When refreshing the pipeline testing output it be useful to add the following in the build.gradle to allow running doing a "gradle -Dpipeline.stack.write=true test --tests *" to refresh all the stack traces?

test {
systemProperty "pipeline.stack.write", System.properties["pipeline.stack.write"]
}

Please add a license so I know the conditions for usage of this example

Recent versions of the PipelineUnitTests (1.2+) moved the PipelineTestHelper to a Singleton class. PipelineSpockTestBase currently instantiates a new instance each time a test is run, which seems wasteful.

I have added a static field to store the singleton instance, and just run setUp() on in the setup() method. This reduced my test time from ~5 minutes to ~20 seconds (for 165 tests).

class PipelineSpockTestBase extends Specification implements RegressionTest {

    /**
     * Delegate to the test helper
     */
    @Delegate PipelineTestHelper pipelineTestHelper

    static internalPipelineHelper = new PipelineTestHelper()
    /**
     * Do the common setup
     */
    def setup() {

        // Set callstacks path for RegressionTest
        callStackPath = 'pipelineTests/groovy/tests/callstacks/'

        // Create and config the helper
        pipelineTestHelper = internalPipelineHelper
        pipelineTestHelper.setUp()
    }
}

sorry i am a noob with this frameowrk, any help in identifying the below issue is appreciated!

Unit Test cases fail with below error when three double quotes are used along with sh in Jenkinsfile

problem is when i use three double quotes without which i cannot get the value of groovy variable

Jenkinsfile Stage

stage('duration') {
steps{
withCredentials([string(credentialsId: 'GH_TOKEN', variable: 'GH_TOKEN'), usernamePassword(credentialsId: '', passwordVariable: 'dbpassword', usernameVariable: 'dbuser')]) {
script {
currentBuild.displayName = "$ghprbPullId"
sh """
echo ${currentBuild.durationString.replace(' and counting', '')} > duration.txt
cat duration.txt
"""
}
}
}
}

Error from Unit test case

tests.job.CIPipelineTest > validate the pipeline FAILED
org.codehaus.groovy.control.MultipleCompilationErrorsException at CIPipelineTest.groovy:18

tests.job.CIPipelineTest > validate shell command[0] FAILED
org.codehaus.groovy.control.MultipleCompilationErrorsException at CIPipelineTest.groovy:34

tests.job.CIPipelineTest > validate shell command[1] FAILED
org.codehaus.groovy.control.MultipleCompilationErrorsException at CIPipelineTest.groovy:34

tests.job.CIPipelineTest > validate shell command[2] FAILED
org.codehaus.groovy.control.MultipleCompilationErrorsException at CIPipelineTest.groovy:34

tests.job.CIPipelineTest > validate shell command[3] FAILED
org.codehaus.groovy.control.MultipleCompilationErrorsException at CIPipelineTest.groovy:34

tests.job.CIPipelineTest > validate shell command[4] FAILED
org.codehaus.groovy.control.MultipleCompilationErrorsException at CIPipelineTest.groovy:34

tests.job.CIPipelineTest > validate shell command[5] FAILED
org.codehaus.groovy.control.MultipleCompilationErrorsException at CIPipelineTest.groovy:34

tests.job.CIPipelineTest > validate shell command[6] FAILED
org.codehaus.groovy.control.MultipleCompilationErrorsException at CIPipelineTest.groovy:34

tests.job.CIPipelineTest > validate shell command[7] FAILED
org.codehaus.groovy.control.MultipleCompilationErrorsException at CIPipelineTest.groovy:34

tests.job.CIPipelineTest > validate shell command[8] FAILED
org.codehaus.groovy.control.MultipleCompilationErrorsException at CIPipelineTest.groovy:34

tests.job.CIPipelineTest > validate shell command[9] FAILED
org.codehaus.groovy.control.MultipleCompilationErrorsException at CIPipelineTest.groovy:34

11 tests completed, 11 failed
:test FAILED

I think instead of raising the exception it should be swallowed and setting the build status to failed:

...
catch (Exception e) {
    // Some sort of error in the pipeline
    binding.getVariable('currentBuild').result = 'FAILURE'
}
...

Probably somewhere else as well?

Error when testing pipeline library file that has more than one parameters:

err:

groovy.lang.MissingMethodException: No signature of method: addPolicy.call() is applicable for argument types: (tests.library.runAddPolicySpec$__spock_feature_1_0_closure1) values: [tests.library.runAddPolicySpec$__spock_feature_1_0_closure1@17a6c499]
Possible solutions: wait(), any(), wait(long), call(java.lang.String, java.lang.String, java.lang.String, java.lang.String), main([Ljava.lang.String;), each(groovy.lang.Closure)
	at com.lesfurets.jenkins.unit.PipelineTestHelper$_closure4.doCall(PipelineTestHelper.groovy:182)
	at com.lesfurets.jenkins.unit.PipelineTestHelper$_closure3.doCall(PipelineTestHelper.groovy:143)
	at tests.library.runAddPolicySpec.test myshared library code(TestAddPolicy.groovy:25)

vars/addPolicy.groovy:

def call(String bucketName, String arnToAdd, String profile, String region) {
  ...
}

test:

class runAddPolicySpec extends PipelineSpockTestBase {

    def "test myshared library code"() {

        given:
        def paramsPassed = {
            bucketName= "..."
            arnToAdd= "..." 
            profile="..."
            region="..."
        }
        callStackPath = 'src'

        when:
        def script = loadScript('vars/addPolicy.groovy')
        script.call(paramsPassed)

        then:
        printCallStack()
        assertJobStatusSuccess()
    }
}

...while the given example test with one parameter works:
exampleJob.jenkins with body def call(body) {

Is this a bug or i should do something differently?

Hi @macg33zr,

i do really appreciate your work done here! I saw the code, mostly under testsupport copy'd into several projects. Have you thought about putting it into maven central?

Regards, Max

When Jenkinsfile was renamed, e.g. x.jenkins and the path in the test as well, the gradle build fails:

when cloned:

gradle clean build

BUILD SUCCESSFUL in 8s
4 actionable tasks: 4 executed

when Jenkinsfile renamed

gradle clean build

> Task :test 

tests.job.JenkinsfileTestSpec > Jenkinsfile should run gradle tests with expected command line validate:null gradle: null FAILED
    groovy.util.ResourceException at JenkinsfileTestSpec.groovy:26
        Caused by: groovy.util.ResourceException at JenkinsfileTestSpec.groovy:26

Then I thought perhaps there is another jenkins file. This was the case, i.e. ./exampleJobs/parallel/Jenkinsfile and when this was renamed the issue persisted.

Should all Jenkins. entries that reside in the test files be renamed as well?

I have a common code in src folder, in package com.mycom.utils File : CommonStages.groovy Code:

    package com.mycom.utils
    def execute() {
      stage('some stage') {
        node ('someNode'){
          Println env.someenv
          
          }
         }
        }

Am getting no signature of method error com.mycom.utils.commonstages.stage() Is applicable for argument types: (java.lang.String, com.mycom.utils.commonsatges$_execute_closure1)

If the code is in jenkinsfile it executes but when I add it to the package structure it fails

test case using spock:

        def "common pipeline"() {
        given:
       

    when:

          helper.registerAllowedMethod('node', [Closure.class], null)
         helper.registerAllowedMethod("stage", [String.class], null)

         addEnvVar('PIPELINE_TYPE', 'PIPELINE_TYPE')
         def script = loadScript('Jenkinsfile')
        then:
        printCallStack()
      }

Hello, I'm familiar with the javascript/python ecosystem but I know almost nothing about the java ecosystem. I've been trying to learn how to use this use pipelineUnit but I can't figure it out.

I gather that I need to be familiar with

• Graddle
• JUnit
• Java
• Groovy
• Jenkinsfile

Is there anything else I should be familiar with before being able to use this package?

If I'm using a withEnv block in my Jenkinsfile and the value of my variable contains an equals symbol (which is often the case when setting JVM options for example) then Pipeline Unit is unable to add the environment variables correctly.

Eg.
withEnv(['JVM_OPTS="-Dhttps.proxyHost=some.host"'])

I need some of the new features in JenkinsPipelineUnit 1.1 (e.g. Windows build support). When using JenkinsPipelineUnit 0.12 your example works. When I tried upgrading your example here by changing the dependency to "com.lesfurets:jenkins-pipeline-unit:1.1" I get errors like the following. I don't know spock well enough to debug what has changed. Do you have any ideas?

Too few invocations for:

1 * shellMock.call(_) >> { args ->

            def shellCmd = args[0]
            assert shellCmd == GRADLE_EXPECTED_CMD
        }   (0 invocations)

Unmatched invocations (ordered by similarity):

None


Too few invocations for:

1 * shellMock.call(_) >> { args ->

            def shellCmd = args[0]
            assert shellCmd == GRADLE_EXPECTED_CMD
        }   (0 invocations)

Unmatched invocations (ordered by similarity):

None

	at org.spockframework.mock.runtime.InteractionScope.verifyInteractions(InteractionScope.java:78)
	at org.spockframework.mock.runtime.MockController.leaveScope(MockController.java:76)
	at tests.job.JenkinsfileTestSpec.Jenkinsfile should run gradle tests with expected command line validate:#P_VALIDATE gradle: #P_GRADLE_TASKS_OPTIONS(JenkinsfileTestSpec.groovy:24)