portrino/codeception-helper-module

Generic helper module for codeception acceptance testing

Codeception Helper Module

, _(*1)

Collection of modules for codeception acceptance testing with TYPO3 and Shopware. You can use this module as base for your codeception acceptance testsuite. It provides a set of modules, abstract page objects and interfaces to make acceptance testing a bit cleaner and easier in context of TYPO3 and Shopware., _(*2)

Installation

You need to add the repository into your composer.json file, _(*3)

composer require --dev portrino/codeception-helper-module

Modules

You can use module(s) as any other codeception module, by adding '\Codeception\Module\Portrino******' to the enabled modules in your codeception suite configurations., _(*4)

Database module

modules:
    enabled:
        - \Portrino\Codeception\Module\Database:
            depends: Db
            no_reset: true # do not reset database after testsuite
 ```  

Update codeception build

```bash
codecept build

Methods

truncateTableInDatabase($table)

Truncates the $table., _(*5)

  $I->truncateTableInDatabase($table);

deleteFromDatabase($table, $criteria)

Deletes the row(s) from $table matching the $criteria, _(*6)

$I->deleteFromDatabase($table, $criteria);

TYPO3 module

modules:
    enabled:
        - \Portrino\Codeception\Module\Typo3:
            depends: Asserts
            domain: www.example.com

Update codeception build, _(*7)

codecept build

Methods

executeCommand

Executes the specified typo3_console $command., _(*8)

$I->executeCommand($command, $arguments = [], $environmentVariables = [])

executeSchedulerTask

Executes tasks that are registered in the scheduler module., _(*9)

$I->executeSchedulerTask($taskId, $force = false, $environmentVariables = [])

flushCache

Flushes TYPO3 core caches first and after that, flushes caches from extensions., _(*10)

$I->flushCache($force = false, $filesOnly = false)

flushCacheGroups

Flushes all caches in specified groups. Valid group names are by default: * all * lowlevel * pages * system, _(*11)

$I->flushCacheGroups($groups)

importIntoDatabase

Import $file into database., _(*12)

$I->importIntoDatabase($file)

Shopware module

modules:
    enabled:
        - \Portrino\Codeception\Module\Shopware:
            depends: Asserts
            bin-dir: 

Update codeception build, _(*13)

codecept build

Methods

executeCommand

Executes the specified shopware_console $command., _(*14)

$I->executeCommand($command, $arguments = [], $environmentVariables = []);

runSqlCommand

Executes SQL query in shopware_console., _(*15)

$I->runSqlCommand($sql);

activatePlugin

Activates Shopware plugin., _(*16)

$I->activatePlugin($plugin);

installPlugin

Install Shopware plugin. If activate = true, the plugin will be activated after installation., _(*17)

$I->installPlugin($plugin, $activate);

refreshPluginList

Refresh Shopware plugin-list. You need to call this sometimes before installing a plugin., _(*18)

$I->refreshPluginList();

regenerateThemeCache

Regenerates the theme-cache., _(*19)

$I->regenerateThemeCache();

clearCache

Clear Shopware cache., _(*20)

$I->clearCache();

setPluginConfiguration

Set configuration of Shopware plugin by plugin-name, configuration-key and configuration-value. * you'll be able to set cofigurations for a specified shop by using the $shop parameter, _(*21)

$I->setPluginConfiguration($plugin, $key, $value, $shop = 1);

Interfaces

You should use our constants defined in some interfaces to prevent typos and make refactoring easier., _(*22)

TYPO3

• \Portrino\Codeception\Interfaces\DatabaseTables\Typo3Database
• \Portrino\Codeception\Interfaces\Cookies\Typo3Cookie
• \Portrino\Codeception\Interfaces\Commands\Typo3Command

Example:, _(*23)

  $I->seeInDatabase(
        \Portrino\Codeception\Interfaces\DatabaseTables\Typo3::PAGES,
        [
            'uid' => 123,
        ]
  );

Shopware

• \Portrino\Codeception\Interfaces\DatabaseTables\ShopwareDatabase
• \Portrino\Codeception\Interfaces\Cookies\ShopwareCookie
• \Portrino\Codeception\Interfaces\Commands\ShopwareCommand

  $I->seeInDatabase(
        \Portrino\Codeception\Interfaces\DatabaseTables\Shopware::ARTICLE,
        [
            'id' => 123,
        ]
  );

Fixtures Helper

For the sake of simplicity we added an little Helper for the Codeception Fixture feature., _(*24)

Please add in your _bootstrap.php file, _(*25)

'__model' => \Portrino\Codeception\Model\Typo3\Typo3FrontendUser::class,, _(*26)

as the first entry in your Fixture array. your Fixture has to look like, _(*27)

\Codeception\Util\Fixtures::add(
    'your_fixture_name',
    [
        '__model' =>  \Portrino\Codeception\Model\Typo3\Typo3FrontendUser::class, 
        'fixtureValueX' => 'X',
        'fixtureValueY' => 'Y'
    ]
);

now you'll be able to use your Fixture with our adapted Fixtures class, _(*28)

\Portrino\Codeception\Util\Fixtures::get('your_fixture_name');

Hints

Use codeception with shopware

Due the fact that shopware only supports some very old versions of packages like guzzlehttp/guzzle or symfony/process, we advise you to put all the testing stuff into a indepented composer.json file under a seperate location like web/tests/Codeception/. Do not add codeception\codeception package into the root composer.json of shopware - you will get trouble., _(*29)

Autoloading

To autoload vendor packages you have to require_once the autoload.php in your composers _bootstrap.php file., _(*30)

require_once(__DIR__ . '/../../../../web/autoload.php');

Authors

, _(*31)

• André Wuttig - Initial work, Unit Tests - aWuttig
• Leopold Engst - Unit Tests, Documentation - leen2104
• Axel Böswetter - Bugfixes - EvilBMP

See also the list of contributors who participated in this project., _(*32)