▶️ Set up CI pipeline for unittesting (#3)

.github/workflows/coverage.yml

@@ -0,0 +1,27 @@
+name: "Coverage"
+
+on:
+  push:
+    branches:
+      - main
+  pull_request: {}
+jobs:
+  coverage:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: ["3.12"]
+        os: [ubuntu-latest]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install tox
+      - name: Run tests and determine coverage
+        run: |
+          tox -e coverage

.github/workflows/unittesting.yml

@@ -0,0 +1,27 @@
+name: "Unittesting"
+
+on:
+  push:
+    branches:
+      - main
+  pull_request: {}
+jobs:
+  pytest:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: ["3.12"]
+        os: [ubuntu-latest]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install tox
+      - name: Run unittests via tox
+        run: |
+          tox -e testing

.gitignore

@@ -2,10 +2,11 @@
 !*.example
 
 .coverage
-__pycache__/
 .idea/
 .pytest_cache/
 .tox/
+__pycache__/
+htmlcov/
 
 # OS
 .DS_Store

tox.ini

@@ -1,9 +1,9 @@
 [tox]
 envlist =
-    # coverage
+    coverage
     linting
     spellchecking
-    # testing
+    testing
     tytpechecking
 isolated_build = True
 skip_missing_interpreters = True
@@ -29,7 +29,7 @@ deps =
 setenv = PYTHONPATH = {toxinidir}
 commands =
     pylint alloy
-    # pylint unittests --rcfile=unittests/.pylintrc
+    pylint unittests --rcfile=unittests/.pylintrc
 
 [testenv:spellchecking]
 setenv = PYTHONPATH = {toxinidir}
@@ -38,7 +38,7 @@ deps =
     -r dev_requirements/requirements-spellchecking.txt
 commands =
     codespell alloy/
-    # codespell unittests/
+    codespell unittests/
     codespell README.md
 
 [testenv:testing]
@@ -55,7 +55,7 @@ deps =
     -r dev_requirements/requirements-typechecking.txt
 commands =
     mypy --show-error-codes alloy --strict
-    # mypy --show-error-codes unittests --strict
+    mypy --show-error-codes unittests --strict
 
 [testenv:dev]
 deps =

unittests/.pylintrc

@@ -0,0 +1,10 @@
+[pylint]
+disable =
+    C0114,  # disable missing-module-docstring
+    C0115,  # disable missing-class-docstring
+    C0116,  # disable missing-function-docstring
+    R0903,  # disable too-few-public-methods
+    W0621,  # disable redefined-outer-name
+    R0801,  # disable duplicate-code
+[pylint."MESSAGES CONTROL"]
+max-line-length = 120

unittests/conftest.py

@@ -0,0 +1,11 @@
+import os
+
+import pytest
+
+
+@pytest.fixture
+def setup_paths(request):
+    unittests_dir = os.path.dirname(request.module.__file__)
+    return {
+        "test_data": os.path.join(unittests_dir, "data"),
+    }

unittests/data/.alloyignore

@@ -0,0 +1,2 @@
+.png
+.svg

unittests/data/dummy.md

@@ -0,0 +1,8 @@
+## lorem ipsum
+
+Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore 
+magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd 
+gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing 
+elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos 
+et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor 
+sit amet.

unittests/data/dummy.py

@@ -0,0 +1,8 @@
+"""
+Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore
+magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd
+gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing
+elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos
+et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
+sit amet.
+"""

unittests/data/dummy.txt

@@ -0,0 +1,6 @@
+Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore
+magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd
+gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing
+elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos
+et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
+sit amet.

unittests/data/dummy/dummy.yml

@@ -0,0 +1,6 @@
+Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore
+magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd
+gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing
+elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos
+et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
+sit amet.

unittests/test_file_collector.py

@@ -0,0 +1,25 @@
+from alloy.collector import consolidate, read_alloyignore
+
+
+def test_consolidate_excludes_png_and_svg(setup_paths):
+    codebase = consolidate(setup_paths["test_data"])
+
+    assert "dummy.md" in codebase
+    assert "dummy.txt" in codebase
+    assert "dummy.py" in codebase
+    assert "dummy.yml" in codebase
+
+    assert "dummy.png" not in codebase
+    assert "dummy.svg" not in codebase
+
+
+def test_read_alloyignore(setup_paths):
+    exclude = read_alloyignore(setup_paths["test_data"])
+
+    assert exclude("test.png") is True
+    assert exclude("test.svg") is True
+
+    assert exclude("test.md") is False
+    assert exclude("test.txt") is False
+    assert exclude("test.py") is False
+    assert exclude("test.yml") is False