EXPERIMENTAL, AND BROKEN: parallelize podman-remote tests

Not working on my laptop: two tests just hang. Am pushing anyway
as a starting point for some motivated team member. Good luck!

Signed-off-by: Ed Santiago <[email protected]>

test/buildah-bud/buildah-tests.diff

@@ -1,21 +1,22 @@
-From af4e93ad93b38d085bc5a236fc5da0ad4106d7c2 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 ed5de994e..0671a52d8 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}"
@@ -32,26 +33,29 @@ index ed5de994e..0671a52d8 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
 
@@ -71,34 +75,37 @@ index ed5de994e..0671a52d8 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
 +
      # 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.
-@@ -265,7 +323,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`
-@@ -329,8 +392,36 @@ function run_buildah() {
+@@ -329,8 +399,36 @@ function run_buildah() {
          --retry)         retry=3;        shift;;  # retry network flakes
      esac
 
@@ -117,7 +124,7 @@ index ed5de994e..0671a52d8 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
@@ -136,7 +143,7 @@ index ed5de994e..0671a52d8 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.
-@@ -344,8 +435,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
@@ -147,7 +154,7 @@ index ed5de994e..0671a52d8 100644
          # without "quotes", multiple lines are glommed together into one
          if [ -n "$output" ]; then
              echo "$output"
-@@ -706,6 +797,26 @@ function skip_if_no_unshare() {
+@@ -706,6 +804,26 @@ function skip_if_no_unshare() {
    fi
  }