drift-org / backend

2 stars 0 forks source link

Feat/#18 - unit tests #31

Closed brandonLi8 closed 3 years ago

brandonLi8 commented 3 years ago

Contributors

@brandonLi8

Relevant issue

Closes #18 (issue)

Summary of change

Setup unit testing framework (make test)
Added helpers for unit testing (most importantly TestWithMongo)
Added wiki page: https://github.com/drift-org/backend/wiki/Testing
Added sample unit test for authController.Register (other unit tests to be added in separate issues later)
Added unit tests to our CI

Testing/Verification

Ran make test
CI should work in this PR

brandonLi8 commented 3 years ago

@anjanbharadwaj

Just as an aside, the tests are currently being stored in the same folder as our source code because of ginkgo bootstrap/generate I assume, do we want to keep this or would we rather separate our tests into a different subdirectory (not sure if it hinders ginkgo)? Can be a decision for a future PR as well, but something to think about.

This was something that I looked into, as I prefer putting tests in parallel (what i normally do for node). Actually, the standard is to put the tests in the SAME directory for golang. See https://stackoverflow.com/a/19201272, and https://www.reddit.com/r/golang/comments/as53js/all_tests_in_a_single_package/, and we should abide by this.