@aws-cdk/assert
Version:
An assertion library for use with CDK Apps
92 lines • 12.4 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.SynthUtils = void 0;
const fs = require("fs");
const path = require("path");
const core = require("aws-cdk-lib");
class SynthUtils {
/**
* Returns the cloud assembly template artifact for a stack.
*/
static synthesize(stack, options = {}) {
// always synthesize against the root (be it an App or whatever) so all artifacts will be included
const assembly = synthesizeApp(stack, options);
return stripNewStyleSynthCfnElements(assembly.getStackArtifact(stack.artifactId));
}
/**
* Synthesizes the stack and returns the resulting CloudFormation template.
*/
static toCloudFormation(stack, options = {}) {
const synth = this._synthesizeWithNested(stack, options);
if (isStackArtifact(synth)) {
return synth.template;
}
else {
return synth;
}
}
/**
* @returns Returns a subset of the synthesized CloudFormation template (only specific resource types).
*/
static subset(stack, options) {
const template = this.toCloudFormation(stack);
if (template.Resources) {
for (const [key, resource] of Object.entries(template.Resources)) {
if (options.resourceTypes && !options.resourceTypes.includes(resource.Type)) {
delete template.Resources[key];
}
}
}
return template;
}
/**
* Synthesizes the stack and returns a `CloudFormationStackArtifact` which can be inspected.
* Supports nested stacks as well as normal stacks.
*
* @return CloudFormationStackArtifact for normal stacks or the actual template for nested stacks
* @internal
*/
static _synthesizeWithNested(stack, options = {}) {
// always synthesize against the root (be it an App or whatever) so all artifacts will be included
const assembly = synthesizeApp(stack, options);
// if this is a nested stack (it has a parent), then just read the template as a string
if (stack.nestedStackParent) {
return JSON.parse(fs.readFileSync(path.join(assembly.directory, stack.templateFile)).toString('utf-8'));
}
return stripNewStyleSynthCfnElements(assembly.getStackArtifact(stack.artifactId));
}
}
exports.SynthUtils = SynthUtils;
/**
* Synthesizes the app in which a stack resides and returns the cloud assembly object.
*/
function synthesizeApp(stack, options) {
const root = stack.node.root;
if (!core.Stage.isStage(root)) {
throw new Error('unexpected: all stacks must be part of a Stage or an App');
}
// to support incremental assertions (i.e. "expect(stack).toNotContainSomething(); doSomething(); expect(stack).toContainSomthing()")
const force = true;
return root.synth({
force,
...options,
});
}
function stripNewStyleSynthCfnElements(stackArtifact) {
const synthesizedTemplate = stackArtifact.template;
// if new-style synthesis is not explicitly set, remove the extra generated Rule and Parameter from the synthesized template,
// to avoid changing many tests that rely on the template being exactly what it is
delete synthesizedTemplate?.Rules?.CheckBootstrapVersion;
if (Object.keys(synthesizedTemplate?.Rules ?? {}).length === 0) {
delete synthesizedTemplate?.Rules;
}
delete synthesizedTemplate?.Parameters?.BootstrapVersion;
if (Object.keys(synthesizedTemplate?.Parameters ?? {}).length === 0) {
delete synthesizedTemplate?.Parameters;
}
return stackArtifact;
}
function isStackArtifact(x) {
return 'template' in x;
}
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"synth-utils.js","sourceRoot":"","sources":["synth-utils.ts"],"names":[],"mappings":";;;AAAA,yBAAyB;AACzB,6BAA6B;AAC7B,oCAAoC;AAGpC,MAAa,UAAU;IACrB;;OAEG;IACI,MAAM,CAAC,UAAU,CAAC,KAAiB,EAAE,UAAsC,EAAG;QACnF,kGAAkG;QAClG,MAAM,QAAQ,GAAG,aAAa,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QAC/C,OAAO,6BAA6B,CAAC,QAAQ,CAAC,gBAAgB,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC;IACpF,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,gBAAgB,CAAC,KAAiB,EAAE,UAAsC,EAAG;QACzF,MAAM,KAAK,GAAG,IAAI,CAAC,qBAAqB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QACzD,IAAI,eAAe,CAAC,KAAK,CAAC,EAAE;YAC1B,OAAO,KAAK,CAAC,QAAQ,CAAC;SACvB;aAAM;YACL,OAAO,KAAK,CAAC;SACd;IACH,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,MAAM,CAAC,KAAiB,EAAE,OAAsB;QAC5D,MAAM,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;QAC9C,IAAI,QAAQ,CAAC,SAAS,EAAE;YACtB,KAAK,MAAM,CAAC,GAAG,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE;gBAChE,IAAI,OAAO,CAAC,aAAa,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,QAAQ,CAAE,QAAgB,CAAC,IAAI,CAAC,EAAE;oBACpF,OAAO,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;iBAChC;aACF;SACF;QAED,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,qBAAqB,CAAC,KAAiB,EAAE,UAAsC,EAAG;QAC9F,kGAAkG;QAClG,MAAM,QAAQ,GAAG,aAAa,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QAE/C,uFAAuF;QACvF,IAAI,KAAK,CAAC,iBAAiB,EAAE;YAC3B,OAAO,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;SACzG;QAED,OAAO,6BAA6B,CAAC,QAAQ,CAAC,gBAAgB,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC;IACpF,CAAC;CACF;AAxDD,gCAwDC;AAED;;GAEG;AACH,SAAS,aAAa,CAAC,KAAiB,EAAE,OAAmC;IAC3E,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC;IAC7B,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QAC7B,MAAM,IAAI,KAAK,CAAC,0DAA0D,CAAC,CAAC;KAC7E;IAED,qIAAqI;IACrI,MAAM,KAAK,GAAG,IAAI,CAAC;IAEnB,OAAO,IAAI,CAAC,KAAK,CAAC;QAChB,KAAK;QACL,GAAG,OAAO;KACX,CAAC,CAAC;AACL,CAAC;AAED,SAAS,6BAA6B,CAAC,aAAgD;IACrF,MAAM,mBAAmB,GAAG,aAAa,CAAC,QAAQ,CAAC;IAEnD,6HAA6H;IAC7H,kFAAkF;IAClF,OAAO,mBAAmB,EAAE,KAAK,EAAE,qBAAqB,CAAC;IACzD,IAAI,MAAM,CAAC,IAAI,CAAC,mBAAmB,EAAE,KAAK,IAAI,EAAE,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;QAC9D,OAAO,mBAAmB,EAAE,KAAK,CAAC;KACnC;IACD,OAAO,mBAAmB,EAAE,UAAU,EAAE,gBAAgB,CAAC;IACzD,IAAI,MAAM,CAAC,IAAI,CAAC,mBAAmB,EAAE,UAAU,IAAI,EAAE,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;QACnE,OAAO,mBAAmB,EAAE,UAAU,CAAC;KACxC;IAED,OAAO,aAAa,CAAC;AACvB,CAAC;AASD,SAAS,eAAe,CAAC,CAAS;IAChC,OAAO,UAAU,IAAI,CAAC,CAAC;AACzB,CAAC","sourcesContent":["import * as fs from 'fs';\nimport * as path from 'path';\nimport * as core from 'aws-cdk-lib';\nimport * as cxapi from 'aws-cdk-lib/cx-api';\n\nexport class SynthUtils {\n  /**\n   * Returns the cloud assembly template artifact for a stack.\n   */\n  public static synthesize(stack: core.Stack, options: core.StageSynthesisOptions = { }): cxapi.CloudFormationStackArtifact {\n    // always synthesize against the root (be it an App or whatever) so all artifacts will be included\n    const assembly = synthesizeApp(stack, options);\n    return stripNewStyleSynthCfnElements(assembly.getStackArtifact(stack.artifactId));\n  }\n\n  /**\n   * Synthesizes the stack and returns the resulting CloudFormation template.\n   */\n  public static toCloudFormation(stack: core.Stack, options: core.StageSynthesisOptions = { }): any {\n    const synth = this._synthesizeWithNested(stack, options);\n    if (isStackArtifact(synth)) {\n      return synth.template;\n    } else {\n      return synth;\n    }\n  }\n\n  /**\n   * @returns Returns a subset of the synthesized CloudFormation template (only specific resource types).\n   */\n  public static subset(stack: core.Stack, options: SubsetOptions): any {\n    const template = this.toCloudFormation(stack);\n    if (template.Resources) {\n      for (const [key, resource] of Object.entries(template.Resources)) {\n        if (options.resourceTypes && !options.resourceTypes.includes((resource as any).Type)) {\n          delete template.Resources[key];\n        }\n      }\n    }\n\n    return template;\n  }\n\n  /**\n   * Synthesizes the stack and returns a `CloudFormationStackArtifact` which can be inspected.\n   * Supports nested stacks as well as normal stacks.\n   *\n   * @return CloudFormationStackArtifact for normal stacks or the actual template for nested stacks\n   * @internal\n   */\n  public static _synthesizeWithNested(stack: core.Stack, options: core.StageSynthesisOptions = { }): cxapi.CloudFormationStackArtifact | object {\n    // always synthesize against the root (be it an App or whatever) so all artifacts will be included\n    const assembly = synthesizeApp(stack, options);\n\n    // if this is a nested stack (it has a parent), then just read the template as a string\n    if (stack.nestedStackParent) {\n      return JSON.parse(fs.readFileSync(path.join(assembly.directory, stack.templateFile)).toString('utf-8'));\n    }\n\n    return stripNewStyleSynthCfnElements(assembly.getStackArtifact(stack.artifactId));\n  }\n}\n\n/**\n * Synthesizes the app in which a stack resides and returns the cloud assembly object.\n */\nfunction synthesizeApp(stack: core.Stack, options: core.StageSynthesisOptions): cxapi.CloudAssembly {\n  const root = stack.node.root;\n  if (!core.Stage.isStage(root)) {\n    throw new Error('unexpected: all stacks must be part of a Stage or an App');\n  }\n\n  // to support incremental assertions (i.e. \"expect(stack).toNotContainSomething(); doSomething(); expect(stack).toContainSomthing()\")\n  const force = true;\n\n  return root.synth({\n    force,\n    ...options,\n  });\n}\n\nfunction stripNewStyleSynthCfnElements(stackArtifact: cxapi.CloudFormationStackArtifact): cxapi.CloudFormationStackArtifact {\n  const synthesizedTemplate = stackArtifact.template;\n\n  // if new-style synthesis is not explicitly set, remove the extra generated Rule and Parameter from the synthesized template,\n  // to avoid changing many tests that rely on the template being exactly what it is\n  delete synthesizedTemplate?.Rules?.CheckBootstrapVersion;\n  if (Object.keys(synthesizedTemplate?.Rules ?? {}).length === 0) {\n    delete synthesizedTemplate?.Rules;\n  }\n  delete synthesizedTemplate?.Parameters?.BootstrapVersion;\n  if (Object.keys(synthesizedTemplate?.Parameters ?? {}).length === 0) {\n    delete synthesizedTemplate?.Parameters;\n  }\n\n  return stackArtifact;\n}\n\nexport interface SubsetOptions {\n  /**\n   * Match all resources of the given type\n   */\n  resourceTypes?: string[];\n}\n\nfunction isStackArtifact(x: object): x is cxapi.CloudFormationStackArtifact {\n  return 'template' in x;\n}"]}