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 [email protected]

Summary by Sourcery

Enhance CI workflows by adding Fedora 42 support, bumping tox-lsr to 3.9.0, improving qemu-kvm integration test error reporting and log handling, and publishing docs artifacts.

CI:

  • Add Fedora-42 and drop Fedora-40 from test matrices in relevant workflows
  • Upgrade tox-lsr dependency to v3.9.0 in all GitHub Actions workflows
  • Configure qemu-kvm integration tests to use --lsr-report-errors-url and format failures via check_logs.py
  • Rename qemu test log files with -SUCCESS or -FAIL suffix based on outcome
  • Upload generated 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 <[email protected]>
@richm richm requested a review from liangwen12year 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 refines multiple GitHub Actions workflows by upgrading to tox-lsr 3.9.0, enhancing QEMU test error reporting and log naming, updating the Fedora test matrix (dropping Fedora 40, adding Fedora 42), and publishing the generated README.html as an artifact.

Sequence Diagram: QEMU Test Error Reporting and Log Management

sequenceDiagram
    actor CI as CI Workflow Step
    participant QTE as QEMU Test Execution
    participant LRE as lsr_report_errors.py (callback)
    participant OL as Output Log
    participant CLS as check_logs.py script
    participant GAD as GitHub Actions Display
    participant LFS as Log File System

    CI ->> QTE: Start QEMU Tests (with --lsr-report-errors-url DEFAULT)
    QTE ->> QTE: Run tests
    alt Test Fails during execution
        QTE ->> LRE: Invoke callback with error information
        LRE ->> OL: Write error details to Output Log
    end
    QTE ->> CI: Tests completed, Output Log generated
    CI ->> CLS: Execute check_logs.py (input: Output Log path)
    CLS ->> OL: Read Output Log
    CLS ->> GAD: Format errors and report to GitHub Actions (via --github-action-format)
    alt Overall Test Result is Failure
        CLS ->> LFS: Rename log file to [testname]-FAIL.log
    else Overall Test Result is Success
        CLS ->> LFS: Rename log file to [testname]-SUCCESS.log
    end
Loading

File-Level Changes

Change Details Files
Upgrade tox-lsr to version 3.9.0 across CI workflows
  • Updated pip install invocations from 3.8.0 to 3.9.0
  • Ensured consistent tox-lsr usage in qemu, lint, ansible, and python test jobs
.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
Improve QEMU test logging and error reporting
  • Added --lsr-report-errors-url DEFAULT to tox QEMU runs
  • Renamed test logs with -SUCCESS.log or -FAIL.log based on exit code
  • Fetched and invoked check_logs.py with --github-action-format to summarize failures
.github/workflows/qemu-kvm-integration-tests.yml
Update Fedora versions in Testing Farm matrix
  • Removed Fedora-40 from supported_platforms and matrix include
  • Added Fedora-42 to supported_platforms and matrix include
.github/workflows/tft.yml
Publish generated documentation for debugging
  • Added a build_docs step to upload README.html as an artifact
.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 and found some issues that need to be addressed.

  • Rather than hard-coding pip installs across multiple workflows, consider centralizing the tox-lsr version into a shared CI variable or matrix to keep the version in sync.
  • Pin the check_logs.py script to a specific commit or release instead of pulling main directly to avoid unexpected breakage from upstream changes.
  • Instead of using actions/upload-artifact@master, pin to a stable version (e.g. v3) to ensure reproducible CI behavior.
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 c0b8196 into main May 19, 2025
35 of 39 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.

2 participants