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 basic unit testing #49

Merged
merged 36 commits into from
Jan 22, 2024
Merged

Add basic unit testing #49

merged 36 commits into from
Jan 22, 2024

Conversation

joshuabmoore
Copy link
Collaborator

  1. I've added a GitHub workflows folder with a Git Actions .yaml which will create a virtual Linux environment in which to test pyspi via. pytest unit tests. The tests currently run in a an Ubuntu environment with python 3.8. Caching of the pip dependencies was also used to speed up testing. Some minor changes were made to the dependencies pulled from the requirements.txt file to overcome the commonly encountered pandas issue on Linux. In particular, we modify the pandas and numpy versions to 1.3.3 and 1.22.0, respectively. The motivation here was to find a workaround without having to modify the original requirements.txt file which may have unintended ramifications for Windows/Mac users. This seems to resolves the pandas error for Linux systems.
  2. Added a standard normal dataset to the 'data' folder in preparation for SPI unit testing (next step).
  3. A tests folder which will contain all of the unit test code, including unit basic unit tests for the calculator and data objects (e.g., does instantiate?). Next step will be to incorporate SPI unit tests, however this may require a bit more nuance (particularly with stochastic SPIs/inconsistent outputs, skipping tests for SPIs that don't compute for whatever reason, etc).

@joshuabmoore joshuabmoore merged commit fd73dc6 into main Jan 22, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant