Search

Codeception\Module

  • Uses Codeception\Util\Shared\Asserts

Basic class for Modules and Helpers. You must extend from it while implementing own helpers.

Public methods of this class start with _ prefix in order to ignore them in actor classes. Module contains HOOKS which allow to handle test execution routine.

$includeInheritedActions

public static $includeInheritedActions

By setting it to false module wan’t inherit methods of parent class.

type bool

$onlyActions

public static $onlyActions

Allows to explicitly set what methods have this class.

type array

$excludeActions

public static $excludeActions

Allows to explicitly exclude actions from module.

type array

$aliases

public static $aliases

Allows to rename actions

type array

__construct()

public __construct($moduleContainer, $config = null)

Module constructor.

Requires module container (to provide access between modules of suite) and config.

  • param ModuleContainer $moduleContainer
  • param array|null $config

See source

_after()

public _after($test)

HOOK executed after test

  • param TestInterface $test

See source

_afterStep()

public _afterStep($step)

HOOK executed after step

  • param Step $step

See source

_afterSuite()

public _afterSuite()

HOOK executed after suite

See source

_before()

public _before($test)

HOOK executed before test

  • param TestInterface $test

See source

_beforeStep()

public _beforeStep($step)

HOOK executed before step

  • param Step $step

See source

_beforeSuite()

public _beforeSuite($settings = null)

HOOK executed before suite

  • param array $settings

See source

_failed()

public _failed($test, $fail)

HOOK executed when test fails but before _after

  • param TestInterface $test
  • param \Exception $fail

See source

_getConfig()

public _getConfig($key = null)

Get config values or specific config item.

  • param mixed $key
  • return mixed the config item’s value or null if it doesn’t exist

See source

_getName()

public _getName()

Returns a module name for a Module, a class name for Helper

  • return string

See source

_hasRequiredFields()

public _hasRequiredFields()

Checks if a module has required fields

  • return bool

See source

_initialize()

public _initialize()

HOOK triggered after module is created and configuration is loaded

See source

_reconfigure()

public _reconfigure($config)

Allows to redefine config for a specific test. Config is restored at the end of a test.

<?php
// cleanup DB only for specific group of tests
public function _before(Test $test) {
    if (in_array('cleanup', $test->getMetadata()->getGroups()) {
        $this->getModule('Db')->_reconfigure(['cleanup' => true]);
    }
}
  • param $config
  • throws Exception\ModuleConfigException
  • throws ModuleException

See source

_resetConfig()

public _resetConfig()

Reverts config changed by _reconfigure

See source

_setConfig()

public _setConfig($config)

Allows to define initial module config. Can be used in _beforeSuite hook of Helpers or Extensions

<?php
public function _beforeSuite($settings = []) {
    $this->getModule('otherModule')->_setConfig($this->myOtherConfig);
}
  • param $config
  • throws Exception\ModuleConfigException
  • throws ModuleException

See source

assert()

protected assert($arguments, $not = null)

See source

assertArrayHasKey()

protected assertArrayHasKey($key, $actual, $description = null)

  • param $key
  • param $actual
  • param $description

See source

assertArrayNotHasKey()

protected assertArrayNotHasKey($key, $actual, $description = null)

  • param $key
  • param $actual
  • param $description

See source

assertArraySubset()

protected assertArraySubset($subset, $array, $strict = null, $message = null)

Checks that array contains subset.

  • param array $subset
  • param array $array
  • param bool $strict
  • param string $message

See source

assertContains()

protected assertContains($needle, $haystack, $message = null)

Checks that haystack contains needle

  • param $needle
  • param $haystack
  • param string $message

See source

assertCount()

protected assertCount($expectedCount, $actual, $description = null)

  • param $expectedCount
  • param $actual
  • param $description

See source

assertEmpty()

protected assertEmpty($actual, $message = null)

Checks that variable is empty.

  • param $actual
  • param string $message

See source

assertEquals()

protected assertEquals($expected, $actual, $message = null, $delta = null)

Checks that two variables are equal.

  • param $expected
  • param $actual
  • param string $message
  • param float $delta

See source

assertEqualsCanonicalizing()

protected assertEqualsCanonicalizing($expected, $actual, $message = null)

See source

assertEqualsIgnoringCase()

protected assertEqualsIgnoringCase($expected, $actual, $message = null)

See source

assertEqualsWithDelta()

protected assertEqualsWithDelta($expected, $actual, $delta, $message = null)

See source

assertFalse()

protected assertFalse($condition, $message = null)

Checks that condition is negative.

  • param $condition
  • param string $message

See source

assertFileExists()

protected assertFileExists($filename, $message = null)

Checks if file exists

  • param string $filename
  • param string $message

See source

assertFileNotExists()

protected assertFileNotExists($filename, $message = null)

Checks if file doesn’t exist

  • param string $filename
  • param string $message

See source

assertGreaterOrEquals()

protected assertGreaterOrEquals($expected, $actual, $description = null)

  • param $expected
  • param $actual
  • param $description

See source

assertGreaterThan()

protected assertGreaterThan($expected, $actual, $message = null)

Checks that actual is greater than expected

  • param $expected
  • param $actual
  • param string $message

See source

assertGreaterThanOrEqual()

protected assertGreaterThanOrEqual($expected, $actual, $message = null)

Checks that actual is greater or equal than expected

  • param $expected
  • param $actual
  • param string $message

See source

assertInstanceOf()

protected assertInstanceOf($class, $actual, $description = null)

  • param $class
  • param $actual
  • param $description

See source

assertInternalType()

protected assertInternalType($type, $actual, $description = null)

  • param $type
  • param $actual
  • param $description

See source

assertIsArray()

protected assertIsArray($actual, $message = null)

See source

assertIsBool()

protected assertIsBool($actual, $message = null)

See source

assertIsCallable()

protected assertIsCallable($actual, $message = null)

See source

assertIsEmpty()

protected assertIsEmpty($actual, $description = null)

  • param $actual
  • param $description

See source

assertIsFloat()

protected assertIsFloat($actual, $message = null)

See source

assertIsInt()

protected assertIsInt($actual, $message = null)

See source

assertIsNotArray()

protected assertIsNotArray($actual, $message = null)

See source

assertIsNotBool()

protected assertIsNotBool($actual, $message = null)

See source

assertIsNotCallable()

protected assertIsNotCallable($actual, $message = null)

See source

assertIsNotFloat()

protected assertIsNotFloat($actual, $message = null)

See source

assertIsNotInt()

protected assertIsNotInt($actual, $message = null)

See source

assertIsNotNumeric()

protected assertIsNotNumeric($actual, $message = null)

See source

assertIsNotObject()

protected assertIsNotObject($actual, $message = null)

See source

assertIsNotResource()

protected assertIsNotResource($actual, $message = null)

See source

assertIsNotScalar()

protected assertIsNotScalar($actual, $message = null)

See source

assertIsNotString()

protected assertIsNotString($actual, $message = null)

See source

assertIsNumeric()

protected assertIsNumeric($actual, $message = null)

See source

assertIsObject()

protected assertIsObject($actual, $message = null)

See source

assertIsResource()

protected assertIsResource($actual, $message = null)

See source

assertIsScalar()

protected assertIsScalar($actual, $message = null)

See source

assertIsString()

protected assertIsString($actual, $message = null)

See source

assertLessOrEquals()

protected assertLessOrEquals($expected, $actual, $description = null)

  • param $expected
  • param $actual
  • param $description

See source

assertLessThan()

protected assertLessThan($expected, $actual, $message = null)

Checks that actual is less than expected

  • param $expected
  • param $actual
  • param string $message

See source

assertLessThanOrEqual()

protected assertLessThanOrEqual($expected, $actual, $message = null)

Checks that actual is less or equal than expected

  • param $expected
  • param $actual
  • param string $message

See source

assertNot()

protected assertNot($arguments)

See source

assertNotContains()

protected assertNotContains($needle, $haystack, $message = null)

Checks that haystack doesn’t contain needle.

  • param $needle
  • param $haystack
  • param string $message

See source

assertNotEmpty()

protected assertNotEmpty($actual, $message = null)

Checks that variable is not empty.

  • param $actual
  • param string $message

See source

assertNotEquals()

protected assertNotEquals($expected, $actual, $message = null, $delta = null)

Checks that two variables are not equal

  • param $expected
  • param $actual
  • param string $message
  • param float $delta

See source

assertNotEqualsCanonicalizing()

protected assertNotEqualsCanonicalizing($expected, $actual, $message = null)

See source

assertNotEqualsIgnoringCase()

protected assertNotEqualsIgnoringCase($expected, $actual, $message = null)

See source

assertNotEqualsWithDelta()

protected assertNotEqualsWithDelta($expected, $actual, $delta, $message = null)

See source

assertNotFalse()

protected assertNotFalse($condition, $message = null)

Checks that the condition is NOT false (everything but false)

  • param $condition
  • param string $message

See source

assertNotInstanceOf()

protected assertNotInstanceOf($class, $actual, $description = null)

  • param $class
  • param $actual
  • param $description

See source

assertNotNull()

protected assertNotNull($actual, $message = null)

Checks that variable is not NULL

  • param $actual
  • param string $message

See source

assertNotRegExp()

protected assertNotRegExp($pattern, $string, $message = null)

Checks that string not match with pattern

  • param string $pattern
  • param string $string
  • param string $message

See source

assertNotSame()

protected assertNotSame($expected, $actual, $message = null)

Checks that two variables are not same

  • param $expected
  • param $actual
  • param string $message

See source

assertNotTrue()

protected assertNotTrue($condition, $message = null)

Checks that the condition is NOT true (everything but true)

  • param $condition
  • param string $message

See source

assertNull()

protected assertNull($actual, $message = null)

Checks that variable is NULL

  • param $actual
  • param string $message

See source

assertRegExp()

protected assertRegExp($pattern, $string, $message = null)

Checks that string match with pattern

  • param string $pattern
  • param string $string
  • param string $message

See source

assertSame()

protected assertSame($expected, $actual, $message = null)

Checks that two variables are same

  • param $expected
  • param $actual
  • param string $message

See source

assertStringContainsString()

protected assertStringContainsString($needle, $haystack, $message = null)

See source

assertStringContainsStringIgnoringCase()

protected assertStringContainsStringIgnoringCase($needle, $haystack, $message = null)

See source

assertStringNotContainsString()

protected assertStringNotContainsString($needle, $haystack, $message = null)

See source

assertStringNotContainsStringIgnoringCase()

protected assertStringNotContainsStringIgnoringCase($needle, $haystack, $message = null)

See source

assertStringStartsNotWith()

protected assertStringStartsNotWith($prefix, $string, $message = null)

Checks that a string doesn’t start with the given prefix.

  • param string $prefix
  • param string $string
  • param string $message

See source

assertStringStartsWith()

protected assertStringStartsWith($prefix, $string, $message = null)

Checks that a string starts with the given prefix.

  • param string $prefix
  • param string $string
  • param string $message

See source

assertThat()

protected assertThat($haystack, $constraint, $message = null)

  • param $haystack
  • param $constraint
  • param string $message

See source

assertThatItsNot()

protected assertThatItsNot($haystack, $constraint, $message = null)

Checks that haystack doesn’t attend

  • param $haystack
  • param $constraint
  • param string $message

See source

assertTrue()

protected assertTrue($condition, $message = null)

Checks that condition is positive.

  • param $condition
  • param string $message

See source

debug()

protected debug($message)

Print debug message to the screen.

  • param $message

See source

debugSection()

protected debugSection($title, $message)

Print debug message with a title

  • param $title
  • param $message

See source

fail()

protected fail($message)

Fails the test with message.

  • param $message

See source

getModule()

protected getModule($name)

Get another module by its name:

<?php
$this->getModule('WebDriver')->_findElements('.items');
  • param $name
  • return Module
  • throws ModuleException

See source

getModules()

protected getModules()

Get all enabled modules

  • return array

See source

hasModule()

protected hasModule($name)

Checks that module is enabled.

  • param $name
  • return bool

See source

onReconfigure()

protected onReconfigure()

HOOK to be executed when config changes with _reconfigure.

See source

scalarizeArray()

protected scalarizeArray($array)

See source

shortenMessage()

protected shortenMessage($message, $chars = null)

Short text message to an amount of chars

  • param $message
  • param $chars
  • return string

See source

validateConfig()

protected validateConfig()

Validates current config for required fields and required packages.

  • throws Exception\ModuleConfigException
  • throws ModuleException

See source

 

Reference is taken from the source code. Help us to improve documentation. Edit module reference
Don't know how to write tests on your own? We will build or improve them for you. Request a quote for official enterprise support or trainings

Not sure what to test?

Let your users tell you!

Turn user feedback into tests

with Bugira Bugtracker