@aws-cdk/assert/lib/assertions/match-template.js

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.matchTemplate = exports.beASupersetOfTemplate = exports.exactlyMatchTemplate = exports.MatchStyle = void 0;
const cfnDiff = require("@aws-cdk/cloudformation-diff");
const assertion_1 = require("../assertion");
var MatchStyle;
(function (MatchStyle) {
    /** Requires an exact match */
    MatchStyle["EXACT"] = "exactly";
    /** Allows any change that does not cause a resource replacement */
    MatchStyle["NO_REPLACES"] = "no replaces";
    /** Allows additions, but no updates */
    MatchStyle["SUPERSET"] = "superset";
})(MatchStyle = exports.MatchStyle || (exports.MatchStyle = {}));
function exactlyMatchTemplate(template) {
    return matchTemplate(template, MatchStyle.EXACT);
}
exports.exactlyMatchTemplate = exactlyMatchTemplate;
function beASupersetOfTemplate(template) {
    return matchTemplate(template, MatchStyle.SUPERSET);
}
exports.beASupersetOfTemplate = beASupersetOfTemplate;
function matchTemplate(template, matchStyle = MatchStyle.EXACT) {
    return new StackMatchesTemplateAssertion(template, matchStyle);
}
exports.matchTemplate = matchTemplate;
class StackMatchesTemplateAssertion extends assertion_1.Assertion {
    constructor(template, matchStyle) {
        super();
        this.template = template;
        this.matchStyle = matchStyle;
    }
    assertOrThrow(inspector) {
        if (!this.assertUsing(inspector)) {
            // The details have already been printed, so don't generate a huge error message
            throw new Error('Template comparison produced unacceptable match');
        }
    }
    assertUsing(inspector) {
        const diff = cfnDiff.diffTemplate(this.template, inspector.value);
        const acceptable = this.isDiffAcceptable(diff);
        if (!acceptable) {
            // Print the diff
            cfnDiff.formatDifferences(process.stderr, diff);
            // Print the actual template
            process.stdout.write('--------------------------------------------------------------------------------------\n');
            process.stdout.write(JSON.stringify(inspector.value, undefined, 2) + '\n');
        }
        return acceptable;
    }
    isDiffAcceptable(diff) {
        switch (this.matchStyle) {
            case MatchStyle.EXACT:
                return diff.differenceCount === 0;
            case MatchStyle.NO_REPLACES:
                for (const change of Object.values(diff.resources.changes)) {
                    if (change.changeImpact === cfnDiff.ResourceImpact.MAY_REPLACE) {
                        return false;
                    }
                    if (change.changeImpact === cfnDiff.ResourceImpact.WILL_REPLACE) {
                        return false;
                    }
                }
                for (const change of Object.values(diff.parameters.changes)) {
                    if (change.isUpdate) {
                        return false;
                    }
                }
                for (const change of Object.values(diff.outputs.changes)) {
                    if (change.isUpdate) {
                        return false;
                    }
                }
                return true;
            case MatchStyle.SUPERSET:
                for (const change of Object.values(diff.resources.changes)) {
                    if (change.changeImpact !== cfnDiff.ResourceImpact.WILL_CREATE) {
                        return false;
                    }
                }
                for (const change of Object.values(diff.parameters.changes)) {
                    if (!change.isAddition) {
                        return false;
                    }
                }
                for (const change of Object.values(diff.outputs.changes)) {
                    if (!change.isAddition) {
                        return false;
                    }
                }
                return true;
        }
    }
    get description() {
        return `template (${this.matchStyle}): ${JSON.stringify(this.template, null, 2)}`;
    }
}
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"match-template.js","sourceRoot":"","sources":["match-template.ts"],"names":[],"mappings":";;;AAAA,wDAAwD;AACxD,4CAAyC;AAGzC,IAAY,UAOX;AAPD,WAAY,UAAU;IACpB,8BAA8B;IAC9B,+BAAiB,CAAA;IACjB,mEAAmE;IACnE,yCAA2B,CAAA;IAC3B,uCAAuC;IACvC,mCAAqB,CAAA;AACvB,CAAC,EAPW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAOrB;AAED,SAAgB,oBAAoB,CAAC,QAAgC;IACnE,OAAO,aAAa,CAAC,QAAQ,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC;AACnD,CAAC;AAFD,oDAEC;AAED,SAAgB,qBAAqB,CAAC,QAAgC;IACpE,OAAO,aAAa,CAAC,QAAQ,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC;AACtD,CAAC;AAFD,sDAEC;AAED,SAAgB,aAAa,CAC3B,QAAgC,EAChC,aAAyB,UAAU,CAAC,KAAK;IACzC,OAAO,IAAI,6BAA6B,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;AACjE,CAAC;AAJD,sCAIC;AAED,MAAM,6BAA8B,SAAQ,qBAAyB;IACnE,YACmB,QAAgC,EAChC,UAAsB;QACvC,KAAK,EAAE,CAAC;QAFS,aAAQ,GAAR,QAAQ,CAAwB;QAChC,eAAU,GAAV,UAAU,CAAY;IAEzC,CAAC;IAEM,aAAa,CAAC,SAAyB;QAC5C,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,EAAE;YAChC,gFAAgF;YAChF,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;SACpE;IACH,CAAC;IAEM,WAAW,CAAC,SAAyB;QAC1C,MAAM,IAAI,GAAG,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC;QAClE,MAAM,UAAU,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAC/C,IAAI,CAAC,UAAU,EAAE;YACf,iBAAiB;YACjB,OAAO,CAAC,iBAAiB,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;YAEhD,4BAA4B;YAC5B,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,0FAA0F,CAAC,CAAC;YACjH,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;SAC5E;QAED,OAAO,UAAU,CAAC;IACpB,CAAC;IAEO,gBAAgB,CAAC,IAA0B;QACjD,QAAQ,IAAI,CAAC,UAAU,EAAE;YACvB,KAAK,UAAU,CAAC,KAAK;gBACnB,OAAO,IAAI,CAAC,eAAe,KAAK,CAAC,CAAC;YACpC,KAAK,UAAU,CAAC,WAAW;gBACzB,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE;oBAC1D,IAAI,MAAM,CAAC,YAAY,KAAK,OAAO,CAAC,cAAc,CAAC,WAAW,EAAE;wBAAE,OAAO,KAAK,CAAC;qBAAE;oBACjF,IAAI,MAAM,CAAC,YAAY,KAAK,OAAO,CAAC,cAAc,CAAC,YAAY,EAAE;wBAAE,OAAO,KAAK,CAAC;qBAAE;iBACnF;gBAED,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE;oBAC3D,IAAI,MAAM,CAAC,QAAQ,EAAE;wBAAE,OAAO,KAAK,CAAC;qBAAE;iBACvC;gBAED,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;oBACxD,IAAI,MAAM,CAAC,QAAQ,EAAE;wBAAE,OAAO,KAAK,CAAC;qBAAE;iBACvC;gBACD,OAAO,IAAI,CAAC;YACd,KAAK,UAAU,CAAC,QAAQ;gBACtB,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE;oBAC1D,IAAI,MAAM,CAAC,YAAY,KAAK,OAAO,CAAC,cAAc,CAAC,WAAW,EAAE;wBAAE,OAAO,KAAK,CAAC;qBAAE;iBAClF;gBAED,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE;oBAC3D,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE;wBAAE,OAAO,KAAK,CAAC;qBAAE;iBAC1C;gBAED,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;oBACxD,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE;wBAAE,OAAO,KAAK,CAAC;qBAAE;iBAC1C;gBAED,OAAO,IAAI,CAAC;SACf;IACH,CAAC;IAED,IAAW,WAAW;QACpB,OAAO,aAAa,IAAI,CAAC,UAAU,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC;IACpF,CAAC;CACF","sourcesContent":["import * as cfnDiff from '@aws-cdk/cloudformation-diff';\nimport { Assertion } from '../assertion';\nimport { StackInspector } from '../inspector';\n\nexport enum MatchStyle {\n  /** Requires an exact match */\n  EXACT = 'exactly',\n  /** Allows any change that does not cause a resource replacement */\n  NO_REPLACES = 'no replaces',\n  /** Allows additions, but no updates */\n  SUPERSET = 'superset'\n}\n\nexport function exactlyMatchTemplate(template: { [key: string]: any }) {\n  return matchTemplate(template, MatchStyle.EXACT);\n}\n\nexport function beASupersetOfTemplate(template: { [key: string]: any }) {\n  return matchTemplate(template, MatchStyle.SUPERSET);\n}\n\nexport function matchTemplate(\n  template: { [key: string]: any },\n  matchStyle: MatchStyle = MatchStyle.EXACT): Assertion<StackInspector> {\n  return new StackMatchesTemplateAssertion(template, matchStyle);\n}\n\nclass StackMatchesTemplateAssertion extends Assertion<StackInspector> {\n  constructor(\n    private readonly template: { [key: string]: any },\n    private readonly matchStyle: MatchStyle) {\n    super();\n  }\n\n  public assertOrThrow(inspector: StackInspector) {\n    if (!this.assertUsing(inspector)) {\n      // The details have already been printed, so don't generate a huge error message\n      throw new Error('Template comparison produced unacceptable match');\n    }\n  }\n\n  public assertUsing(inspector: StackInspector): boolean {\n    const diff = cfnDiff.diffTemplate(this.template, inspector.value);\n    const acceptable = this.isDiffAcceptable(diff);\n    if (!acceptable) {\n      // Print the diff\n      cfnDiff.formatDifferences(process.stderr, diff);\n\n      // Print the actual template\n      process.stdout.write('--------------------------------------------------------------------------------------\\n');\n      process.stdout.write(JSON.stringify(inspector.value, undefined, 2) + '\\n');\n    }\n\n    return acceptable;\n  }\n\n  private isDiffAcceptable(diff: cfnDiff.TemplateDiff): boolean {\n    switch (this.matchStyle) {\n      case MatchStyle.EXACT:\n        return diff.differenceCount === 0;\n      case MatchStyle.NO_REPLACES:\n        for (const change of Object.values(diff.resources.changes)) {\n          if (change.changeImpact === cfnDiff.ResourceImpact.MAY_REPLACE) { return false; }\n          if (change.changeImpact === cfnDiff.ResourceImpact.WILL_REPLACE) { return false; }\n        }\n\n        for (const change of Object.values(diff.parameters.changes)) {\n          if (change.isUpdate) { return false; }\n        }\n\n        for (const change of Object.values(diff.outputs.changes)) {\n          if (change.isUpdate) { return false; }\n        }\n        return true;\n      case MatchStyle.SUPERSET:\n        for (const change of Object.values(diff.resources.changes)) {\n          if (change.changeImpact !== cfnDiff.ResourceImpact.WILL_CREATE) { return false; }\n        }\n\n        for (const change of Object.values(diff.parameters.changes)) {\n          if (!change.isAddition) { return false; }\n        }\n\n        for (const change of Object.values(diff.outputs.changes)) {\n          if (!change.isAddition) { return false; }\n        }\n\n        return true;\n    }\n  }\n\n  public get description(): string {\n    return `template (${this.matchStyle}): ${JSON.stringify(this.template, null, 2)}`;\n  }\n}\n"]}