osbuild: tweak how we can mock osbuild slightly #1969

mvo5 · 2025-10-27T07:24:00Z

Tiny commit to tweak the way we allow to change the osbuild binary to run. This is a followup for PR#1965. The main motivation is to unexport osbuild.OSBuildCmd as it is global state and potentially racy, i.e. two threads doing:

osbuild.OSBuildCmd = "foo"
osbuild.RunOSBuild()

and

osbuild.OSBuildCmd = "bar"
osbuild.RunOSBuild()

would potentially race.

I know the risk is small (because this is mean only for testing and tests are run in sequence in the same pkg by default) but if it is ever used outside of tests it can becomes a source of subtle and hard to spot bugs.

The use-case to tweak osbuild.OSBuildCmd to test osbuild.RunOSBuild() from the outside one can just modify PATH to point to a different osbuild binary (we do something similar in e.g. ibcli, i.e. just modifying PATH).

Tiny commit to tweak the way we allow to change the osbuild binary to run. This is a followup for PR#1965. The main motivation is to unexport `osbuild.OSBuildCmd` as it is global state and potentially racy, i.e. two threads doing: ```go osbuild.OSBuildCmd = "foo" osbuild.RunOSBuild() ``` and ```go osbuild.OSBuildCmd = "bar" osbuild.RunOSBuild() ``` would potentially race. I know the risk is small (because this is mean only for testing and tests are run in sequence in the same pkg by default) but if it is ever used outside of tests it can becomes a source of subtle and hard to spot bugs. The use-case to tweak osbuild.OSBuildCmd to test osbuild.RunOSBuild() from the outside one can just modify PATH to point to a different osbuild binary (we do something similar in e.g. ibcli, i.e. just modifying PATH).

croissanne

My original plan was to keep it public so ibcli's tests can use it still. But as you suggested, let's just edit PATH in ibcli's tests.

croissanne · 2025-10-27T10:28:25Z

pkg/osbuild/export_test.go

 	StatusJSON = statusJSON
 )
+
+func MockOsbuildCmd(s string) (restore func()) {


Oh, nitpick, could we make it MockOSBuildCmd ?

(just an inconsistency I've noticed and got annoyed at >.>)

achilleas-k · 2025-10-28T10:49:40Z

Our AWS-based CI runners are not working today. This PR is small and the changes don't affect those builds. Admin merging.

Changes with 0.210.0 ---------------- - Make bootupd metadata generation configurable per distro (osbuild/images#1958) - Author: Paul Whalen, Reviewers: Lukáš Zapletal, Simon de Vlieger - many: add support for bootc container based anaconda ISOs (HMS-9495) (osbuild/images#1906) - Author: Michael Vogt, Reviewers: Achilleas Koutsou, Simon de Vlieger, Tomáš Hozza - osbuild/osbuild-exec: make osbuild command a variable (osbuild/images#1965) - Author: Sanne Raymaekers, Reviewers: Lukáš Zapletal, Simon de Vlieger Changes with 0.211.0 ---------------- - Update osbuild dependency commit ID to latest (osbuild/images#1968) - Author: SchutzBot, Reviewers: Achilleas Koutsou, Simon de Vlieger - Update snapshots to 20251023 (osbuild/images#1967) - Author: SchutzBot, Reviewers: Achilleas Koutsou, Simon de Vlieger - deps: switch yaml libraries (osbuild/images#1970) - Author: Simon de Vlieger, Reviewers: Achilleas Koutsou, Michael Vogt - osbuild/monitor: increase status scanner buffer size to 16MiB (osbuild/images#1977) - Author: Sanne Raymaekers, Reviewers: Michael Vogt, Simon de Vlieger - osbuild: tweak how we can mock osbuild slightly (osbuild/images#1969) - Author: Michael Vogt, Reviewers: Achilleas Koutsou, Sanne Raymaekers - schutzbot/terraform: bump terraform sha (osbuild/images#1976) - Author: Florian Schüller, Reviewers: Achilleas Koutsou, Sanne Raymaekers, Simon de Vlieger Changes with 0.212.0 ---------------- - distro,manifest: have a single `LoraxTemplates` type (osbuild/images#1975) - Author: Michael Vogt, Reviewers: Achilleas Koutsou, Simon de Vlieger - distro: cleanup/reuse YAML for bootc ISO (osbuild/images#1971) - Author: Michael Vogt, Reviewers: Lukáš Zapletal, Simon de Vlieger - distro: cleanup/reuse YAML for bootc distro (osbuild/images#1944) - Author: Michael Vogt, Reviewers: Achilleas Koutsou, Simon de Vlieger - distro: load distros from multiple files (osbuild/images#1974) - Author: Simon de Vlieger, Reviewers: Michael Vogt, Tomáš Hozza - osbuild: switch from a bufio.Scanner to a bufio.Reader (osbuild/images#1978) - Author: Michael Vogt, Reviewers: Lukáš Zapletal, Simon de Vlieger - reporegistry: various cleanups (osbuild/images#1980) - Author: Michael Vogt, Reviewers: Simon de Vlieger, Tomáš Hozza - various: fix `make gh-action-test` and update README (osbuild/images#1981) - Author: Michael Vogt, Reviewers: Lukáš Zapletal, Simon de Vlieger Changes with 0.213.0 ---------------- - data: update fedora 43 repositories (osbuild/images#1983) - Author: Simon de Vlieger, Reviewers: Michael Vogt, Sanne Raymaekers - osbuild-exec: add buildlog and monitor support (osbuild/images#1966) - Author: Sanne Raymaekers, Reviewers: Michael Vogt, Simon de Vlieger

mvo5 requested a review from croissanne October 27, 2025 07:24

mvo5 requested a review from a team as a code owner October 27, 2025 07:24

mvo5 requested review from bcl and supakeen October 27, 2025 07:24

supakeen requested review from lzap and removed request for supakeen October 27, 2025 08:22

croissanne approved these changes Oct 27, 2025

View reviewed changes

croissanne mentioned this pull request Oct 27, 2025

osbuild-exec: add buildlog and monitor support #1966

Merged

croissanne reviewed Oct 27, 2025

View reviewed changes

achilleas-k approved these changes Oct 27, 2025

View reviewed changes

supakeen added this pull request to the merge queue Oct 28, 2025

github-merge-queue bot removed this pull request from the merge queue due to failed status checks Oct 28, 2025

achilleas-k merged commit 9f01e5c into osbuild:main Oct 28, 2025
24 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

osbuild: tweak how we can mock osbuild slightly #1969

osbuild: tweak how we can mock osbuild slightly #1969

Uh oh!

mvo5 commented Oct 27, 2025

Uh oh!

croissanne left a comment

Uh oh!

croissanne Oct 27, 2025

Uh oh!

croissanne Oct 27, 2025

Uh oh!

Uh oh!

achilleas-k commented Oct 28, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

osbuild: tweak how we can mock osbuild slightly #1969

osbuild: tweak how we can mock osbuild slightly #1969

Uh oh!

Conversation

mvo5 commented Oct 27, 2025

Uh oh!

croissanne left a comment

Choose a reason for hiding this comment

Uh oh!

croissanne Oct 27, 2025

Choose a reason for hiding this comment

Uh oh!

croissanne Oct 27, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

achilleas-k commented Oct 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

achilleas-k commented Oct 28, 2025 •

edited

Loading