You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: Fix "Bring your own toolbox" in DEVELOPING.md (vectordotdev#18014)
There were a couple of small things I ran into while getting my
development environment working, and I thought I'd update the docs to
reflect them:
- `cargo-nextest` is neede for some of the `make` targets
- `SCOPE` needs to be capitalised when running tests, or it is silently
ignored
Copy file name to clipboardExpand all lines: docs/DEVELOPING.md
+5-4Lines changed: 5 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -121,6 +121,7 @@ To build Vector on your own host will require a fairly complete development envi
121
121
Loosely, you'll need the following:
122
122
123
123
-**To build Vector:** Have working Rustup, Protobuf tools, C++/C build tools (LLVM, GCC, or MSVC), Python, and Perl, `make` (the GNU one preferably), `bash`, `cmake`, `GNU coreutils`, and `autotools`.
124
+
-**To run `make test`:** Install [`cargo-nextest`](https://nexte.st/)
124
125
-**To run integration tests:** Have `docker` available, or a real live version of that service. (Use `AUTOSPAWN=false`)
125
126
-**To run `make check-component-features`:** Have `remarshal` installed.
126
127
-**To run `make check-licenses` or `cargo vdev build licenses`:** Have `rust-license-tool`[installed](https://github.com/DataDog/rust-license-tool).
@@ -141,19 +142,19 @@ cargo build
141
142
make build-dev
142
143
# Validate your test pass
143
144
cargo test sources::example
144
-
make testscope="sources::example"
145
+
make testSCOPE="sources::example"
145
146
# Validate tests (that do not require other services) pass
146
147
cargo test
147
148
make test
148
149
# Validate your tests pass (starting required services in Docker)
149
-
make test-integration scope="sources::example"
150
+
make test-integration SCOPE="sources::example"
150
151
# Validate your tests pass against a live service.
151
-
make test-integration scope="sources::example" autospawn=false
152
+
make test-integration SCOPE="sources::example" autospawn=false
152
153
cargo test --features docker sources::example
153
154
# Validate all tests pass (starting required services in Docker)
0 commit comments