chore(spec2cdk): support local, temporary service files (#27675)

To work with new features that are not released on CFN yet, we need the ability to provide local schema overrides. This changes adds support for this, by importing additional schema files into the model database before codegen.

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

Author: mrgrain

tools/@aws-cdk/spec2cdk/README.md

@@ -37,6 +37,11 @@ Path patterns can use the following variables:
 
 ```
 
+## Temporary Schemas
+
+You can import additional, temporary CloudFormation Registry Schemas to test new functionality that is not yet published in `@aws-cdk/aws-service-spec`.
+To do this, drop the schema file into `temporary-schemas/us-east-1` and it will be imported on top of the default model.
+
 ## Use as @aws-cdk/cfn2ts replacement
 
 You can use the `cfn2ts` binary as a drop-in replacement for the existing `@aws-cdk/cfn2ts` command.

tools/@aws-cdk/spec2cdk/lib/generate.ts

@@ -1,5 +1,6 @@
 import * as path from 'path';
 import { loadAwsServiceSpec } from '@aws-cdk/aws-service-spec';
+import { DatabaseBuilder } from '@aws-cdk/service-spec-importers';
 import { SpecDatabase } from '@aws-cdk/service-spec-types';
 import { TypeScriptRenderer } from '@cdklabs/typewriter';
 import * as fs from 'fs-extra';
@@ -118,6 +119,12 @@ export interface GenerateOutput {
 export async function generate(modules: GenerateModuleMap, options: GenerateOptions) {
   enableDebug(options);
   const db = await loadAwsServiceSpec();
+
+  // Load additional schema files
+  await new DatabaseBuilder(db as any, { validate: false })
+    .importCloudFormationRegistryResources(path.join(__dirname, '..', 'temporary-schemas'))
+    .build();
+
   return generator(db, modules, options);
 }
 

tools/@aws-cdk/spec2cdk/package.json

@@ -33,6 +33,7 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@aws-cdk/aws-service-spec": "^0.0.23",
+    "@aws-cdk/service-spec-importers": "^0.0.1",
     "@aws-cdk/service-spec-types": "^0.0.23",
     "@cdklabs/tskb": "^0.0.1",
     "@cdklabs/typewriter": "^0.0.2",

tools/@aws-cdk/spec2cdk/temporary-schemas/us-east-1/.keep

@@ -68,6 +68,22 @@
   resolved "https://registry.npmjs.org/@aws-cdk/lambda-layer-kubectl-v24/-/lambda-layer-kubectl-v24-2.0.242.tgz#4273a5ad7714f933a7eba155eb9280823086db71"
   integrity sha512-7/wIOo685tmrEe4hh6zqDELhBZh5OQGf3Hd2FU2Vnwy2ZubW8qTmEw5gqJCsCrGKeYDoa1BcVhDRZ/nzjkaqyA==
 
+"@aws-cdk/service-spec-importers@^0.0.1":
+  version "0.0.1"
+  resolved "https://registry.npmjs.org/@aws-cdk/service-spec-importers/-/service-spec-importers-0.0.1.tgz#9565d3c358e4b5237c778bee50f8591553846819"
+  integrity sha512-CyUWiNcyFxdLeqiWIfR22eOGV4BTFDn6p+qLeNdX21vzBk4WFNlJ1n5VI+Z44a2BJyrG4ckp0Vj4SFP9Q76Mjw==
+  dependencies:
+    "@aws-cdk/service-spec-types" "^0.0.23"
+    "@cdklabs/tskb" "^0.0.2"
+    ajv "^6"
+    canonicalize "^2.0.0"
+    chalk "^4"
+    commander "^11.1.0"
+    fast-json-patch "^3.1.1"
+    fs-extra "^11.1.1"
+    glob "^8"
+    sort-json "^2.0.1"
+
 "@aws-cdk/service-spec-types@^0.0.23":
   version "0.0.23"
   resolved "https://registry.npmjs.org/@aws-cdk/service-spec-types/-/service-spec-types-0.0.23.tgz#b336c6e4cd50ea098b3e2728fb98bf8e8686dce7"
@@ -4724,7 +4740,7 @@ aggregate-error@^3.0.0:
     clean-stack "^2.0.0"
     indent-string "^4.0.0"
 
-ajv@^6.10.0, ajv@^6.12.4:
+ajv@^6, ajv@^6.10.0, ajv@^6.12.4:
   version "6.12.6"
   resolved "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz#baf5a62e802b07d977034586f8c3baf5adf26df4"
   integrity sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==
@@ -5515,6 +5531,11 @@ caniuse-lite@^1.0.30001539:
   resolved "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001541.tgz#b1aef0fadd87fb72db4dcb55d220eae17b81cdb1"
   integrity sha512-bLOsqxDgTqUBkzxbNlSBt8annkDpQB9NdzdTbO2ooJ+eC/IQcvDspDc058g84ejCelF7vHUx57KIOjEecOHXaw==
 
+canonicalize@^2.0.0:
+  version "2.0.0"
+  resolved "https://registry.npmjs.org/canonicalize/-/canonicalize-2.0.0.tgz#32be2cef4446d67fd5348027a384cae28f17226a"
+  integrity sha512-ulDEYPv7asdKvqahuAY35c1selLdzDwHqugK92hfkzvlDCwXRRelDkR+Er33md/PtnpqHemgkuDPanZ4fiYZ8w==
+
 [email protected], case@^1.6.3:
   version "1.6.3"
   resolved "https://registry.npmjs.org/case/-/case-1.6.3.tgz#0a4386e3e9825351ca2e6216c60467ff5f1ea1c9"
@@ -5865,6 +5886,11 @@ commander@^10.0.1:
   resolved "https://registry.npmjs.org/commander/-/commander-10.0.1.tgz#881ee46b4f77d1c1dccc5823433aa39b022cbe06"
   integrity sha512-y4Mg2tXshplEbSGzx7amzPwKKOCGuoSRP/CjEdwwk0FOGlUbq6lKuoyDZTNZkmxHdJtp54hdfY/JUrdL7Xfdug==
 
+commander@^11.1.0:
+  version "11.1.0"
+  resolved "https://registry.npmjs.org/commander/-/commander-11.1.0.tgz#62fdce76006a68e5c1ab3314dc92e800eb83d906"
+  integrity sha512-yPVavfyCcRhmorC7rWlkHn15b4wDVgVmBA7kV4QVBsF7kv/9TKJAbAXVTxvTnwP8HHKjRCJDClKbciiYS7p0DQ==
+
 commander@^2.16.0, commander@^2.20.3, commander@^2.8.1:
   version "2.20.3"
   resolved "https://registry.npmjs.org/commander/-/commander-2.20.3.tgz#fd485e84c03eb4881c20722ba48035e8531aeb33"
@@ -7942,7 +7968,7 @@ glob@^7.0.0, glob@^7.1.1, glob@^7.1.3, glob@^7.1.4, glob@^7.1.6, glob@^7.1.7, gl
     once "^1.3.0"
     path-is-absolute "^1.0.0"
 
-glob@^8.0.1:
+glob@^8, glob@^8.0.1:
   version "8.1.0"
   resolved "https://registry.npmjs.org/glob/-/glob-8.1.0.tgz#d388f656593ef708ee3e34640fdfb99a9fd1c33e"
   integrity sha512-r8hpEjiQEYlF2QU0df3dS+nxxSIreXQS1qRhMJM0Q5NDdR386C7jb7Hwwod8Fgiuex+k0GFjgft18yvxm5XoCQ==