Skip to content

docs: explain how to run tests locally #17783

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
DominicBurkart merged 3 commits into from
Jun 28, 2023
Merged

docs: explain how to run tests locally #17783

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8390861
explain how to run tests locally
DominicBurkart Jun 28, 2023
63dba5f
indicate you need a containerized environment to run integration tests
DominicBurkart Jun 28, 2023
40671df
harmonize docs
DominicBurkart Jun 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ Vector team member will find this document useful.
- [Daily tests](#daily-tests)
- [Flakey tests](#flakey-tests)
- [Test harness](#test-harness)
- [Running Tests Locally](#running-tests-locally)
- [Deprecations](#deprecations)
- [Dependencies](#dependencies)
- [Next steps](#next-steps)
Expand Down Expand Up @@ -210,6 +211,17 @@ any pull request with:
/test -t <name>
```

### Running Tests Locally

To run tests locally, use [cargo vdev](https://github.com/vectordotdev/vector/blob/master/vdev/README.md).

Unit tests can be run by calling `cargo vdev test`.

Integration tests are not run by default when running
`cargo vdev test`. Instead, they are accessible via the integration subcommand (example:
`cargo vdev int test aws` runs aws-related integration tests). You can find the list of available integration tests using `cargo vdev int show`. Integration tests require docker or podman to run.


### Deprecations

When deprecating functionality in Vector, see [DEPRECATION.md](DEPRECATION.md).
Expand Down
8 changes: 8 additions & 0 deletions vdev/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Table of Contents:
- [Repository](#repository)
- [Starship](#starship)
- [CLI](#cli)
- [Running Tests](#running-tests)

## Installation

Expand Down Expand Up @@ -65,3 +66,10 @@ when = true
The CLI uses [Clap](https://github.com/clap-rs/clap) with the `derive` construction mechanism and is stored in the [commands](src/commands) directory.

Every command group/namespace has its own directory with a `cli` module, including the root `vdev` command group. All commands have an `exec` method that provides the actual implementation, which in the case of command groups will be calling sub-commands.


## Running Tests

Unit tests can be run by calling `cargo vdev test`.

Integration tests are not run by default when running`cargo vdev test`. Instead, they are accessible via the integration subcommand (example: `cargo vdev int test aws` runs aws-related integration tests). You can find the list of available integration tests using `cargo vdev int show`. Integration tests require docker or podman to run.