add tests for configuration class

Application/Model/ActionBase.php

@@ -19,6 +19,7 @@ use D3\DataWizard\Application\Model\Exceptions\InputUnvalidException;
 use FormManager\Inputs\Checkbox;
 use FormManager\Inputs\Input;
 use FormManager\Inputs\Radio;
+use OxidEsales\Eshop\Core\Database\Adapter\DatabaseInterface;
 use OxidEsales\Eshop\Core\DatabaseProvider;
 use OxidEsales\Eshop\Core\Exception\DatabaseConnectionException;
 use OxidEsales\Eshop\Core\Exception\DatabaseErrorException;
@@ -76,7 +77,7 @@ abstract class ActionBase implements QueryBase
             );
         }
 
-        $affected = DatabaseProvider::getDb( DatabaseProvider::FETCH_MODE_ASSOC )->execute( $queryString, $parameters );
+        $affected = $this->d3GetDb()->execute( $queryString, $parameters );
 
         throw oxNew(
             Exceptions\TaskException::class,
@@ -90,6 +91,15 @@ abstract class ActionBase implements QueryBase
         );
     }
 
+    /**
+     * @return DatabaseInterface|null
+     * @throws DatabaseConnectionException
+     */
+    public function d3GetDb()
+    {
+        return DatabaseProvider::getDb( DatabaseProvider::FETCH_MODE_ASSOC );
+    }
+
     /**
      * @return string
      */

Application/Model/Configuration.php

@@ -149,7 +149,13 @@ class Configuration
      */
     public function getActionById($id) : ActionBase
     {
-        return $this->getAllActions()[$id];
+        $allActions = $this->getAllActions();
+
+        if (false == $allActions[$id]) {
+            throw oxNew(DataWizardException::class, 'no action with id '.$id);
+        }
+
+        return $allActions[$id];
     }
 
     /**

tests/unit/Application/Model/ActionBaseTest.php

@@ -15,11 +15,13 @@ declare(strict_types=1);
 
 namespace D3\DataWizard\tests\unit\Application\Model;
 
+use D3\DataWizard\Application\Model\Exceptions\TaskException;
 use D3\DataWizard\tests\tools\d3TestAction;
 use D3\ModCfg\Tests\unit\d3ModCfgUnitTestCase;
 use FormManager\Inputs\Hidden;
 use FormManager\Inputs\Number;
 use FormManager\Inputs\Radio;
+use OxidEsales\Eshop\Core\Database\Adapter\Doctrine\Database;
 use OxidEsales\Eshop\Core\Exception\StandardException;
 use PHPUnit\Framework\MockObject\MockObject;
 use ReflectionException;
@@ -247,4 +249,68 @@ class ActionBaseTest extends d3ModCfgUnitTestCase
             'invalidElements' => [[$validMock, $invalidField], true]
         ];
     }
+
+    /**
+     * @covers \D3\DataWizard\Application\Model\ActionBase::executeAction
+     * @test
+     * @throws ReflectionException
+     * @dataProvider canExecuteActionDataProvider
+     */
+    public function canExecuteAction($query, $throwsException)
+    {
+        /** @var Database|MockObject $dbMock */
+        $dbMock = $this->getMockBuilder(Database::class)
+            ->onlyMethods(['execute'])
+            ->getMock();
+        $dbMock->expects($this->exactly((int) !$throwsException))->method('execute')->willReturn(true);
+
+        /** @var d3TestAction|MockObject $modelMock */
+        $modelMock = $this->getMockBuilder(d3TestAction::class)
+            ->onlyMethods(['d3GetDb'])
+            ->getMock();
+        $modelMock->expects($this->exactly((int) !$throwsException))->method('d3GetDb')->willReturn($dbMock);
+
+        $this->_oModel = $modelMock;
+
+        try {
+            $this->callMethod(
+                $this->_oModel,
+                'executeAction',
+                [[$query, ['parameters']]]
+            );
+        } catch (TaskException $e) {
+            if ($throwsException) {
+                $this->assertStringContainsString('ACTIONSELECT', $e->getMessage());
+            } else {
+                $this->assertStringContainsString('ACTIONRESULT', $e->getMessage());
+            }
+        }
+    }
+
+    /**
+     * @return array[]
+     */
+    public function canExecuteActionDataProvider(): array
+    {
+        return [
+            'Select throws exception'   => ['SELECT 1', true],
+            'Update dont throws exception'   => ['UPDATE 1', false],
+        ];
+    }
+
+    /**
+     * @covers \D3\DataWizard\Application\Model\ActionBase::d3GetDb
+     * @test
+     * @throws ReflectionException
+     */
+    public function canGetDb()
+    {
+        $this->assertInstanceOf(
+            Database::class,
+            $this->callMethod(
+                $this->_oModel,
+                'd3GetDb'
+            )
+        );
+    }
 }

tests/unit/Application/Model/ConfigurationTest.php

@@ -0,0 +1,454 @@
+<?php
+
+/**
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * https://www.d3data.de
+ *
+ * @copyright (C) D3 Data Development (Inh. Thomas Dartsch)
+ * @author    D3 Data Development - Daniel Seifert <info@shopmodule.com>
+ * @link      https://www.oxidmodule.com
+ */
+
+declare(strict_types=1);
+
+namespace D3\DataWizard\tests\unit\Application\Model;
+
+use D3\DataWizard\Application\Model\Configuration;
+use D3\DataWizard\Application\Model\Exceptions\DataWizardException;
+use D3\DataWizard\tests\tools\d3TestAction;
+use D3\DataWizard\tests\tools\d3TestExport;
+use D3\ModCfg\Tests\unit\d3ModCfgUnitTestCase;
+use PHPUnit\Framework\MockObject\MockObject;
+
+class ConfigurationTest extends d3ModCfgUnitTestCase
+{
+    /** @var Configuration */
+    protected $_oModel;
+
+    public function setUp() : void
+    {
+        parent::setUp();
+
+        $this->_oModel = oxNew(Configuration::class);
+    }
+
+    public function tearDown() : void
+    {
+        parent::tearDown();
+
+        unset($this->_oModel);
+    }
+
+    /**
+     * @covers \D3\DataWizard\Application\Model\Configuration::__construct
+     * @test
+     * @throws \ReflectionException
+     */
+    public function canConstruct()
+    {
+        /** @var Configuration|MockObject $modelMock */
+        $modelMock = $this->getMockBuilder(Configuration::class)
+            ->disableOriginalConstructor()
+            ->onlyMethods(['configure'])
+            ->getMock();
+        $modelMock->expects($this->once())->method('configure');
+        $this->_oModel = $modelMock;
+
+        $this->callMethod(
+            $this->_oModel,
+            '__construct'
+        );
+    }
+
+    /**
+     * @covers \D3\DataWizard\Application\Model\Configuration::configure()
+     * @test
+     * @throws \ReflectionException
+     */
+    public function canConfigure()
+    {
+        $this->assertEmpty(
+            $this->callMethod(
+                $this->_oModel,
+                'configure'
+            )
+        );
+    }
+
+    /**
+     * @covers \D3\DataWizard\Application\Model\Configuration::registerAction
+     * @test
+     * @throws \ReflectionException
+     */
+    public function canRegisterAction()
+    {
+        $action = oxNew(d3TestAction::class);
+
+        $oldCount = count($this->getValue(
+            $this->_oModel,
+            'actions'
+        ));
+
+        $this->callMethod(
+            $this->_oModel,
+            'registerAction',
+            ['testGroup', $action]
+        );
+
+        $actions = $this->getValue(
+            $this->_oModel,
+            'actions'
+        );
+
+        $newCount = count($actions);
+
+        $flattedActions = $this->array_flatten($actions);
+
+        $this->assertGreaterThan($oldCount, $newCount);
+        $this->assertContains($action, $flattedActions);
+    }
+
+    /**
+     * @covers \D3\DataWizard\Application\Model\Configuration::registerExport
+     * @test
+     * @throws \ReflectionException
+     */
+    public function canRegisterExport()
+    {
+        $export = oxNew(d3TestExport::class);
+
+        $oldCount = count($this->getValue(
+            $this->_oModel,
+            'exports'
+        ));
+
+        $this->callMethod(
+            $this->_oModel,
+            'registerExport',
+            ['testGroup', $export]
+        );
+
+        $exports = $this->getValue(
+            $this->_oModel,
+            'exports'
+        );
+
+        $newCount = count($exports);
+
+        $flattedExports = $this->array_flatten($exports);
+
+        $this->assertGreaterThan($oldCount, $newCount);
+        $this->assertContains($export, $flattedExports);
+    }
+
+    /**
+     * @param $array
+     * @return array|false
+     */
+    public function array_flatten($array) {
+        if (!is_array($array)) {
+            return false;
+        }
+        $result = array();
+        foreach ($array as $key => $value) {
+            if (is_array($value)) {
+                $result = array_merge($result, $this->array_flatten($value));
+            }
+            else {
+                $result[$key] = $value;
+            }
+        }
+        return $result;
+    }
+
+    /**
+     * @covers \D3\DataWizard\Application\Model\Configuration::getGroupedActions()
+     * @test
+     * @throws \ReflectionException
+     */
+    public function canGetGroupedActions()
+    {
+        $actionList = ['abc', 'def'];
+
+        $this->setValue(
+            $this->_oModel,
+            'actions',
+            $actionList
+        );
+
+        $this->assertSame(
+            $actionList,
+            $this->callMethod(
+                $this->_oModel,
+                'getGroupedActions'
+            )
+        );
+    }
+
+    /**
+     * @covers \D3\DataWizard\Application\Model\Configuration::getGroupedExports()
+     * @test
+     * @throws \ReflectionException
+     */
+    public function canGetGroupedExports()
+    {
+        $exportList = ['abc', 'def'];
+
+        $this->setValue(
+            $this->_oModel,
+            'exports',
+            $exportList
+        );
+
+        $this->assertSame(
+            $exportList,
+            $this->callMethod(
+                $this->_oModel,
+                'getGroupedExports'
+            )
+        );
+    }
+
+    /**
+     * @covers \D3\DataWizard\Application\Model\Configuration::getActionGroups()
+     * @test
+     * @throws \ReflectionException
+     */
+    public function canGetActionGroups()
+    {
+        $actionList = ['abc'    => '123', 'def' => '456'];
+
+        $this->setValue(
+            $this->_oModel,
+            'actions',
+            $actionList
+        );
+
+        $this->assertSame(
+            ['abc', 'def'],
+            $this->callMethod(
+                $this->_oModel,
+                'getActionGroups'
+            )
+        );
+    }
+
+    /**
+     * @covers \D3\DataWizard\Application\Model\Configuration::getExportGroups()
+     * @test
+     * @throws \ReflectionException
+     */
+    public function canGetExportGroups()
+    {
+        $exportList = ['abc'    => '123', 'def' => '456'];
+
+        $this->setValue(
+            $this->_oModel,
+            'exports',
+            $exportList
+        );
+
+        $this->assertSame(
+            ['abc', 'def'],
+            $this->callMethod(
+                $this->_oModel,
+                'getExportGroups'
+            )
+        );
+    }
+
+    /**
+     * @covers \D3\DataWizard\Application\Model\Configuration::getActionsByGroup()
+     * @test
+     * @throws \ReflectionException
+     */
+    public function canGetActionsByGroup()
+    {
+        $actionList = ['abc' => '123', 'def' => '456'];
+
+        $this->setValue(
+            $this->_oModel,
+            'actions',
+            $actionList
+        );
+
+        $this->assertSame(
+            '456',
+            $this->callMethod(
+                $this->_oModel,
+                'getActionsByGroup',
+                ['def']
+            )
+        );
+    }
+
+    /**
+     * @covers \D3\DataWizard\Application\Model\Configuration::getExportsByGroup()
+     * @test
+     * @throws \ReflectionException
+     */
+    public function canGetExportsByGroup()
+    {
+        $exportList = ['abc' => '123', 'def' => '456'];
+
+        $this->setValue(
+            $this->_oModel,
+            'exports',
+            $exportList
+        );
+
+        $this->assertSame(
+            '456',
+            $this->callMethod(
+                $this->_oModel,
+                'getExportsByGroup',
+                ['def']
+            )
+        );
+    }
+
+    /**
+     * @covers \D3\DataWizard\Application\Model\Configuration::getAllActions()
+     * @test
+     * @throws \ReflectionException
+     */
+    public function canGetAllActions()
+    {
+        /** @var Configuration|MockObject $modelMock */
+        $modelMock = $this->getMockBuilder(Configuration::class)
+            ->onlyMethods([
+                'getActionGroups',
+                'getActionsByGroup'
+            ])
+            ->getMock();
+        $modelMock->expects($this->once())->method('getActionGroups')->willReturn(['123', '456']);
+        $modelMock->expects($this->exactly(2))->method('getActionsByGroup')->willReturnOnConsecutiveCalls(
+            ['123', '456'],
+            ['789', '012']
+        );
+
+        $this->_oModel = $modelMock;
+
+        $this->assertSame(
+            ['123','456', '789', '012'],
+            $this->callMethod(
+                $this->_oModel,
+                'getAllActions'
+            )
+        );
+    }
+
+    /**
+     * @covers \D3\DataWizard\Application\Model\Configuration::getAllExports()
+     * @test
+     * @throws \ReflectionException
+     */
+    public function canGetAllExports()
+    {
+        /** @var Configuration|MockObject $modelMock */
+        $modelMock = $this->getMockBuilder(Configuration::class)
+            ->onlyMethods([
+                'getExportGroups',
+                'getExportsByGroup'
+            ])
+            ->getMock();
+        $modelMock->expects($this->once())->method('getExportGroups')->willReturn(['123', '456']);
+        $modelMock->expects($this->exactly(2))->method('getExportsByGroup')->willReturnOnConsecutiveCalls(
+            ['123', '456'],
+            ['789', '012']
+        );
+
+        $this->_oModel = $modelMock;
+
+        $this->assertSame(
+            ['123', '456', '789', '012'],
+            $this->callMethod(
+                $this->_oModel,
+                'getAllExports'
+            )
+        );
+    }
+
+    /**
+     * @covers \D3\DataWizard\Application\Model\Configuration::getActionById()
+     * @test
+     * @throws \ReflectionException
+     * @dataProvider canGetActionByIdDataProvider
+     */
+    public function canGetActionById($id, $throwException)
+    {
+        $expected = oxNew(d3TestAction::class);
+
+        /** @var Configuration|MockObject $modelMock */
+        $modelMock = $this->getMockBuilder(Configuration::class)
+            ->onlyMethods(['getAllActions'])
+            ->getMock();
+        $modelMock->expects($this->once())->method('getAllActions')->willReturn(['123'  => oxNew(d3TestAction::class), '456' => $expected]);
+        $this->_oModel = $modelMock;
+
+        if ($throwException) {
+            $this->expectException(DataWizardException::class);
+        }
+
+        $return = $this->callMethod(
+            $this->_oModel,
+            'getActionById',
+            [$id]
+        );
+
+        if (!$throwException) {
+            $this->assertSame(
+                $expected,
+                $return
+            );
+        }
+    }
+
+    /**
+     * @covers \D3\DataWizard\Application\Model\Configuration::getExportById()
+     * @test
+     * @throws \ReflectionException
+     * @dataProvider canGetActionByIdDataProvider
+     */
+    public function canGetExportById($id, $throwException)
+    {
+        $expected = oxNew(d3TestExport::class);
+
+        /** @var Configuration|MockObject $modelMock */
+        $modelMock = $this->getMockBuilder(Configuration::class)
+            ->onlyMethods(['getAllExports'])
+            ->getMock();
+        $modelMock->expects($this->once())->method('getAllExports')->willReturn(['123'  => oxNew(d3TestExport::class), '456' => $expected]);
+        $this->_oModel = $modelMock;
+
+        if ($throwException) {
+            $this->expectException(DataWizardException::class);
+        }
+
+        $return = $this->callMethod(
+            $this->_oModel,
+            'getExportById',
+            [$id]
+        );
+
+        if (!$throwException) {
+            $this->assertSame(
+                $expected,
+                $return
+            );
+        }
+    }
+
+    /**
+     * @return array[]
+     */
+    public function canGetActionByIdDataProvider(): array
+    {
+        return [
+            'unset id'  => ['987', true],
+            'set id'  => ['456', false],
+        ];
+    }
+}