@aws-cdk/cloudformation-diff
Version:
Utilities to diff CDK stacks against CloudFormation templates
91 lines • 12.1 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.diffAttribute = diffAttribute;
exports.diffCondition = diffCondition;
exports.diffMapping = diffMapping;
exports.diffMetadata = diffMetadata;
exports.diffOutput = diffOutput;
exports.diffParameter = diffParameter;
exports.diffResource = diffResource;
exports.diffUnknown = diffUnknown;
const types = require("./types");
const util_1 = require("./util");
function diffAttribute(oldValue, newValue) {
return new types.Difference(_asString(oldValue), _asString(newValue));
}
function diffCondition(oldValue, newValue) {
return new types.ConditionDifference(oldValue, newValue);
}
function diffMapping(oldValue, newValue) {
return new types.MappingDifference(oldValue, newValue);
}
function diffMetadata(oldValue, newValue) {
return new types.MetadataDifference(oldValue, newValue);
}
function diffOutput(oldValue, newValue) {
return new types.OutputDifference(oldValue, newValue);
}
function diffParameter(oldValue, newValue) {
return new types.ParameterDifference(oldValue, newValue);
}
function diffResource(oldValue, newValue) {
const resourceType = {
oldType: oldValue && oldValue.Type,
newType: newValue && newValue.Type,
};
let propertyDiffs = {};
let otherDiffs = {};
if (resourceType.oldType !== undefined && resourceType.oldType === resourceType.newType) {
// Only makes sense to inspect deeper if the types stayed the same
const impl = (0, util_1.loadResourceModel)(resourceType.oldType);
propertyDiffs = (0, util_1.diffKeyedEntities)(oldValue.Properties, newValue.Properties, (oldVal, newVal, key) => _diffProperty(oldVal, newVal, key, impl));
otherDiffs = (0, util_1.diffKeyedEntities)(oldValue, newValue, _diffOther);
delete otherDiffs.Properties;
}
return new types.ResourceDifference(oldValue, newValue, {
resourceType, propertyDiffs, otherDiffs,
});
function _diffProperty(oldV, newV, key, resourceSpec) {
let changeImpact = types.ResourceImpact.NO_CHANGE;
const spec = resourceSpec?.properties?.[key];
if (spec && !(0, util_1.deepEqual)(oldV, newV)) {
switch (spec.causesReplacement) {
case 'yes':
changeImpact = types.ResourceImpact.WILL_REPLACE;
break;
case 'maybe':
changeImpact = types.ResourceImpact.MAY_REPLACE;
break;
default:
// In those cases, whatever is the current value is what we should keep
changeImpact = types.ResourceImpact.WILL_UPDATE;
}
}
return new types.PropertyDifference(oldV, newV, { changeImpact });
}
function _diffOther(oldV, newV) {
return new types.Difference(oldV, newV);
}
}
function diffUnknown(oldValue, newValue) {
return new types.Difference(oldValue, newValue);
}
/**
* Coerces a given value to +string | undefined+.
*
* @param value - the value to be coerced.
*
* @returns +undefined+ if +value+ is +null+ or +undefined+,
* +value+ if it is a +string+,
* a compact JSON representation of +value+ otherwise.
*/
function _asString(value) {
if (value == null) {
return undefined;
}
if (typeof value === 'string') {
return value;
}
return JSON.stringify(value);
}
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";;AAIA,sCAEC;AAED,sCAEC;AAED,kCAEC;AAED,oCAEC;AAED,gCAEC;AAED,sCAEC;AAED,oCA+CC;AAED,kCAEC;AA9ED,iCAAiC;AACjC,iCAAyE;AAEzE,SAAgB,aAAa,CAAC,QAAa,EAAE,QAAa;IACxD,OAAO,IAAI,KAAK,CAAC,UAAU,CAAS,SAAS,CAAC,QAAQ,CAAC,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;AAChF,CAAC;AAED,SAAgB,aAAa,CAAC,QAAyB,EAAE,QAAyB;IAChF,OAAO,IAAI,KAAK,CAAC,mBAAmB,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;AAC3D,CAAC;AAED,SAAgB,WAAW,CAAC,QAAuB,EAAE,QAAuB;IAC1E,OAAO,IAAI,KAAK,CAAC,iBAAiB,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;AACzD,CAAC;AAED,SAAgB,YAAY,CAAC,QAAwB,EAAE,QAAwB;IAC7E,OAAO,IAAI,KAAK,CAAC,kBAAkB,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;AAC1D,CAAC;AAED,SAAgB,UAAU,CAAC,QAAsB,EAAE,QAAsB;IACvE,OAAO,IAAI,KAAK,CAAC,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;AACxD,CAAC;AAED,SAAgB,aAAa,CAAC,QAAyB,EAAE,QAAyB;IAChF,OAAO,IAAI,KAAK,CAAC,mBAAmB,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;AAC3D,CAAC;AAED,SAAgB,YAAY,CAAC,QAAyB,EAAE,QAAyB;IAC/E,MAAM,YAAY,GAAG;QACnB,OAAO,EAAE,QAAQ,IAAI,QAAQ,CAAC,IAAI;QAClC,OAAO,EAAE,QAAQ,IAAI,QAAQ,CAAC,IAAI;KACnC,CAAC;IACF,IAAI,aAAa,GAAqD,EAAE,CAAC;IACzE,IAAI,UAAU,GAA6C,EAAE,CAAC;IAE9D,IAAI,YAAY,CAAC,OAAO,KAAK,SAAS,IAAI,YAAY,CAAC,OAAO,KAAK,YAAY,CAAC,OAAO,EAAE,CAAC;QACxF,kEAAkE;QAClE,MAAM,IAAI,GAAG,IAAA,wBAAiB,EAAC,YAAY,CAAC,OAAO,CAAC,CAAC;QACrD,aAAa,GAAG,IAAA,wBAAiB,EAAC,QAAS,CAAC,UAAU,EACpD,QAAS,CAAC,UAAU,EACpB,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,EAAE,CAAC,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC;QAErE,UAAU,GAAG,IAAA,wBAAiB,EAAC,QAAQ,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;QAC/D,OAAO,UAAU,CAAC,UAAU,CAAC;IAC/B,CAAC;IAED,OAAO,IAAI,KAAK,CAAC,kBAAkB,CAAC,QAAQ,EAAE,QAAQ,EAAE;QACtD,YAAY,EAAE,aAAa,EAAE,UAAU;KACxC,CAAC,CAAC;IAEH,SAAS,aAAa,CAAC,IAAS,EAAE,IAAS,EAAE,GAAW,EAAE,YAAuB;QAC/E,IAAI,YAAY,GAAG,KAAK,CAAC,cAAc,CAAC,SAAS,CAAC;QAElD,MAAM,IAAI,GAAG,YAAY,EAAE,UAAU,EAAE,CAAC,GAAG,CAAC,CAAC;QAC7C,IAAI,IAAI,IAAI,CAAC,IAAA,gBAAS,EAAC,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC;YACnC,QAAQ,IAAI,CAAC,iBAAiB,EAAE,CAAC;gBAC/B,KAAK,KAAK;oBACR,YAAY,GAAG,KAAK,CAAC,cAAc,CAAC,YAAY,CAAC;oBACjD,MAAM;gBACR,KAAK,OAAO;oBACV,YAAY,GAAG,KAAK,CAAC,cAAc,CAAC,WAAW,CAAC;oBAChD,MAAM;gBACR;oBACE,uEAAuE;oBACvE,YAAY,GAAG,KAAK,CAAC,cAAc,CAAC,WAAW,CAAC;YACpD,CAAC;QACH,CAAC;QAED,OAAO,IAAI,KAAK,CAAC,kBAAkB,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,YAAY,EAAE,CAAC,CAAC;IACpE,CAAC;IAED,SAAS,UAAU,CAAC,IAAS,EAAE,IAAS;QACtC,OAAO,IAAI,KAAK,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAC1C,CAAC;AACH,CAAC;AAED,SAAgB,WAAW,CAAC,QAAa,EAAE,QAAa;IACtD,OAAO,IAAI,KAAK,CAAC,UAAU,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;AAClD,CAAC;AAED;;;;;;;;GAQG;AACH,SAAS,SAAS,CAAC,KAAU;IAC3B,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;QAClB,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,KAAe,CAAC;IACzB,CAAC;IACD,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;AAC/B,CAAC","sourcesContent":["import type { Resource } from '@aws-cdk/service-spec-types';\nimport * as types from './types';\nimport { deepEqual, diffKeyedEntities, loadResourceModel } from './util';\n\nexport function diffAttribute(oldValue: any, newValue: any): types.Difference<string> {\n  return new types.Difference<string>(_asString(oldValue), _asString(newValue));\n}\n\nexport function diffCondition(oldValue: types.Condition, newValue: types.Condition): types.ConditionDifference {\n  return new types.ConditionDifference(oldValue, newValue);\n}\n\nexport function diffMapping(oldValue: types.Mapping, newValue: types.Mapping): types.MappingDifference {\n  return new types.MappingDifference(oldValue, newValue);\n}\n\nexport function diffMetadata(oldValue: types.Metadata, newValue: types.Metadata): types.MetadataDifference {\n  return new types.MetadataDifference(oldValue, newValue);\n}\n\nexport function diffOutput(oldValue: types.Output, newValue: types.Output): types.OutputDifference {\n  return new types.OutputDifference(oldValue, newValue);\n}\n\nexport function diffParameter(oldValue: types.Parameter, newValue: types.Parameter): types.ParameterDifference {\n  return new types.ParameterDifference(oldValue, newValue);\n}\n\nexport function diffResource(oldValue?: types.Resource, newValue?: types.Resource): types.ResourceDifference {\n  const resourceType = {\n    oldType: oldValue && oldValue.Type,\n    newType: newValue && newValue.Type,\n  };\n  let propertyDiffs: { [key: string]: types.PropertyDifference<any> } = {};\n  let otherDiffs: { [key: string]: types.Difference<any> } = {};\n\n  if (resourceType.oldType !== undefined && resourceType.oldType === resourceType.newType) {\n    // Only makes sense to inspect deeper if the types stayed the same\n    const impl = loadResourceModel(resourceType.oldType);\n    propertyDiffs = diffKeyedEntities(oldValue!.Properties,\n      newValue!.Properties,\n      (oldVal, newVal, key) => _diffProperty(oldVal, newVal, key, impl));\n\n    otherDiffs = diffKeyedEntities(oldValue, newValue, _diffOther);\n    delete otherDiffs.Properties;\n  }\n\n  return new types.ResourceDifference(oldValue, newValue, {\n    resourceType, propertyDiffs, otherDiffs,\n  });\n\n  function _diffProperty(oldV: any, newV: any, key: string, resourceSpec?: Resource) {\n    let changeImpact = types.ResourceImpact.NO_CHANGE;\n\n    const spec = resourceSpec?.properties?.[key];\n    if (spec && !deepEqual(oldV, newV)) {\n      switch (spec.causesReplacement) {\n        case 'yes':\n          changeImpact = types.ResourceImpact.WILL_REPLACE;\n          break;\n        case 'maybe':\n          changeImpact = types.ResourceImpact.MAY_REPLACE;\n          break;\n        default:\n          // In those cases, whatever is the current value is what we should keep\n          changeImpact = types.ResourceImpact.WILL_UPDATE;\n      }\n    }\n\n    return new types.PropertyDifference(oldV, newV, { changeImpact });\n  }\n\n  function _diffOther(oldV: any, newV: any) {\n    return new types.Difference(oldV, newV);\n  }\n}\n\nexport function diffUnknown(oldValue: any, newValue: any): types.Difference<any> {\n  return new types.Difference(oldValue, newValue);\n}\n\n/**\n * Coerces a given value to +string | undefined+.\n *\n * @param value - the value to be coerced.\n *\n * @returns +undefined+ if +value+ is +null+ or +undefined+,\n *      +value+ if it is a +string+,\n *      a compact JSON representation of +value+ otherwise.\n */\nfunction _asString(value: any): string | undefined {\n  if (value == null) {\n    return undefined;\n  }\n  if (typeof value === 'string') {\n    return value as string;\n  }\n  return JSON.stringify(value);\n}\n"]}