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 self-assigned this Jun 3, 2025
@sourcery-ai
Copy link

sourcery-ai bot commented Jun 3, 2025

Reviewer's Guide

Introduce bootc end-to-end validation by upgrading the CI’s tox-lsr version, adding an Ubuntu-specific Podman 5.x workaround, refining skip-tag logic for bootc tests in QEMU workflows, and appending a dedicated QEMU validation step that runs qcow2-based tests with the __bootc_validation flag.

Sequence Diagram for Bootc End-to-End Test Execution Flow

sequenceDiagram
    participant GAW as GitHub Actions Workflow
    participant ToxPrep as Tox (Preparation Env)
    participant Script_Buildah as bootc-buildah-qcow.sh
    participant ToxVal as Tox (Validation Env)
    participant QEMU as QEMU VM
    participant Scripts_VM as Test Scripts (in VM)

    GAW->>ToxPrep: Run image preparation
    ToxPrep->>Script_Buildah: Execute script
    Script_Buildah->>Script_Buildah: Build container image using Buildah
    Script_Buildah-->>ToxPrep: Return disk.qcow2
    ToxPrep-->>GAW: Preparation complete (disk.qcow2 available)

    GAW->>ToxVal: Run QEMU validation (with disk.qcow2, __bootc_validation=true)
    ToxVal->>QEMU: Start VM with disk.qcow2
    QEMU->>QEMU: Boot OS from image
    QEMU->>Scripts_VM: Execute validation scripts
    Scripts_VM->>Scripts_VM: Perform configuration checks
    Scripts_VM-->>QEMU: Validation results
    QEMU-->>ToxVal: VM execution results
    ToxVal-->>GAW: Validation results
Loading

File-Level Changes

Change Details Files
Bump tox-lsr to 3.10.0 across CI workflows
  • Update pip install URI to point at tox-lsr@3.10.0
  • Replace all occurrences of the old 3.9.0 tag
.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
Add Ubuntu Podman 5.x backport hack
  • Insert conditional step for Ubuntu bootc images
  • Pin and install Podman and related packages from ‘plucky’ using apt preferences
.github/workflows/qemu-kvm-integration-tests.yml
Refine skip-tag flags for bootc end-to-end tests
  • Change --skip-tags to exclude tests::bootc-e2e instead of earlier tags
.github/workflows/qemu-kvm-integration-tests.yml
Add QEMU validation step for bootc containers
  • Append a new conditional step to detect qcow2 images
  • Loop through disks, invoke tox with __bootc_validation flag, and capture PASS/FAIL logs
.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 - here's some feedback:

  • Consolidate the repeated tox-lsr upgrade commands across workflows into a common CI template or reusable step to simplify future version bumps.
  • Add a clear TODO or conditional guard for the Ubuntu plucky pinning hack so it’s automatically removed once upgrading to 26.04 LTS to avoid stale configuration.
  • Extract the Run bootc validation tests in QEMU logic into a standalone script or composite action for better readability and maintainability.
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 ad49e80 to 98bb5eb Compare June 3, 2025 19:29
@richm richm merged commit c242dc0 into main Jun 3, 2025
34 checks passed
@richm richm deleted the changes-20250603-1 branch June 3, 2025 22:38
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