Add support for spock2

Signed-off-by: Javier Salinas <jsalinaspolo@gmail.com>

build.gradle

@@ -64,7 +64,6 @@ subprojects {
         testngVersion = '7.4.0'
         assertjVersion = '3.20.2'
         slf4jVersion = '1.7.32'
-        bytebuddyVersion = '1.11.13'
         paranamerVersion = '2.8'
         jansiVersion = '1.18'
         gsonVersion = '2.8.8'
@@ -74,7 +73,7 @@ subprojects {
         jacocoVersion = '0.8.5'
         quickcheckVersion = '0.6'
         hsqldbVersion = '2.3.2'
-        byteBuddyVersion = '1.10.2'
+        byteBuddyVersion = '1.12.3'
         androidGradleVersion = '3.1.0'
         androidCompileSdkVersion = 27
         androidBuildToolsVersion = '27.0.2'

gradle.properties

@@ -1,4 +1,4 @@
-version=1.1.0
+version=1.2.0
 org.gradle.jvmargs=-Xmx1536M
 org.gradle.parallel=true
 android.useAndroidX=true

jgiven-core/build.gradle

@@ -8,7 +8,7 @@ dependencies {
     api "com.google.guava:guava:$guavaVersion"
     api "com.google.code.gson:gson:$gsonVersion"
     implementation "com.thoughtworks.paranamer:paranamer:$paranamerVersion"
-    implementation "net.bytebuddy:byte-buddy:$bytebuddyVersion"
+    implementation "net.bytebuddy:byte-buddy:$byteBuddyVersion"
     implementation "org.fusesource.jansi:jansi:$jansiVersion"
 
     testImplementation 'com.github.stefanbirkner:system-rules:1.19.0'

jgiven-core/src/main/java/com/tngtech/jgiven/impl/intercept/StepInterceptorImpl.java

@@ -1,26 +1,24 @@
 package com.tngtech.jgiven.impl.intercept;
 
-import static com.tngtech.jgiven.report.model.InvocationMode.NORMAL;
-import static com.tngtech.jgiven.report.model.InvocationMode.PENDING;
-import static com.tngtech.jgiven.report.model.InvocationMode.SKIPPED;
-
-import java.lang.reflect.Method;
-import java.util.Arrays;
-import java.util.List;
-import java.util.Stack;
-
-import com.tngtech.jgiven.impl.util.ThrowableUtil;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
 import com.tngtech.jgiven.annotation.DoNotIntercept;
 import com.tngtech.jgiven.annotation.Hidden;
 import com.tngtech.jgiven.annotation.NestedSteps;
 import com.tngtech.jgiven.annotation.Pending;
 import com.tngtech.jgiven.impl.ScenarioExecutor;
 import com.tngtech.jgiven.impl.util.ParameterNameUtil;
+import com.tngtech.jgiven.impl.util.ThrowableUtil;
 import com.tngtech.jgiven.report.model.InvocationMode;
 import com.tngtech.jgiven.report.model.NamedArgument;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.lang.reflect.Method;
+import java.util.Arrays;
+import java.util.List;
+import java.util.Stack;
+
+import static com.tngtech.jgiven.report.model.InvocationMode.PENDING;
+import static com.tngtech.jgiven.report.model.InvocationMode.SKIPPED;
 
 public class StepInterceptorImpl implements StepInterceptor {
     private static final Logger log = LoggerFactory.getLogger( StepInterceptorImpl.class );

jgiven-spock/src/test/groovy/com/tngtech/jgiven/spock/MyShinyJGivenShould.groovy

@@ -25,7 +25,7 @@ class MyShinyJGivenShould extends ScenarioSpec<Given, When, Then> {
         when().some_action()
         then().some_outcome()
 
-        assert getScenario().getScenarioModel().getScenarioCases().get(0).getStep(0).words.join(" ") == "Given some state param"
+        assert scenario.scenarioModel.scenarioCases.first().getStep(0).words.join(" ") == "Given some state param"
     }
 
     @ExtendedDescription("more details")
@@ -36,7 +36,7 @@ class MyShinyJGivenShould extends ScenarioSpec<Given, When, Then> {
         when().some_action()
         then().some_outcome()
 
-        assert getScenario().getScenarioModel().getExtendedDescription() == "more details"
+        assert getScenario().getScenarioModel().extendedDescription == "more details"
     }
 
     @Unroll
@@ -46,7 +46,7 @@ class MyShinyJGivenShould extends ScenarioSpec<Given, When, Then> {
         when().some_action()
         then().some_outcome()
 
-        assert getScenario().getScenarioModel().getDescription() == "be able to use tables #param"
+        assert getScenario().getScenarioModel().description == "be able to use tables #param"
 
         where:
         param        | _

jgiven-spock/src/test/groovy/com/tngtech/jgiven/spock/stages/Given.groovy

@@ -11,4 +11,4 @@ class Given extends Stage<Given> {
     def some_state_$(String param) {
         self()
     }
-}
+}

jgiven-spock/src/test/groovy/com/tngtech/jgiven/spock/stages/Then.groovy

@@ -8,4 +8,4 @@ class Then extends Stage<Then> {
         assert true
         self()
     }
-}
+}

jgiven-spock/src/test/groovy/com/tngtech/jgiven/spock/stages/When.groovy

@@ -7,4 +7,4 @@ class When extends Stage<When> {
     When some_action() {
         self()
     }
-}
+}

jgiven-spock2/.gitignore

@@ -0,0 +1 @@
+/target

jgiven-spock2/build.gradle

@@ -0,0 +1,27 @@
+plugins {
+    id 'java-library'
+}
+
+apply plugin: 'groovy'
+
+description = "Module for writing JGiven tests with Spock 2"
+
+ext {
+    spock2_version = '2.0-groovy-3.0'
+    groovy_version = '3.0.9'
+}
+
+dependencies {
+    api project(':jgiven-junit')
+
+    implementation "org.codehaus.groovy:groovy:$groovy_version"
+    implementation "org.spockframework:spock-core:$spock2_version"
+    implementation "org.spockframework:spock-junit4:$spock2_version"
+
+    testImplementation project(':jgiven-html5-report')
+}
+
+test {
+    useJUnitPlatform()
+    finalizedBy(jgivenHtml5Report)
+}

jgiven-spock2/src/main/groovy/com/tngtech/jgiven/spock/ScenarioSpec.groovy

@@ -0,0 +1,58 @@
+package com.tngtech.jgiven.spock
+
+import com.google.common.reflect.TypeToken
+import com.tngtech.jgiven.annotation.DoNotIntercept
+import com.tngtech.jgiven.impl.Scenario
+import com.tngtech.jgiven.junit.JGivenClassRule
+import com.tngtech.jgiven.spock.junit.JGivenSpockMethodRule
+import net.bytebuddy.ByteBuddy
+import net.bytebuddy.description.annotation.AnnotationDescription
+import net.bytebuddy.dynamic.loading.ClassLoadingStrategy
+import net.bytebuddy.implementation.SuperMethodCall
+import net.bytebuddy.matcher.ElementMatchers
+import org.junit.ClassRule
+import org.junit.Rule
+import spock.lang.Shared
+import spock.lang.Specification
+
+class ScenarioSpec<GIVEN, WHEN, THEN> extends Specification {
+    @ClassRule @Shared JGivenClassRule writerRule = new JGivenClassRule()
+    @Rule JGivenSpockMethodRule scenarioRule = new JGivenSpockMethodRule(createScenario())
+
+    GIVEN given() {
+        getScenario().given()
+    }
+
+    WHEN when() {
+        getScenario().when()
+    }
+
+    THEN then() {
+        getScenario().then()
+    }
+
+    Scenario<GIVEN, WHEN, THEN> getScenario() {
+        (Scenario<GIVEN, WHEN, THEN>) scenarioRule.getScenario()
+    }
+
+    Scenario<GIVEN, WHEN, THEN> createScenario() {
+        Class<GIVEN> givenClass = addDoNotInterceptToMetaClass(new TypeToken<GIVEN>(getClass()) {}.getRawType())
+        Class<WHEN> whenClass = addDoNotInterceptToMetaClass(new TypeToken<WHEN>(getClass()) {}.getRawType())
+        Class<THEN> thenClass = addDoNotInterceptToMetaClass(new TypeToken<THEN>(getClass()) {}.getRawType())
+
+        new Scenario<GIVEN, WHEN, THEN>(givenClass, whenClass, thenClass)
+    }
+
+    private <T> Class<T> addDoNotInterceptToMetaClass(Class<T> clazz) {
+        AnnotationDescription doNotIntercept = AnnotationDescription.Builder.ofType(DoNotIntercept.class).build()
+        def clazzA = clazz.metaClass.getTheClass()
+        new ByteBuddy()
+                .subclass(clazzA)
+                .method(ElementMatchers.named("getMetaClass"))
+                .intercept(SuperMethodCall.INSTANCE)
+                .annotateMethod(doNotIntercept)
+                .make()
+                .load(clazzA.getClassLoader(), ClassLoadingStrategy.Default.INJECTION)
+                .getLoaded() as Class<T>
+    }
+}

jgiven-spock2/src/main/groovy/com/tngtech/jgiven/spock/junit/JGivenSpockMethodRule.java

@@ -0,0 +1,32 @@
+package com.tngtech.jgiven.spock.junit;
+
+import com.tngtech.jgiven.impl.ScenarioBase;
+import com.tngtech.jgiven.junit.JGivenMethodRule;
+import org.junit.runners.model.FrameworkMethod;
+import org.junit.runners.model.Statement;
+import spock.lang.Specification;
+
+/**
+ * JUnit Rule to enable JGiven with Spock2
+ *
+ * @since 1.2.0
+ */
+public class JGivenSpockMethodRule extends JGivenMethodRule {
+
+    /**
+     * @since 1.2.0
+     */
+    public JGivenSpockMethodRule(ScenarioBase scenario) {
+        super(scenario);
+    }
+
+    @Override
+    protected void starting(Statement base, FrameworkMethod testMethod, Object target) {
+        super.starting(base, testMethod, target);
+        scenario.getScenarioModel().setDescription(methodNameFromSpec(target));
+    }
+
+    private String methodNameFromSpec(Object target) {
+        return ((Specification) target).getSpecificationContext().getCurrentIteration().getParent().getDisplayName();
+    }
+}

jgiven-spock2/src/test/groovy/com/tngtech/jgiven/spock/ShinySpockJGivenShould.groovy

@@ -0,0 +1,56 @@
+package com.tngtech.jgiven.spock
+
+import com.tngtech.jgiven.annotation.ExtendedDescription
+import com.tngtech.jgiven.spock.stages.Given
+import com.tngtech.jgiven.spock.stages.Then
+import com.tngtech.jgiven.spock.stages.When
+import spock.lang.Unroll
+
+class ShinySpockJGivenShould extends ScenarioSpec<Given, When, Then> {
+
+    def "something should happen"() {
+        expect:
+
+        given().some_state()
+        when().some_action()
+        then().some_outcome()
+
+        assert scenario.scenarioModel.description == "something should happen"
+    }
+
+    def "be some able to use params"() {
+        expect:
+
+        given().some_state_$("param")
+        when().some_action()
+        then().some_outcome()
+
+        assert scenario.scenarioModel.scenarioCases.first().getStep(0).words.join(" ") == "Given some state param"
+    }
+
+    @ExtendedDescription("more details")
+    def "be able to have extended descriptions"() {
+        expect:
+
+        given().some_state()
+        when().some_action()
+        then().some_outcome()
+
+        assert scenario.scenarioModel.extendedDescription == "more details"
+    }
+
+    @Unroll
+    def "be able to use tables #param"() {
+        expect:
+        given().some_state_$(param)
+        when().some_action()
+        then().some_outcome()
+
+        assert scenario.scenarioModel.getDescription() == "be able to use tables #param"
+
+        where:
+        param        | _
+        "param"      | _
+        "word param" | _
+    }
+}

jgiven-spock2/src/test/groovy/com/tngtech/jgiven/spock/stages/Given.groovy

@@ -0,0 +1,17 @@
+package com.tngtech.jgiven.spock.stages
+
+import com.tngtech.jgiven.Stage
+import com.tngtech.jgiven.annotation.As
+
+class Given extends Stage<Given> {
+
+    Given some_state() {
+        self()
+    }
+
+    def some_state_$(String param) {
+        self()
+    }
+}
+
+

jgiven-spock2/src/test/groovy/com/tngtech/jgiven/spock/stages/Then.groovy

@@ -0,0 +1,11 @@
+package com.tngtech.jgiven.spock.stages
+
+import com.tngtech.jgiven.Stage
+
+class Then extends Stage<Then> {
+
+    Then some_outcome() {
+        assert true
+        self()
+    }
+}

jgiven-spock2/src/test/groovy/com/tngtech/jgiven/spock/stages/When.groovy

@@ -0,0 +1,10 @@
+package com.tngtech.jgiven.spock.stages
+
+import com.tngtech.jgiven.Stage
+
+class When extends Stage<When> {
+
+    When some_action() {
+        self()
+    }
+}

jgiven-timing/build.gradle

@@ -11,8 +11,8 @@ description = "Module for injecting automated performance analysis for test meth
 dependencies {
     implementation project(":jgiven-core")
     implementation("com.google.guava:guava:$guavaVersion")
-    implementation "net.bytebuddy:byte-buddy-gradle-plugin:$bytebuddyVersion"
-    implementation "net.bytebuddy:byte-buddy-agent:$bytebuddyVersion"
+    implementation "net.bytebuddy:byte-buddy-gradle-plugin:$byteBuddyVersion"
+    implementation "net.bytebuddy:byte-buddy-agent:$byteBuddyVersion"
     testImplementation("com.google.guava:guava-testlib:$guavaVersion")
     testImplementation 'org.mockito:mockito-inline:4.0.0'
 }

settings.gradle

@@ -33,6 +33,7 @@ include ':jgiven-core',
         ':jgiven-maven-plugin',
         ':jgiven-junit',
         ':jgiven-spock',
+        ':jgiven-spock2',
         ':jgiven-testng',
         ':jgiven-spring',
         ':jgiven-spring-junit4',