GenericPipeline (jenkins-library 1.4.0 API)

jenkins_shared_library.pipelines.generic.GenericPipeline

Extends the functionality available in the Pipeline class. This class adds methods for building and testing your application.

A typical pipeline should include these stage in sequence:

build : build and generate artifact locally.
test : test the artifact.
sonarScan : SonarQube static code scanning.
packaging : package/create artifact.
publish : publish the artifact to Artifactory. If the build is a release, we publish the artifact to release folder.
release : if the build is a release, we tag the GitHub. If the build is a formal release, we also bump release on code base.

Required Plugins:

The following plugins are required:

Example:

 @Library('fill this out according to your setup') import org.zowe.jenkins_shared_library.pipelines.generic.GenericPipeline
 node('pipeline-node') {
     GenericPipeline pipeline = new GenericPipeline(this)

     // Set your config up before calling setup
     pipeline.admins.add("userid1", "userid2", "userid3")

     // update branches settings if we have different settings from #defineDefaultBranches()
     pipeline.branches.addMap([
         [
             name         : 'lts-incremental',
             isProtected  : true,
             buildHistory : 20,
         ]
     ])

     // MUST BE CALLED FIRST
     pipeline.setup(
         // Define the git configuration
         github: [
             email: 'git-user-email@example.com',
             usernamePasswordCredential: 'git-user-credentials-id'
         ],
         // Define the artifactory configuration
         artifactory: [
             url : 'https://your-artifactory-url',
             usernamePasswordCredential : 'artifactory-credential-id',
         ]
     )

     pipeline.build()   // Provide required parameters in your pipeline
     pipeline.test()    // Provide required parameters in your pipeline
     pipeline.publish() // Provide required parameters in your pipeline
     pipeline.release() // Provide required parameters in your pipeline

     // MUST BE CALLED LAST
     pipeline.end()
 }

Field Summary

Fields
Modifiers	Name	Description
`protected static java.lang.String`	`BUILD_PARAMETER_PERFORM_RELEASE`	Build parameter name for "Perform Release"
`protected static java.lang.String`	`BUILD_PARAMETER_PRE_RELEASE_STRING`	Build parameter name for "Pre-Release String"
`protected GenericPipelineControl`	`_control`	More control variables for the pipeline.
`protected java.util.List<java.lang.String>`	`_junitResults`	Holds junit test result files.
`protected java.lang.String`	`_manifestFormat`	Format of manifest file.
`protected java.util.Map`	`_manifestObject`	Object of manifest.
`protected static java.lang.String`	`temporaryUploadSpecName`	Temporary upload spec name

Inherited fields
Fields inherited from class	Fields
`class org.zowe.jenkins_shared_library.pipelines.base.Pipeline`	`__$stMC`

Properties Summary

Properties
Type	Name and description
`org.zowe.jenkins_shared_library.artifact.JFrogArtifactory`	`artifactory` JFrogArtifactory instance
`java.lang.String`	`artifactoryUploadTargetFile` Artifactory file name pattern when the pipeline try to publish artifacts.
`java.lang.String`	`artifactoryUploadTargetPath` Artifactory upload path pattern when the pipeline try to publish artifacts.
`org.zowe.jenkins_shared_library.pipelines.base.Branches<org.zowe.jenkins_shared_library.pipelines.generic.models.GenericBranch>`	`branches` A map of branches.
`ChangeInformation`	`changeInfo` Stores the change information for reference later.
`org.zowe.jenkins_shared_library.scm.GitHub`	`github` GitHub instance
`java.lang.String`	`githubTagPrefix` Github tag prefix
`java.lang.String`	`manifest` Manifest file name/path
`java.util.Map`	`packageInfo` Package information extracted from project.
`org.zowe.jenkins_shared_library.package.Pax`	`pax` PAX packaging instance
`java.lang.String`	`publishTargetVersion` The full version pattern when the pipeline try to publish artifacts.

Constructor Summary

Constructors
Constructor and description
`GenericPipeline (java.lang.Object steps)` Constructs the class.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected java.lang.String`	`_parseString(java.lang.String str, java.util.Map<java.lang.String, java.lang.String> macros)` Parse a string using macros Map.
	`protected void`	`_readPackageManifest()` Read manifest file if exists and fill in packageInfo.
	`protected static void`	`_validateReportInfo(TestReport report, java.lang.String reportName, java.lang.String stageName)` Validates that a test report has the required options.
	`protected void`	`build(java.util.Map arguments = [:])` Pseudo build method, should be overridden by inherited classes
	`void`	`buildGeneric(BuildStageArguments arguments)` Creates a stage that will build a generic package.
	`void`	`buildGeneric(java.util.Map arguments = [:])` Creates a stage that will build a generic package.
	`protected void`	`bumpVersion()` This method should be overridden to properly bump version in different kind of project.
	`protected void`	`defineDefaultBranches()` Setup default branch settings
	`protected void`	`end(java.util.Map arguments = [:])` Pseudo end method, should be overridden by inherited classes
	`void`	`endGeneric(java.util.Map arguments = [:])` Signal that no more stages will be added and begin pipeline execution.
	`protected java.util.Map<java.lang.String, java.lang.String>`	`extractArtifactoryUploadTargetFileMacros(java.lang.String file)` Extract macro of "filename" and "fileext" for artifactory upload file.
	`java.lang.String`	`getBranchTag(java.lang.String branch = '')` Get branch tag
	`protected java.util.Map<java.lang.String, java.lang.String>`	`getBuildStringMacros(java.util.Map<java.lang.String, java.lang.String> macros = [:])` Return map of build string macros.
	`java.lang.String`	`getPreReleaseString()` The pre-release string parameter of current build.
	`java.lang.String`	`getPublishTargetPath(java.util.Map arguments = [:])` Get real publish target path
	`java.lang.Boolean`	`isFormalReleaseBranch(java.lang.String branch = '')` If current pipeline branch can do a formal release
	`java.lang.Boolean`	`isPerformingRelease()` If current build is a release build based on the build parameter which starts the build.
	`java.lang.Boolean`	`isReleaseBranch(java.lang.String branch = '')` If current pipeline branch can do a release.
	`protected void`	`packaging(java.util.Map arguments)` Pseudo packaging method, should be overridden by inherited classes
	`void`	`packagingGeneric(PackagingStageArguments arguments)` Creates a stage that will package artifact(s).
	`void`	`packagingGeneric(java.util.Map arguments = [:])` Creates a stage that will package artifact(s).
	`protected void`	`publish(java.util.Map arguments)` Pseudo publish method, should be overridden by inherited classes
	`void`	`publishGeneric(PublishStageArguments arguments)` Creates a stage that will publish artifacts to Artifactory.
	`void`	`publishGeneric(java.util.Map arguments = [:])` Creates a stage that will publish artifacts to Artifactory.
	`protected void`	`release(java.util.Map arguments = [:])` Pseudo release method, should be overridden by inherited classes
	`void`	`releaseGeneric(java.util.Map arguments = [:])` Creates a stage that will execute a release
	`void`	`releaseGeneric(ReleaseStageArguments arguments)` Creates a stage that will execute a release
	`protected void`	`sendReleaseNotice()` Send out email notification for the new version released.
	`protected void`	`setup(java.util.Map arguments = [:])` Pseudo setup method, should be overridden by inherited classes
	`void`	`setupGeneric(GenericSetupStageArguments arguments)` Calls Pipeline.setupBase to setup the build.
	`void`	`setupGeneric(java.util.Map arguments = [:])` Initialize the pipeline.
	`protected void`	`sonarScan(java.util.Map arguments = [:])` Pseudo SonarQube Scan method, should be overridden by inherited classes
	`void`	`sonarScanGeneric(SonarScanStageArguments arguments)` Creates a stage that will perform SonarQube static code scanning.
	`void`	`sonarScanGeneric(java.util.Map arguments = [:])` Creates a stage that will execute SonarQube code scan on your application.
	`protected void`	`tagBranch(java.lang.String tagPrefix = '')` Tag branch when release.
	`protected void`	`test(java.util.Map arguments = [:])` Pseudo test method, should be overridden by inherited classes
	`void`	`testGeneric(TestStageArguments arguments)` Creates a stage that will execute tests on your application.
	`void`	`testGeneric(java.util.Map arguments = [:])` Creates a stage that will execute tests on your application.
	`void`	`uploadArtifacts(java.util.List<java.lang.String> artifacts, java.lang.String baseTargetPath = "")` Upload artifacts.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class org.zowe.jenkins_shared_library.pipelines.base.Pipeline`	org.zowe.jenkins_shared_library.pipelines.base.Pipeline#getSteps(), org.zowe.jenkins_shared_library.pipelines.base.Pipeline#setSteps(java.lang.Object), org.zowe.jenkins_shared_library.pipelines.base.Pipeline#setupBase(org.zowe.jenkins_shared_library.pipelines.base.arguments.SetupStageArguments), org.zowe.jenkins_shared_library.pipelines.base.Pipeline#setupBase(java.util.Map), org.zowe.jenkins_shared_library.pipelines.base.Pipeline#setupBase(), org.zowe.jenkins_shared_library.pipelines.base.Pipeline#getBranches(), org.zowe.jenkins_shared_library.pipelines.base.Pipeline#setBranches(org.zowe.jenkins_shared_library.pipelines.base.Branches), org.zowe.jenkins_shared_library.pipelines.base.Pipeline#createStage(java.util.Map), org.zowe.jenkins_shared_library.pipelines.base.Pipeline#createStage(org.zowe.jenkins_shared_library.pipelines.base.arguments.StageArguments), org.zowe.jenkins_shared_library.pipelines.base.Pipeline#addBuildParameter(java.lang.Object), org.zowe.jenkins_shared_library.pipelines.base.Pipeline#addBuildOption(java.lang.Object), org.zowe.jenkins_shared_library.pipelines.base.Pipeline#addBuildParameters([Lorg.jenkinsci.plugins.structs.describable.UninstantiatedDescribable;), org.zowe.jenkins_shared_library.pipelines.base.Pipeline#addBuildParameters(java.util.List), org.zowe.jenkins_shared_library.pipelines.base.Pipeline#addUpstreams([Ljava.lang.String;), org.zowe.jenkins_shared_library.pipelines.base.Pipeline#getFirstFailingStage(), org.zowe.jenkins_shared_library.pipelines.base.Pipeline#getAdmins(), org.zowe.jenkins_shared_library.pipelines.base.Pipeline#getBuildOptions(), org.zowe.jenkins_shared_library.pipelines.base.Pipeline#setBuildOptions(java.util.List), org.zowe.jenkins_shared_library.pipelines.base.Pipeline#getBuildParameters(), org.zowe.jenkins_shared_library.pipelines.base.Pipeline#setBuildParameters(java.util.List), org.zowe.jenkins_shared_library.pipelines.base.Pipeline#getBuildUpstreams(), org.zowe.jenkins_shared_library.pipelines.base.Pipeline#setBuildUpstreams(java.util.List), org.zowe.jenkins_shared_library.pipelines.base.Pipeline#setVersion(java.lang.String), org.zowe.jenkins_shared_library.pipelines.base.Pipeline#endBase(org.zowe.jenkins_shared_library.pipelines.base.arguments.EndArguments), org.zowe.jenkins_shared_library.pipelines.base.Pipeline#endBase(), org.zowe.jenkins_shared_library.pipelines.base.Pipeline#endBase(java.util.Map), org.zowe.jenkins_shared_library.pipelines.base.Pipeline#getStage(java.lang.String), org.zowe.jenkins_shared_library.pipelines.base.Pipeline#setPackageName(java.lang.String), org.zowe.jenkins_shared_library.pipelines.base.Pipeline#setBaseDirectory(java.lang.String), org.zowe.jenkins_shared_library.pipelines.base.Pipeline#getVersion(), org.zowe.jenkins_shared_library.pipelines.base.Pipeline#invokeMethod(java.lang.String, java.lang.Object), org.zowe.jenkins_shared_library.pipelines.base.Pipeline#getMetaClass(), org.zowe.jenkins_shared_library.pipelines.base.Pipeline#setMetaClass(groovy.lang.MetaClass), org.zowe.jenkins_shared_library.pipelines.base.Pipeline#setResult(org.zowe.jenkins_shared_library.pipelines.base.enums.ResultEnum), org.zowe.jenkins_shared_library.pipelines.base.Pipeline#getBaseDirectory(), org.zowe.jenkins_shared_library.pipelines.base.Pipeline#setProperty(java.lang.String, java.lang.Object), org.zowe.jenkins_shared_library.pipelines.base.Pipeline#getProperty(java.lang.String), org.zowe.jenkins_shared_library.pipelines.base.Pipeline#getPackageName(), org.zowe.jenkins_shared_library.pipelines.base.Pipeline#wait(long, int), org.zowe.jenkins_shared_library.pipelines.base.Pipeline#wait(long), org.zowe.jenkins_shared_library.pipelines.base.Pipeline#wait(), org.zowe.jenkins_shared_library.pipelines.base.Pipeline#equals(java.lang.Object), org.zowe.jenkins_shared_library.pipelines.base.Pipeline#toString(), org.zowe.jenkins_shared_library.pipelines.base.Pipeline#hashCode(), org.zowe.jenkins_shared_library.pipelines.base.Pipeline#getClass(), org.zowe.jenkins_shared_library.pipelines.base.Pipeline#notify(), org.zowe.jenkins_shared_library.pipelines.base.Pipeline#notifyAll()
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Field Detail
  - protected static final java.lang.String BUILD_PARAMETER_PERFORM_RELEASE
    
    Build parameter name for "Perform Release"
  - protected static final java.lang.String BUILD_PARAMETER_PRE_RELEASE_STRING
    
    Build parameter name for "Pre-Release String"
  - protected GenericPipelineControl _control
    
    More control variables for the pipeline.
  - protected java.util.List<java.lang.String> _junitResults
    
    Holds junit test result files.
    This is internal used to avoid publishing duplicated junit file to Jenkins.
  - protected java.lang.String _manifestFormat
    
    Format of manifest file.
    The value could be json or yaml.
    
    The value is calculated based on manifest file name.
  - protected java.util.Map _manifestObject
    
    Object of manifest.
    The value is calculated based on manifest file content.
  - protected static final java.lang.String temporaryUploadSpecName
    
    Temporary upload spec name
    Default:
    ".tmp-pipeline-publish-spec.json"
- Property Detail
  - org.zowe.jenkins_shared_library.artifact.JFrogArtifactory artifactory
    
    JFrogArtifactory instance
  - java.lang.String artifactoryUploadTargetFile
    
    Artifactory file name pattern when the pipeline try to publish artifacts.
    Note:
    Allowed macros are same as macros defined in artifactoryUploadTargetPath and with these extras.
    
    - filename: the base file name extracted from original artifact.
    
    - fileext: the file extension extracted from original artifact.
    
    - publishversion: parsed string of publishTargetVersion
    Default:
    "{filename}-{publishversion}{fileext}"
    Example:
    With the default pattern, if we want to upload my-artifact.zip, the pipeline may interpret the targe file name as "my-artifact-1.2.3-snapshot-23-20190101010101.zip".
  - java.lang.String artifactoryUploadTargetPath
    
    Artifactory upload path pattern when the pipeline try to publish artifacts.
    Note:
    Allowed macros:
    
    - repository: Artifactory repository name where the artifact will be published.
    
    - package: value defined by pipeline.setPackage(name)
    
    - subproject: optional value passed when parsing the path string
    
    - version: the current version
    
    - prerelease: pre-release string, like rc1, beta1, etc.
    
    - branchtag: branch tag
    
    - branchtag-uc: branch tag but in UPPER case.
    
    - timestamp: timestamp in yyyyMMddHHmmss format
    
    - buildnumber: current build number
    Note:
    If the artifactory repository is a Maven repository, the upload may fail if the branchtag is lower case characters.
    Default:
    "{repository}/{package}{subproject}/{version}{branchtag-uc}/"
    Example:
    With the default pattern, the pipeline may interpret the targe upload path as "lib-snapshot-local/org/zowe/my-project/1.2.3-STAGINGS-TLS/".
  - org.zowe.jenkins_shared_library.pipelines.base.Branches<org.zowe.jenkins_shared_library.pipelines.generic.models.GenericBranch> branches
    
    A map of branches.
  - final ChangeInformation changeInfo
    
    Stores the change information for reference later.
  - org.zowe.jenkins_shared_library.scm.GitHub github
    
    GitHub instance
  - java.lang.String githubTagPrefix
    
    Github tag prefix
    If you set a prefix example, then all version tags like v1.2.3 will have a github tag example-v1.2.3.
  - java.lang.String manifest
    
    Manifest file name/path
    Set to file path if the repository has Zowe manifest file. This is optional. By default, the Generic pipeline will try manifest.json, manifest.yaml or manifest.yml in root directory.
  - java.util.Map packageInfo
    
    Package information extracted from project.
    Based on type of project, the keys included could be vary.
    Note:
    These keys should exist all the time, otherwise exceptions may be thrown for missing values.
    
    - name
    
    - version
    
    - versionTrunks
  - org.zowe.jenkins_shared_library.package.Pax pax
    
    PAX packaging instance
  - java.lang.String publishTargetVersion
    
    The full version pattern when the pipeline try to publish artifacts.
    Note:
    Allowed macros are same as macros defined in artifactoryUploadTargetPath.
    Default:
    "{version}{prerelease}{branchtag}{buildnumber}{timestamp}"
    Example:
    With the default pattern, the pipeline may interpret the targe version string as "1.2.3-snapshot-23-20190101010101".
- Constructor Detail
  - GenericPipeline(java.lang.Object steps)
    
    Constructs the class.
    When invoking from a Jenkins pipeline script, the GenericPipeline must be passed the current environment of the Jenkinsfile to have access to the steps.
    Example:
    def pipeline = new GenericPipeline(this)
    Parameters:
    steps - The workflow steps object provided by the Jenkins pipeline
- Method Detail
  - protected java.lang.String _parseString(java.lang.String str, java.util.Map<java.lang.String, java.lang.String> macros)
    
    Parse a string using macros Map.
    Macros wrap with curly brackets will be replace in the string. For example, all occurence of {repository} in the string will be replaced with value of macro key repository.
    
    Parameters:
    str - string to parse
    macros - map of macros to replace
    Returns:
    parsed string
  - protected void _readPackageManifest()
    
    Read manifest file if exists and fill in packageInfo.
  - protected static void _validateReportInfo(TestReport report, java.lang.String reportName, java.lang.String stageName)
    
    Validates that a test report has the required options.
    Parameters:
    report - The report to validate
    reportName - The name of the report being validated
    stageName - The name of the stage that is executing.
    Throws:
    org.zowe.jenkins_shared_library.pipelines.generic.exceptions.TestStageException when any of the report properties are invalid.
  - protected void build(java.util.Map arguments = [:])
    
    Pseudo build method, should be overridden by inherited classes
    Parameters:
    arguments - A map of arguments to be applied to the BuildStageArguments used to define the stage.
  - void buildGeneric(BuildStageArguments arguments)
    
    Creates a stage that will build a generic package.
    Calling this function will add the following stage to your Jenkins pipeline. Arguments passed to this function will map to the BuildStageArguments class. The BuildStageArguments.operation will be executed after all checks are complete. This must be provided or a java.lang.NullPointerException will be encountered.
    Stages:
    This method adds the following stage to your build:
    
    Build: BuildStageArguments.name
    
    Runs the build of your application. The build stage also ignores any BuildStageArguments.resultThreshold provided and only runs on org.zowe.jenkins_shared_library.pipelines.base.enums.ResultEnum#SUCCESS.
    
    Exceptions:
    The following exceptions can be thrown by the build stage:
    
    BuildStageException
    
    When arguments.stage is provided. This is an invalid argument field for the operation.
    
    When called more than once in your pipeline. Only one build may be present in a pipeline.
    
    java.lang.NullPointerException
    
    When arguments.operation is not provided.
    
    Note:
    This method was intended to be called build but had to be named buildGeneric due to the issues described in Pipeline.
    
    Parameters:
    arguments - A map of arguments to be applied to the BuildStageArguments used to define the stage.
  - void buildGeneric(java.util.Map arguments = [:])
    
    Creates a stage that will build a generic package.
    Parameters:
    arguments - A map that can be instantiated as org.zowe.jenkins_shared_library.pipelines.generic.arguments.BuildStageArguments
    See Also:
    buildGeneric(BuildStageArguments)
  - protected void bumpVersion()
    
    This method should be overridden to properly bump version in different kind of project.
    For example, npm package should use `npm version patch` to bump, and gradle project should update the version definition in "gradle.properties".
  - @java.lang.Override protected void defineDefaultBranches()
    
    Setup default branch settings
  - @java.lang.Override protected void end(java.util.Map arguments = [:])
    
    Pseudo end method, should be overridden by inherited classes
    Parameters:
    arguments - A map that can be instantiated as EndArguments.
  - void endGeneric(java.util.Map arguments = [:])
    
    Signal that no more stages will be added and begin pipeline execution.
    Parameters:
    arguments - Arguments to send to Pipeline.endBase
  - protected java.util.Map<java.lang.String, java.lang.String> extractArtifactoryUploadTargetFileMacros(java.lang.String file)
    
    Extract macro of "filename" and "fileext" for artifactory upload file.
    Note:
    The filename and fileext extracted from the file path does not include path to the file and version information.
    For example, if we have a local artifact "./path/to/my-artifact-1.2.3-snapshot.zip", then the expected macros extracted are: [filename: "my-artifact", fileext: "zip"]
    
    Parameters:
    file - original file name
    Returns:
    macro map
  - java.lang.String getBranchTag(java.lang.String branch = '')
    
    Get branch tag
    Parameters:
    branch - the branch name to check. By default, empty string will check current branch
    Returns:
    tag of the branch
  - protected java.util.Map<java.lang.String, java.lang.String> getBuildStringMacros(java.util.Map<java.lang.String, java.lang.String> macros = [:])
    
    Return map of build string macros. Those macros will be used to parse build string.
    Parameters:
    macros - default value of macros.
    Returns:
    updated macro list.
  - java.lang.String getPreReleaseString()
    
    The pre-release string parameter of current build.
    Note:
    This value will be empty if the build is not a release build (build parameter BUILD_PARAMETER_PERFORM_RELEASE is not set).
    
    Returns:
    the pre-release string, or empty if not set.
  - java.lang.String getPublishTargetPath(java.util.Map arguments = [:])
    
    Get real publish target path
    Parameters:
    publishTargetPath - overwrite default publish path pattern
    Returns:
    parsed target publish path
  - java.lang.Boolean isFormalReleaseBranch(java.lang.String branch = '')
    
    If current pipeline branch can do a formal release
    Note:
    For regular Pipeline build, since we cannot determin branch name easily, this method will always return true to allow formal release.
    
    Parameters:
    branch - the branch name to check. By default, empty string will check current branch
    Returns:
    true or false
  - java.lang.Boolean isPerformingRelease()
    
    If current build is a release build based on the build parameter which starts the build.
    Returns:
    true or false
  - java.lang.Boolean isReleaseBranch(java.lang.String branch = '')
    
    If current pipeline branch can do a release.
    Note:
    For regular Pipeline build, since we cannot determin branch name easily, this method will always return true to allow release.
    
    Parameters:
    branch - the branch name to check. By default, empty string will check current branch
    Returns:
    true or false
  - protected void packaging(java.util.Map arguments)
    
    Pseudo packaging method, should be overridden by inherited classes
    Parameters:
    arguments - The arguments for the packaging step. arguments.name must be provided.
  - void packagingGeneric(PackagingStageArguments arguments)
    
    Creates a stage that will package artifact(s).
    The default behavior of this stage will check if there is a local PAX workspace presents. If so, then run a PAX packaging process to generate a Pax package.
    
    Provide arguments.operation to override the default behavior.
    
    Calling this function will add the following stage to your Jenkins pipeline. Arguments passed to this function will map to the PackagingStageArguments class. The PackagingStageArguments.operation will be executed after all checks are complete. This must be provided or a java.lang.NullPointerException will be encountered.
    Stages:
    This method adds the following stage to your build:
    
    Packaging: PackagingStageArguments.name
    
    Create a package for your project. The stage also ignores any PackagingStageArguments.resultThreshold provided and only runs on org.zowe.jenkins_shared_library.pipelines.base.enums.ResultEnum#SUCCESS.
    
    Exceptions:
    The following exceptions can be thrown by the sonar scan stage:
    
    PackagingStageException
    
    When arguments.stage is provided. This is an invalid argument field for the operation.
    
    When called more than once in your pipeline. Only one sonar scan may be present in a pipeline.
    
    When arguments.name is not defined. This name will be used as final pacakge name.
    
    When arguments.sshHost is not defined and arguments.operation is not provided.
    
    When arguments.sshCredential is not defined and arguments.operation is not provided.
    
    When arguments.remoteWorkspace is not defined and arguments.operation is not provided.
    
    java.lang.NullPointerException
    
    When arguments.operation is not provided.
    
    Note:
    With default behavior (by not providing arguments.operation), the SonarQube scan stage won't fail the build if the scan result doesn't pass the threshold. The stage will only fail when then scanning cannot be performed, like cannot connect to the SonarQube server.
    Note:
    This method was intended to be called pacakging but had to be named packagingGeneric due to the issues described in Pipeline.
    
    Parameters:
    arguments - A map of arguments to be applied to the SonarScanStageArguments used to define the stage.
  - void packagingGeneric(java.util.Map arguments = [:])
    
    Creates a stage that will package artifact(s).
    Parameters:
    arguments - A map that can be instantiated as org.zowe.jenkins_shared_library.pipelines.generic.arguments.PackagingStageArguments
    See Also:
    packagingGeneric(PackagingStageArguments)
  - protected void publish(java.util.Map arguments)
    
    Pseudo publish method, should be overridden by inherited classes
    Parameters:
    arguments - The arguments for the publish step.
  - void publishGeneric(PublishStageArguments arguments)
    
    Creates a stage that will publish artifacts to Artifactory.
    By default, if you publish a pre-release version on formal release branch, the pipeline will show a confirmation information requiring human intervene. For example, you want to publish rc1 on master branch. Normally a pre-release should be released from staging branch. Set PublishStageArguments.allowPublishPreReleaseFromFormalReleaseBranch to true to disable it.
    Conditions:
    The stage will adhere to the following conditions:
    
    The stage will only execute if the current build result is org.zowe.jenkins_shared_library.pipelines.base.enums.ResultEnum#SUCCESS or higher.
    Exceptions:
    The Publish stage will throw the following exceptions:
    
    org.zowe.jenkins_shared_library.pipelines.generic.exceptions.PublishStageException
    
    When stage is provided as an argument. This is an invalid parameter for both stages
    
    When a test stage has not executed. This prevents untested code from being published
    
    java.lang.NullPointerException
    
    When an operation is not provided for the stage.
    
    Note:
    This method was intended to be called publish but had to be named publishGeneric due to the issues described in Pipeline.
    
    Parameters:
    arguments - The arguments for the publish step.
  - void publishGeneric(java.util.Map arguments = [:])
    
    Creates a stage that will publish artifacts to Artifactory.
    Parameters:
    arguments - A map that can be instantiated as org.zowe.jenkins_shared_library.pipelines.generic.arguments.PublishStageArguments
    See Also:
    publishGeneric(PublishStageArguments)
  - protected void release(java.util.Map arguments = [:])
    
    Pseudo release method, should be overridden by inherited classes
    Parameters:
    arguments - The arguments for the release step.
  - void releaseGeneric(java.util.Map arguments = [:])
    
    Creates a stage that will execute a release
    See Also:
    releaseGeneric(ReleaseStageArguments)
  - void releaseGeneric(ReleaseStageArguments arguments)
    
    Creates a stage that will execute a release
    The default behavior of release stage is after the publish stage, which release artifacts have been uploaded to Artifactory, we have to tag the GitHub branch with the release. If this is a formal release, we also need to bump project version, so we won't build same version again. The version bump will create a commit and push to GitHub. After all, the stage will send out email notification for the new release.
    
    Provide arguments.operation to override the default behavior. Or you can provide arguments.tagBranch or arguments.bumpVersion to override part of the behavior.
    
    Calling this function will add the following stage to your Jenkins pipeline. Arguments passed to this function will map to the org.zowe.jenkins_shared_library.pipelines.generic.arguments.ReleaseStageArguments class. The org.zowe.jenkins_shared_library.pipelines.generic.arguments.ReleaseStageArguments#operation will be executed after all checks are complete. This must be provided or a java.lang.NullPointerException will be encountered.
    Stages:
    This method adds the following stage to your build:
    
    Releasing: org.zowe.jenkins_shared_library.pipelines.generic.arguments.ReleaseStageArguments#name
    
    This stage is responsible for tagging the branch and bumping the release of your application source.
    Conditions:
    This stage will adhere to the following conditions:
    
    The stage will only execute if the current build result is org.zowe.jenkins_shared_library.pipelines.base.enums.ResultEnum#SUCCESS or higher.
    
    The stage will only execute if the current branch is a releasing branch.
    
    The build job is started when build parameter "Perform Release" BUILD_PARAMETER_PERFORM_RELEASE is checked.
    Exceptions:
    The following exceptions will be thrown if there is an error.
    
    org.zowe.jenkins_shared_library.pipelines.generic.exceptions.ReleaseStageException
    
    When stage is provided as an argument.
    
    When publish stage is not successful.
    
    java.lang.NullPointerException
    
    When an operation is not provided for the stage.
    
    Note:
    This method was intended to be called release but had to be named releaseGeneric due to the issues described in Pipeline.
    
    Parameters:
    arguments - A map of arguments to be applied to the org.zowe.jenkins_shared_library.pipelines.generic.arguments.ReleaseStageArguments used to define the stage.
  - protected void sendReleaseNotice()
    
    Send out email notification for the new version released.
  - @java.lang.Override protected void setup(java.util.Map arguments = [:])
    
    Pseudo setup method, should be overridden by inherited classes
    Parameters:
    arguments - A map that can be instantiated as GenericSetupStageArguments
  - void setupGeneric(GenericSetupStageArguments arguments)
    
    Calls Pipeline.setupBase to setup the build.
    Stages:
    This method adds 2 stages to the build:
    
    Check for CI Skip
    
    Checks that the build commit doesn't contain the CI Skip Constants.CI_SKIP indicator. If the pipeline finds the skip commit, all remaining steps (except those explicitly set to ignore this condition) will also be skipped. The build will also be marked as not built in this scenario.
    
    Init Generic Pipeline
    
    This initialization stage will run #init() methods of dependended instances, for example, GitHub, JFrogArtifactory, Pax etc. This step is placed in a stage because some initlialization requires code checkout. You can specify GenericSetupStageArguments.extraInit to extend the default initialization.
    
    Note:
    This method was intended to be called setup but had to be named setupGeneric due to the issues described in Pipeline.
  - void setupGeneric(java.util.Map arguments = [:])
    
    Initialize the pipeline.
    Parameters:
    arguments - A map that can be instantiated as GenericSetupStageArguments
    See Also:
    setupGeneric(GenericSetupStageArguments)
  - protected void sonarScan(java.util.Map arguments = [:])
    
    Pseudo SonarQube Scan method, should be overridden by inherited classes
    Parameters:
    arguments - The arguments for the sonarScan step.
  - void sonarScanGeneric(SonarScanStageArguments arguments)
    
    Creates a stage that will perform SonarQube static code scanning.
    The default behavior of this stage will check if there is a "sonar-project.properties" file presents. If so, then run a SonarQube static code scanning using that configuration file.
    
    Provide arguments.operation to override the default behavior.
    
    Calling this function will add the following stage to your Jenkins pipeline. Arguments passed to this function will map to the SonarScanStageArguments class. The SonarScanStageArguments.operation will be executed after all checks are complete. This must be provided or a java.lang.NullPointerException will be encountered.
    Stages:
    This method adds the following stage to your build:
    
    SonarQube Scan: SonarScanStageArguments.name
    
    Perform a SonarQube static code scanning on your application. The stage also ignores any SonarScanStageArguments.resultThreshold provided and only runs on org.zowe.jenkins_shared_library.pipelines.base.enums.ResultEnum#SUCCESS.
    
    Exceptions:
    The following exceptions can be thrown by the sonar scan stage:
    
    SonarScanStageException
    
    When arguments.stage is provided. This is an invalid argument field for the operation.
    
    When called more than once in your pipeline. Only one sonar scan may be present in a pipeline.
    
    When arguments.scannerServer is not defined and arguments.operation is not provided.
    
    When arguments.scannerTool is not defined and arguments.operation is not provided.
    
    java.lang.NullPointerException
    
    When arguments.operation is not provided.
    
    Note:
    With default behavior (by not providing arguments.operation), the SonarQube scan stage will only run if "sonar-project.properties" file presents. This file should have basic scanning configurations.
    Note:
    With default behavior (by not providing arguments.operation), the SonarQube scan stage won't fail the build if the scan result doesn't pass the threshold. The stage will only fail when then scanning cannot be performed, like cannot connect to the SonarQube server.
    Note:
    This method was intended to be called sonarScan but had to be named sonarScanGeneric due to the issues described in Pipeline.
    
    Parameters:
    arguments - A map of arguments to be applied to the SonarScanStageArguments used to define the stage.
  - void sonarScanGeneric(java.util.Map arguments = [:])
    
    Creates a stage that will execute SonarQube code scan on your application.
    Parameters:
    arguments - A map that can be instantiated as org.zowe.jenkins_shared_library.pipelines.generic.arguments.SonarScanStageArguments
    See Also:
    sonarScanGradle(SonarScanStageArguments)
  - protected void tagBranch(java.lang.String tagPrefix = '')
    
    Tag branch when release.
    Example:
    If we are releasing "1.2.3" with pre-release string "rc1", we will creating a tag "v1.2.3-rc1".
    
    Parameters:
    tagPrefix - if prefix the tag with an identifier
  - protected void test(java.util.Map arguments = [:])
    
    Pseudo test method, should be overridden by inherited classes
    Parameters:
    arguments - A map of arguments to be applied to the TestStageArguments used to define the stage.
  - void testGeneric(TestStageArguments arguments)
    
    Creates a stage that will execute tests on your application.
    Arguments passed to this function will map to the TestStageArguments class.
    Stages:
    This method adds the following stage to the build:
    
    Test: TestStageArguments.name
    
    Runs one of your application tests. If the test operation throws an error, that error is ignored and will be assumed to be caught in the junit processing. Some test functions may exit with a non-zero return code on a test failure but may still capture junit output. In this scenario, it is assumed that the junit report is either missing or contains failing tests. In the case that it is missing, the build will fail on this report and relevant exceptions are printed. If the junit report contains failing tests, the build will be marked as unstable and a report of failing tests can be viewed.
    
    The following reports can be captured:
    
    Test Results HTML Report
    
    This is an html report that contains the result of the build. The report must be defined to the method in the org.zowe.jenkins_shared_library.pipelines.generic.arguments.TestStageArguments#htmlReports variable.
    
    Code Coverage HTML Report
    
    This is an HTML report generated from code coverage output from your build. The report can be omitted by omitting org.zowe.jenkins_shared_library.pipelines.generic.arguments.TestStageArguments#htmlReports
    
    JUnit Report
    
    This report feeds Jenkins the data about the current test run. It can be used to mark a build as failed or unstable. The report location must be present in org.zowe.jenkins_shared_library.pipelines.generic.arguments.TestStageArguments#junit
    
    Cobertura Report
    
    This report feeds Jenkins the data about the coverage results for the current test run. If no Cobertura options are passed, then no coverage data will be collected. For more information, see org.zowe.jenkins_shared_library.pipelines.generic.arguments.TestStageArguments#cobertura
    
    The test stage will execute by default if the current build result is greater than or equal to org.zowe.jenkins_shared_library.pipelines.base.enums.ResultEnum#UNSTABLE. If a different status is passed, that will take precedent.
    
    After the test is complete, the stage will continue to collect the JUnit Report and the Test Results HTML Report. The stage will fail if either of those are missing. If specified, the Cobertura Report are then captured. The build will fail if these reports are to be collected and were missing.
    
    Exceptions:
    The test stage can throw the following exceptions:
    
    org.zowe.jenkins_shared_library.pipelines.generic.exceptions.TestStageException
    
    When a test stage is created before a call to buildGeneric(Map)
    
    When TestStageArguments.junit is missing
    
    When invalid options are specified for TestStageArguments.junit
    
    When TestStageArguments.cobertura is provided but has an invalid format
    
    When TestStageArguments.operation is missing.
    
    Note:
    This method was intended to be called test but had to be named testGeneric due to the issues described in Pipeline.
    
    Parameters:
    arguments - A map of arguments to be applied to the TestStageArguments used to define the stage.
  - void testGeneric(java.util.Map arguments = [:])
    
    Creates a stage that will execute tests on your application.
    Parameters:
    arguments - A map that can be instantiated as org.zowe.jenkins_shared_library.pipelines.generic.arguments.TestStageArguments
    See Also:
    testGeneric(TestStageArguments)
  - void uploadArtifacts(java.util.List<java.lang.String> artifacts, java.lang.String baseTargetPath = "")
    
    Upload artifacts.
    This is a part of publish stage default behavior. If org.zowe.jenkins_shared_library.pipelines.generic.arguments.PublishStageArguments#artifacts is defined, those artifacts will be uploaded to artifactory with this method.
    
    Parameters:
    artifacts - list of artifacts. glob file pattern is allowed.
    baseTargetPath - The targe path to upload

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Groovy] Class GenericPipeline

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected static final java.lang.String BUILD_PARAMETER_PERFORM_RELEASE

protected static final java.lang.String BUILD_PARAMETER_PRE_RELEASE_STRING

protected GenericPipelineControl _control

protected java.util.List<java.lang.String> _junitResults

protected java.lang.String _manifestFormat

protected java.util.Map _manifestObject

protected static final java.lang.String temporaryUploadSpecName

Property Detail

org.zowe.jenkins_shared_library.artifact.JFrogArtifactory artifactory

java.lang.String artifactoryUploadTargetFile

java.lang.String artifactoryUploadTargetPath

org.zowe.jenkins_shared_library.pipelines.base.Branches<org.zowe.jenkins_shared_library.pipelines.generic.models.GenericBranch> branches

final ChangeInformation changeInfo

org.zowe.jenkins_shared_library.scm.GitHub github

java.lang.String githubTagPrefix

java.lang.String manifest

java.util.Map packageInfo

org.zowe.jenkins_shared_library.package.Pax pax

java.lang.String publishTargetVersion

Constructor Detail

GenericPipeline(java.lang.Object steps)

Method Detail

protected java.lang.String _parseString(java.lang.String str, java.util.Map<java.lang.String, java.lang.String> macros)

protected void _readPackageManifest()

protected static void _validateReportInfo(TestReport report, java.lang.String reportName, java.lang.String stageName)

protected void build(java.util.Map arguments = [:])

void buildGeneric(BuildStageArguments arguments)

void buildGeneric(java.util.Map arguments = [:])

protected void bumpVersion()

@java.lang.Override protected void defineDefaultBranches()

@java.lang.Override protected void end(java.util.Map arguments = [:])

void endGeneric(java.util.Map arguments = [:])

protected java.util.Map<java.lang.String, java.lang.String> extractArtifactoryUploadTargetFileMacros(java.lang.String file)

java.lang.String getBranchTag(java.lang.String branch = '')

protected java.util.Map<java.lang.String, java.lang.String> getBuildStringMacros(java.util.Map<java.lang.String, java.lang.String> macros = [:])

java.lang.String getPreReleaseString()

java.lang.String getPublishTargetPath(java.util.Map arguments = [:])

java.lang.Boolean isFormalReleaseBranch(java.lang.String branch = '')

java.lang.Boolean isPerformingRelease()

java.lang.Boolean isReleaseBranch(java.lang.String branch = '')

protected void packaging(java.util.Map arguments)

void packagingGeneric(PackagingStageArguments arguments)

void packagingGeneric(java.util.Map arguments = [:])

protected void publish(java.util.Map arguments)

void publishGeneric(PublishStageArguments arguments)

void publishGeneric(java.util.Map arguments = [:])

protected void release(java.util.Map arguments = [:])

void releaseGeneric(java.util.Map arguments = [:])

void releaseGeneric(ReleaseStageArguments arguments)

protected void sendReleaseNotice()

@java.lang.Override protected void setup(java.util.Map arguments = [:])

void setupGeneric(GenericSetupStageArguments arguments)

void setupGeneric(java.util.Map arguments = [:])

protected void sonarScan(java.util.Map arguments = [:])

void sonarScanGeneric(SonarScanStageArguments arguments)

void sonarScanGeneric(java.util.Map arguments = [:])

protected void tagBranch(java.lang.String tagPrefix = '')

protected void test(java.util.Map arguments = [:])

void testGeneric(TestStageArguments arguments)

void testGeneric(java.util.Map arguments = [:])

void uploadArtifacts(java.util.List<java.lang.String> artifacts, java.lang.String baseTargetPath = "")