Merge pull request #233 from guardian/aa-tag-name

refactor!: follow aws tag name convention of `org:something`
guardian · Feb 5, 2021 · 86bf433 · 86bf433
2 parents b7afa65 + 1ff1da8
commit 86bf433
Show file tree

Hide file tree

Showing 13 changed files with 110 additions and 88 deletions.
diff --git a/src/constants/__mocks__/library-info.ts b/src/constants/__mocks__/library-info.ts
@@ -3,6 +3,6 @@ export const LibraryInfo = {
 };
 
 export const TrackingTag = {
-  Key: "X-Gu-CDK-Version",
+  Key: "gu:cdk:version",
   Value: LibraryInfo.VERSION,
 };
diff --git a/src/constants/library-info.ts b/src/constants/library-info.ts
@@ -7,6 +7,6 @@ export const LibraryInfo = {
 };
 
 export const TrackingTag = {
-  Key: "X-Gu-CDK-Version",
+  Key: "gu:cdk:version",
   Value: LibraryInfo.VERSION,
 };
diff --git a/src/constructs/cloudwatch/__snapshots__/lambda-alarms.test.ts.snap b/src/constructs/cloudwatch/__snapshots__/lambda-alarms.test.ts.snap
@@ -43,6 +43,10 @@ Object {
             "Key": "App",
             "Value": "testing",
           },
+          Object {
+            "Key": "gu:cdk:version",
+            "Value": "TEST",
+          },
           Object {
             "Key": "Stack",
             "Value": Object {
@@ -55,10 +59,6 @@ Object {
               "Ref": "Stage",
             },
           },
-          Object {
-            "Key": "X-Gu-CDK-Version",
-            "Value": "TEST",
-          },
         ],
         "Timeout": 30,
       },
@@ -97,6 +97,10 @@ Object {
             "Key": "App",
             "Value": "testing",
           },
+          Object {
+            "Key": "gu:cdk:version",
+            "Value": "TEST",
+          },
           Object {
             "Key": "Stack",
             "Value": Object {
@@ -109,10 +113,6 @@ Object {
               "Ref": "Stage",
             },
           },
-          Object {
-            "Key": "X-Gu-CDK-Version",
-            "Value": "TEST",
-          },
         ],
       },
       "Type": "AWS::IAM::Role",

diff --git a/src/constructs/core/stack.test.ts b/src/constructs/core/stack.test.ts
@@ -3,7 +3,7 @@ import "@aws-cdk/assert/jest";
 import { SynthUtils } from "@aws-cdk/assert";
 import { Role, ServicePrincipal } from "@aws-cdk/aws-iam";
 import { App } from "@aws-cdk/core";
-import { simpleGuStackForTesting } from "../../../test/utils";
+import { alphabeticalTags, simpleGuStackForTesting } from "../../../test/utils";
 import type { SynthedStack } from "../../../test/utils";
 import { Stage, Stages } from "../../constants";
 import { TrackingTag } from "../../constants/library-info";
@@ -38,7 +38,7 @@ describe("The GuStack construct", () => {
     });
 
     expect(stack).toHaveResource("AWS::IAM::Role", {
-      Tags: [
+      Tags: alphabeticalTags([
         {
           Key: "App",
           Value: "MyApp",
@@ -56,7 +56,7 @@ describe("The GuStack construct", () => {
           },
         },
         TrackingTag,
-      ],
+      ]),
     });
   });
 

diff --git a/src/constructs/core/stack.ts b/src/constructs/core/stack.ts
@@ -58,12 +58,17 @@ export class GuStack extends Stack {
 
   /**
    * A helper function to add a tag to all resources in a stack.
+   *
+   * Note: tags will be listed in alphabetical order during synthesis.
+   *
    * @param key the tag name
    * @param value the value of the tag
    * @param applyToLaunchedInstances whether or not to apply the tag to instances launched in an ASG.
    * @protected
    */
   protected addTag(key: string, value: string, applyToLaunchedInstances: boolean = true): void {
+    // TODO add validation for `key` and `value`
+    //  see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html
     Tags.of(this).add(key, value, { applyToLaunchedInstances });
   }
 

diff --git a/src/constructs/iam/policies/__snapshots__/ses.test.ts.snap b/src/constructs/iam/policies/__snapshots__/ses.test.ts.snap
@@ -92,6 +92,10 @@ Object {
             "Key": "App",
             "Value": "testing",
           },
+          Object {
+            "Key": "gu:cdk:version",
+            "Value": "TEST",
+          },
           Object {
             "Key": "Stack",
             "Value": Object {
@@ -104,10 +108,6 @@ Object {
               "Ref": "Stage",
             },
           },
-          Object {
-            "Key": "X-Gu-CDK-Version",
-            "Value": "TEST",
-          },
         ],
       },
       "Type": "AWS::IAM::Role",

diff --git a/src/constructs/iam/roles/__snapshots__/instance-role.test.ts.snap b/src/constructs/iam/roles/__snapshots__/instance-role.test.ts.snap
@@ -133,6 +133,10 @@ Object {
             "Key": "App",
             "Value": "testing",
           },
+          Object {
+            "Key": "gu:cdk:version",
+            "Value": "TEST",
+          },
           Object {
             "Key": "Stack",
             "Value": Object {
@@ -145,10 +149,6 @@ Object {
               "Ref": "Stage",
             },
           },
-          Object {
-            "Key": "X-Gu-CDK-Version",
-            "Value": "TEST",
-          },
         ],
       },
       "Type": "AWS::IAM::Role",
@@ -396,6 +396,10 @@ Object {
             "Key": "App",
             "Value": "testing",
           },
+          Object {
+            "Key": "gu:cdk:version",
+            "Value": "TEST",
+          },
           Object {
             "Key": "Stack",
             "Value": Object {
@@ -408,10 +412,6 @@ Object {
               "Ref": "Stage",
             },
           },
-          Object {
-            "Key": "X-Gu-CDK-Version",
-            "Value": "TEST",
-          },
         ],
       },
       "Type": "AWS::IAM::Role",
@@ -612,6 +612,10 @@ Object {
             "Key": "App",
             "Value": "testing",
           },
+          Object {
+            "Key": "gu:cdk:version",
+            "Value": "TEST",
+          },
           Object {
             "Key": "Stack",
             "Value": Object {
@@ -624,10 +628,6 @@ Object {
               "Ref": "Stage",
             },
           },
-          Object {
-            "Key": "X-Gu-CDK-Version",
-            "Value": "TEST",
-          },
         ],
       },
       "Type": "AWS::IAM::Role",

diff --git a/src/constructs/lambda/__snapshots__/lambda.test.ts.snap b/src/constructs/lambda/__snapshots__/lambda.test.ts.snap
@@ -97,6 +97,10 @@ Object {
             "Key": "App",
             "Value": "testing",
           },
+          Object {
+            "Key": "gu:cdk:version",
+            "Value": "TEST",
+          },
           Object {
             "Key": "Stack",
             "Value": Object {
@@ -109,10 +113,6 @@ Object {
               "Ref": "Stage",
             },
           },
-          Object {
-            "Key": "X-Gu-CDK-Version",
-            "Value": "TEST",
-          },
         ],
         "Timeout": 30,
       },
@@ -151,6 +151,10 @@ Object {
             "Key": "App",
             "Value": "testing",
           },
+          Object {
+            "Key": "gu:cdk:version",
+            "Value": "TEST",
+          },
           Object {
             "Key": "Stack",
             "Value": Object {
@@ -163,10 +167,6 @@ Object {
               "Ref": "Stage",
             },
           },
-          Object {
-            "Key": "X-Gu-CDK-Version",
-            "Value": "TEST",
-          },
         ],
       },
       "Type": "AWS::IAM::Role",
@@ -230,6 +230,10 @@ Object {
             "Key": "App",
             "Value": "testing",
           },
+          Object {
+            "Key": "gu:cdk:version",
+            "Value": "TEST",
+          },
           Object {
             "Key": "Stack",
             "Value": Object {
@@ -242,10 +246,6 @@ Object {
               "Ref": "Stage",
             },
           },
-          Object {
-            "Key": "X-Gu-CDK-Version",
-            "Value": "TEST",
-          },
         ],
       },
       "Type": "AWS::ApiGateway::RestApi",
@@ -418,6 +418,10 @@ Object {
             "Key": "App",
             "Value": "testing",
           },
+          Object {
+            "Key": "gu:cdk:version",
+            "Value": "TEST",
+          },
           Object {
             "Key": "Stack",
             "Value": Object {
@@ -430,15 +434,11 @@ Object {
               "Ref": "Stage",
             },
           },
-          Object {
-            "Key": "X-Gu-CDK-Version",
-            "Value": "TEST",
-          },
         ],
       },
       "Type": "AWS::IAM::Role",
     },
-    "lambdaapi2Deployment4ECB937340ba28821c4d87686bb600192997b7b2": Object {
+    "lambdaapi2Deployment4ECB93739afe50d503afeac32f7e1b1edd2caf70": Object {
       "DependsOn": Array [
         "lambdaapi2proxyANY3F8E1D36",
         "lambdaapi2proxyE68FDFBC",
@@ -455,7 +455,7 @@ Object {
     "lambdaapi2DeploymentStageprodCC9E3016": Object {
       "Properties": Object {
         "DeploymentId": Object {
-          "Ref": "lambdaapi2Deployment4ECB937340ba28821c4d87686bb600192997b7b2",
+          "Ref": "lambdaapi2Deployment4ECB93739afe50d503afeac32f7e1b1edd2caf70",
         },
         "RestApiId": Object {
           "Ref": "lambdaapi239350ECC",
@@ -466,6 +466,10 @@ Object {
             "Key": "App",
             "Value": "testing",
           },
+          Object {
+            "Key": "gu:cdk:version",
+            "Value": "TEST",
+          },
           Object {
             "Key": "Stack",
             "Value": Object {
@@ -478,10 +482,6 @@ Object {
               "Ref": "Stage",
             },
           },
-          Object {
-            "Key": "X-Gu-CDK-Version",
-            "Value": "TEST",
-          },
         ],
       },
       "Type": "AWS::ApiGateway::Stage",
@@ -763,6 +763,10 @@ Object {
             "Key": "App",
             "Value": "testing",
           },
+          Object {
+            "Key": "gu:cdk:version",
+            "Value": "TEST",
+          },
           Object {
             "Key": "Stack",
             "Value": Object {
@@ -775,10 +779,6 @@ Object {
               "Ref": "Stage",
             },
           },
-          Object {
-            "Key": "X-Gu-CDK-Version",
-            "Value": "TEST",
-          },
         ],
       },
       "Type": "AWS::ApiGateway::RestApi",
@@ -816,6 +816,10 @@ Object {
             "Key": "App",
             "Value": "testing",
           },
+          Object {
+            "Key": "gu:cdk:version",
+            "Value": "TEST",
+          },
           Object {
             "Key": "Stack",
             "Value": Object {
@@ -828,15 +832,11 @@ Object {
               "Ref": "Stage",
             },
           },
-          Object {
-            "Key": "X-Gu-CDK-Version",
-            "Value": "TEST",
-          },
         ],
       },
       "Type": "AWS::IAM::Role",
     },
-    "lambdaapiDeployment8E95B58515e203156872c143be11756a3c89fbba": Object {
+    "lambdaapiDeployment8E95B5854a7d40530a7080bd25491376ccd199af": Object {
       "DependsOn": Array [
         "lambdaapiproxyANYA94E968A",
         "lambdaapiproxyB573C729",
@@ -853,7 +853,7 @@ Object {
     "lambdaapiDeploymentStageprod9598BC2F": Object {
       "Properties": Object {
         "DeploymentId": Object {
-          "Ref": "lambdaapiDeployment8E95B58515e203156872c143be11756a3c89fbba",
+          "Ref": "lambdaapiDeployment8E95B5854a7d40530a7080bd25491376ccd199af",
         },
         "RestApiId": Object {
           "Ref": "lambdaapiC1812993",
@@ -864,6 +864,10 @@ Object {
             "Key": "App",
             "Value": "testing",
           },
+          Object {
+            "Key": "gu:cdk:version",
+            "Value": "TEST",
+          },
           Object {
             "Key": "Stack",
             "Value": Object {
@@ -876,10 +880,6 @@ Object {
               "Ref": "Stage",
             },
           },
-          Object {
-            "Key": "X-Gu-CDK-Version",
-            "Value": "TEST",
-          },
         ],
       },
       "Type": "AWS::ApiGateway::Stage",