Sebastian Castro, 2020-2022
This repository shows a few examples of testing and continuous integration (CI) using Python. Testing is done using the PyTest package. Then, we create a Docker image and integrate this into the Jenkins CI tool.
Refer to the following blog posts for more information.
To get started locally, first clone this repository and go to its root folder.
Create a Python 3 virtual environment using the requirements file included. Take the steps below, replacing $FOLDER_NAME with whatever destination you would like.
python3 -m venv SFOLDER_NAME
source $FOLDER_NAME/bin/activate
pip install -r python_requirements.txt
Then, with the virtual environment activated, additionally install the packages included with this repository.
pip install .
NOTE: This repository was tested using Ubuntu 20.04 and Python 3.8.
This repository contains a Dockerfile, from which you can build a Docker image. To do this, first install Docker, then go to the root folder of the repository and build the image.
docker build -t testing-ci .
where testing-ci is the name of the image, and you can use whatever you prefer instead.
Once you have built the image, you can start an interactive session to a container running this image as follows (assuming you used the same name).
docker run -it testing-ci
Once you're there, you can run all the tests in this repository as shown in the following section.
First, you can use Flake8 to check the code against the PEP8 coding style. For example, to check the matrix_tools/basic_utils.py source file:
flake8 --format=html --htmldir=flake-report matrix_tools/basic_utils.py
The HTML file generated in the flake-report folder will show you there are a few small coding standard fixes to make.
We are using the PyTest module to run and manage unit tests. All you need to do is go to the root of this repository and run the following line.
pytest
PyTest will automatically pick up functions and/or class methods in files that start with test_, as well as pick up the command-line options we have specified in the pytest.ini file.
One of these options is to generate an HTML test report, which is saved as the latest_test_results.html file.
If you are using the Docker workflow, you can copy the generated file to the host using:
docker cp <containerId>:/app/latest_test_results.html ./latest_test_results.html
where <containerId> is the ID of the container you can get by running docker ps and copying the ID that shows up.
A Jenkinsfile is included with this repository. This is set up to run pytest and then get the automatically generated JUnit-style XML for display on Jenkins.
Most of the setup for this part needs to be done in GitHub and Jenkins, to ensure that a push to GitHub will trigger running a CI job on Jenkins. Please refer to the blog post linked at the beginning for more information.