Merge pull request #70 from malmeloo/feat/unit-tests

tests: Add very basic unit tests

.github/workflows/docs.yml

@@ -26,7 +26,7 @@ jobs:
       run: |
         python -m pip install poetry
         poetry config virtualenvs.in-project true
-        poetry install
+        poetry install --with dev
       
     - name: Build documentation
       run: |

.github/workflows/pre-commit.yml

@@ -22,7 +22,7 @@ jobs:
       run: |
         python -m pip install poetry
         poetry config virtualenvs.in-project true
-        poetry install
+        poetry install --with dev
     
     - uses: pre-commit/[email protected]
 

.github/workflows/publish.yml

@@ -24,7 +24,7 @@ jobs:
       run: |
         python -m pip install poetry
         poetry config virtualenvs.in-project true
-        poetry install
+        poetry install --with dev
 
     - name: Prepare README
       run: ./scripts/refactor_readme.py README.md

.github/workflows/test.yml

@@ -0,0 +1,57 @@
+name: Run unit tests
+
+on:
+  workflow_dispatch:
+  push:
+
+jobs:
+  versions:
+    runs-on: ubuntu-latest
+
+    outputs:
+      py-versions: ${{ steps.supported-versions.outputs.py-versions }}
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.10'
+
+    - name: Install dependencies
+      run: |
+        python -m pip install poetry
+        poetry config virtualenvs.in-project true
+        poetry install --with dev
+
+    - id: supported-versions
+      name: Get supported versions
+      run: echo "py-versions=$(poetry run ./scripts/supported_py_versions.py)" >> "$GITHUB_OUTPUT"
+
+  test:
+    runs-on: ubuntu-latest
+
+    needs: versions
+    strategy:
+      matrix:
+        py-version: ${{ fromJson(needs.versions.outputs.py-versions) }}
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "${{ matrix.py-version }}"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install poetry
+          poetry config virtualenvs.in-project true
+          
+          # Only install main dependencies
+          poetry install --with test
+
+      - name: Run unit tests
+        run: poetry run pytest

pyproject.toml

@@ -14,12 +14,22 @@ beautifulsoup4 = "^4.12.3"
 aiohttp = "^3.9.5"
 bleak = "^0.22.2"
 
+[tool.poetry.group.dev]
+optional = true
+
 [tool.poetry.group.dev.dependencies]
 pre-commit = "^3.8.0"
 sphinx = "^7.2.6"
 sphinx-autoapi = "^3.2.1"
 pyright = "^1.1.374"
 ruff = "0.5.6"
+tomli = "^2.0.1"
+
+[tool.poetry.group.test]
+optional = true
+
+[tool.poetry.group.test.dependencies]
+pytest = "^8.3.2"
 
 [tool.pyright]
 venvPath = "."
@@ -32,6 +42,7 @@ reportImplicitOverride = true
 [tool.ruff]
 exclude = [
     "docs/",
+    "tests/"
 ]
 
 select = [

scripts/supported_py_versions.py

@@ -0,0 +1,38 @@
+#!/usr/bin/env python3
+
+import json
+from itertools import count
+from pathlib import Path
+from typing import Generator
+
+import tomli
+from packaging.specifiers import SpecifierSet
+from packaging.version import Version
+
+
+def get_python_versions() -> Generator[str, None, None]:
+    """Get all python versions this package is compatible with."""
+    with Path("pyproject.toml").open("rb") as f:
+        pyproject_data = tomli.load(f)
+
+    specifier = SpecifierSet(pyproject_data["tool"]["poetry"]["dependencies"]["python"])
+
+    below_spec = True
+    for v_minor in count():
+        version = Version(f"3.{v_minor}")
+
+        # in specifier: yield
+        if version in specifier:
+            below_spec = False
+            yield str(version)
+            continue
+
+        # below specifier: skip
+        if below_spec:
+            continue
+
+        # above specifier: return
+        return
+
+
+print(json.dumps(list(get_python_versions())))

tests/test_keygen.py

@@ -0,0 +1,11 @@
+import pytest
+
+
+@pytest.mark.parametrize('execution_number', range(100))
+def test_import(execution_number):
+    import findmy
+
+    kp = findmy.KeyPair.new()
+    assert len(kp.private_key_bytes) == 28
+    assert len(kp.adv_key_bytes) == 28
+    assert len(kp.hashed_adv_key_bytes) == 32