Skip to content

ci: Add Fedora 42; use tox-lsr 3.9.0; use lsr-report-errors for qemu tests#534

Merged
richm merged 1 commit intomainfrom
changes-20250519
May 19, 2025
Merged

ci: Add Fedora 42; use tox-lsr 3.9.0; use lsr-report-errors for qemu tests#534
richm merged 1 commit intomainfrom
changes-20250519

Conversation

@richm
Copy link
Copy Markdown
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 [email protected]

Summary by Sourcery

Update CI workflows to include Fedora 42, upgrade tox-lsr to 3.9.0, enhance QEMU integration test reporting and log handling, and preserve documentation artifacts.

CI:

  • Add Fedora-42 to the testing farm matrix and remove Fedora-40
  • Upgrade tox-lsr to v3.9.0 across all GitHub Actions workflows
  • Enhance QEMU integration tests with --lsr-report-errors-url DEFAULT for inline error reporting
  • Rename QEMU test logs to use -SUCCESS.log or -FAIL.log suffixes for pass/fail clarity
  • Integrate check_logs.py --github-action-format to group and format failure logs

Documentation:

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

…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 <[email protected]>
@richm richm self-assigned this May 19, 2025
@sourcery-ai
Copy link
Copy Markdown

sourcery-ai Bot commented May 19, 2025

Reviewer's Guide

This PR refreshes CI workflows by adding Fedora 42 support (dropping Fedora 40), upgrading tox-lsr to 3.9.0, integrating error reporting into QEMU tests via --lsr-report-errors-url and check_logs.py (with GitHub Actions formatting) along with log renames, and publishing README.html as a documentation artifact.

Sequence Diagram: QEMU Test Error Reporting with lsr-report-errors

sequenceDiagram
    participant GHAW as GitHub Actions Workflow
    participant QEMUTest as QEMU Test Execution (via tox-lsr)
    participant ErrorCallback as lsr_report_errors.py (callback)
    participant CheckLogs as check_logs.py

    GHAW->>QEMUTest: Run test with --lsr-report-errors-url DEFAULT
    alt Test Fails
        QEMUTest->>ErrorCallback: Invoke with error details
        ErrorCallback-->>QEMUTest: Write errors to output log
    end
    GHAW->>CheckLogs: Process output log with --github-action-format
    CheckLogs-->>GHAW: Return formatted errors
    GHAW->>GHAW: Rename log file (e.g., test-FAIL.log)
Loading

Flow Diagram: README.html Artifact Upload in Build Docs Workflow

graph TD
    A[Start Build Docs Job] --> B{Build Documentation};
    B --> C{Is env.RELEASE_VERSION == 'latest'?};
    C -- Yes --> D[Copy RELEASE_VERSION/README.html to docs/index.html];
    D --> F[Upload RELEASE_VERSION/README.html as 'README.html' artifact];
    F --> G[Commit changes];
    C -- No --> E[Skip copy];
    E --> G;
    G --> H[End Build Docs Job];

    style F fill:#ddeeff,stroke:#0077cc
Loading

File-Level Changes

Change Details Files
Updated Fedora platform matrix
  • Removed Fedora-40 entries
  • Added Fedora-42 to supported_platforms and matrix
.github/workflows/tft.yml
Upgraded tox-lsr dependency .github/workflows/qemu-kvm-integration-tests.yml
.github/workflows/ansible-lint.yml
.github/workflows/ansible-managed-var-comment.yml
.github/workflows/ansible-test.yml
.github/workflows/python-unit-test.yml
Enhanced QEMU test error reporting and log handling
  • Added --lsr-report-errors-url DEFAULT to tox commands
  • Integrated check_logs.py with --github-action-format for failure logs
  • Renamed test logs to include -SUCCESS or -FAIL suffix
.github/workflows/qemu-kvm-integration-tests.yml
Published README.html build artifact
  • Uploaded generated README.html as an artifact 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
Copy Markdown

@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 actions/upload-artifact to a specific release tag instead of using @master to avoid unexpected breakages.
  • Fetch check_logs.py from a fixed commit or tag rather than main branch to ensure CI stability.
  • Consider centralizing the tox-lsr version across workflows (e.g. via a shared variable or workflow template) to simplify future upgrades.
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 fea3415 into main May 19, 2025
34 checks passed
@richm richm deleted the changes-20250519 branch May 19, 2025 20:35
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