Skip to content

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

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#239
richm merged 1 commit intomainfrom
changes-20250519

Conversation

@richm
Copy link
Copy Markdown
Collaborator

@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 the CI pipelines by upgrading tox-lsr, updating the Fedora matrix, improving QEMU test error reporting and log naming, integrating formatted failure logs, and preserving documentation artifacts.

Enhancements:

  • Upgrade CI workflows to use tox-lsr 3.9.0 across test jobs
  • Extend testing farm matrix by adding Fedora 42 and removing Fedora 40
  • Configure QEMU tests to report errors via lsr-report-errors and rename logs with -SUCCESS/-FAIL suffixes
  • Integrate check_logs.py to format test failures for GitHub Actions
  • Upload generated README.html as an artifact in the build_docs job

…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 natoscott as a code owner May 19, 2025 17:38
@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 enhances CI workflows by adding Fedora 42 support, upgrading tox-lsr to 3.9.0, improving QEMU test error reporting via lsr-report-errors and check_logs.py, standardizing log file names with status suffixes, and uploading README.html as a build_docs artifact.

Sequence Diagram: Enhanced QEMU Test Error Reporting

sequenceDiagram
    participant Runner as GitHub Actions Runner
    participant TestScript as QEMU Test Script
    participant LSRCallback as lsr_report_errors.py
    participant CheckLogsScript as check_logs.py
    participant FileSystem as Log Storage

    Runner->>TestScript: Execute QEMU tests (with --lsr-report-errors-url DEFAULT)
    alt Test Execution
        TestScript->>LSRCallback: (test error occurs)
        LSRCallback->>FileSystem: Write error details to output log
    end
    Runner->>CheckLogsScript: Execute check_logs.py --github-action-format
    CheckLogsScript->>FileSystem: Read output log
    CheckLogsScript->>CheckLogsScript: Format errors for GitHub Actions
    CheckLogsScript->>FileSystem: Rename log file (e.g., to test-FAIL.log or test-SUCCESS.log)
Loading

File-Level Changes

Change Details Files
Update Fedora test matrix
  • Remove Fedora-40 from supported platforms
  • Add Fedora-42 to supported_platforms in metadata
  • Include Fedora-42 in the matrix for testing farm
.github/workflows/tft.yml
Upgrade tox-lsr to version 3.9.0
  • Change pip install references from 3.8.0 to 3.9.0
  • Apply update across QEMU, ansible-lint, managed-var-comment, and ansible-test workflows
.github/workflows/qemu-kvm-integration-tests.yml
.github/workflows/ansible-lint.yml
.github/workflows/ansible-managed-var-comment.yml
.github/workflows/ansible-test.yml
Enable lsr-report-errors in QEMU tests
  • Add --lsr-report-errors-url DEFAULT to tox invocation
  • Leverage the lsr_report_errors callback plugin for error output
.github/workflows/qemu-kvm-integration-tests.yml
Standardize test log file naming with status suffix
  • Rename logs to include -SUCCESS.log on pass
  • Rename logs to include -FAIL.log on failure
.github/workflows/qemu-kvm-integration-tests.yml
Use check_logs.py for formatted failure output
  • Download check_logs.py via curl
  • Run it with --github-action-format on all -FAIL.log files
.github/workflows/qemu-kvm-integration-tests.yml
Upload README.html as a CI artifact
  • Add an upload-artifact step in build_docs job
  • Publish README.html for debugging
.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 the check_logs.py download to a specific commit or tag instead of refs/heads/main to avoid breaking changes in your CI when upstream evolves.
  • Consider centralizing the tox-lsr version string in a shared variable or reusable workflow to simplify future bumps across all GitHub Actions files.
  • Double-check that any other scripts or artifact uploads still referencing <test>.log are updated to use the new -SUCCESS.log/-FAIL.log filenames so nothing is missed.
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 5573184 into main May 19, 2025
26 of 27 checks passed
@richm richm deleted the changes-20250519 branch May 19, 2025 20:28
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