PHPUnitRunner
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
Adds a new error message to the $errors array.
Enforce rule where input must contain only alphabetic characters.
Enforce rule where input must be alphanumeric characters.
Ensures input is between within a certain range in length.
Checks if class exists within the specified namespace.
Enforce rule where response and $match parameter needs to be different.
Sets name of field to be validated.
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.
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.
Enforces rule when input must contain at least one lower case character.
Enforce rule where response and $match parameter needs to match.
Ensures input meets requirements for maximum allowable length.
Ensures input meets requirements for minimum allowable length.
Enforces rule when input must contain no special characters.
Enforce rule when reserved keywords should be avoided.
Enforces rule when input must contain at least one numeric character.
Enforce rule where input must contain only numeric characters.
Adds validator to array of validators to be used.
Enforces rule when input must contain at least one special character.
Split on commas (tolerate spaces), normalize to lowercase, drop empties.
Enforces rule when input must contain at least one lower case character.
Calls validator callbacks. This function also ensures validators don't bleed into next question if instance is reused.
Constructor
Validates argument and option input. If validation fails then the user is asked to enter a new value.
Ask user to confirm among several options based on question asked.
Asks a user to confirm based on question asked.
Returns instance of this or child helper class.
Asks user question about file to be created.
Parse array containing additional validators or attributes for FrameworkQuestion as strings along with any additional parameters that maybe expected.
Test to ensure there is not an empty test suite.
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
Generates filter when testing by particular line number/function within a test file
Retrieves all files in test suite so they can be run.
Alerts use if there are no available tests to perform.
Parses related arguments and ignore Symfony arguments.
Supports ability to run test by class/file name.
Performs testing against a single class within a test suite.
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.
Determine if test file exists in any of the available test suites.
Enforces rule that classes/files across test suites should be unique for filtering.
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.
in
HasValidators at line 89
HasValidators
alpha()
Enforce rule where input must contain only alphabetic characters.
in
HasValidators at line 103
HasValidators
alphaNumeric()
Enforce rule where input must be alphanumeric characters.
in
HasValidators at line 121
HasValidators
between(array $range)
Ensures input is between within a certain range in length.
in
HasValidators at line 146
HasValidators
classExists(string|array $namespace)
Checks if class exists within the specified namespace.
in
HasValidators at line 161
HasValidators
colonNotation()
Ensures response is in colon notation format.
in
HasValidators at line 179
HasValidators
different(mixed $data)
Enforce rule where response and $match parameter needs to be different.
in
HasValidators at line 194
void
displayErrorMessages()
Displays a list of all error messages.
in
HasValidators at line 210
HasValidators
dotNotation()
Ensures response is in dot notation format.
in
HasValidators at line 227
HasValidators
email()
Ensures input is a valid E-mail address.
in
HasValidators at line 242
HasValidators
fieldName(string|array $fieldName)
Sets name of field to be validated.
in
HasValidators at line 253
HasValidators
ip()
Enforce rule where input must be a valid IP address.
in
HasValidators at line 267
HasValidators
integer()
Enforce rule where input must be an integer.
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.
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).
in
HasValidators at line 352
HasValidators
lower()
Enforces rule when input must contain at least one lower case character.
in
HasValidators at line 367
HasValidators
match(mixed $match)
Enforce rule where response and $match parameter needs to match.
in
HasValidators at line 382
HasValidators
max(int|array $maxRule)
Ensures input meets requirements for maximum allowable length.
in
HasValidators at line 398
HasValidators
min(int|array $minRule)
Ensures input meets requirements for minimum allowable length.
in
HasValidators at line 413
HasValidators
negative()
Enforces rule when input must be a negative number.
in
HasValidators at line 427
HasValidators
noSpecialChars()
Enforces rule when input must contain no special characters.
in
HasValidators at line 441
HasValidators
notReservedKeyword()
Enforce rule when reserved keywords should be avoided.
in
HasValidators at line 455
HasValidators
number()
Enforces rule when input must contain at least one numeric character.
in
HasValidators at line 469
HasValidators
numeric()
Enforce rule where input must contain only numeric characters.
in
HasValidators at line 483
HasValidators
required()
Ensures required input is entered.
in
HasValidators at line 496
HasValidators
positive()
Enforces rule when input must a positive number.
in
HasValidators at line 510
HasValidators
queue()
Validates if queue exists in database or redis.
in
HasValidators at line 534
HasValidators
setValidator(callable $validator)
Adds validator to array of validators to be used.
in
HasValidators at line 544
HasValidators
special()
Enforces rule when input must contain at least one special character.
in
HasValidators at line 558
HasValidators
testFilterNotation()
Ensures response is in colon notation format.
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.
in
HasValidators at line 589
HasValidators
upper()
Enforces rule when input must contain at least one lower case character.
in
HasValidators at line 603
HasValidators
url()
Enforce rule where input must be a valid URL.
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.
at line 74
__construct(InputInterface $input, OutputInterface $output)
Constructor
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
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.
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.
in
Console at line 107
static Console
getInstance(string $fieldName = "")
Returns instance of this or child helper class.
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
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.
in
TestRunner at line 67
int
allTests()
Performs all available tests.
in
TestRunner at line 102
bool
areAllSuitesEmpty(array $testSuites)
Test to ensure there is not an empty test suite.
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.
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
in
TestRunner at line 142
static array
getAllTestsInSuite(string $path, string $extension)
Retrieves all files in test suite so they can be run.
in
TestRunner at line 151
static private void
noAvailableTestsMessage()
Alerts use if there are no available tests to perform.
at line 101
string
parseOptions()
Parses related arguments and ignore Symfony arguments.
in
TestRunner at line 169
void
runTest(string $test)
Runs the unit test for your testing suite.
in
TestRunner at line 181
int
selectByTestName(string $testArg)
Supports ability to run test by class/file name.
in
TestRunner at line 216
int
singleFileWithinSuite(string $testArg, string $testSuite, string $extension)
Performs testing against a single class within a test suite.
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.
in
TestRunner at line 267
static string
testCommand()
Returns value of TEST_COMMAND constant.
in
TestRunner at line 277
static bool
testExists(string $name)
Determine if test file exists in any of the available test suites.
in
TestRunner at line 293
static array
testFileExtensions()
Returns 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.
in
TestRunner at line 325
int
testSuite(array $collection)
Run all test files in an individual test suite.
in
TestRunner at line 342
static array
testSuites()
Return array of available test suites.
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.