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

Update CI workflows to use tox-lsr 3.9.0, adjust Fedora test coverage, enhance test logging and error reporting, and upload built docs artifact

Enhancements:

  • Bump tox-lsr dependency to 3.9.0 across GitHub workflows
  • Extend testing farm matrix to include Fedora-42 and remove Fedora-40
  • Rename test logs with -SUCCESS.log and -FAIL.log suffixes for clearer pass/fail identification

CI:

  • Add --lsr-report-errors-url to QEMU tests and integrate lsr-report-errors callback
  • Use check_logs.py with GitHub Action formatting to summarize test failures

Documentation:

  • Upload README.html as an artifact in the build_docs workflow

…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 modernizes the CI pipelines by adding Fedora 42 support, upgrading tox-lsr to 3.9.0, improving QEMU test error reporting with lsr-report-errors and check_logs.py (including renaming test logs by status), and exposing README.html as a build artifact.

Sequence Diagram for Enhanced QEMU Test Error Reporting

sequenceDiagram
    participant GHA as GitHub Actions (Workflow)
    participant TOX as tox (with tox-lsr 3.9.0)
    participant LSR_CB as lsr_report_errors.py (Callback)
    participant LOG as Test Log File
    participant CLS as check_logs.py

    GHA->>TOX: Run QEMU tests
    activate TOX
    TOX-->>LSR_CB: Executes tests, on error calls callback (via --lsr-report-errors-url DEFAULT)
    activate LSR_CB
    LSR_CB->>LOG: Writes detailed errors
    deactivate LSR_CB
    deactivate TOX
    GHA->>CLS: Run check_logs.py --github-action-format
    activate CLS
    CLS->>LOG: Reads log file
    CLS->>GHA: Outputs formatted errors
    CLS->>LOG: Renames log file (e.g., *-FAIL.log or *-SUCCESS.log)
    deactivate CLS
Loading

File-Level Changes

Change Details Files
Add Fedora 42 to the testing matrix and remove Fedora 40
  • Append Fedora-42 in supported_platforms logic
  • Drop Fedora-40 and add Fedora-42 entries in matrix.include
.github/workflows/tft.yml
Upgrade tox-lsr to version 3.9.0 across workflows
  • Update pip install references from @3.8.0 to @3.9.0
  • Ensure all GitHub workflow jobs install the new tox-lsr version
.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
Enhance QEMU integration tests with structured error reporting
  • Add --lsr-report-errors-url DEFAULT to the tox invocation
  • Download and invoke check_logs.py with --github-action-format
  • Replace manual grep logic with check_logs.py to format failures
.github/workflows/qemu-kvm-integration-tests.yml
Rename test log files to include PASS/FAIL status
  • Move individual test logs to -SUCCESS.log on success
  • Move logs to -FAIL.log on failure in both qemu and scenario loops
.github/workflows/qemu-kvm-integration-tests.yml
Expose built README.html as an artifact in the docs job
  • Add an upload-artifact step for README.html in build_docs.yml
.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 check_logs.py script to a specific commit or release instead of always pulling from main to ensure reproducible error formatting.
  • Use a fixed version tag for actions/upload-artifact (instead of @master) to avoid unexpected CI breaks when the action changes upstream.
  • Centralize the tox-lsr version (e.g. via a workflow variable or reusable workflow) to avoid having to bump it manually across multiple YAML files.
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 717019f into main May 19, 2025
27 checks passed
@richm richm deleted the changes-20250519 branch May 19, 2025 20:26
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.

2 participants