Skip to content

Commit

Permalink
docs: how to record test fixtures
Browse files Browse the repository at this point in the history
  • Loading branch information
gouline committed Oct 12, 2024
1 parent 6728dab commit 4ff90aa
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,16 @@ Once you are finished, stop the sandbox:
make sandbox-down
```

#### Recording

Whenever tests require updating Metabase API fixtures, you need to "record" them from the running sandbox instance by executing:

```
RECORD=true make test
```

This will run tests against the actual Metabase instance, instead of fixtures, and write those responses to new fixtures. **Many tests will likely fail**, because of timestamps and other transient data, so you need to manually fix those assertions.

## Code of Conduct

All contributors are expected to follow the [PSF Code of Conduct](https://www.python.org/psf/conduct/).
Expand Down

0 comments on commit 4ff90aa

Please sign in to comment.