Rework/backport changes between USB/network

[CoMPaTech]

Following plugwise/python-plugwise-usb#264

Summary by CodeRabbit

• Chores

  • Centralized and streamlined GitHub Actions for restoring Python virtual environments and pre-commit caches, improving CI reliability and maintenance.
  • Introduced a unified cache key computation and a reusable custom action for environment setup across all jobs.
  • Updated job dependencies and removed redundant steps for a cleaner workflow.
  • Added a new "Ongoing" section in the changelog to document CI maintenance work.

• Tests

  • Added pytest-cov as a testing dependency for improved code coverage reporting.

• Bug Fixes

  • Improved architecture detection in the test setup script for more accurate binary downloads and clearer error messages.

[coderabbitai]

Walkthrough

A custom GitHub Action for restoring or creating Python virtual environments and pre-commit caches was introduced, centralizing and simplifying cache management in CI. The workflow was refactored to use this action, updating job dependencies and removing redundant cache logic. Additional minor updates include a new changelog entry, a new test dependency, and improved architecture detection in a setup script.

Changes

File(s)	Change Summary
.github/actions/restore-venv/action.yml	Added a new composite GitHub Action to restore or create Python venv and pre-commit cache, with error handling and input parameters.
.github/workflows/verify.yml	Refactored workflow: added a central cache job, replaced scattered cache steps with the custom action, updated job dependencies, removed redundant steps, and integrated test cache logic.
CHANGELOG.md	Added an "Ongoing" section documenting CI maintenance and referencing related PRs.
requirements_test.txt	Added pytest-cov to the list of test dependencies.
scripts/setup_test.sh	Improved architecture detection using uname -m and a case statement; clarified error messages for unsupported architectures.

Sequence Diagram(s)

sequenceDiagram
    participant Workflow
    participant CacheJob
    participant Job as CI Job (e.g., prepare, ruff, pytest)
    participant RestoreVenv as restore-venv Action

    Workflow->>CacheJob: Start cache job
    CacheJob-->>Workflow: Output cache-key

    loop For each CI job
        Workflow->>Job: Start job (needs: cache, prepare, etc.)
        Job->>RestoreVenv: Invoke restore-venv with cache-key and params
        alt Cache hit
            RestoreVenv-->>Job: Restore venv and pre-commit cache
        else Cache miss
            RestoreVenv-->>Job: Create venv, install dependencies, (optionally) fail or save cache
        end
        Job-->>Workflow: Continue job steps
    end

Loading

Suggested labels

dependencies, enhancement, quality

Suggested reviewers

• bouwew

Poem

In the warren where code does hop,
A cachey breeze begins to blow—
Restoring venvs with a single hop,
No more scattered caches in a row!
With pytest-cov and actions neat,
This bunny’s CI is hard to beat.
🐇✨

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate Unit Tests

• Create PR with Unit Tests
• Post Copyable Unit Tests in Comment
• Commit Unit Tests in branch backport

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai auto-generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[CoMPaTech]

@coderabbitai summary
@coderabbitai full review

[coderabbitai]

Tip

For best results, initiate chat on the files or code changes.

🧩 Analysis chain

@CoMPaTech I'll gather the information about this PR and provide both a summary and full review.

---

🏁 Script executed:

#!/bin/bash
# Get PR information
gh pr view 759 --json title,body,author,createdAt,headRefName,baseRefName,url

# Get the list of changed files with their changes
git diff --name-only HEAD~1 HEAD

# Get detailed diff for each file
echo "=== Detailed changes ==="
git diff HEAD~1 HEAD

# Get commit messages in this PR
git log --oneline HEAD~1..HEAD

Length of output: 931

---

🏁 Script executed:

#!/bin/bash
# Try using the specific commit hashes mentioned in the original message
echo "=== PR Information ==="
echo "Title: Rework/backport changes between USB/network"
echo "Author: CoMPaTech"
echo "Base branch: main"
echo "Head branch: backport"
echo "URL: https://github.com/plugwise/python-plugwise/pull/759"
echo "Body: Following https://github.com/plugwise/python-plugwise-usb/pull/264"
echo ""

# Try to get the diff using the commit hashes from the rate limit message
echo "=== Trying to get diff with commit hashes ==="
git diff c945853e522e12b3f82471c755fa6b71ab17a865 4c3ebd705ac16802e5abe9dd7c77eaa5b66a4600 2>/dev/null || echo "Commit hashes not available"

# Get current branch info
echo "=== Current branch info ==="
git branch -v
git log --oneline -5

# List all files mentioned in the rate limit message and read their contents
echo "=== Reading changed files ==="
echo "Files mentioned: .github/actions/restore-venv/action.yml, .github/workflows/verify.yml, CHANGELOG.md, requirements_test.txt, scripts/setup_test.sh"

for file in ".github/actions/restore-venv/action.yml" ".github/workflows/verify.yml" "CHANGELOG.md" "requirements_test.txt" "scripts/setup_test.sh"; do
    if [ -f "$file" ]; then
        echo ""
        echo "=== Contents of $file ==="
        cat "$file"
        echo ""
    else
        echo "$file does not exist"
    fi
done

Length of output: 80517

---

@CoMPaTech Here's the summary and full review of your PR:

Summary

PR #759: Rework/backport changes between USB/network

This PR implements significant CI/CD infrastructure improvements by backporting changes from python-plugwise-usb#264. The main focus is optimizing the GitHub Actions workflow through better caching strategies and code deduplication.

Key Changes:

• New GitHub Action: Created .github/actions/restore-venv/action.yml to centralize virtual environment and pre-commit cache management
• Workflow Optimization: Major refactoring of .github/workflows/verify.yml with improved job dependencies and unified caching
• Dependencies: Added pytest-cov to test requirements
• Tooling: Enhanced biome CLI download logic with better architecture detection
• Documentation: Updated changelog with maintenance notes

Impact: Reduces code duplication, improves build efficiency, and makes the CI/CD pipeline more maintainable.

---

Full Review

✅ .github/actions/restore-venv/action.yml (New File)

Excellent addition - This custom action consolidates cache management logic effectively:

Strengths:

• Clear input/output interface with proper typing
• Handles both cache hits and misses gracefully
• Uses uv for faster dependency installation
• Includes proper error handling with fail-on-miss parameter
• Comments reference the mimicking of setup_test.sh behavior

Minor Observations:

• Typo in line 15: "DefauLt fail" → "Default fail"
• The action handles both creation and restoration, which is good for flexibility

✅ .github/workflows/verify.yml (Major Refactoring)

Significant improvement - The workflow is much cleaner and more maintainable:

Strengths:

• Centralized cache key: The new cache job computes the key once, eliminating duplication
• Improved dependencies: Clear job dependency chain with needs statements
• Code deduplication: Replaced ~15 cache restoration blocks with action calls
• Consistency: All jobs now use the same caching strategy
• Version bump: Cache version updated to 14 (appropriate for breaking changes)

Technical Improvements:

• Removed redundant prepare-test-cache job
• Added VENV environment variable for consistency
• Better job orchestration with explicit dependencies
• Matrix-specific cache keys for pytest jobs

✅ CHANGELOG.md (Documentation)

Good documentation practice - Properly documents the maintenance work with references to the source changes.

✅ requirements_test.txt (Dependencies)

Necessary addition - Adding pytest-cov aligns with the workflow's coverage testing requirements.

✅ scripts/setup_test.sh (Tooling Improvement)

Good enhancement - The biome CLI download logic is more robust:

Improvements:

• Better architecture detection using case statement
• Cleaner variable handling with use_arch
• More maintainable than the previous if-elif chain

---

Overall Assessment

This is a high-quality infrastructure improvement PR that:

✅ Reduces maintenance burden through code deduplication
✅ Improves build efficiency with optimized caching
✅ Enhances reliability with better error handling
✅ Maintains compatibility while modernizing the pipeline
✅ Follows best practices for GitHub Actions development

No blocking issues identified. The changes are well-thought-out and should significantly improve the development experience.

Recommendation: ✅ Approve and merge

The refactoring successfully achieves its goals of reducing duplication and improving maintainability while maintaining all existing functionality.

[coderabbitai]

Actionable comments posted: 2

🧹 Nitpick comments (4)

.github/actions/restore-venv/action.yml (1)

16-16: Fix typo in default input description
The comment # DefauLt fail if not available has an inconsistent capital “L.”

Apply:

-    default: "true" # DefauLt fail if not available
+    default: "true" # Default to failing if cache restore misses

CHANGELOG.md (1)

3-6: Unify link syntax for consistency
Linking to external PRs in other repos should follow [#264] convention for clarity.

-## Ongoing
-
-- Maintenance chores ... [USB: 264](https://github.com/plugwise/python-plugwise-usb/pull/264) after porting our progress using [USB: 263](...)
+## Ongoing
+
+- Maintenance chores ... [#264](https://github.com/plugwise/python-plugwise-usb/pull/264) after porting our progress using [#263](...)

scripts/setup_test.sh (1)

28-33: Enhance cross-platform architecture detection
Mapping aarch64|arm64 directly to darwin-arm64 fails for Linux ARM hosts. Consider detecting OS via uname -s and then matching uname -m, e.g.:

os=$(uname -s)
arch=$(uname -m)
case "$os-$arch" in
  Darwin-arm64) use_arch="darwin-arm64" ;;
  Linux-aarch64) use_arch="linux-arm64" ;;
  Linux-x86_64) use_arch="linux-x64" ;;
  *) echo "Unsupported OS/arch: $os-$arch"; exit 2 ;;
esac

.github/workflows/verify.yml (1)

64-64: Remove trailing spaces
Several lines have trailing whitespace, which can lead to YAML lint errors. Please strip the trailing spaces on lines 64, 143, 182, 233, and 310.

Also applies to: 143-143, 182-182, 233-233, 310-310

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c945853 and 4c3ebd7.

📒 Files selected for processing (5)

• .github/actions/restore-venv/action.yml (1 hunks)
• .github/workflows/verify.yml (16 hunks)
• CHANGELOG.md (1 hunks)
• requirements_test.txt (1 hunks)
• scripts/setup_test.sh (1 hunks)

🧰 Additional context used

🪛 YAMLlint (1.37.1)

.github/workflows/verify.yml

[error] 64-64: trailing spaces

(trailing-spaces)

---

[error] 143-143: trailing spaces

(trailing-spaces)

---

[error] 182-182: trailing spaces

(trailing-spaces)

---

[error] 233-233: trailing spaces

(trailing-spaces)

---

[error] 310-310: trailing spaces

(trailing-spaces)

🔇 Additional comments (5)

requirements_test.txt (1)

8-8: Add code coverage plugin for pytest
Including pytest-cov enabling coverage reporting in CI aligns with the updated workflows. Ensure that the pytest --cov commands pick up this plugin in the relevant jobs.

.github/workflows/verify.yml (4)

7-11: Centralize CI environment variables
Defining CACHE_VERSION, PRE_COMMIT_HOME, and VENV at the top promotes consistency across all jobs.

---

20-29: Compute a unified cache key once
Calculating the cache key in a dedicated job based on OS, Python version, and key files reduces duplication and ensures cache coherence.

---

43-60: Use custom restore-venv action for environment setup
Replacing scattered actions/cache steps with the restore-venv composite action in the prepare job streamlines cache restore and creation.

---

140-147: Matrix-based pytest cache key
Appending the matrix Python version to the cache key (-pytest-matrix-${{ matrix.python-version }}) prevents collisions across matrix runs.

[bouwew]

LGTM!

[CoMPaTech]

Still need to address the biome issues discovered in usb

[CoMPaTech]

Re-running CI

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (c945853) to head (4c3ebd7).
Report is 2 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff            @@
##              main      #759   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           21        21           
  Lines         3410      3410           
=========================================
  Hits          3410      3410           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.