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

Hamcrest matchers for Python

Data-Driven Tests for Python Unittest

A simple tool to test internet stability.

Selenium Manager

Python Moonlight (Machine Learning) Practice

Cornell record & replay mock server

A folder automation made using Watch-dog, it only works in linux for now but I assume, it will be adaptable to mac and PC as well

A Python Selenium library inspired by the Testing Library

The evaluator covering all of the metrics required by tasks within the DUE Benchmark.

tidevice can be used to communicate with iPhone device

A utility for mocking out the Python Requests library.

It's a simple script to generate a mush on code forces, the script will accept the public problem urls only or polygon problems.

Pytest modified env

Aplikasi otomasi klik di situs popcat.click menggunakan Python dan Selenium

Web testing library for Robot Framework

Python Webscraping using Selenium

This is a simple software for fetching new changes to remote repositories automatically.

Klara is a static analysis tools to automatic generate test case, based on SMT (z3) solver, with a powerful ast level inference system.

Just a small test with lists in cython

Subprocesses for Humans 2.0.