PHP Class App\Lib\Codeception

(c) James Healey For the full copyright and license information, please view the LICENSE file that was distributed with this source code.

Afficher le fichier Open project: jayhealey/webception

Méthodes publiques

Свойство	Type	Description
$config	boolean	Merges the Codeception.yml and Webception Codeception.php

Méthodes publiques

Méthode	Description
__construct ( array $config = [], $site = NULL )	Initialization of the Codeception class.
addTest ( Test $test )	Add a Test to the list.
checkExecutable ( string $file, string $config ) : array	Check that the Codeception executable exists and is runnable.
checkWriteable ( $path = null, $config ) : array	Check if the Codeception Log Path is writeable.
getCommandPath ( string $type, string $filename, $env ) : string	Full command to run a Codeception test.
getEnvironments ( $type )
getLogPath ( ) : string	Get the Codeception log path
getRunResponse ( string $type, string $hash ) : array	Given a test type & hash, handle the test run response for the AJAX call.
getTest ( string $type, string $hash ) : App\Lib\Test	Given a test type & hash, return a single Test.
getTestTally ( ) : integer	Return the count of discovered tests
getTests ( )	Get the complete test list.
loadConfig ( string $path, string $file ) : array	Load the Codeception YAML configuration.
loadTests ( )	Load the Codeception tests from disk.
ready ( ) : boolean	Return if Codeception is ready.
run ( Test $test ) : Test	Given a test, run the Codeception test.

Method Details

__construct() public méthode

Initialization of the Codeception class.

public __construct ( array $config = [], $site = NULL )
$config	array	The codeception.php configuration file.

addTest() public méthode

Push the tally count up as well.

public addTest ( Test $test )
$test	Test

checkExecutable() public méthode

Check that the Codeception executable exists and is runnable.

public checkExecutable ( string $file, string $config ) : array
$file	string	File name of the Codeception executable.
$config	string	Full path of the config of where the $file was defined.
Résultat	array	Array of flags used in the JSON respone.

checkWriteable() public méthode

Check if the Codeception Log Path is writeable.

public checkWriteable ( $path = null, $config ) : array
Résultat	array	Array of flags used in the JSON respone.

getCommandPath() public méthode

Full command to run a Codeception test.

public getCommandPath ( string $type, string $filename, $env ) : string
$type	string	Test Type (Acceptance, Functional, Unit)
$filename	string	Name of the Test
Résultat	string	Full command to execute Codeception with requred parameters.

getEnvironments() public méthode

public getEnvironments ( $type )

getLogPath() public méthode

Get the Codeception log path

public getLogPath ( ) : string
Résultat	string

getRunResponse() public méthode

Given a test type & hash, handle the test run response for the AJAX call.

public getRunResponse ( string $type, string $hash ) : array
$type	string	Test type (Unit, Acceptance, Functional)
$hash	string	Hash of the test.
Résultat	array	Array of flags used in the JSON respone.

getTest() public méthode

Given a test type & hash, return a single Test.

public getTest ( string $type, string $hash ) : App\Lib\Test
$type	string	Test type (Unit, Acceptance, Functional)
$hash	string	Hash of the test.
Résultat	App\Lib\Test	or FALSE.

getTestTally() public méthode

Return the count of discovered tests

public getTestTally ( ) : integer
Résultat	integer	$this->tally

getTests() public méthode

Get the complete test list.

public getTests ( )

loadConfig() public méthode

Load the Codeception YAML configuration.

public loadConfig ( string $path, string $file ) : array
$path	string
$file	string
Résultat	array	$config

loadTests() public méthode

Load the Codeception tests from disk.

public loadTests ( )

ready() public méthode

Return if Codeception is ready.

public ready ( ) : boolean
Résultat	boolean

run() public méthode

Given a test, run the Codeception test.

public run ( Test $test ) : Test
$test	Test	Current test to Run.
Résultat	Test	$test Updated test with log and result.

Property Details

$config public_oe property

Merges the Codeception.yml and Webception Codeception.php

public bool $config
Résultat	boolean