CODEWITHSUNDEEP
jenkinsgroovyjenkins-pipelinepipelinefunction-call
manish soni
manish soni

Reputation: 575

Required context class hudson.FilePath is missing Perhaps you forgot to surround the code with a step that provides this, such as: node

When i load another groovy file in Jenkinsfile it show me following error.

"Required context class hudson.FilePath is missing Perhaps you forgot to surround the code with a step that provides this, such as: node"

I made a groovy file which contains a function and i want to call it in my Declarative Jenkinsfile. but it shows an error.

My Jenkinsfile--->

def myfun = load 'testfun.groovy'
pipeline{
    agent any
    environment{
        REPO_PATH='/home/manish/Desktop'
        APP_NAME='test'
    }
    stages{
        stage('calling function'){
            steps{
                script{
                    myfun('${REPO_PATH}','${APP_NAME}')
                }
             }
         }
     }
  }

Result--

org.jenkinsci.plugins.workflow.steps.MissingContextVariableException: Required context class hudson.FilePath is missing Perhaps you forgot to surround the code with a step that provides this, such as: node

Suggest me what is the right way to do it.

Upvotes: 24

Views: 82399

Answers (5)

PHZ.fi-Pharazon
PHZ.fi-Pharazon

Reputation: 2073

Another possibility is that due to earlier/underlying errors, the context has been removed for example by multiple executor machines. This happens if you are missing the node (e.g. script) -block, but especially at the post always -block. You can use the if -check also in other places. After this you get another error, that was causing this error message.

post {
  always {
    script {
       //skip the step if context is missing
       if (getContext(hudson.FilePath)) {
         echo "It works"
       }
     }
   }
 }

See https://docs.cloudbees.com/docs/cloudbees-ci-kb/latest/troubleshooting-guides/how-to-troubleshoot-hudson-filepath-is-missing-in-pipeline-run

Upvotes: 4

devatherock
devatherock

Reputation: 4911

Loading the function in an initial script block inside the pipeline worked for me. Something like below:

def myfun

pipeline {
    agent any
    environment {
        REPO_PATH='/home/manish/Desktop'
        APP_NAME='test'
    }
    stages {
        stage('load function') {
            steps {
                script {
                    myfun = load 'testfun.groovy'
                }
            }
        }
        stage('calling function') {
            steps {
                script {
                    myfun("${REPO_PATH}","${APP_NAME}")
                }
            }
        }
    }
}

Upvotes: 2

PHZ.fi-Pharazon
PHZ.fi-Pharazon

Reputation: 2073

I got this error message when I was calling a sh script that does not not exist in the repository / file system. Please look in the stack trace the following line:

at WorkflowScript.run(WorkflowScript:135)

The 135 marks the line in Jenkinsfile, on which the missing script or error is happening.

Upvotes: 1

Suresh Kandru
Suresh Kandru

Reputation: 118

We have to wrap with node {}, so that jenkins executors will execute on node, Incase if we would like to execute on any specific agent node, we can mention like node('agent name'){}

example here : 

node {

def myfun = load 'testfun.groovy'
pipeline{
    agent any
    environment{
        REPO_PATH='/home/manish/Desktop'
        APP_NAME='test'
    }
    stages{
        stage('calling function'){
            steps{
                script{
                    myfun('${REPO_PATH}','${APP_NAME}')
                }
             }
         }
     }
  }

}

Upvotes: 1

quietbird
quietbird

Reputation: 125

You either need to use a scripted pipeline and put "load" instruction inside the node section (see this question) or if you are already using a declarative pipeline (which seems to be the case), you can include it in "environment" section:

environment {
    REPO_PATH='/home/manish/Desktop'
    APP_NAME='test'
    MY_FUN = load 'testfun.groovy'
}

Upvotes: 6

Related Questions