feat: sort keys of ApiObject manifests (#67)

Fixes #17 Using [`json-stable-stringify`](https://github.com/substack/json-stable-stringify) to sort output alphabetically and recursively. Signed-off-by: campionfellin <[email protected]>
cdk8s-team · Mar 12, 2020 · 1fe89bd · 1fe89bd
1 parent 7b1d613
commit 1fe89bd
Show file tree

Hide file tree

Showing 8 changed files with 313 additions and 248 deletions.
diff --git a/package.json b/package.json
@@ -16,7 +16,9 @@
     ],
     "nohoist": [
       "cdk8s/yaml",
-      "cdk8s/yaml/**"
+      "cdk8s/yaml/**",
+      "cdk8s/json-stable-stringify",
+      "cdk8s/json-stable-stringify/**"
     ]
   },
   "devDependencies": {

diff --git a/packages/cdk8s/lib/api-object.ts b/packages/cdk8s/lib/api-object.ts
@@ -2,6 +2,7 @@ import { Construct } from '@aws-cdk/core';
 import { Chart } from './chart';
 import { removeEmpty } from './_util';
 import { resolve } from './_tokens';
+import * as stringify from 'json-stable-stringify';
 
 /**
  * Metadata associated with this object.
@@ -121,7 +122,7 @@ export class ApiObject extends Construct {
 
     // convert to "pure data" so, for example, when we convert to yaml these
     // references are not converted to anchors.
-    return JSON.parse(JSON.stringify(removeEmpty(resolve(this, data))));
+    return JSON.parse(stringify(removeEmpty(resolve(this, data))));
   }
 }
 
diff --git a/packages/cdk8s/package.json b/packages/cdk8s/package.json
@@ -66,6 +66,7 @@
     "@aws-cdk/core": "^1.27.0",
     "@aws-cdk/cx-api": "^1.27.0",
     "@types/jest": "^25.1.2",
+    "@types/json-stable-stringify": "^1.0.32",
     "@types/node": "13.7.1",
     "@types/yaml": "^1.2.0",
     "@typescript-eslint/eslint-plugin": "^2.20.0",
@@ -84,10 +85,12 @@
     ]
   },
   "bundledDependencies": [
-    "yaml"
+    "yaml",
+    "json-stable-stringify"
   ],
   "dependencies": {
-    "yaml": "^1.7.2"
+    "yaml": "^1.7.2",
+    "json-stable-stringify": "^1.0.1"
   },
   "peerDependencies": {
     "@aws-cdk/core": "^1.27.0",

diff --git a/packages/cdk8s/test/__snapshots__/api-object.test.js.snap b/packages/cdk8s/test/__snapshots__/api-object.test.js.snap
@@ -57,6 +57,25 @@ Array [
 ]
 `;
 
+exports[`printed yaml is alphabetical 1`] = `
+Array [
+  Object {
+    "apiVersion": "v1",
+    "kind": "MyResource",
+    "metadata": Object {
+      "name": "test-my-resource-2998ce93",
+    },
+    "spec": Object {
+      "firstProperty": "hello",
+      "secondProperty": Object {
+        "beforeThirdProperty": "world",
+        "innerThirdProperty": "!",
+      },
+    },
+  },
+]
+`;
+
 exports[`synthesized resource name is based on path 1`] = `
 Array [
   Object {

diff --git a/packages/cdk8s/test/api-object.test.ts b/packages/cdk8s/test/api-object.test.ts
@@ -13,6 +13,27 @@ test('minimal configuration', () => {
   expect(Testing.synth(stack)).toMatchSnapshot();
 });
 
+test('printed yaml is alphabetical', () => {
+  const app = Testing.app();
+  const stack = new Chart(app, 'test');
+
+  // Object keys in random order
+  new ApiObject(stack, 'my-resource', {
+    kind: 'MyResource',
+    apiVersion: 'v1',
+    spec: {
+      secondProperty: {
+        innerThirdProperty: '!',
+        beforeThirdProperty: 'world'
+      },
+      firstProperty: 'hello'
+    }
+  });
+
+  // Should match alphabetically-ordered snapshot
+  expect(Testing.synth(stack)).toMatchSnapshot();
+});
+
 test('synthesized resource name is based on path', () => {
   // GIVEN
   const app = Testing.app();

diff --git a/test/test-python-app/expected/test.k8s.yaml b/test/test-python-app/expected/test.k8s.yaml
@@ -1,10 +1,10 @@
+apiVersion: v1
+kind: Pod
+metadata:
+  name: test-pod-84164e5f
 spec:
   containers:
-    - name: hello-kubernetes
-      image: paulbouwer/hello-kubernetes:1.7
+    - image: paulbouwer/hello-kubernetes:1.7
+      name: hello-kubernetes
       ports:
         - containerPort: 8080
-kind: Pod
-apiVersion: v1
-metadata:
-  name: test-pod-84164e5f
diff --git a/test/test-typescript-app/expected/test.k8s.yaml b/test/test-typescript-app/expected/test.k8s.yaml
@@ -1,10 +1,10 @@
+apiVersion: v1
+kind: Pod
+metadata:
+  name: test-pod-84164e5f
 spec:
   containers:
-    - name: hello-kubernetes
-      image: paulbouwer/hello-kubernetes:1.7
+    - image: paulbouwer/hello-kubernetes:1.7
+      name: hello-kubernetes
       ports:
         - containerPort: 8080
-kind: Pod
-apiVersion: v1
-metadata:
-  name: test-pod-84164e5f