Handle required parameters for certain builders

Author: NickBurkard

README.md

@@ -91,6 +91,8 @@ object ExampleApp extends App {
 
     CfnApplicationV2(
       internalResourceId = "Runtime",
+      serviceExecutionRole = "arn:example-role",
+      runtimeEnvironment = "FLINK-1_13",
       tags = Some(
         List(
           CfnTag(key = Some("env"), value = Some(env)),
@@ -117,9 +119,7 @@ object ExampleApp extends App {
             )
           )
         )
-      ),
-      serviceExecutionRole = Some("arn:example-role"),
-      runtimeEnvironment = Some("FLINK-1_13")
+      )
     )
   }
 }

build.sbt

@@ -155,6 +155,7 @@ lazy val awsCdkScala = project
     opensearchservice,
     opsworks,
     opsworkscm,
+    panorama,
     pinpoint,
     pinpointemail,
     pipelines,
@@ -164,6 +165,7 @@ lazy val awsCdkScala = project
     rds,
     redshift,
     regioninfo,
+    rekognition,
     resourcegroups,
     robomaker,
     route53,
@@ -195,6 +197,7 @@ lazy val awsCdkScala = project
     transfer,
     waf,
     wafv2,
+    wisdom,
     workspaces,
     xray
   )
@@ -1024,6 +1027,12 @@ lazy val opsworkscm = project
   .withCdk()
   .enablePublishing()
 
+lazy val panorama = project
+  .in(file("modules/panorama"))
+  .dependsOn(core)
+  .withCdk()
+  .enablePublishing()
+
 lazy val pinpoint = project
   .in(file("modules/pinpoint"))
   .dependsOn(core)
@@ -1078,6 +1087,12 @@ lazy val regioninfo = project
   .withCdk()
   .enablePublishing()
 
+lazy val rekognition = project
+  .in(file("modules/rekognition"))
+  .dependsOn(core)
+  .withCdk()
+  .enablePublishing()
+
 lazy val resourcegroups = project
   .in(file("modules/resourcegroups"))
   .dependsOn(core)
@@ -1264,6 +1279,12 @@ lazy val wafv2 = project
   .withCdk()
   .enablePublishing()
 
+lazy val wisdom = project
+  .in(file("modules/wisdom"))
+  .dependsOn(core)
+  .withCdk()
+  .enablePublishing()
+
 lazy val workspaces = project
   .in(file("modules/workspaces"))
   .dependsOn(core)

codegen/src/main/scala/io/burkard/cdk/codegen/CdkBuilder.scala

@@ -4,6 +4,9 @@ import java.lang.reflect.{Method, Modifier}
 import java.nio.file.{Path, Paths}
 
 import scala.annotation.nowarn
+import scala.util.Try
+
+import com.google.common.base.CaseFormat
 
 import io.burkard.cdk.codegen.CdkBuilder.ConstructorType
 
@@ -15,8 +18,26 @@ final case class CdkBuilder private[codegen](
   constructorType: CdkBuilder.ConstructorType,
   underlying: Class[_]
 ) {
+  // The required field names of the underlying builder props.
+  private[codegen] lazy val requiredFieldNames: Set[String] =
+    (for {
+      // The `props` field is a builder for all required & optional properties.
+      propsBuilder <- Try(underlying.getDeclaredField("props")).map(_.getType)
+
+      // The `build` method returns an instance of the props itself, which needs to be inspected.
+      props <- Try(propsBuilder.getDeclaredMethod("build")).map(_.getReturnType)
+
+      // Dig into `props` for all non-static `get` methods without a default implementation.
+      requiredFields = props.getDeclaredMethods.toList
+        .collect {
+          case m if !Modifier.isStatic(m.getModifiers) && m.getName.startsWith("get") && !m.isDefault =>
+            CaseFormat.UPPER_CAMEL.to(CaseFormat.LOWER_CAMEL, m.getName.stripPrefix("get"))
+        }
+        .toSet
+    } yield requiredFields).getOrElse(Set.empty)
+
   @nowarn("cat=deprecation")
-  // [0, N] field methods of the underlying builder. All are optional for the generated code.
+  // [0, N] field methods of the underlying builder. All non-optional fields appear before optional fields.
   private[this] lazy val fieldMethods: List[FieldMethod] =
     underlying
       .getMethods
@@ -38,7 +59,7 @@ final case class CdkBuilder private[codegen](
               methodName,
               methodName,
               typeName,
-              isOptional = true,
+              isOptional = !requiredFieldNames.contains(methodName),
               annotations
             )
           )
@@ -51,12 +72,13 @@ final case class CdkBuilder private[codegen](
               s"$methodName$index",
               methodName,
               typeName,
-              isOptional = true,
+              isOptional = !requiredFieldNames.contains(methodName),
               annotations
             )
           }
       }
       .toList
+      .sortBy(_.isOptional)
 
   lazy val packageName: String = renamePackage(underlying.getPackageName)
 

codegen/src/main/scala/io/burkard/cdk/codegen/Codegen.scala

@@ -24,7 +24,13 @@ object Codegen {
         classInfo.getPackageName match {
           // Resource for some service.
           case ServiceRegex(_, name) =>
-            name -> classInfo.load()
+            // Bundle deprecated assets in core module.
+            // TODO Remove once deprecated assets are gone.
+            if (name.startsWith("assets")) {
+              "core" -> classInfo.load()
+            } else {
+              name -> classInfo.load()
+            }
 
           // Shared resources are considered `core`.
           case CoreRegex() =>

codegen/src/main/scala/io/burkard/cdk/codegen/package.scala

@@ -14,8 +14,15 @@ package object codegen {
   private[this] val packageRewrites: List[(Regex, Regex.Match => String)] =
     List(
       ServiceRegex -> { m =>
+        // Bundle deprecated assets in core module.
+        // TODO Remove once deprecated assets are gone.
         if (m.group(1) == null) {
-          s"io.burkard.cdk.${m.group(2)}"
+          val second = m.group(2)
+          if (second.startsWith("assets")) {
+            s"io.burkard.cdk.core.$second"
+          } else {
+            s"io.burkard.cdk.$second"
+          }
         } else {
           s"io.burkard.cdk.services.${m.group(2)}"
         }

codegen/src/test/scala/io/burkard/cdk/codegen/CdkBuilderSpec.scala

@@ -31,6 +31,13 @@ class CdkBuilderSpec extends AnyFlatSpec with Matchers with OptionValues {
       .value mustBe directConstructorCdkBuilder
   }
 
+  it should "identify required fields" in {
+    CdkBuilder
+      .build(requiredFieldsServiceName, requiredFieldsBuilderClass)
+      .value
+      .requiredFieldNames mustBe requiredFieldsNames
+  }
+
   it should "reject a non-builder class" in {
     import CdkBuilderTestFixtures.Invalid._
 

codegen/src/test/scala/io/burkard/cdk/codegen/CdkBuilderTestFixtures.scala

@@ -3,6 +3,7 @@ package io.burkard.cdk.codegen
 import software.amazon.awscdk.Tag
 import software.amazon.awscdk.services.cloudwatch.CfnDashboardProps
 import software.amazon.awscdk.services.ec2.Connections
+import software.amazon.awscdk.services.kinesisanalytics.CfnApplicationV2
 import software.amazon.awscdk.services.route53.CaaRecord
 
 object CdkBuilderTestFixtures {
@@ -79,6 +80,14 @@ object CdkBuilderTestFixtures {
         constructorType = CdkBuilder.ConstructorType.DirectConstructorNoParameters,
         underlying = directConstructorBuilderClass
       )
+
+    val requiredFieldsServiceName: String = "kinesisanalytics"
+
+    lazy val requiredFieldsBuilderClass: Class[CfnApplicationV2.Builder] =
+      classOf[CfnApplicationV2.Builder]
+
+    val requiredFieldsNames: Set[String] =
+      Set("serviceExecutionRole", "runtimeEnvironment")
   }
 
   object Invalid {

example/src/main/scala/io/burkard/cdk/example/ExampleApp.scala

@@ -20,6 +20,8 @@ object ExampleApp extends App {
 
     CfnApplicationV2(
       internalResourceId = "Runtime",
+      serviceExecutionRole = "arn:example-role",
+      runtimeEnvironment = "FLINK-1_13",
       tags = Some(
         List(
           CfnTag(key = Some("env"), value = Some(env)),
@@ -46,9 +48,7 @@ object ExampleApp extends App {
             )
           )
         )
-      ),
-      serviceExecutionRole = Some("arn:example-role"),
-      runtimeEnvironment = Some("FLINK-1_13")
+      )
     )
   }
 }

modules/accessanalyzer/src/main/scala/io/burkard/cdk/services/accessanalyzer/CfnAnalyzer.scala

@@ -8,16 +8,16 @@ object CfnAnalyzer {
 
   def apply(
     internalResourceId: String,
+    `type`: String,
     tags: Option[List[_ <: software.amazon.awscdk.CfnTag]] = None,
     analyzerName: Option[String] = None,
-    `type`: Option[String] = None,
     archiveRules: Option[List[_]] = None
   )(implicit stackCtx: software.amazon.awscdk.Stack): software.amazon.awscdk.services.accessanalyzer.CfnAnalyzer =
     software.amazon.awscdk.services.accessanalyzer.CfnAnalyzer.Builder
       .create(stackCtx, internalResourceId)
+      .`type`(`type`)
       .tags(tags.map(_.asJava).orNull)
       .analyzerName(analyzerName.orNull)
-      .`type`(`type`.orNull)
       .archiveRules(archiveRules.map(_.asJava).orNull)
       .build()
 }

modules/acmpca/src/main/scala/io/burkard/cdk/services/acmpca/CfnCertificate.scala

@@ -5,22 +5,22 @@ object CfnCertificate {
 
   def apply(
     internalResourceId: String,
+    certificateAuthorityArn: String,
+    signingAlgorithm: String,
+    validity: software.amazon.awscdk.services.acmpca.CfnCertificate.ValidityProperty,
+    certificateSigningRequest: String,
     apiPassthrough: Option[software.amazon.awscdk.services.acmpca.CfnCertificate.ApiPassthroughProperty] = None,
     validityNotBefore: Option[software.amazon.awscdk.services.acmpca.CfnCertificate.ValidityProperty] = None,
-    certificateAuthorityArn: Option[String] = None,
-    signingAlgorithm: Option[String] = None,
-    validity: Option[software.amazon.awscdk.services.acmpca.CfnCertificate.ValidityProperty] = None,
-    templateArn: Option[String] = None,
-    certificateSigningRequest: Option[String] = None
+    templateArn: Option[String] = None
   )(implicit stackCtx: software.amazon.awscdk.Stack): software.amazon.awscdk.services.acmpca.CfnCertificate =
     software.amazon.awscdk.services.acmpca.CfnCertificate.Builder
       .create(stackCtx, internalResourceId)
+      .certificateAuthorityArn(certificateAuthorityArn)
+      .signingAlgorithm(signingAlgorithm)
+      .validity(validity)
+      .certificateSigningRequest(certificateSigningRequest)
       .apiPassthrough(apiPassthrough.orNull)
       .validityNotBefore(validityNotBefore.orNull)
-      .certificateAuthorityArn(certificateAuthorityArn.orNull)
-      .signingAlgorithm(signingAlgorithm.orNull)
-      .validity(validity.orNull)
       .templateArn(templateArn.orNull)
-      .certificateSigningRequest(certificateSigningRequest.orNull)
       .build()
 }