io.jenkins.plugins.forensics.git.util

Class GitRepositoryValidator

java.lang.Object

io.jenkins.plugins.forensics.git.util.GitRepositoryValidator

public class GitRepositoryValidator
extends Object

Inspects a given working tree and determines if this path is a valid Git repository that can be used to run one of the forensics analyzers.

Author:

Ullrich Hafner

Field Summary

Fields

Modifier and Type	Field and Description
static String	INFO_SHALLOW_CLONE Error message.

Constructor Summary

Constructors

Constructor and Description
GitRepositoryValidator(SCM scm, Run<?,?> build, FilePath workTree, TaskListener listener, edu.hm.hafner.util.FilteredLog logger) Creates a new GitRepositoryValidator.

Method Summary

Modifier and Type	Method and Description
org.jenkinsci.plugins.gitclient.GitClient	createClient() Creates a GitClient using the field values.
String	getHead() Returns the GIT_COMMIT environment variable, or 'HEAD' if not set.
String	getId() Returns the key for the associated SCM.
SCM	getScm() Returns the associated SCM.
boolean	isGitRepository() Returns whether the specified working tree contains a valid Git repository that can be used to run one of the forensics analyzers.

Methods inherited from class java.lang.Object

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

Field Detail

INFO_SHALLOW_CLONE

public static final String INFO_SHALLOW_CLONE

Error message.

See Also:

Constant Field Values

Constructor Detail

GitRepositoryValidator

public GitRepositoryValidator(SCM scm,
                              Run<?,?> build,
                              FilePath workTree,
                              TaskListener listener,
                              edu.hm.hafner.util.FilteredLog logger)

Creates a new GitRepositoryValidator.

Parameters:

scm - the SCM to create the blamer for

build - the current build

workTree - the working tree to inspect

listener - a task listener

logger - a logger to report error messages

Method Detail

isGitRepository

public boolean isGitRepository()

Returns whether the specified working tree contains a valid Git repository that can be used to run one of the forensics analyzers.

Returns:

true if the working tree contains a valid repository, false otherwise

createClient

public org.jenkinsci.plugins.gitclient.GitClient createClient()

Creates a GitClient using the field values.

Returns:

a GitClient

getHead

public String getHead()

Returns the GIT_COMMIT environment variable, or 'HEAD' if not set.

Returns:

a GitClient

getId

public String getId()

Returns the key for the associated SCM.

Returns:

the SCM key

getScm

public SCM getScm()

Returns the associated SCM.

Returns:

the SCM