Skip to content

Conversation

@richm
Copy link
Contributor

@richm richm commented Jun 3, 2025

NOTE: This also requires upgrading to tox-lsr 3.10.0, and some
hacks to workaround a podman issue in ubuntu.

These tests run the role during a bootc container image build, deploy
the container into a QEMU VM, boot that, and validate the expected
configuration there. They run in two different tox environments, and
thus have to be run in two steps (preparation in buildah, validation in
QEMU). The preparation is expected to output a qcow2 image in
tests/tmp/TESTNAME/qcow2/disk.qcow2, i.e. the output structure of
https://github.com/osbuild/bootc-image-builder.

There are two possibilities:

  • Have separate bootc end-to-end tests. These are tagged with
    tests::bootc-e2 and are skipped in the normal qemu-* scenarios.
    They run as part of the container-* ones.

  • Modify an existing test: These need to build a qcow2 image exactly
    once (via calling bootc-buildah-qcow.sh) and skip setup/cleanup
    and role invocations in validation mode, i.e. when
    __bootc_validation is true.

In the container scenario, run the QEMU validation as a separate step in
the workflow.

See https://issues.redhat.com/browse/RHEL-88396

@richm richm requested a review from spetrosi as a code owner June 3, 2025 18:25
@richm richm self-assigned this Jun 3, 2025
@sourcery-ai
Copy link

sourcery-ai bot commented Jun 3, 2025

Reviewer's Guide

This PR enhances the GitHub Actions CI to support Bootc end-to-end validation tests by upgrading tox-lsr across workflows, adding a Podman 5.x workaround for Ubuntu in the QEMU integration pipeline, and extending the qemu-kvm-integration-tests workflow to tag and run Bootc E2E validation steps on built qcow2 images with the __bootc_validation flag.

Sequence Diagram for Bootc Two-Stage Test Process

sequenceDiagram
    participant GA as GitHub Actions
    participant TX as Tox
    participant Buildah as "Preparation (bootc-buildah-qcow.sh)"
    participant QEMU_VM as "Validation (QEMU + VM)"

    GA->>TX: Trigger Bootc E2E Test
    TX->>Buildah: Run Preparation Phase
    Buildah->>Buildah: Build bootc container image
    Buildah->>Buildah: Generate disk.qcow2
    Buildah-->>TX: disk.qcow2 available
    TX->>QEMU_VM: Run Validation Phase (with disk.qcow2)
    QEMU_VM->>QEMU_VM: Deploy qcow2 & Boot VM
    QEMU_VM->>QEMU_VM: Execute validation logic (using __bootc_validation flag)
    QEMU_VM-->>TX: Validation Status
    TX-->>GA: Overall Test Status
Loading

File-Level Changes

Change Details Files
Upgrade tox-lsr from 3.9.0 to 3.10.0 in all CI workflows
  • Bump pip install URL version in qemu-kvm-integration-tests.yml
  • Bump pip install URL version in ansible-lint.yml
  • Bump pip install URL version in ansible-managed-var-comment.yml
  • Bump pip install URL version in ansible-test.yml
.github/workflows/qemu-kvm-integration-tests.yml
.github/workflows/ansible-lint.yml
.github/workflows/ansible-managed-var-comment.yml
.github/workflows/ansible-test.yml
Add Podman 5.x compatibility workaround for Ubuntu in QEMU integration workflow
  • Insert step to add ‘plucky’ apt source and pin packages
  • Pin Podman and related packages to plucky release
  • Install Podman 5.x components
.github/workflows/qemu-kvm-integration-tests.yml
Implement Bootc end-to-end validation steps in qemu-kvm integration
  • Adjust skip-tags to exclude tests::bootc-e2e in initial QEMU run
  • Introduce new job step to locate qcow2 images and invoke validation with __bootc_validation flag
  • Capture and rename output logs per test outcome
.github/workflows/qemu-kvm-integration-tests.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.

NOTE: This also requires upgrading to tox-lsr 3.10.0, and some
hacks to workaround a podman issue in ubuntu.

These tests run the role during a bootc container image build, deploy
the container into a QEMU VM, boot that, and validate the expected
configuration there. They run in two different tox environments, and
thus have to be run in two steps (preparation in buildah, validation in
QEMU). The preparation is expected to output a qcow2 image in
`tests/tmp/TESTNAME/qcow2/disk.qcow2`, i.e. the output structure of
<https://github.com/osbuild/bootc-image-builder>.

There are two possibilities:

* Have separate bootc end-to-end tests. These are tagged with
`tests::bootc-e2` and are skipped in the normal qemu-* scenarios.
They run as part of the container-* ones.

* Modify an existing test: These need to build a qcow2 image exactly
*once* (via calling `bootc-buildah-qcow.sh`) and skip setup/cleanup
and role invocations in validation mode, i.e. when
`__bootc_validation` is true.

In the container scenario, run the QEMU validation as a separate step in
the workflow.

See https://issues.redhat.com/browse/RHEL-88396

Signed-off-by: Rich Megginson <rmeggins@redhat.com>
@richm richm force-pushed the changes-20250603-1 branch from c2a4539 to 9c6857f Compare June 3, 2025 19:30
@richm richm merged commit 697f2f9 into main Jun 3, 2025
19 checks passed
@richm richm deleted the changes-20250603-1 branch June 3, 2025 22:32
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