final class PHPUnitRunner extends TestRunner

Supports PHPUnit testing operations.

Traits

Supports ability to validate console input.

Constants

ALLOWED_OPTIONS

The array of options allowed as input for the test command.

TEST_COMMAND

The command for PHPUnit

TEST_FILE_EXTENSIONS

Array of supported test file extensions.

TEST_SUITES

Array of available test suites.

FEATURE_PATH

The path for feature tests.

TEST_FILE_EXTENSION

File extension for PHPUnit unit tests.

UNIT_PATH

The path for unit tests.

Properties

protected array $errors

An array of errors.

from  HasValidators
protected string $fieldName

The name of the field to be validated.

from  HasValidators
protected array $reservedKeywords

An array of reserved keywords.

from  HasValidators
protected array $validators

Array of validator callbacks.

from  HasValidators
protected InputInterface $input

A string of input options provided as input when running the test command.

from  TestRunner
protected OutputInterface $output

The Symfony OutputInterface object.

from  TestRunner

Methods

void
addErrorMessage(string $message)

Adds a new error message to the $errors array.

alpha()

Enforce rule where input must contain only alphabetic characters.

alphaNumeric()

Enforce rule where input must be alphanumeric characters.

between(array $range)

Ensures input is between within a certain range in length.

classExists(string|array $namespace)

Checks if class exists within the specified namespace.

colonNotation()

Ensures response is in colon notation format.

different(mixed $data)

Enforce rule where response and $match parameter needs to be different.

void
displayErrorMessages()

Displays a list of all error messages.

dotNotation()

Ensures response is in dot notation format.

email()

Ensures input is a valid E-mail address.

fieldName(string|array $fieldName)

Sets name of field to be validated.

ip()

Enforce rule where input must be a valid IP address.

integer()

Enforce rule where input must be an integer.

isPortUsed(array $attributes)

Checks if a port on a particular host is in use. Assists in verifying if a port is available for a serve command. If the port is already in use an error message is presented to the user.

list(array $attributes)

Ensure user inputs valid comma separated list of values. The user must provide the following in the $attributes parameter: 1) Class containing full namespaced path 2) Name of function that returns an array of strings or a comma separated array of strings.

lower()

Enforces rule when input must contain at least one lower case character.

match(mixed $match)

Enforce rule where response and $match parameter needs to match.

max(int|array $maxRule)

Ensures input meets requirements for maximum allowable length.

min(int|array $minRule)

Ensures input meets requirements for minimum allowable length.

negative()

Enforces rule when input must be a negative number.

noSpecialChars()

Enforces rule when input must contain no special characters.

notReservedKeyword()

Enforce rule when reserved keywords should be avoided.

number()

Enforces rule when input must contain at least one numeric character.

numeric()

Enforce rule where input must contain only numeric characters.

required()

Ensures required input is entered.

positive()

Enforces rule when input must a positive number.

queue()

Validates if queue exists in database or redis.

setValidator(callable $validator)

Adds validator to array of validators to be used.

special()

Enforces rule when input must contain at least one special character.

testFilterNotation()

Ensures response is in colon notation format.

static array
tokens(string $data)

Split on commas (tolerate spaces), normalize to lowercase, drop empties.

upper()

Enforces rule when input must contain at least one lower case character.

url()

Enforce rule where input must be a valid URL.

bool
validate(mixed $response)

Calls validator callbacks. This function also ensures validators don't bleed into next question if instance is reused.

__construct(InputInterface $input, OutputInterface $output)

Constructor

static void
argOptionValidate(string $field, string $message, FrameworkQuestion $question, array $validators = [], bool $defaultNone = false)

Validates argument and option input. If validation fails then the user is asked to enter a new value.

from  Console
static mixed
choice(string $message, array $choices, FrameworkQuestion $question, string|bool|int|float|null $default = null)

Ask user to confirm among several options based on question asked.

from  Console
static mixed
confirm(string $message, FrameworkQuestion $question, string|bool|int|float|null $default = true)

Asks a user to confirm based on question asked.

from  Console
static Console
getInstance(string $fieldName = "")

Returns instance of this or child helper class.

from  Console
static string
prompt(string $message, FrameworkQuestion $question, array $attributes = [], array $suggestions = [], string|bool|int|float|null $default = null, bool $defaultNone = false)

Asks user question about file to be created.

from  Console
static void
parseAttributes(object $object, array $validators)

Parse array containing additional validators or attributes for FrameworkQuestion as strings along with any additional parameters that maybe expected.

from  Console
int
allTests()

Performs all available tests.

bool
areAllSuitesEmpty(array $testSuites)

Test to ensure there is not an empty test suite.

static void
duplicateTestNameMessage()

Present message to the user if the following conditions are true:

  • Test case files in multiple suites with the same name
  • There exists a function in both classes with the same name

static string
filter(string $file, string $location, string $extension = "")

Generates filter when testing by particular line number/function within a test file

static array
getAllTestsInSuite(string $path, string $extension)

Retrieves all files in test suite so they can be run.

static void
noAvailableTestsMessage()

Alerts use if there are no available tests to perform.

string
parseOptions()

Parses related arguments and ignore Symfony arguments.

void
runTest(string $test)

Runs the unit test for your testing suite.

int
selectByTestName(string $testArg)

Supports ability to run test by class/file name.

int
singleFileWithinSuite(string $testArg, string $testSuite, string $extension)

Performs testing against a single class within a test suite.

int
testByFilter(string $testArg, FrameworkQuestion $question)

Run filtered test by line number or function within a test file. This function works across multiple test suite types and supports multiple file extensions. Correct filter syntax must be implemented in separate filter() function that must be implemented before this function can successfully execute.

static string
testCommand()

Returns value of TEST_COMMAND constant.

static bool
testExists(string $name)

Determine if test file exists in any of the available test suites.

static array
testFileExtensions()

Returns array of supported test file extensions.

static bool
testIfSame(string $name)

Enforces rule that classes/files across test suites should be unique for filtering.

int
testSuite(array $collection)

Run all test files in an individual test suite.

static array
testSuites()

Return array of available test suites.

static bool
testSuiteStatus(array $suiteStatuses)

Determines if execution of a test suite(s) is successful. The result is determined by testing if the status value is set and its integer value is equal to Command::SUCCESS.

Details

in HasValidators at line 79
void addErrorMessage(string $message)

Adds a new error message to the $errors array.

Parameters

string $message

The error message to be added to the $errors array.

Return Value

void

in HasValidators at line 89
HasValidators alpha()

Enforce rule where input must contain only alphabetic characters.

Return Value

HasValidators

in HasValidators at line 103
HasValidators alphaNumeric()

Enforce rule where input must be alphanumeric characters.

Return Value

HasValidators

in HasValidators at line 121
HasValidators between(array $range)

Ensures input is between within a certain range in length.

Parameters

array $range

2 element array where position 0 is min and position 1 is max.

Return Value

HasValidators

Exceptions

FrameworkRuntimeException

in HasValidators at line 146
HasValidators classExists(string|array $namespace)

Checks if class exists within the specified namespace.

Parameters

string|array $namespace

A string or an array containing one element with string for the namespace.

Return Value

HasValidators

in HasValidators at line 161
HasValidators colonNotation()

Ensures response is in colon notation format.

Return Value

HasValidators

in HasValidators at line 179
HasValidators different(mixed $data)

Enforce rule where response and $match parameter needs to be different.

Parameters

mixed $data

The value we want to compare.

Return Value

HasValidators

in HasValidators at line 194
void displayErrorMessages()

Displays a list of all error messages.

Return Value

void

in HasValidators at line 210
HasValidators dotNotation()

Ensures response is in dot notation format.

Return Value

HasValidators

in HasValidators at line 227
HasValidators email()

Ensures input is a valid E-mail address.

Return Value

HasValidators

in HasValidators at line 242
HasValidators fieldName(string|array $fieldName)

Sets name of field to be validated.

Parameters

string|array $fieldName

The name of the field to be validated.

Return Value

HasValidators

in HasValidators at line 253
HasValidators ip()

Enforce rule where input must be a valid IP address.

Return Value

HasValidators

in HasValidators at line 267
HasValidators integer()

Enforce rule where input must be an integer.

Return Value

HasValidators

in HasValidators at line 285
HasValidators isPortUsed(array $attributes)

Checks if a port on a particular host is in use. Assists in verifying if a port is available for a serve command. If the port is already in use an error message is presented to the user.

Parameters

array $attributes

An array that assumes index 0 is the host and index 1 is timeout variable which is set to 3 if not provided.

Return Value

HasValidators

in HasValidators at line 314
HasValidators list(array $attributes)

Ensure user inputs valid comma separated list of values. The user must provide the following in the $attributes parameter: 1) Class containing full namespaced path 2) Name of function that returns an array of strings or a comma separated array of strings.

3) A string value in this array as an alias (optional).

Parameters

array $attributes

A : separate list in the following format: NamespaceToClass\Class:Method:Alias.

Return Value

HasValidators

in HasValidators at line 352
HasValidators lower()

Enforces rule when input must contain at least one lower case character.

Return Value

HasValidators

in HasValidators at line 367
HasValidators match(mixed $match)

Enforce rule where response and $match parameter needs to match.

Parameters

mixed $match

The value we want to compare.

Return Value

HasValidators

in HasValidators at line 382
HasValidators max(int|array $maxRule)

Ensures input meets requirements for maximum allowable length.

Parameters

int|array $maxRule

The maximum allowed size for input.

Return Value

HasValidators

in HasValidators at line 398
HasValidators min(int|array $minRule)

Ensures input meets requirements for minimum allowable length.

Parameters

int|array $minRule

The minimum allowed size for input.

Return Value

HasValidators

in HasValidators at line 413
HasValidators negative()

Enforces rule when input must be a negative number.

Return Value

HasValidators

in HasValidators at line 427
HasValidators noSpecialChars()

Enforces rule when input must contain no special characters.

Return Value

HasValidators

in HasValidators at line 441
HasValidators notReservedKeyword()

Enforce rule when reserved keywords should be avoided.

Return Value

HasValidators

in HasValidators at line 455
HasValidators number()

Enforces rule when input must contain at least one numeric character.

Return Value

HasValidators

in HasValidators at line 469
HasValidators numeric()

Enforce rule where input must contain only numeric characters.

Return Value

HasValidators

in HasValidators at line 483
HasValidators required()

Ensures required input is entered.

Return Value

HasValidators

in HasValidators at line 496
HasValidators positive()

Enforces rule when input must a positive number.

Return Value

HasValidators

in HasValidators at line 510
HasValidators queue()

Validates if queue exists in database or redis.

Return Value

HasValidators

in HasValidators at line 534
HasValidators setValidator(callable $validator)

Adds validator to array of validators to be used.

Parameters

callable $validator

The anonymous function for a validator.

Return Value

HasValidators

in HasValidators at line 544
HasValidators special()

Enforces rule when input must contain at least one special character.

Return Value

HasValidators

in HasValidators at line 558
HasValidators testFilterNotation()

Ensures response is in colon notation format.

Return Value

HasValidators

in HasValidators at line 579
static protected array tokens(string $data)

Split on commas (tolerate spaces), normalize to lowercase, drop empties.

Useful for cases where you have a comma separated string.

Parameters

string $data

Comma separated strings of values to be converted into an array.

Return Value

array

An array containing values originally found in comma separated string.

in HasValidators at line 589
HasValidators upper()

Enforces rule when input must contain at least one lower case character.

Return Value

HasValidators

in HasValidators at line 603
HasValidators url()

Enforce rule where input must be a valid URL.

Return Value

HasValidators

in HasValidators at line 619
protected bool validate(mixed $response)

Calls validator callbacks. This function also ensures validators don't bleed into next question if instance is reused.

Parameters

mixed $response

The user answer.

Return Value

bool

True if validation passed. Otherwise, we return false.

at line 74
__construct(InputInterface $input, OutputInterface $output)

Constructor

Parameters

InputInterface $input

The Symfony InputInterface object.

OutputInterface $output

The Symfony OutputInterface object.

in Console at line 42
static void argOptionValidate(string $field, string $message, FrameworkQuestion $question, array $validators = [], bool $defaultNone = false)

Validates argument and option input. If validation fails then the user is asked to enter a new value.

Validates the following conditions: 1) required 2) noSpecialChars 3) alpha 4) notReservedKeyword

Parameters

string $field

The reference to the value to be validated.

string $message

The message to present to the user.

FrameworkQuestion $question

Instance of FrameworkQuestion class.

array $validators
bool $defaultNone

When set to true user will have to specify all validators.

Return Value

void

in Console at line 75
static mixed choice(string $message, array $choices, FrameworkQuestion $question, string|bool|int|float|null $default = null)

Ask user to confirm among several options based on question asked.

Parameters

string $message

The message to present to the user.

array $choices

An array of choices.

FrameworkQuestion $question

Instance of FrameworkQuestion class.

string|bool|int|float|null $default

The default value if the user does not provide an answer.

Return Value

mixed

The user answer.

in Console at line 93
static mixed confirm(string $message, FrameworkQuestion $question, string|bool|int|float|null $default = true)

Asks a user to confirm based on question asked.

Parameters

string $message

The message to present to the user.

FrameworkQuestion $question

Instance of FrameworkQuestion class.

string|bool|int|float|null $default

The default value if the user does not provide an answer.

Return Value

mixed

The user answer.

in Console at line 107
static Console getInstance(string $fieldName = "")

Returns instance of this or child helper class.

Parameters

string $fieldName

The name of the field to be validated.

Return Value

Console

in Console at line 132
static string prompt(string $message, FrameworkQuestion $question, array $attributes = [], array $suggestions = [], string|bool|int|float|null $default = null, bool $defaultNone = false)

Asks user question about file to be created.

Validates the following conditions: 1) required 2) noSpecialChars 3) alpha 4) notReservedKeyword

Parameters

string $message

The message to present to the user.

FrameworkQuestion $question

Instance of FrameworkQuestion class.

array $attributes

An array of additional validators.

array $suggestions

An array of suggestions for when $anticipate is set to true. An exception is thrown if this array is empty and $anticipate = true.

string|bool|int|float|null $default

The default value if the user does not provide an answer.

bool $defaultNone

When set to true user will have to specify all validators and attributes.

Return Value

string

The user response.

in Console at line 167
static protected void parseAttributes(object $object, array $validators)

Parse array containing additional validators or attributes for FrameworkQuestion as strings along with any additional parameters that maybe expected.

Parameters

object $object

The instance of a class using the HasValidators trait.

array $validators

An array of validators. Any additional parameters must be separated with a ":".

Return Value

void

Exceptions

FrameworkException

in TestRunner at line 67
int allTests()

Performs all available tests.

Return Value

int

A value that indicates success, invalid, or failure.

in TestRunner at line 102
bool areAllSuitesEmpty(array $testSuites)

Test to ensure there is not an empty test suite.

Parameters

array $testSuites

The collection of all available test suites. Best practice is to use const provided by child class.

Return Value

bool

True if all test suites are empty. Otherwise, we return false.

in TestRunner at line 117
static private void duplicateTestNameMessage()

Present message to the user if the following conditions are true:

  • Test case files in multiple suites with the same name
  • There exists a function in both classes with the same name

This function is called internally by the selectTest function.

Return Value

void

at line 89
static protected string filter(string $file, string $location, string $extension = "")

Generates filter when testing by particular line number/function within a test file

Parameters

string $file

The name of the test file.

string $location

Line number/function within the test file

string $extension

The file extension. Default value is an empty string.

Return Value

string

The formatted string for filtering tests by location within a file.

in TestRunner at line 142
static array getAllTestsInSuite(string $path, string $extension)

Retrieves all files in test suite so they can be run.

Parameters

string $path

Path to test suite.

string $extension

File extension to specify between php and js related tests. Best practice is to use const provided by child class.

Return Value

array

The array of all filenames in a particular directory.

in TestRunner at line 151
static private void noAvailableTestsMessage()

Alerts use if there are no available tests to perform.

Return Value

void

at line 101
string parseOptions()

Parses related arguments and ignore Symfony arguments.

Return Value

string

A string containing the arguments to be provided to test command.

in TestRunner at line 169
void runTest(string $test)

Runs the unit test for your testing suite.

Parameters

string $test

The test to be performed.

Return Value

void

in TestRunner at line 181
int selectByTestName(string $testArg)

Supports ability to run test by class/file name.

Parameters

string $testArg

The name of the class/file.

Return Value

int

A value that indicates success, invalid, or failure.

in TestRunner at line 216
int singleFileWithinSuite(string $testArg, string $testSuite, string $extension)

Performs testing against a single class within a test suite.

Parameters

string $testArg

The name of the test file without extension.

string $testSuite

The name of the test suite. Best practice is to use const provided by child class.

string $extension

The file extension. Best practice is to use const provided by child class.

Return Value

int

A value that indicates success, invalid, or failure.

in TestRunner at line 236
int testByFilter(string $testArg, FrameworkQuestion $question)

Run filtered test by line number or function within a test file. This function works across multiple test suite types and supports multiple file extensions. Correct filter syntax must be implemented in separate filter() function that must be implemented before this function can successfully execute.

Parameters

string $testArg

The name of the test file.

FrameworkQuestion $question

Instance of FrameworkQuestion class.

Return Value

int

A value that indicates success, invalid, or failure.

in TestRunner at line 267
static string testCommand()

Returns value of TEST_COMMAND constant.

Return Value

string

The test command string.

in TestRunner at line 277
static bool testExists(string $name)

Determine if test file exists in any of the available test suites.

Parameters

string $name

The name of the test we want to confirm if it exists.

Return Value

bool

True if test does exist. Otherwise, we return false.

in TestRunner at line 293
static array testFileExtensions()

Returns array of supported test file extensions.

Return Value

array

An array of supported test file extensions.

in TestRunner at line 304
static bool testIfSame(string $name)

Enforces rule that classes/files across test suites should be unique for filtering.

Parameters

string $name

Name of the test class to be executed.

Return Value

bool

True if the class or file name exists in multiple test suites. Otherwise, we return false.

in TestRunner at line 325
int testSuite(array $collection)

Run all test files in an individual test suite.

Parameters

array $collection

All classes in a particular test suite.

Return Value

int

A value that indicates success, invalid, or failure.

in TestRunner at line 342
static array testSuites()

Return array of available test suites.

Return Value

array

in TestRunner at line 356
static bool testSuiteStatus(array $suiteStatuses)

Determines if execution of a test suite(s) is successful. The result is determined by testing if the status value is set and its integer value is equal to Command::SUCCESS.

Parameters

array $suiteStatuses

Array of integers that indicates a test is successful.

Return Value

bool

True if execution is successful. Otherwise, we return false.