First tests for transformers.

This commit is contained in:
James Cole
2018-02-16 22:14:34 +01:00
parent 645a29e22b
commit 278b7ac52b
6 changed files with 638 additions and 18 deletions

View File

@@ -0,0 +1,88 @@
<?php
/**
* AboutControllerTest.php
* Copyright (c) 2018 thegrumpydictator@gmail.com
*
* This file is part of Firefly III.
*
* Firefly III is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Firefly III 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Firefly III. If not, see <http://www.gnu.org/licenses/>.
*/
declare(strict_types=1);
namespace Tests\Api\V1\Controllers;
use FireflyIII\Transformers\UserTransformer;
use Laravel\Passport\Passport;
use Tests\TestCase;
/**
* Class AboutControllerTest
* @runTestsInSeparateProcesses
* @preserveGlobalState disabled
*/
class AboutControllerTest extends TestCase
{
/** @var array */
protected $transformed
= [
'id' => 1,
'email' => 'some@user',
'links' => [
'rel' => 'self',
'uri' => '/users/1',
],
];
public function setUp()
{
parent::setUp();
Passport::actingAs($this->user());
}
/**
* @covers \FireflyIII\Api\V1\Controllers\AboutController::about
*/
public function testAbout()
{
// test API
$response = $this->get('/api/v1/about');
$response->assertStatus(200);
$response->assertJson(
['data' => [
'version' => true,
'api_version' => true,
'php_version' => true,
]]
);
}
/**
* @covers \FireflyIII\Api\V1\Controllers\AboutController::user
*/
public function testUser()
{
// mock stuff:
$transformer = $this->overload(UserTransformer::class);
$transformer->shouldReceive('setCurrentScope')->andReturnSelf();
$transformer->shouldReceive('transform')->andReturn($this->transformed);
// test API
$response = $this->get('/api/v1/about/user');
$response->assertStatus(200);
$response->assertJson(['data' => ['attributes' => true, 'links' => true]]);
}
}

View File

@@ -0,0 +1,78 @@
<?php
/**
* AccountControllerTest.php
* Copyright (c) 2018 thegrumpydictator@gmail.com
*
* This file is part of Firefly III.
*
* Firefly III is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Firefly III 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Firefly III. If not, see <http://www.gnu.org/licenses/>.
*/
declare(strict_types=1);
namespace Tests\Api\V1\Controllers;
use FireflyIII\Models\Account;
use FireflyIII\Repositories\Account\AccountRepositoryInterface;
use FireflyIII\Transformers\AccountTransformer;
use Laravel\Passport\Passport;
use Tests\TestCase;
/**
* Class AccountControllerTest
*/
class AccountControllerTest extends TestCase
{
/** @var array */
protected $transformed
= [
'id' => 1,
'name' => 'Some account',
'links' => [
'rel' => 'self',
'uri' => '/accounts/1',
],
];
public function setUp()
{
parent::setUp();
Passport::actingAs($this->user());
}
/**
* @covers \FireflyIII\Api\V1\Controllers\AccountController::index
*/
public function testIndex()
{
// mock stuff:
$repository = $this->mock(AccountRepositoryInterface::class);
$transformer = $this->overload(AccountTransformer::class);
$transformer->shouldReceive('setCurrentScope')->andReturnSelf();
$transformer->shouldReceive('transform')->andReturn($this->transformed);
$accounts = factory(Account::class, 10)->create();
$repository->shouldReceive('setUser')->once();
$repository->shouldReceive('getAccountsByType')->withAnyArgs()->andReturn($accounts)->once();
$response = $this->get('/api/v1/accounts');
$response->assertStatus(200);
$response->assertJson(['data' => []]);
$response->assertJson(['meta' => []]);
$response->assertJson(['links' => []]);
$response->assertSee('type=all'); // default returns this.
}
}

View File

@@ -128,4 +128,17 @@ abstract class TestCase extends BaseTestCase
return $object;
}
/**
* @param string $class
*
* @return Mockery\MockInterface
*/
protected function overload(string $class)
{
$externalMock = Mockery::mock('overload:' . $class);
//$this->app->instance($class, $externalMock);
return $externalMock;
}
}

View File

@@ -0,0 +1,399 @@
<?php
/**
* AccountTransformerTest.php
* Copyright (c) 2018 thegrumpydictator@gmail.com
*
* This file is part of Firefly III.
*
* Firefly III is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Firefly III 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Firefly III. If not, see <http://www.gnu.org/licenses/>.
*/
declare(strict_types=1);
namespace Tests\Unit\Transformers;
use Carbon\Carbon;
use FireflyIII\Models\Account;
use FireflyIII\Models\AccountMeta;
use FireflyIII\Models\Note;
use FireflyIII\Models\Transaction;
use FireflyIII\Models\TransactionJournal;
use FireflyIII\Transformers\AccountTransformer;
use Symfony\Component\HttpFoundation\ParameterBag;
use Tests\TestCase;
/**
* Class AccountTransformerTest
*/
class AccountTransformerTest extends TestCase
{
/**
* Basic account display.
*
* @covers \FireflyIII\Transformers\AccountTransformer::transform
*/
public function testBasic()
{
// make new account:
$account = Account::create(
[
'user_id' => $this->user()->id,
'account_type_id' => 3, // asset account
'name' => 'Random name #' . rand(1, 10000),
'virtual_balance' => 12.34,
'iban' => 'NL85ABNA0466812694',
'active' => 1,
'encrypted' => 0,
]
);
$transformer = new AccountTransformer(new ParameterBag);
$result = $transformer->transform($account);
$this->assertEquals($account->name, $result['name']);
$this->assertEquals('Asset account', $result['type']);
$this->assertEquals(12.34, $result['virtual_balance']);
$this->assertEquals(12.34, $result['current_balance']);
$this->assertNull($result['opening_balance']);
$this->assertNull($result['opening_balance_date']);
}
/**
* Basic account display with custom date parameter.
*
* @covers \FireflyIII\Transformers\AccountTransformer::transform
*/
public function testBasicDate()
{
// make new account:
$account = Account::create(
[
'user_id' => $this->user()->id,
'account_type_id' => 3, // asset account
'name' => 'Random name #' . rand(1, 10000),
'virtual_balance' => 12.34,
'iban' => 'NL85ABNA0466812694',
'active' => 1,
'encrypted' => 0,
]
);
$parameterBag = new ParameterBag;
$parameterBag->set('date', new Carbon('2018-01-01'));
$transformer = new AccountTransformer($parameterBag);
$result = $transformer->transform($account);
$this->assertEquals($account->name, $result['name']);
$this->assertEquals('Asset account', $result['type']);
$this->assertEquals(12.34, $result['virtual_balance']);
$this->assertEquals(12.34, $result['current_balance']);
$this->assertEquals('2018-01-01', $result['current_balance_date']);
}
/**
* Assert account has credit card meta data, should NOT be ignored in output.
*
* @covers \FireflyIII\Transformers\AccountTransformer::transform
*/
public function testCCDataAsset()
{
// make new account:
$account = Account::create(
[
'user_id' => $this->user()->id,
'account_type_id' => 3, // asset account
'name' => 'Random name #' . rand(1, 10000),
'virtual_balance' => 12.34,
'iban' => 'NL85ABNA0466812694',
'active' => 1,
'encrypted' => 0,
]
);
// add currency preference:
AccountMeta::create(
[
'account_id' => $account->id,
'name' => 'currency_id',
'data' => 1, // euro
]
);
// add a note:
$note = Note::create(
[
'noteable_id' => $account->id,
'noteable_type' => Account::class,
'title' => null,
'text' => 'I am a note #' . rand(1, 1000),
]
);
// add credit card meta data (will be ignored)
AccountMeta::create(
[
'account_id' => $account->id,
'name' => 'accountRole',
'data' => 'ccAsset',
]
);
AccountMeta::create(
[
'account_id' => $account->id,
'name' => 'ccMonthlyPaymentDate',
'data' => '2018-02-01',
]
);
AccountMeta::create(
[
'account_id' => $account->id,
'name' => 'ccType',
'data' => 'monthlyFull',
]
);
$transformer = new AccountTransformer(new ParameterBag);
$result = $transformer->transform($account);
$this->assertEquals($account->name, $result['name']);
$this->assertEquals('Asset account', $result['type']);
$this->assertEquals(12.34, $result['virtual_balance']);
$this->assertEquals(12.34, $result['current_balance']);
$this->assertEquals(1, $result['currency_id']);
$this->assertEquals('EUR', $result['currency_code']);
$this->assertEquals($note->text, $result['notes']);
$this->assertEquals('2018-02-01', $result['monthly_payment_date']);
$this->assertEquals('monthlyFull', $result['credit_card_type']);
$this->assertEquals('ccAsset', $result['role']);
}
/**
* Expense account has credit card meta data, should be ignored in output.
*
* @covers \FireflyIII\Transformers\AccountTransformer::transform
*/
public function testIgnoreCCExpense()
{
// make new account:
$account = Account::create(
[
'user_id' => $this->user()->id,
'account_type_id' => 4, // expense account
'name' => 'Random name #' . rand(1, 10000),
'virtual_balance' => 12.34,
'iban' => 'NL85ABNA0466812694',
'active' => 1,
'encrypted' => 0,
]
);
// add currency preference:
AccountMeta::create(
[
'account_id' => $account->id,
'name' => 'currency_id',
'data' => 1, // euro
]
);
// add a note:
$note = Note::create(
[
'noteable_id' => $account->id,
'noteable_type' => Account::class,
'title' => null,
'text' => 'I am a note #' . rand(1, 1000),
]
);
// add credit card meta data (will be ignored)
AccountMeta::create(
[
'account_id' => $account->id,
'name' => 'accountRole',
'data' => 'ccAsset',
]
);
AccountMeta::create(
[
'account_id' => $account->id,
'name' => 'ccMonthlyPaymentDate',
'data' => '2018-02-01',
]
);
AccountMeta::create(
[
'account_id' => $account->id,
'name' => 'ccType',
'data' => 'monthlyFull',
]
);
$transformer = new AccountTransformer(new ParameterBag);
$result = $transformer->transform($account);
$this->assertEquals($account->name, $result['name']);
$this->assertEquals('Expense account', $result['type']);
$this->assertEquals(12.34, $result['virtual_balance']);
$this->assertEquals(12.34, $result['current_balance']);
$this->assertEquals(1, $result['currency_id']);
$this->assertEquals('EUR', $result['currency_code']);
$this->assertEquals($note->text, $result['notes']);
$this->assertNull($result['monthly_payment_date']);
$this->assertNull($result['credit_card_type']);
$this->assertNull($result['role']);
}
/**
* Basic account display.
*
* @covers \FireflyIII\Transformers\AccountTransformer::transform
*/
public function testOpeningBalance()
{
// make new account:
$account = Account::create(
[
'user_id' => $this->user()->id,
'account_type_id' => 3, // asset account
'name' => 'Random name #' . rand(1, 10000),
'virtual_balance' => 12.34,
'iban' => 'NL85ABNA0466812694',
'active' => 1,
'encrypted' => 0,
]
);
// create opening balance:
$journal = TransactionJournal::create(
[
'user_id' => $this->user()->id,
'transaction_type_id' => 4, // opening balance
'transaction_currency_id' => 1, // EUR
'description' => 'Opening',
'date' => '2018-01-01',
'completed' => 1,
]
);
$transaction = Transaction::create(
[
'account_id' => $account->id,
'transaction_journal_id' => $journal->id,
'transaction_currency_id' => 1,
'amount' => '45.67',
]
);
$transformer = new AccountTransformer(new ParameterBag);
$result = $transformer->transform($account);
$this->assertEquals($account->name, $result['name']);
$this->assertEquals('Asset account', $result['type']);
$this->assertEquals(12.34, $result['virtual_balance']);
$this->assertEquals(58.01, $result['current_balance']); // add opening balance.
$this->assertEquals(45.67, $result['opening_balance']);
$this->assertEquals('2018-01-01', $result['opening_balance_date']);
}
/**
* Account has currency preference, should be reflected in output.
*
* @covers \FireflyIII\Transformers\AccountTransformer::transform
*/
public function testWithCurrency()
{
// make new account:
$account = Account::create(
[
'user_id' => $this->user()->id,
'account_type_id' => 3, // asset account
'name' => 'Random name #' . rand(1, 10000),
'virtual_balance' => 12.34,
'iban' => 'NL85ABNA0466812694',
'active' => 1,
'encrypted' => 0,
]
);
// add currency preference:
AccountMeta::create(
[
'account_id' => $account->id,
'name' => 'currency_id',
'data' => 1, // euro
]
);
$transformer = new AccountTransformer(new ParameterBag);
$result = $transformer->transform($account);
$this->assertEquals($account->name, $result['name']);
$this->assertEquals('Asset account', $result['type']);
$this->assertEquals(12.34, $result['virtual_balance']);
$this->assertEquals(12.34, $result['current_balance']);
$this->assertEquals(1, $result['currency_id']);
$this->assertEquals('EUR', $result['currency_code']);
}
/**
* Account has notes, should be reflected in output.
*
* @covers \FireflyIII\Transformers\AccountTransformer::transform
*/
public function testWithNotes()
{
// make new account:
$account = Account::create(
[
'user_id' => $this->user()->id,
'account_type_id' => 3, // asset account
'name' => 'Random name #' . rand(1, 10000),
'virtual_balance' => 12.34,
'iban' => 'NL85ABNA0466812694',
'active' => 1,
'encrypted' => 0,
]
);
// add currency preference:
AccountMeta::create(
[
'account_id' => $account->id,
'name' => 'currency_id',
'data' => 1, // euro
]
);
// add a note:
$note = Note::create(
[
'noteable_id' => $account->id,
'noteable_type' => Account::class,
'title' => null,
'text' => 'I am a note #' . rand(1, 1000),
]
);
$transformer = new AccountTransformer(new ParameterBag);
$result = $transformer->transform($account);
$this->assertEquals($account->name, $result['name']);
$this->assertEquals('Asset account', $result['type']);
$this->assertEquals(12.34, $result['virtual_balance']);
$this->assertEquals(12.34, $result['current_balance']);
$this->assertEquals(1, $result['currency_id']);
$this->assertEquals('EUR', $result['currency_code']);
$this->assertEquals($note->text, $result['notes']);
}
}