如何提升CDK快照测试鲁棒性，降低对栈属性顺序的敏感度？

问题场景 #

使用CDK编写快照测试时，每次更新aws-cdk-lib依赖后，生成的快照总会和现有快照不匹配，核心原因是资源内部属性的序列化顺序非确定性——部分资源属性按字母序排列，但另一些则随机变化，导致快照对比失败。

原测试代码：

test("LoadBalancer Stack Snapshot", () => {
  expect(
    YAML.stringify(Template.fromStack(stack), null, {
      singleQuote: true,
    })
  ).toMatchSnapshot();
});

已尝试的方案 #

曾在YAML.stringify中添加sortMapEntries: true参数，但仅对模板顶层的Outputs、Parameters、Resources等属性生效，无法处理资源内部的嵌套属性排序。

修改后的代码：

test("LoadBalancer Stack Snapshot", () => {
  expect(
    YAML.stringify(Template.fromStack(stack), null, {
      sortMapEntries: true,
      singleQuote: true,
    })
  ).toMatchSnapshot();
});

可行解决方案 #

要让快照测试更鲁棒，需要对所有层级的属性进行深度排序，消除序列化顺序的不确定性。以下是两种实现方式：

方式1：自定义深度排序函数（单测试用例适配） #

编写递归函数遍历模板的所有嵌套对象，对每个对象的键按字母序排序，再进行序列化：

// 递归深度排序所有对象属性
function deepSort(obj) {
  if (Array.isArray(obj)) {
    return obj.map(deepSort);
  } else if (obj !== null && typeof obj === 'object') {
    return Object.keys(obj).sort().reduce((sortedObj, key) => {
      sortedObj[key] = deepSort(obj[key]);
      return sortedObj;
    }, {});
  }
  return obj;
}

// 修改后的测试代码
test("LoadBalancer Stack Snapshot", () => {
  // 将CDK模板转为JSON对象后深度排序
  const sortedTemplate = deepSort(Template.fromStack(stack).toJSON());
  // 序列化并生成快照
  expect(YAML.stringify(sortedTemplate, null, { singleQuote: true })).toMatchSnapshot();
});

方式2：自定义Jest快照序列化器（全局适配） #

如果多个测试用例都需要处理这个问题，可以自定义Jest序列化器，统一处理CDK模板的深度排序：

1. 在项目根目录创建cdk-template-serializer.js：

const YAML = require('yaml');

function deepSort(obj) {
  if (Array.isArray(obj)) {
    return obj.map(deepSort);
  } else if (obj !== null && typeof obj === 'object') {
    return Object.keys(obj).sort().reduce((sortedObj, key) => {
      sortedObj[key] = deepSort(obj[key]);
      return sortedObj;
    }, {});
  }
  return obj;
}

module.exports = {
  // 判断是否需要使用该序列化器
  test(val) {
    return typeof val === 'object' && val !== null && (val.Resources || val.Outputs || val.Parameters);
  },
  // 序列化逻辑
  print(val) {
    const sortedTemplate = deepSort(val);
    return YAML.stringify(sortedTemplate, null, { singleQuote: true });
  },
};

2. 在jest.config.js中配置该序列化器：

module.exports = {
  snapshotSerializers: ['<rootDir>/cdk-template-serializer.js'],
};

3. 测试代码简化为：

test("LoadBalancer Stack Snapshot", () => {
  expect(Template.fromStack(stack).toJSON()).toMatchSnapshot();
});

原理说明 #

通过深度排序，强制所有层级的对象键按字母序排列，无论CDK合成时的属性顺序如何变化，最终序列化后的内容结构一致，从而避免依赖更新导致的快照不匹配问题。

内容的提问来源于stack exchange，提问作者Gerry Kovan