From 3dc9edaa7b11c2d1e580aab1dea3e1b89126cd64 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Cl=C3=A9ment=20Fournier?= <clement.fournier76@gmail.com>
Date: Mon, 24 Sep 2018 19:00:17 +0200
Subject: [PATCH] Port group tests

---
 .../pmd/lang/java/ast/KotlinTestingDsl.kt     | 60 ++++++++++++++++++-
 pmd-test/pom.xml                              |  1 +
 2 files changed, 60 insertions(+), 1 deletion(-)

diff --git a/pmd-java/src/test/kotlin/net/sourceforge/pmd/lang/java/ast/KotlinTestingDsl.kt b/pmd-java/src/test/kotlin/net/sourceforge/pmd/lang/java/ast/KotlinTestingDsl.kt
index 58cbb5dc3d..a955c584e8 100644
--- a/pmd-java/src/test/kotlin/net/sourceforge/pmd/lang/java/ast/KotlinTestingDsl.kt
+++ b/pmd-java/src/test/kotlin/net/sourceforge/pmd/lang/java/ast/KotlinTestingDsl.kt
@@ -8,6 +8,8 @@ import io.kotlintest.specs.AbstractFunSpec
 import net.sourceforge.pmd.lang.ast.Node
 import net.sourceforge.pmd.lang.ast.test.*
 import net.sourceforge.pmd.lang.java.ParserTstUtil
+import io.kotlintest.should as kotlintestShould
+
 
 /**
  * Represents the different Java language versions.
@@ -79,6 +81,62 @@ fun AbstractFunSpec.parserTest(name: String,
 }
 
 
+/**
+ * Defines a group of tests that should be named similarly,
+ * executed on several java versions. Calls to "should" in
+ * the block are intercepted to create a new test, with the
+ * given [name] as a common prefix.
+ *
+ * This is useful to make a batch of grammar specs for grammar
+ * regression tests without bothering to find a name.
+ *
+ * @param name Common prefix for the test names
+ * @param javaVersions Language versions for which to generate tests
+ * @param spec Assertions. Each call to [io.kotlintest.should] on a string
+ *             receiver is replaced by a [GroupTestCtx.should], which creates a
+ *             new parser test.
+ */
+fun AbstractFunSpec.testGroup(name: String,
+                              javaVersions: List<JavaVersion>,
+                              spec: GroupTestCtx.() -> Unit) {
+    javaVersions.forEach {
+        testGroup(name, it, spec)
+    }
+}
+
+
+/**
+ * Defines a group of tests that should be named similarly.
+ * Calls to "should" in the block are intercepted to create
+ * a new test, with the given [name] as a common prefix.
+ *
+ * This is useful to make a batch of grammar specs for grammar
+ * regression tests without bothering to find a name.
+ *
+ * @param name Common prefix for the test names
+ * @param javaVersion Language versions to use when parsing
+ * @param spec Assertions. Each call to [io.kotlintest.should] on a string
+ *             receiver is replaced by a [GroupTestCtx.should], which creates a
+ *             new parser test.
+ *
+ */
+fun AbstractFunSpec.testGroup(name: String,
+                              javaVersion: JavaVersion = JavaVersion.Latest,
+                              spec: GroupTestCtx.() -> Unit) {
+    GroupTestCtx(this, name, javaVersion).spec()
+}
+
+class GroupTestCtx(private val funspec: AbstractFunSpec, private val groupName: String, javaVersion: JavaVersion) : ParserTestCtx(javaVersion) {
+
+    infix fun String.should(matcher: Matcher<String>) {
+        funspec.parserTest("$groupName: '$this'") {
+            this@should kotlintestShould matcher
+        }
+    }
+
+}
+
+
 /**
  * Extensible environment to describe parse/match testing workflows in a concise way.
  * Can be used inside of a [io.kotlintest.specs.FunSpec] with [parserTest].
@@ -116,7 +174,7 @@ fun AbstractFunSpec.parserTest(name: String,
  * @property importedTypes Types to import at the beginning of parsing contexts
  * @property otherImports Other imports, without the `import` and semicolon
  */
-data class ParserTestCtx(val javaVersion: JavaVersion = JavaVersion.Latest,
+open class ParserTestCtx(val javaVersion: JavaVersion = JavaVersion.Latest,
                          val importedTypes: MutableList<Class<*>> = mutableListOf(),
                          val otherImports: MutableList<String> = mutableListOf()) {
 
diff --git a/pmd-test/pom.xml b/pmd-test/pom.xml
index 873e8a371b..7403dda8dc 100644
--- a/pmd-test/pom.xml
+++ b/pmd-test/pom.xml
@@ -3,6 +3,7 @@
     <modelVersion>4.0.0</modelVersion>
     <artifactId>pmd-test</artifactId>
     <name>PMD Test Framework</name>
+    <description>Contains a test framework to test rules.</description>
 
     <parent>
         <groupId>net.sourceforge.pmd</groupId>