Merge pull request #401 from CoreMedia/JENKINS-27125

[JENKINS-27125] ignorePostCommitHooks option for SCM trigger

Author: daspilker

docs/Home.md

@@ -18,6 +18,7 @@ Have a look at the [Jenkins Job DSL Gradle example](https://github.com/sheehan/j
 ## Release Notes
 * 1.31 (unreleased)
  * Added support for [Pre-SCM Build Step Plugin](https://wiki.jenkins-ci.org/display/JENKINS/pre-scm-buildstep)
+ * Added `ignorePostCommitHooks` option for SCM trigger
  * The enum argument of `localRepository` for the Maven job and context has changed, see [[Migration]]
 * 1.30 (March 08 2015)
  * Added support for [Custom Tools Plugin](https://wiki.jenkins-ci.org/display/JENKINS/Custom+Tools+Plugin)

docs/Job-reference.md

@@ -85,6 +85,7 @@ freeStyleJob(String name) { // since 1.30
         githubPush()
         pullRequest(Closure pullRequestClosure) // since 1.22
         scm(String cron)
+        scm(String cron, Closure scmTriggerClosure) // since 1.31
         snapshotDependencies(boolean checkSnapshotDependencies)
         urlTrigger(String cronString = null, Closure urlTriggerClosure)
     }
@@ -1276,12 +1277,35 @@ cron(String cronString)
 Triggers job based on regular intervals.
 
 ### Source Control Trigger
+
 ```groovy
-scm(String cronString)
+job {
+    triggers {
+        scm(String cronString) {
+            ignorePostCommitHooks(boolean ignorePostCommitHooks = true) // since 1.31
+        }
+    }
+}
 ```
 
 Polls source control for changes at regular intervals.
 
+```groovy
+job {
+    triggers {
+        scm('@daily')
+    }
+}
+
+job {
+    triggers {
+        scm('@midnight') {
+            ignorePostCommitHooks()
+        }
+    }
+}
+```
+
 ### Github Push Notification Trigger
 ```groovy
 githubPush()

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

@@ -0,0 +1,11 @@
+package javaposse.jobdsl.dsl.helpers.triggers
+
+import javaposse.jobdsl.dsl.Context
+
+class ScmTriggerContext implements Context {
+    boolean ignorePostCommitHooks
+
+    void ignorePostCommitHooks(boolean ignorePostCommitHooks = true) {
+        this.ignorePostCommitHooks = ignorePostCommitHooks
+    }
+}

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

@@ -92,12 +92,18 @@ class TriggerContext implements Context {
     /**
      * <hudson.triggers.SCMTrigger>
      *     <spec>10 * * * *</spec>
+     *     <ignorePostCommitHooks>false</ignorePostCommitHooks>
      * </hudson.triggers.SCMTrigger>
      */
-    void scm(String cronString) {
+    void scm(String cronString, @DslContext(ScmTriggerContext) Closure scmTriggerClosure = null) {
         Preconditions.checkNotNull(cronString)
+
+        ScmTriggerContext scmTriggerContext = new ScmTriggerContext()
+        ContextHelper.executeInContext(scmTriggerClosure, scmTriggerContext)
+
         triggerNodes << new NodeBuilder().'hudson.triggers.SCMTrigger' {
             spec cronString
+            ignorePostCommitHooks scmTriggerContext.ignorePostCommitHooks
         }
     }
 

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

@@ -283,6 +283,21 @@ class TriggerContextSpec extends Specification {
         timerTrigger.spec[0].value() == '*/5 * * * *'
     }
 
+    def 'call scm trigger with closure'() {
+        when:
+        context.scm('*/5 * * * *') {
+            ignorePostCommitHooks()
+        }
+
+        then:
+        with(context.triggerNodes[0]) {
+            name() == 'hudson.triggers.SCMTrigger'
+            children().size() == 2
+            spec[0].value() == '*/5 * * * *'
+            ignorePostCommitHooks[0].value() == true
+        }
+    }
+
     def 'call pull request trigger with no args'() {
         when:
         context.pullRequest()