Add README for tests (#45)

Metron-Project · Sep 23, 2021 · e73788e · e73788e
1 parent 5e1a0d2
commit e73788e
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/tests/README.md b/tests/README.md
@@ -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).