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

Add Fedora 42 support, upgrade tox-lsr to 3.9.0 across CI, and improve QEMU integration test logging and error reporting

Enhancements:

  • Use --lsr-report-errors-url with tox-lsr in QEMU tests and format failures via check_logs.py
  • Rename QEMU test logs with -SUCCESS or -FAIL suffix based on result

CI:

  • Add Fedora-42 to testing matrix and remove Fedora-40
  • Upgrade tox-lsr to version 3.9.0 in GitHub workflows

Documentation:

  • 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 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 updates CI workflows by adding Fedora 42 (and dropping Fedora 40) to the test matrix, upgrading tox-lsr to 3.9.0 across jobs, enhancing the QEMU integration tests with lsr-report-errors and structured log handling, and publishing README.html as a build artifact.

Sequence Diagram: QEMU Test Error Reporting and Log Processing

sequenceDiagram
    title: "Sequence Diagram: QEMU Test Error Reporting and Log Processing"
    participant Job as "qemu-kvm-integration-tests.yml Job"
    participant Ansible as "Ansible Execution"
    participant LSRCallback as "lsr_report_errors.py (Callback)"
    participant LogFile as "Test Log File"
    participant CheckLogs as "check_logs.py Script"
    participant GH_Actions as "GitHub Actions UI"

    Job->>Ansible: Run QEMU test playbook (with lsr_report_errors callback enabled via --lsr-report-errors-url DEFAULT)
    Ansible->>Ansible: Execute test tasks
    alt Test Failure
        Ansible->>LSRCallback: Error occurred, Ansible invokes callback
        LSRCallback->>LogFile: Write detailed error to log output
    end
    Ansible->>Job: Playbook execution finished (status)
    alt Test Failed
        Job->>LogFile: Rename log to *-FAIL.log
    else Test Succeeded
        Job->>LogFile: Rename log to *-SUCCESS.log
    end
    Job->>CheckLogs: Execute with --github-action-format (input: LogFile)
    CheckLogs->>LogFile: Read log content
    CheckLogs->>CheckLogs: Parse log and format errors
    CheckLogs->>GH_Actions: Output formatted errors (e.g., as annotations)
Loading

File-Level Changes

Change Details Files
Add Fedora 42 support and remove Fedora 40 from test matrix
  • Remove Fedora-40 entries from the testing matrix
  • Add Fedora-42 to supported_platforms logic and matrix include
.github/workflows/tft.yml
Upgrade tox-lsr to version 3.9.0 across CI 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
Enhance QEMU integration tests with error-reporting and structured log naming
  • Add --lsr-report-errors-url DEFAULT to tox-lsr invocation
  • Rename generated log files to include -SUCCESS.log or -FAIL.log
  • Fetch and invoke check_logs.py with --github-action-format for failures
.github/workflows/qemu-kvm-integration-tests.yml
Publish README.html as a build artifact in the docs job
  • Add an actions/upload-artifact step for README.html
.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 they look great!

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 982fbab 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.

2 participants