org.jboss.pull.shared.evaluators

Class BasePullEvaluator

java.lang.Object

org.jboss.pull.shared.evaluators.BasePullEvaluator

All Implemented Interfaces:

PullEvaluator

Direct Known Subclasses:

BugAndJiraFlagBasedPullEvaluator, BugFlagBasedPullEvaluator, ParentBugBasedPullEvaluator

public abstract class BasePullEvaluator
extends Object
implements PullEvaluator

An abstract base evaluator which holds the target github branch.

Author:

Ivo Studensky

Nested Class Summary

Nested classes/interfaces inherited from interface org.jboss.pull.shared.spi.PullEvaluator

PullEvaluator.Result

Field Summary

Fields

Modifier and Type	Field and Description
static Pattern	BUGZILLA_ID_PATTERN
static String	EVALUATOR_PROPERTY
static String	GITHUB_BRANCH_PROPERTY
static String	GITHUB_BRANCH_UPSTREAM
static String	GITHUB_ORGANIZAITON_UPSTREAM
static String	GITHUB_REPOSITORY_UPSTREAM
protected String	githubBranch
protected PullHelper	helper
static String	ISSUE_FIX_VERSION
protected String	issueFixVersion
protected String	upstreamBranch
protected String	upstreamOrganization
protected String	upstreamRepository

Constructor Summary

Constructors

Constructor and Description
BasePullEvaluator()

Method Summary

Methods

Modifier and Type	Method and Description
protected List<Bug>	getBug(org.eclipse.egit.github.core.PullRequest pull)
List<? extends Issue>	getIssue(org.eclipse.egit.github.core.PullRequest pull) Returns the issue(-s) related to the given pull request.
protected List<JiraIssue>	getJiraIssue(org.eclipse.egit.github.core.PullRequest pull)
String	getTargetBranch() Returns the github branch this evaluator is dedicated to.
List<org.eclipse.egit.github.core.PullRequest>	getUpstreamPullRequest(org.eclipse.egit.github.core.PullRequest pull) Returns the upstream pull request(-s) related to the given pull request.
void	init(PullHelper helper, Properties configuration, String version) Initializes the evaluator.
PullEvaluator.Result	isMergeable(org.eclipse.egit.github.core.PullRequest pull) Evaluates if the given pull request is mergeable according to the rules of the relevant EAP issueFixVersion.
protected PullEvaluator.Result	isMergeableByUpstream(org.eclipse.egit.github.core.PullRequest pull)
static boolean	isReviewed(PullEvaluator.Result result)
boolean	updateIssueAsMerged(org.eclipse.egit.github.core.PullRequest pull) Marks the issue related to the given pull request merged.

Methods inherited from class java.lang.Object

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

Field Detail

BUGZILLA_ID_PATTERN

public static final Pattern BUGZILLA_ID_PATTERN

EVALUATOR_PROPERTY

public static final String EVALUATOR_PROPERTY

See Also:

Constant Field Values

GITHUB_BRANCH_PROPERTY

public static final String GITHUB_BRANCH_PROPERTY

See Also:

Constant Field Values

GITHUB_ORGANIZAITON_UPSTREAM

public static final String GITHUB_ORGANIZAITON_UPSTREAM

See Also:

Constant Field Values

GITHUB_REPOSITORY_UPSTREAM

public static final String GITHUB_REPOSITORY_UPSTREAM

See Also:

Constant Field Values

GITHUB_BRANCH_UPSTREAM

public static final String GITHUB_BRANCH_UPSTREAM

See Also:

Constant Field Values

ISSUE_FIX_VERSION

public static final String ISSUE_FIX_VERSION

See Also:

Constant Field Values

helper

protected PullHelper helper

issueFixVersion

protected String issueFixVersion

githubBranch

protected String githubBranch

upstreamOrganization

protected String upstreamOrganization

upstreamRepository

protected String upstreamRepository

upstreamBranch

protected String upstreamBranch

Constructor Detail

BasePullEvaluator

public BasePullEvaluator()

Method Detail

init

public void init(PullHelper helper,
        Properties configuration,
        String version)

Description copied from interface: PullEvaluator

Initializes the evaluator.

Specified by:

init in interface PullEvaluator

Parameters:

helper - PullHelper instance

configuration - configuration properties

version - issueFixVersion name related to this evaluator in the configuration properties

getTargetBranch

public String getTargetBranch()

Description copied from interface: PullEvaluator

Returns the github branch this evaluator is dedicated to.

Specified by:

getTargetBranch in interface PullEvaluator

Returns:

the target branch this evaluator is dedicated to.

isMergeable

public PullEvaluator.Result isMergeable(org.eclipse.egit.github.core.PullRequest pull)

Description copied from interface: PullEvaluator

Evaluates if the given pull request is mergeable according to the rules of the relevant EAP issueFixVersion.

Specified by:

isMergeable in interface PullEvaluator

Parameters:

pull - a pull request to be evaluated

Returns:

Result result of the evaluation

isReviewed

public static boolean isReviewed(PullEvaluator.Result result)

updateIssueAsMerged

public boolean updateIssueAsMerged(org.eclipse.egit.github.core.PullRequest pull)

Description copied from interface: PullEvaluator

Marks the issue related to the given pull request merged. Typically in Bugzilla to state MODIFIED, in JIRA to state Resolved.

Specified by:

updateIssueAsMerged in interface PullEvaluator

Parameters:

pull - a pull request

Returns:

true if the issue has been updated, false otherwise

getIssue

public List<? extends Issue> getIssue(org.eclipse.egit.github.core.PullRequest pull)

Description copied from interface: PullEvaluator

Returns the issue(-s) related to the given pull request. It can either be a JiraIssue if the pull request is tracked in Jira or a Bug if it is tracked by Bugzilla or a list of both.

Specified by:

getIssue in interface PullEvaluator

Parameters:

pull - a pull request

Returns:

the issue(-s) related to the pull request.

getUpstreamPullRequest

public List<org.eclipse.egit.github.core.PullRequest> getUpstreamPullRequest(org.eclipse.egit.github.core.PullRequest pull)

Description copied from interface: PullEvaluator

Returns the upstream pull request(-s) related to the given pull request.

Specified by:

getUpstreamPullRequest in interface PullEvaluator

Parameters:

pull - a pull request

Returns:

the upstream pull request(-s) related to the pull request.

isMergeableByUpstream

protected PullEvaluator.Result isMergeableByUpstream(org.eclipse.egit.github.core.PullRequest pull)

getJiraIssue

protected List<JiraIssue> getJiraIssue(org.eclipse.egit.github.core.PullRequest pull)

getBug

protected List<Bug> getBug(org.eclipse.egit.github.core.PullRequest pull)