firefly-iii/tests/Api/V1/Controllers/AvailableBudgetControllerTest.php

<?php
/**
 * AvailableBudgetControllerTest.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\Api\V1\Controllers;

use Amount;
use FireflyIII\Factory\TransactionCurrencyFactory;
use FireflyIII\Models\AvailableBudget;
use FireflyIII\Models\TransactionCurrency;
use FireflyIII\Repositories\Budget\AvailableBudgetRepositoryInterface;
use FireflyIII\Repositories\Currency\CurrencyRepositoryInterface;
use FireflyIII\Transformers\AvailableBudgetTransformer;
use Laravel\Passport\Passport;
use Log;
use Tests\TestCase;

/**
 *
 * Class AvailableBudgetControllerTest
 * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
 * @SuppressWarnings(PHPMD.ExcessiveMethodLength)
 * @SuppressWarnings(PHPMD.TooManyPublicMethods)
 */
class AvailableBudgetControllerTest extends TestCase
{
    /**
     *
     */
    public function setUp(): void
    {
        parent::setUp();
        Passport::actingAs($this->user());
        $this->mockDefaultConfiguration();
        Log::info(sprintf('Now in %s.', get_class($this)));
    }

    /**
     * Store new available budget.
     *
     * @covers \FireflyIII\Api\V1\Controllers\AvailableBudgetController
     */
    public function testStore(): void
    {
        Log::info(sprintf('Now in test %s.', __METHOD__));
        $abRepository    = $this->mock(AvailableBudgetRepositoryInterface::class);
        $transformer     = $this->mock(AvailableBudgetTransformer::class);
        $factory         = $this->mock(TransactionCurrencyFactory::class);
        $availableBudget = new AvailableBudget;

        // mock transformer
        $transformer->shouldReceive('setParameters')->withAnyArgs()->atLeast()->once();
        $transformer->shouldReceive('setCurrentScope')->withAnyArgs()->atLeast()->once()->andReturnSelf();
        $transformer->shouldReceive('getDefaultIncludes')->withAnyArgs()->atLeast()->once()->andReturn([]);
        $transformer->shouldReceive('getAvailableIncludes')->withAnyArgs()->atLeast()->once()->andReturn([]);
        $transformer->shouldReceive('transform')->atLeast()->once()->andReturn(['id' => 5]);
        $factory->shouldReceive('find')->withArgs([2, ''])->once()->andReturn(TransactionCurrency::find(2));

        // mock calls:
        $abRepository->shouldReceive('setUser')->atLeast()->once();
        $abRepository->shouldReceive('store')->once()->andReturn($availableBudget);

        // data to submit
        $data = [
            'currency_id' => '2',
            'amount'      => '100',
            'start'       => '2018-01-01',
            'end'         => '2018-01-31',
        ];


        // test API
        $response = $this->post(route('api.v1.available_budgets.store'), $data);
        $response->assertStatus(200);
        $response->assertJson(['data' => ['type' => 'available_budgets', 'links' => true],]);
        $response->assertHeader('Content-Type', 'application/vnd.api+json');
    }

    /**
     * Store new available budget without a valid currency.
     *
     * @covers \FireflyIII\Api\V1\Controllers\AvailableBudgetController
     */
    public function testStoreNoCurrencyAtAll(): void
    {
        Log::info(sprintf('Now in test %s.', __METHOD__));
        // mock stuff:
        $transformer     = $this->mock(AvailableBudgetTransformer::class);
        $factory         = $this->mock(TransactionCurrencyFactory::class);
        $abRepository    = $this->mock(AvailableBudgetRepositoryInterface::class);
        $availableBudget = new AvailableBudget;

        // mock transformer
        $transformer->shouldReceive('setParameters')->withAnyArgs()->atLeast()->once();
        $transformer->shouldReceive('setCurrentScope')->withAnyArgs()->atLeast()->once()->andReturnSelf();
        $transformer->shouldReceive('getDefaultIncludes')->withAnyArgs()->atLeast()->once()->andReturn([]);
        $transformer->shouldReceive('getAvailableIncludes')->withAnyArgs()->atLeast()->once()->andReturn([]);
        $transformer->shouldReceive('transform')->atLeast()->once()->andReturn(['id' => 5]);
        $factory->shouldReceive('find')->withArgs([0, ''])->once()->andReturnNull();

        Amount::shouldReceive('getDefaultCurrency')->once()->andReturn(TransactionCurrency::find(5));

        // mock calls:
        $abRepository->shouldReceive('setUser')->atLeast()->once();
        $abRepository->shouldReceive('store')->once()->andReturn($availableBudget);

        // data to submit
        $data = [
            'amount' => '100',
            'start'  => '2018-01-01',
            'end'    => '2018-01-31',
        ];


        // test API
        $response = $this->post(route('api.v1.available_budgets.store'), $data);
        $response->assertStatus(200);
        $response->assertHeader('Content-Type', 'application/vnd.api+json');
    }

    /**
     * Store new available budget without a valid currency.
     *
     * @covers \FireflyIII\Api\V1\Controllers\AvailableBudgetController
     */
    public function testStoreNoCurrencyId(): void
    {
        Log::info(sprintf('Now in test %s.', __METHOD__));
        /** @var AvailableBudget $availableBudget */
        $availableBudget = $this->user()->availableBudgets()->first();

        // mock stuff:
        $abRepository = $this->mock(AvailableBudgetRepositoryInterface::class);
        $transformer  = $this->mock(AvailableBudgetTransformer::class);
        $factory      = $this->mock(TransactionCurrencyFactory::class);

        // mock transformer
        $transformer->shouldReceive('setParameters')->withAnyArgs()->atLeast()->once();
        $transformer->shouldReceive('setCurrentScope')->withAnyArgs()->atLeast()->once()->andReturnSelf();
        $transformer->shouldReceive('getDefaultIncludes')->withAnyArgs()->atLeast()->once()->andReturn([]);
        $transformer->shouldReceive('getAvailableIncludes')->withAnyArgs()->atLeast()->once()->andReturn([]);
        $transformer->shouldReceive('transform')->atLeast()->once()->andReturn(['id' => 5]);

        $factory->shouldReceive('find')->withArgs([0, 'EUR'])->once()->andReturnNull();
        Amount::shouldReceive('getDefaultCurrency')->once()->andReturn(TransactionCurrency::find(5));

        // mock calls:
        $abRepository->shouldReceive('setUser')->once();
        $abRepository->shouldReceive('store')->once()->andReturn($availableBudget);

        // data to submit
        $data = [
            'currency_code' => 'EUR',
            'amount'        => '100',
            'start'         => '2018-01-01',
            'end'           => '2018-01-31',
        ];


        // test API
        $response = $this->post(route('api.v1.available_budgets.store'), $data);
        $response->assertStatus(200);
        $response->assertJson(['data' => ['type' => 'available_budgets', 'links' => true],]);
        $response->assertHeader('Content-Type', 'application/vnd.api+json');
    }

    /**
     * Update available budget.
     *
     * @covers \FireflyIII\Api\V1\Controllers\AvailableBudgetController
     *
     */
    public function testUpdate(): void
    {
        Log::info(sprintf('Now in test %s.', __METHOD__));
        // mock repositories
        $abRepository       = $this->mock(AvailableBudgetRepositoryInterface::class);
        $currencyRepository = $this->mock(CurrencyRepositoryInterface::class);
        $transformer        = $this->mock(AvailableBudgetTransformer::class);
        $factory            = $this->mock(TransactionCurrencyFactory::class);
        $euro               = $this->getEuro();
        // mock facades:
        Amount::shouldReceive('getDefaultCurrency')->atLeast()->once()->andReturn($euro);

        // mock transformer
        $transformer->shouldReceive('setParameters')->withAnyArgs()->atLeast()->once();
        $transformer->shouldReceive('setCurrentScope')->withAnyArgs()->atLeast()->once()->andReturnSelf();
        $transformer->shouldReceive('getDefaultIncludes')->withAnyArgs()->atLeast()->once()->andReturn([]);
        $transformer->shouldReceive('getAvailableIncludes')->withAnyArgs()->atLeast()->once()->andReturn([]);
        $transformer->shouldReceive('transform')->atLeast()->once()->andReturn(['id' => 5]);

        $factory->shouldReceive('find')->withArgs([1, ''])->once()->andReturnNull();

        /** @var AvailableBudget $availableBudget */
        $availableBudget = $this->user()->availableBudgets()->first();

        // mock calls:
        $abRepository->shouldReceive('setUser');
        $abRepository->shouldReceive('updateAvailableBudget')->once()->andReturn($availableBudget);
        $currencyRepository->shouldReceive('findNull')->andReturn($this->getEuro());

        // data to submit
        $data = [
            'currency_id' => '1',
            'amount'      => '100',
            'start'       => '2018-01-01',
            'end'         => '2018-01-31',
        ];

        // test API
        $response = $this->put(route('api.v1.available_budgets.update', $availableBudget->id), $data, ['Accept' => 'application/json']);
        $response->assertStatus(200);
        $response->assertJson(['data' => ['type' => 'available_budgets', 'links' => true],]);
        $response->assertHeader('Content-Type', 'application/vnd.api+json');
    }


}