chore: migrate to gestalt v7—fork 🅰, keep subsystems separate

build-logic/build.gradle.kts

@@ -9,6 +9,7 @@ plugins {
 
 repositories {
     mavenCentral()
+    google()  // gestalt uses an annotation package by Google
 
     maven {
         name = "Terasology Artifactory"
@@ -21,10 +22,11 @@ repositories {
 dependencies {
     // Needed for caching reflected data during builds
     implementation("org.terasology:reflections:0.9.12-MB")
+    implementation("org.javassist:javassist:3.27.0-GA")
     implementation("dom4j:dom4j:1.6.1")
 
     // for inspecting modules
-    implementation("org.terasology:gestalt-module:5.1.5")
+    implementation("org.terasology.gestalt:gestalt-module:7.0.6-SNAPSHOT")
 
     api(kotlin("test"))
 }

build-logic/src/main/kotlin/org/terasology/gradology/module_build.kt

@@ -4,10 +4,10 @@
 package org.terasology.gradology
 
 import org.gradle.api.Project
-import org.terasology.module.DependencyInfo
-import org.terasology.module.ModuleMetadata
-import org.terasology.module.ModuleMetadataJsonAdapter
-import org.terasology.naming.Version
+import org.terasology.gestalt.module.ModuleMetadata
+import org.terasology.gestalt.module.ModuleMetadataJsonAdapter
+import org.terasology.gestalt.module.dependencyresolution.DependencyInfo
+import org.terasology.gestalt.naming.Version
 import java.io.File
 
 

build-logic/src/main/kotlin/reflections-manifest.gradle.kts

@@ -0,0 +1,42 @@
+// Copyright 2021 The Terasology Foundation
+// SPDX-License-Identifier: Apache-2.0
+
+import org.reflections.Reflections
+import org.reflections.scanners.SubTypesScanner
+import org.reflections.scanners.TypeAnnotationsScanner
+import org.reflections.serializers.JsonSerializer
+import org.reflections.util.ConfigurationBuilder
+import java.net.URLClassLoader
+
+tasks.register("cacheReflections") {
+    description = "Caches reflection output to make regular startup faster. May go stale and need cleanup at times."
+
+    val sourceSets = project.convention.getPlugin(JavaPluginConvention::class.java).sourceSets
+    val mainSourceSet: SourceSet = sourceSets[SourceSet.MAIN_SOURCE_SET_NAME]
+
+    inputs.files(mainSourceSet.output.classesDirs)
+    dependsOn(tasks.named("classes"))
+    outputs.upToDateWhen { tasks.named("classes").get().state.upToDate }
+
+    // TODO: output to the task's own build directory, because putting things in the
+    //     classes directory confuses gradle caching.
+    val manifestFile = File(mainSourceSet.output.classesDirs.first(), "manifest.json")
+    outputs.file(manifestFile)
+
+    doLast {
+        val classPaths = mainSourceSet.compileClasspath.map { it.toURI().toURL() }
+        val classLoader = URLClassLoader(classPaths.toTypedArray())
+        try {
+            val reflections = Reflections(
+                ConfigurationBuilder()
+                .setSerializer(JsonSerializer())
+                .addClassLoader(classLoader)
+                // .filterInputsBy(FilterBuilder.parsePackages("+org"))
+                .addUrls(inputs.files.map { it.toURI().toURL() })
+                .setScanners(TypeAnnotationsScanner(), SubTypesScanner(false)))
+            reflections.save(manifestFile.toString())
+        } catch (e: java.net.MalformedURLException) {
+            logger.error("Cannot parse input to url", e)
+        }
+    }
+}

build-logic/src/main/kotlin/terasology-module.gradle.kts

@@ -5,11 +5,6 @@
 
 import org.gradle.plugins.ide.eclipse.model.EclipseModel
 import org.gradle.plugins.ide.idea.model.IdeaModel
-import org.reflections.Reflections
-import org.reflections.scanners.SubTypesScanner
-import org.reflections.scanners.TypeAnnotationsScanner
-import org.reflections.util.ConfigurationBuilder
-import org.reflections.util.FilterBuilder
 import org.terasology.gradology.ModuleMetadataForGradle
 
 plugins {
@@ -121,32 +116,6 @@ tasks.register("createSkeleton") {
 val mainSourceSet: SourceSet = sourceSets[SourceSet.MAIN_SOURCE_SET_NAME]
 
 
-tasks.register("cacheReflections") {
-    description = "Caches reflection output to make regular startup faster. May go stale and need cleanup at times."
-    inputs.files(mainSourceSet.output.classesDirs)
-    outputs.file(File(mainSourceSet.output.classesDirs.first(), "reflections.cache"))
-    dependsOn(tasks.named("classes"))
-
-    outputs.upToDateWhen { tasks.named("classes").get().state.upToDate }
-
-    doFirst {
-        try {
-            val reflections = Reflections(ConfigurationBuilder()
-                    .filterInputsBy(FilterBuilder.parsePackages("+org"))
-                    .addUrls(inputs.getFiles().getSingleFile().toURI().toURL())
-                    .setScanners(TypeAnnotationsScanner(), SubTypesScanner()))
-            reflections.save(outputs.getFiles().getAsPath())
-        } catch (e: java.net.MalformedURLException) {
-            logger.error("Cannot parse input to url", e)
-        }
-    }
-}
-
-tasks.register<Delete>("cleanReflections") {
-    description = "Cleans the reflection cache. Useful in cases where it has gone stale and needs regeneration."
-    delete(tasks.getByName("cacheReflections").outputs.files)
-}
-
 // This task syncs everything in the assets dir into the output dir, used when jarring the module
 tasks.register<Sync>("syncAssets") {
     from("assets")
@@ -166,7 +135,6 @@ tasks.register<Sync>("syncDeltas") {
 // Instructions for packaging a jar file - is a manifest even needed for modules?
 tasks.named("jar") {
     // Make sure the assets directory is included
-    dependsOn("cacheReflections")
     dependsOn("syncAssets")
     dependsOn("syncOverrides")
     dependsOn("syncDeltas")
@@ -179,7 +147,6 @@ tasks.named("jar") {
         }
     }
 
-    finalizedBy("cleanReflections")
 }
 
 tasks.named<Test>("test") {

build-logic/src/main/kotlin/terasology-repositories.gradle.kts

@@ -14,6 +14,14 @@ repositories {
         }
     }
 
+    google {
+        // gestalt uses an annotation library from Google
+        content {
+            // (This is an optimization so gradle doesn't try to find our hundreds of modules here.)
+            excludeGroupByRegex("""org\.terasology(\..+)?""")
+        }
+    }
+
     // MovingBlocks Artifactory instance for libs not readily available elsewhere plus our own libs
     maven {
         val repoViaEnv = System.getenv()["RESOLUTION_REPO"]

build.gradle

@@ -5,6 +5,7 @@
 buildscript {
     repositories {
         mavenCentral()
+        google()
         gradlePluginPortal()
 
         maven {
@@ -16,10 +17,6 @@ buildscript {
     }
 
     dependencies {
-        // Needed for caching reflected data during builds
-        classpath 'org.terasology:reflections:0.9.12-MB'
-        classpath 'dom4j:dom4j:1.6.1'
-
         //Spotbugs
         classpath "gradle.plugin.com.github.spotbugs.snom:spotbugs-gradle-plugin:4.0.0"
 
@@ -43,6 +40,8 @@ plugins {
     id "idea"
     // For the "Build and run using: Intellij IDEA | Gradle" switch
     id "org.jetbrains.gradle.plugin.idea-ext" version "1.0"
+
+    id("terasology-repositories")
 }
 
 
@@ -71,17 +70,6 @@ ext {
     LwjglVersion = '3.2.3'
 }
 
-// Declare remote repositories we're interested in - library files will be fetched from here
-repositories {
-    mavenCentral()
-
-    // MovingBlocks Artifactory instance for libs not readily available elsewhere plus our own libs
-    maven {
-        name "Terasology Artifactory"
-        url "http://artifactory.terasology.org/artifactory/virtual-repo-live"
-        allowInsecureProtocol true  // 😱
-    }
-}
 
 ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 // Natives - Handles pulling in and extracting native libraries for LWJGL                                            //

engine-tests/build.gradle

@@ -23,7 +23,7 @@ ext {
 ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
 // Read the internal version out of the engine-tests module.txt
-def moduleFile = file('src/main/resources/module.txt')
+def moduleFile = file('src/main/resources/org/terasology/unittest/module.txt')
 
 if (!moduleFile.exists()) {
     println "Failed to find module.txt for engine-tests"
@@ -68,6 +68,7 @@ dependencies {
     implementation("org.junit.jupiter:junit-jupiter-api")
     implementation("org.junit.jupiter:junit-jupiter-params")
     testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine")
+    testImplementation("org.mockito:mockito-inline:3.7.7")
 
     implementation("org.mockito:mockito-junit-jupiter:3.7.7")
 

engine-tests/src/main/java/org/terasology/engine/Environment.java

@@ -1,32 +1,19 @@
-/*
- * Copyright 2014 MovingBlocks
- *
- * Licensed under the Apache License, Version 2.0 (the "License"){ }
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *  http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
+// Copyright 2021 The Terasology Foundation
+// SPDX-License-Identifier: Apache-2.0
 
 package org.terasology.engine;
 
 import com.badlogic.gdx.physics.bullet.Bullet;
 import com.google.common.collect.Sets;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
-import org.terasology.assets.management.AssetManager;
 import org.terasology.engine.context.Context;
 import org.terasology.engine.context.internal.ContextImpl;
 import org.terasology.engine.core.paths.PathManager;
 import org.terasology.engine.recording.RecordAndReplayCurrentStatus;
 import org.terasology.engine.registry.CoreRegistry;
-import org.terasology.naming.Name;
+import org.terasology.gestalt.assets.management.AssetManager;
+import org.terasology.gestalt.naming.Name;
 
 import java.io.IOException;
 import java.util.Set;
@@ -50,8 +37,11 @@ public Environment(Name... moduleNames) {
         try {
             reset(Sets.newHashSet(moduleNames));
         } catch (Exception e) {
-            logger.error("Error", e);
-            throw new RuntimeException(e);
+            if (e instanceof RuntimeException) {
+                throw (RuntimeException) e;
+            } else {
+                throw new RuntimeException(e);
+            }
         }
     }
 
@@ -76,7 +66,7 @@ protected void reset(Set<Name> moduleNames) throws Exception {
         AssetManager assetManager = setupAssetManager();
 
         setupBlockManager(assetManager);
-        
+
         setupExtraDataManager(context);
 
         setupCollisionManager();
@@ -137,7 +127,7 @@ protected AssetManager setupEmptyAssetManager() {
     protected void setupBlockManager(AssetManager assetManager) {
         // empty
     }
-    
+
     protected void setupExtraDataManager(Context context) {
         // empty
     }