Enable optional support for Jenkins pipelines

Add a global option to enable pipeline support. If it's enabled, don't
require the job to inherit from AbstractProject. Allow any Job subclass
that implements ParameterizedJob, which is true both for freestyle
projects and for pipelines.

Make it clear in the option help text and in README.md that pipeline
support is currently experimental.

Add workflow-job as a test dependency. Add unit tests to make sure that
WorkflowJob is supported only when pipeline support is enabled.

Author: proski

README.md

@@ -137,6 +137,16 @@ These comments can contain environment variables that will be translated when po
 
 This feature can be used to post for instance a URL to the deployed application or code coverage at a successful build and why the build failed like what tests that did not pass.
 
+## Pipeline support
+
+Support for Jenkins pipelines is currently experimental. To enable it, go to *Manage Jenkins*, then *Configure System* and check for *Enable Pipeline Support*.
+
+The configuration is the same as for other projects, but it is not currently possible to customize the comments posted to the Bitbucket Server after the job completion.
+
+Stash Pull Request Builder Plugin could serve as a stepping stone to a more advanced setup using Bitbucket Branch Source Plugin. Unlike the later, this plugin supports inline Groovy scripts for pipeline configuration, which may be handy while figuring out the optimal configuration for the build. Once that configuration is established, it can be added to the sources as `Jenkinsfile`.
+
+Also, this plugin makes conversion to pipelines transparent to the users. The plugin will still post comments about the build status, the rebuild can still be requested with the *"test this please"* comment, the additional parameters continue to work.
+
 ## Copyright
 
 Copyright © 2015 Nathan McCarthy.

pom.xml

@@ -108,6 +108,12 @@
       <artifactId>junit</artifactId>
       <scope>test</scope>
     </dependency>
+    <dependency>
+      <groupId>org.jenkins-ci.plugins.workflow</groupId>
+      <artifactId>workflow-job</artifactId>
+      <version>2.9</version>
+     <scope>test</scope>
+    </dependency>
   </dependencies>
 
   <repositories>

src/main/java/stashpullrequestbuilder/stashpullrequestbuilder/StashBuildTrigger.java

@@ -229,12 +229,27 @@ public boolean getOnlyBuildOnComment() {
   }
 
   public static final class DescriptorImpl extends TriggerDescriptor {
+    private boolean enablePipelineSupport;
+
     public DescriptorImpl() {
       load();
     }
 
+    public boolean getEnablePipelineSupport() {
+      return enablePipelineSupport;
+    }
+
+    @DataBoundSetter
+    public void setEnablePipelineSupport(boolean enablePipelineSupport) {
+      this.enablePipelineSupport = enablePipelineSupport;
+    }
+
     @Override
     public boolean isApplicable(Item item) {
+      if (enablePipelineSupport) {
+        return item instanceof Job && item instanceof ParameterizedJob;
+      }
+
       return item instanceof AbstractProject;
     }
 
@@ -245,6 +260,9 @@ public String getDisplayName() {
 
     @Override
     public boolean configure(StaplerRequest req, JSONObject json) throws FormException {
+      enablePipelineSupport = false;
+
+      req.bindJSON(this, json);
       save();
       return super.configure(req, json);
     }

src/main/resources/stashpullrequestbuilder/stashpullrequestbuilder/StashBuildTrigger/global.jelly

@@ -0,0 +1,8 @@
+<?jelly escape-by-default='true'?>
+<j:jelly xmlns:j="jelly:core" xmlns:f="/lib/form">
+  <f:section title="Stash Pull Request Builder">
+    <f:entry title="Enable pipeline support (experimental)" field="enablePipelineSupport">
+      <f:checkbox />
+    </f:entry>
+  </f:section>
+</j:jelly>

src/main/resources/stashpullrequestbuilder/stashpullrequestbuilder/StashBuildTrigger/help-enablePipelineSupport.html

@@ -0,0 +1,11 @@
+<div>
+  <p>
+    Enable support for pipelines. When checked, Stash Pull Request
+    Builder will be available in pipeline based projects. Please note
+    that pipeline support is experimental.
+  </p>
+  <p>
+    Another way to support pipelines with Bitbucket Server is to use
+    Bitbucket Branch Source Plugin.
+  </p>
+</div>

src/test/java/stashpullrequestbuilder/stashpullrequestbuilder/StashBuildTriggerTest.java

@@ -3,13 +3,25 @@
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.Matchers.is;
 import static org.hamcrest.Matchers.notNullValue;
+import static org.mockito.Mockito.lenient;
+import static org.mockito.Mockito.mock;
 
 import hudson.model.Descriptor.PropertyType;
+import hudson.model.FreeStyleProject;
 import java.util.Arrays;
+import java.util.Collections;
+import javax.servlet.ServletContext;
+import javax.servlet.http.HttpServletRequest;
+import net.sf.json.JSONObject;
+import org.jenkinsci.plugins.workflow.job.WorkflowJob;
 import org.junit.Rule;
 import org.junit.Test;
 import org.junit.runner.RunWith;
 import org.jvnet.hudson.test.JenkinsRule;
+import org.kohsuke.stapler.RequestImpl;
+import org.kohsuke.stapler.Stapler;
+import org.kohsuke.stapler.StaplerRequest;
+import org.kohsuke.stapler.WebApp;
 import org.mockito.junit.MockitoJUnit;
 import org.mockito.junit.MockitoJUnitRunner;
 import org.mockito.junit.MockitoRule;
@@ -21,6 +33,65 @@ public class StashBuildTriggerTest {
   @Rule public JenkinsRule jenkinsRule = new JenkinsRule();
   @Rule public MockitoRule rule = MockitoJUnit.rule().strictness(Strictness.STRICT_STUBS);
 
+  private StaplerRequest makeStaplerRequest() {
+    ServletContext servletContext = mock(ServletContext.class);
+    WebApp webApp = new WebApp(servletContext);
+
+    Stapler stapler = mock(Stapler.class);
+    lenient().when(stapler.getWebApp()).thenReturn(webApp);
+
+    HttpServletRequest servletRequest = mock(HttpServletRequest.class);
+
+    return new RequestImpl(stapler, servletRequest, Collections.emptyList(), null);
+  }
+
+  @Test
+  public void pipeline_jobs_not_supported_by_default() throws Exception {
+    JSONObject json = new JSONObject();
+
+    StaplerRequest staplerRequest = makeStaplerRequest();
+    StashBuildTrigger.DescriptorImpl descriptor = new StashBuildTrigger.DescriptorImpl();
+    descriptor.configure(staplerRequest, json);
+
+    FreeStyleProject project = jenkinsRule.createFreeStyleProject();
+    assertThat(descriptor.isApplicable(project), is(true));
+
+    WorkflowJob workflowJob = jenkinsRule.createProject(WorkflowJob.class);
+    assertThat(descriptor.isApplicable(workflowJob), is(false));
+  }
+
+  @Test
+  public void pipeline_jobs_not_supported_when_pipeline_support_disabled() throws Exception {
+    JSONObject json = new JSONObject();
+    json.put("enablePipelineSupport", "false");
+
+    StaplerRequest staplerRequest = makeStaplerRequest();
+    StashBuildTrigger.DescriptorImpl descriptor = new StashBuildTrigger.DescriptorImpl();
+    descriptor.configure(staplerRequest, json);
+
+    FreeStyleProject project = jenkinsRule.createFreeStyleProject();
+    assertThat(descriptor.isApplicable(project), is(true));
+
+    WorkflowJob workflowJob = jenkinsRule.createProject(WorkflowJob.class);
+    assertThat(descriptor.isApplicable(workflowJob), is(false));
+  }
+
+  @Test
+  public void pipeline_jobs_supported_when_pipeline_support_enabled() throws Exception {
+    JSONObject json = new JSONObject();
+    json.put("enablePipelineSupport", "true");
+
+    StaplerRequest staplerRequest = makeStaplerRequest();
+    StashBuildTrigger.DescriptorImpl descriptor = new StashBuildTrigger.DescriptorImpl();
+    descriptor.configure(staplerRequest, json);
+
+    FreeStyleProject project = jenkinsRule.createFreeStyleProject();
+    assertThat(descriptor.isApplicable(project), is(true));
+
+    WorkflowJob workflowJob = jenkinsRule.createProject(WorkflowJob.class);
+    assertThat(descriptor.isApplicable(workflowJob), is(true));
+  }
+
   @Test
   public void check_getters() throws Exception {
     StashBuildTrigger.DescriptorImpl descriptor = StashBuildTrigger.descriptor;