search

meedan / check

Development environment for Meedan Check, a collaborative media annotation platform
https://meedan.com/check
MIT License
127 stars 53 forks source link

Update testing documentation for Check API and Pender #78

Closed hartsick closed 1 year ago

hartsick commented 1 year ago

This updates the Check documentation to make it clearer how to run Check API and Pender tests without spinning up a separate test container. Would love a read through to see if this is clear and makes sense!

Related thought: We may want to add documentation about integration tests (or links to our confluence pages), but that seemed out of scope for this PR. I think we need additional work to support running them locally with these changes, but it's hard for me to test since I can't run integration tests locally.

amoedoamorim commented 1 year ago

This is awesome! Thank you Christa! I didn't know until yesterday that we could run check-api unit tests in dev mode without messing with the dev DB!

hartsick commented 1 year ago

This is awesome! Thank you Christa! I didn't know until yesterday that we could run check-api unit tests in dev mode without messing with the dev DB!

@amoedoamorim one thing to note is that these instructions are just for unit / Check API- or Pender-only tests. I'm not 100% sure how the changes I had made to make this happen will impact running integration tests locally. I think we should just run integration tests locally as we previously did (spinning up everything in test mode) and it will not drop development data, but I haven't been about to double check since I can't run integration tests on my machine.