Files
yookassa-sdk-php/tests/Request/Payouts/CreatePayoutRequestBuilderTest.php
Антон Н. Николаев 2db9951ff6 Валидация payment_order.recipient.bank.name и payment_order.payment_period.year. Выплаты самозанятым теперь deprecated
Информация про чеки самозанятых в платежах и возвратах удалена - больше не поддерживаем сервисы для самозанятых
Добавлена возможность выставления счета по смс и email
Добавлена поддержка работы со списками выплат
Обновлен Copyright
2026-02-05 15:36:37 +03:00

406 lines
12 KiB
PHP
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<?php
/*
* The MIT License
*
* Copyright (c) 2026 "YooMoney", NBСO LLC
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
namespace Tests\YooKassa\Request\Payouts;
use Exception;
use InvalidArgumentException;
use PHPUnit\Framework\TestCase;
use stdClass;
use YooKassa\Helpers\Random;
use YooKassa\Model\AmountInterface;
use YooKassa\Model\CurrencyCode;
use YooKassa\Model\MonetaryAmount;
use YooKassa\Model\Payment\PaymentMethodType;
use YooKassa\Model\Payout\Payout;
use YooKassa\Model\Payout\PayoutDestinationType;
use YooKassa\Request\Payouts\CreatePayoutRequestBuilder;
use YooKassa\Request\Payouts\PayoutDestinationData\PayoutDestinationDataFactory;
/**
* CreatePayoutRequestBuilderTest
*
* @category ClassTest
* @author cms@yoomoney.ru
* @link https://yookassa.ru/developers/api
*/
class CreatePayoutRequestBuilderTest extends TestCase
{
/**
* @dataProvider validDataProvider
*
* @param mixed $options
*
* @throws Exception
*/
public function testSetDeal(mixed $options): void
{
$builder = new CreatePayoutRequestBuilder();
$builder->setOptions($options);
$instance = $builder->build();
if (empty($options['deal'])) {
self::assertNull($instance->getDeal());
} else {
self::assertNotNull($instance->getDeal());
self::assertEquals($options['deal'], $instance->getDeal()->toArray());
}
}
/**
* @dataProvider validDataProvider
*
* @param mixed $options
*
* @throws Exception
*/
public function testSetAmount(mixed $options): void
{
$builder = new CreatePayoutRequestBuilder();
$builder->setOptions($options);
$instance = $builder->build();
self::assertNotNull($instance->getAmount());
if ($options['amount'] instanceof AmountInterface) {
self::assertEquals($options['amount']->getValue(), $instance->getAmount()->getValue());
} else {
self::assertEquals($options['amount']['value'], $instance->getAmount()->getValue());
}
if (!$options['amount'] instanceof AmountInterface) {
$builder->setAmount([
'value' => $options['amount']['value'],
'currency' => 'EUR',
]);
$builder->setPayoutToken($options['payoutDestinationData'] ? null : uniqid('', true));
$builder->setPayoutDestinationData($options['payoutDestinationData']);
$instance = $builder->build();
self::assertEquals($options['amount']['value'], $instance->getAmount()->getValue());
}
}
/**
* @dataProvider invalidAmountDataProvider
*
* @param mixed $value
*/
public function testSetInvalidAmount(mixed $value): void
{
$this->expectException(InvalidArgumentException::class);
$builder = new CreatePayoutRequestBuilder();
$builder->setAmount($value);
}
/**
* @dataProvider validDataProvider
*
* @param mixed $options
*
* @throws Exception
*/
public function testSetPayoutToken(mixed $options): void
{
$builder = new CreatePayoutRequestBuilder();
$builder->setOptions($options);
$instance = $builder->build();
if (empty($options['payoutToken'])) {
self::assertNull($instance->getPayoutToken());
} else {
self::assertNotNull($instance->getPayoutToken());
self::assertEquals($options['payoutToken'], $instance->getPayoutToken());
}
}
/**
* @dataProvider validDataProvider
*
* @param mixed $options
*
* @throws Exception
*/
public function testSetPaymentMethodId(mixed $options): void
{
$builder = new CreatePayoutRequestBuilder();
$builder->setOptions($options);
$instance = $builder->build();
if (empty($options['paymentMethodId'])) {
self::assertNull($instance->getPaymentMethodId());
} else {
self::assertNotNull($instance->getPaymentMethodId());
self::assertEquals($options['paymentMethodId'], $instance->getPaymentMethodId());
}
}
/**
* @dataProvider validDataProvider
*
* @param mixed $options
*
* @throws Exception
*/
public function testSetPayoutDestinationData(mixed $options): void
{
$builder = new CreatePayoutRequestBuilder();
$builder->setOptions($options);
$instance = $builder->build();
if (empty($options['payoutDestinationData'])) {
self::assertNull($instance->getPayoutDestinationData());
} else {
self::assertNotNull($instance->getPayoutDestinationData());
if (is_array($options['payoutDestinationData'])) {
self::assertEquals($options['payoutDestinationData'], $instance->getPayoutDestinationData()->toArray());
} else {
self::assertEquals($options['payoutDestinationData'], $instance->getPayoutDestinationData());
}
}
}
/**
* @dataProvider validDataProvider
*
* @param mixed $options
*
* @throws Exception
*/
public function testSetMetadata(mixed $options): void
{
$builder = new CreatePayoutRequestBuilder();
$builder->setOptions($options);
$instance = $builder->build();
if (empty($options['metadata'])) {
self::assertNull($instance->getMetadata());
} else {
self::assertEquals($options['metadata'], $instance->getMetadata()->toArray());
}
}
public function invalidRecipientDataProvider(): array
{
return [
[null],
[true],
[false],
[1],
[1.1],
['test'],
[new stdClass()],
];
}
/**
* @throws Exception
*/
public static function validDataProvider(): array
{
$payoutDestinationData = self::payoutDestinationData();
$result = [
[
[
'description' => null,
'amount' => new MonetaryAmount(Random::int(1, 1000)),
'currency' => Random::value(CurrencyCode::getValidValues()),
'payoutToken' => null,
'paymentMethodId' => null,
'payoutDestinationData' => Random::value($payoutDestinationData),
'confirmation' => null,
'metadata' => null,
'deal' => [
'id' => Random::str(36, 50),
],
'self_employed' => null,
'receipt_data' => null,
],
],
[
[
'description' => '',
'amount' => new MonetaryAmount(Random::int(1, 1000)),
'currency' => Random::value(CurrencyCode::getValidValues()),
'payoutToken' => uniqid('', true),
'paymentMethodId' => '',
'payoutDestinationData' => null,
'metadata' => [[]],
'deal' => [
'id' => Random::str(36, 50),
],
],
],
];
for ($i = 0; $i < 10; $i++) {
$even = $i % 3;
$request = [
'description' => uniqid('', true),
'amount' => ['value' => Random::int(1, 99)],
'currency' => CurrencyCode::RUB,
'paymentMethodId' => $even === 0 ? uniqid('', true) : null,
'payoutToken' => $even === 1 ? uniqid('', true) : null,
'payoutDestinationData' => $even === 2 ? Random::value($payoutDestinationData) : null,
'metadata' => ['test' => 'test'],
'deal' => [
'id' => Random::str(36, 50),
],
];
$result[] = [$request];
}
return $result;
}
public static function payoutDestinationData(): array
{
return [
[
'type' => PaymentMethodType::YOO_MONEY,
'account_number' => Random::str(11, 33, '0123456789'),
],
[
'type' => PaymentMethodType::BANK_CARD,
'card' => [
'number' => Random::str(16, 16, '0123456789'),
],
],
[
'type' => PaymentMethodType::SBP,
'phone' => Random::str(4, 15, '0123456789'),
'bank_id' => Random::str(12, 12, '0123456789'),
],
];
}
public static function invalidAmountDataProvider(): array
{
return [
[-1],
[true],
[false],
[new stdClass()],
[0],
];
}
/**
* @dataProvider validDataProvider
*
* @param mixed $options
*
* @throws Exception
*/
public function testSetDescription(mixed $options): void
{
$builder = new CreatePayoutRequestBuilder();
$builder->setOptions($options);
$instance = $builder->build();
if (empty($options['description'])) {
self::assertNull($instance->getDescription());
} else {
self::assertEquals($options['description'], $instance->getDescription());
}
}
public function testSetInvalidLengthDescription(): void
{
$this->expectException(InvalidArgumentException::class);
$builder = new CreatePayoutRequestBuilder();
$description = Random::str(Payout::MAX_LENGTH_DESCRIPTION + 1);
$builder->setDescription($description);
}
/**
* @throws Exception
*/
public static function invalidDealDataProvider(): array
{
return [
[true],
[false],
[new stdClass()],
[0],
[7],
[Random::int(-100, -1)],
[Random::int(7, 100)],
];
}
/**
* @dataProvider invalidDealDataProvider
*
* @param mixed $value
*/
public function testSetInvalidDeal(mixed $value): void
{
$this->expectException(InvalidArgumentException::class);
$builder = new CreatePayoutRequestBuilder();
$builder->setDeal($value);
}
/**
* @throws Exception
*/
public static function invalidSelfEmployedProvider(): array
{
return [
[true],
[false],
[new stdClass()],
[0],
[7],
[Random::int(-100, -1)],
[Random::int(7, 100)],
];
}
/**
* @param null $testingProperty
*
* @throws Exception
*/
protected function getRequiredData($testingProperty = null): array
{
$result = [];
$even = Random::bool();
if ('amount' !== $testingProperty) {
$result['amount'] = new MonetaryAmount(Random::int(1, 1000));
}
if ('payoutToken' !== $testingProperty) {
$result['payoutToken'] = $even ? Random::str(36, 50) : null;
}
$factory = new PayoutDestinationDataFactory();
if ('payoutDestinationData' !== $testingProperty) {
$type = Random::value(PayoutDestinationType::getValidValues());
$payoutDestination = self::payoutDestinationData();
$result['payoutDestinationData'] = $even ? null : $factory->factory($type);
}
return $result;
}
}