test: move bib tests from bootc-image-builder

Move the integration tests from bootc-image-builder into
image-builder. With bootc-image-builder being merged into
image-builder we still want to run the integration tests
for bib because our goal is 100% compatibility. Note that
this does not preserve history. There is a PR [0] that
does that and while I'm a big fan in general I am not
sure its worth the trouble because GH will not allow us
to merge the repos and we need to manually force push
it. The history of the tests is still fully available
in the bootc-image-builder repo in cases it is needed.

[0] osbuild#398

Author: mvo5

test/bib/conftest.py

@@ -0,0 +1,29 @@
+import pytest
+
+# pylint: disable=wrong-import-order
+from testcases import TestCase
+from vmtest.util import get_free_port
+
+
+def pytest_addoption(parser):
+    parser.addoption("--force-aws-upload", action="store_true", default=False,
+                     help=("Force AWS upload when building AMI, failing if credentials are not set. "
+                           "If not set, the upload will be performed only when credentials are available."))
+
+
+@pytest.fixture(name="force_aws_upload", scope="session")
+def force_aws_upload_fixture(request):
+    return request.config.getoption("--force-aws-upload")
+
+
+# see https://hackebrot.github.io/pytest-tricks/param_id_func/ and
+# https://docs.pytest.org/en/7.1.x/reference/reference.html#pytest.hookspec.pytest_make_parametrize_id
+def pytest_make_parametrize_id(config, val):  # pylint: disable=W0613
+    if isinstance(val, TestCase):
+        return f"{val}"
+    return None
+
+
+@pytest.fixture(name="free_port")
+def free_port_fixture():
+    return get_free_port()

test/bib/containerbuild.py

@@ -0,0 +1,148 @@
+import os
+import platform
+import random
+import string
+import subprocess
+import textwrap
+from contextlib import contextmanager
+
+import pytest
+
+
+@contextmanager
+def make_container(container_path, arch=None):
+    # BIB only supports container tags, not hashes
+    container_tag = "bib-test-" + "".join(random.choices(string.digits, k=12))
+
+    if not arch:
+        # Always provide an architecture here because without that the default
+        # behavior is to pull whatever arch was pulled for this image ref
+        # last but we want "native" if nothing else is specified.
+        #
+        # Note: podman seems to translate kernel arch to go arches
+        # automatically it seems.
+        arch = platform.uname().machine
+
+    subprocess.check_call([
+        "podman", "build",
+        "--cache-ttl=1h",
+        "-t", container_tag,
+        "--arch", arch,
+        container_path], encoding="utf8")
+    yield container_tag
+    subprocess.check_call(["podman", "rmi", container_tag])
+
+
+@pytest.fixture(name="build_container", scope="session")
+def build_container_fixture():
+    """Build a container from the Containerfile and returns the name"""
+    if tag_from_env := os.getenv("BIB_TEST_BUILD_CONTAINER_TAG"):
+        return tag_from_env
+
+    container_tag = "bootc-image-builder-test"
+    subprocess.check_call([
+        "podman", "build",
+        "--cache-ttl=1h",
+        "-f", "Containerfile",
+        "-t", container_tag,
+    ])
+    return container_tag
+
+
+@pytest.fixture(name="build_fake_container", scope="session")
+def build_fake_container_fixture(tmpdir_factory, build_container):
+    """Build a container with a fake osbuild and returns the name"""
+    tmp_path = tmpdir_factory.mktemp("build-fake-container")
+
+    # see https://github.com/osbuild/osbuild/blob/main/osbuild/testutil/__init__.py#L91
+    tracing_podman_path = tmp_path / "tracing-podman"
+    tracing_podman_path.write_text(textwrap.dedent("""\
+    #!/bin/sh -e
+
+    TRACE_PATH=/output/"$(basename $0)".log
+    for arg in "$@"; do
+        echo "$arg" >> "$TRACE_PATH"
+    done
+    # extra separator to differenciate between calls
+    echo >> "$TRACE_PATH"
+    exec "$0".real "$@"
+    """), encoding="utf8")
+
+    fake_osbuild_path = tmp_path / "fake-osbuild"
+    fake_osbuild_path.write_text(textwrap.dedent("""\
+    #!/bin/bash -e
+
+    # injest generated manifest from the images library, if we do not
+    # do this images may fail with "broken" pipe errors
+    cat - >/dev/null
+
+    mkdir -p /output/qcow2
+    echo "fake-disk.qcow2" > /output/qcow2/disk.qcow2
+
+    """), encoding="utf8")
+
+    cntf_path = tmp_path / "Containerfile"
+
+    cntf_path.write_text(textwrap.dedent(f"""\n
+    FROM {build_container}
+    COPY fake-osbuild /usr/bin/osbuild
+    RUN chmod 755 /usr/bin/osbuild
+    COPY --from={build_container} /usr/bin/podman /usr/bin/podman.real
+    COPY tracing-podman /usr/bin/podman
+    RUN chmod 755 /usr/bin/podman
+    """), encoding="utf8")
+
+    container_tag = "bootc-image-builder-test-faked-osbuild"
+    subprocess.check_call([
+        "podman", "build",
+        "-t", container_tag,
+        tmp_path,
+    ])
+    return container_tag
+
+
+@pytest.fixture(name="build_erroring_container", scope="session")
+def build_erroring_container_fixture(tmpdir_factory, build_container):
+    """Build a container with a erroring osbuild and returns the name"""
+    tmp_path = tmpdir_factory.mktemp("build-fake-container")
+
+    # this ensures there are messages from osbuild itself that
+    # we can reliably test for
+    wrapping_osbuild_path = tmp_path / "wrapping-osbuild"
+    wrapping_osbuild_path.write_text(textwrap.dedent("""\
+    #!/bin/sh -e
+    echo "output-from-osbuild-stdout"
+    >&2 echo "output-from-osbuild-stderr"
+
+    exec /usr/bin/osbuild.real "$@"
+    """), encoding="utf8")
+
+    # this ensures we have a failing stage and failure messages
+    bad_stage_path = tmp_path / "bad-stage"
+    bad_stage_path.write_text(textwrap.dedent("""\
+    #!/bin/sh -e
+    echo osbuild-stage-stdout-output
+    >&2 echo osbuild-stage-stderr-output
+    exit 112
+    """), encoding="utf8")
+
+    cntf_path = tmp_path / "Containerfile"
+    cntf_path.write_text(textwrap.dedent(f"""\n
+    FROM {build_container}
+    # ensure there is osbuild output
+    COPY --from={build_container} /usr/bin/osbuild /usr/bin/osbuild.real
+    COPY wrapping-osbuild /usr/bin/osbuild
+    RUN chmod 755 /usr/bin/osbuild
+
+    # we break org.osbuild.selinux as runs early and is used everywhere
+    COPY bad-stage /usr/lib/osbuild/stages/org.osbuild.selinux
+    RUN chmod +x /usr/lib/osbuild/stages/org.osbuild.selinux
+    """), encoding="utf8")
+
+    container_tag = "bootc-image-builder-test--osbuild"
+    subprocess.check_call([
+        "podman", "build",
+        "-t", container_tag,
+        tmp_path,
+    ])
+    return container_tag

test/bib/requirements.txt

@@ -0,0 +1,6 @@
+pytest==7.4.3
+flake8==6.1.0
+boto3==1.33.13
+qmp==1.1.0
+pylint==3.2.5
+vmtest @ git+https://github.com/osbuild/images.git

test/bib/test_build_cross.py

@@ -0,0 +1,23 @@
+import platform
+
+import pytest
+
+from testcases import gen_testcases
+
+from test_build_disk import (  # pylint: disable=unused-import
+    assert_disk_image_boots,
+    build_container_fixture,
+    gpg_conf_fixture,
+    image_type_fixture,
+    registry_conf_fixture,
+    shared_tmpdir_fixture,
+)
+
+
+# This testcase is not part of "test_build_disk.py:test_image_boots"
+# because it takes ~30min on the GH runners so moving it into a
+# separate file ensures it is run in parallel on GH.
+@pytest.mark.skipif(platform.system() != "Linux", reason="boot test only runs on linux right now")
+@pytest.mark.parametrize("image_type", gen_testcases("qemu-cross"), indirect=["image_type"])
+def test_image_boots_cross(image_type):
+    assert_disk_image_boots(image_type)