Expand test coverage.

This commit is contained in:
James Cole
2018-01-05 17:29:42 +01:00
parent c329ffa545
commit 3e9f98b43e
24 changed files with 1150 additions and 93 deletions

View File

@@ -0,0 +1,300 @@
<?php
/**
* CsvProcessorTest.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\Import\FileProcessor;
use FireflyIII\Import\FileProcessor\CsvProcessor;
use FireflyIII\Import\Specifics\AbnAmroDescription;
use FireflyIII\Models\ImportJob;
use FireflyIII\Repositories\ImportJob\ImportJobRepositoryInterface;
use Mockery;
use Tests\TestCase;
/**
* Class CsvProcessorTest
*/
class CsvProcessorTest extends TestCase
{
/**
* @covers \FireflyIII\Import\FileProcessor\CsvProcessor::__construct
* @covers \FireflyIII\Import\FileProcessor\CsvProcessor::getObjects
* @expectedException \FireflyIII\Exceptions\FireflyException
* @expectedExceptionMessage Cannot call getObjects() without a job.
*/
public function testGetObjectsNoJob()
{
$processor = new CsvProcessor();
$processor->getObjects();
}
/**
* @covers \FireflyIII\Import\FileProcessor\CsvProcessor::run
* @covers \FireflyIII\Import\FileProcessor\CsvProcessor::getImportArray
* @covers \FireflyIII\Import\FileProcessor\CsvProcessor::getObjects
* @covers \FireflyIII\Import\FileProcessor\CsvProcessor::setJob
* @covers \FireflyIII\Import\FileProcessor\CsvProcessor::importRow
* @covers \FireflyIII\Import\FileProcessor\CsvProcessor::specifics
* @covers \FireflyIII\Import\FileProcessor\CsvProcessor::getRowHash
* @covers \FireflyIII\Import\FileProcessor\CsvProcessor::annotateValue
* @expectedException \FireflyIII\Exceptions\FireflyException
* @expectedExceptionMessage "bad-role" is not a valid role.
*/
public function testRunBadRole()
{
// data
$config = [
'column-roles' => [
0 => 'bad-role',
],
];
$job = $this->getJob($config);
$csvFile = '20170101,-12.34,"Some description"';
// mock stuff
$repository = $this->mock(ImportJobRepositoryInterface::class);
$repository->shouldReceive('setUser')->withArgs([Mockery::any()])->once();
$repository->shouldReceive('getConfiguration')->andReturn($config);
$repository->shouldReceive('uploadFileContents')->withArgs([Mockery::any()])->andReturn($csvFile)->once();
$repository->shouldReceive('getExtendedStatus')->once()->andReturn([]);
$repository->shouldReceive('setExtendedStatus')->once()->andReturn($job);
// mock stuff for this single row:
$repository->shouldReceive('countByHash')->once()->withArgs([Mockery::any()])->andReturn(0);
$processor = new CsvProcessor();
$processor->setJob($job);
$processor->run();
}
/**
* @covers \FireflyIII\Import\FileProcessor\CsvProcessor::run
* @covers \FireflyIII\Import\FileProcessor\CsvProcessor::getImportArray
* @covers \FireflyIII\Import\FileProcessor\CsvProcessor::getObjects
* @covers \FireflyIII\Import\FileProcessor\CsvProcessor::setJob
*/
public function testRunBasic()
{
// data
$config = [];
$job = $this->getJob($config);
$csvFile = '';
// mock stuff
$repository = $this->mock(ImportJobRepositoryInterface::class);
$repository->shouldReceive('setUser')->withArgs([Mockery::any()])->once();
$repository->shouldReceive('getConfiguration')->andReturn($config);
$repository->shouldReceive('uploadFileContents')->withArgs([Mockery::any()])->andReturn($csvFile)->once();
$repository->shouldReceive('getExtendedStatus')->once()->andReturn([]);
$repository->shouldReceive('setExtendedStatus')->once()->andReturn($job);
$processor = new CsvProcessor();
$processor->setJob($job);
$processor->run();
$objects = $processor->getObjects();
$this->assertCount(0, $objects);
}
/**
* @covers \FireflyIII\Import\FileProcessor\CsvProcessor::run
* @covers \FireflyIII\Import\FileProcessor\CsvProcessor::getImportArray
* @covers \FireflyIII\Import\FileProcessor\CsvProcessor::getObjects
* @covers \FireflyIII\Import\FileProcessor\CsvProcessor::setJob
* @covers \FireflyIII\Import\FileProcessor\CsvProcessor::importRow
* @covers \FireflyIII\Import\FileProcessor\CsvProcessor::specifics
* @covers \FireflyIII\Import\FileProcessor\CsvProcessor::getRowHash
* @covers \FireflyIII\Import\FileProcessor\CsvProcessor::annotateValue
* @covers \FireflyIII\Import\FileProcessor\CsvProcessor::rowAlreadyImported
*/
public function testRunExisting()
{
// data
$config = [];
$job = $this->getJob($config);
$csvFile = '20170101,-12.34,"Some description"';
// mock stuff
$repository = $this->mock(ImportJobRepositoryInterface::class);
$repository->shouldReceive('setUser')->withArgs([Mockery::any()])->once();
$repository->shouldReceive('getConfiguration')->andReturn($config);
$repository->shouldReceive('uploadFileContents')->withArgs([Mockery::any()])->andReturn($csvFile)->once();
$repository->shouldReceive('getExtendedStatus')->twice()->andReturn([]); // twice for update errors.
$repository->shouldReceive('setExtendedStatus')->twice()->andReturn($job);
// mock stuff for this single row:
$repository->shouldReceive('countByHash')->once()->withArgs([Mockery::any()])->andReturn(1);
$repository->shouldReceive('addStepsDone')->once()->withArgs([Mockery::any(), 5]);
$processor = new CsvProcessor();
$processor->setJob($job);
$processor->run();
$objects = $processor->getObjects();
$this->assertCount(0, $objects);
}
/**
* @covers \FireflyIII\Import\FileProcessor\CsvProcessor::run
* @covers \FireflyIII\Import\FileProcessor\CsvProcessor::getImportArray
* @covers \FireflyIII\Import\FileProcessor\CsvProcessor::getObjects
* @covers \FireflyIII\Import\FileProcessor\CsvProcessor::setJob
* @covers \FireflyIII\Import\FileProcessor\CsvProcessor::importRow
* @covers \FireflyIII\Import\FileProcessor\CsvProcessor::specifics
* @covers \FireflyIII\Import\FileProcessor\CsvProcessor::getRowHash
* @covers \FireflyIII\Import\FileProcessor\CsvProcessor::annotateValue
* @covers \FireflyIII\Import\FileProcessor\CsvProcessor::rowAlreadyImported
* @expectedException \FireflyIII\Exceptions\FireflyException
* @expectedExceptionMessage "GoodBankDescription" is not a valid class name
*/
public function testRunInvalidSpecific()
{
// data
$config = [
'specifics' => ['GoodBankDescription' => 1],
];
$job = $this->getJob($config);
$csvFile = '20170101,-12.34,descr';
$row = explode(',', $csvFile);
// mock stuff
$repository = $this->mock(ImportJobRepositoryInterface::class);
$repository->shouldReceive('setUser')->withArgs([Mockery::any()])->once();
$repository->shouldReceive('getConfiguration')->andReturn($config);
$repository->shouldReceive('uploadFileContents')->withArgs([Mockery::any()])->andReturn($csvFile)->once();
$repository->shouldReceive('getExtendedStatus')->once()->andReturn([]);
$repository->shouldReceive('setExtendedStatus')->once()->andReturn($job);
// mock stuff for this single row:
$repository->shouldReceive('countByHash')->once()->withArgs([Mockery::any()])->andReturn(0);
// mock specific:
$processor = new CsvProcessor();
$processor->setJob($job);
$processor->run();
}
/**
* @covers \FireflyIII\Import\FileProcessor\CsvProcessor::run
* @expectedException \FireflyIII\Exceptions\FireflyException
* @expectedExceptionMessage Cannot call run() without a job.
*/
public function testRunNoJob()
{
$processor = new CsvProcessor();
$processor->run();
}
/**
* @covers \FireflyIII\Import\FileProcessor\CsvProcessor::run
* @covers \FireflyIII\Import\FileProcessor\CsvProcessor::getImportArray
* @covers \FireflyIII\Import\FileProcessor\CsvProcessor::getObjects
* @covers \FireflyIII\Import\FileProcessor\CsvProcessor::setJob
* @covers \FireflyIII\Import\FileProcessor\CsvProcessor::importRow
* @covers \FireflyIII\Import\FileProcessor\CsvProcessor::specifics
* @covers \FireflyIII\Import\FileProcessor\CsvProcessor::getRowHash
* @covers \FireflyIII\Import\FileProcessor\CsvProcessor::annotateValue
* @covers \FireflyIII\Import\FileProcessor\CsvProcessor::rowAlreadyImported
*/
public function testRunSingle()
{
// data
$config = [];
$job = $this->getJob($config);
$csvFile = '20170101,-12.34,"Some description"';
// mock stuff
$repository = $this->mock(ImportJobRepositoryInterface::class);
$repository->shouldReceive('setUser')->withArgs([Mockery::any()])->once();
$repository->shouldReceive('getConfiguration')->andReturn($config);
$repository->shouldReceive('uploadFileContents')->withArgs([Mockery::any()])->andReturn($csvFile)->once();
$repository->shouldReceive('getExtendedStatus')->once()->andReturn([]);
$repository->shouldReceive('setExtendedStatus')->once()->andReturn($job);
// mock stuff for this single row:
$repository->shouldReceive('countByHash')->once()->withArgs([Mockery::any()])->andReturn(0);
$repository->shouldReceive('addStepsDone')->once()->withArgs([Mockery::any(), 1]);
$processor = new CsvProcessor();
$processor->setJob($job);
$processor->run();
$objects = $processor->getObjects();
$this->assertCount(1, $objects);
}
/**
* @covers \FireflyIII\Import\FileProcessor\CsvProcessor::run
* @covers \FireflyIII\Import\FileProcessor\CsvProcessor::getImportArray
* @covers \FireflyIII\Import\FileProcessor\CsvProcessor::getObjects
* @covers \FireflyIII\Import\FileProcessor\CsvProcessor::setJob
* @covers \FireflyIII\Import\FileProcessor\CsvProcessor::importRow
* @covers \FireflyIII\Import\FileProcessor\CsvProcessor::specifics
* @covers \FireflyIII\Import\FileProcessor\CsvProcessor::getRowHash
* @covers \FireflyIII\Import\FileProcessor\CsvProcessor::annotateValue
* @covers \FireflyIII\Import\FileProcessor\CsvProcessor::rowAlreadyImported
*/
public function testRunSpecific()
{
// data
$config = [
'specifics' => ['AbnAmroDescription' => 1],
];
$job = $this->getJob($config);
$csvFile = '20170101,-12.34,descr';
$row = explode(',', $csvFile);
// mock stuff
$repository = $this->mock(ImportJobRepositoryInterface::class);
$repository->shouldReceive('setUser')->withArgs([Mockery::any()])->once();
$repository->shouldReceive('getConfiguration')->andReturn($config);
$repository->shouldReceive('uploadFileContents')->withArgs([Mockery::any()])->andReturn($csvFile)->once();
$repository->shouldReceive('getExtendedStatus')->once()->andReturn([]);
$repository->shouldReceive('setExtendedStatus')->once()->andReturn($job);
// mock stuff for this single row:
$repository->shouldReceive('countByHash')->once()->withArgs([Mockery::any()])->andReturn(0);
$repository->shouldReceive('addStepsDone')->once()->withArgs([Mockery::any(), 1]);
// mock specific:
$specific = $this->mock(AbnAmroDescription::class);
$specific->shouldReceive('run')->once()->andReturn($row);
$processor = new CsvProcessor();
$processor->setJob($job);
$processor->run();
$objects = $processor->getObjects();
$this->assertCount(1, $objects);
}
/**
* @param array $config
*
* @return ImportJob
*/
protected function getJob(array $config): ImportJob
{
$job = new ImportJob;
$job->file_type = 'file';
$job->status = 'new';
$job->key = 'x' . rand(1, 100000);
$job->user()->associate($this->user());
$job->configuration = $config;
return $job;
}
}