Skip to content

Commit ab2eb93

Browse files
authored
Update README to reference t.sh and tn.sh (#8463)
1 parent 529776e commit ab2eb93

File tree

1 file changed

+16
-9
lines changed

1 file changed

+16
-9
lines changed

README.md

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -112,43 +112,44 @@ docker compose up
112112
To run our standard battery of tests (lints, unit, integration):
113113

114114
```shell
115-
docker compose run --use-aliases boulder ./test.sh
115+
./t.sh
116116
```
117117

118118
To run all unit tests:
119119

120120
```shell
121-
docker compose run --use-aliases boulder ./test.sh --unit
121+
./t.sh -u
122122
```
123123

124124
To run specific unit tests (example is of the ./va directory):
125125

126126
```shell
127-
docker compose run --use-aliases boulder ./test.sh --unit --filter=./va
127+
./t.sh -u -p ./va
128128
```
129129

130130
To run all integration tests:
131131

132132
```shell
133-
docker compose run --use-aliases boulder ./test.sh --integration
133+
./t.sh -i
134134
```
135135

136136
To run unit tests and integration tests with coverage:
137137

138138
```shell
139-
docker compose run --use-aliases boulder ./test.sh --unit --integration --coverage --coverage-dir=./test/coverage/mytestrun
139+
./t.sh -ui -c --coverage-dir=./test/coverage/mytestrun
140140
```
141141

142142
To run specific integration tests (example runs TestGenerateValidity and TestWFECORS):
143143

144144
```shell
145-
docker compose run --use-aliases boulder ./test.sh --filter TestGenerateValidity/TestWFECORS
145+
./t.sh -i -f TestGenerateValidity/TestWFECORS
146146
```
147147

148-
To get a list of available integration tests:
148+
To do any of the above, but using the "config-next" configuration, which
149+
represents a likely future state (e.g. including new feature flags):
149150

150151
```shell
151-
docker compose run --use-aliases boulder ./test.sh --list-integration-tests
152+
./tn.sh -your -options -here
152153
```
153154

154155
The configuration in docker-compose.yml mounts your boulder checkout at
@@ -186,7 +187,13 @@ docker compose run --use-aliases -e FAKE_DNS=172.17.0.1 --service-ports boulder
186187

187188
Running tests without the `./test.sh` wrapper:
188189

189-
Run all unit tests
190+
Run unit tests locally, without docker (only works for some directories):
191+
192+
```shell
193+
go test ./issuance/...
194+
```
195+
196+
Run all unit tests:
190197

191198
```shell
192199
docker compose run --use-aliases boulder go test -p 1 ./...

0 commit comments

Comments
 (0)