Merge pull request #16 from gjbex/development

Replace slides on unittest by slides on pytest

Author: gjbex

python_software_engineering.pptx

@@ -0,0 +1,26 @@
+# Markers
+
+pytest supports custom markers that can be used to select or deselect tests.
+
+
+## What is it?
+
+1. `fibonacci.py`: Python script that defines a function to compute the
+   Fibonacci sequence in a (very) naive way.
+1. `test_fibonacci.py`: test script that uses pytest to test the
+   implementation of the Fibonacci sequence computation.  One of the tests has been marked with the `slow` marker.
+1. `pytest.ini`: configuration file for pytest that defines the markers that
+   can be used in the test scripts.
+
+
+## How to use it?
+
+To run all tests:
+```bash
+$ pytest
+```
+
+To run all tests except the `slow` test:
+```bash
+$ pytest -m "not slow"
+```

source-code/testing/PyTest/CustomMarkers/README.md

@@ -0,0 +1,19 @@
+#!/usr/bin/env python
+
+def fib(n):
+    if n < 0:
+        raise ValueError('fac argument must be positive')
+    elif n < 2:
+        return 1
+    else:
+        return fib(n - 1) + fib(n - 2)
+
+
+if __name__ == '__main__':
+    from argparse import ArgumentParser
+    arg_parser = ArgumentParser(description='compute fibonacci numbers')
+    arg_parser.add_argument('n', type=int, default=5,
+                            help='maximum argument')
+    options = arg_parser.parse_args()
+    for i in range(options.n + 1):
+        print(f'fib({i}) = {fib(i)}')

source-code/testing/PyTest/CustomMarkers/fibonacci.py

@@ -0,0 +1,3 @@
+[pytest]
+markers =
+    slow: marks tests as slow (deselect with '-m "not slow"')

source-code/testing/PyTest/CustomMarkers/pytest.ini

@@ -0,0 +1,24 @@
+from fibonacci import fib
+
+import pytest
+
+
+def test_fib_0():
+    assert fib(0) == 1
+
+def test_fib_1():
+    assert fib(1) == 1
+
+def test_fib_2():
+    assert fib(2) == 2
+
+def test_fib_5():
+    assert fib(5) == 8
+
+@pytest.mark.slow
+def test_fib_40():
+    assert fib(40) == 165580141
+
+def test_fib_negative():
+    with pytest.raises(ValueError):
+        _ = fib(-1)    

source-code/testing/PyTest/CustomMarkers/test_fib.py

@@ -0,0 +1,11 @@
+# Parameterize
+
+pytest tests can be parameterized so that it can be run on a list of input
+arguments and expected output.
+
+
+## What is it?
+
+1. `fibonacci.py`: Python script that implements the Fibonacci function.
+1. `test_fib.py`: parameterized tests for the Fibonacci function.
+1. `pytest.ini`: pytest configuration file that defines a `slow` marker.

source-code/testing/PyTest/Parametrize/README.md

@@ -0,0 +1,19 @@
+#!/usr/bin/env python
+
+def fib(n):
+    if n < 0:
+        raise ValueError('fac argument must be positive')
+    elif n < 2:
+        return 1
+    else:
+        return fib(n - 1) + fib(n - 2)
+
+
+if __name__ == '__main__':
+    from argparse import ArgumentParser
+    arg_parser = ArgumentParser(description='compute fibonacci numbers')
+    arg_parser.add_argument('n', type=int, default=5,
+                            help='maximum argument')
+    options = arg_parser.parse_args()
+    for i in range(options.n + 1):
+        print(f'fib({i}) = {fib(i)}')

source-code/testing/PyTest/Parametrize/fibonacci.py

@@ -0,0 +1,3 @@
+[pytest]
+markers =
+    slow: marks tests as slow (deselect with '-m "not slow"')

source-code/testing/PyTest/Parametrize/pytest.ini

@@ -0,0 +1,25 @@
+from fibonacci import fib
+
+import pytest
+
+@pytest.mark.parametrize("n, expected", [
+    (0, 1),
+    (1, 1),
+    (2, 2),
+    (5, 8),
+])
+def test_fib(n, expected):
+    assert fib(n) == expected
+
+@pytest.mark.slow
+@pytest.mark.parametrize("n, expected", [
+    (40, 165580141),
+    (41, 267914296),
+    (42, 433494437),
+])
+def test_fib_40(n, expected):
+    assert fib(n) == expected
+
+def test_fib_negative():
+    with pytest.raises(ValueError):
+        _ = fib(-1)    

source-code/testing/PyTest/Parametrize/test_fib.py

@@ -6,3 +6,6 @@ module provided by the Python standard library.
 1. `Simple`: a very simple illustration of how to test using `pytest`.
 1. `Cython`: testing a Cython implementation using `pytest`.
 1. `Fixtures`: illustrates using fixtures with pytest.
+1. `CustomMarkers`: illustrates using custom markers with pytest to
+   selectively run tests.
+1. `Parametrize`: illustrates using parameterized tests.