Skip to content
This repository was archived by the owner on Dec 4, 2024. It is now read-only.

Commit 4a7ccec

Browse files
committed
Add a quickstart section to the readme.
1 parent 8528b05 commit 4a7ccec

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

devenv/integration/README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,37 @@ logs from the first failed container. You must stop the nodes with
3737
dangling container and re-execute tests once you have fixed and rebuilt the
3838
testbed image.
3939

40+
## QuickStart
41+
42+
1. Build the testbed image that has the source and binaries to execute the integration tests.
43+
2. Run the testing script.
44+
45+
```bash
46+
> devenv$ cd integration
47+
> devenv/integration$ ./bin/build
48+
> cd -
49+
> devenv$ ./integration/bin/test
50+
```
51+
52+
You will see lines like below if your tests completed succesfully.
53+
54+
```
55+
Runner: 71c1beca7261e2c1b706fa0e9eeb3823ad56977c4846c89b25a315a48a1bbda5 exited with err_no: 0
56+
Runner: fb2da5362115b5ae37874d39831bbf249b2928c58296dfb23af94b7083d8455b exited with err_no: 0
57+
```
58+
59+
Use the container id to inspect the runner for more details.
60+
61+
```
62+
> devenv$ ./logs.sh 71c1beca7261e2c1b706fa0e9eeb3823ad56977c4846c89b25a315a48a1bbda5
63+
```
64+
65+
the script will abort the moment a container fails. The script will print the
66+
logs from the first failed container. You will need to stop the nodes yourself
67+
with `docker stop $(docker ps -qa)`. You can also run `test` again to down and
68+
up again any dangling container and reexecute tests once you have fixed and
69+
rebuilt the testbed image.
70+
4071
### Running integration tests.
4172

4273
Start at devenv, `pushd` integration. You will find scripts in the `bin` folder

0 commit comments

Comments
 (0)