ci: add unit tests

Author: foosel

.github/workflows/ci.yml

@@ -0,0 +1,170 @@
+name: CI
+on:
+  push:
+  pull_request:
+#  release:
+#    types: [released]
+  workflow_dispatch:
+
+env:
+  DEFAULT_PYTHON: "3.12"
+
+jobs:
+  build:
+    name: 🔨 Build distribution
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: 🏗 Set up Python ${{ env.DEFAULT_PYTHON }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: "${{ env.DEFAULT_PYTHON }}"
+
+      - name: 🔨 Build distribution
+        uses: OctoPrint/actions/build-dist@main
+        with:
+          artifact: dist
+
+  pre-commit:
+    name: 🧹 Pre-commit
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: 🏗 Set up Python ${{ env.DEFAULT_PYTHON }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: "${{ env.DEFAULT_PYTHON }}"
+
+      - name: 🏗 Set up dev dependencies
+        run: |
+          pip install -e .[develop]
+
+      - name: 🚀 Run pre-commit
+        run: |
+          pre-commit run --all-files --show-diff-on-failure
+
+  test-unit:
+    name: 🧪 Unit tests
+    strategy:
+      fail-fast: false
+      matrix:
+        python: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: 🏗 Set up Python ${{ matrix.python }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python }}
+
+      - name: 🏗 Set up test dependencies
+        run: |
+          pip install -e .[develop]
+
+      - name: 🚀 Run test suite
+        run: |
+          pytest | tee report.txt
+
+          # generate summary
+          python=$(python -c 'import sys; print(".".join(map(str, sys.version_info[:3])))')
+          today=$(date +'%Y-%m-%d')
+          now=$(date +'%H:%M')
+          summary=$(tail -n1 report.txt | sed 's/^=*\s//g' | sed 's/\s=*$//g')
+
+          cat << EOF >> $GITHUB_STEP_SUMMARY
+          ### Test Report
+
+          *generated on $today at $now under Python $python*
+
+          <details>
+          <summary>$summary</summary>
+
+          \`\`\`
+          $(cat report.txt)
+          \`\`\`
+
+          </details>
+          EOF
+
+    name: 🧪 Installation test
+    strategy:
+      fail-fast: false
+      matrix:
+        python: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: 🏗 Set up Python ${{ matrix.python }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python }}
+
+      - name: 🚀 Run test install
+        run: |
+          pip install -e .
+
+  publish-on-testpypi:
+    name: 📦 Publish on TestPyPI
+    if: github.event_name == 'release'
+    needs:
+      - build
+      - pre-commit
+      - test-install
+      - test-unit
+    runs-on: ubuntu-latest
+
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/gcode-thumbnail-tool
+
+    permissions:
+      id-token: write
+
+    steps:
+      - name: ⬇ Download build result
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist
+
+      - name: 🧹 Remove some stuff that won't make it through twine check
+        run: |
+          rm dist/*.source.tar.gz
+          rm dist/sha512sums.txt
+
+      - name: 📦 Publish to index
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+
+  publish-on-pypi:
+    name: 📦 Publish tagged releases to PyPI
+    if: github.event_name == 'release'
+    needs: publish-on-testpypi
+    runs-on: ubuntu-latest
+
+    environment:
+      name: pypi
+      url: https://pypi.org/p/gcode-thumbnail-tool
+
+    permissions:
+      id-token: write
+
+    steps:
+      - name: ⬇ Download build result
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist
+
+      - name: 🧹 Remove some stuff that won't make it through twine check
+        run: |
+          rm dist/*.source.tar.gz
+          rm dist/sha512sums.txt
+
+      - name: 📦 Publish to index
+        uses: pypa/gh-action-pypi-publish@release/v1

gcode_thumbnail_tool.py

@@ -129,7 +129,7 @@ class ExtractedBytes:
     images: dict[str, bytes]
 
 
-def _potential_lines(path: str) -> str:
+def _potential_lines_from_gcode_file(path: str) -> str:
     if not os.path.exists(path):
         return ""
 
@@ -151,20 +151,40 @@ def _potential_lines(path: str) -> str:
     return "".join(content_lines).replace("\r\n", "\n").replace(";\n;\n", ";\n\n;\n")
 
 
-def extract_thumbnails_from_gcode(gcode_path: str) -> Optional[ExtractedImages]:
+def _to_thumbnail_bytes(extracted: ExtractedImages, format="PNG") -> ExtractedBytes:
+    data = {}
+    for image in extracted.images:
+        sizehint = _image_to_sizehint(image)
+        if sizehint in data:
+            continue
+        data[sizehint] = _image_to_bytes(image, format=format)
+    return ExtractedBytes(extractor=extracted.extractor, images=data)
+
+
+def extract_thumbnails_from_gcode_file(gcode_path: str) -> Optional[ExtractedImages]:
     logger = logging.getLogger(__name__)
 
+    if not os.path.exists(gcode_path):
+        logger.warning(f"Gcode file {gcode_path} doesn't exist")
+        return None
+
     logger.info(f"Extracting thumbnails from {gcode_path}...")
 
-    potential_lines = _potential_lines(gcode_path)
+    potential_lines = _potential_lines_from_gcode_file(gcode_path)
     logger.debug(
         f"Searching for matches in:\n{_prefix_lines(potential_lines, prefix=' | ')}"
     )
 
+    return extract_thumbnails_from_gcode(potential_lines)
+
+
+def extract_thumbnails_from_gcode(gcode: str) -> Optional[ExtractedImages]:
+    logger = logging.getLogger(__name__)
+
     extractors = [
         ("generic", (REGEX_GENERIC, _extract_generic_base64_thumbnails)),
         ("snapmaker", (REGEX_SNAPMAKER, _extract_generic_base64_thumbnails)),
-        ("mks", (REGEX_MKS, _extract_mks_thumbnails)),
+        # ("mks", (REGEX_MKS, _extract_mks_thumbnails)),
         ("weedo", (REGEX_WEEDO, _extract_weedo_thumbnails)),
         ("qidi", (REGEX_QIDI, _extract_qidi_thumbnails)),
         ("flashprint", _extract_flashprint_thumbnails),
@@ -176,45 +196,39 @@ def extract_thumbnails_from_gcode(gcode_path: str) -> Optional[ExtractedImages]:
             # regex based extractor
             regex, extractor = tooling
 
-            matches = list(regex.finditer(potential_lines))
+            matches = list(regex.finditer(gcode))
             if matches:
                 logger.debug(f"Detected {name} thumbnails, extracting...")
                 return ExtractedImages(extractor=name, images=extractor(matches))
 
         elif callable(tooling):
             # custom extractor function
-            thumbnails = tooling(gcode_path, potential_lines)
+            thumbnails = tooling(gcode)
             if thumbnails:
                 return ExtractedImages(extractor=name, images=thumbnails)
 
-    # none of the regex based extractors matched, could this be flashprint?
-    with open(gcode_path, "rb") as f:
-        f.seek(58)
-        buffer = f.read(14454)
-        if buffer[0] == 0x42 and buffer[1] == 0x4D:  # BMP magic numbers
-            logger.debug("Detected flashprint thumbnails, extracting...")
-            return ExtractedImages(
-                extractor="flashprint", images=_extract_flashprint_thumbnails(buffer)
-            )
-
     # if we reach this point, we could not find any thumbnails
     return None
 
 
-def extract_thumbnail_bytes_from_gcode(
+def extract_thumbnail_bytes_from_gcode_file(
     gcode_path: str, format="PNG"
 ) -> Optional[ExtractedBytes]:
-    result = extract_thumbnails_from_gcode(gcode_path)
+    result = extract_thumbnails_from_gcode_file(gcode_path)
     if not result:
         return None
 
-    data = {}
-    for image in result.images:
-        sizehint = _image_to_sizehint(image)
-        if sizehint in data:
-            continue
-        data[sizehint] = _image_to_bytes(image, format=format)
-    return ExtractedBytes(extractor=result.extractor, images=data)
+    return _to_thumbnail_bytes(result, format=format)
+
+
+def extract_thumbnail_bytes_from_gcode(
+    gcode: str, format="PNG"
+) -> Optional[ExtractedBytes]:
+    result = extract_thumbnails_from_gcode(gcode)
+    if not result:
+        return None
+
+    return _to_thumbnail_bytes(result, format=format)
 
 
 # ~~ extractors
@@ -245,24 +259,7 @@ def _extract_generic_base64_thumbnails(matches: list[re.Match]) -> list[PILImage
     return result
 
 
-def _extract_generic_hex_thumbnails(matches: list[re.Match]) -> list[PILImage]:
-    """
-    Extracts thumbnails from hex encoded data
-
-    Will remove any comment prefixes from lines.
-
-    Expected match groups:
-    * ``data``: hex encoded data
-    """
-    result = []
-    for match in matches:
-        data = _remove_whitespace(_remove_comment_prefix(match.group("data")))
-        image = _image_from_hex(data)
-        result.append(image)
-    return result
-
-
-def _extract_mks_thumbnails(matches: list[re.Match]) -> list[PILImage]:
+def _extract_old_mks_thumbnails(matches: list[re.Match]) -> list[PILImage]:
     """Extracts a thumbnail from hex binary data used by MKS printers"""
 
     OPTIONS = {";;gimage": (200, 200), ";simage": (100, 100)}
@@ -392,11 +389,14 @@ def val2rgb(val: int) -> tuple[int, int, int]:
     return result
 
 
-def _extract_flashprint_thumbnails(path: str, _lines: str) -> list[PILImage]:
-    with open(path, "rb") as f:
+def _extract_flashprint_thumbnails(gcode: str) -> list[PILImage]:
+    with io.BytesIO(gcode.encode()) as f:
         f.seek(58)
         buffer = f.read(14454)
 
+    if not len(buffer) == 14454:
+        return {}
+
     if not (buffer[0] == 0x42 and buffer[1] == 0x4D):  # BMP magic numbers
         return {}
 
@@ -534,7 +534,7 @@ def main():
             print(f"{args.path} doesn't exist, exiting!", file=sys.stderr)
             sys.exit(1)
 
-        result = extract_thumbnail_bytes_from_gcode(args.path, format="PNG")
+        result = extract_thumbnail_bytes_from_gcode_file(args.path, format="PNG")
         if result:
             output_folder = args.output
             if not output_folder:
@@ -559,7 +559,7 @@ def main():
             print(f"{args.path} doesn't exist, exiting!", file=sys.stderr)
             sys.exit(1)
 
-        result = extract_thumbnails_from_gcode(args.path)
+        result = extract_thumbnails_from_gcode_file(args.path)
         if result:
             print(
                 f'Found {len(result.images)} thumbnails in {args.path}, in format "{result.extractor}":'

pyproject.toml

@@ -21,3 +21,11 @@ maintainers = [
 
 [project.scripts]
 gcode-thumbnail-tool = "gcode_thumbnail_tool:main"
+
+[project.optional-dependencies]
+develop = [
+    # Testing dependencies
+    "pytest-doctest-custom>=1.0.0,<2",
+    "pytest>=8.3.4,<9",
+    "pre-commit",
+]

tests/__init__.py

@@ -0,0 +1 @@
+# Tests for gcode-thumbnail-tool