firefly-iii/tests/Feature/Controllers/Chart/BudgetControllerTest.php

<?php
/**
 * BudgetControllerTest.php
 * Copyright (c) 2019 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/>.
 */
declare(strict_types=1);

namespace Tests\Feature\Controllers\Chart;

use Carbon\Carbon;
use Exception;
use FireflyIII\Generator\Chart\Basic\GeneratorInterface;
use FireflyIII\Helpers\Collector\GroupCollectorInterface;
use FireflyIII\Helpers\Fiscal\FiscalHelperInterface;
use FireflyIII\Models\BudgetLimit;
use FireflyIII\Models\TransactionType;
use FireflyIII\Repositories\Account\AccountRepositoryInterface;
use FireflyIII\Repositories\Budget\BudgetLimitRepositoryInterface;
use FireflyIII\Repositories\Budget\BudgetRepositoryInterface;
use FireflyIII\Repositories\Budget\NoBudgetRepositoryInterface;
use FireflyIII\Repositories\Budget\OperationsRepositoryInterface;
use FireflyIII\Repositories\Category\CategoryRepositoryInterface;
use Illuminate\Support\Collection;
use Log;
use Preferences;
use Tests\Support\TestDataTrait;
use Tests\TestCase;

/**
 * Class BudgetControllerTest
 * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
 * @SuppressWarnings(PHPMD.ExcessiveMethodLength)
 * @SuppressWarnings(PHPMD.TooManyPublicMethods)
 */
class BudgetControllerTest extends TestCase
{
    use TestDataTrait;
    /**
     *
     */
    public function setUp(): void
    {
        parent::setUp();
        Log::info(sprintf('Now in %s.', get_class($this)));
    }

    /**
     * @covers       \FireflyIII\Http\Controllers\Chart\BudgetController
     * @dataProvider dateRangeProvider
     *
     * @param string $range
     */
    public function testBudget(string $range): void
    {
        $repository = $this->mock(BudgetRepositoryInterface::class);
        $generator  = $this->mock(GeneratorInterface::class);
        $opsRepos   = $this->mock(OperationsRepositoryInterface::class);
        $blRepos    = $this->mock(BudgetLimitRepositoryInterface::class);
        $nbRepos    = $this->mock(NoBudgetRepositoryInterface::class);

        try {
            $date = new Carbon('2015-01-01');
        } catch (Exception $e) {
            $e->getMessage();
        }

        // mock default session
        $this->mockDefaultSession();
        Preferences::shouldReceive('lastActivity')->atLeast()->once()->andReturn('md512345');

        $repository->shouldReceive('firstUseDate')->andReturn($date)->atLeast()->once();
        $opsRepos->shouldReceive('sumExpenses')->andReturn([])->atLeast()->once();


        // multiSet
        $generator->shouldReceive('multiSet')->andReturn([])->atLeast()->once();

        $this->be($this->user());
        $this->changeDateRange($this->user(), $range);
        $response = $this->get(route('chart.budget.budget', [1]));
        $response->assertStatus(200);
    }

    /**
     * @covers       \FireflyIII\Http\Controllers\Chart\BudgetController
     * @dataProvider dateRangeProvider
     *
     * @param string $range
     */
    public function testBudgetLimit(string $range): void
    {
        $repository = $this->mock(BudgetRepositoryInterface::class);
        $generator  = $this->mock(GeneratorInterface::class);
        $opsRepos   = $this->mock(OperationsRepositoryInterface::class);
        $blRepos    = $this->mock(BudgetLimitRepositoryInterface::class);
        $nbRepos    = $this->mock(NoBudgetRepositoryInterface::class);

        // mock default session
        $this->mockDefaultSession();
        Preferences::shouldReceive('lastActivity')->atLeast()->once()->andReturn('md512345');

        $opsRepos->shouldReceive('spentInPeriod')->andReturn('-100')->atLeast()->once();
        $generator->shouldReceive('singleSet')->andReturn([])->atLeast()->once();

        $this->be($this->user());
        $this->changeDateRange($this->user(), $range);
        $response = $this->get(route('chart.budget.budget-limit', [1, 1]));
        $response->assertStatus(200);
    }

    /**
     * @covers \FireflyIII\Http\Controllers\Chart\BudgetController
     */
    public function testBudgetLimitWrongLimit(): void
    {
        $this->mock(BudgetRepositoryInterface::class);
        $this->mock(GeneratorInterface::class);
        $opsRepos = $this->mock(OperationsRepositoryInterface::class);
        $blRepos  = $this->mock(BudgetLimitRepositoryInterface::class);
        $nbRepos  = $this->mock(NoBudgetRepositoryInterface::class);

        $budget = $this->getRandomBudget();
        $limit  = BudgetLimit::where('budget_id', '!=', $budget->id)->first();

        // mock default session
        $this->mockDefaultSession();

        Log::warning('The following error is part of a test.');
        $this->be($this->user());
        $response = $this->get(route('chart.budget.budget-limit', [$budget->id, $limit->id]));
        $response->assertStatus(500);
    }

    /**
     * @covers       \FireflyIII\Http\Controllers\Chart\BudgetController
     * @dataProvider dateRangeProvider
     *
     * @param string $range
     */
    public function testExpenseAsset(string $range): void
    {
        $this->mock(BudgetRepositoryInterface::class);
        $generator    = $this->mock(GeneratorInterface::class);
        $collector    = $this->mock(GroupCollectorInterface::class);
        $accountRepos = $this->mock(AccountRepositoryInterface::class);
        $opsRepos     = $this->mock(OperationsRepositoryInterface::class);
        $blRepos      = $this->mock(BudgetLimitRepositoryInterface::class);
        $nbRepos      = $this->mock(NoBudgetRepositoryInterface::class);

        $withdrawal  = $this->getRandomWithdrawalAsArray();
        $destination = $this->user()->accounts()->find($withdrawal['destination_account_id']);

        // mock default session
        $this->mockDefaultSession();
        Preferences::shouldReceive('lastActivity')->atLeast()->once()->andReturn('md512345');

        $accountRepos->shouldReceive('getAccountsByType')->andReturn(new Collection([$destination]))->atLeast()->once();
        $collector->shouldReceive('setBudget')->andReturnSelf()->atLeast()->once();
        $collector->shouldReceive('setRange')->andReturnSelf()->atLeast()->once();
        $collector->shouldReceive('setCurrency')->andReturnSelf()->atLeast()->once();
        $collector->shouldReceive('getExtractedJournals')->andReturn([$withdrawal])->atLeast()->once();

        $generator->shouldReceive('multiCurrencyPieChart')->atLeast()->once()->andReturn([]);

        $this->be($this->user());
        $this->changeDateRange($this->user(), $range);
        $response = $this->get(route('chart.budget.expense-asset', [1, 1]));
        $response->assertStatus(200);
    }

    /**
     * @covers       \FireflyIII\Http\Controllers\Chart\BudgetController
     * @dataProvider dateRangeProvider
     *
     * @param string $range
     */
    public function testExpenseCategory(string $range): void
    {
        $this->mock(BudgetRepositoryInterface::class);
        $generator = $this->mock(GeneratorInterface::class);
        $collector = $this->mock(GroupCollectorInterface::class);
        $catRepos  = $this->mock(CategoryRepositoryInterface::class);
        $opsRepos  = $this->mock(OperationsRepositoryInterface::class);
        $blRepos   = $this->mock(BudgetLimitRepositoryInterface::class);
        $nbRepos   = $this->mock(NoBudgetRepositoryInterface::class);

        $withdrawal = $this->getRandomWithdrawalAsArray();
        $category   = $this->user()->categories()->find($withdrawal['category_id']);

        // mock default session
        $this->mockDefaultSession();
        Preferences::shouldReceive('lastActivity')->atLeast()->once()->andReturn('md512345');

        $collector->shouldReceive('setBudget')->andReturnSelf()->atLeast()->once();
        $collector->shouldReceive('setRange')->andReturnSelf()->atLeast()->once();
        $collector->shouldReceive('withCategoryInformation')->andReturnSelf()->atLeast()->once();
        $collector->shouldReceive('getExtractedJournals')->andReturn([$withdrawal])->atLeast()->once();
        $collector->shouldReceive('setCurrency')->andReturnSelf()->atLeast()->once();

        $catRepos->shouldReceive('getCategories')->andReturn(new Collection([$category]))->atLeast()->once();

        $generator->shouldReceive('multiCurrencyPieChart')->andReturn([])->atLeast()->once();

        $this->be($this->user());
        $this->changeDateRange($this->user(), $range);
        $response = $this->get(route('chart.budget.expense-category', [1, 1]));
        $response->assertStatus(200);
    }

    /**
     * @covers       \FireflyIII\Http\Controllers\Chart\BudgetController
     * @dataProvider dateRangeProvider
     *
     * @param string $range
     */
    public function testExpenseExpense(string $range): void
    {
        $this->mock(BudgetRepositoryInterface::class);
        $generator    = $this->mock(GeneratorInterface::class);
        $collector    = $this->mock(GroupCollectorInterface::class);
        $accountRepos = $this->mock(AccountRepositoryInterface::class);
        $opsRepos     = $this->mock(OperationsRepositoryInterface::class);
        $blRepos      = $this->mock(BudgetLimitRepositoryInterface::class);
        $nbRepos      = $this->mock(NoBudgetRepositoryInterface::class);

        $withdrawal  = $this->getRandomWithdrawalAsArray();
        $destination = $this->user()->accounts()->find($withdrawal['destination_account_id']);

        // mock default session
        $this->mockDefaultSession();
        Preferences::shouldReceive('lastActivity')->atLeast()->once()->andReturn('md512345');


        $collector->shouldReceive('withAccountInformation')->andReturnSelf()->atLeast()->once();
        $collector->shouldReceive('setTypes')->withArgs([[TransactionType::WITHDRAWAL]])->andReturnSelf()->atLeast()->once();
        $collector->shouldReceive('setBudget')->andReturnSelf()->atLeast()->once();
        $collector->shouldReceive('setRange')->andReturnSelf()->atLeast()->once();
        $collector->shouldReceive('setCurrency')->andReturnSelf()->atLeast()->once();
        $collector->shouldReceive('getExtractedJournals')->andReturn([$withdrawal])->atLeast()->once();

        $accountRepos->shouldReceive('getAccountsByType')->andReturn(new Collection([$destination]))->atLeast()->once();

        $generator->shouldReceive('multiCurrencyPieChart')->once()->andReturn([]);

        $this->be($this->user());
        $this->changeDateRange($this->user(), $range);
        $response = $this->get(route('chart.budget.expense-expense', [1, 1]));
        $response->assertStatus(200);
    }

    /**
     * @covers       \FireflyIII\Http\Controllers\Chart\BudgetController
     * @dataProvider dateRangeProvider
     *
     * @param string $range
     */
    public function testFrontPage(string $range): void
    {
        $repository = $this->mock(BudgetRepositoryInterface::class);
        $generator  = $this->mock(GeneratorInterface::class);
        $collector  = $this->mock(GroupCollectorInterface::class);
        $opsRepos   = $this->mock(OperationsRepositoryInterface::class);
        $blRepos    = $this->mock(BudgetLimitRepositoryInterface::class);
        $nbRepos    = $this->mock(NoBudgetRepositoryInterface::class);

        $budget      = $this->getRandomBudget();
        $budgetLimit = $this->getRandomBudgetLimit();

        // mock default session
        $this->mockDefaultSession();
        Preferences::shouldReceive('lastActivity')->atLeast()->once()->andReturn('md512345');


        $repository->shouldReceive('getActiveBudgets')->andReturn(new Collection([$budget]))->atLeast()->once();
        $blRepos->shouldReceive('getBudgetLimits')->atLeast()->once()->andReturn(new Collection([$budgetLimit]));
        //$opsRepos->shouldReceive('spentInPeriod')->andReturn('-100')->atLeast()->once();
        $opsRepos->shouldReceive('sumExpenses')->atLeast()->once()->andReturn($this->budgetSumExpenses());

        //$collector->shouldReceive('setTypes')->withArgs([[TransactionType::WITHDRAWAL]])->andReturnSelf()->atLeast()->once();
        //$collector->shouldReceive('setRange')->andReturnSelf()->atLeast()->once();
        //$collector->shouldReceive('withoutBudget')->andReturnSelf()->atLeast()->once();
        //$collector->shouldReceive('getSum')->andReturn('-100')->atLeast()->once();

        $generator->shouldReceive('multiSet')->andReturn([])->atLeast()->once();

        $this->be($this->user());
        $this->changeDateRange($this->user(), $range);
        $response = $this->get(route('chart.budget.frontpage'));
        $response->assertStatus(200);
    }

    /**
     * @covers       \FireflyIII\Http\Controllers\Chart\BudgetController
     * @dataProvider dateRangeProvider
     *
     * @param string $range
     */
    public function testFrontpageMultiLimit(string $range): void
    {

        $repository = $this->mock(BudgetRepositoryInterface::class);
        $generator  = $this->mock(GeneratorInterface::class);
        $collector  = $this->mock(GroupCollectorInterface::class);
        $opsRepos   = $this->mock(OperationsRepositoryInterface::class);
        $blRepos    = $this->mock(BudgetLimitRepositoryInterface::class);
        $nbRepos    = $this->mock(NoBudgetRepositoryInterface::class);

        $budget = $this->getRandomBudget();
        $limit1 = $this->getRandomBudgetLimit();
        $limit2 = $this->getRandomBudgetLimit();

        // mock default session
        $this->mockDefaultSession();
        Preferences::shouldReceive('lastActivity')->atLeast()->once()->andReturn('md512345');

        $repository->shouldReceive('getActiveBudgets')->andReturn(new Collection([$budget]))->once();
        $blRepos->shouldReceive('getBudgetLimits')->once()->andReturn(new Collection([$limit1, $limit2]));
        //$opsRepos->shouldReceive('spentInPeriod')->andReturn('-100')->atLeast()->once();

//        $collector->shouldReceive('setTypes')->withArgs([[TransactionType::WITHDRAWAL]])->andReturnSelf()->once();
//        $collector->shouldReceive('setRange')->andReturnSelf()->once();
//        $collector->shouldReceive('withoutBudget')->andReturnSelf()->once();
//        $collector->shouldReceive('getSum')->andReturn('-100')->atLeast()->once();
        $opsRepos->shouldReceive('sumExpenses')->atLeast()->once()->andReturn($this->budgetSumExpenses());

        $generator->shouldReceive('multiSet')->once()->andReturn([]);

        $this->be($this->user());
        $this->changeDateRange($this->user(), $range);
        $response = $this->get(route('chart.budget.frontpage'));
        $response->assertStatus(200);
    }

    /**
     * @covers       \FireflyIII\Http\Controllers\Chart\BudgetController
     * @dataProvider dateRangeProvider
     *
     * @param string $range
     */
    public function testFrontpageNoLimits(string $range): void
    {

        $repository = $this->mock(BudgetRepositoryInterface::class);
        $generator  = $this->mock(GeneratorInterface::class);
        $collector  = $this->mock(GroupCollectorInterface::class);
        $opsRepos   = $this->mock(OperationsRepositoryInterface::class);
        $blRepos    = $this->mock(BudgetLimitRepositoryInterface::class);
        $nbRepos    = $this->mock(NoBudgetRepositoryInterface::class);

        $budget = $this->getRandomBudget();

        // mock default session
        $this->mockDefaultSession();
        Preferences::shouldReceive('lastActivity')->atLeast()->once()->andReturn('md512345');

        $repository->shouldReceive('getActiveBudgets')->andReturn(new Collection([$budget]))->atLeast()->once();
        $blRepos->shouldReceive('getBudgetLimits')->once()->andReturn(new Collection);
        $opsRepos->shouldReceive('sumExpenses')->atLeast()->once()->andReturn($this->budgetSumExpenses());
        $generator->shouldReceive('multiSet')->once()->andReturn([]);

        $this->be($this->user());
        $this->changeDateRange($this->user(), $range);
        $response = $this->get(route('chart.budget.frontpage'));
        $response->assertStatus(200);
    }

    /**
     * @covers \FireflyIII\Http\Controllers\Chart\BudgetController
     */
    public function testPeriod(): void
    {
        $repository   = $this->mock(BudgetRepositoryInterface::class);
        $generator    = $this->mock(GeneratorInterface::class);
        $budgetLimit  = $this->getRandomBudgetLimit();
        $fiscalHelper = $this->mock(FiscalHelperInterface::class);
        $opsRepos     = $this->mock(OperationsRepositoryInterface::class);
        $blRepos      = $this->mock(BudgetLimitRepositoryInterface::class);
        $nbRepos      = $this->mock(NoBudgetRepositoryInterface::class);

        $date = new Carbon;

        // mock default session
        $this->mockDefaultSession();
        Preferences::shouldReceive('lastActivity')->atLeast()->once()->andReturn('md512345');


        $fiscalHelper->shouldReceive('endOfFiscalYear')->atLeast()->once()->andReturn($date);
        $fiscalHelper->shouldReceive('startOfFiscalYear')->atLeast()->once()->andReturn($date);

        $blRepos->shouldReceive('find')->atLeast()->once()->andReturn($budgetLimit);
        $generator->shouldReceive('multiSet')->once()->andReturn([]);
        $opsRepos->shouldReceive('sumExpenses')->atLeast()->once()->andReturn($this->budgetSumExpenses());

        $this->be($this->user());
        $response = $this->get(route('chart.budget.period', [$budgetLimit->budget_id, 1, 1, '20120101', '20120131']));
        $response->assertStatus(200);
    }

    /**
     * @covers \FireflyIII\Http\Controllers\Chart\BudgetController
     */
    public function testPeriodNoBudget(): void
    {
        $repository   = $this->mock(BudgetRepositoryInterface::class);
        $generator    = $this->mock(GeneratorInterface::class);
        $fiscalHelper = $this->mock(FiscalHelperInterface::class);
        $opsRepos     = $this->mock(OperationsRepositoryInterface::class);
        $blRepos      = $this->mock(BudgetLimitRepositoryInterface::class);
        $nbRepos      = $this->mock(NoBudgetRepositoryInterface::class);

        $date = new Carbon;

        // mock default session
        $this->mockDefaultSession();
        Preferences::shouldReceive('lastActivity')->atLeast()->once()->andReturn('md512345');

        $fiscalHelper->shouldReceive('endOfFiscalYear')->atLeast()->once()->andReturn($date);
        $fiscalHelper->shouldReceive('startOfFiscalYear')->atLeast()->once()->andReturn($date);

        $generator->shouldReceive('singleSet')->once()->andReturn([]);

        $nbRepos->shouldReceive('sumExpenses')->atLeast()->once()->andReturn($this->budgetSumExpenses());

        $this->be($this->user());
        $response = $this->get(route('chart.budget.period.no-budget', ['1','1', '20120101', '20120131']));
        $response->assertStatus(200);
    }
}