feat: single duration formatter + unit tests

Author: foosel

.github/workflows/build.yml

@@ -44,6 +44,52 @@ jobs:
         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 octoprint
+          pip install -e .[develop]
+      - name: 🚀 Run test suite
+        run: |
+          pytest | tee report.txt
+          pytest_exit=${PIPESTATUS[0]}
+
+          # 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
+
+          # make sure we fail if pytest fails!
+          exit $pytest_exit
+
   test-install:
     name: 🧪 Installation test
     strategy:
@@ -92,6 +138,7 @@ jobs:
     needs:
       - build
       - pre-commit
+      - test-unit
       - test-install
       - test-e2e
     runs-on: ubuntu-latest

octoprint_wrapped/__init__.py

@@ -215,10 +215,10 @@ def _get_year_stats(self, year: int) -> Optional[YearStats]:
             return YearStats(
                 year=year,
                 prints_completed=stats.get("prints_finished", 0),
-                total_print_duration=self._to_duration_days(
+                total_print_duration=_format_duration(
                     int(stats.get("print_duration_total", 0))
                 ),
-                longest_print=self._to_duration_hours(
+                longest_print=_format_duration(
                     int(stats.get("longest_print_duration", 0))
                 ),
                 busiest_weekday=weekday,
@@ -231,31 +231,6 @@ def _get_year_stats(self, year: int) -> Optional[YearStats]:
             )
             return None
 
-    def _to_duration_days(self, seconds: int) -> str:
-        days = int(seconds / SECONDS_DAY)
-        seconds -= days * SECONDS_DAY
-
-        hours = int(seconds / SECONDS_HOUR)
-        seconds -= hours * SECONDS_HOUR
-
-        minutes = int(seconds / SECONDS_MINUTE)
-        seconds -= minutes * SECONDS_MINUTE
-
-        if days >= 100:
-            # strip the minutes to keep things fitting...
-            return f"{days}d {hours}h"
-        else:
-            return f"{days}d {hours}h {minutes}m"
-
-    def _to_duration_hours(self, seconds: int) -> str:
-        hours = int(seconds / SECONDS_HOUR)
-        seconds -= hours * SECONDS_HOUR
-
-        minutes = int(seconds / SECONDS_MINUTE)
-        seconds -= minutes * SECONDS_MINUTE
-
-        return f"{hours}h {minutes}m"
-
     def _load_font(self) -> None:
         from base64 import b64encode
 
@@ -273,6 +248,54 @@ def _load_font(self) -> None:
             self._logger.exception("Error creating data URI for embedded font")
 
 
+def _format_duration(seconds: int) -> str:
+    """
+    Formats a duration in seconds for the wrapped picture.
+
+    Examples:
+
+    >>> _format_duration(SECONDS_MINUTE)
+    '0h 1m'
+    >>> _format_duration(SECONDS_HOUR)
+    '1h 0m'
+    >>> _format_duration(SECONDS_DAY)
+    '1d 0h 0m'
+    >>> _format_duration(SECONDS_DAY + SECONDS_HOUR + SECONDS_MINUTE)
+    '1d 1h 1m'
+    >>> _format_duration(99 * SECONDS_DAY + SECONDS_HOUR + SECONDS_MINUTE)
+    '99d 1h 1m'
+    >>> _format_duration(100 * SECONDS_DAY + SECONDS_HOUR + SECONDS_MINUTE)
+    '100d 1h'
+    >>> _format_duration(100 * SECONDS_DAY + SECONDS_HOUR + 30 * SECONDS_MINUTE)
+    '100d 2h'
+    >>> _format_duration(100 * SECONDS_DAY + 23 * SECONDS_HOUR + 30 * SECONDS_MINUTE)
+    '101d 0h'
+    """
+    days = int(seconds / SECONDS_DAY)
+    seconds %= SECONDS_DAY
+
+    hours = int(seconds / SECONDS_HOUR)
+    seconds %= SECONDS_HOUR
+
+    minutes = int(seconds / SECONDS_MINUTE)
+    seconds %= SECONDS_MINUTE
+
+    if days >= 100:
+        # strip the minutes to keep things fitting (but round up if needed)...
+        if minutes >= 30:
+            # past 30m -> add an hour
+            hours += 1
+        if hours >= 24:
+            # past 24h -> add a day
+            hours %= 24
+            days += 1
+        return f"{days}d {hours}h"
+    elif days == 0:
+        return f"{hours}h {minutes}m"
+    else:
+        return f"{days}d {hours}h {minutes}m"
+
+
 __plugin_name__ = "OctoPrint Wrapped!"
 __plugin_pythoncompat__ = ">=3.9,<4"  # Only Python 3
 

pyproject.toml

@@ -36,7 +36,8 @@ Homepage = "https://github.com/OctoPrint/OctoPrint-Wrapped"
 
 [project.optional-dependencies]
 develop = [
-    "go-task-bin"
+    "go-task-bin",
+    "pytest"
 ]
 
 [tool.ruff]

pytest.ini

@@ -0,0 +1,3 @@
+[pytest]
+testpaths = octoprint_wrapped tests
+addopts = --doctest-modules