Running klocwork scan on docker agent

[jenkinsci]

Running klocwork scan on docker agent

[michael-baron]

Hi,

The plugin requires the path for the location of the Klocwork tools to be set. For a pipeline job you can add:

PATH = "/tmp/klocwork/latest/bin:$PATH"

to the environment section of your pipeline. This should resolve the issue with the location of the tools being unknown.

Best Regards,

Michael

[grzegorz-kotarski]

Hi,

The plugin requires the path for the location of the Klocwork tools to be set. For a pipeline job you can add:

PATH = "/tmp/klocwork/latest/bin:$PATH"

to the environment section of your pipeline. This should resolve the issue with the location of the tools being unknown.

Best Regards,

Michael

Hi Michael,

It does not work, it looks like it is related to https://issues.jenkins.io/browse/JENKINS-48082

See example pipeline code:

stage('Docker') {
        agent {
          docker {
            image '<MY_IMAGE>'
          }
        }
        steps {
            echo 'Docker:'
            withEnv(['PATH+WHATEVER=/tmp/klocwork']) {
                echo "env.PATH=${env.PATH}"
                sh 'echo sh PATH = $PATH'
                sh '''#!/usr/bin/env bash
                echo bash PATH = $PATH
                '''
            }
        }
    }
    stage('Master') {
        agent {
          label 'master'
        }
        steps {
            echo 'Master:'
            withEnv(['PATH+WHATEVER=/tmp/klocwork']) {
                echo "env.PATH=${env.PATH}"
                sh 'echo sh PATH = $PATH'
                sh '''#!/usr/bin/env bash
                echo bash PATH = $PATH
                '''
            }
        }
    }

The result of its execution is:

$ docker run -t -d -u 1002:120 -v /home/jenkins/.ssh:/home/jenkins/.ssh -w /home/jenkins/workspace/my-pipeline -v /home/jenkins/workspace/my-pipeline:/home/jenkins/workspace/my-pipeline:rw,z -v /home/jenkins/workspace/my-pipeline_tmp:/home/jenkins/workspace/my-pipeline_tmp:rw,z -e ******** -e ******** -e ******** -e ******** -e ******** -e ******** -e ******** -e ******** -e ******** -e ******** -e ******** -e ******** -e ******** -e ******** -e ******** -e ******** -e ******** -e ******** -e ******** -e ******** -e ******** -e ******** -e ******** -e ******** -e ******** -e ******** -e ******** -e ******** <MY_IMAGE> cat
$ docker top ae03c529a78bd9a947bb948bd5e9c428343997de60305d4b741f722d07712345 -eo pid,comm
[Pipeline] {
[Pipeline] echo
Docker:
[Pipeline] withEnv
[Pipeline] {
[Pipeline] echo
env.PATH=/tmp/klocwork:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/games:/usr/local/games:/snap/bin
[Pipeline] sh
+ echo sh PATH = /usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
sh PATH = /usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
[Pipeline] sh
bash PATH = /usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
[Pipeline] }
[Pipeline] // withEnv
[Pipeline] }
$ docker stop --time=1 ae03c529a78bd9a947bb948bd5e9c428343997de60305d4b741f722d07712345
$ docker rm -f ae03c529a78bd9a947bb948bd5e9c428343997de60305d4b741f722d07712345
[Pipeline] // withDockerContainer
[Pipeline] }
[Pipeline] // node
[Pipeline] }
[Pipeline] // stage
[Pipeline] stage
[Pipeline] { (Master)
[Pipeline] node
Running on Jenkins in /var/jenkins_home/workspace/my-node
[Pipeline] {
[Pipeline] echo
Master:
[Pipeline] withEnv
[Pipeline] {
[Pipeline] echo
env.PATH=/tmp/klocwork:/opt/java/openjdk/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
[Pipeline] sh
+ echo sh PATH = /tmp/klocwork:/opt/java/openjdk/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
sh PATH = /tmp/klocwork:/opt/java/openjdk/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
[Pipeline] sh
bash PATH = /tmp/klocwork:/opt/java/openjdk/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin

As you can see for docker the env. variable has not changed.

Best Regards,
Greg

[grzegorz-kotarski]

An "ugly" workaround would be to set the PATH variable using docker args:

docker {
    image '<MY_IMAGE>'
    args '-e PATH=$PATH:/tmp/klocwork/latest/bin'