hw3-tester

Tests for CS540 Spring 2021 HW3: Principal Component Analysis

Usage

Download test.py and move it into the directory that contains pca.py and YaleB_32x32.npy

The contents of your directory should look like this:

$ tree
.
├── YaleB_32x32.npy
├── pca.py
└── test.py

To run the tests, do

$ python3 test.py

It is assumed that YaleB_32x32.npy is present in the same directory as test.py and pca.py. If this is not the case, you can use the argument --yale-path like this:

$ python3 test.py --yale-path path/to/YaleB_32x32.npy

Ideally, you should be running test.py using your terminal as this README describes. If you have an issue, first try running it that way. However, provided that test.py, pca.py, and YaleB_32x32.npy are all in the same directory, it should work if you do %run test.py in Jupyter, or run it the same way you would run pca.py in your editor (VS Code, Pycharm, Sublime, etc).

Testing with GitHub Actions

Background: GitHub Actions is a CI/CD pipeline tool. If you are unfamiliar with CI/CD, it is a great process to familiarize yourself with as it is used almost everywhere in industry. It is a great buzzword for interviews. For this class, the CI portion of the pipeline automatically runs test.py any time you push changes to GitHub. You will get an email from GitHub if any of the unit tests fail. The CD portion creates the hw\<num>_\<net_id>.zip file which you can download and turn in to Canvas. I encourage you to give it a try, but it is beyond the scope of this course, and you may always run tests and package the zip file manually.

To set this up, the yml file needs to be in a folder named .github/workflows. Run this command to copy the yml file into your project:

$ cp example_github_actions.yml /path/to/CS540/hw3/.github/workflows/ci.yml

Then open the yml file and edit the NET_ID environment variable on line 23. With this setup, GitHub automatically runs the unit tests in test.py whenever you run git push. You will get an email from GitHub if the unit tests fail.
This workflow will also generate the hw<num>_<NETID>.zip file you need to turn in. It can be downloaded by going to the Actions tab of the main page of your GitHub repo, scrolling down to artifacts section, and clicking on the file.

Lastly, you will need a requirements.txt file in your repo to tell the test script what modules to install from pip. This repo contains a requirements.txt file with the modules used in the homework assignment. Simply copy it to your project:

$ cp requirements.txt /path/to/CS540/hw3/

One thing to note is Actions is included in a GitHub Pro account. This comes in the GitHub Student Deveoloper Pack which is free for students and comes with like 300 hours of Actions run time per month or something like that.

Disclaimer

These tests are not endorsed or created by anyone working in an official capacity with UW Madison or any staff for CS540. The tests are make by students, for students.

By running test.py, you are executing code you downloaded from the internet. Back up your files and take a look at what you are running first.

If you have comments or questions, create an issue at https://github.com/CS540-testers-SP21/hw3-tester/issues or ask in our discord at https://discord.gg/RDFNsAxgCQ.