Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Parallelize buildah bud tests #24656

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .cirrus.yml
Original file line number Diff line number Diff line change
Expand Up @@ -976,8 +976,8 @@ buildah_bud_test_task:
PODBIN_NAME: podman
- env:
PODBIN_NAME: remote
gce_instance: *standardvm
timeout_in: 45m
gce_instance: *fastvm
timeout_in: 30m
clone_script: *get_gosrc
setup_script: *setup
main_script: *main
Expand Down
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ require (
github.com/checkpoint-restore/checkpointctl v1.3.0
github.com/checkpoint-restore/go-criu/v7 v7.2.0
github.com/containernetworking/plugins v1.5.1
github.com/containers/buildah v1.38.1-0.20241119213149-52437ef15d33
github.com/containers/buildah v1.38.1-0.20241122025341-998312277d88
github.com/containers/common v0.61.1-0.20241112152446-305e9ce69b0f
github.com/containers/conmon v2.0.20+incompatible
github.com/containers/gvisor-tap-vsock v0.8.0
Expand Down
4 changes: 2 additions & 2 deletions go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,8 @@ github.com/containernetworking/cni v1.2.3 h1:hhOcjNVUQTnzdRJ6alC5XF+wd9mfGIUaj8F
github.com/containernetworking/cni v1.2.3/go.mod h1:DuLgF+aPd3DzcTQTtp/Nvl1Kim23oFKdm2okJzBQA5M=
github.com/containernetworking/plugins v1.5.1 h1:T5ji+LPYjjgW0QM+KyrigZbLsZ8jaX+E5J/EcKOE4gQ=
github.com/containernetworking/plugins v1.5.1/go.mod h1:MIQfgMayGuHYs0XdNudf31cLLAC+i242hNm6KuDGqCM=
github.com/containers/buildah v1.38.1-0.20241119213149-52437ef15d33 h1:Ih6KuyByK7ZGGzkS0M5rVBPLWIyeDvdL5klhsKBo8vA=
github.com/containers/buildah v1.38.1-0.20241119213149-52437ef15d33/go.mod h1:RxIuKhwTpRl3ma4d4BF6QzSSeg9zNNvo/xhYJOKeDQs=
github.com/containers/buildah v1.38.1-0.20241122025341-998312277d88 h1:Xa1sfUgLrIuXx5q3JtyQmg/6suD/lWu0PqcdGFQFrSU=
github.com/containers/buildah v1.38.1-0.20241122025341-998312277d88/go.mod h1:RxIuKhwTpRl3ma4d4BF6QzSSeg9zNNvo/xhYJOKeDQs=
github.com/containers/common v0.61.1-0.20241112152446-305e9ce69b0f h1:K3jmJrkDJJhLnRdVFI7Gb5mv4/jb2ue9StZ2F1y2rsE=
github.com/containers/common v0.61.1-0.20241112152446-305e9ce69b0f/go.mod h1:NGRISq2vTFPSbhNqj6MLwyes4tWSlCnqbJg7R77B8xc=
github.com/containers/conmon v2.0.20+incompatible h1:YbCVSFSCqFjjVwHTPINGdMX1F6JXHGTUje2ZYobNrkg=
Expand Down
5 changes: 5 additions & 0 deletions test/buildah-bud/apply-podman-deltas
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,11 @@ skip "podman-build fails with 'context must be a directory'" \
skip "does not pass in Podman CI: needs investigation" \
"bud with --no-hostname"

# 2024-11-22 not really a useful test of podman (the push/pull uses buildah binary)
# and it flakes when run in parallel. We choose to go with CI speed.
skip "not a useful podman test, and it breaks when run parallel" \
"bud: build push with --force-compression"

###############################################################################
# BEGIN tests which are skipped because they make no sense under podman-remote

Expand Down
51 changes: 29 additions & 22 deletions test/buildah-bud/buildah-tests.diff
Original file line number Diff line number Diff line change
@@ -1,21 +1,22 @@
From d7839d93860915b2a43c486d0fed89fee7313ec0 Mon Sep 17 00:00:00 2001
From 42a2977ef907112fd48575bcf69aef7847726a9b Mon Sep 17 00:00:00 2001
From: Ed Santiago <[email protected]>
Date: Thu, 6 Oct 2022 17:32:59 -0600
Subject: [PATCH] tweaks for running buildah tests under podman

Signed-off-by: Ed Santiago <[email protected]>
---
tests/helpers.bash | 119 +++++++++++++++++++++++++++++++++++++++++++--
1 file changed, 115 insertions(+), 4 deletions(-)
tests/helpers.bash | 126 +++++++++++++++++++++++++++++++++++++++++++--
1 file changed, 122 insertions(+), 4 deletions(-)

diff --git a/tests/helpers.bash b/tests/helpers.bash
index f8ab624a8..0d8f5ce69 100644
index ed5de994e..8f82a9fd4 100644
--- a/tests/helpers.bash
+++ b/tests/helpers.bash
@@ -80,6 +80,38 @@ EOF
@@ -80,6 +80,42 @@ EOF
BUILDAH_REGISTRY_OPTS="${regconfopt} ${regconfdir} --short-name-alias-conf ${TEST_SCRATCH_DIR}/cache/shortnames.conf"
COPY_REGISTRY_OPTS="${BUILDAH_REGISTRY_OPTS}"
PODMAN_REGISTRY_OPTS="${regconfopt}"
+ PODMAN_REMOTE_OPTS=
+
+ PODMAN_SERVER_PID=
+ PODMAN_NATIVE="${PODMAN_BINARY} ${ROOTDIR_OPTS} ${PODMAN_REGISTRY_OPTS}"
Expand All @@ -32,26 +33,29 @@ index f8ab624a8..0d8f5ce69 100644
+ local sockdir=/run
+ if is_rootless; then
+ sockdir=${XDG_RUNTIME_DIR:-/run/user/$(id -u)}
+ mkdir -p ${sockdir}/podman
+ fi
+ PODMAN_SOCK_FILE=$sockdir/podman/podman.sock
+ PODMAN_SOCK_FILE=$sockdir/podman/podman-${BATS_SUITE_TEST_NUMBER}.sock
+ PODMAN_REMOTE_OPTS="--url unix://${PODMAN_SOCK_FILE}"
+ # static CONTAINERS_CONF needed for capabilities test. As of 2021-07-01
+ # no tests in bud.bats override this; if at some point any test does
+ # so, it will probably need to be skip_if_remote()d.
+ env CONTAINERS_CONF_OVERRIDE=${CONTAINERS_CONF_OVERRIDE:-$(dirname ${BASH_SOURCE})/containers.conf} $PODMAN_NATIVE system service --log-level=info --timeout=0 &>>${PODMAN_SERVER_LOG:-/dev/stderr} &
+ echo "$_LOG_PROMPT $PODMAN_NATIVE system service [...] unix://${PODMAN_SOCK_FILE}" >&2
+ env CONTAINERS_CONF_OVERRIDE=${CONTAINERS_CONF_OVERRIDE:-$(dirname ${BASH_SOURCE})/containers.conf} $PODMAN_NATIVE system service --log-level=info --timeout=0 unix://${PODMAN_SOCK_FILE} &>>${PODMAN_SERVER_LOG:-/dev/stderr} &
+ PODMAN_SERVER_PID=$!
+ echo ">> pid=$PODMAN_SERVER_PID" >>${PODMAN_SERVER_LOG:-/dev/stderr}
+ local timeout=10
+ local timeout=30
+ while ((timeout > 0)); do
+ test -S $PODMAN_SOCK_FILE && return
+ sleep 0.2
+ timeout=$((timeout - 1))
+ done
+ die "podman server never came up"
+ die "podman server never came up: $PODMAN_SOCK_FILE"
+ fi
}

function starthttpd() { # directory [working-directory-or-"" [certfile, keyfile]]
@@ -144,6 +176,32 @@ function teardown_tests() {
@@ -144,6 +180,35 @@ function teardown_tests() {
stop_git_daemon
stop_registry

Expand All @@ -71,34 +75,37 @@ index f8ab624a8..0d8f5ce69 100644
+ done
+ fi
+
+ # FIXME! 2024-11-22: I have no idea if this is still relevant, but it
+ # certainly does not play well with parallel bats tests. Let's see
+ # what happens if we disable it.
+ # FIXME! 2023-04-11: under remote + rootless, on the very first test,
+ # we somehow end up with two podman-system-service jobs. The second one
+ # lingers, and prevents BATS from completing, manifesting as a test hang.
+ if is_rootless; then
+ ps auxww | grep "system service" | grep -v grep | while read user pid rest; do
+ echo "# teardown: killing stray server: $user $pid $rest" >&3
+ kill $pid
+ done
+ fi
+# if is_rootless; then
+# ps auxww | grep "system service" | grep -v grep | while read user pid rest; do
+# echo "# teardown: killing stray server: $user $pid $rest" >&3
+# kill $pid
+# done
+# fi
Comment on lines +78 to +89
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm choosing to leave this in place, instead of deleting it, because I want someone else to practice the bud-tests dance.

You will need to:

  1. Check out this PR
  2. invoke test/buildah-bud/run-buildah-tests --no-test. This will check out the buildah source tree into test-buildah-* and apply some patches
  3. cd there
  4. You will need to git reset --hard, to get rid of the applied skips and error message changes, but before you do so, why not run git diff just so you can get a feel for what things look like in a bud-under-podman scenario?
  5. git reset --hard
  6. edit tests/helpers.bash and remove this block
  7. git commit --amend. Don't worry, this isn't podman, this is a scratch git repo for buildah. Commit message is irrelevant, don't bother changing it, just commit your new changes
  8. ./make-new-buildah-diffs
  9. cd .., back to your podman source tree
  10. git diff, and this is hard to grok because you're diffing a diff patch, but basically it should look like changes in commit hash, line numbers, and one block removed
  11. git commit that, and push your PR, and party on

+
# Workaround for #1991 - buildah + overlayfs leaks mount points.
# Many tests leave behind /var/tmp/.../root/overlay and sub-mounts;
# let's find those and clean them up, otherwise 'rm -rf' fails.
@@ -252,7 +310,12 @@ function copy() {
@@ -265,7 +330,12 @@ function copy() {
}

function podman() {
- command ${PODMAN_BINARY:-podman} ${PODMAN_REGISTRY_OPTS} ${ROOTDIR_OPTS} "$@"
+ local cmd=${PODMAN_BINARY:-podman}
+ local opts="${PODMAN_REGISTRY_OPTS} ${ROOTDIR_OPTS}"
+ if [[ $cmd =~ remote ]]; then
+ opts=
+ opts="${PODMAN_REMOTE_OPTS}"
+ fi
+ command $cmd $opts "$@"
}

# There are various scenarios where we would like to execute `tests` as rootless user, however certain commands like `buildah mount`
@@ -316,8 +379,36 @@ function run_buildah() {
@@ -329,8 +399,36 @@ function run_buildah() {
--retry) retry=3; shift;; # retry network flakes
esac

Expand All @@ -117,7 +124,7 @@ index f8ab624a8..0d8f5ce69 100644
+ podman_or_buildah=${PODMAN_BINARY}
+ _opts="${ROOTDIR_OPTS} ${PODMAN_REGISTRY_OPTS}"
+ if [[ -n "$REMOTE" ]]; then
+ _opts=
+ _opts="${PODMAN_REMOTE_OPTS}"
+ fi
+
+ # Special case: there's one test that invokes git in such
Expand All @@ -136,7 +143,7 @@ index f8ab624a8..0d8f5ce69 100644

# If session is rootless and `buildah mount` is invoked, perform unshare,
# since normal user cannot mount a filesystem unless they're in a user namespace along with its own mount namespace.
@@ -331,8 +422,8 @@ function run_buildah() {
@@ -344,8 +442,8 @@ function run_buildah() {
retry=$(( retry - 1 ))

# stdout is only emitted upon error; this echo is to help a debugger
Expand All @@ -147,7 +154,7 @@ index f8ab624a8..0d8f5ce69 100644
# without "quotes", multiple lines are glommed together into one
if [ -n "$output" ]; then
echo "$output"
@@ -693,6 +784,26 @@ function skip_if_no_unshare() {
@@ -706,6 +804,26 @@ function skip_if_no_unshare() {
fi
}

Expand Down
2 changes: 1 addition & 1 deletion test/buildah-bud/run-buildah-bud-tests
Original file line number Diff line number Diff line change
Expand Up @@ -262,5 +262,5 @@ review the test failure and double-check your changes.
BUILDAH_BINARY=$(pwd)/bin/buildah \
COPY_BINARY=$(pwd)/bin/copy \
INET_BINARY=$(pwd)/bin/inet \
bats "${bats_filter[@]}" tests/bud.bats)
bats -j $(nproc) "${bats_filter[@]}" tests/bud.bats)
fi
16 changes: 10 additions & 6 deletions vendor/github.com/containers/buildah/Makefile

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion vendor/modules.txt
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ github.com/containernetworking/cni/pkg/version
# github.com/containernetworking/plugins v1.5.1
## explicit; go 1.20
github.com/containernetworking/plugins/pkg/ns
# github.com/containers/buildah v1.38.1-0.20241119213149-52437ef15d33
# github.com/containers/buildah v1.38.1-0.20241122025341-998312277d88
## explicit; go 1.22.6
github.com/containers/buildah
github.com/containers/buildah/bind
Expand Down