From 646445d4acf4e10ab030a1e62f6b6bb894deba4e Mon Sep 17 00:00:00 2001
From: Phil Renaud <phil.renaud@hashicorp.com>
Date: Mon, 4 Dec 2023 13:40:00 -0500
Subject: [PATCH] [ui] example job with actions (#19153)

* An example job with a few interesting actions

* A pretty different example job

* Tests updated with const'd number of default templates

* Removed default jobspec params and formatted
---
 .changelog/19153.txt                  |   3 +
 ui/app/utils/default-job-templates.js |  15 ++++
 ui/app/utils/default_jobs/actions.js  | 125 ++++++++++++++++++++++++++
 ui/tests/acceptance/job-run-test.js   |  18 +++-
 4 files changed, 157 insertions(+), 4 deletions(-)
 create mode 100644 .changelog/19153.txt
 create mode 100644 ui/app/utils/default_jobs/actions.js

diff --git a/.changelog/19153.txt b/.changelog/19153.txt
new file mode 100644
index 000000000..6c9da374e
--- /dev/null
+++ b/.changelog/19153.txt
@@ -0,0 +1,3 @@
+```release-note:improvement
+ui: Added a new example template with Task Actions
+```
diff --git a/ui/app/utils/default-job-templates.js b/ui/app/utils/default-job-templates.js
index 1d89de7cc..02d18ab97 100644
--- a/ui/app/utils/default-job-templates.js
+++ b/ui/app/utils/default-job-templates.js
@@ -7,6 +7,7 @@ import helloWorld from './default_jobs/hello-world';
 import parameterized from './default_jobs/parameterized';
 import serviceDiscovery from './default_jobs/service-discovery';
 import variables from './default_jobs/variables';
+import actions from './default_jobs/actions';
 
 export default [
   {
@@ -22,6 +23,20 @@ export default [
       },
     ],
   },
+  {
+    id: 'nomad/job-templates/default/actions',
+    keyValues: [
+      {
+        key: 'template',
+        value: actions,
+      },
+      {
+        key: 'description',
+        value:
+          'Nomad Actions let job authors describe commands that can be run in one click from the UI or one command from the CLI. This example job shows how to use them to simulate development on a Redis instance.',
+      },
+    ],
+  },
   {
     id: 'nomad/job-templates/default/parameterized-job',
     keyValues: [
diff --git a/ui/app/utils/default_jobs/actions.js b/ui/app/utils/default_jobs/actions.js
new file mode 100644
index 000000000..cd65feab8
--- /dev/null
+++ b/ui/app/utils/default_jobs/actions.js
@@ -0,0 +1,125 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: BUSL-1.1
+ */
+
+export default `job "redis-actions" {
+
+  group "cache" {
+    network {
+      port "db" {}
+    }
+
+    task "redis" {
+      driver = "docker"
+
+      config {
+        image   = "redis:7"
+        ports   = ["db"]
+        command = "/bin/sh"
+        args    = ["-c", "redis-server --port \${NOMAD_PORT_db} & /local/db_log.sh"]
+      }
+
+      template {
+        data        = <<EOF
+          #!/bin/sh
+          while true; do
+            echo "$(date): Current DB Size: $(redis-cli -p \${NOMAD_PORT_db} DBSIZE)"
+            sleep 3
+          done
+EOF
+        destination = "local/db_log.sh"
+        perms       = "0755"
+      }
+
+      resources {
+        cpu    = 128
+        memory = 128
+      }
+
+      service {
+        name     = "redis-service"
+        port     = "db"
+        provider = "nomad"
+
+        check {
+          name     = "alive"
+          type     = "tcp"
+          port     = "db"
+          interval = "10s"
+          timeout  = "2s"
+        }
+      }
+
+      # Adds a random key/value to the Redis database
+      action "add-random-key" {
+        command = "/bin/sh"
+        args    = ["-c", "key=$(head /dev/urandom | tr -dc A-Za-z0-9 | head -c 13); value=$(head /dev/urandom | tr -dc A-Za-z0-9 | head -c 13); redis-cli -p \${NOMAD_PORT_db} SET $key $value; echo Key $key added with value $value"]
+      }
+
+      # Adds a random key/value with a "temp_" prefix to the Redis database
+      action "add-random-temporary-key" {
+        command = "/bin/sh"
+        args    = ["-c", "key=temp_$(head /dev/urandom | tr -dc A-Za-z0-9 | head -c 13); value=$(head /dev/urandom | tr -dc A-Za-z0-9 | head -c 13); redis-cli -p \${NOMAD_PORT_db} SET $key $value; echo Key $key added with value $value"]
+      }
+
+      # Lists all keys currently stored in the Redis database.
+      action "list-keys" {
+        command = "/bin/sh"
+        args    = ["-c", "redis-cli -p \${NOMAD_PORT_db} KEYS '*'"]
+      }
+
+      # Retrieves various stats about the Redis server
+      action "get-redis-stats" {
+        command = "/bin/sh"
+        args    = ["-c", "redis-cli -p \${NOMAD_PORT_db} INFO"]
+      }
+
+      # Performs a latency check of the Redis server.
+      # This action is a non-terminating action, meaning it will run indefinitely until it is stopped.
+      # Pass a signal interruption (Ctrl-C) to stop the action.
+      action "health-check" {
+        command = "/bin/sh"
+        args    = ["-c", "redis-cli -p \${NOMAD_PORT_db} --latency"]
+      }
+
+      # Deletes all keys with a 'temp_' prefix
+      action "flush-temp-keys" {
+        command = "/bin/sh"
+        args    = ["-c", <<EOF
+          keys_to_delete=$(redis-cli -p \${NOMAD_PORT_db} --scan --pattern 'temp_*')
+          if [ -n "$keys_to_delete" ]; then
+            # Count the number of keys to delete
+            deleted_count=$(echo "$keys_to_delete" | wc -l)
+            # Execute the delete command
+            echo "$keys_to_delete" | xargs redis-cli -p \${NOMAD_PORT_db} DEL
+          else
+            deleted_count=0
+          fi
+          remaining_keys=$(redis-cli -p \${NOMAD_PORT_db} DBSIZE)
+          echo "$deleted_count temporary keys removed; $remaining_keys keys remaining in database"
+EOF
+        ]
+      }
+
+      # Toggles saving to disk (RDB persistence). When enabled, allocation logs will indicate a save every 60 seconds.
+      action "toggle-save-to-disk" {
+        command = "/bin/sh"
+        args    = ["-c", <<EOF
+          current_config=$(redis-cli -p \${NOMAD_PORT_db} CONFIG GET save | awk 'NR==2');
+          if [ -z "$current_config" ]; then
+            # Enable saving to disk (example: save after 60 seconds if at least 1 key changed)
+            redis-cli -p \${NOMAD_PORT_db} CONFIG SET save "60 1";
+            echo "Saving to disk enabled: 60 seconds interval if at least 1 key changed";
+          else
+            # Disable saving to disk
+            redis-cli -p \${NOMAD_PORT_db} CONFIG SET save "";
+            echo "Saving to disk disabled";
+          fi;
+EOF
+        ]
+      }
+    }
+  }
+}
+`;
diff --git a/ui/tests/acceptance/job-run-test.js b/ui/tests/acceptance/job-run-test.js
index 97d021c12..09391a36f 100644
--- a/ui/tests/acceptance/job-run-test.js
+++ b/ui/tests/acceptance/job-run-test.js
@@ -29,6 +29,8 @@ const newJobName = 'new-job';
 const newJobTaskGroupName = 'redis';
 const newJobNamespace = 'default';
 
+const NUMBER_OF_DEFAULT_TEMPLATES = 5;
+
 let managementToken, clientToken;
 
 const jsonJob = (overrides) => {
@@ -245,7 +247,10 @@ module('Acceptance | job run', function (hooks) {
       // Assert
       assert
         .dom('[data-test-template-card]')
-        .exists({ count: 4 }, 'A list of default job templates is rendered.');
+        .exists(
+          { count: NUMBER_OF_DEFAULT_TEMPLATES },
+          'A list of default job templates is rendered.'
+        );
 
       await click('[data-test-create-new-button]');
       assert.equal(currentRouteName(), 'jobs.run.templates.new');
@@ -331,7 +336,10 @@ module('Acceptance | job run', function (hooks) {
       // Assert
       assert
         .dom('[data-test-template-card]')
-        .exists({ count: 4 }, 'A list of default job templates is rendered.');
+        .exists(
+          { count: NUMBER_OF_DEFAULT_TEMPLATES },
+          'A list of default job templates is rendered.'
+        );
 
       await click('[data-test-create-new-button]');
       assert.equal(currentRouteName(), 'jobs.run.templates.new');
@@ -380,7 +388,10 @@ module('Acceptance | job run', function (hooks) {
       // Assert
       assert
         .dom('[data-test-template-card]')
-        .exists({ count: 4 }, 'A list of default job templates is rendered.');
+        .exists(
+          { count: NUMBER_OF_DEFAULT_TEMPLATES },
+          'A list of default job templates is rendered.'
+        );
 
       await click('[data-test-create-new-button]');
       assert.equal(currentRouteName(), 'jobs.run.templates.new');
@@ -576,7 +587,6 @@ module('Acceptance | job run', function (hooks) {
 
     test('default templates', async function (assert) {
       assert.expect(4);
-      const NUMBER_OF_DEFAULT_TEMPLATES = 4;
 
       await visit('/jobs/run/templates');