Skip to content

Commit

Permalink
update DEVELOPING.md with snapshot update instructions
Browse files Browse the repository at this point in the history
Signed-off-by: Will Murphy <will.murphy@anchore.com>
  • Loading branch information
willmurphyscode committed Oct 18, 2023
1 parent bfa22e1 commit 055ae95
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions DEVELOPING.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,22 @@ pip uninstall vunnel #... if you already have vunnel installed in this virtual
pip install -e .
```

### Snapshot Tests

In order to ensure that the same feed state from providers would make the same
set of vulnerabilities, snapshot testing is used.

Snapshot tests are run as part of ordinary unit tests, and will run during
`make unit`.

To update snapshots, run the following pytest command. (Note that this example
is for the debian provider, and the test name and path will be different for
other providers):

``` sh
pytest ./tests/unit/providers/debian/test_debian.py -k test_provider_via_snapshot --snapshot-update
```

## Architecture

Vunnel is a CLI tool that downloads and processes vulnerability data from various sources (in the codebase, these are called "providers").
Expand Down

0 comments on commit 055ae95

Please sign in to comment.