Files
firefly-iii/tests/Api/Models/Recurrence/UpdateControllerTest.php
2021-03-20 19:17:22 +01:00

350 lines
13 KiB
PHP

<?php
/*
* UpdateControllerTest.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\Recurrence;
use Faker\Factory;
use Laravel\Passport\Passport;
use Log;
use Tests\Objects\Field;
use Tests\Objects\FieldSet;
use Tests\Objects\TestConfiguration;
use Tests\TestCase;
use Tests\Traits\CollectsValues;
use Tests\Traits\TestHelpers;
/**
* Class UpdateControllerTest
*/
class UpdateControllerTest extends TestCase
{
use TestHelpers, CollectsValues;
/**
*
*/
public function setUp(): void
{
parent::setUp();
Passport::actingAs($this->user());
Log::info(sprintf('Now in %s.', get_class($this)));
}
/**
* @dataProvider updateDataProvider
*/
public function testUpdate(array $submission): void
{
if ([] === $submission) {
$this->markTestSkipped('Empty provider.');
}
Log::debug('testStoreUpdated()');
Log::debug('submission :', $submission['submission']);
Log::debug('expected :', $submission['expected']);
Log::debug('ignore :', $submission['ignore']);
Log::debug('parameters :', $submission['parameters']);
$route = route('api.v1.recurrences.update', $submission['parameters']);
$this->assertPUT($route, $submission);
}
/**
* @return array
*/
public function updateDataProvider(): array
{
$configuration = new TestConfiguration;
// optional fields
$fieldSet = new FieldSet;
$fieldSet->parameters = [1];
$field = Field::createBasic('title', 'uuid');
$fieldSet->addField($field);
$configuration->addOptionalFieldSet('title', $fieldSet);
$fieldSet = new FieldSet;
$fieldSet->parameters = [1];
$field = Field::createBasic('description', 'uuid');
$fieldSet->addField($field);
$configuration->addOptionalFieldSet('description', $fieldSet);
$fieldSet = new FieldSet;
$fieldSet->parameters = [1];
$field = Field::createBasic('first_date', 'random-past-date');
$field->ignorableFields = ['repetitions'];
$fieldSet->addField($field);
$configuration->addOptionalFieldSet('first_date', $fieldSet);
$fieldSet = new FieldSet;
$fieldSet->parameters = [1];
$field = Field::createBasic('apply_rules', 'boolean');
$fieldSet->addField($field);
$configuration->addOptionalFieldSet('apply_rules', $fieldSet);
$fieldSet = new FieldSet;
$fieldSet->parameters = [1];
$field = Field::createBasic('active', 'boolean');
$fieldSet->addField($field);
$configuration->addOptionalFieldSet('active', $fieldSet);
$fieldSet = new FieldSet;
$fieldSet->parameters = [1];
$field = Field::createBasic('repetitions/0/type', 'static-ndom');
$field->ignorableFields = ['repetitions/0/description', 'repetitions/0/occurrences'];
$fieldSet->addField($field);
$fieldSet->addField(Field::createBasic('repetitions/0/moment', 'moment-ndom'));
$configuration->addOptionalFieldSet('ndom', $fieldSet);
$fieldSet = new FieldSet;
$fieldSet->parameters = [1];
$field = Field::createBasic('repetitions/0/type', 'static-monthly');
$field->ignorableFields = ['repetitions/0/description', 'repetitions/0/occurrences'];
$fieldSet->addField($field);
$fieldSet->addField(Field::createBasic('repetitions/0/moment', 'moment-monthly'));
$configuration->addOptionalFieldSet('monthly', $fieldSet);
$fieldSet = new FieldSet;
$fieldSet->parameters = [1];
$field = Field::createBasic('repetitions/0/type', 'static-yearly');
$field->ignorableFields = ['repetitions/0/description', 'repetitions/0/occurrences'];
$fieldSet->addField($field);
$fieldSet->addField(Field::createBasic('repetitions/0/moment', 'random-past-date'));
$configuration->addOptionalFieldSet('yearly', $fieldSet);
$fieldSet = new FieldSet;
$fieldSet->parameters = [1];
$field = Field::createBasic('repetitions/0/skip', 'random-skip');
$field->ignorableFields = ['repetitions/0/description', 'repetitions/0/occurrences'];
$fieldSet->addField($field);
$configuration->addOptionalFieldSet('skip', $fieldSet);
$fieldSet = new FieldSet;
$fieldSet->parameters = [1];
$field = Field::createBasic('repetitions/0/weekend', 'weekend');
$field->ignorableFields = ['repetitions/0/description', 'repetitions/0/occurrences'];
$fieldSet->addField($field);
$configuration->addOptionalFieldSet('weekend', $fieldSet);
$fieldSet = new FieldSet;
$fieldSet->parameters = [1];
$fieldSet->addField(Field::createBasic('transactions/0/foreign_amount', 'random-amount'));
$field = Field::createBasic('transactions/0/foreign_currency_id', 'random-currency-id');
$field->ignorableFields = ['transactions/0/foreign_currency_code', 'transactions/0/foreign_currency_symbol'];
$fieldSet->addField($field);
$configuration->addOptionalFieldSet('foreign1', $fieldSet);
$fieldSet = new FieldSet;
$fieldSet->parameters = [1];
$field = Field::createBasic('transactions/0/budget_id', 'random-budget-id');
$field->ignorableFields = ['transactions/0/budget_name'];
$fieldSet->addField($field);
$configuration->addOptionalFieldSet('budget', $fieldSet);
$fieldSet = new FieldSet;
$fieldSet->parameters = [1];
$field = Field::createBasic('transactions/0/category_id', 'random-category-id');
$field->ignorableFields = ['transactions/0/category_name'];
$fieldSet->addField($field);
$configuration->addOptionalFieldSet('category', $fieldSet);
$fieldSet = new FieldSet;
$fieldSet->parameters = [1];
$fieldSet->addField(Field::createBasic('transactions/0/tags', 'random-tags'));
$configuration->addOptionalFieldSet('tags', $fieldSet);
$fieldSet = new FieldSet;
$fieldSet->parameters = [1];
$field = Field::createBasic('transactions/0/piggy_bank_id', 'random-piggy-id');
$field->ignorableFields = ['transactions/0/piggy_bank_name'];
$fieldSet->addField($field);
$configuration->addOptionalFieldSet('piggy', $fieldSet);
return $configuration->generateAll();
}
/**
* @return array
*/
public function updateDataSet(): array
{
$faker = Factory::create();
$types = [
['daily', ''],
['weekly', (string)$faker->numberBetween(1, 7)],
['ndom', (string)$faker->numberBetween(1, 4) . ',' . $faker->numberBetween(1, 7)],
['monthly', (string)$faker->numberBetween(1, 31)],
['yearly', $faker->dateTimeBetween('-1 year', 'now')->format('Y-m-d')],
];
$set = [
'title' => [
'id' => 1,
'fields' => [
'title' => ['test_value' => $faker->uuid],
],
'extra_ignore' => [],
],
'description' => [
'id' => 1,
'fields' => [
'description' => ['test_value' => $faker->uuid],
],
'extra_ignore' => [],
],
'first_date' => [
'id' => 1,
'fields' => [
'first_date' => ['test_value' => $faker->date()],
],
'extra_ignore' => [],
],
'repeat_until' => [
'id' => 1,
'fields' => [
'repeat_until' => ['test_value' => $faker->dateTimeBetween('1 year', '2 year')->format('Y-m-d')],
],
'extra_ignore' => [],
],
'nr_of_repetitions' => [
'id' => 1,
'fields' => [
'nr_of_repetitions' => ['test_value' => $faker->numberBetween(1, 5)],
],
'extra_ignore' => ['repeat_until'],
],
'apply_rules' => [
'id' => 1,
'fields' => [
'apply_rules' => ['test_value' => $faker->boolean],
],
'extra_ignore' => [],
],
'active' => [
'id' => 1,
'fields' => [
'active' => ['test_value' => $faker->boolean],
],
'extra_ignore' => [],
],
'notes' => [
'id' => 1,
'fields' => [
'notes' => ['test_value' => $faker->uuid],
],
'extra_ignore' => [],
],
];
// repetitions. Will submit 0,1 2 3 repetitions:
for ($i = 0; $i < 4; $i++) {
if (0 === $i) {
$set[] = [
'id' => 1,
'fields' => [
'repetitions' => [
'test_value' => [],
],
],
'extra_ignore' => [],
];
continue;
}
$extraRepetitions = [];
// do $i repetitions
for ($ii = 0; $ii < $i; $ii++) {
// now loop fields, enough to create sets I guess?
$thisType = $types[$faker->numberBetween(0, 4)];
// TODO maybe do some permutation stuff here?
$extraRepetition = [
'type' => $thisType[0],
'moment' => $thisType[1],
'skip' => $faker->numberBetween(1, 3),
'weekend' => $faker->numberBetween(1, 4),
];
$extraRepetitions[] = $extraRepetition;
}
$set[] = [
'id' => 1,
'fields' => [
'repetitions' => [
'test_value' => $extraRepetitions,
],
],
'extra_ignore' => [],
];
}
// transactions. Will submit 0,1 2 3 transactions:
for ($i = 0; $i < 4; $i++) {
if (0 === $i) {
$set[] = [
'id' => 1,
'fields' => [
'transactions' => [
'test_value' => [],
],
],
'extra_ignore' => [],
];
continue;
}
$extraTransactions = [];
// do $i repetitions
for ($ii = 0; $ii < $i; $ii++) {
// now loop fields, enough to create sets I guess?
// TODO maybe do some permutation stuff here?
$extraTransaction = [
'currency_id' => (string)$faker->numberBetween(1, 4),
'foreign_currency_id' => (string)$faker->numberBetween(4, 6),
'source_id' => $faker->numberBetween(1, 3),
'destination_id' => $faker->numberBetween(8, 8),
'amount' => number_format($faker->randomFloat(2, 10, 100), 2),
'foreign_amount' => number_format($faker->randomFloat(2, 10, 100), 2),
'description' => $faker->uuid,
];
$extraTransactions[] = $extraTransaction;
}
$set[] = [
'id' => 1,
'fields' => [
'transactions' => [
'test_value' => $extraTransactions,
],
],
'extra_ignore' => [],
];
}
return $set;
}
}