Skip to content

Commit 08ecc6b

Browse files
Merge branch '11.5' into 12.1
2 parents 65ef243 + 655cecc commit 08ecc6b

File tree

1 file changed

+50
-0
lines changed

1 file changed

+50
-0
lines changed

src/textui.rst

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,24 @@ Errors tend to be easier to fix than failures. If you have a big list of problem
4242
best to tackle the errors first and see if you have any failures left when they are all
4343
fixed.
4444

45+
Output
46+
======
47+
48+
The default output of PHPUnit's test runner consists of up to four sections.
49+
50+
Versions and Configuration
51+
--------------------------
52+
53+
This section contains information about the PHPUnit version, PHP version, and PHPUnit's XML
54+
configuration file.
55+
56+
This section can be disabled using the ``--no-output`` CLI option.
57+
58+
Progress
59+
--------
60+
61+
This section is printed to indicate progress while the tests are being run:
62+
4563
For each test run, the PHPUnit command-line tool prints one character to
4664
indicate progress:
4765

@@ -81,6 +99,38 @@ indicate progress:
8199

82100
Printed when the test was skipped (see :ref:`writing-tests-for-phpunit.skipping-tests`)
83101

102+
This section can be disabled using the ``--no-progress`` and ``--no-output`` CLI options.
103+
104+
Test Results
105+
------------
106+
107+
This section contains information about errors, failures, skipped tests,
108+
incomplete tests, and issues. By default, only information about errors and failures
109+
is printed.
110+
111+
This section is only printed when there are errors, failures, or issues to report.
112+
It can be disabled using the ``--no-results`` and ``--no-output`` CLI options.
113+
114+
Summary
115+
-------
116+
117+
This section contains a summary of the test suite execution.
118+
119+
- When no test errored or failed then the summary will be ``OK``
120+
- When a test errored then the summary will be ``ERRORED!``
121+
- When a test failed and no test errored then the summary will be ``FAILED!``
122+
- When there were no errors, failures, or issues, but a test was skipped, then the summary will be ``OK, but some tests were skipped!``
123+
- When there were no errors, failures, skipped tests, or issues then the summary will be ``OK, but there were issues!``
124+
125+
.. admonition:: ``--fail-on-*``
126+
127+
Please note that if you use CLI options such as ``--fail-on-deprecation``, for example,
128+
or their XML configuration counterparts, then this only affects the test runner's shell
129+
exit code. It does not have an effect on whether or not ``OK`` will be printed in the
130+
output's summary section.
131+
132+
This section can be disabled using the ``--no-output`` CLI option.
133+
84134
.. _textui.command-line-options:
85135

86136
Command-Line Options

0 commit comments

Comments
 (0)