Software testing is the process of verifying and validating that code works as expected. The most granular level is unit testing, where each standalone unit in a code (e.g., function) is exercised to help ensure that it works correctly, even in edge and corner cases. Whether you write unit tests after your code is written or as you go, software tools exist to help make the testing process less manual and more systematic.
This workshop covers some best practices for testing code and gives participants a hands-on introduction to testing frameworks for interpreted (Python) with suggestions for compiled languages (C/C++). Though the emphasis will be on unit testing, other forms of testing such as system tests, integration tests, and regression tests will be discussed.
Choose one of the methods below to setup the needed software for this workshop:
If you already have an account on Adroit:
$ ssh <YourNetID>@adroit.princeton.edu # VPN required if off-campus
# answer yes if prompted
$ source /scratch/environments/shared_venv/bin/activate
$ git clone https://github.com/PrincetonUniversity/software_testing.git
$ cd software_testing/02_pytest
$ python status.py
Success!If you are using a Windows machine and you encounter Corrupted MAC on input then use:
$ ssh -m hmac-sha2-512 <YourNetID>@adroit.princeton.edu
You will need to install the Python packages pytest, pytest-mock, flask and requests. It would be best to install these into an isolated software environment (see the conda create line for Nobel below). Here is one way to install the packages:
$ pip install pytest pytest-mock flask requests
Then test your software environment:
$ git clone https://github.com/PrincetonUniversity/software_testing.git
$ cd software_testing/02_pytest
$ python status.py
Success!
All members of Princeton with a NetID have access to Nobel.
$ ssh <YourNetID>@nobel.princeton.edu
# answer yes if prompted
$ module load anaconda3/2023.9
$ conda create --name testing-env pytest pytest-mock flask requests -c conda-forge -y
$ conda activate testing-env
$ git clone https://github.com/PrincetonUniversity/software_testing.git
$ cd software_testing/02_pytest
$ python status.py
Success!If you are using a Windows machine and you encounter Corrupted MAC on input then use:
$ ssh -m hmac-sha2-512 <YourNetID>@nobel.princeton.edu
- If you have not already registered for the live workshop then please register.
- Wintersession will send participants a survey after the workshop.
- Request an account on Adroit if you wish to use Adroit to run examples.
If you encounter any difficulties with the material in this guide then please send an email to cses@princeton.edu or attend a help session.
Software Testing Tutorial from Intersect
This guide was created by Jonathan Halverson, William Hasling and members of Princeton Research Computing.