firefly-iii/tests/Api/Models/Transaction/StoreControllerTest.php

<?php
/*
 * StoreControllerTest.php
 * Copyright (c) 2021 james@firefly-iii.org
 *
 * This file is part of Firefly III (https://github.com/firefly-iii).
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

namespace Tests\Api\Models\Transaction;


use DateTimeInterface;
use Faker\Factory;
use Laravel\Passport\Passport;
use Log;
use Tests\TestCase;
use Tests\Traits\CollectsValues;
use Tests\Traits\RandomValues;
use Tests\Traits\TestHelpers;

/**
 * Class StoreControllerTest
 */
class StoreControllerTest extends TestCase
{
    use RandomValues, TestHelpers, CollectsValues;

    /**
     * @return array
     */
    public function emptyDataProvider(): array
    {
        return [[[]]];

    }

    /**
     *
     */
    public function setUp(): void
    {
        parent::setUp();
        Passport::actingAs($this->user());
        Log::info(sprintf('Now in %s.', get_class($this)));
    }

    /**
     * @return array
     */
    public function storeDataProvider(): array
    {
        $minimalSets  = $this->minimalSets();
        $optionalSets = $this->optionalSets();
        $regenConfig  = [
            'transactions' => [
                [
                    'description' => function () {
                        $faker = Factory::create();

                        return $faker->uuid;
                    },
                ],
            ],
        ];

        return $this->genericDataProvider($minimalSets, $optionalSets, $regenConfig);
    }

    /**
     * @return array
     */
    private function minimalSets(): array
    {
        $faker = Factory::create();

        // 3 sets:
        $combis = [
            ['withdrawal', 1, 8],
            ['deposit', 9, 1],
            ['transfer', 1, 2],
        ];
        $set    = [];
        foreach ($combis as $combi) {
            $set[] = [
                'parameters' => [],
                'fields'     => [
                    'error_if_duplicate_hash' => $faker->boolean,
                    'transactions'            => [
                        [
                            'type'           => $combi[0],
                            'date'           => $faker->dateTime(null, 'Europe/Amsterdam')->format(DateTimeInterface::RFC3339),
                            'amount'         => number_format($faker->randomFloat(2, 10, 100), 12),
                            'description'    => $faker->uuid,
                            'source_id'      => $combi[1],
                            'destination_id' => $combi[2],
                        ],
                    ],
                ],
            ];
        }

        return $set;
    }

    /**
     * @return \array[][]
     */
    private function optionalSets(): array
    {
        $faker = Factory::create();
        $set   = [
            'transactions_currency_id'   => [
                'fields' => [
                    'transactions' => [
                        // first entry, set field:
                        [
                            'currency_id' => $faker->numberBetween(1, 1),
                        ],
                    ],
                ],
            ],
            'transactions_currency_code' => [
                'fields' => [
                    'transactions' => [
                        // first entry, set field:
                        [
                            'currency_code' => $faker->randomElement(['EUR']),
                        ],
                    ],
                ],
            ],
            // category id
            'category_id'                => [
                'fields' => [
                    'transactions' => [
                        // first entry, set field:
                        [
                            'category_id' => '1',
                        ],
                    ],
                ],
            ],
            // reconciled
            'reconciled'                 => [
                'fields' => [
                    'transactions' => [
                        // first entry, set field:
                        [
                            'reconciled' => $faker->boolean,
                        ],
                    ],
                ],
            ],
            // tags
            'tags'                       => [
                'fields' => [
                    'transactions' => [
                        // first entry, set field:
                        [
                            'tags' => ['a', 'b', 'c'],
                        ],
                    ],
                ],
            ],
        ];
        $extra = ['notes', 'internal_reference', 'bunq_payment_id', 'sepa_cc', 'sepa_ct_op', 'sepa_ct_id',
                  'sepa_db', 'sepa_country', 'sepa_ep', 'sepa_ci', 'sepa_batch_id'];
        foreach ($extra as $key) {
            $set[$key] = [
                'fields' => [
                    'transactions' => [
                        // first entry, set field:
                        [
                            $key => $faker->uuid,
                        ],
                    ],
                ],
            ];
        }

        return $set;
    }

    /**
     * @param array $submission
     *
     * emptyDataProvider / storeDataProvider
     *
     * @dataProvider storeDataProvider
     */
    public function testStore(array $submission): void
    {
        if ([] === $submission) {
            $this->markTestSkipped('Empty data provider');
        }
        $route = 'api.v1.transactions.store';
        $this->storeAndCompare($route, $submission);
    }

}