README

oprudkyi/codeception-events-scripting The Codeception extension for automatically running shell scripts on codeception events.

About

Run shell scripts on codeception's events - before/after tests/suites (like db seeding, stopping-running additional software etc.) Inspired by Phantoman extension for Codeception, though allow to run anything in more generic way.

Minimum Requirements

Codeception 2.1.0
PHP 5.5

Installation

This project can be installed via Composer. To get the latest version, simply add the following line to the require block of your composer.json file:

{
    "require-dev": {
            "oprudkyi/codeception-events-scripting": "*"
    }

}

You'll then need to run composer install or composer update to download the package and have the autoloader updated.

Or run the following command:

    composer require oprudkyi/codeception-events-scripting --dev

Configuration

Enable extension in the codeception.yml and write commands. Next events are supported:

BeforeAll - run before tests on every "codecept run"
AfterAll - run after all tests
BeforeSuite - run before each suite (use 'suites' array to run only for selected suites)
AfterSuite - run after each suite (use 'suites' array to run only for selected suites)

supported next attributes:

command - command line to run (for one-liners you can write command directly)
description - echoed before command
params - additional params for command
ignoreErrors - don't break testing if command fails (failed or retval != 0)
suites - single name or array of suites to run command for (applied to base name, like 'acceptance' as well to long name 'acceptance (phantom, firefox)')
environments - single name or array of environments
platforms - single name or array of platforms (uses PHP_OS constant, i.e. the platform where PHP was built, check here for details)

extensions:
    enabled:
        - Codeception\Extension\EventsScripting
    config:
        Codeception\Extension\EventsScripting:
            BeforeAll:
                - command: echo "Before All"
                - command: echo "Before All with Description"
                  description: Description of command
                - echo "Before All single line"
                - command: echo 
                  params: "Before All Params"
                  description: Before All with Params
                - command: "false"
                  description: BeforeAll. fail on run but ignore errors
                  ignoreErrors: true
            AfterAll:
                - command: echo "After All"
                - command: uname
                  description: Platform *nx-like
                  platforms: [darwin, linux, bsd, unix]
                - command: ver
                  description: Platform Windows
                  platforms: windows
            BeforeSuite:
                - command: echo "Before acceptance suite"
                  suites: ['acceptance']
                - command: echo "Before any suite"
                - command: echo "Before acceptance suite, phantom environment"
                  suites: ['acceptance']
                  environments: phantom
                - command: echo "Before acceptance suite, phantom,chrome environments"
                  suites: ['acceptance']
                  environments: ['phantom', 'chrome']
            AfterSuite:
                - command: echo "After acceptance suite"
                  suites: 'acceptance'
                - command: echo "After any suite"

Real example (start/stop mailcatcher and seed db):

        Codeception\Extension\EventsScripting:
          BeforeAll:
              - command: ./artisan db:seed-test --env=testing
                description: Reset db and seed
          BeforeSuite:
              - command: GEM_HOME=vendor/ruby vendor/ruby/bin/mailcatcher --ip 127.0.0.1 --smtp-port 11031 --http-port 11091
                suites: 'acceptance' 
                description: Start mailcatcher
          AfterSuite:
              - command: curl -s -X DELETE http://127.0.0.1:11091
                suites: 'acceptance' 
                description: Stop mailcatcher
                ignoreErrors: true

Testing

cd sample
composer install -n --prefer-source
cd ../test
composer install -n --prefer-source
./vendor/bin/codecept run

Contribute

This package is (yet) under development and refactoring but is ready for production. Please, feel free to comment, contribute and help. I will be happy to get some help to deliver tests.

License

Codeception's events scripting is licensed under The MIT License (MIT).

oprudkyi / codeception-events-scripting

Maintainers

Details