Skip to content

docs: document that unit tests require TEST_SNYK_TOKEN #7062

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

Open
rrama wants to merge 1 commit into
base: main
Choose a base branch
from
+11 −2
Open

docs: document that unit tests require TEST_SNYK_TOKEN #7062

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 4 additions & 2 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,8 +178,8 @@ The CLI follows a layered testing pyramid. Each layer has a different goal, syst
## Running Tests

```sh
# TypeScript unit tests
npm run test:unit
# TypeScript unit tests (some suites validate credentials, so a token is required)
TEST_SNYK_TOKEN=<token> npm run test:unit

@rrama rrama Aug 3, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The docs do not instruct the agent that they need to build the CLI before they can run the tests. My agent didn't notice as it built the CLI first anyway, but would it be worth adding this requirement as well?


# TypeScript acceptance tests (requires a built binary)
TEST_SNYK_COMMAND=./binary-releases/snyk-macos-arm64 npm run test:acceptance
Expand All @@ -191,6 +191,8 @@ cd cliv2 && make test
npx jest --runInBand test/jest/unit/path/to/test.spec.ts
```

`SNYK_TOKEN` is **not** an alternative to `TEST_SNYK_TOKEN` — `test/setup.js` removes `SNYK_TOKEN` (and `SNYK_API_KEY`) from the environment when either is set, and writes `TEST_SNYK_TOKEN` into the CLI user config so tests run against a known configuration.

## Running the CLI Locally

```sh
Expand Down
7 changes: 7 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,13 @@ Avoid using mocks as these can go out of sync and be challenging to maintain; pr
If you are mostly testing functions calling other functions, consider writing an acceptance test instead. Otherwise,
your tests will likely mirror the implementation and rely heavily on mocks; making future changes difficult.

Despite the above, `npm run test:unit` currently needs `TEST_SNYK_TOKEN` set to a
[valid API token](https://docs.snyk.io/snyk-api/authentication-for-api). A handful of suites drive command entry points
that validate credentials before doing anything else, so without it they fail with `MissingApiTokenError`. Note that
setting `SNYK_TOKEN` does not work: [`test/setup.js`](./test/setup.js) removes `SNYK_TOKEN` (and `SNYK_API_KEY`) from the
environment when either is set, and separately writes `TEST_SNYK_TOKEN` into the CLI user config so tests run against a
known configuration rather than whatever the developer happens to be authenticated as.

### Acceptance tests

Acceptance tests enforce the correctness of our distribution and are written from the perspective of a user.
Expand Down