fix: use codemaker output in java

hashicorp · Oct 13, 2023 · 34eeebe · 34eeebe
1 parent bdef3df
commit 34eeebe
Show file tree

Hide file tree

Showing 8 changed files with 22 additions and 7 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,12 @@
 
 Since the long-term support for Node.js 16 ended on 2023-09-11, we updated our minimum compatible Node.js version to 18.12.
 
+### Java: `codeMakerOutput` needs to be set to a company identifier
+
+We did not honor the `codeMakerOutput` setting in the `cdktf.json` previously, this is fixed now.
+To have no changes in the generated code you can set `codeMakerOutput: "imports"`.
+If you like, you can now set it to your company name, e.g. `codeMakerOutput: "com.hashicorp"` so that the provider is generated under the `com.hashicorp.aws` generated.
+
 ## 0.18.2
 
 Fixes a bug in 0.18.1 that broke crash reporting due to a partial dependency upgrade.

diff --git a/examples/java/documentation-gradle/cdktf.json b/examples/java/documentation-gradle/cdktf.json
@@ -1,7 +1,7 @@
 {
   "language": "java",
   "app": "./gradlew run",
-  "codeMakerOutput": "src/main/java/imports",
+  "codeMakerOutput": "imports",
   "terraformProviders": [
     "aws@~> 3.0",
     "kubernetes@~> 2.0",

diff --git a/examples/java/documentation/cdktf.json b/examples/java/documentation/cdktf.json
@@ -1,7 +1,7 @@
 {
   "language": "java",
   "app": "mvn -e -q compile exec:java",
-  "codeMakerOutput": "src/main/java/imports",
+  "codeMakerOutput": "imports",
   "terraformProviders": [
     "aws@~> 3.0",
     "kubernetes@~> 2.0",

diff --git a/examples/java/gradle-shared-module/common/cdktf.json b/examples/java/gradle-shared-module/common/cdktf.json
@@ -2,7 +2,7 @@
   "language": "java",
   "app": "../gradlew -q :common:run",
   "output": "./",
-  "codeMakerOutput": "./src/main/java/imports",
+  "codeMakerOutput": "imports",
   "terraformProviders": [
     "hashicorp/vsphere@~> 2.0.2"
   ],

diff --git a/examples/java/gradle-shared-module/module-a/cdktf.json b/examples/java/gradle-shared-module/module-a/cdktf.json
@@ -2,7 +2,7 @@
   "language": "java",
   "app": "../gradlew -q :module-a:run",
   "output": "./",
-  "codeMakerOutput": "./src/main/java/imports",
+  "codeMakerOutput": "imports",
   "terraformProviders": [],
   "context": {}
 }
diff --git a/examples/java/gradle-shared-module/module-b/cdktf.json b/examples/java/gradle-shared-module/module-b/cdktf.json
@@ -3,7 +3,7 @@
   "app": "../gradlew -q :module-b:run",
   "//": "The target output directory is set to the current working directory so that definitions generated by cdk can be referenced in local HCL sources",
   "output": "./",
-  "codeMakerOutput": "./src/main/java/imports",
+  "codeMakerOutput": "imports",
   "terraformProviders": [],
   "context": {}
 }
diff --git a/packages/@cdktf/cli-core/templates/java/cdktf.json b/packages/@cdktf/cli-core/templates/java/cdktf.json
@@ -3,7 +3,7 @@
   "app": "./gradlew run",
   "projectId": "{{projectId}}",
   "sendCrashReports": "{{sendCrashReports}}",
-  "codeMakerOutput": "src/main/java/imports",
+  "codeMakerOutput": "imports",
   "terraformProviders": [],
   "terraformModules": [],
   "context": {

diff --git a/packages/@cdktf/provider-generator/lib/get/constructs-maker.ts b/packages/@cdktf/provider-generator/lib/get/constructs-maker.ts
@@ -410,9 +410,18 @@ export class ConstructsMaker {
     }
 
     if (this.isJavaTarget) {
+      if (
+        this.options.codeMakerOutput.includes("/") ||
+        this.options.codeMakerOutput.includes("\\")
+      ) {
+        throw Errors.Usage(
+          `When using Java the "codeMakerOutput" option in the cdktf.json must be the organization identifier for your project (e.g. com.my-company), not a path. The generated Java code will be placed in a subdirectory of the given directory.`
+        );
+      }
+
       opts.java = {
         outdir: ".", // generated java files aren't packaged, so just include directly in app
-        package: `imports.${target.srcMakName}`,
+        package: `${this.options.codeMakerOutput}.${target.srcMakName}`,
       };
     }