closes aws-actions#135

exolink · Sep 20, 2023 · d7c1251 · d7c1251
1 parent b70251e
commit d7c1251
Show file tree

Hide file tree

Showing 3 changed files with 72 additions and 2 deletions.
diff --git a/action.yml b/action.yml
@@ -22,6 +22,9 @@ inputs:
   log-configuration-options:
     description: "Create/Override options inside logConfiguration. Each variable is of the form key=value, you can specify multiple variables with multi-line YAML strings."
     required: false
+#  tags:
+#    description: "Tags to add to the task definition. Each Tag is of the form KEY=value, you can specify multiple key–value pairs with multi-line YAML strings."
+#    required: false
 outputs:
   task-definition:
     description: 'The path to the rendered task definition file'

diff --git a/index.js b/index.js
@@ -11,6 +11,7 @@ async function run() {
     const imageURI = core.getInput('image', { required: true });
 
     const environmentVariables = core.getInput('environment-variables', { required: false });
+    const tags = core.getInput('tags', {required: false});
 
     const logConfigurationLogDriver = core.getInput("log-configuration-log-driver", { required: false });
     const logConfigurationOptions = core.getInput("log-configuration-options", { required: false });
@@ -73,6 +74,43 @@ async function run() {
       })
     }
 
+    if (tags) {
+
+      // If tags array is missing, create it
+      if (!Array.isArray(containerDef.tags)) {
+        containerDef.tags = [];
+      }
+
+      // Get pairs by splitting on newlines
+      tags.split('\n').forEach(function (line) {
+        // Trim whitespace
+        const trimmedLine = line.trim();
+        // Skip if empty
+        if (trimmedLine.length === 0) { return; }
+        // Split on =
+        const separatorIdx = trimmedLine.indexOf("=");
+        // If there's nowhere to split
+        if (separatorIdx === -1) {
+          throw new Error(`Cannot parse the tag '${trimmedLine}'. Tag key–value pairs must be of the form KEY=value.`);
+        }
+        // Build object
+        const tag = {
+          key: trimmedLine.substring(0, separatorIdx),
+          value: trimmedLine.substring(separatorIdx + 1),
+        };
+
+        // Search container definition tags for one matching name
+        const tagDef = containerDef.tags.find((e) => e.key == tag.key);
+        if (tagDef) {
+          // If found, update
+          tagDef.value = tag.value;
+        } else {
+          // Else, create
+          containerDef.tags.push(tag);
+        }
+      })
+    }
+
     if (logConfigurationLogDriver) {
       if (!containerDef.logConfiguration) { containerDef.logConfiguration = {} }
       const validDrivers = ["json-file", "syslog", "journald", "logentries", "gelf", "fluentd", "awslogs", "splunk", "awsfirelens"];

diff --git a/index.test.js b/index.test.js
@@ -27,7 +27,8 @@ describe('Render task definition', () => {
             .mockReturnValueOnce('task-definition.json') // task-definition
             .mockReturnValueOnce('web')                  // container-name
             .mockReturnValueOnce('nginx:latest')         // image
-            .mockReturnValueOnce('FOO=bar\nHELLO=world'); // environment-variables
+            .mockReturnValueOnce('FOO=bar\nHELLO=world') // environment-variables
+            .mockReturnValueOnce('tag=value\nanother=tag'); // tags
 
         process.env = Object.assign(process.env, { GITHUB_WORKSPACE: __dirname });
         process.env = Object.assign(process.env, { RUNNER_TEMP: '/home/runner/work/_temp' });
@@ -92,6 +93,16 @@ describe('Render task definition', () => {
                                 name: "HELLO",
                                 value: "world"
                             }
+                        ],
+                        tags: [
+                            {
+                                key: "tag",
+                                value: "value"
+                            },
+                            {
+                                key: "another",
+                                value: "tag"
+                            }
                         ]
                     },
                     {
@@ -110,7 +121,8 @@ describe('Render task definition', () => {
             .mockReturnValueOnce('/hello/task-definition.json') // task-definition
             .mockReturnValueOnce('web')                  // container-name
             .mockReturnValueOnce('nginx:latest')         // image
-            .mockReturnValueOnce('EXAMPLE=here');        // environment-variables
+            .mockReturnValueOnce('EXAMPLE=here')        // environment-variables
+            .mockReturnValueOnce('tag=value');          // tags
         jest.mock('/hello/task-definition.json', () => ({
             family: 'task-def-family',
             containerDefinitions: [
@@ -142,6 +154,12 @@ describe('Render task definition', () => {
                                 name: "EXAMPLE",
                                 value: "here"
                             }
+                        ],
+                        tags: [
+                            {
+                                key: "tag",
+                                value: "value"
+                            }
                         ]
                     }
                 ]
@@ -157,6 +175,7 @@ describe('Render task definition', () => {
             .mockReturnValueOnce('web')
             .mockReturnValueOnce('nginx:latest')
             .mockReturnValueOnce('FOO=bar\nHELLO=world')
+            .mockReturnValueOnce('tag=value\nanother=tag')
             .mockReturnValueOnce('awslogs')
             .mockReturnValueOnce(`awslogs-create-group=true\nawslogs-group=/ecs/web\nawslogs-region=us-east-1\nawslogs-stream-prefix=ecs`);
 
@@ -192,6 +211,16 @@ describe('Render task definition', () => {
                                 value: "world"
                             }
                         ],
+                        tags: [
+                            {
+                                key: "tag",
+                                value: "value"
+                            },
+                            {
+                                key: "another",
+                                value: "tag"
+                            }
+                        ],
                         logConfiguration: {
                             logDriver: "awslogs",
                             options: {