Method Detail

• static java.lang.String dumpProperties(java.lang.Object obj)

  Return all properties and values of an object

  Parameters:

  obj - Object to check

• static java.lang.String escapeXml(java.lang.String text)

  Escape special characters in text to make it safe to put in XML

  Note:

  This method uses org.apache.commons.lang3.StringEscapeUtils#escapeXml11(String) to escape XML.

  Parameters:

  params - text to escape

  Returns:

  escaped text

• static java.lang.String getBuildIdentifier(java.lang.Object env, java.util.Map args = [:])

  Get Build Identifier.

  Note:

  This method is for back compatible purpose.

  Example output:

  • 20180101.010101-pr-11-1: PR-11 branch build #1 at 20180101.010101
  • 20180101.010101-13: master branch build #13 at 20180101.010101
  • 20180101-010101-13: master branch build #13 using "%Y%m%d-%H%M%S" format

  deprecated:

  @param env Jenkins environment variable

  Parameters:

  includeTimestamp - Boolean|String, default is true. If add timstamp to the build identifier, or specify a formatting string. Support format is using Java DateTimeFormatter: https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html

  excludeBranches - List|String, The branches should not be excluded from identifier. Set it to '__ALL__' to completely exclude branch name from the identifier.

  includeBuildNumber - Boolean, default is true. If add build number to the build identifier

  Returns:

  build identifier

• static java.util.logging.Logger getLogger(java.lang.String name = '')

  Get a logger instance

  Note:

  This method is mainly used in integration test to write extra logs. For Jenkins Library classes, should import groovy.util.logging.Log then use @Log annoutation to enable logging.

  Parameters:

  name - name of the logger

  Returns:

  a Logger instance

• static java.lang.String getReleaseIdentifier(java.lang.Object env, java.util.Map mappings = ['master': 'SNAPSHOT'])

  Get release identifier from branch name.

  Note:

  This method use env.BRANCH_NAME to get branch name, so it only works on Multibranch Pipeline.

  Example output:

  • SNAPSHOT: default release name on master branch
  • pr-13: pull request #13

  Usage examples:

  • getReleaseIdentifier(env, ['master': 'snapshot', 'staging': 'latest'])

  deprecated:

  @param env Map of Jenkins environment variable. This map should have BRANCH_NAME key.

  Parameters:

  mappings - mappings of branch name and identifier

  Returns:

  branch identifier

• static java.lang.String getTimestamp(java.lang.String format = "yyyyMMddHHmmss")

  Get current timestamp in a specific format.

  See Also:

  java.time.format.DateTimeFormatter - Patterns for Formatting and Parsing

  Parameters:

  format - Format of datatime. Default value is yyyyMMddHHmmss

  Returns:

  Timestamp string in specified format. For example, 20190101010101

• static java.lang.String getUriQueryString(java.util.Map params = [:])

  Convert a Map to URL query string.

  Example:

  With input of ['param1': 'value1', 'param2': 234], should expect a result of param1=value1&param2=234

  Parameters:

  params - map to hold the URL parameters

  Returns:

  URL query string

• static java.lang.String interpretSemanticVersionBump(java.util.Map versionTrunks, java.lang.String bump)

  Convert a version bump string to exact new version string.

  Note:

  This method has similar logic as npm version.

  Parameters:

  versionTrunks - Map of version trunks returned from parseSemanticVersion(String).

  bump - New expected version. For example, patch, or minor.

  Returns:

  Interpreted semantic version. For exmaple, 1.2.4.

• static java.lang.String loadResource(java.lang.String path)

  Read resource file

  Example:

       String content = Utils.loadResource('src/test/resources/my-file.txt')
   

  throws:

  IOException if failed to read the file

  Parameters:

  path - path to the resource file

  Returns:

  the file content

• static java.util.Map parseFileExtension(java.lang.String file)

  Return file name and extension with the given file name

  Parameters:

  file - file name to parse

  Returns:

  a map with keys of name and ext

• static java.util.Map parseSemanticVersion(java.lang.String version)

  Parse semantic version into trunks.

  The result should be a Map with these keys:

  • - major
  • - minor
  • - patch
  • - prerelease
  • - metadata

  Example:

  With input: 1.2.3-alpha.1+20190101010101, the method should return an output of:

  • - major: 1
  • - minor: 2
  • - patch: 3
  • - prerelease: alpha.1
  • - metadata: 20190101010101

  Parameters:

  version - the version string to parse

  Returns:

  a Map with major, minor, path, prerelease and metadata keys.

• static java.lang.String sanitizeBranchName(java.lang.String branch)

  Sanitize branch name so it can only contains:

  • - letters
  • - numbers
  • - dash

  Example:

   String branch = 'stagings/mytest'
   String santizedBranch = Utils.sanitizeBranchName(branch)
   assert santizedBranch == 'stagings-mytest'
   

  Parameters:

  branch - branch name

  Returns:

  sanitized branch name

• static java.util.Map toMap(java.lang.Object obj)

  Convert an Object to Map

  Parameters:

  obj - Object to convert

  Returns:

  Map with same properties of the Object

• static java.util.Map waitForInput(java.lang.Object jenkinsSteps, java.util.Map args = [:])

  Pause the Jenkins pipeline and wait for end-user input.

  The result should be a Map include these keys:

  • timeout: a Boolean value if the input has reached timeout.
  • proceed: a Boolean value if the pipeline should proceed. It will be true only if the input is Approved to proceed by a user.
  • user: a nullable string represents who approved/rejected the input.

  Example:

  Pause the pipeline for 30 minutes:

   Map action = Utils.waitForInput(
       this.steps,
       [
           timeout: [time: 30, unit: 'MINUTES'],
           message: "Please verify before continue:"
       ]
   )
   

  Here is senarios what could be returned:

  • [timeout: true, proceed: false, user: 'TIMEOUT']: No one intervened, so the input reached timeout.
  • [timeout: false, proceed: true, user: 'Jack T. Jia']: Jack clicked on Proceed button.
  • [timeout: false, proceed: false, user: 'Jack T. Jia']: Jack chosed to abort the pipeline.

  Parameters:

  jenkinsSteps - jenkins steps object

  args - arguments for the input:

  • - timeout map of timeout. For example [time: 2, unit: 'MINUTES']
  • - message message of the input
  • - proceedButton proceed button text

  Returns:

  A map represents how the input is handled.