Skip to content
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.

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

Add README for tests #45

Merged
merged 1 commit into from
Sep 23, 2021
Merged
Changes from all commits
Commits
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
11 changes: 11 additions & 0 deletions tests/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Testing

These tests use the Simyan requests caching for mocking tests, so tests will
run quickly and not require credentials.

If your code adds a new URL to the cache, set the `COMICVINE_API_KEY` environment variable
before running the test and it will be populated in the `Simyan-Cache.sqlite` database.

At any point you should be able to delete the database, set any creditials, and
run the full test suite to repopulate it (though some of the results might be
diffent if any of the data has changed at Comic Vine).