fixing tests

Author: snhobbs

.github/workflows/cd.yml

@@ -0,0 +1,76 @@
+name: Publish Python 🐍 distribution 📦 to PyPI and TestPyPI
+
+on: push
+
+jobs:
+  build:
+    name: Build distribution 📦
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        persist-credentials: false
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.x"
+    - name: Install pypa/build
+      run: >-
+        python3 -m
+        pip install
+        build
+        --user
+    - name: Build a binary wheel and a source tarball
+      run: python3 -m build
+    - name: Store the distribution packages
+      uses: actions/upload-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+
+  publish-to-pypi:
+    name: >-
+      Publish Python 🐍 distribution 📦 to PyPI
+    if: startsWith(github.ref, 'refs/tags/')  # only publish to PyPI on tag pushes
+    needs:
+    - build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/isp-programmer  # Replace <package-name> with your PyPI project name
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish distribution 📦 to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+
+  publish-to-testpypi:
+    name: Publish Python 🐍 distribution 📦 to TestPyPI
+    needs:
+    - build
+    runs-on: ubuntu-latest
+
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/isp-programmer
+
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish distribution 📦 to TestPyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        repository-url: https://test.pypi.org/legacy/

.github/workflows/python-app.yml

@@ -0,0 +1,38 @@
+# This workflow will install Python dependencies, run tests and lint with a single version of Python
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: Python application
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python 3.9
+      uses: actions/setup-python@v3
+      with:
+        python-version: "3.9"
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install .
+        pip install ruff pytest
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+    - name: Lint with ruff
+      run: |
+        # stop the build if there are Python syntax errors or undefined names
+        ruff check --exit-non-zero-on-fix
+    - name: Test with pytest
+      run: |
+        pytest

.github/workflows/python-package.yml

@@ -5,7 +5,7 @@
 import struct
 from dataclasses import dataclass
 import typing
-from typing import Deque, Union
+from typing import Deque, Union, Dict
 from collections import deque
 
 from intelhex import IntelHex
@@ -578,11 +578,11 @@ class ChipDescription:
     Wraps a chip description line and exposes it as a class
     """
 
-    kWordSize = 4
-    kPageSizeBytes = 64
-    SectorSizePages = 16
-    CRCLocation = 0x000002FC
-    CRCValues = {
+    kWordSize: int = 4
+    kPageSizeBytes: int = 64
+    SectorSizePages: int = 16
+    CRCLocation: int = 0x000002FC
+    CRCValues: Dict[str, int] = {
         "NO_ISP": 0x4E697370,
         "CRP1": 0x12345678,
         "CRP2": 0x87654321,
@@ -957,7 +957,7 @@ def SetupChip(
         chip = ChipDescription(descriptor)
         chip.CrystalFrequency = crystal_frequency
 
-        _log.debug("Setting new baudrate %d" % baudrate)
+        _log.debug("Setting new baudrate %d", baudrate)
         isp.SetBaudRate(baudrate)  # set the chips baudrate
         isp.baud_rate = baudrate  # change the driver baudrate
         time.sleep(isp.settings.set_baudrate_sleep)

.github/workflows/pythonpublish.yml

@@ -1 +1,5 @@
-from .ISPConnection import *
+from .ISPConnection import (BAUDRATES,
+                            Settings,
+                            ISPConnection)
+
+__all__ = ("BAUDRATES", "Settings", "ISPConnection")

src/isp_programmer/ISPConnection.py

@@ -1,13 +1,21 @@
+import unittest
+from pathlib import Path
 from isp_programmer import parts_definitions
 
-def_file = "lpctools_parts.def"
 
-if __name__ == "__main__":
-    df = parts_definitions.ReadChipFile(def_file)
-    print(df)
+def_file = Path(__file__).absolute().parent / "lpctools_parts.def"
+
+
+class SmokeTest(unittest.TestCase):
+    def test_smoketest(self):
+        df = parts_definitions.ReadChipFile(def_file)
+        print(df)
 
-    line = parts_definitions.GetPartDescriptorLine(fname=def_file, partid=0x00008041)
-    print(line)
+        line = parts_definitions.GetPartDescriptorLine(fname=def_file, partid=0x00008041)
+        self.assertTrue(line is not None)
 
-    line = parts_definitions.GetPartDescriptorLine(fname=def_file, partid=0x0000804)
-    print(line)
+        with self.assertRaises(ValueError):
+                parts_definitions.GetPartDescriptorLine(fname=def_file, partid=0x0000804)
+
+if __name__ == "__main__":
+    unittest.main()