Fr3nch13/CakePHP Utilities

PackagesCommandTest extends TestCase
in package

Application

uses ConsoleIntegrationTestTrait

Cake TestCase class

Properties

$autoFixtures : bool: By default, all fixtures attached to this class will be truncated and reloaded after each test.
$dropTables : bool: Control table create/drops on each test method.
$fixtureManager : FixtureManager|null: The class responsible for managing the creation, loading and removing of fixtures
$_configure : array<string|int, mixed>: Configure values to restore at end of test.
$_err : StubConsoleOutput: Console error output stub
$_exitCode : int|null: Last exit code
$_in : StubConsoleInput: Console input mock
$_out : StubConsoleOutput: Console output stub
$_tableLocator : LocatorInterface|null: Table locator instance
$_useCommandRunner : bool: Whether to use the CommandRunner
$command : PackagesCommand
$defaultTable : string|null: This object's default table alias.
$fixtures : array<string|int, string>: Fixtures used by this test case.
$fixtureStrategy : FixtureStrategyInterface|null

Methods

assertDirectoryDoesNotExist() : void: Asserts that a directory does not exist.
assertDoesNotMatchRegularExpression() : void: Asserts that a string does not match a given regular expression.
assertEqualsSql() : void: Assert that a string matches SQL with db-specific characters like quotes removed.
assertErrorContains() : void: Asserts `stderr` contains expected output
assertErrorEmpty() : void: Asserts that `stderr` is empty
assertErrorRegExp() : void: Asserts `stderr` contains expected regexp
assertEventFired() : void: Asserts that a global event was fired. You must track events in your event manager for this assertion to work
assertEventFiredWith() : void: Asserts an event was fired with data
assertExitCode() : void: Asserts shell exited with the expected code
assertExitError() : void: Asserts shell exited with Command::CODE_ERROR
assertExitSuccess() : void: Asserts shell exited with the Command::CODE_SUCCESS
assertFileDoesNotExist() : void: Asserts that a file does not exist.
assertHtml() : bool: Asserts HTML tags.
assertMatchesRegularExpression() : void: Asserts that a string matches a given regular expression.
assertOutputContains() : void: Asserts `stdout` contains expected output
assertOutputEmpty() : void: Asserts that `stdout` is empty
assertOutputNotContains() : void: Asserts `stdout` does not contain expected output
assertOutputRegExp() : void: Asserts `stdout` contains expected regexp
assertRegExpSql() : void: Assertion for comparing a regex pattern against a query having its identifiers quoted. It accepts queries quoted with the characters `<` and `>`. If the third parameter is set to true, it will alter the pattern to both accept quoted and unquoted queries
assertTextContains() : void: Assert that a string contains another string, ignoring differences in newlines.
assertTextEndsNotWith() : void: Asserts that a string ends not with a given prefix, ignoring differences in newlines.
assertTextEndsWith() : void: Asserts that a string ends with a given prefix, ignoring differences in newlines.
assertTextEquals() : void: Assert text equality, ignoring differences in newlines.
assertTextNotContains() : void: Assert that a text doesn't contain another text, ignoring differences in newlines.
assertTextNotEquals() : void: Assert text equality, ignoring differences in newlines.
assertTextStartsNotWith() : void: Asserts that a string starts not with a given prefix, ignoring differences in newlines.
assertTextStartsWith() : void: Asserts that a string starts with a given prefix, ignoring differences in newlines.
cleanupConsoleTrait() : void: Cleans state to get ready for the next test
clearPlugins() : void: Clear all plugins from the global plugin collection.
deprecated() : void: Helper method for check deprecation methods
exec() : void: Runs CLI integration test
fetchTable() : Table: Convenience method to get a table instance.
getFixtures() : array<string|int, string>: Get the fixtures this test should use.
getMockForModel() : Table|MockObject: Mock a model, maintain fixtures and table association
getTableLocator() : LocatorInterface: Gets the table locator.
loadFixtures() : void: Chooses which fixtures to load for a given test
loadPlugins() : BaseApplication: Load plugins into a simulated application.
loadRoutes() : void: Load routes for the application.
removePlugins() : void: Remove plugins from the global plugin collection.
setAppNamespace() : string|null: Set the app namespace
setTableLocator() : $this: Sets the table locator.
setUp() : void: setUp method
skipIf() : bool: Overrides SimpleTestCase::skipIf to provide a boolean return value
testBuildOptionParser() : void: Test \Fr3nch13\Utilities\Command\PackagesCommand::buildOptionParser()
testGetDescription() : void: Test \Fr3nch13\Utilities\Command\PackagesCommand::getDescription()
testHelpOption() : void: Test the help option.
testNoOptions() : void: Test no options.
testOptionBadPath() : void: Test when the path option is bad.
testOptionCommandAll() : void: Test the command option with all selected.
testOptionCommandApp() : void: Test the command option with app selected.
testOptionCommandCompare() : void: Test the command option with compare selected.
testOptionCommandPackages() : void: Test the command option with packages selected.
testOptionPath() : void: Test the path options.
testVerboseOption() : void: Test the verbose option.
useCommandRunner() : void: Set this test case to use the CommandRunner rather than the legacy ShellDispatcher
withErrorReporting() : void: Helper method for tests that needs to use error_reporting()
_assertAttributes() : string|false: Check the attributes as part of an assertTags() check.
_getTableClassName() : string: Gets the class name for the table.
_normalizePath() : string: Normalize a path for comparison.
addFixture() : $this: Adds a fixture to this test case.
assertNotWithinRange() : void: Compatibility function to test if a value is not between an acceptable range.
assertOutputContainsRow() : void: Check that a row of cells exists in the output.
assertPathEquals() : void: Compatibility function to test paths.
assertWithinRange() : void: Compatibility function to test if a value is between an acceptable range.
commandStringToArgs() : array<string|int, string>: Creates an $argv array from a command string
getFixtureStrategy() : FixtureStrategyInterface: Returns fixture strategy used by these tests.
makeRunner() : CommandRunner|LegacyCommandRunner: Builds the appropriate command dispatcher
setupFixtures() : void: Initialized and loads any use fixtures.
skipUnless() : bool: Compatibility function for skipping.
tearDown() : void: teardown any static object changes and restore them.
teardownFixtures() : void: Unloads any use fixtures.

$autoFixtures

By default, all fixtures attached to this class will be truncated and reloaded after each test.

autoFixtures is only used by deprecated fixture features. This property will be removed in 5.0


    public
        bool
    $autoFixtures
     = true

Set this to false to handle manually

$dropTables

Control table create/drops on each test method.

dropTables is only used by deprecated fixture features. This property will be removed in 5.0


    public
        bool
    $dropTables
     = false

If true, tables will still be dropped at the end of each test runner execution.

$fixtureManager

The class responsible for managing the creation, loading and removing of fixtures


    public
    static    FixtureManager|null
    $fixtureManager

$_configure

Configure values to restore at end of test.


    protected
        array<string|int, mixed>
    $_configure
     = []

$_err

Console error output stub


    protected
        StubConsoleOutput
    $_err

$_exitCode

Last exit code


    protected
        int|null
    $_exitCode

$_in

Console input mock


    protected
        StubConsoleInput
    $_in

$_out

Console output stub


    protected
        StubConsoleOutput
    $_out

$_tableLocator

Table locator instance


    protected
        LocatorInterface|null
    $_tableLocator

$_useCommandRunner

Whether to use the CommandRunner


    protected
        bool
    $_useCommandRunner
     = false

$command


    protected
        PackagesCommand
    $command

$defaultTable

This object's default table alias.


    protected
        string|null
    $defaultTable
     = null

$fixtures

Fixtures used by this test case.


    protected
        array<string|int, string>
    $fixtures
     = []

$fixtureStrategy


    protected
        FixtureStrategyInterface|null
    $fixtureStrategy
     = null

assertDirectoryDoesNotExist()

Asserts that a directory does not exist.


    public
            static        assertDirectoryDoesNotExist(string $directory[, string $message = '' ]) : void

Parameters

$directory : string: Directory
$message : string = '': Message

assertDoesNotMatchRegularExpression()

Asserts that a string does not match a given regular expression.


    public
            static        assertDoesNotMatchRegularExpression(string $pattern, string $string[, string $message = '' ]) : void

Parameters

$pattern : string: Regex pattern
$string : string: String to test
$message : string = '': Message

assertEqualsSql()

Assert that a string matches SQL with db-specific characters like quotes removed.


    public
                    assertEqualsSql(string $expected, string $actual[, string $message = '' ]) : void

Parameters

$expected : string: The expected sql
$actual : string: The sql to compare
$message : string = '': The message to display on failure

assertErrorContains()

Asserts `stderr` contains expected output


    public
                    assertErrorContains(string $expected[, string $message = '' ]) : void

Parameters

$expected : string: Expected output
$message : string = '': Failure message

assertErrorEmpty()

Asserts that `stderr` is empty


    public
                    assertErrorEmpty([string $message = '' ]) : void

Parameters

$message : string = '': The message to output when the assertion fails.

assertErrorRegExp()

Asserts `stderr` contains expected regexp


    public
                    assertErrorRegExp(string $pattern[, string $message = '' ]) : void

Parameters

$pattern : string: Expected pattern
$message : string = '': Failure message

assertEventFired()

Asserts that a global event was fired. You must track events in your event manager for this assertion to work


    public
                    assertEventFired(string $name[, EventManager|null $eventManager = null ][, string $message = '' ]) : void

Parameters

$name : string: Event name
$eventManager : EventManager|null = null: Event manager to check, defaults to global event manager
$message : string = '': Assertion failure message

assertEventFiredWith()

Asserts an event was fired with data


    public
                    assertEventFiredWith(string $name, string $dataKey, mixed $dataValue[, EventManager|null $eventManager = null ][, string $message = '' ]) : void

If a third argument is passed, that value is used to compare with the value in $dataKey

Parameters

$name : string: Event name
$dataKey : string: Data key
$dataValue : mixed: Data value
$eventManager : EventManager|null = null: Event manager to check, defaults to global event manager
$message : string = '': Assertion failure message

assertExitCode()

Asserts shell exited with the expected code


    public
                    assertExitCode(int $expected[, string $message = '' ]) : void

Parameters

$expected : int: Expected exit code
$message : string = '': Failure message

assertExitError()

Asserts shell exited with Command::CODE_ERROR


    public
                    assertExitError([string $message = '' ]) : void

Parameters

$message : string = '': Failure message

assertExitSuccess()

Asserts shell exited with the Command::CODE_SUCCESS


    public
                    assertExitSuccess([string $message = '' ]) : void

Parameters

$message : string = '': Failure message

assertFileDoesNotExist()

Asserts that a file does not exist.


    public
            static        assertFileDoesNotExist(string $filename[, string $message = '' ]) : void

Parameters

$filename : string: Filename
$message : string = '': Message

assertHtml()

Asserts HTML tags.


    public
                    assertHtml(array<string|int, mixed> $expected, string $string[, bool $fullDebug = false ]) : bool

Takes an array $expected and generates a regex from it to match the provided $string. Samples for $expected:

Checks for an input tag with a name attribute (contains any non-empty value) and an id attribute that contains 'my-input':

['input' => ['name', 'id' => 'my-input']]

Checks for two p elements with some text in them:

[
  ['p' => true],
  'textA',
  '/p',
  ['p' => true],
  'textB',
  '/p'
]

You can also specify a pattern expression as part of the attribute values, or the tag being defined, if you prepend the value with preg: and enclose it with slashes, like so:

[
  ['input' => ['name', 'id' => 'preg:/FieldName\d+/']],
  'preg:/My\s+field/'
]

Important: This function is very forgiving about whitespace and also accepts any permutation of attribute order. It will also allow whitespace between specified tags.

Parameters

$expected : array<string|int, mixed>: An array, see above
$string : string: An HTML/XHTML/XML string
$fullDebug : bool = false: Whether more verbose output should be used.

Return values

bool

assertMatchesRegularExpression()

Asserts that a string matches a given regular expression.


    public
            static        assertMatchesRegularExpression(string $pattern, string $string[, string $message = '' ]) : void

Parameters

$pattern : string: Regex pattern
$string : string: String to test
$message : string = '': Message

assertOutputContains()

Asserts `stdout` contains expected output


    public
                    assertOutputContains(string $expected[, string $message = '' ]) : void

Parameters

$expected : string: Expected output
$message : string = '': Failure message

assertOutputEmpty()

Asserts that `stdout` is empty


    public
                    assertOutputEmpty([string $message = '' ]) : void

Parameters

$message : string = '': The message to output when the assertion fails.

assertOutputNotContains()

Asserts `stdout` does not contain expected output


    public
                    assertOutputNotContains(string $expected[, string $message = '' ]) : void

Parameters

$expected : string: Expected output
$message : string = '': Failure message

assertOutputRegExp()

Asserts `stdout` contains expected regexp


    public
                    assertOutputRegExp(string $pattern[, string $message = '' ]) : void

Parameters

$pattern : string: Expected pattern
$message : string = '': Failure message

assertRegExpSql()

Assertion for comparing a regex pattern against a query having its identifiers quoted. It accepts queries quoted with the characters `<` and `>`. If the third parameter is set to true, it will alter the pattern to both accept quoted and unquoted queries


    public
                    assertRegExpSql(string $pattern, string $actual[, bool $optional = false ]) : void

Parameters

$pattern : string: The expected sql pattern
$actual : string: The sql to compare
$optional : bool = false: Whether quote characters (marked with <>) are optional