Merge pull request os-autoinst#23653 from ricardobranco777/docker_cleanup

Move gotestsum install to bats library and normalize docker cleanup

Author: ricardobranco777

lib/containers/bats.pm

@@ -30,6 +30,7 @@ our @EXPORT = qw(
   bats_post_hook
   bats_tests
   go_arch
+  install_gotestsum
   install_ncat
   mount_tmp_vartmp
   patch_junit
@@ -83,6 +84,14 @@ sub install_git {
     run_command "sudo zypper --gpg-auto-import-keys -n install --allow-vendor-change git-core", timeout => 300;
 }
 
+sub install_gotestsum {
+    # We need gotestsum to parse "go test" and create JUnit XML output
+    return if (script_run("command -v gotestsum") == 0);
+    run_command 'export GOPATH=$HOME/go';
+    run_command 'export PATH=$GOPATH/bin:$PATH';
+    run_command 'go install gotest.tools/[email protected]';
+}
+
 sub install_ncat {
     if (is_sle('<16')) {
         # This repo has ncat 7.94

tests/containers/bats/buildah.pm

@@ -67,9 +67,7 @@ sub enable_docker {
 
 # Run conformance tests that compare the output of buildah against Docker's BuildKit
 sub test_conformance {
-    run_command 'export GOPATH=$HOME/go';
-    run_command 'export PATH=$PATH:$GOPATH/bin';
-    run_command 'go install gotest.tools/[email protected]';
+    install_gotestsum;
     run_command 'cp /usr/bin/busybox-static tests/conformance/testdata/mount-targets/true';
     run_command 'docker rmi -f $(docker images -q) || true';
     run_command 'gotestsum --junitfile conformance.xml --format standard-verbose -- ./tests/conformance/... |& tee conformance.txt', timeout => 1200;

tests/containers/bats/skopeo.pm

@@ -35,9 +35,7 @@ sub run_tests {
 }
 
 sub test_integration {
-    run_command 'export GOPATH=$HOME/go';
-    run_command 'export PATH=$PATH:$GOPATH/bin';
-    run_command 'go install gotest.tools/[email protected]';
+    install_gotestsum;
     # We can't use openSUSE's distribution-registry package on SLES so extract this binary from the OCI image
     # Note: registry:latest with v3 fails unlike library/registry:3
     run_command "podman run --rm -v /usr/local/bin:/target:rw,z --user root --entrypoint /bin/cp $registry /bin/registry /target/";

tests/containers/docker_buildx.pm

@@ -21,6 +21,7 @@ sub setup {
     my $self = shift;
     my @pkgs = qw(buildkit distribution-registry docker docker-buildx docker-compose go1.24);
     $self->setup_pkgs(@pkgs);
+    install_gotestsum;
 
     # The tests assume a vanilla configuration
     run_command "mv -f /etc/docker/daemon.json{,.bak}";
@@ -31,11 +32,6 @@ sub setup {
     run_command "systemctl restart docker";
     record_info "docker info", script_output("docker info");
 
-    # We need gotestsum to parse "go test" and create JUnit XML output
-    run_command 'export GOPATH=$HOME/go';
-    run_command 'export PATH=$GOPATH/bin:$PATH';
-    run_command 'go install gotest.tools/[email protected]';
-
     # The tests expect the plugins to be in PATH without the "docker-" prefix
     run_command 'cp /usr/lib/docker/cli-plugins/docker-buildx /usr/local/bin/buildx';
     run_command 'cp /usr/lib/docker/cli-plugins/docker-compose /usr/local/bin/compose';
@@ -74,14 +70,13 @@ sub run {
     upload_logs("buildx.txt");
 }
 
-sub cleanup() {
-    script_run 'rm -vf /usr/local/bin/{buildx,compose}';
+sub cleanup {
     script_run "mv -f /etc/docker/daemon.json{.bak,}";
     script_run "mv -f /etc/sysconfig/docker{.bak,}";
     script_run 'docker rm -vf $(docker ps -aq)';
-    script_run "docker volume prune -a -f";
-    script_run "docker system prune -a -f";
+    script_run "docker system prune -a -f --volumes";
     systemctl "restart docker";
+    script_run 'rm -vf /usr/local/bin/{buildx,compose}';
 }
 
 sub post_fail_hook {

tests/containers/docker_cli.pm

@@ -21,6 +21,7 @@ sub setup {
     my $self = shift;
     my @pkgs = qw(docker docker-compose go1.24 jq make);
     $self->setup_pkgs(@pkgs);
+    install_gotestsum;
 
     # The tests assume a vanilla configuration
     run_command "mv -f /etc/docker/daemon.json{,.bak}";
@@ -43,10 +44,6 @@ sub setup {
         run_command "chmod +x /usr/local/bin/notary";
     }
 
-    # We need gotestsum to parse "go test" and create JUnit XML output
-    run_command 'export GOPATH=$HOME/go';
-    run_command 'export PATH=$PATH:$GOPATH/bin';
-    run_command 'go install gotest.tools/[email protected]';
     # Some tests have /usr/local/go/bin/go hard-coded
     run_command 'ln -s /usr /usr/local/go';
 
@@ -115,17 +112,16 @@ sub run {
     upload_logs("cli.txt");
 }
 
-sub cleanup() {
-    script_run "docker rm -vf registry";
+sub cleanup {
     script_run "COMPOSE_PROJECT_NAME=clie2e COMPOSE_FILE=./e2e/compose-env.yaml docker compose down -v --rmi all";
     script_run "docker swarm leave -f";
-    script_run "docker rmi -f \$(docker images -q)";
-    script_run "docker volume prune -a -f";
-    script_run "docker system prune -a -f";
     script_run "mv -f /etc/docker/daemon.json{.bak,}";
     script_run "mv -f /etc/sysconfig/docker{.bak,}";
     script_run "mv -f /usr/lib/docker/cli-plugins/docker-buildx{.bak,}";
+    script_run 'docker rm -vf $(docker ps -aq)';
+    script_run "docker system prune -a -f --volumes";
     systemctl "restart docker";
+    script_run "rm -f /usr/local/bin/notary";
 }
 
 sub post_fail_hook {

tests/containers/docker_compose.pm

@@ -77,13 +77,20 @@ sub run {
     test $_ foreach (@targets);
 }
 
+sub cleanup {
+    script_run 'docker rm -vf $(docker ps -aq)';
+    script_run "docker system prune -a -f --volumes";
+}
+
 sub post_fail_hook {
     my ($self) = @_;
+    cleanup;
     bats_post_hook;
 }
 
 sub post_run_hook {
     my ($self) = @_;
+    cleanup;
     bats_post_hook;
 }
 

tests/containers/docker_engine.pm

@@ -22,6 +22,7 @@ sub setup {
     my $self = shift;
     my @pkgs = qw(containerd-ctr distribution-registry docker go1.24 make);
     $self->setup_pkgs(@pkgs);
+    install_gotestsum;
 
     # The tests assume a vanilla configuration
     run_command "mv -f /etc/docker/daemon.json{,.bak}";
@@ -34,11 +35,6 @@ sub setup {
     run_command "systemctl restart docker";
     record_info "docker info", script_output("docker info");
 
-    # We need gotestsum to parse "go test" and create JUnit XML output
-    run_command 'export GOPATH=$HOME/go';
-    run_command 'export PATH=$GOPATH/bin:/usr/local/bin:$PATH';
-    run_command 'go install gotest.tools/[email protected]';
-
     # We need ping from GNU inetutils
     run_command 'docker run --rm -it -v /usr/local/bin:/target:rw,z debian sh -c "apt update; apt install -y inetutils-ping; cp -v /bin/ping* /target"', timeout => 120;
     record_info "ping version", script_output("ping --version");
@@ -112,16 +108,14 @@ sub run {
     upload_logs("/var/tmp/report.txt");
 }
 
-sub cleanup() {
-    script_run 'docker rm -vf $(docker ps -aq)';
-    script_run 'docker rmi -f $(docker images -q)';
-    script_run "docker volume prune -a -f";
-    script_run "docker system prune -a -f";
-    script_run "mv -f /etc/docker/daemon.json{.bak,}";
+sub cleanup {
+    script_run "rm -f /usr/local/bin/{ctr,ping}";
     script_run "mv -f /etc/sysconfig/docker{.bak,}";
     script_run "mv -f /usr/lib/docker/cli-plugins/docker-buildx{.bak,}";
-    script_run "rm -f /root/go/bin/docker";
+    script_run 'docker rm -vf $(docker ps -aq)';
+    script_run "docker system prune -a -f --volumes";
     systemctl "restart docker";
+    script_run "mv -f /etc/docker/daemon.json{.bak,}";
 }
 
 sub post_fail_hook {

tests/containers/python_docker.pm

@@ -105,9 +105,13 @@ sub run {
     test "ssh";
 }
 
-sub cleanup() {
+sub cleanup {
     script_run "unset DOCKER_HOST";
-    script_run "mv -f /etc/docker/daemon.json.bak /etc/docker/daemon.json";
+    script_run "mv -f /etc/docker/daemon.json{.bak,}";
+    script_run 'docker rm -vf $(docker ps -aq)';
+    script_run "docker system prune -a -f --volumes";
+    systemctl "restart docker";
+    script_run "rm -f /usr/local/bin/{docker-credential-pass,pass}";
 }
 
 sub post_fail_hook {