ci: Add support for bootc end-to-end validation tests #198
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Reviewer's GuideThis PR enhances GitHub Actions workflows to support bootc end-to-end validation tests by upgrading the tox-lsr dependency, applying a temporary podman 5.x workaround on Ubuntu, and extending the qemu-kvm integration workflow with a dedicated QEMU validation step for bootc images. Sequence Diagram of the bootc CI End-to-End Test ExecutionsequenceDiagram
actor User as "Developer/User"
participant GA as "GitHub Actions Workflow"
participant ToxPrep as "Tox (Preparation Environment)"
participant Builder as "Buildah / bootc-image-builder"
participant ArtifactStorage as "Artifact Storage (e.g., tests/tmp/...)"
participant ToxVal as "Tox (Validation Environment)"
participant QEMU as "QEMU VM"
User->>+GA: Pushes code / Creates PR
GA->>+ToxPrep: Trigger Preparation Phase
ToxPrep->>+Builder: Invoke role & bootc image build script (bootc-buildah-qcow.sh)
Builder-->>ArtifactStorage: Store disk.qcow2
ArtifactStorage-->>ToxPrep: disk.qcow2 path
ToxPrep-->>-GA: Preparation Phase Complete
GA->>+ToxVal: Trigger Validation Phase (with disk.qcow2 path)
ToxVal->>+QEMU: Deploy & Boot disk.qcow2
activate QEMU
QEMU-->>ToxVal: VM Booted Successfully
ToxVal->>QEMU: Run Validation Scripts
QEMU-->>ToxVal: Validation Results
deactivate QEMU
ToxVal-->>-GA: Validation Phase Complete
GA-->>-User: Report Overall Test Status
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @richm - I've reviewed your changes - here's some feedback:
- There are repeated
pip install tox-lsr@3.10.0invocations across multiple workflow files – consider extracting the version into a shared variable or reusable step to reduce duplication. - The Podman 5.x pinning workaround manipulates apt sources and preference files without cleanup – please add a cleanup step or a clear TODO to remove this hack once Ubuntu 26.04 LTS is used.
- The new QEMU validation step loops over qcow2 images but doesn’t handle the case where no images are found – consider adding a guard or informative message to avoid silent skips.
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
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>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 ofhttps://github.com/osbuild/bootc-image-builder.
There are two possibilities:
Have separate bootc end-to-end tests. These are tagged with
tests::bootc-e2and 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/cleanupand role invocations in validation mode, i.e. when
__bootc_validationis true.In the container scenario, run the QEMU validation as a separate step in
the workflow.
See https://issues.redhat.com/browse/RHEL-88396