chore: make ftl init create self contained kotlin modules (#1005)

- removes parent POM + logic to update parent POM when new child POMs are added; each module has its own self-contained POM now - removes now unused`ftlEndpoint` and `ftlModuleName` maven properties - removes the `ftl-module-` prefix from kotlin module scaffolding fixes #933 --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
block · Mar 2, 2024 · 208c3aa · 208c3aa
1 parent 9a8df99
commit 208c3aa
Show file tree

Hide file tree

Showing 15 changed files with 244 additions and 205 deletions.
diff --git a/buildengine/build_kotlin.go b/buildengine/build_kotlin.go
@@ -40,7 +40,7 @@ func (e externalModuleContext) ExternalModules() []*schema.Module {
 
 func buildKotlin(ctx context.Context, sch *schema.Schema, module Module) error {
 	logger := log.FromContext(ctx)
-	if err := SetPOMProperties(ctx, filepath.Join(module.Dir, "..")); err != nil {
+	if err := SetPOMProperties(ctx, module.Dir); err != nil {
 		return fmt.Errorf("unable to update ftl.version in %s: %w", module.Dir, err)
 	}
 
@@ -61,7 +61,7 @@ func buildKotlin(ctx context.Context, sch *schema.Schema, module Module) error {
 	return nil
 }
 
-// SetPOMProperties updates the ftl.version and ftlEndpoint properties in the
+// SetPOMProperties updates the ftl.version properties in the
 // pom.xml file in the given base directory.
 func SetPOMProperties(ctx context.Context, baseDir string) error {
 	logger := log.FromContext(ctx)
@@ -70,11 +70,6 @@ func SetPOMProperties(ctx context.Context, baseDir string) error {
 		ftlVersion = "1.0-SNAPSHOT"
 	}
 
-	ftlEndpoint := os.Getenv("FTL_ENDPOINT")
-	if ftlEndpoint == "" {
-		ftlEndpoint = "http://127.0.0.1:8892"
-	}
-
 	pomFile := filepath.Clean(filepath.Join(baseDir, "pom.xml"))
 
 	logger.Debugf("Setting ftl.version in %s to %s", pomFile, ftlVersion)
@@ -94,13 +89,6 @@ func SetPOMProperties(ctx context.Context, baseDir string) error {
 	}
 	version.SetText(ftlVersion)
 
-	endpoint := properties.SelectElement("ftlEndpoint")
-	if endpoint == nil {
-		logger.Warnf("unable to find <properties>/<ftlEndpoint> in %s", pomFile)
-	} else {
-		endpoint.SetText(ftlEndpoint)
-	}
-
 	return tree.WriteToFile(pomFile)
 }
 

diff --git a/cmd/ftl/cmd_init.go b/cmd/ftl/cmd_init.go
@@ -12,7 +12,6 @@ import (
 	"strings"
 
 	"github.com/TBD54566975/scaffolder"
-	"github.com/beevik/etree"
 
 	"github.com/TBD54566975/ftl/backend/schema"
 	"github.com/TBD54566975/ftl/backend/schema/strcase"
@@ -72,52 +71,16 @@ func (i initKotlinCmd) Run(ctx context.Context, parent *initCmd) error {
 		return fmt.Errorf("module name %q is invalid", i.Name)
 	}
 
-	if _, err := os.Stat(filepath.Join(i.Dir, "ftl-module-"+i.Name)); err == nil {
+	moduleDir := filepath.Join(i.Dir, i.Name)
+	if _, err := os.Stat(moduleDir); err == nil {
 		return fmt.Errorf("module directory %s already exists", filepath.Join(i.Dir, i.Name))
 	}
 
-	options := []scaffolder.Option{}
-
-	// Update root POM if it already exists.
-	pomFile := filepath.Join(i.Dir, "pom.xml")
-	if _, err := os.Stat(pomFile); err == nil {
-		options = append(options, scaffolder.Exclude("^pom.xml$"))
-		if err := updatePom(pomFile, i.Name); err != nil {
-			return err
-		}
-	}
-
-	if err := scaffold(parent.Hermit, kotlinruntime.Files(), i.Dir, i, options...); err != nil {
-		return err
-	}
-
-	return buildengine.SetPOMProperties(ctx, i.Dir)
-}
-
-func updatePom(pomFile, name string) error {
-	tree := etree.NewDocument()
-	err := tree.ReadFromFile(pomFile)
-	if err != nil {
+	if err := scaffold(parent.Hermit, kotlinruntime.Files(), i.Dir, i); err != nil {
 		return err
 	}
 
-	// Add new module entry to root of XML file
-	root := tree.Root()
-	modules := root.SelectElement("modules")
-	if modules == nil {
-		modules = root.CreateElement("modules")
-	}
-	modules.CreateText("    ")
-	module := modules.CreateElement("module")
-	module.SetText("ftl-module-" + name)
-	modules.CreateText("\n    ")
-
-	// Write updated XML file back to disk
-	err = tree.WriteToFile(pomFile)
-	if err != nil {
-		return err
-	}
-	return nil
+	return buildengine.SetPOMProperties(ctx, moduleDir)
 }
 
 func unzipToTmpDir(reader *zip.Reader) (string, error) {

diff --git a/examples/kotlin/ftl-module-echo/ftl.toml → examples/kotlin/echo/ftl.toml b/examples/kotlin/ftl-module-echo/ftl.toml → examples/kotlin/echo/ftl.toml
diff --git a/examples/kotlin/pom.xml → examples/kotlin/echo/pom.xml b/examples/kotlin/pom.xml → examples/kotlin/echo/pom.xml
@@ -3,21 +3,13 @@
     <modelVersion>4.0.0</modelVersion>
 
     <groupId>ftl</groupId>
-    <artifactId>ftl</artifactId>
+    <artifactId>echo</artifactId>
     <version>1.0-SNAPSHOT</version>
 
-    <packaging>pom</packaging>
-
-    <modules>
-        <module>ftl-module-echo</module>
-        <module>ftl-module-time</module>
-    </modules>
-
     <properties>
         <ftl.version>1.0-SNAPSHOT</ftl.version>
-        <ftlEndpoint>http://localhost:8892</ftlEndpoint>
         <java.version>1.8</java.version>
-        <kotlin.version>1.9.0</kotlin.version>
+        <kotlin.version>1.9.22</kotlin.version>
         <kotlin.compiler.incremental>true</kotlin.compiler.incremental>
         <maven.compiler.source>${java.version}</maven.compiler.source>
         <maven.compiler.target>${java.version}</maven.compiler.target>
@@ -37,7 +29,7 @@
         <dependency>
             <groupId>org.postgresql</groupId>
             <artifactId>postgresql</artifactId>
-            <version>42.7.1</version>
+            <version>42.7.2</version>
         </dependency>
     </dependencies>
 
@@ -76,7 +68,7 @@
                 <plugin>
                     <groupId>org.apache.maven.plugins</groupId>
                     <artifactId>maven-dependency-plugin</artifactId>
-                    <version>3.2.0</version>
+                    <version>3.6.1</version>
                     <executions>
                         <!-- Copy all dependencies into the target directory -->
                         <execution>
@@ -119,7 +111,7 @@
                 <plugin>
                     <groupId>org.codehaus.mojo</groupId>
                     <artifactId>build-helper-maven-plugin</artifactId>
-                    <version>3.2.0</version>
+                    <version>3.5.0</version>
                     <executions>
                         <execution>
                             <phase>generate-sources</phase>
@@ -137,7 +129,7 @@
                 <plugin>
                     <groupId>com.github.ozsie</groupId>
                     <artifactId>detekt-maven-plugin</artifactId>
-                    <version>1.23.3.1</version>
+                    <version>1.23.5</version>
                     <configuration>
                         <disableDefaultRuleSets>true</disableDefaultRuleSets>
                         <classPath>${generated.classpath}</classPath>
@@ -169,5 +161,25 @@
                 </plugin>
             </plugins>
         </pluginManagement>
+        <plugins>
+            <plugin>
+                <artifactId>kotlin-maven-plugin</artifactId>
+                <groupId>org.jetbrains.kotlin</groupId>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-dependency-plugin</artifactId>
+            </plugin>
+            <!-- Add generated sources to the classpath -->
+            <plugin>
+                <groupId>org.codehaus.mojo</groupId>
+                <artifactId>build-helper-maven-plugin</artifactId>
+            </plugin>
+            <!-- Extract schema -->
+            <plugin>
+                <groupId>com.github.ozsie</groupId>
+                <artifactId>detekt-maven-plugin</artifactId>
+            </plugin>
+        </plugins>
     </build>
-</project>
+</project>
diff --git a/...ule-echo/src/main/kotlin/ftl/echo/Echo.kt → ...lin/echo/src/main/kotlin/ftl/echo/Echo.kt b/...ule-echo/src/main/kotlin/ftl/echo/Echo.kt → ...lin/echo/src/main/kotlin/ftl/echo/Echo.kt
diff --git a/examples/kotlin/ftl-module-echo/pom.xml b/examples/kotlin/ftl-module-echo/pom.xml
diff --git a/examples/kotlin/ftl-module-time/pom.xml b/examples/kotlin/ftl-module-time/pom.xml
diff --git a/examples/kotlin/ftl-module-time/ftl.toml → examples/kotlin/time/ftl.toml b/examples/kotlin/ftl-module-time/ftl.toml → examples/kotlin/time/ftl.toml