Merge pull request #257 from dwnusbaum/test-fixes

Fix WithContainerStepTest.stop and WithContainerStepTest.death

Author: dwnusbaum

src/main/java/org/jenkinsci/plugins/docker/workflow/WithContainerStep.java

@@ -350,6 +350,15 @@ private static class Decorator extends LauncherDecorator implements Serializable
                 @Override public void kill(Map<String,String> modelEnvVars) throws IOException, InterruptedException {
                     ByteArrayOutputStream baos = new ByteArrayOutputStream();
                     String executable = getExecutable();
+                    // For this code to be able to successfully kill processes:
+                    // 1: The image must contain `ps`, which notably excludes slim variants of Debian.
+                    // 2. The version of `ps` being used must support `-o command`. Busybox does not (so no Alpine!).
+                    //    `-o args` seems to be a more portable equivalent, but even then, see JENKINS-52881.
+                    // 3. The version of `ps` being used must support the `e` output modifier to include environment
+                    //    variables in the command's output. Otherwise, the output only includes `jsc=<cookie here>` and
+                    //    `JENKINS_SERVER_COOKIE=$jsc`, but the output must include `JENKINS_SERVER_COOKIE=<cookie here>
+                    //    for this code to work.
+                    // In practice, this means that this code only works with images that include procps.
                     if (getInner().launch().cmds(executable, "exec", container, "ps", "-A", "-o", "pid,command", "e").stdout(baos).quiet(true).start().joinWithTimeout(DockerClient.CLIENT_TIMEOUT, TimeUnit.SECONDS, listener) != 0) {
                         throw new IOException("failed to run ps");
                     }

src/test/java/org/jenkinsci/plugins/docker/workflow/WithContainerStepTest.java

@@ -164,7 +164,7 @@ public class WithContainerStepTest {
                 WorkflowJob p = story.j.jenkins.createProject(WorkflowJob.class, "prj");
                 p.setDefinition(new CpsFlowDefinition(
                     "node {\n" +
-                    "  withDockerContainer('httpd:2.4.12') {\n" +
+                    "  withDockerContainer('ubuntu:kinetic-20220602') {\n" +
                     "    sh 'trap \\'echo got SIGTERM\\' TERM; trap \\'echo exiting; exit 99\\' EXIT; echo sleeping now with JENKINS_SERVER_COOKIE=$JENKINS_SERVER_COOKIE; sleep 999'\n" +
                     "  }\n" +
                     "}", true));
@@ -185,8 +185,8 @@ public class WithContainerStepTest {
                 WorkflowJob p = story.j.jenkins.createProject(WorkflowJob.class, "prj");
                 p.setDefinition(new CpsFlowDefinition(
                     "node {\n" +
-                    "  withDockerContainer('httpd:2.4.12') {\n" +
-                    "    sh \"sleep 5; ps -e -o pid,command | egrep '${pwd tmp: true}/durable-.+/script.sh' | fgrep -v grep | sort -n | tr -s ' ' | cut -d ' ' -f2 | xargs kill -9\"\n" +
+                    "  withDockerContainer('httpd:2.4.54-alpine') {\n" +
+                    "    sh \"set -e; sleep 5; ps -e -o pid,args | egrep '${pwd tmp: true}/durable-.+/script.sh' | fgrep -v grep | sort -n | tr -s ' ' | cut -d ' ' -f2 | xargs kill -9\"\n" +
                     "  }\n" +
                     "}", true));
                 Field hci = BourneShellScript.class.getDeclaredField("HEARTBEAT_CHECK_INTERVAL");