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