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

a plugin for py.test that changes the default look and feel of py.test (e.g. progressbar, show tests that fail instantly)

A pytest plugin to skip `@pytest.mark.slow` tests by default.

PyAutoEasy is a extension / wrapper around the famous PyAutoGUI, a cross-platform GUI automation tool to replace your boooring repetitive tasks.

Codeforces Test Parser for C/C++ & Python on Windows

Nokia SR OS automation

d4rk Ghost is all in one hacking framework For red team Pentesting

Python dilinin Selenium kütüphanesini kullanarak; Amazon, LinkedIn ve ÇiçekSepeti üzerinde test işlemleri yaptığımız bir case study reposudur.

API mocking with Python.

WomboAI Art Generator

Generic automation framework for acceptance testing and RPA

Divide full port scan results and use it for targeted Nmap runs

Let your Python tests travel through time

show python coverage information directly in emacs

A Python Selenium library inspired by the Testing Library

Enabling easy statistical significance testing for deep neural networks.

pytest_pyramid provides basic fixtures for testing pyramid applications with pytest test suite

The Penetration Testers Framework (PTF) is a way for modular support for up-to-date tools.

pytest plugin for testing mypy types, stubs, and plugins

No longer maintained, please migrate to model_bakery

Ward is a modern test framework for Python with a focus on productivity and readability.