Skip to content

Allow for commit status backref configuration #138

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lanwen merged 2 commits into from
Sep 19, 2016
Merged

Allow for commit status backref configuration #138

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8e23c4c
allow for backref configuration
pupssman Sep 19, 2016
fb3dd70
Change test to using JenkinsRule
pupssman Sep 19, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions src/main/java/org/jenkinsci/plugins/github/extension/status/GitHubStatusBackrefSource.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
package org.jenkinsci.plugins.github.extension.status;

import hudson.ExtensionPoint;
import hudson.model.AbstractDescribableImpl;
import hudson.model.Run;
import hudson.model.TaskListener;

/**
* Extension point to provide backref for the status, i.e. to the build or to the test report.
*
* @author pupssman (Kalinin Ivan)
* @since 1.21.2
*/
public abstract class GitHubStatusBackrefSource extends AbstractDescribableImpl<GitHubStatusBackrefSource>
implements ExtensionPoint {

/**
* @param run actual run
* @param listener build listener
*
* @return URL that points to the status source, i.e. test result page
*/
public abstract String get(Run<?, ?> run, TaskListener listener);

}
24 changes: 23 additions & 1 deletion src/main/java/org/jenkinsci/plugins/github/status/GitHubCommitStatusSetter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,13 @@
import org.jenkinsci.plugins.github.common.CombineErrorHandler;
import org.jenkinsci.plugins.github.extension.status.GitHubCommitShaSource;
import org.jenkinsci.plugins.github.extension.status.GitHubReposSource;
import org.jenkinsci.plugins.github.extension.status.GitHubStatusBackrefSource;
import org.jenkinsci.plugins.github.extension.status.GitHubStatusContextSource;
import org.jenkinsci.plugins.github.extension.status.GitHubStatusResultSource;
import org.jenkinsci.plugins.github.extension.status.StatusErrorHandler;
import org.jenkinsci.plugins.github.status.sources.AnyDefinedRepositorySource;
import org.jenkinsci.plugins.github.status.sources.BuildDataRevisionShaSource;
import org.jenkinsci.plugins.github.status.sources.BuildRefBackrefSource;
import org.jenkinsci.plugins.github.status.sources.DefaultCommitContextSource;
import org.jenkinsci.plugins.github.status.sources.DefaultStatusResultSource;
import org.kohsuke.github.GHCommitState;
Expand All @@ -44,6 +46,7 @@ public class GitHubCommitStatusSetter extends Notifier implements SimpleBuildSte
private GitHubReposSource reposSource = new AnyDefinedRepositorySource();
private GitHubStatusContextSource contextSource = new DefaultCommitContextSource();
private GitHubStatusResultSource statusResultSource = new DefaultStatusResultSource();
private GitHubStatusBackrefSource statusBackrefSource = new BuildRefBackrefSource();
private List<StatusErrorHandler> errorHandlers = new ArrayList<>();

@DataBoundConstructor
Expand All @@ -70,6 +73,11 @@ public void setStatusResultSource(GitHubStatusResultSource statusResultSource) {
this.statusResultSource = statusResultSource;
}

@DataBoundSetter
public void setStatusBackrefSource(GitHubStatusBackrefSource statusBackrefSource) {
this.statusBackrefSource = statusBackrefSource;
}

@DataBoundSetter
public void setErrorHandlers(List<StatusErrorHandler> errorHandlers) {
this.errorHandlers = errorHandlers;
Expand Down Expand Up @@ -103,6 +111,13 @@ public GitHubStatusResultSource getStatusResultSource() {
return statusResultSource;
}

/**
* @return backref provider
*/
public GitHubStatusBackrefSource getStatusBackrefSource() {
return statusBackrefSource;
}

/**
* @return error handlers
*/
Expand All @@ -121,7 +136,7 @@ public void perform(@Nonnull Run<?, ?> run, @Nonnull FilePath workspace, @Nonnul
List<GHRepository> repos = getReposSource().repos(run, listener);
String contextName = getContextSource().context(run, listener);

String backref = run.getAbsoluteUrl();
String backref = getStatusBackrefSource().get(run, listener);

GitHubStatusResultSource.StatusResult result = getStatusResultSource().get(run, listener);

Expand All @@ -146,6 +161,13 @@ public BuildStepMonitor getRequiredMonitorService() {
return BuildStepMonitor.NONE;
}

public Object readResolve() {
if (getStatusBackrefSource() == null) {
setStatusBackrefSource(new BuildRefBackrefSource());
}
return this;
}


@Extension
public static class GitHubCommitStatusSetterDescr extends BuildStepDescriptor<Publisher> {
Expand Down
35 changes: 35 additions & 0 deletions src/main/java/org/jenkinsci/plugins/github/status/sources/BuildRefBackrefSource.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
package org.jenkinsci.plugins.github.status.sources;

import org.jenkinsci.plugins.github.extension.status.GitHubStatusBackrefSource;

import hudson.Extension;
import hudson.model.Descriptor;
import hudson.model.Run;
import hudson.model.TaskListener;

/**
* Gets backref from Run URL.
*
* @author pupssman (Kalinin Ivan)
* @since 1.21.2
*
*/
public class BuildRefBackrefSource extends GitHubStatusBackrefSource {
Copy link

@oeuftete oeuftete Oct 3, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://issues.jenkins-ci.org/browse/JENKINS-38611

Caused by: org.kohsuke.stapler.NoStaplerConstructorException: There's no @DataBoundConstructor on any constructor of class org.jenkinsci.plugins.github.status.sources.BuildRefBackrefSource
    at org.kohsuke.stapler.ClassDescriptor.loadConstructorParamNames(ClassDescriptor.java:247)
    at org.kohsuke.stapler.RequestImpl.instantiate(RequestImpl.java:758)
    at org.kohsuke.stapler.RequestImpl.access$200(RequestImpl.java:83)
    at org.kohsuke.stapler.RequestImpl$TypePair.convertJSON(RequestImpl.java:674)
    ... 90 more

Copy link
Member

@lanwen lanwen Oct 3, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will fix it in #141 in a few hours


/**
* Returns absolute URL of the Run
*/
@SuppressWarnings("deprecation")
@Override
public String get(Run<?, ?> run, TaskListener listener) {
return run.getAbsoluteUrl();
}

@Extension
public static class BuildRefBackrefSourceDescriptor extends Descriptor<GitHubStatusBackrefSource> {
@Override
public String getDisplayName() {
return "Backref to the build";
}
}
}
57 changes: 57 additions & 0 deletions src/main/java/org/jenkinsci/plugins/github/status/sources/ManuallyEnteredBackrefSource.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
package org.jenkinsci.plugins.github.status.sources;

import org.jenkinsci.plugins.github.common.ExpandableMessage;
import org.jenkinsci.plugins.github.extension.status.GitHubStatusBackrefSource;
import org.kohsuke.stapler.DataBoundConstructor;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import hudson.Extension;
import hudson.model.Descriptor;
import hudson.model.Run;
import hudson.model.TaskListener;

/**
* Allows to manually enter backref, with env/token expansion.
*
* @author pupssman (Kalinin Ivan)
* @since 1.21.2
*
*/
public class ManuallyEnteredBackrefSource extends GitHubStatusBackrefSource {
private static final Logger LOG = LoggerFactory.getLogger(ManuallyEnteredBackrefSource.class);

private String backref;

@DataBoundConstructor
public ManuallyEnteredBackrefSource(String backref) {
this.backref = backref;
}

public String getBackref() {
return backref;
}

/**
* Just returns what user entered. Expands env vars and token macro
*/
@SuppressWarnings("deprecation")
@Override
public String get(Run<?, ?> run, TaskListener listener) {
try {
return new ExpandableMessage(backref).expandAll(run, listener);
} catch (Exception e) {
LOG.debug("Can't expand backref, returning as is", e);
return backref;
}
}

@Extension
public static class ManuallyEnteredBackrefSourceDescriptor extends Descriptor<GitHubStatusBackrefSource> {
@Override
public String getDisplayName() {
return "Manually entered backref";
}
}

}
1 change: 1 addition & 0 deletions ...main/resources/org/jenkinsci/plugins/github/status/GitHubCommitStatusSetter/config.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ f.section(title: _('Where:')) {
f.section(title: _('What:')) {
f.dropdownDescriptorSelector(title: _('Commit context: '), field: 'contextSource')
f.dropdownDescriptorSelector(title: _('Status result: '), field: 'statusResultSource')
f.dropdownDescriptorSelector(title: _('Status backref: '), field: 'statusBackrefSource')
}

f.advanced {
Expand Down
7 changes: 7 additions & 0 deletions ...resources/org/jenkinsci/plugins/github/status/sources/BuildRefBackrefSource/config.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
package org.jenkinsci.plugins.github.status.sources.BuildRefBackrefSource


def f = namespace(lib.FormTagLib);

f.helpLink(url: descriptor.getHelpFile())
f.helpArea()
3 changes: 3 additions & 0 deletions ...ain/resources/org/jenkinsci/plugins/github/status/sources/BuildRefBackrefSource/help.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<div>
Points commit status backref back to the producing build page.
</div>
8 changes: 8 additions & 0 deletions ...es/org/jenkinsci/plugins/github/status/sources/ManuallyEnteredBackrefSource/config.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
package org.jenkinsci.plugins.github.status.sources.ManuallyEnteredBackrefSource


def f = namespace(lib.FormTagLib);

f.entry(title: _('Backref URL'), field: 'backref') {
f.textbox()
}
3 changes: 3 additions & 0 deletions ...rg/jenkinsci/plugins/github/status/sources/ManuallyEnteredBackrefSource/help-backref.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<div>
A backref URL. Allows env vars and token macro.
</div>
3 changes: 3 additions & 0 deletions ...ources/org/jenkinsci/plugins/github/status/sources/ManuallyEnteredBackrefSource/help.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<div>
A manually entered backref URL.
</div>
45 changes: 45 additions & 0 deletions src/test/java/org/jenkinsci/plugins/github/status/sources/BuildRefBackrefSourceTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
package org.jenkinsci.plugins.github.status.sources;

import hudson.model.FreeStyleProject;
import hudson.model.Run;
import hudson.model.TaskListener;
import org.junit.Rule;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.jvnet.hudson.test.JenkinsRule;
import org.mockito.Answers;
import org.mockito.Mock;
import org.mockito.junit.MockitoJUnit;
import org.mockito.junit.MockitoRule;
import org.mockito.runners.MockitoJUnitRunner;

import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.is;
import static org.mockito.Mockito.when;

/**
* @author pupssman (Kalinin Ivan)
*/
@RunWith(MockitoJUnitRunner.class)
public class BuildRefBackrefSourceTest {

@Rule
public JenkinsRule jenkinsRule = new JenkinsRule();

@Mock(answer = Answers.RETURNS_MOCKS)
private TaskListener listener;

@Test
/**
* Should've used mocked Run, but getAbsoluteUrl is final.
*
* @throws Exception
*/
public void shouldReturnRunAbsoluteUrl() throws Exception {
Run<?, ?> run = jenkinsRule.buildAndAssertSuccess(jenkinsRule.createFreeStyleProject());

String result = new BuildRefBackrefSource().get(run, listener);
assertThat("state", result, is(run.getAbsoluteUrl()));
}

}
9 changes: 9 additions & 0 deletions src/test/java/org/jenkinsci/plugins/github/status/sources/ManuallyEnteredSourcesTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,13 @@ public void shouldExpandSha() throws Exception {
String context = new ManuallyEnteredShaSource("").get(run, listener);
assertThat(context, equalTo(EXPANDED));
}

@Test
public void shouldExpandBackref() throws Exception {
when(run.getEnvironment(listener)).thenReturn(env);
when(env.expand(Matchers.anyString())).thenReturn(EXPANDED);

String context = new ManuallyEnteredBackrefSource("").get(run, listener);
assertThat(context, equalTo(EXPANDED));
}
}