fix the tck so it always runs

* split the simple map datastore into it's own library
* split the tck up into domains / base spec / tests
* ensure the tck only runs on the simple, hibernate5, and mongo implementations

Author: jdaugherty

build.gradle

@@ -60,9 +60,11 @@ def publishedProjects = [
         'grails-datastore-gorm',
         'grails-datastore-gorm-async',
         //'grails-datastore-gorm-rx',
+        'grails-datastore-gorm-simple',
         'grails-datastore-gorm-support',
         'grails-datastore-gorm-tck',
-        'grails-datastore-gorm-test',
+        'grails-datastore-gorm-tck-base',
+        'grails-datastore-gorm-tck-domains',
         'grails-datastore-gorm-validation',
         'grails-datastore-web',
         'grails-gorm-testing-support',

docs/guide-developer/src/main/docs/stepByStep.adoc

@@ -32,7 +32,7 @@ dependencies {
             project(':grails-datastore-web'),
             project(':grails-datastore-gorm-support')
             
-    testImplementation project(':grails-datastore-gorm-tck')
+    testImplementation project(':grails-datastore-gorm-tck').testFixtures
     testRuntime "javax.servlet:javax.servlet-api:$servletApiVersion"
 
 }

docs/guide-developer/src/main/docs/testing.adoc

@@ -2,7 +2,7 @@ The `grails-datastore-gorm-tck` project provides several hundred tests to guaran
 
 [source,groovy]
 ----
-testCompile project(':grails-datastore-gorm-tck')
+testCompile project(':grails-datastore-gorm-tck').testFixtures
 ----
 
 Then create a `Setup.groovy` file that sets up your custom datastore in your implementation.

gradle/publish-config.gradle

@@ -20,4 +20,5 @@ extensions.configure(GrailsPublishExtension) {
             'jamesfredley': 'James Fredley'
     ]
     it.artifactId = findProperty('pomArtifactId') ?: name
+    it.publishTestSources = findProperty('pomPublishTestSources') ?: false
 }

gradle/tck-config.gradle

@@ -1,53 +1,33 @@
 dependencies {
+    if(!project.hasProperty('includeBaseTckClass') || project.findProperty('includeBaseTckClass')) {
+        testImplementation project(':grails-datastore-gorm-tck-base')
+    }
+//    testImplementation project(path: ':grails-datastore-gorm-tck', configuration: 'testArtifacts')
     testImplementation project(':grails-datastore-gorm-tck')
+    testImplementation project(':grails-datastore-gorm-tck-domains')
 }
 
-// We need to test against the TCK. Gradle cannot find/run tests from jars
-// without a lot of plumbing, so here we copy the class files from the TCK
-// project into this project's test classes dir so Gradle can find the test
-// classes and run them. See grails.gorm.tests.GormDatastoreSpec for on the TCK.
+// TODO: gradle will happily put the jar file on the classpath, but junit won't find the tests.  Dynamic test discovery also won't find them.
+tasks.register("extractTckJar", Copy) {
+    dependsOn(configurations.testRuntimeClasspath)
+
+    Provider<Directory> extractTarget = layout.buildDirectory.dir("extracted-tck-classes")
 
-// helper, used below.
-def toBaseClassRelativePathWithoutExtension = { String base, String classFile ->
-    if (classFile.startsWith(base)) {
-        def sansClass = classFile[0 .. classFile.size() - '.class'.size() - 1]
-        def dollarIndex = sansClass.indexOf('$')
-        def baseClass = dollarIndex > 0 ? sansClass[0..dollarIndex - 1] : sansClass
-        def relative = baseClass - base - '/'
-        relative
+    doFirst {
+        extractTarget.get().asFile.deleteDir()
     }
-    else {
-        null
+
+    outputs.dir(extractTarget)
+    File tckJar = configurations.testRuntimeClasspath.resolve().find { it.name.startsWith("grails-datastore-gorm-tck-${projectVersion}") }
+    if (tckJar) {
+        from(zipTree(tckJar))
+        into(extractTarget)
     }
 }
 
-tasks.named('test') {
+tasks.withType(Test).configureEach {
+    dependsOn("extractTckJar")
     doFirst {
-        File tckClassesDir = findProject(':grails-datastore-gorm-tck').sourceSets.main.output.classesDirs.files.first()
-        // surely there is a less hardcoded way to do this
-        copy {
-            from tckClassesDir
-            into sourceSets.test.output.classesDirs.files.first()
-            include '**/*.class'
-            exclude { details ->
-                // Do not copy across any TCK class (or nested classes of that class)
-                // If there is a corresponding source file in the particular modules
-                // test source tree. Allows a module to override a test/helper.
-                if (!details.file.isFile()) {
-                    return false
-                }
-                def candidatePath = details.file.absolutePath
-                def relativePath = toBaseClassRelativePathWithoutExtension(tckClassesDir.absolutePath, candidatePath)
-                if (relativePath == null) {
-                    throw new IllegalStateException("$candidatePath does not appear to be in the TCK")
-                }
-                file("src/test/groovy/${relativePath}.groovy").exists()
-            }
-        }
+        testClassesDirs += files(layout.buildDirectory.dir("extracted-tck-classes"))
     }
-}
-
-//        Only enable to force snapshot dependency updates due to spring dependency management plugin snapshot caching behavior
-//        configurations.all {
-//            resolutionStrategy.cacheChangingModulesFor 0, 'seconds'
-//        }
+}

grails-data-hibernate5/gorm/build.gradle

@@ -43,7 +43,9 @@ dependencies {
     }
 
     testImplementation "com.h2database:h2"
-    testImplementation 'junit:junit' // JUnit 4
+    testImplementation 'org.junit.platform:junit-platform-suite', {
+        // api: SelectClasses, Suite
+    }
     testImplementation "org.apache.groovy:groovy-test-junit5"
     testImplementation "org.apache.groovy:groovy-sql"
     testImplementation "org.apache.groovy:groovy-json"
@@ -69,6 +71,6 @@ dependencies {
 apply {
     from rootProject.layout.projectDirectory.file('gradle/java-config.gradle')
     from rootProject.layout.projectDirectory.file('gradle/hibernate5-test-config.gradle')
-    from rootProject.layout.projectDirectory.file('gradle/tck-config.gradle')
     from rootProject.layout.projectDirectory.file('gradle/publish-config.gradle')
+    from rootProject.layout.projectDirectory.file('gradle/tck-config.gradle')
 }

grails-data-hibernate5/gorm/src/test/groovy/grails/gorm/tests/GormDatastoreSpec.groovy

@@ -0,0 +1,106 @@
+package grails.gorm.tests
+
+import grails.gorm.tck.Book
+import grails.gorm.tck.ChildEntity
+import grails.gorm.tck.City
+import grails.gorm.tck.ClassWithListArgBeforeValidate
+import grails.gorm.tck.ClassWithNoArgBeforeValidate
+import grails.gorm.tck.ClassWithOverloadedBeforeValidate
+import grails.gorm.tck.CommonTypes
+import grails.gorm.tck.Country
+import grails.gorm.tck.EnumThing
+import grails.gorm.tck.Face
+import grails.gorm.tck.Highway
+import grails.gorm.tck.Location
+import grails.gorm.tck.ModifyPerson
+import grails.gorm.tck.Nose
+import grails.gorm.tck.OptLockNotVersioned
+import grails.gorm.tck.OptLockVersioned
+import grails.gorm.tck.Person
+import grails.gorm.tck.PersonEvent
+import grails.gorm.tck.Pet
+import grails.gorm.tck.PetType
+import grails.gorm.tck.Plant
+import grails.gorm.tck.PlantCategory
+import grails.gorm.tck.Publication
+import grails.gorm.tck.Task
+import grails.gorm.tck.TestEntity
+import org.grails.datastore.mapping.core.DatastoreUtils
+import org.grails.datastore.mapping.core.Session
+import spock.lang.Shared
+import spock.lang.Specification
+
+/**
+ * A Spec base class that manages a Session for each feature as well as
+ * meta class cleanup on the Entity classes in the TCK.
+ *
+ * Users of this class need to provide a "setup" class at runtime that
+ * provides the session instance. It *must* have the following name:
+ *
+ * - org.grails.datastore.gorm.Setup
+ *
+ * This class must contain a static no-arg method called "setup()"
+ * that returns a Session instance.
+ */
+abstract class GormDatastoreSpec extends Specification {
+
+    static final CURRENT_TEST_NAME = "current.gorm.test"
+    static final SETUP_CLASS_NAME = 'org.grails.datastore.gorm.Setup'
+    static final TEST_CLASSES = [
+            Book, ChildEntity, City, ClassWithListArgBeforeValidate, ClassWithNoArgBeforeValidate,
+            ClassWithOverloadedBeforeValidate, CommonTypes, Country, EnumThing, Face, Highway,
+            Location, ModifyPerson, Nose, OptLockNotVersioned, OptLockVersioned, Person, PersonEvent,
+            Pet, PetType, Plant, PlantCategory, Publication, Task, TestEntity]
+
+    @Shared Class setupClass
+
+    Session session
+
+    def setupSpec() {
+        setupClass = loadSetupClass()
+    }
+
+    def setup() {
+        System.out.println("Using hibernate5 datastore class")
+        cleanRegistry()
+        System.setProperty(CURRENT_TEST_NAME, this.getClass().simpleName - 'Spec')
+        session = createSession()
+        DatastoreUtils.bindSession session
+    }
+
+    Session createSession() {
+        setupClass.setup(((TEST_CLASSES + getDomainClasses()) as Set) as List)
+    }
+
+    List getDomainClasses() {
+        []
+    }
+
+    def cleanup() {
+        if (session) {
+            session.disconnect()
+            DatastoreUtils.unbindSession session
+        }
+        try {
+            setupClass.destroy()
+        } catch(e) {
+            println "ERROR: Exception during test cleanup: ${e.message}"
+        }
+
+        cleanRegistry()
+    }
+
+    private cleanRegistry() {
+        for (clazz in (TEST_CLASSES + getDomainClasses() )) {
+            GroovySystem.metaClassRegistry.removeMetaClass(clazz)
+        }
+    }
+
+    static Class loadSetupClass() {
+        try {
+            getClassLoader().loadClass(SETUP_CLASS_NAME)
+        } catch (Throwable e) {
+            throw new RuntimeException("Datastore setup class ($SETUP_CLASS_NAME) was not found",e)
+        }
+    }
+}

grails-data-hibernate5/gorm/src/test/groovy/grails/gorm/tests/GroovyProxySpec.groovy

@@ -1,41 +1,13 @@
 package grails.gorm.tests
 
+import grails.gorm.tck.OptLockNotVersioned
+import grails.gorm.tck.OptLockVersioned
 import org.springframework.orm.hibernate5.HibernateOptimisticLockingFailureException
 
-
 /**
  * @author Burt Beckwith
  */
-class OptimisticLockingSpec extends GormDatastoreSpec {
-
-    void "Test versioning"() {
-
-        given:
-        def o = new OptLockVersioned(name: 'locked')
-
-        when:
-        o.save flush: true
-
-        then:
-        o.version == 0
-
-        when:
-        session.clear()
-        o = OptLockVersioned.get(o.id)
-        o.name = 'Fred'
-        o.save flush: true
-
-        then:
-        o.version == 1
-
-        when:
-        session.clear()
-        o = OptLockVersioned.get(o.id)
-
-        then:
-        o.name == 'Fred'
-        o.version == 1
-    }
+class HibernateOptimisticLockingSpec extends GormDatastoreSpec {
 
     void "Test optimistic locking"() {
 

grails-data-hibernate5/gorm/src/test/groovy/grails/gorm/tests/OptimisticLockingSpec.groovy renamed to grails-data-hibernate5/gorm/src/test/groovy/grails/gorm/tests/HibernateOptimisticLockingSpec.groovy

@@ -1,15 +1,14 @@
 package grails.gorm.tests
 
-import org.junit.runner.RunWith
-import org.junit.runners.Suite
+import grails.gorm.tck.FirstAndLastMethodSpec
+import grails.gorm.tck.NotInListSpec
+import org.junit.platform.suite.api.SelectClasses
+import org.junit.platform.suite.api.Suite
 
 /**
  * Created by graemerocher on 06/07/2016.
  */
-@RunWith(Suite)
-
-@Suite.SuiteClasses([
-        NullValueEqualSpec
-])
+@Suite
+@SelectClasses([FirstAndLastMethodSpec])
 class HibernateSuite {
 }