Merge branch 'JENKINS-27504'

Author: daspilker

docs/Home.md

@@ -22,6 +22,7 @@ Have a look at the [Jenkins Job DSL Gradle example](https://github.com/sheehan/j
  * Added support for [Sonar Plugin](http://docs.sonarqube.org/display/SONAR/Jenkins+Plugin)
  * Added `recurse` option for list views
  * Added `ignorePostCommitHooks` option for SCM trigger
+ * Added `commentFilePath` option for [GitHub Pull Request Builder Plugin](https://wiki.jenkins-ci.org/display/JENKINS/GitHub+pull+request+builder+plugin)
  * Added "Configure Project" column for [Extra Columns Plugin](https://wiki.jenkins-ci.org/display/JENKINS/Extra+Columns+Plugin)
  * Added support for [PostBuildScript Plugin](https://wiki.jenkins-ci.org/display/JENKINS/PostBuildScript+Plugin)
  * Added support for [Xvfb Plugin](https://wiki.jenkins-ci.org/display/JENKINS/Xvfb+Plugin)

docs/Job-reference.md

@@ -1366,23 +1366,29 @@ gerrit {
 ### Github Pull Request Trigger
 
 ```groovy
-pullRequest {
-    admin(String admin) // add admin
-    admins(Iterable<String> admins) // add admins
-    userWhitelist(String user) // add user to whitelist
-    userWhitelist(Iterable<String> users) // add users to whitelist
-    orgWhitelist(String organization) // add organization to whitelist
-    orgWhitelist(Iterable<String> organizations) // add organizations to whitelist
-    cron(String cron) // set cron schedule, defaults to 'H/5 * * * *'
-    triggerPhrase(String triggerPhrase) // set phrase to trigger by commenting within the pull request
-    onlyTriggerPhrase(boolean onlyTriggerPhrase = true) // defaults to false if not specified
-    useGitHubHooks(boolean useGithubHooks = true) // defaults to false if not specified
-    permitAll(boolean permitAll = true) // defaults to false if not specified
-    autoCloseFailedPullRequests(boolean autoCloseFailedPullRequests = true) // defaults to false if not specified
+job('example') {
+    triggers {
+        pullRequest {
+            admin(String admin)
+            admins(Iterable<String> admins)
+            userWhitelist(String user)
+            userWhitelist(Iterable<String> users)
+            orgWhitelist(String organization)
+            orgWhitelist(Iterable<String> organizations)
+            cron(String cron)                                 // defaults to 'H/5 * * * *'
+            triggerPhrase(String triggerPhrase)
+            onlyTriggerPhrase(boolean value = true)            // defaults to false
+            useGitHubHooks(boolean useGithubHooks = true)     // defaults to false
+            permitAll(boolean permitAll = true)               // defaults to false
+            autoCloseFailedPullRequests(boolean value = true) // defaults to false
+            commentFilePath(String commentFilePath)           // since 1.31
+        }
+    }
 }
 ```
 
-Builds pull requests from GitHub and will report the results directly to the pull request. Requires the [GitHub pull request builder plugin](https://wiki.jenkins-ci.org/display/JENKINS/GitHub+pull+request+builder+plugin). (Available since 1.22)
+Builds pull requests from GitHub and will report the results directly to the pull request. Requires the
+[GitHub pull request builder plugin](https://wiki.jenkins-ci.org/display/JENKINS/GitHub+pull+request+builder+plugin).
 
 The pull request builder plugin requires a special Git SCM configuration, see the plugin documentation for details.
 
@@ -1399,9 +1405,9 @@ job('example') {
     }
     triggers {
         pullRequest {
-            admins('USER_ID')
+            admin('USER_ID')
             userWhitelist('[email protected]')
-            orgWhitelist('your_github_org', 'another_org')
+            orgWhitelist(['your_github_org', 'another_org'])
             cron('H/5 * * * *')
             triggerPhrase('Ok to test')
             onlyTriggerPhrase()
@@ -1413,6 +1419,8 @@ job('example') {
 }
 ```
 
+(since 1.22)
+
 ### URL Trigger
 
 The URL trigger plugin checks one or more specified URLs and starts a build when a change is detected. (Since 1.16)

job-dsl-core/src/main/groovy/javaposse/jobdsl/dsl/helpers/triggers/PullRequestBuilderContext.groovy

@@ -1,17 +1,25 @@
 package javaposse.jobdsl.dsl.helpers.triggers
 
 import javaposse.jobdsl.dsl.Context
+import javaposse.jobdsl.dsl.JobManagement
 
 class PullRequestBuilderContext implements Context {
+    private final JobManagement jobManagement
+
     List admins = []
     List userWhitelist = []
     List orgWhitelist = []
     String cron = 'H/5 * * * *'
-    String triggerPhrase = ''
+    String triggerPhrase
     boolean onlyTriggerPhrase = false
     boolean useGitHubHooks = false
     boolean permitAll = false
     boolean autoCloseFailedPullRequests = false
+    String commentFilePath
+
+    PullRequestBuilderContext(JobManagement jobManagement) {
+        this.jobManagement = jobManagement
+    }
 
     void admin(String admin) {
         admins << admin
@@ -47,6 +55,12 @@ class PullRequestBuilderContext implements Context {
         this.cron = cron
     }
 
+    void commentFilePath(String commentFilePath) {
+        jobManagement.requireMinimumPluginVersion('ghprb', '1.14')
+
+        this.commentFilePath = commentFilePath
+    }
+
     void triggerPhrase(String triggerPhrase) {
         this.triggerPhrase = triggerPhrase
     }
@@ -66,5 +80,4 @@ class PullRequestBuilderContext implements Context {
     void autoCloseFailedPullRequests(boolean autoCloseFailedPullRequests = true) {
         this.autoCloseFailedPullRequests = autoCloseFailedPullRequests
     }
-
 }

job-dsl-core/src/main/groovy/javaposse/jobdsl/dsl/helpers/triggers/TriggerContext.groovy

@@ -135,10 +135,11 @@ class TriggerContext implements Context {
      *      <useGitHubHooks>true</useGitHubHooks>
      *      <permitAll>true</permitAll>
      *      <autoCloseFailedPullRequests>false</autoCloseFailedPullRequests>
+     *      <commentFilePath>$WORKSPACE/myCommentFile.log</commentFilePath>
      *  </org.jenkinsci.plugins.ghprb.GhprbTrigger>
      */
     void pullRequest(@DslContext(PullRequestBuilderContext) Closure contextClosure) {
-        PullRequestBuilderContext pullRequestBuilderContext = new PullRequestBuilderContext()
+        PullRequestBuilderContext pullRequestBuilderContext = new PullRequestBuilderContext(jobManagement)
         ContextHelper.executeInContext(contextClosure, pullRequestBuilderContext)
 
         triggerNodes << new NodeBuilder().'org.jenkinsci.plugins.ghprb.GhprbTrigger' {
@@ -147,11 +148,12 @@ class TriggerContext implements Context {
             orgslist pullRequestBuilderContext.orgWhitelist.join('\n')
             delegate.cron(pullRequestBuilderContext.cron)
             spec pullRequestBuilderContext.cron
-            triggerPhrase pullRequestBuilderContext.triggerPhrase
+            triggerPhrase pullRequestBuilderContext.triggerPhrase ?: ''
             onlyTriggerPhrase pullRequestBuilderContext.onlyTriggerPhrase
             useGitHubHooks pullRequestBuilderContext.useGitHubHooks
             permitAll pullRequestBuilderContext.permitAll
             autoCloseFailedPullRequests pullRequestBuilderContext.autoCloseFailedPullRequests
+            commentFilePath pullRequestBuilderContext.commentFilePath ?: ''
         }
     }
 

job-dsl-core/src/test/groovy/javaposse/jobdsl/dsl/helpers/triggers/TriggerContextSpec.groovy

@@ -300,7 +300,8 @@ class TriggerContextSpec extends Specification {
 
     def 'call pull request trigger with no args'() {
         when:
-        context.pullRequest()
+        context.pullRequest {
+        }
 
         then:
         def pullRequestNode = context.triggerNodes[0]
@@ -315,6 +316,7 @@ class TriggerContextSpec extends Specification {
             adminlist[0].value() == ''
             whitelist[0].value() == ''
             orgslist[0].value() == ''
+            commentFilePath[0].value() == ''
         }
 
     }
@@ -348,6 +350,7 @@ class TriggerContextSpec extends Specification {
             useGitHubHooks(true)
             permitAll(true)
             autoCloseFailedPullRequests(true)
+            commentFilePath('myCommentFile')
         }
 
         then:
@@ -364,7 +367,9 @@ class TriggerContextSpec extends Specification {
             useGitHubHooks[0].value() == true
             permitAll[0].value() == true
             autoCloseFailedPullRequests[0].value() == true
+            commentFilePath[0].value() == 'myCommentFile'
         }
+        1 * mockJobManagement.requireMinimumPluginVersion('ghprb', '1.14')
     }
 
     def 'call empty gerrit trigger methods'() {