Skip to content

Conversation

@richm
Copy link
Contributor

@richm richm commented May 19, 2025

Add Fedora 42 to testing farm test matrix, drop Fedora 40

Use tox-lsr 3.9.0 for the --lsr-report-errors-url argument.

Add the argument --lsr-report-errors-url DEFAULT to the qemu test so that
the errors will be written to the output log. This uses the output callback
https://github.com/linux-system-roles/auto-maintenance/blob/main/callback_plugins/lsr_report_errors.py

Use the check_logs.py script
https://github.com/linux-system-roles/auto-maintenance/blob/main/check_logs.py
with the --github-action-format argument to format the errors
in a github action friendly manner.

Rename the log files -FAIL.log or -SUCCESS.log depending on status.
This is compatible with the way the testing farm log files are named, and
makes it easy to tell if a test passed or failed from the log file name.

Upload README.html as artifacts of the build_docs job for debugging

Signed-off-by: Rich Megginson rmeggins@redhat.com

Summary by Sourcery

Enhance CI workflows to include Fedora 42, upgrade tox-lsr, improve QEMU test error reporting and log handling, and publish documentation artifacts.

New Features:

  • Capture QEMU test errors via tox-lsr’s --lsr-report-errors-url and write them to output logs
  • Format and surface error details in GitHub Actions using check_logs.py

Enhancements:

  • Add Fedora 42 and remove Fedora 40 from testing farm and matrix configurations
  • Rename test log files with -SUCCESS or -FAIL suffixes to indicate pass/fail status

Build:

  • Upload generated README.html as an artifact in the build_docs job

CI:

  • Upgrade tox-lsr to version 3.9.0 across GitHub workflows

…tests

Add Fedora 42 to testing farm test matrix, drop Fedora 40

Use tox-lsr 3.9.0 for the `--lsr-report-errors-url` argument.

Add the argument `--lsr-report-errors-url DEFAULT` to the qemu test so that
the errors will be written to the output log.  This uses the output callback
https://github.com/linux-system-roles/auto-maintenance/blob/main/callback_plugins/lsr_report_errors.py

Use the check_logs.py script
https://github.com/linux-system-roles/auto-maintenance/blob/main/check_logs.py
with the `--github-action-format` argument to format the errors
in a github action friendly manner.

Rename the log files `-FAIL.log` or `-SUCCESS.log` depending on status.
This is compatible with the way the testing farm log files are named, and
makes it easy to tell if a test passed or failed from the log file name.

Upload README.html as artifacts of the build_docs job for debugging

Signed-off-by: Rich Megginson <rmeggins@redhat.com>
@richm richm requested a review from spetrosi as a code owner May 19, 2025 17:38
@richm richm self-assigned this May 19, 2025
@sourcery-ai
Copy link

sourcery-ai bot commented May 19, 2025

Reviewer's Guide

This PR refactors CI workflows: it bumps tox-lsr to v3.9.0 across all pipelines, enriches QEMU integration tests with lsr-report-errors URL support, dynamic SUCCESS/FAIL log renaming and GitHub-friendly error formatting via check_logs.py; it also updates the testing farm matrix by dropping Fedora-40 in favor of Fedora-42 and adds a step to upload README.html as a build_docs artifact.

Sequence Diagram: QEMU Test Error Reporting and Log Processing

sequenceDiagram
    participant Job as QEMU Tests Job (GitHub Actions)
    participant TestRunner as Test Runner (e.g., tox with tox-lsr 3.9.0)
    participant Ansible as Ansible Execution
    participant Callback as lsr_report_errors.py (Callback Plugin)
    participant Scripting as CI Script Logic
    participant CheckLogs as check_logs.py
    participant GH_UI as GitHub Actions UI/Logs

    Job->>TestRunner: Start tests
    TestRunner->>Ansible: Execute tests with --lsr-report-errors-url DEFAULT
    alt Test Failure
        Ansible->>Callback: Error occurs, trigger callback
        Callback->>Ansible: Write error details to test output log
    end
    TestRunner->>Scripting: Test execution completed
    Scripting->>Scripting: Rename log file (e.g., test-FAIL.log or test-SUCCESS.log)
    Job->>CheckLogs: Process renamed log file with --github-action-format
    CheckLogs->>GH_UI: Output formatted errors for easy viewing
Loading

Flow Diagram: README.html Artifact Upload in build_docs Workflow

graph TD
    A["Start build_docs job"] --> B["Build documentation"];
    B --> C["Copy README.html to docs/index.html (if latest release)"];
    C --> D["Upload README.html (from env.RELEASE_VERSION path) as artifact"];
    style D fill:#cff,stroke:#333,stroke-width:2px;
    A --> E["Commit changes (if any)"];
Loading

File-Level Changes

Change Details Files
Bump tox-lsr to 3.9.0 in CI workflows
  • Update pip3 install reference to tox-lsr@3.9.0 in QEMU CI
  • Update pip3 install reference to tox-lsr@3.9.0 in ansible-lint workflow
  • Update pip3 install reference to tox-lsr@3.9.0 in ansible-managed-var-comment workflow
  • Update pip3 install reference to tox-lsr@3.9.0 in ansible-test workflow
.github/workflows/qemu-kvm-integration-tests.yml
.github/workflows/ansible-lint.yml
.github/workflows/ansible-managed-var-comment.yml
.github/workflows/ansible-test.yml
Enhance QEMU test error reporting and log management
  • Add --lsr-report-errors-url DEFAULT flag to tox invocation
  • Rename test logs to include -SUCCESS.log or -FAIL.log suffix
  • Fetch and run check_logs.py with --github-action-format for failed logs
.github/workflows/qemu-kvm-integration-tests.yml
Update Fedora versions in testing farm matrix
  • Remove Fedora-40 from supported_platforms and matrix
  • Add Fedora-42 to supported_platforms and matrix
.github/workflows/tft.yml
Publish generated documentation artifact
  • Add README.html upload-artifact step in build_docs job
.github/workflows/build_docs.yml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @richm - I've reviewed your changes - here's some feedback:

  • Pin the actions/upload-artifact@master reference to a stable version (e.g. @v3) to avoid unexpected breaks when the default branch updates.
  • Rather than fetching check_logs.py from main every run, consider pinning it to a specific commit or vendoring a copy in the repo to prevent future API changes from breaking the workflow.
  • Since you’re bumping tox-lsr in multiple workflows, it might be cleaner to centralize that version in a shared variable or workflow template to avoid drift.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Review instructions: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@richm richm merged commit bac3cae into main May 19, 2025
26 checks passed
@richm richm deleted the changes-20250519 branch May 19, 2025 20:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant