mkobit / jenkins-pipeline-shared-library-example

Basic template example of a Jenkins Pipelines Shared Library that is tested using https://github.com/mkobit/jenkins-pipeline-shared-libraries-gradle-plugin

Jenkins Pipeline Shared Library Gradle Plugin

Note	Contributions for examples are welcome!

Purpose

This repository is an example of a Jenkins Jenkins Pipeline Shared Library that uses the Shared Library Gradle Plugin for development and testing of shared libraries.

Explore this project by:

• Importing into IntelliJ

• Activating the resources/idea.gdsl to see how the Jenkins steps auto-completion works

• Build, test, and run integration tests with ./gradlew build

• See how test code is generated for simplifying tests (like com.mkobit.jenkins.pipelines.codegen.LocalLibraryRetriever)

jenkins-pipeline-shared-library-example's Issues

Example test showing usage of JenkinsPipelineUsage

Sort of depends on one of:

• jenkinsci/JenkinsPipelineUnit#64
• jenkinsci/JenkinsPipelineUnit#75

Related to jenkinsci/JenkinsPipelineUnit#70

Add a Groovy build.gradle example

@kleini commented on Thu Mar 15 2018

I would to stay at first with Groovy DSL in build.gradle files. Can you provide an example how to use your plugin in a build.gradle file?

---

@mkobit commented on Thu Mar 15 2018

I think this issue is better suited for https://github.com/mkobit/jenkins-pipeline-shared-library-example - is it alright if I migrate it there?

---

@mkobit commented on Thu Mar 15 2018

A few notes that may be helpful

• https://github.com/mkobit/jenkins-pipeline-shared-libraries-gradle-plugin/tree/01762ba70b05b950dff251dcd99811ed1895bdb0/src/pipelineTestResources/projects has all of the different types of samples that the test suite runs against. Some of those may help for what you are looking for
• https://github.com/mkobit/jenkins-pipeline-shared-libraries-gradle-plugin/blob/01762ba70b05b950dff251dcd99811ed1895bdb0/src/pipelineTestResources/projects/gradle-configuration-groovy/build.gradle is a close approximation of how to configure the build.gradle, but I can add a more specific setup to the other repository

---

@kleini commented on Thu Mar 15 2018

You're right. Migrate it.
Thanks for your hints. I will try to get it working for me and then contribute to your examples.

---

@kleini commented on Thu Mar 15 2018

I already got it working. Why did my first try to reference your plugin from my build.gradle file fail? No idea. I thought it was because it was written in Kotlin. The fault sits always in front of the computer!

How to activate the resources/idea.gdsl

Hi there,
I'm wondering if you can elaborate on this step Activating the resources/idea.gdsl to see how the Jenkins steps auto-completion works? I imported the project but can't find a way to get autocompletion to work. Thanks!

Request for guidance - Breaking the linkage to the obsoleting jcenter

Been having a few problems with the latest edition of your excellent and helpful plugin.
Getting intermittent failures resolving dependencies from jcenter.
I use this plugin to perform unit and integration testing a serveral Jenkins Shared Pipeline Libraries.

Can you offer any specific guidance about to go about removing the jcenter linkage and going with maven central?

Groovyc: unable to resolve class com.mkobit.jenkins.pipelines.codegen.LocalLibraryRetriever

From a clean clone, & import into intellij as gradle project, reports:

Groovyc: unable to resolve class com.mkobit.jenkins.pipelines.codegen.LocalLibraryRetriever

Something missing to resolve this?

Example test showing how to modify whitelist

java.lang.UnsupportedOperationException: no known implementation of class hudson.scm.SCM is named GitSCM

Hi,

I have wrote my code to test this vars declaritive pipeline,

def call(String var_codeRepoBranch, String var_codeRepoUrl) {
node {
try {
checkout([$class: 'GitSCM', branches: [[name: var_codeRepoBranch]], doGenerateSubmoduleConfigurations: false, extensions: [], submoduleCfg: [], userRemoteConfigs: [[credentialsId: 'peidong_bitbucket_eco', url: var_codeRepoUrl]]])
//git branch: var_codeRepoBranch, credentialsId: 'peidong_bitbucket_eco', url: var_codeRepoUrl
echo "first checkout done"
}
}
}

But I got following error in the integrationtest. After debug, I have found that the problem is that gradle sharedlibrary dependency has no plugin, "org.jenkinsci.plugins", "git".

But the latest plugin is in Maven repo, however the program is just trying to download it from jenkins-ci repo, and that repo has only very old git plugin here,
https://repo.jenkins-ci.org/public/org/jenkinsci/plugins/git/

I think the gradle plugin needs to be changed to download the jenkins-ci stuff from maven repo

Running on Jenkins in /tmp/j h2322993632165826436/workspace/project
[Pipeline] {
[Pipeline] checkout
[Pipeline] echo
first checkout failed
[Pipeline] retry
[Pipeline] {
[Pipeline] checkout
[Pipeline] }
ERROR: Execution failed
java.lang.UnsupportedOperationException: no known implementation of class hudson.scm.SCM is named GitSCM
at org.jenkinsci.plugins.structs.describable.DescribableModel.resolveClass(DescribableModel.java:478)
at org.jenkinsci.plugins.structs.describable.DescribableModel.coerce(DescribableModel.java:402)
at org.jenkinsci.plugins.structs.describable.DescribableModel.buildArguments(DescribableModel.java:341)
at org.jenkinsci.plugins.structs.describable.DescribableModel.instantiate(DescribableModel.java:282)
at org.jenkinsci.plugins.workflow.steps.StepDescriptor.newInstance(StepDescriptor.java:202)
at org.jenkinsci.plugins.workflow.cps.DSL.invokeStep(DSL.java:262)
at org.jenkinsci.plugins.workflow.cps.DSL.invokeMethod(DSL.java:176)
at org.jenkinsci.plugins.workflow.cps.CpsScript.invokeMethod(CpsScript.java:122)
at groovy.lang.MetaClassImpl.invokeMethodOnGroovyObject(MetaClassImpl.java:1295)

Build script incompatible with Gradle 6

When I run any Gradle command from master (eef1ea2), I get the following warning:

Deprecated Gradle features were used in this build, making it incompatible with Gradle 6.0.
Use '--warning-mode all' to show the individual deprecation warnings.

If I re-run with --warning-mode all, I get the following output:

> Configure project :
The ProjectLayout.directoryProperty() method has been deprecated. This is scheduled to be removed in Gradle 6.0. Please use the ObjectFactory.directoryProperty() method instead.

If I upgrade Gradle to the latest version, 5.2, I get the same warnings.

Fix integration test

Starting at line 77 in test/integration/groovy/com/mkobit/libraryexample/ExampleSrcSpockSpec.groovy:

   then:
    // JenkinsRule has different assertion capabilities
    WorkflowRun run = rule.assertBuildStatusSuccess(futureRun)
    rule.assertLogContains('''
        [Pipeline] lock
        Trying to acquire lock on [myLock]
        Resource [myLock] did not exist. Created.
        Lock acquired on [myLock]
    '''.stripIndent(), run)
  }

should be

  then:
    // JenkinsRule has different assertion capabilities
    WorkflowRun run = rule.assertBuildStatusSuccess(futureRun)
    rule.assertLogContains('''
    [Pipeline] lock
    Trying to acquire lock on [myLock]
    Resource [myLock] did not exist. Created.
    Lock acquired on [myLock]
    '''.stripIndent(), run)
  }

Example: libraryResource usage

Demonstrate how to get code coverage for library code

Add Java 11 to CI build