CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Reporting Security Issues
    • Privacy Policy
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Get Involved
    • Issues (Github)
    • Bakery
    • Featured Resources
    • Training
    • Meetups
    • My CakePHP
    • CakeFest
    • Newsletter
    • Linkedin
    • YouTube
    • Facebook
    • Twitter
    • Mastodon
    • Help & Support
    • Forum
    • Stack Overflow
    • IRC
    • Slack
    • Paid Support
CakePHP

C CakePHP 3.10 Red Velvet API

  • Project:
    • CakePHP
      • CakePHP
      • Authentication
      • Authorization
      • Chronos
      • Elastic Search
      • Queue
  • Version:
    • 3.10
      • 5.2
      • 5.1
      • 5.0
      • 4.6
      • 4.5
      • 4.4
      • 4.3
      • 4.2
      • 4.1
      • 4.0
      • 3.10
      • 3.9
      • 3.8
      • 3.7
      • 3.6
      • 3.5
      • 3.4
      • 3.3
      • 3.2
      • 3.1
      • 3.0
      • 2.10
      • 2.9
      • 2.8
      • 2.7
      • 2.6
      • 2.5
      • 2.4
      • 2.3
      • 2.2
      • 2.1
      • 2.0
      • 1.3
      • 1.2

Namespaces

  • Global
  • Cake
    • Auth
    • Cache
    • Collection
    • Command
    • Console
    • Controller
    • Core
    • Database
    • Datasource
    • Error
    • Event
    • Filesystem
    • Form
    • Http
    • I18n
    • Log
    • Mailer
    • Network
    • ORM
    • Routing
    • Shell
    • TestSuite
      • Constraint
      • Fixture
      • Stub
    • Utility
    • Validation
    • View

Trait ConsoleIntegrationTestTrait

A test case class intended to make integration tests of cake console commands easier.

Namespace: Cake\TestSuite

Property Summary

  • $_err protected
    Cake\TestSuite\Stub\ConsoleOutput|PHPUnit_Framework_MockObject_MockObject|null

    Console error output stub

  • $_exitCode protected
    int|null

    Last exit code

  • $_in protected
    Cake\Console\ConsoleInput|PHPUnit_Framework_MockObject_MockObject|null

    Console input mock

  • $_out protected
    Cake\TestSuite\Stub\ConsoleOutput|PHPUnit_Framework_MockObject_MockObject|null

    Console output stub

  • $_useCommandRunner protected
    bool

    Whether or not to use the CommandRunner

Method Summary

  • assertErrorContains() public

    Asserts stderr contains expected output

  • assertErrorEmpty() public

    Asserts that stderr is empty

  • assertErrorRegExp() public

    Asserts stderr contains expected regexp

  • assertExitCode() public

    Asserts shell exited with the expected code

  • assertExitError() public

    Asserts shell exited with Command::CODE_ERROR

  • assertExitSuccess() public

    Asserts shell exited with the Command::CODE_SUCCESS

  • assertOutputContains() public

    Asserts stdout contains expected output

  • assertOutputContainsRow() protected

    Check that a row of cells exists in the output.

  • assertOutputEmpty() public

    Asserts that stdout is empty

  • assertOutputNotContains() public

    Asserts stdout does not contain expected output

  • assertOutputRegExp() public

    Asserts stdout contains expected regexp

  • cleanupConsoleTrait() public

    Cleans state to get ready for the next test

  • commandStringToArgs() protected

    Creates an $argv array from a command string

  • exec() public

    Runs cli integration test

  • makeRunner() protected

    Builds the appropriate command dispatcher

  • useCommandRunner() public

    Set this test case to use the CommandRunner rather than the legacy ShellDispatcher

Method Detail

assertErrorContains() ¶ public

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

Asserts stderr contains expected output

Parameters
string $expected

Expected output

string $message optional

Failure message

Returns
void

assertErrorEmpty() ¶ public

assertErrorEmpty(string $message = ''): void

Asserts that stderr is empty

Parameters
string $message optional

The message to output when the assertion fails.

Returns
void

assertErrorRegExp() ¶ public

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

Asserts stderr contains expected regexp

Parameters
string $pattern

Expected pattern

string $message optional

Failure message

Returns
void

assertExitCode() ¶ public

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

Asserts shell exited with the expected code

Parameters
int $expected

Expected exit code

string $message optional

Failure message

Returns
void

assertExitError() ¶ public

assertExitError(string $message = ''): void

Asserts shell exited with Command::CODE_ERROR

Parameters
string $message optional

Failure message

Returns
void

assertExitSuccess() ¶ public

assertExitSuccess(string $message = ''): void

Asserts shell exited with the Command::CODE_SUCCESS

Parameters
string $message optional

Failure message

Returns
void

assertOutputContains() ¶ public

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

Asserts stdout contains expected output

Parameters
string $expected

Expected output

string $message optional

Failure message

Returns
void

assertOutputContainsRow() ¶ protected

assertOutputContainsRow(array $row, string $message = ''): void

Check that a row of cells exists in the output.

Parameters
array $row

Row of cells to ensure exist in the output.

string $message optional

Failure message.

Returns
void

assertOutputEmpty() ¶ public

assertOutputEmpty(string $message = ''): void

Asserts that stdout is empty

Parameters
string $message optional

The message to output when the assertion fails.

Returns
void

assertOutputNotContains() ¶ public

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

Asserts stdout does not contain expected output

Parameters
string $expected

Expected output

string $message optional

Failure message

Returns
void

assertOutputRegExp() ¶ public

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

Asserts stdout contains expected regexp

Parameters
string $pattern

Expected pattern

string $message optional

Failure message

Returns
void

cleanupConsoleTrait() ¶ public

cleanupConsoleTrait(): void

Cleans state to get ready for the next test

Returns
void

commandStringToArgs() ¶ protected

commandStringToArgs(string $command): array

Creates an $argv array from a command string

Parameters
string $command

Command string

Returns
array

exec() ¶ public

exec(string $command, array $input = []): void

Runs cli integration test

Parameters
string $command

Command to run

array $input optional

Input values to pass to an interactive shell

Returns
void

makeRunner() ¶ protected

makeRunner(): CommandRunner|LegacyCommandRunner

Builds the appropriate command dispatcher

Returns
CommandRunner|LegacyCommandRunner

useCommandRunner() ¶ public

useCommandRunner(): void

Set this test case to use the CommandRunner rather than the legacy ShellDispatcher

Returns
void

Property Detail

$_err ¶ protected

Console error output stub

Type
Cake\TestSuite\Stub\ConsoleOutput|PHPUnit_Framework_MockObject_MockObject|null

$_exitCode ¶ protected

Last exit code

Type
int|null

$_in ¶ protected

Console input mock

Type
Cake\Console\ConsoleInput|PHPUnit_Framework_MockObject_MockObject|null

$_out ¶ protected

Console output stub

Type
Cake\TestSuite\Stub\ConsoleOutput|PHPUnit_Framework_MockObject_MockObject|null

$_useCommandRunner ¶ protected

Whether or not to use the CommandRunner

Type
bool
OpenHub
Pingping
Linode
  • Business Solutions
  • Showcase
  • Documentation
  • Book
  • API
  • Videos
  • Reporting Security Issues
  • Privacy Policy
  • Logos & Trademarks
  • Community
  • Get Involved
  • Issues (Github)
  • Bakery
  • Featured Resources
  • Training
  • Meetups
  • My CakePHP
  • CakeFest
  • Newsletter
  • Linkedin
  • YouTube
  • Facebook
  • Twitter
  • Mastodon
  • Help & Support
  • Forum
  • Stack Overflow
  • IRC
  • Slack
  • Paid Support

Generated using CakePHP API Docs