Heading image

This is Day 20 of the #100DaysOfPython challenge.

This post will build off previous work done in the Python Unit Testing With PyTest post to add a GitHub Action for running test runner jobs on a push event to the repo.

The final project code can be found on my GitHub repo.

Prerequisites

  1. Familiarity with Pipenv. See here for my post on Pipenv.
  2. Read Python Unit Testing With PyTest if you are unfamiliar with Python.

Getting started

Let’s clone the original PyTest repo in .

At this stage, we can test that our repo is working correctly with PyTest locally:

At this stage, we are ready to set things up for our GitHub action!

Adding the test script

In of the , we want to add a section to add a script:

That script will simply call . We will use this script within our GitHub action.

In order to also prepare our GitHub action to give us more vebose information, we will also be passing a flag to our call to .

We can test things are working as expected by running from our terminal:

The verbose flag gives us more information about which test ran and passed. This can be helpful for debugging in CI.

Adding the GitHub action

We are now ready to add the GitHub action. Within the file that we created earlier, add the following:

Here we are doing a couple of things:

  1. Creating a job call .
  2. Running this job on a event to the repository.
  3. Running the job on .
  4. Setting a custom timeout of 10 minutes (albeit this is overkill, feel free to omit).
  5. Setting up the Python environment for the latest in version .
  6. Install and .
  7. Install dependencies with a cache set to be the hash of the lockfile.
  8. Running the test suite that we setup the command and tested before.

That is all that we need for this repo to be working!

Be sure at this stage that you have set up your own origin remote for the repo.

At this stage, all we need to do is commit the code and push the repo and the job will be available under the actions tab in the GitHub UI.

Summary

Today’s post demonstrated how to use GitHub actions to test Python code on a push to the remote repository. We used the testing framework to test our code.

Resources and further reading

  1. The ABCs of Pipenv
  2. Pipenv
  3. GitHub Actions
  4. Creating a Python GitHub Action
  5. Final project
  6. Python Unit Testing With PyTest

Photo credit:

Originally posted on my blog. To see new posts without delay, read the posts there and subscribe to my newsletter.

I write content for AWS, Kubernetes, Python, JavaScript and more. To view all the latest content, be sure to visit my blog and subscribe to my newsletter. Follow me on Twitter.

Senior Engineer @ UsabilityHub. Formerly Culture Amp.