ApplicationTest\Service\ImporterTest

Complexity

Total Complexity

18

Size/Duplication

Total Lines	134
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	tearDown()	0	3	1
A	testThrowInvalidCamtFormat()	0	4	1
A	testThrowWhenFileDoesNotExist()	0	4	1
A	testThrowInvalidXml()	0	4	1
A	testThrowMissingAcctSvcrRef()	0	4	1
A	testThrowInvalidUser()	0	4	1
A	testImport()	0	6	1
A	testThrowInvalidIban()	0	4	1
A	import()	0	5	1
A	setUp()	0	4	1
A	extract()	0	9	2
A	extractLine()	0	14	1
A	providerImport()	0	14	3
A	extractTransaction()	0	19	2

<?php

declare(strict_types=1);

namespace ApplicationTest\Service;

use Application\Model\Account;
use Application\Model\Transaction;
use Application\Model\TransactionLine;
use Application\Model\User;
use Application\Service\Importer;
use PHPUnit\Framework\TestCase;

class ImporterTest extends TestCase
{
    private string $previousTimeZone;

    protected function setUp(): void
    {
        $this->previousTimeZone = date_default_timezone_get();
        date_default_timezone_set('Europe/Zurich');
    }

    protected function tearDown(): void
    {
        date_default_timezone_set($this->previousTimeZone);
    }

    private function import(string $filename): array
    {
        $importer = new Importer();

        return $this->extract($importer->import($filename));
    }

    /**
     * @dataProvider providerImport
     */
    public function testImport(string $xml, string $php): void
    {
        $actual = $this->import($xml);
        $expected = require $php;

        self::assertSame($expected, $actual);
    }

    public function testThrowWhenFileDoesNotExist(): void
    {
        $this->expectExceptionMessage('/this/surely/is/a/non/existing/file does not exists');
        $this->import('/this/surely/is/a/non/existing/file');
    }

    public function testThrowMissingAcctSvcrRef(): void
    {
        $this->expectExceptionMessage('Cannot import a transaction without unique universal identifier (<EndToEndId>, <AcctSvcrRef> or <MsgId>).');
        $this->import('tests/data/importer/missing-EndToEndId-and-AcctSvcrRef.xml');
    }

    public function testThrowInvalidIban(): void
    {
        $this->expectExceptionMessage('The CAMT file contains a statement for account with IBAN `CH2133685416723344187`, but no account exist for that IBAN in the database. Either create/update a corresponding account, or import a different CAMT file.');
        $this->import('tests/data/importer/invalid-iban.xml');
    }

    public function testThrowInvalidUser(): void
    {
        $this->expectExceptionMessage('Could not find a matching user for reference number `800826000000000000000099994` and user ID `9999`.');
        $this->import('tests/data/importer/invalid-user.xml');
    }

    public function testThrowInvalidCamtFormat(): void
    {
        $this->expectExceptionMessage('The format CAMT 054 is expected, but instead we got: camt.053.001.04');
        $this->import('tests/data/importer/invalid-camt-format.xml');
    }

    public function testThrowInvalidXml(): void
    {
        $this->expectExceptionMessage('Unsupported format, cannot find message format with xmlns');
        $this->import('tests/data/importer/invalid-xml.xml');
    }

    /**
     * @param Transaction[] $transactions
     */
    private function extract(array $transactions): array
    {
        $result = [];

        foreach ($transactions as $transaction) {
            $result[] = $this->extractTransaction($transaction);
        }

        return $result;
    }

    private function extractTransaction(Transaction $transaction): array
    {
        $lines = [];
        /** @var TransactionLine $line */
        foreach ($transaction->getTransactionLines() as $line) {
            $lines[] = $this->extractLine($line);
        }

        $result = [
            'name' => $transaction->getName(),
            'remarks' => $transaction->getRemarks(),
            'internalRemarks' => $transaction->getInternalRemarks(),
            'datatransRef' => $transaction->getDatatransRef(),
            'transactionDate' => $transaction->getTransactionDate()->toIso8601String(),
            'owner' => $transaction->getOwner()?->getName(),
            'transactionLines' => $lines,
        ];

        return $result;
    }

    private function extractLine(TransactionLine $line): array
    {
        $result = [
            'importedId' => $line->getImportedId(),
            'name' => $line->getName(),
            'remarks' => $line->getRemarks(),
            'transactionDate' => $line->getTransactionDate()->toIso8601String(),
            'balance' => $line->getBalance()->getAmount(),
            'owner' => $line->getOwner()?->getName(),
            'debit' => $line->getDebit()?->getName(),
            'credit' => $line->getCredit()?->getName(),
        ];

        return $result;
    }

    public function providerImport(): array
    {
        // Return all couples of xml/php files
        $files = [];
        foreach (glob('tests/data/importer/*.xml') as $xml) {
            $php = preg_replace('~xml$~', 'php', $xml);
            if (file_exists($php)) {
                $name = str_replace('-', ' ', basename($xml, '.xml'));

                $files[$name] = [$xml, $php];
            }
        }

        return $files;
    }
}