IntenseFinance/firefly-iii
3
0
Fork 0
mirror of https://github.com/firefly-iii/firefly-iii.git synced 2025-01-12 00:52:01 -06:00
Code Issues Packages Projects Releases Wiki Activity

Finish budget tests.

Browse Source
This commit is contained in:
James Cole 2021-03-13 19:03:08 +01:00
parent fdcd6befb6
commit 1f50f65bb7
No known key found for this signature in database
GPG Key ID: B5669F9493CDE38D
7 changed files with 436 additions and 88 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
app/Api/V1/Controllers/Models/Budget/StoreController.php
View File

@ -68,6 +68,7 @@ class StoreController extends Controller
public function store(StoreRequest $request): JsonResponse
{
$budget = $this->repository->store($request->getAll());
$budget->refresh();
$manager = $this->getManager();
/** @var BudgetTransformer $transformer */

41
app/Api/V1/Requests/Models/Budget/StoreRequest.php
View File

@ -46,23 +46,20 @@ class StoreRequest extends FormRequest
*/
public function getAll(): array
{
$active = true;
if (null !== $this->get('active')) {
$active = $this->boolean('active');
}
$fields = [
'name' => ['name', 'string'],
'active' => ['active', 'boolean'],
'order' => ['active', 'integer'],
return [
'name' => $this->string('name'),
'active' => $active,
'order' => 0,
'transaction_currency_id' => $this->integer('auto_budget_currency_id'),
'transaction_currency_code' => $this->string('auto_budget_currency_code'),
// auto budget info
'auto_budget_type' => $this->string('auto_budget_type'),
'auto_budget_amount' => $this->string('auto_budget_amount'),
'auto_budget_period' => $this->string('auto_budget_period'),
// auto budget currency:
'currency_id' => ['auto_budget_currency_id', 'integer'],
'currency_code' => ['auto_budget_currency_code', 'string'],
'auto_budget_type' => ['auto_budget_type', 'string'],
'auto_budget_amount' => ['auto_budget_amount', 'string'],
'auto_budget_period' => ['auto_budget_period', 'string'],
];
return $this->getAllData($fields);
}
/**
@ -73,14 +70,14 @@ class StoreRequest extends FormRequest
public function rules(): array
{
return [
'name' => 'required|between:1,100|uniqueObjectForUser:budgets,name',
'active' => [new IsBoolean],
'auto_budget_currency_id' => 'exists:transaction_currencies,id',
'auto_budget_currency_code' => 'exists:transaction_currencies,code',
'name' => 'required|between:1,100|uniqueObjectForUser:budgets,name',
'active' => [new IsBoolean],
'currency_id' => 'exists:transaction_currencies,id',
'currency_code' => 'exists:transaction_currencies,code',
// auto budget info
'auto_budget_type' => 'in:reset,rollover,none',
'auto_budget_amount' => 'min:0|max:1000000000',
'auto_budget_period' => 'in:daily,weekly,monthly,quarterly,half_year,yearly',
'auto_budget_type' => 'in:reset,rollover,none',
'auto_budget_amount' => 'min:0|max:1000000000',
'auto_budget_period' => 'in:daily,weekly,monthly,quarterly,half_year,yearly',
];
}

28
app/Api/V1/Requests/Models/Budget/UpdateRequest.php
View File

@ -46,21 +46,19 @@ class UpdateRequest extends FormRequest
*/
public function getAll(): array
{
$active = true;
if (null !== $this->get('active')) {
$active = $this->boolean('active');
}
return [
'name' => $this->string('name'),
'active' => $active,
'order' => 0,
'auto_budget_type' => $this->string('auto_budget_type'),
'transaction_currency_id' => $this->integer('auto_budget_currency_id'),
'transaction_currency_code' => $this->string('auto_budget_currency_code'),
'auto_budget_amount' => $this->string('auto_budget_amount'),
'auto_budget_period' => $this->string('auto_budget_period'),
// this is the way:
$fields = [
'name' => ['name', 'string'],
'active' => ['active', 'boolean'],
'order' => ['order', 'integer'],
'currency_id' => ['auto_budget_currency_id', 'integer'],
'currency_code' => ['auto_budget_currency_code', 'string'],
'auto_budget_type' => ['auto_budget_type', 'string'],
'auto_budget_amount' => ['auto_budget_amount', 'string'],
'auto_budget_period' => ['auto_budget_period', 'string'],
];
return $this->getAllData($fields);
}
/**
@ -73,7 +71,7 @@ class UpdateRequest extends FormRequest
$budget = $this->route()->parameter('budget');
return [
'name' => sprintf('required|between:1,100|uniqueObjectForUser:budgets,name,%d', $budget->id),
'name' => sprintf('between:1,100|uniqueObjectForUser:budgets,name,%d', $budget->id),
'active' => [new IsBoolean],
'auto_budget_type' => 'in:reset,rollover,none',
'auto_budget_currency_id' => 'exists:transaction_currencies,id',

111
app/Repositories/Budget/BudgetRepository.php
View File

@ -320,6 +320,7 @@ class BudgetRepository implements BudgetRepositoryInterface
'user_id' => $this->user->id,
'name' => $data['name'],
'order' => $order + 1,
'active' => array_key_exists('active', $data) ? $data['active'] : true,
]
);
} catch (QueryException $e) {
@ -327,25 +328,27 @@ class BudgetRepository implements BudgetRepositoryInterface
Log::error($e->getTraceAsString());
throw new FireflyException('400002: Could not store budget.');
}
// try to create associated auto budget:
$type = $data['auto_budget_type'] ?? 0;
if (0 === $type || '' === $type || 'none' === $type) {
if (!array_key_exists('auto_budget_type', $data)) {
return $newBudget;
}
$type = $data['auto_budget_type'];
if ('none' === $type) {
return $newBudget;
}
if ('reset' === $type) {
$type = AutoBudget::AUTO_BUDGET_RESET;
}
if ('rollover' === $type) {
$type = AutoBudget::AUTO_BUDGET_ROLLOVER;
}
$repos = app(CurrencyRepositoryInterface::class);
$currencyId = (int)($data['transaction_currency_id'] ?? 0);
$currencyCode = (string)($data['transaction_currency_code'] ?? '');
$currency = $repos->findNull($currencyId);
if (null === $currency) {
$currency = $repos->findByCodeNull($currencyCode);
$repos = app(CurrencyRepositoryInterface::class);
if (array_key_exists('currency_id', $data)) {
$currency = $repos->findNull((int)$data['currency_id']);
}
if (array_key_exists('currency_code', $data)) {
$currency = $repos->findByCode((string)$data['currency_code']);
}
if (null === $currency) {
$currency = app('amount')->getDefaultCurrencyByUser($this->user);
@ -387,56 +390,68 @@ class BudgetRepository implements BudgetRepositoryInterface
*/
public function update(Budget $budget, array $data): Budget
{
$oldName = $budget->name;
$budget->name = $data['name'];
$budget->active = $data['active'];
$oldName = $budget->name;
if (array_key_exists('name', $data)) {
$budget->name = $data['name'];
}
if (array_key_exists('active', $data)) {
$budget->active = $data['active'];
}
$budget->save();
// update or create auto-budget:
$autoBudgetType = $data['auto_budget_type'] ?? 0;
if ('reset' === $autoBudgetType) {
$autoBudgetType = AutoBudget::AUTO_BUDGET_RESET;
}
if ('rollover' === $autoBudgetType) {
$autoBudgetType = AutoBudget::AUTO_BUDGET_ROLLOVER;
}
if ('none' === $autoBudgetType) {
$autoBudgetType = 0;
}
if (0 !== $autoBudgetType) {
$autoBudget = $this->getAutoBudget($budget);
if (null === $autoBudget) {
$autoBudget = new AutoBudget;
$autoBudget->budget()->associate($budget);
}
$autoBudget = $this->getAutoBudget($budget);
// get currency:
$currency = null;
if (array_key_exists('currency_id', $data) || array_key_exists('currency_code', $data)) {
$repos = app(CurrencyRepositoryInterface::class);
$currencyId = (int)($data['transaction_currency_id'] ?? 0);
$currencyCode = (string)($data['transaction_currency_code'] ?? '');
$currency = $repos->findNull($currencyId);
$currencyId = (int)($data['currency_id'] ?? 0);
$currencyCode = (string)($data['currency_code'] ?? '');
$currency = $repos->findNull($currencyId);
if (null === $currency) {
$currency = $repos->findByCodeNull($currencyCode);
}
if (null === $currency) {
$currency = app('amount')->getDefaultCurrencyByUser($this->user);
}
}
if (null === $currency) {
$currency = app('amount')->getDefaultCurrencyByUser($this->user);
}
if (null === $autoBudget
&& array_key_exists('auto_budget_type', $data)
&& array_key_exists('auto_budget_amount', $data)
) {
// only create if all are here:
$autoBudget = new AutoBudget;
$autoBudget->budget_id = $budget->id;
$autoBudget->transaction_currency_id = $currency->id;
$autoBudget->auto_budget_type = $autoBudgetType;
$autoBudget->amount = $data['auto_budget_amount'] ?? '0';
$autoBudget->period = $data['auto_budget_period'] ?? 'monthly';
}
// update existing type
if (array_key_exists('auto_budget_type', $data)) {
$autoBudgetType = $data['auto_budget_type'];
if ('reset' === $autoBudgetType) {
$autoBudget->auto_budget_type = AutoBudget::AUTO_BUDGET_RESET;
}
if ('rollover' === $autoBudgetType) {
$autoBudget->auto_budget_type = AutoBudget::AUTO_BUDGET_ROLLOVER;
}
if ('none' === $autoBudgetType && null !== $autoBudget->id) {
$autoBudget->delete();
return $budget;
}
}
if (array_key_exists('auto_budget_amount', $data)) {
$autoBudget->amount = $data['auto_budget_amount'];
}
if (array_key_exists('auto_budget_period', $data)) {
$autoBudget->period = $data['auto_budget_period'];
}
if (null !== $autoBudget) {
$autoBudget->save();
}
if (0 === $autoBudgetType) {
$autoBudget = $this->getAutoBudget($budget);
if (null !== $autoBudget) {
$this->destroyAutoBudget($budget);
}
}
$this->updateRuleTriggers($oldName, $data['name']);
$this->updateRuleActions($oldName, $data['name']);
app('preferences')->mark();
return $budget;
}

5
app/Transformers/BudgetTransformer.php
View File

@ -81,13 +81,12 @@ class BudgetTransformer extends AbstractTransformer
];
if (null !== $autoBudget) {
$abCurrencyId = (int)$autoBudget->transactionCurrency->id;
$abCurrencyId = (string)$autoBudget->transactionCurrency->id;
$abCurrencyCode = $autoBudget->transactionCurrency->code;
$abType = $types[$autoBudget->auto_budget_type];
$abAmount = number_format((float)$autoBudget->amount, $autoBudget->transactionCurrency->decimal_places, '.', '');
$abPeriod = $autoBudget->period;
}
return [
'id' => (string)$budget->id,
'created_at' => $budget->created_at->toAtomString(),
@ -96,7 +95,7 @@ class BudgetTransformer extends AbstractTransformer
'name' => $budget->name,
'auto_budget_type' => $abType,
'auto_budget_period' => $abPeriod,
'auto_budget_currency_id' => (string)$abCurrencyId,
'auto_budget_currency_id' => $abCurrencyId,
'auto_budget_currency_code' => $abCurrencyCode,
'auto_budget_amount' => $abAmount,
'spent' => $spent,

161
tests/Api/Models/Budget/StoreControllerTest.php Normal file
View File

@ -0,0 +1,161 @@
<?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\Budget;
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;
/**
*
*/
public function setUp(): void
{
parent::setUp();
Passport::actingAs($this->user());
Log::info(sprintf('Now in %s.', get_class($this)));
}
/**
* @param array $submission
*
* @dataProvider storeDataProvider
* @ data Provider emptyDataProvider
*/
public function testStore(array $submission): void
{
if ([] === $submission) {
$this->markTestSkipped('Empty data provider');
}
// run account store with a minimal data set:
$route = 'api.v1.budgets.store';
$this->storeAndCompare($route, $submission);
}
/**
* @return array
*/
public function emptyDataProvider(): array
{
return [[[]]];
}
/**
* @return array
*/
public function storeDataProvider(): array
{
$minimalSets = $this->minimalSets();
$optionalSets = $this->optionalSets();
$regenConfig = [
'name' => function () {
$faker = Factory::create();
return join(' ', $faker->words(5));
},
];
return $this->genericDataProvider($minimalSets, $optionalSets, $regenConfig);
}
/**
* @return array
*/
private function minimalSets(): array
{
$faker = Factory::create();
$repeatFreqs = ['yearly', 'weekly', 'monthly'];
$repeatFreq = $repeatFreqs[rand(0, count($repeatFreqs) - 1)];
return [
'default_bill' => [
'fields' => [
'name' => join(',', $faker->words(5)),
],
],
];
}
/**
* @return \array[][]
*/
private function optionalSets(): array
{
$faker = Factory::create();
$repeatFreqs = ['weekly', 'monthly', 'yearly'];
$repeatFreq = $repeatFreqs[rand(0, count($repeatFreqs) - 1)];
$currencies = [
1 => 'EUR',
2 => 'HUF',
3 => 'GBP',
4 => 'UAH',
];
$rand = rand(1, 4);
$objectGroupId = $faker->numberBetween(1, 2);
$objectGroupName = sprintf('Object group %d', $objectGroupId);
$autoBudgetTypes = ['reset', 'rollover'];
$autoBudgetType = $autoBudgetTypes[rand(0, count($autoBudgetTypes) - 1)];
return [
'active' => [
'fields' => [
'active' => $faker->boolean,
],
],
'auto_budget_id' => [
'fields' => [
'auto_budget_type' => $autoBudgetType,
'auto_budget_currency_id' => $rand,
'auto_budget_amount' => number_format($faker->randomFloat(2, 10, 100), 2),
'auto_budget_period' => $repeatFreq,
],
],
'auto_budget_code' => [
'fields' => [
'auto_budget_type' => $autoBudgetType,
'auto_budget_currency_code' => $currencies[$rand],
'auto_budget_amount' => number_format($faker->randomFloat(2, 10, 100), 2),
'auto_budget_period' => $repeatFreq,
],
]
];
}
}

177
tests/Api/Models/Budget/UpdateControllerTest.php Normal file
View File

@ -0,0 +1,177 @@
<?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\Budget;
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 UpdateControllerTest
*/
class UpdateControllerTest extends TestCase
{
use RandomValues, 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
{
$ignore = [
'created_at',
'updated_at',
];
$route = route('api.v1.budgets.update', [$submission['id']]);
$this->updateAndCompare($route, $submission, $ignore);
}
/**
* @return array
*/
public function updateDataProvider(): array
{
$submissions = [];
$all = $this->updateDataSet();
foreach ($all as $name => $data) {
$submissions[] = [$data];
}
return $submissions;
}
/**
* @return array
*/
public function updateDataSet(): array
{
$faker = Factory::create();
$currencies = [
1 => 'EUR',
2 => 'HUF',
3 => 'GBP',
4 => 'UAH',
];
$repeatFreqs = ['yearly', 'weekly', 'monthly'];
$repeatFreq = $repeatFreqs[rand(0, count($repeatFreqs) - 1)];
$objectGroupId = $faker->numberBetween(1, 2);
$objectGroupName = sprintf('Object group %d', $objectGroupId);
$rand = rand(1, 4);
$autoBudgetTypes = ['reset', 'rollover'];
$autoBudgetType = $autoBudgetTypes[rand(0, count($autoBudgetTypes) - 1)];
$set = [
'name' => [
'id' => 1,
'fields' => [
'name' => ['test_value' => join(' ', $faker->words(4))],
],
'extra_ignore' => [],
],
'active' => [
'id' => 1,
'fields' => [
'active' => ['test_value' => $faker->boolean],
],
'extra_ignore' => [],
],
'order' => [
'id' => 1,
'fields' => [
'order' => ['test_value' => $faker->numberBetween(1, 5)],
],
'extra_ignore' => [],
],
'auto_budget' => [
'id' => 1,
'fields' => [
'auto_budget_type' => ['test_value' => $autoBudgetType],
'auto_budget_currency_id' => ['test_value' => (string)$rand],
'auto_budget_currency_code' => ['test_value' => $currencies[$rand]],
'auto_budget_amount' => ['test_value' => number_format($faker->randomFloat(2, 10, 100), 2)],
'auto_budget_period' => ['test_value' => $repeatFreq],
],
'extra_ignore' => [],
],
'auto_budget_currency_id' => [
'id' => 1,
'fields' => [
'auto_budget_currency_id' => ['test_value' => (string)$rand],
],
'extra_ignore' => ['auto_budget_currency_code'],
],
'auto_budget_currency_code' => [
'id' => 1,
'fields' => [
'auto_budget_currency_code' => ['test_value' => $currencies[$rand]],
],
'extra_ignore' => ['auto_budget_currency_id'],
],
'auto_budget_amount' => [
'id' => 1,
'fields' => [
'auto_budget_amount' => ['test_value' => number_format($faker->randomFloat(2, 10, 100), 2)],
],
'extra_ignore' => [],
],
'auto_budget_period' => [
'id' => 1,
'fields' => [
'auto_budget_period' => ['test_value' => $repeatFreq],
],
'extra_ignore' => [],
],
'auto_budget_reset' => [
'id' => 1,
'fields' => [
'auto_budget_type' => ['test_value' => 'none'],
],
'extra_ignore' => ['auto_budget_type', 'auto_budget_period', 'auto_budget_currency_id', 'auto_budget_currency_code', 'auto_budget_amount'],
],
];
return $set;
}
}