Make @IgnoreIf repeatable (#1030) (#1188)

Author: Vampire

docs/extensions.adoc

@@ -102,13 +102,12 @@ later feature methods may depend on earlier feature methods having executed.
 
 === IgnoreIf
 
-To ignore a feature method under certain conditions, annotate it with `spock.lang.IgnoreIf`,
+To ignore a feature method or specification under certain conditions, annotate it with `spock.lang.IgnoreIf`,
 followed by a predicate:
 
-[source,groovy]
+[source,groovy,indent=0]
 ----
-@IgnoreIf({ System.getProperty("os.name").contains("windows") })
-def "I'll run everywhere but on Windows"() { ... }
+include::{sourcedir}/extension/IgnoreIfDocSpec.groovy[tag=example-a]
 ----
 
 To make predicates easier to read and write, the following properties are available inside the closure:
@@ -124,10 +123,17 @@ To make predicates easier to read and write, the following properties are availa
 
 Using the `os` property, the previous example can be rewritten as:
 
-[source,groovy]
+[source,groovy,indent=0]
 ----
-@IgnoreIf({ os.windows })
-def "I'll run everywhere but on Windows"() { ... }
+include::{sourcedir}/extension/IgnoreIfDocSpec.groovy[tag=example-b]
+----
+
+If multiple `@IgnoreIf` annotations are present, they are effectively combined with a logical "or".
+The annotated element is skipped if any of the conditions evaluates to `true`:
+
+[source,groovy,indent=0]
+----
+include::{sourcedir}/extension/IgnoreIfDocSpec.groovy[tag=example-c]
 ----
 
 Care should be taken when ignoring feature methods in a spec class annotated with `spock.lang.Stepwise` since
@@ -137,10 +143,9 @@ To use IDE support like code completion, you can also use the argument to the cl
 `org.spockframework.runtime.extension.builtin.PreconditionContext`. This enables the IDE with type information
 which is not available otherwise:
 
-[source,groovy]
+[source,groovy,indent=0]
 ----
-@IgnoreIf({ PreconditionContext it -> it.os.windows })
-def "I'll run everywhere but on Windows"() { ... }
+include::{sourcedir}/extension/IgnoreIfDocSpec.groovy[tag=example-d]
 ----
 
 If applied to a data driven feature, the closure can also access the data variables.

docs/release_notes.adoc

@@ -16,6 +16,8 @@ include::include.adoc[]
 
 - `@Issue` is now repeatable
 
+- `@IgnoreIf` is now repeatable
+
 - `@Requires` is now repeatable
 
 - `@See` is now repeatable

spock-core/src/main/java/spock/lang/IgnoreIf.java

@@ -16,16 +16,14 @@
 
 package spock.lang;
 
-import java.lang.annotation.ElementType;
-import java.lang.annotation.Retention;
-import java.lang.annotation.RetentionPolicy;
-import java.lang.annotation.Target;
+import java.lang.annotation.*;
 
 import groovy.lang.Closure;
 
 import org.spockframework.runtime.extension.ExtensionAnnotation;
 import org.spockframework.runtime.extension.builtin.IgnoreIfExtension;
 import org.spockframework.runtime.extension.builtin.PreconditionContext;
+import org.spockframework.util.Beta;
 
 /**
  * Ignores the annotated spec, feature or selected iterations if the given condition holds.
@@ -48,6 +46,17 @@
 @Retention(RetentionPolicy.RUNTIME)
 @Target({ElementType.TYPE, ElementType.METHOD})
 @ExtensionAnnotation(IgnoreIfExtension.class)
+@Repeatable(IgnoreIf.Container.class)
 public @interface IgnoreIf {
 	Class<? extends Closure> value();
+
+  /**
+   * @since 2.0
+   */
+  @Beta
+  @Retention(RetentionPolicy.RUNTIME)
+  @Target({ElementType.TYPE, ElementType.METHOD})
+  @interface Container {
+    IgnoreIf[] value();
+  }
 }

spock-specs/src/test/groovy/org/spockframework/docs/extension/IgnoreIfDocSpec.groovy

@@ -0,0 +1,40 @@
+package org.spockframework.docs.extension
+
+import org.spockframework.runtime.extension.builtin.PreconditionContext
+import spock.lang.IgnoreIf
+import spock.lang.Specification
+
+class IgnoreIfDocSpec extends Specification {
+// tag::example-a[]
+  @IgnoreIf({ System.getProperty("os.name").toLowerCase().contains("windows") })
+  def "I'll run everywhere but on Windows"() {
+// end::example-a[]
+    expect:
+    true
+  }
+
+// tag::example-b[]
+  @IgnoreIf({ os.windows })
+  def "I will run everywhere but on Windows"() {
+// end::example-b[]
+    expect:
+    true
+  }
+
+// tag::example-c[]
+  @IgnoreIf({ os.windows })
+  @IgnoreIf({ jvm.java8 })
+  def "I'll run everywhere but on Windows or anywhere on Java 8"() {
+// end::example-c[]
+    expect:
+    true
+  }
+
+// tag::example-d[]
+  @IgnoreIf({ PreconditionContext it -> it.os.windows })
+  def "I will run everywhere but not on Windows"() {
+// end::example-d[]
+    expect:
+    true
+  }
+}

spock-specs/src/test/groovy/org/spockframework/smoke/extension/IgnoreIfExtension.groovy

@@ -17,6 +17,7 @@
 package org.spockframework.smoke.extension
 
 import org.spockframework.EmbeddedSpecification
+import org.spockframework.runtime.ConditionNotSatisfiedError
 import org.spockframework.runtime.extension.ExtensionException
 import spock.lang.*
 
@@ -163,6 +164,47 @@ class Bar extends Closure {
     ee.message == 'Failed to instantiate condition'
   }
 
+  @IgnoreIf({ true })
+  @IgnoreIf({ false })
+  def "feature is ignored if at least one IgnoreIf annotation is true"() {
+    expect: false
+  }
+
+  def "feature is not ignored if all IgnoreIf annotations are false"() {
+    when:
+    runner.runSpecBody """
+@IgnoreIf({ false })
+@IgnoreIf({ false })
+def foo() {
+  expect: false
+}
+"""
+
+    then:
+    thrown(ConditionNotSatisfiedError)
+  }
+
+  @IgnoreIf({ a == 1 })
+  @IgnoreIf({ false })
+  def "feature is ignored if data variable accessing IgnoreIf annotation is true"() {
+    expect: false
+    where: a = 1
+  }
+
+  @IgnoreIf({ a == 1 })
+  @IgnoreIf({ a != 1 })
+  def "feature is ignored if at least one data variable accessing IgnoreIf annotation is true"() {
+    expect: false
+    where: a = 1
+  }
+
+  @IgnoreIf({ true })
+  @IgnoreIf({ a != 1 })
+  def "feature is ignored if non data variable accessing IgnoreIf annotation is true"() {
+    expect: false
+    where: a = 1
+  }
+
   def "@IgnoreIf provides condition access to Specification instance shared fields"() {
     when:
     def result = runner.runWithImports("""