MockInputOutput

MockInputOutput provides an easy way to write tests for commands that require user input, such as CLI::prompt(), CLI::wait(), and CLI::input().

You can replace the InputOutput class with MockInputOutput during test execution to capture inputs and outputs.

.. note:: When you use MockInputOutput, you don't need to use :ref:stream-filter-trait, :ref:ci-test-stream-filter, and :ref:php-stream-wrapper.

Helper Methods

getOutput(?int $index = null): string ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Gets the output.

If you call it like $io->getOutput(), it returns the whole output string.
If you specify 0 or a positive number, it returns the output array item. Each item has the output of a CLI::fwrite() call.
If you specify a negative number -n, it returns the last n-th item of the output array.

getOutputs(): array ^^^^^^^^^^^^^^^^^^^

Returns the output array. Each item has the output of a CLI::fwrite() call.

How to Use

CLI::setInputOutput() can set the MockInputOutput instance to the CLI class.
CLI::resetInputOutput() resets the InputOutput instance in the CLI class.
MockInputOutput::setInputs() sets the user input array.
MockInputOutput::getOutput() gets the command output.

The following test code is to test the command spark db:table:

.. literalinclude:: cli/001.php

Without MockInputOutput

.. _testing-cli-output:

Testing CLI Output

.. _stream-filter-trait:

StreamFilterTrait

.. versionadded:: 4.3.0

StreamFilterTrait provides an alternate to these helper methods.

You may need to test things that are difficult to test. Sometimes, capturing a stream, like PHP's own STDOUT, or STDERR, might be helpful. The StreamFilterTrait helps you capture the output from the stream of your choice.

How to Use ^^^^^^^^^^

StreamFilterTrait::getStreamFilterBuffer() gets the captured data from the buffer.
StreamFilterTrait::resetStreamFilterBuffer() resets captured data.

An example demonstrating this inside one of your test cases:

.. literalinclude:: overview/018.php

The StreamFilterTrait has a configurator that is called automatically. See :ref:Testing Traits <testing-overview-traits>.

If you override the setUp() or tearDown() methods in your test, then you must call the parent::setUp() and parent::tearDown() methods respectively to configure the StreamFilterTrait.

.. _ci-test-stream-filter:

CITestStreamFilter

CITestStreamFilter for manual/single use.

If you need to capture streams in only one test, then instead of using the StreamFilterTrait trait, you can manually add a filter to streams.

How to Use ^^^^^^^^^^

CITestStreamFilter::registration() Filter registration.
CITestStreamFilter::addOutputFilter() Adding a filter to the output stream.
CITestStreamFilter::addErrorFilter() Adding a filter to the error stream.
CITestStreamFilter::removeOutputFilter() Removing a filter from the output stream.
CITestStreamFilter::removeErrorFilter() Removing a filter from the error stream.

.. literalinclude:: overview/020.php

.. _testing-cli-input:

Testing CLI Input

.. _php-stream-wrapper:

PhpStreamWrapper

.. versionadded:: 4.3.0

PhpStreamWrapper provides a way to write tests for methods that require user input, such as CLI::prompt(), CLI::wait(), and CLI::input().

.. note:: The PhpStreamWrapper is a stream wrapper class. If you don't know PHP's stream wrapper, see The streamWrapper class <https://www.php.net/manual/en/class.streamwrapper.php>_ in the PHP maual.

How to Use ^^^^^^^^^^

PhpStreamWrapper::register() Register the PhpStreamWrapper to the php protocol.
PhpStreamWrapper::restore() Restore the php protocol wrapper back to the PHP built-in wrapper.
PhpStreamWrapper::setContent() Set the input data.

.. important:: The PhpStreamWrapper is intended for only testing php://stdin. But when you register it, it handles all the php protocol <https://www.php.net/manual/en/wrappers.php.php>_ streams, such as php://stdout, php://stderr, php://memory. So it is strongly recommended that PhpStreamWrapper be registered/unregistered only when needed. Otherwise, it will interfere with other built-in php streams while registered.

An example demonstrating this inside one of your test cases:

.. literalinclude:: overview/019.php