3

I want to run nested shell command for example like this in Jenkins pipeline:

docker stop $(docker ps -aq)

Unfortunately when I format it into pipeline syntax:

sh('docker stop $(docker ps -aq)')

Jenkins does not seem to run them correctly, but outputs that:

"docker stop" requires at least 1 argument(s).

I tried to run the command under bash like told here: Run bash command on jenkins pipeline But end up with similar issue. Any ideas how to solve this?

Maksim Luzik
  • 5,863
  • 4
  • 36
  • 57

5 Answers5

4

This becomes easier for Jenkins Pipeline if you expand the shell command into two lines:

  • The first to capture the Docker containers that you want to stop.
  • The second to stop those Docker containers captured in the first command.

We use the first line to capture the output of the shell command into a variable:

containers = sh(returnStdout: true, script: 'sudo /usr/bin/docker ps -aq')

We then use the second command to operate on the captured output from the first command stored in a variable:

sh("sudo /usr/bin/docker stop $containers")

Note that the docker command is normally comfortable with the output of docker ps -aq for operating on with its other commands, but if it dislikes the output stored in the variable, you can reformat it like the following:

containers = sh(returnStdout: true, script: 'sudo /usr/bin/docker ps -aq').trim()

This would, for example, strip the leading whitespace and trailing newlines. The Docker CLI normally does not care about that, but some reformatting may prove necessary here.

Since removing the newlines here would result in a long combined container ID, we need to (as you noted) replace it with a whitespace to delimit the container IDs. That would make the formatting for the string stored in the containers variable:

containers = sh(returnStdout: true, script: 'sudo /usr/bin/docker ps -aq').replaceAll("\n", " ")

Matthew Schuchard
  • 25,172
  • 3
  • 47
  • 67
  • Thanks Matt for suggestion. I seems that Jenkins runs the output of the command as the command. I get following error: `[build-abc-pipeline-TEST] Running shell script + docker ps -aq [Pipeline] sh [build-abc-pipeline-TEST] Running shell script + docker stop b21b1d2a85a2 b21b1d2a85a2 + 4c8e17511fd1 /var/lib/jenkins/workspace/abc-TEST@tmp/durable-27835dc3/script.sh: line 3: 4c8e17511fd1: command not found` Looks like the output (container ID) is run as shell command? – Maksim Luzik Nov 21 '17 at 09:34
  • @MaksimLuzik So it works which is good, but the caveat about the formatting seems to be true, so you need to follow my advice on that. – Matthew Schuchard Nov 21 '17 at 12:41
  • You were right Matt, as `docker ps -aq` returns each container ID as its own row, Jenkins was running IDs onwards from 2nd row as commands. I had to replace new line with spaces to make it work, like this: `docker ps -aq |tr "\n" " "` – Maksim Luzik Nov 22 '17 at 11:52
  • 1
    @MaksimLuzik So it looks like `.trim()` would have been a problem since it just removes the newlines and does not insert a space and that would result in a long combined container ID which would not be helpful. `.replaceAll("\n", " ")` would end up being the intrinsic for you. Updating the answer in a bit. – Matthew Schuchard Nov 22 '17 at 12:10
1

I've not used docker stop command this way but syntax is same for docker rm command. Block of pipeline code + OP's line for example:

...
    withEnv(["port=$port", "user=$user", "env=$env"]) {
        sh '''
            ssh -p $port $user@$env docker rm \$(docker ps -aq) || true; \
            ssh -p $port $user@$env docker rmi \$(docker images -aq) || true; \
            ssh -p $port $user@$env docker stop \$(docker ps -aq) || true
        '''
    }
...
R. Adams
  • 55
  • 6
1

Adding to the @Matt's answer,

You need a check for empty container. In case when there is no container available to stop, Jenkins build will fail and throw the following error message

"docker stop" requires at least 1 argument(s).

To handle this, you simply need a check for container availability. Here is the complete code

        stage('Clean docker containers'){
            steps{
                script{
                
                    def doc_containers = sh(returnStdout: true, script: 'docker container ps -aq').replaceAll("\n", " ") 
                    if (doc_containers) {
                        sh "docker stop ${doc_containers}"
                    }
                    
                }
            }
        }
Muhammad Tariq
  • 3,318
  • 5
  • 38
  • 42
0

Have you tried somethink like: 

docker stop `docker ps -aq`

?

user2611877
  • 1
0
          stage('Some stage') {
                steps {
                    script{
                        def doc_containers = sh(returnStdout: true, script: 'docker container ps -aq').replaceAll("\n", " ") 
                        if (doc_containers) {
                            sh "docker rm -f ${doc_containers}"
                        }
                    }
                 }
              }

This worked for me on a centos linux agent

Note: docker rm -f removes all containers even if its running

Akhil
  • 69
  • 1
  • 5