learned to run-task

Author: patrickcrocker

CHANGELOG.md

@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - `delete-domain` command - Delete a domain
 - `map-route` command - Add a url route to an app
 - `unmap-route` command - Remove a url route from an app
+- `run-task` command - Run a one-off task on an app
 
 ### Changed
 - Updated to cf cli v6.35.2

README.md

@@ -611,6 +611,30 @@ Delete an app
       delete_mapped_routes: true
 ```
 
+#### run-task
+
+Run a one-off task on an app
+
+* `org`: *Optional.* The organization to target (required if not set in the source config)
+* `space`: *Optional.* The space to target (required if not set in the source config)
+* `app_name`: *Required.* The name of the application
+* `task_command`: *Required.* The command to run for the task
+* `task_name`: *Optional.* Name to give the task (generated if omitted)
+* `memory`: *Optional.* Memory limit (e.g. 256M, 1024M, 1G)
+* `disk_quota`: *Optional.* Disk limit (e.g. 256M, 1024M, 1G)
+
+```yml
+  - put: cf-run-task
+    resource: cf-env
+    params:
+      command: run-task
+      app_name: myapp-ui
+      task_command: "bundle exec rake db:migrate"
+      task_name: migrate
+      memory: 256M
+      disk_quota: 1G
+```
+
 #### scale
 
 Change or view the instance count, disk space limit, and memory limit for an app

assets/cf-functions.sh

@@ -435,6 +435,28 @@ function cf_delete() {
   fi
 }
 
+function cf_run_task() {
+  local app_name=${1:?app_name null or not set}
+  local task_command=${2:?task_command null or not set}
+  local task_name=${3:-}
+  local memory=${4:-}
+  local disk_quota=${5:-}
+
+  local args=("$app_name" "$task_command")
+  [ -n "$task_name" ] && args+=(--name "$task_name")
+  [ -n "$memory" ] && args+=(-m "$memory")
+  [ -n "$disk_quota" ] && args+=(-k "$disk_quota")
+
+  cf run-task "${args[@]}"
+}
+
+# very loose match on some "task name" (or command...) in the cf tasks output
+function cf_was_task_run() {
+  local app_name=${1:?app_name null or not set}
+  local task_name=${2:?task_name null or not set}
+  CF_TRACE=false cf tasks "$app_name" | grep "$task_name" >/dev/null
+}
+
 function cf_is_app_started() {
   local app_name=${1:?app_name null or not set}
   local guid=$(cf_get_app_guid "$app_name")

assets/out

@@ -266,6 +266,15 @@ echo "$params" | jq -c '.commands[]' | while read -r options; do
     printf '\e[92m[INFO]\e[0m Executing \e[33m%s\e[0m: %s\n' "$command" "$app_name"
     cf_target "$org" "$space"
     cf_start "$app_name" "$staging_timeout" "$startup_timeout"
+  elif [ "run-task" = "$command" ]; then
+    app_name=$(echo $options | jq -r '.app_name //empty')
+    task_command=$(echo $options | jq -r '.task_command //empty')
+    task_name=$(echo $options | jq -r '.task_name //empty')
+    memory=$(echo $options | jq -r '.memory //empty')
+    disk_quota=$(echo $options | jq -r '.disk_quota //empty')
+    printf '\e[92m[INFO]\e[0m Executing \e[33m%s\e[0m: %s\n' "$command" "$app_name"
+    cf_target "$org" "$space"
+    cf_run_task "$app_name" "$task_command" "$task_name" "$memory" "$disk_quota"
   elif [ "scale" = "$command" ]; then
     app_name=$(echo $options | jq -r '.app_name //empty')
     instances=$(echo $options | jq -r '.instances //empty')

itest/put.sh

@@ -488,6 +488,118 @@ it_can_zero_downtime_push() {
   cf_is_app_started "$app_name"
 }
 
+it_can_run_a_task_with_disk_quota() {
+  local working_dir=$(mktemp -d $TMPDIR/put-src.XXXXXX)
+
+  local params=$(jq -n \
+  --arg org "$org" \
+  --arg space "$space" \
+  --arg app_name "$app_name" \
+  --arg task_command "echo run-task-with-disk_quota-test" \
+  --arg disk_quota "756M" \
+  '{
+    command: "run-task",
+    org: $org,
+    space: $space,
+    app_name: $app_name,
+    task_command: $task_command,
+    disk_quota: $disk_quota
+  }')
+
+  local config=$(echo $source | jq --argjson params "$params" '.params = $params')
+
+  put_with_params "$config" "$working_dir" | jq -e '
+    .version | keys == ["timestamp"]
+  '
+
+  cf_was_task_run "$app_name" "run-task-with-disk_quota-test"
+}
+
+it_can_run_a_task_with_memory() {
+  local working_dir=$(mktemp -d $TMPDIR/put-src.XXXXXX)
+
+  local params=$(jq -n \
+  --arg org "$org" \
+  --arg space "$space" \
+  --arg app_name "$app_name" \
+  --arg task_command "echo run-task-with-memory-test" \
+  --arg memory "512M" \
+  '{
+    command: "run-task",
+    org: $org,
+    space: $space,
+    app_name: $app_name,
+    task_command: $task_command,
+    memory: $memory
+  }')
+
+  local config=$(echo $source | jq --argjson params "$params" '.params = $params')
+
+  put_with_params "$config" "$working_dir" | jq -e '
+    .version | keys == ["timestamp"]
+  '
+
+  cf_was_task_run "$app_name" "run-task-with-memory-test"
+}
+
+it_can_run_a_task_with_name() {
+  local working_dir=$(mktemp -d $TMPDIR/put-src.XXXXXX)
+
+  local params=$(jq -n \
+  --arg org "$org" \
+  --arg space "$space" \
+  --arg app_name "$app_name" \
+  --arg task_command "echo run-task-with-name-test" \
+  --arg task_name "run-task-with-name-test" \
+  '{
+    command: "run-task",
+    org: $org,
+    space: $space,
+    app_name: $app_name,
+    task_command: $task_command,
+    task_name: $task_name
+  }')
+
+  local config=$(echo $source | jq --argjson params "$params" '.params = $params')
+
+  put_with_params "$config" "$working_dir" | jq -e '
+    .version | keys == ["timestamp"]
+  '
+
+  cf_was_task_run "$app_name" "run-task-with-name-test"
+}
+
+it_can_run_a_task() {
+  local working_dir=$(mktemp -d $TMPDIR/put-src.XXXXXX)
+
+  local params=$(jq -n \
+  --arg org "$org" \
+  --arg space "$space" \
+  --arg app_name "$app_name" \
+  --arg task_command "echo run-task-test-all" \
+  --arg task_name "run-task-test-all" \
+  --arg memory "512M" \
+  --arg disk_quota "756M" \
+  '{
+    command: "run-task",
+    org: $org,
+    space: $space,
+    app_name: $app_name,
+    task_command: $task_command,
+    task_name: $task_name,
+    memory: $memory,
+    disk_quota: $disk_quota
+  }')
+
+  local config=$(echo $source | jq --argjson params "$params" '.params = $params')
+
+  put_with_params "$config" "$working_dir" | jq -e '
+    .version | keys == ["timestamp"]
+  '
+
+  cf_was_task_run "$app_name" "run-task-test-all"
+}
+
 it_can_scale_an_app_instances() {
   local working_dir=$(mktemp -d $TMPDIR/put-src.XXXXXX)
 
@@ -1327,6 +1439,11 @@ run it_can_bind_an_asynchronous_service
 run it_can_start_an_app
 run it_can_zero_downtime_push
 
+run it_can_run_a_task_with_disk_quota
+run it_can_run_a_task_with_memory
+run it_can_run_a_task_with_name
+run it_can_run_a_task
+
 run it_can_scale_an_app_instances
 run it_can_scale_an_app_disk_quota
 run it_can_scale_an_app_memory