Minimal example of how to use pytest with automated 'devops' style automated test runs

Last update: Jan 02, 2022

Overview

Pytest python example with automated testing

This is a minimal viable example of pytest with an automated run of tests for every push/merge into the main branch and a auto schedule to run the tests every day.

It also shows an example of how to handle sensitive information (such as api keys) in your pipeline using secrets.

How does this work?

At every push and/or merge to the main branch, pytest is used to run the tests which are written in the ./tests directory of this repo
The exact same tests may be ran locally (see "Run tests locally")
Automated testing with a pipline and secrets (using Github actions - but this process is the same for any provider; Gitlab, bitbucket etc) see https://github.com/KarmaComputing/pytest-example-automated-testing/actions

Setup (local)

python3 -m venv venv
. venv/bin/activate
pip install -r requirements.txt

Copy api key (this is an example , it's not a real api key-you can use any value).

cp .env.example .env

Run tests locally

. venv/bin/activate
python -m pytest -vv

Example Output (when tests pass)

collected 1 item                                                                                                                  

tests/test_app.py::test_add PASSED                                                                                          [100%]

======================================================== 1 passed in 0.01s ========================================================
(venv) (base) $

Example Output (when a test fails)


Run python -m pytest -vv
============================= test session starts ==============================
platform linux -- Python 3.10.1, pytest-6.2.5, py-1.11.0, pluggy-1.0.0 -- /opt/hostedtoolcache/Python/3.10.1/x64/bin/python
cachedir: .pytest_cache
rootdir: /home/runner/work/pytest-example-automated-testing/pytest-example-automated-testing
collecting ... collected 2 items

tests/test_app.py::test_add PASSED                                       [ 50%]
tests/test_app.py::test_get_api_key FAILED                               [100%]

=================================== FAILURES ===================================
_______________________________ test_get_api_key _______________________________

    def test_get_api_key():
>       assert app.get_api_key() is not None

tests/test_app.py:9: 
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ 

    def get_api_key():
>       assert API_KEY is not None, "An empty API_KEY should never be allowed, did you forget to either add it to your .env file or, set the environment variable?"  # noqa: E501
E       AssertionError: An empty API_KEY should never be allowed, did you forget to either add it to your .env file or, set the environment variable?

app/app.py:13: AssertionError
=========================== short test summary info ============================
FAILED tests/test_app.py::test_get_api_key - AssertionError: An empty API_KEY...
========================= 1 failed, 1 passed in 0.04s ==========================
Error: Process completed with exit code 1.

Minimal example of how to use pytest with automated 'devops' style automated test runs

Related tags

Overview

Pytest python example with automated testing

How does this work?

Setup (local)

Run tests locally

Example Output (when tests pass)

Example Output (when a test fails)

Owner

Karma Computing

HTTP client mocking tool for Python - inspired by Fakeweb for Ruby

The pytest framework makes it easy to write small tests, yet scales to support complex functional testing

splinter - python test framework for web applications

Bayesian A/B testing

Auto Click by pyautogui and excel operations.

Asyncio http mocking. Similar to the responses library used for 'requests'

Automates hiketop+ crystal earning using python and appium

Python selenium script to bypass simaster.ugm.ac.id weak captcha.

Automated tests for OKAY websites in Python (Selenium) - user friendly version

FaceBot is a script to automatically create a facebook account using the selenium and chromedriver modules.

A rewrite of Python's builtin doctest module (with pytest plugin integration) but without all the weirdness

Ab testing - The using AB test to test of difference of conversion rate

Pytest-rich - Pytest + rich integration (proof of concept)

Test python asyncio-based code with ease.

A pure Python script to easily get a reverse shell

The source code and slide for my talk about the subject: unittesing in python

Integration layer between Requests and Selenium for automation of web actions.

a wrapper around pytest for executing tests to look for test flakiness and runtime regression

Tools for test driven data-wrangling and data validation.

A testing system for catching visual regressions in Web applications.