org.datadog.jenkins.plugins.datadog.util.git

Class GitUtils

java.lang.Object

org.datadog.jenkins.plugins.datadog.util.git.GitUtils

public final class GitUtils
extends Object

Method Summary

Modifier and Type	Method and Description
static FilePath	buildFilePath(Run<?,?> run) Return the FilePath associated with the run instance
static FilePath	buildFilePath(String nodeName, String workspace) Return the FilePath based on the Node name and the Workspace.
static GitCommitAction	buildGitCommitAction(Run<?,?> run, org.jenkinsci.plugins.gitclient.GitClient gitClient, String gitCommit) Returns the GitCommitAction of the Run instance.
static GitRepositoryAction	buildGitRepositoryAction(Run<?,?> run, org.jenkinsci.plugins.gitclient.GitClient gitClient, EnvVars envVars, String gitRepositoryURL) Returns the GitRepositoryAction of the Run instance.
static boolean	isCommitInfoAlreadyCreated(Run<?,?> run, String gitCommit) Check if the GitCommitAction has been already created and populated.
static boolean	isRepositoryInfoAlreadyCreated(Run<?,?> run, String gitRepositoryUrl) Check if the GitRepositoryAction has been already created and populated.
static boolean	isUserSuppliedGit(Map<String,String> envVars) Check if the env vars map contains any environment variable with Git information supplied by the user manually.
static boolean	isValidCommit(String gitCommit) Check if the git commit is a valid commit.
static boolean	isValidRepositoryURL(String gitRepositoryURL) Check if the git repository URL is a valid repository
static org.jenkinsci.plugins.gitclient.GitClient	newGitClient(Run<?,?> run, TaskListener listener, EnvVars envVars, String nodeName, String workspace) Creates a new instance of a GitClient.
static String	resolveGitBranch(Map<String,String> envVars, BuildData buildData) Resolve the value for the git branch based 1: Check user supplied env var 2: Check Jenkins env var 3: Check BuildData already calculated
static String	resolveGitCommit(Map<String,String> envVars, BuildData buildData) Resolve the value for the git commit sha based 1: Check user supplied env var 2: Check Jenkins env var 3: Check BuildData already calculated
static String	resolveGitRepositoryUrl(Map<String,String> envVars, BuildData buildData) Resolve the value for the git repository url based 1: Check user supplied env var 2: Check Jenkins env var 3: Check BuildData already calculated
static String	resolveGitTag(Map<String,String> envVars, BuildData buildData) Resolve the value for the git tag based 1: Check user supplied env var 3: Check BuildData already calculated
static RepositoryInfo	searchRepositoryInfo(org.jenkinsci.plugins.gitclient.GitClient gitClient, EnvVars envVars) Return the RepositoryInfo for a certain Git repository.
static org.eclipse.jgit.revwalk.RevCommit	searchRevCommit(org.jenkinsci.plugins.gitclient.GitClient gitClient, String gitCommit) Return the RevCommit for a certain commit based on the information stored in a certain workspace of a certain node.

Methods inherited from class java.lang.Object

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

Method Detail

buildFilePath

public static FilePath buildFilePath(String nodeName,
                                     String workspace)

Return the FilePath based on the Node name and the Workspace.

Parameters:

nodeName - the node name to check

workspace - the workspace to build the path

Returns:

filePath for (nodeName, workspace)

buildFilePath

public static FilePath buildFilePath(Run<?,?> run)

Return the FilePath associated with the run instance

Parameters:

run - a particular execution of a Jenkins build

Returns:

filePath for the run.

searchRevCommit

public static org.eclipse.jgit.revwalk.RevCommit searchRevCommit(org.jenkinsci.plugins.gitclient.GitClient gitClient,
                                                                 String gitCommit)

Return the RevCommit for a certain commit based on the information stored in a certain workspace of a certain node.

Parameters:

gitCommit - the Git commit SHA to search info.

gitClient - the Git client used.

Returns:

revCommit

searchRepositoryInfo

public static RepositoryInfo searchRepositoryInfo(org.jenkinsci.plugins.gitclient.GitClient gitClient,
                                                  EnvVars envVars)

Return the RepositoryInfo for a certain Git repository.

Parameters:

gitClient - The Git client to use to obtain the repository information

envVars - the env vars available.

Returns:

repositoryInfo

buildGitCommitAction

public static GitCommitAction buildGitCommitAction(Run<?,?> run,
                                                   org.jenkinsci.plugins.gitclient.GitClient gitClient,
                                                   String gitCommit)

Returns the GitCommitAction of the Run instance. If the Run instance does not have GitCommitAction or the current commit hash is different from the commit hash stored in the GitCommitAction, then a new GitCommitAction is built and stored in the Run instance. The GitCommit information is stored in an action because it's fairly expensive to calculate. To avoid calculating every time, it's store in the Run instance as an action.

Parameters:

run - a particular execution of a Jenkins build

gitClient - the Git client

gitCommit - the git commit SHA to use

Returns:

the GitCommitAction with the information about Git Commit.

buildGitRepositoryAction

public static GitRepositoryAction buildGitRepositoryAction(Run<?,?> run,
                                                           org.jenkinsci.plugins.gitclient.GitClient gitClient,
                                                           EnvVars envVars,
                                                           String gitRepositoryURL)

Returns the GitRepositoryAction of the Run instance. If the Run instance does not have GitRepositoryAction or some infor is not populated in the GitRepositoryAction, then a new GitCommitAction is built and stored in the Run instance. The GitRepository information is stored in an action because it's fairly expensive to calculate. To avoid calculating every time, it's store in the Run instance as an action.

Parameters:

run - a particular execution of a Jenkins build

gitClient - the Git client

envVars - the env vars available

gitRepositoryURL - the git repository URL to use

Returns:

the GitRepositoryAction with the information about Git repository.

newGitClient

public static org.jenkinsci.plugins.gitclient.GitClient newGitClient(Run<?,?> run,
                                                                     TaskListener listener,
                                                                     EnvVars envVars,
                                                                     String nodeName,
                                                                     String workspace)

Creates a new instance of a GitClient.

Parameters:

run - a particular execution of a Jenkins build

listener - the task listener

envVars - the env vars available

nodeName - the node name to use to build the Git client

workspace - the workspace to use to build the Git client

Returns:

gitClient

isValidCommit

public static boolean isValidCommit(String gitCommit)

Check if the git commit is a valid commit.

Parameters:

gitCommit - the git commit to evaluate

Returns:

true if the git commit is a valid SHA 40 (HEX)

isValidRepositoryURL

public static boolean isValidRepositoryURL(String gitRepositoryURL)

Check if the git repository URL is a valid repository

Parameters:

gitRepositoryURL - the current git repository

Returns:

true if the git repository url is a valid repository in either http or scp form.

isRepositoryInfoAlreadyCreated

public static boolean isRepositoryInfoAlreadyCreated(Run<?,?> run,
                                                     String gitRepositoryUrl)

Check if the GitRepositoryAction has been already created and populated. Typically this method is used to avoid calculating the action multiple times.

Parameters:

run - the current run

gitRepositoryUrl - the current git respository

Returns:

true if the action has been created and populated.

isCommitInfoAlreadyCreated

public static boolean isCommitInfoAlreadyCreated(Run<?,?> run,
                                                 String gitCommit)

Check if the GitCommitAction has been already created and populated. Typically this method is used to avoid calculating the action multiple times.

Parameters:

run - the current run

gitCommit - the git commit to check for

Returns:

true if the action has been created and populated.

resolveGitBranch

public static String resolveGitBranch(Map<String,String> envVars,
                                      BuildData buildData)

Resolve the value for the git branch based 1: Check user supplied env var 2: Check Jenkins env var 3: Check BuildData already calculated

Parameters:

envVars - the user supplied env vars

buildData - the build data

Returns:

the branch value.

resolveGitCommit

public static String resolveGitCommit(Map<String,String> envVars,
                                      BuildData buildData)

Resolve the value for the git commit sha based 1: Check user supplied env var 2: Check Jenkins env var 3: Check BuildData already calculated

Parameters:

envVars - the user supplied env vars

buildData - the build data

Returns:

the commit sha value.

resolveGitRepositoryUrl

public static String resolveGitRepositoryUrl(Map<String,String> envVars,
                                             BuildData buildData)

Resolve the value for the git repository url based 1: Check user supplied env var 2: Check Jenkins env var 3: Check BuildData already calculated

Parameters:

envVars - the user supplied env vars

buildData - the build data

Returns:

the git repository url value.

resolveGitTag

public static String resolveGitTag(Map<String,String> envVars,
                                   BuildData buildData)

Resolve the value for the git tag based 1: Check user supplied env var 3: Check BuildData already calculated

Parameters:

envVars - the user supplied environment variables

buildData - the build data

Returns:

the git tag value.

isUserSuppliedGit

public static boolean isUserSuppliedGit(Map<String,String> envVars)

Check if the env vars map contains any environment variable with Git information supplied by the user manually.

Parameters:

envVars - the environment variables

Returns:

true if any of the env vars is not empty.