Skip to content

Commit 2a4b52f

Browse files
committed
Update readme
1 parent 317f389 commit 2a4b52f

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,8 @@ Showing the top 5 slowest tests:
4343

4444
Default options are:
4545

46-
- rows: `5`
46+
- rows: `5` (Report 5 tests max)
47+
- min: `200` (Report tests slower than 200ms)
4748

4849
### Csv
4950

@@ -55,8 +56,9 @@ Write the tests in a CSV file ready for import.
5556

5657
Default options are:
5758

58-
- rows: `null` (all the tests)
5959
- file: `phpunit_results.csv`
60+
- rows: `null` (all the tests)
61+
- min: `200`
6062

6163
### Json
6264

@@ -68,8 +70,9 @@ Write the tests in a JSON file ready for import.
6870

6971
Default options are:
7072

71-
- rows: `null` (all the tests)
7273
- file: `phpunit_results.json`
74+
- rows: `null` (all the tests)
75+
- min: `200`
7376

7477
### MySQL
7578

@@ -81,12 +84,13 @@ Store the test name and the time into a MySQL database. It will override existin
8184

8285
Default credentials are (as array):
8386

84-
- rows: `null` (all the tests)
8587
- database: `phpunit_results`
8688
- table: `default`
8789
- username: `root`
8890
- password: ``
8991
- host: `127.0.0.1`
92+
- rows: `null` (all the tests)
93+
- min: `200`
9094

9195
### SQLite
9296

@@ -98,9 +102,10 @@ Store the test name and the time into a SQLite database. It will override existi
98102

99103
Default credentials are (as array):
100104

101-
- rows: `null` (all the tests)
102105
- database: `phpunit_results.db`
103106
- table: `default`
107+
- rows: `null` (all the tests)
108+
- min: `200`
104109

105110
## Arguments
106111

@@ -109,17 +114,18 @@ To override the default configuration per extension, you need to use `<arguments
109114
```xml
110115
<extension class="Lloople\PHPUnitExtensions\Runners\SlowestTests\Json">
111116
<arguments>
112-
<integer>10</integer>
113117
<string>phpunit_results_as_json.json</string>
118+
<integer>10</integer> <!-- Max number of tests to report. -->
119+
<integer>400</integer> <!-- Min miliseconds to report a test. -->
114120
</arguments>
115121
</extension>
116122
```
117123

118124
In the case of the MySQL and SQLite, which needs a database connection, configuration goes as array
119125

126+
```xml
120127
<extension class="Lloople\PHPUnitExtensions\Runners\SlowestTests\MySQL">
121128
<arguments>
122-
<null/> <!-- This allows you to log all the tests -->
123129
<array>
124130
<element key="database">
125131
<string>my_phpunit_results</string>

0 commit comments

Comments
 (0)