com.compuware.ispw.git

Class GitToIspwUtils

java.lang.Object

com.compuware.ispw.git.GitToIspwUtils

public class GitToIspwUtils
extends Object

Constructor Summary

Constructors

Constructor and Description
GitToIspwUtils()

Method Summary

Modifier and Type	Method and Description
static hudson.util.ListBoxModel	buildContainerPrefItems(jenkins.model.Jenkins context, String containerPref, hudson.model.Item project)
static hudson.util.ListBoxModel	buildStandardCredentialsIdItems(jenkins.model.Jenkins context, String credentialsId, hudson.model.Item project)
static List<CustomGitChangeSetList>	calculateGitSCMChanges(hudson.model.Run<?,?> run, hudson.FilePath workspace, hudson.model.TaskListener listener, hudson.EnvVars envVars, IGitToIspwPublish publishStep)
static boolean	callCli(hudson.Launcher launcher, hudson.model.Run<?,?> build, PrintStream logger, hudson.EnvVars envVars, RefMap refMap, IGitToIspwPublish publishStep) Calls the IspwCLI and returns whether the execution was successful.
static String	escapeArgument(String args) Escapes the string argument passed in to conform with CLI standards
static List<? extends hudson.scm.ChangeLogSet<? extends hudson.scm.ChangeLogSet.Entry>>	getChangeSets(hudson.model.Run<?,?> run, PrintStream logger) Get the changed log
static hudson.FilePath	getFilePathInVirtualWorkspace(hudson.EnvVars envVars, String fileName) Get file path in virtual workspace
static hudson.plugins.git.Revision	getRevision(org.jenkinsci.plugins.workflow.job.WorkflowRun run, hudson.plugins.git.GitSCM gitSCM) get the Git revision of the specific build of the multibranch pipeline project
static boolean	isReCalculateChangesRequired(org.jenkinsci.plugins.workflow.job.WorkflowRun run, hudson.model.TaskListener listener)
static boolean	isSameRevision(hudson.plugins.git.Revision firstRevision, hudson.plugins.git.Revision secondBuildRevision) Check if the same revision is used between two runs for a multibranch pipeline project
static boolean	isSameRevisionUsedbyLastBuild(org.jenkinsci.plugins.workflow.job.WorkflowRun run, hudson.plugins.git.GitSCM gitSCM, PrintStream logger) check if the same revision is used by requested build and its previous build
static Map<String,RefMap>	parse(String branchMapping)
static void	trimEnvironmentVariables(hudson.EnvVars envVars) Gets the ref, refId, fromHash, and toHash environment variables and trims them to empty.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GitToIspwUtils

public GitToIspwUtils()

Method Detail

buildStandardCredentialsIdItems

public static hudson.util.ListBoxModel buildStandardCredentialsIdItems(@AncestorInPath
                                                                       jenkins.model.Jenkins context,
                                                                       @QueryParameter
                                                                       String credentialsId,
                                                                       @AncestorInPath
                                                                       hudson.model.Item project)

buildContainerPrefItems

public static hudson.util.ListBoxModel buildContainerPrefItems(@AncestorInPath
                                                               jenkins.model.Jenkins context,
                                                               @QueryParameter
                                                               String containerPref,
                                                               @AncestorInPath
                                                               hudson.model.Item project)

parse

public static Map<String,RefMap> parse(String branchMapping)

trimEnvironmentVariables

public static void trimEnvironmentVariables(hudson.EnvVars envVars)

Gets the ref, refId, fromHash, and toHash environment variables and trims them to empty.

Parameters:

envVars - the EnvVars for Jenkins

getFilePathInVirtualWorkspace

public static hudson.FilePath getFilePathInVirtualWorkspace(hudson.EnvVars envVars,
                                                            String fileName)

Get file path in virtual workspace

Parameters:

envVars - the jenkins env

fileName - the file inside virtual workspace

Returns:

the file path

callCli

public static boolean callCli(hudson.Launcher launcher,
                              hudson.model.Run<?,?> build,
                              PrintStream logger,
                              hudson.EnvVars envVars,
                              RefMap refMap,
                              IGitToIspwPublish publishStep)
                       throws InterruptedException,
                              IOException

Calls the IspwCLI and returns whether the execution was successful. Any exceptions thrown by the executor are caught and returned as a boolean.

Parameters:

launcher - the launcher

build - the Jenkins Run

logger - the logger

envVars - the environment variables including ref, refId, fromHash, and toHash

refMap - the ref map

publishStep - publish step

Returns:

a boolean to indicate success

Throws:

InterruptedException - the exception

IOException - the exception

getChangeSets

public static List<? extends hudson.scm.ChangeLogSet<? extends hudson.scm.ChangeLogSet.Entry>> getChangeSets(hudson.model.Run<?,?> run,
                                                                                                             PrintStream logger)

Get the changed log

Parameters:

run - the Jenkins build

logger - logging the message

Returns:

list of ChangeLogSet

isSameRevisionUsedbyLastBuild

public static boolean isSameRevisionUsedbyLastBuild(org.jenkinsci.plugins.workflow.job.WorkflowRun run,
                                                    hudson.plugins.git.GitSCM gitSCM,
                                                    PrintStream logger)

check if the same revision is used by requested build and its previous build

Parameters:

run - the requested build

gitSCM - the Git SCM used by the build

logger - logger for logging the message

Returns:

true or false

isSameRevision

public static boolean isSameRevision(hudson.plugins.git.Revision firstRevision,
                                     hudson.plugins.git.Revision secondBuildRevision)

Check if the same revision is used between two runs for a multibranch pipeline project

Parameters:

firstRevision - first revision to compare

secondBuildRevision - second revision to compare

Returns:

true or false

getRevision

public static hudson.plugins.git.Revision getRevision(org.jenkinsci.plugins.workflow.job.WorkflowRun run,
                                                      hudson.plugins.git.GitSCM gitSCM)

get the Git revision of the specific build of the multibranch pipeline project

Parameters:

run - the current build of the multibranch pipeline project

gitSCM - the Git SCM of the multibranch pipeline project

Returns:

Revision returns the Git revision of the Jenkins build.

isReCalculateChangesRequired

public static boolean isReCalculateChangesRequired(org.jenkinsci.plugins.workflow.job.WorkflowRun run,
                                                   hudson.model.TaskListener listener)

Parameters:

run - the workflow run instance

listener - the task listener

Returns:

true if need recalc

calculateGitSCMChanges

public static List<CustomGitChangeSetList> calculateGitSCMChanges(hudson.model.Run<?,?> run,
                                                                  hudson.FilePath workspace,
                                                                  hudson.model.TaskListener listener,
                                                                  hudson.EnvVars envVars,
                                                                  IGitToIspwPublish publishStep)

escapeArgument

public static String escapeArgument(String args)

Escapes the string argument passed in to conform with CLI standards

Parameters:

args - The command argument

Returns:

The escaped command argument, or the same command argument if no character substitution was done