File: output-cli-usage.txt

package info (click to toggle)
phpunit 12.3.5-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 50,160 kB
  • sloc: php: 101,772; xml: 2,084; makefile: 124; sh: 99
file content (158 lines) | stat: -rw-r--r-- 11,053 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
PHPUnit %s by Sebastian Bergmann and contributors.

Usage:
  phpunit [options] <directory|file> ...

Configuration:

  --bootstrap <file>                   A PHP script that is included before the tests run
  -c|--configuration <file>            Read configuration from XML file
  --no-configuration                   Ignore default configuration file (phpunit.xml)
  --extension <class>                  Register test runner extension with bootstrap <class>
  --no-extensions                      Do not register test runner extensions
  --include-path <path(s)>             Prepend PHP's include_path with given path(s)
  -d <key[=value]>                     Sets a php.ini value
  --cache-directory <dir>              Specify cache directory
  --generate-configuration             Generate configuration file with suggested settings
  --migrate-configuration              Migrate configuration file to current format
  --generate-baseline <file>           Generate baseline for issues
  --use-baseline <file>                Use baseline to ignore issues
  --ignore-baseline                    Do not use baseline to ignore issues

Selection:

  --list-suites                        List available test suites
  --testsuite <name>                   Only run tests from the specified test suite(s)
  --exclude-testsuite <name>           Exclude tests from the specified test suite(s)
  --list-groups                        List available test groups
  --group <name>                       Only run tests from the specified group(s)
  --exclude-group <name>               Exclude tests from the specified group(s)
  --covers <name>                      Only run tests that intend to cover <name>
  --uses <name>                        Only run tests that intend to use <name>
  --requires-php-extension <name>      Only run tests that require PHP extension <name>
  --list-test-files                    List available test files
  --list-tests                         List available tests
  --list-tests-xml <file>              List available tests in XML format
  --filter <pattern>                   Filter which tests to run
  --exclude-filter <pattern>           Exclude tests for the specified filter pattern
  --test-suffix <suffixes>             Only search for test in files with specified suffix(es). Default: Test.php,.phpt

Execution:

  --process-isolation                  Run each test in a separate PHP process
  --globals-backup                     Backup and restore $GLOBALS for each test
  --static-backup                      Backup and restore static properties for each test

  --strict-coverage                    Be strict about code coverage metadata
  --strict-global-state                Be strict about changes to global state
  --disallow-test-output               Be strict about output during tests
  --enforce-time-limit                 Enforce time limit based on test size
  --default-time-limit <sec>           Timeout in seconds for tests that have no declared size
  --do-not-report-useless-tests        Do not report tests that do not test anything

  --stop-on-defect                     Stop after first error, failure, warning, or risky test
  --stop-on-error                      Stop after first error
  --stop-on-failure                    Stop after first failure
  --stop-on-warning                    Stop after first warning
  --stop-on-risky                      Stop after first risky test
  --stop-on-deprecation                Stop after first test that triggered a deprecation
  --stop-on-notice                     Stop after first test that triggered a notice
  --stop-on-skipped                    Stop after first skipped test
  --stop-on-incomplete                 Stop after first incomplete test

  --fail-on-empty-test-suite           Signal failure using shell exit code when no tests were run
  --fail-on-warning                    Signal failure using shell exit code when a warning was triggered
  --fail-on-risky                      Signal failure using shell exit code when a test was considered risky
  --fail-on-deprecation                Signal failure using shell exit code when a deprecation was triggered
  --fail-on-phpunit-deprecation        Signal failure using shell exit code when a PHPUnit deprecation was triggered
  --fail-on-phpunit-notice             Signal failure using shell exit code when a PHPUnit notice was triggered
  --fail-on-phpunit-warning            Signal failure using shell exit code when a PHPUnit warning was triggered
  --fail-on-notice                     Signal failure using shell exit code when a notice was triggered
  --fail-on-skipped                    Signal failure using shell exit code when a test was skipped
  --fail-on-incomplete                 Signal failure using shell exit code when a test was marked incomplete
  --fail-on-all-issues                 Signal failure using shell exit code when an issue is triggered

  --do-not-fail-on-empty-test-suite    Do not signal failure using shell exit code when no tests were run
  --do-not-fail-on-warning             Do not signal failure using shell exit code when a warning was triggered
  --do-not-fail-on-risky               Do not signal failure using shell exit code when a test was considered risky
  --do-not-fail-on-deprecation         Do not signal failure using shell exit code when a deprecation was triggered
  --do-not-fail-on-phpunit-deprecation Do not signal failure using shell exit code when a PHPUnit deprecation was triggered
  --do-not-fail-on-phpunit-notice      Do not signal failure using shell exit code when a PHPUnit notice was triggered
  --do-not-fail-on-phpunit-warning     Do not signal failure using shell exit code when a PHPUnit warning was triggered
  --do-not-fail-on-notice              Do not signal failure using shell exit code when a notice was triggered
  --do-not-fail-on-skipped             Do not signal failure using shell exit code when a test was skipped
  --do-not-fail-on-incomplete          Do not signal failure using shell exit code when a test was marked incomplete

  --cache-result                       Write test results to cache file
  --do-not-cache-result                Do not write test results to cache file

  --order-by <order>                   Run tests in order: default|defects|depends|duration|no-depends|random|reverse|size
  --random-order-seed <N>              Use the specified random seed when running tests in random order

Reporting:

  --colors <flag>                      Use colors in output ("never", "auto" or "always")
  --columns <n>                        Number of columns to use for progress output
  --columns max                        Use maximum number of columns for progress output
  --stderr                             Write to STDERR instead of STDOUT

  --no-progress                        Disable output of test execution progress
  --no-results                         Disable output of test results
  --no-output                          Disable all output

  --display-incomplete                 Display details for incomplete tests
  --display-skipped                    Display details for skipped tests
  --display-deprecations               Display details for deprecations triggered by tests
  --display-phpunit-deprecations       Display details for PHPUnit deprecations
  --display-phpunit-notices            Display details for PHPUnit notices
  --display-errors                     Display details for errors triggered by tests
  --display-notices                    Display details for notices triggered by tests
  --display-warnings                   Display details for warnings triggered by tests
  --display-all-issues                 Display details for all issues that are triggered
  --reverse-list                       Print defects in reverse order

  --teamcity                           Replace default progress and result output with TeamCity format
  --testdox                            Replace default result output with TestDox format
  --testdox-summary                    Repeat TestDox output for tests with errors, failures, or issues

  --debug                              Replace default progress and result output with debugging information
  --with-telemetry                     Include telemetry information in debugging information output

Logging:

  --log-junit <file>                   Write test results in JUnit XML format to file
  --log-otr <file>                     Write test results in Open Test Reporting XML format to file
  --include-git-information            Include Git information in Open Test Reporting XML logfile
  --log-teamcity <file>                Write test results in TeamCity format to file
  --testdox-html <file>                Write test results in TestDox format (HTML) to file
  --testdox-text <file>                Write test results in TestDox format (plain text) to file
  --log-events-text <file>             Stream events as plain text to file
  --log-events-verbose-text <file>     Stream events as plain text with extended information to file
  --no-logging                         Ignore logging configured in the XML configuration file

Code Coverage:

  --coverage-clover <file>             Write code coverage report in Clover XML format to file
  --coverage-openclover <file>         Write code coverage report in OpenClover XML format to file
  --coverage-cobertura <file>          Write code coverage report in Cobertura XML format to file
  --coverage-crap4j <file>             Write code coverage report in Crap4J XML format to file
  --coverage-html <dir>                Write code coverage report in HTML format to directory
  --coverage-php <file>                Write serialized code coverage data to file
  --coverage-text=<file>               Write code coverage report in text format to file [default: standard output]
  --only-summary-for-coverage-text     Option for code coverage report in text format: only show summary
  --show-uncovered-for-coverage-text   Option for code coverage report in text format: show uncovered files
  --coverage-xml <dir>                 Write code coverage report in XML format to directory
  --warm-coverage-cache                Warm static analysis cache
  --coverage-filter <dir>              Include <dir> in code coverage reporting
  --path-coverage                      Report path coverage in addition to line coverage
  --disable-coverage-ignore            Disable metadata for ignoring code coverage
  --no-coverage                        Ignore code coverage reporting configured in the XML configuration file

Miscellaneous:

  -h|--help                            Prints this usage information
  --version                            Prints the version and exits
  --atleast-version <min>              Checks that version is greater than <min> and exits
  --check-version                      Checks whether PHPUnit is the latest version and exits
  --check-php-configuration            Checks whether PHP configuration follows best practices