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
mainbranch,pytestis used to run the tests which are written in the./testsdirectory 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.
1.1k Dec 31, 2022
4 Nov 27, 2022
1 Dec 01, 2021
1 Nov 17, 2022
3 Aug 12, 2021
2k Jan 06, 2023
249 Dec 14, 2022
756 Dec 22, 2022
2 Jun 17, 2022
14 Jan 25, 2022
632 Jan 08, 2023
35 Dec 15, 2022
1 Nov 29, 2021
5 Mar 05, 2022
73 Nov 06, 2022
1.7k Dec 24, 2022
6 Jun 10, 2022
2 Jan 28, 2022
2.6k Dec 27, 2022
58 Jan 03, 2023