Bootstrap Unit Test framework

.github/workflows/ci.yaml

@@ -65,3 +65,32 @@ jobs:
         run: |
           echo "::add-matcher::.github/matchers/pylint.json"
           tox -e pylint
+
+  # Run python unit tests
+  # https://docs.python.org/3/library/unittest.html
+  tests-unit:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Python 3.8
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.8"
+          cache: 'pip'
+
+      - name: Cache Python Dependencies and Env
+        uses: actions/cache@v2
+        with:
+          path: |
+            ~/.cache/pip
+            .tox
+          key: ${{ runner.os }}-v1-python-3.8-pylint-${{ hashFiles('requirements.txt', 'test-requirements.txt', 'tox.ini') }}
+
+      - name: Install Python test dependencies
+        run: python -m pip install tox
+
+      - name: Run unit tests
+        run: |
+          tox -e unit

.gitignore

@@ -5,7 +5,9 @@
 *.logs
 
 # VS code
-.vscode/settings.json
+.vscode/
+# We include in the repo recommended settings file with configured Tests Suite
+!.vscode/settings.json
 
 # Mac
 **/.DS_Store

.vscode/settings.json

@@ -0,0 +1,17 @@
+// Configuration for running unit tests with the Python extension for VS Code
+// https://code.visualstudio.com/docs/python/unit-testing
+{
+    "python.testing.unittestArgs": [
+        "--verbose",
+        "--top-level-directory",
+        "scripts",
+        "--start-directory",
+        "./scripts/tests/unit",
+        "--pattern",
+        "test_*.py"
+    ],
+    "python.testing.pytestEnabled": false,
+    // Uses the unittest module
+    // https://docs.python.org/3/library/unittest.html
+    "python.testing.unittestEnabled": true
+}

scripts/tests/README.md

@@ -0,0 +1,17 @@
+# BitOps Unit Tests
+
+This directory contains tests for the BitOps core.
+We use the built-in [`unittest`](https://docs.python.org/3/library/unittest.html) module as a framework for testing.
+
+## Running the tests
+The testing command is defined in [`tox.ini`](../../tox.ini) and can be run with `tox`:
+```bash
+tox -e unit
+```
+
+## VSCode Configuration
+The repository contains a `.vscode/settings.json` file that configures VSCode to auto-discover the tests and run the test suite.
+
+![VSCode Tests Suite Configuration](https://code.visualstudio.com/assets/docs/python/testing/test-results.png)
+
+See [Python Testing in VSCode](https://code.visualstudio.com/docs/python/testing) for more information.

scripts/tests/unit/test_hello.py

@@ -0,0 +1,13 @@
+import unittest
+
+
+class TestHello(unittest.TestCase):
+    """Basic test example demonstrating the hello world."""
+
+    def test_hello(self):
+        """Test hello world."""
+        self.assertEqual(True, True)
+
+
+if __name__ == "__main__":
+    unittest.main()

tox.ini

@@ -33,3 +33,11 @@ commands =
 skip_install = True
 commands =
        pylint scripts/
+
+# Unit tests
+# https://docs.python.org/3/library/unittest.html
+# Run:
+#      tox -e unit
+[testenv:unit]
+commands =
+       python3 -m unittest discover --verbose --top-level-directory scripts --start-directory scripts/tests/unit --pattern "test_*.py"