org.jboss.pull.shared.spi

Interface PullEvaluator

All Known Implementing Classes:

BasePullEvaluator, BugAndJiraFlagBasedPullEvaluator, BugFlagBasedPullEvaluator, ParentBugBasedPullEvaluator

public interface PullEvaluator

A pull request evaluator service interface.

Author:

Ivo Studensky

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PullEvaluator.Result Result of the evaluation process of a pull request.

Method Summary

Methods

Modifier and Type	Method and Description
List<? extends Issue>	getIssue(RedhatPullRequest pull) Returns the issue(-s) related to the given pull request.
String	getTargetBranch() Returns the github branch this evaluator is dedicated to.
List<RedhatPullRequest>	getUpstreamPullRequest(RedhatPullRequest 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(RedhatPullRequest pull) Evaluates if the given pull request is mergeable according to the rules of the relevant EAP issueFixVersion.
boolean	updateIssueAsMerged(RedhatPullRequest pull) Marks the issue related to the given pull request merged.

Method Detail

init

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

Initializes the evaluator.

Parameters:

helper - PullHelper instance

configuration - configuration properties

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

getTargetBranch

String getTargetBranch()

Returns the github branch this evaluator is dedicated to.

Returns:

the target branch this evaluator is dedicated to.

isMergeable

PullEvaluator.Result isMergeable(RedhatPullRequest pull)

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

Parameters:

pull - a pull request to be evaluated

Returns:

Result result of the evaluation

getIssue

List<? extends Issue> getIssue(RedhatPullRequest pull)

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.

Parameters:

pull - a pull request

Returns:

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

getUpstreamPullRequest

List<RedhatPullRequest> getUpstreamPullRequest(RedhatPullRequest pull)

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

Parameters:

pull - a pull request

Returns:

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

updateIssueAsMerged

boolean updateIssueAsMerged(RedhatPullRequest pull)

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

Parameters:

pull - a pull request

Returns:

true if the issue has been updated, false otherwise