TestsCommands
extends AbstractCommands
in package
Class TestsCommands.
Table of Contents
- getConfigurationFile() : string
- Path to YAML configuration file containing command defaults.
- getWorkingDir() : string
- Returns the current working directory.
- initializeRuntimeConfiguration() : mixed
- Command initialization.
- toolkitCheckPhpcsRequirements() : mixed
- Make sure that the config file exists and configuration is correct.
- toolkitRunPhpcbf() : mixed
- Run PHP code autofixing.
- toolkitSetupPhpcs() : mixed
- Setup PHP code sniffer.
- toolkitTestBehat() : mixed
- Run Behat tests.
- toolkitTestPhpcs() : mixed
- Run PHP code sniffer.
- toolkitTestPhpmd() : mixed
- Run PHPMD.
- toolkitTestPhpstan() : mixed
- Run PHPStan.
- toolkitTestPhpunit() : mixed
- Run PHPUnit tests.
- getBin() : string
- Validate and return the path to given bin.
- getBinPath() : string
- Return the path to given bin.
- getConfigValue() : mixed
- {@inheritdoc}
- getNodeBin() : string
- Validate and return the path to given bin from node packages.
- getNodeBinPath() : string
- Return the path to given bin from node packages.
- isSimulating() : bool
- Check if current command is being executed with option simulate.
- taskExecute() : mixed
- Execute a command.
- taskProcess() : Process|CollectionBuilder
- Process the file.
- taskReplaceBlock() : ReplaceBlock|CollectionBuilder
- Replace block in a file.
- toolkitRunGrumphp() : mixed
- Run PHP code sniffer within GrumPHP.
- toolkitRunPhpcs() : mixed
- Run PHP code sniffer.
Methods
getConfigurationFile()
Path to YAML configuration file containing command defaults.
public
getConfigurationFile() : string
Return values
string —getWorkingDir()
Returns the current working directory.
public
getWorkingDir() : string
Return values
string —The current working directory.
initializeRuntimeConfiguration()
Command initialization.
public
initializeRuntimeConfiguration() : mixed
Tags
Return values
mixed —toolkitCheckPhpcsRequirements()
Make sure that the config file exists and configuration is correct.
public
toolkitCheckPhpcsRequirements() : mixed
Tags
Return values
mixed —toolkitRunPhpcbf()
Run PHP code autofixing.
public
toolkitRunPhpcbf() : mixed
Tags
Return values
mixed —toolkitSetupPhpcs()
Setup PHP code sniffer.
public
toolkitSetupPhpcs() : mixed
Check configurations at config/default.yml - 'toolkit.test.phpcs'.
Tags
Return values
mixed —toolkitTestBehat()
Run Behat tests.
public
toolkitTestBehat([array<string|int, mixed> $options = ['from' => InputOption::VALUE_OPTIONAL, 'to' => InputOption::VALUE_OPTIONAL, 'profile' => InputOption::VALUE_OPTIONAL, 'suite' => InputOption::VALUE_OPTIONAL, 'options' => InputOption::VALUE_OPTIONAL] ]) : mixed
Check configurations at config/default.yml - 'toolkit.test.behat'. Accept commands to run before and/or after the Behat tests.
Parameters
- $options : array<string|int, mixed> = ['from' => InputOption::VALUE_OPTIONAL, 'to' => InputOption::VALUE_OPTIONAL, 'profile' => InputOption::VALUE_OPTIONAL, 'suite' => InputOption::VALUE_OPTIONAL, 'options' => InputOption::VALUE_OPTIONAL]
Tags
Return values
mixed —toolkitTestPhpcs()
Run PHP code sniffer.
public
toolkitTestPhpcs() : mixed
Tags
Return values
mixed —toolkitTestPhpmd()
Run PHPMD.
public
toolkitTestPhpmd([array<string|int, mixed> $options = ['config' => InputOption::VALUE_REQUIRED, 'format' => InputOption::VALUE_REQUIRED, 'ignore_patterns' => InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY, 'triggered_by' => InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY, 'files' => InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY] ]) : mixed
Check configurations at config/default.yml - 'toolkit.test.phpmd'.
Parameters
- $options : array<string|int, mixed> = ['config' => InputOption::VALUE_REQUIRED, 'format' => InputOption::VALUE_REQUIRED, 'ignore_patterns' => InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY, 'triggered_by' => InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY, 'files' => InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY]
Tags
Return values
mixed —toolkitTestPhpstan()
Run PHPStan.
public
toolkitTestPhpstan([array<string|int, mixed> $options = ['config' => InputOption::VALUE_REQUIRED, 'level' => InputOption::VALUE_REQUIRED, 'files' => InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY, 'memory-limit' => InputOption::VALUE_OPTIONAL, 'options' => InputOption::VALUE_OPTIONAL] ]) : mixed
Check configurations at config/default.yml - 'toolkit.test.phpstan'.
Parameters
- $options : array<string|int, mixed> = ['config' => InputOption::VALUE_REQUIRED, 'level' => InputOption::VALUE_REQUIRED, 'files' => InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY, 'memory-limit' => InputOption::VALUE_OPTIONAL, 'options' => InputOption::VALUE_OPTIONAL]
Tags
Return values
mixed —toolkitTestPhpunit()
Run PHPUnit tests.
public
toolkitTestPhpunit([array<string|int, mixed> $options = ['execution' => InputOption::VALUE_REQUIRED, 'from' => InputOption::VALUE_REQUIRED, 'to' => InputOption::VALUE_REQUIRED] ]) : mixed
Check configurations at config/default.yml - 'toolkit.test.phpunit'. Accept commands to run before and/or after the PHPUnit tests.
Parameters
- $options : array<string|int, mixed> = ['execution' => InputOption::VALUE_REQUIRED, 'from' => InputOption::VALUE_REQUIRED, 'to' => InputOption::VALUE_REQUIRED]
Tags
Return values
mixed —getBin()
Validate and return the path to given bin.
protected
getBin(string $name) : string
Parameters
- $name : string
-
The bin to look for.
Tags
Return values
string —The bin path.
getBinPath()
Return the path to given bin.
protected
getBinPath(string $name) : string
Parameters
- $name : string
Return values
string —The path to given binary.
getConfigValue()
{@inheritdoc}
protected
getConfigValue(mixed $key[, mixed $default = null ]) : mixed
Parameters
- $key : mixed
- $default : mixed = null
Return values
mixed —getNodeBin()
Validate and return the path to given bin from node packages.
protected
getNodeBin(string $name) : string
Parameters
- $name : string
-
The bin to look for.
Tags
Return values
string —The bin path.
getNodeBinPath()
Return the path to given bin from node packages.
protected
getNodeBinPath(string $name) : string
Parameters
- $name : string
Return values
string —The path to given binary.
isSimulating()
Check if current command is being executed with option simulate.
protected
isSimulating() : bool
Return values
bool —True if using --simulate, false otherwise.
taskExecute()
Execute a command.
protected
taskExecute(array<string|int, mixed> $tasks) : mixed
Parameters
- $tasks : array<string|int, mixed>
-
An array with tasks to execute.
Return values
mixed —taskProcess()
Process the file.
protected
taskProcess(string $source[, string $destination = '' ]) : Process|CollectionBuilder
Parameters
- $source : string
-
The source file to process.
- $destination : string = ''
-
The destination file.
Return values
Process|CollectionBuilder —taskReplaceBlock()
Replace block in a file.
protected
taskReplaceBlock([string $filename = '' ]) : ReplaceBlock|CollectionBuilder
Parameters
- $filename : string = ''
-
The file to process.
Return values
ReplaceBlock|CollectionBuilder —toolkitRunGrumphp()
Run PHP code sniffer within GrumPHP.
protected
toolkitRunGrumphp() : mixed
Tags
Return values
mixed —toolkitRunPhpcs()
Run PHP code sniffer.
protected
toolkitRunPhpcs() : mixed
Check configurations at config/default.yml - 'toolkit.test.phpcs'.