Skip to content

Commit

Permalink
Document integration tests
Browse files Browse the repository at this point in the history
Signed-off-by: Pablo Chacin <[email protected]>
  • Loading branch information
pablochacin committed Aug 29, 2023
1 parent b848926 commit fb6d1f5
Showing 1 changed file with 10 additions and 9 deletions.
19 changes: 10 additions & 9 deletions docs/01-development/01-contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,16 @@ $ git clone https://github.com/grafana/xk6-disruptor.git
$ cd xk6-disruptor
```

### Makefile

Most of the development tasks can be executed using `make` targets:
* `agent-image`: builds the `xk6-disruptor-agent` image locally
* `build`: builds k6 with the `xk6-disruptor` extension
* `clean`: removes local build and other work directories
* `e2e`: executes the end-to-end tests. These tests can take several minutes.
* `test`: executes unit tests
* `lint`: runs the linter
## Integration tests

Integration tests are implemented in the same packages than the component they test. Execution is conditioned using the `integration` build tag.

In order to run integration tests (if any) for a package, use the following command:

```sh
go test -tags integration ./path/to/package/...
```


### Extension/agent image versions dependencies

Expand Down

0 comments on commit fb6d1f5

Please sign in to comment.