Add actions for tests and code quality

Author: philipbl

.flake8

@@ -0,0 +1,13 @@
+[flake8]
+max-line-length = 127
+extend-ignore = E203, W503, E501
+exclude = 
+    .git,
+    __pycache__,
+    .venv,
+    venv,
+    htmlcov,
+    Old,
+    setup
+per-file-ignores =
+    tests/*:F401,F811

.github/workflows/code-quality.yml

@@ -0,0 +1,49 @@
+name: Code Quality
+
+on:
+  push:
+    branches: [ main, develop, tests ]
+  pull_request:
+    branches: [ main, develop ]
+
+jobs:
+  lint-and-format:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python 3.11
+      uses: actions/setup-python@v4
+      with:
+        python-version: 3.11
+
+    - name: Cache pip dependencies
+      uses: actions/cache@v3
+      with:
+        path: ~/.cache/pip
+        key: ${{ runner.os }}-lint-${{ hashFiles('setup/requirements*.txt') }}
+        restore-keys: |
+          ${{ runner.os }}-lint-
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install black isort flake8 mypy
+        pip install -r setup/requirements.txt
+        pip install -r setup/requirements_test.txt
+
+    - name: Check code formatting with Black
+      run: |
+        black --check --diff .
+
+    - name: Check import sorting with isort
+      run: |
+        isort --check-only --diff .
+
+    - name: Lint with flake8
+      run: |
+        # Stop the build if there are Python syntax errors or undefined names
+        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+        # Exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics

.github/workflows/tests.yml

@@ -0,0 +1,40 @@
+name: Run Tests
+
+on:
+  push:
+    branches: [ main, develop, tests ]
+  pull_request:
+    branches: [ main, develop ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.9, 3.11, 3.12]
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Cache pip dependencies
+      uses: actions/cache@v3
+      with:
+        path: ~/.cache/pip
+        key: ${{ runner.os }}-pip-${{ hashFiles('setup/requirements*.txt') }}
+        restore-keys: |
+          ${{ runner.os }}-pip-
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r setup/requirements.txt
+        pip install -r setup/requirements_test.txt
+
+    - name: Run tests with pytest
+      run: |
+        pytest tests/ --verbose --tb=short

README.md

@@ -101,4 +101,4 @@ The last step for the bUE is to enable it to run when the device power cycles. T
 sudo systemctl enable bue.service
 ```
 
-If you also wish the service to start during this power cycle, just run the `systemctl start` command above.
+If you also wish the service to start during this power cycle, just run the `systemctl start` command above.

pyproject.toml

@@ -5,11 +5,44 @@ python_classes = ["Test*"]
 python_functions = ["test_*"]
 addopts = [
     "--verbose",
-#     "--tb=short",
-#     "--cov=.",
-#     "--cov-report=html",
-#     "--cov-report=term-missing"
+    "--tb=short",
+    "--cov=.",
+    "--cov-report=html",
+    "--cov-report=term-missing"
 ]
 filterwarnings = [
     "ignore::DeprecationWarning"
 ]
+
+[tool.black]
+line-length = 127
+target-version = ['py39', 'py311', 'py312']
+include = '\.pyi?$'
+extend-exclude = '''
+/(
+  # directories
+  \.eggs
+  | \.git
+  | \.hg
+  | \.mypy_cache
+  | \.tox
+  | \.venv
+  | venv
+  | _build
+  | buck-out
+  | build
+  | dist
+  | htmlcov
+  | Old
+)/
+'''
+
+[tool.isort]
+profile = "black"
+line_length = 127
+multi_line_output = 3
+include_trailing_comma = true
+force_grid_wrap = 0
+use_parentheses = true
+ensure_newline_before_comments = true
+skip_glob = ["Old/*", "htmlcov/*", "setup/*"]