deprecate buildpack in favor of buildpacks on push command

Author: patrickcrocker

CHANGELOG.md

@@ -5,12 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-## 2.XX.X - Unreleased
+## 2.22.0 - Unreleased
 
 ### Added
 
-- Introduced new tests (see `spec` folder) using the [shellspec](https://shellspec.info/) BDD testing framework. The existing home-grown test framework in the `itest` folder has served this project well, but it's time to move
-- `push` command now supports to specify multiple `buildpacks`
+- Introduced new tests (see `spec` folder) using the [shellspec](https://shellspec.info/) BDD testing framework. The existing home-grown test framework in the `itest` folder has served this project well, but it's time to move on to something better. Over the upcoming releases, we'll slowly start converting more of the `itest` tests to the newer `spec` tests.
+- `push` command now supports specifying multiple `buildpacks`, thanks to a PR by [tenjaa](https://github.com/tenjaa). The original `buildpack` option is now deprecated and superceded by `buildpacks`.
 
 ### Changed
 

README.md

@@ -794,8 +794,8 @@ _NOTE_: A manifest can be used to specify values for required parameters. Any pa
 - `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 (_Optional_ if using a `manifest` that specifies the application name)
-- `buildpack`: _Optional._ Custom buildpack by name (e.g. my-buildpack) or Git URL (e.g. 'https://github.com/cloudfoundry/java-buildpack.git') or Git URL with a branch or tag (e.g. 'https://github.com/cloudfoundry/java-buildpack.git#v3.3.0' for 'v3.3.0' tag). To use built-in buildpacks only, specify 'default' or 'null'
-- `buildpacks`: _Optional._ Multiple buildpacks as an array
+- `buildpack`: _Optional._ _Deprecated_, please use `buildpacks` instead.
+- `buildpacks`: _Optional._ List of custom buildpacks by name (e.g. my-buildpack) or Git URL (e.g. 'https://github.com/cloudfoundry/java-buildpack.git') or Git URL with a branch or tag (e.g. 'https://github.com/cloudfoundry/java-buildpack.git#v3.3.0' for 'v3.3.0' tag). To use built-in buildpacks only, specify 'default' or 'null'
 - `disk_quota`: _Optional._ Disk limit (e.g. 256M, 1024M, 1G)
 - `docker_image`: _Optional._ Docker-image to be used (e.g. user/docker-image-name)
 - `docker_username`: _Optional._ This is used as the username to authenticate against a protected docker registry
@@ -833,7 +833,8 @@ _NOTE_: Enable these by specifying `cf_cli_version: 7` in the resource `source`
     app_name: myapp-ui
     memory: 1G
     path: path/to/myapp-*.jar
-    buildpack: java_buildpack
+    buildpacks:
+      - java_buildpack
     manifest: path/to/manifest.yml
     vars:
       instances: 3

itest/run-app-push-tests

@@ -315,7 +315,6 @@ it_can_push_an_app_with_multiple_buildpacks() {
   --arg org "$org" \
   --arg space "$space" \
   --arg app_name "$app_name" \
-  --arg stack "$stack" \
   --arg path "$project/content" \
   --arg manifest "$project/manifest.yml" \
   '{
@@ -325,9 +324,10 @@ it_can_push_an_app_with_multiple_buildpacks() {
     app_name: $app_name,
     path: $path,
     manifest: $manifest,
-    buildpacks:
-    - binary_buildpack
-    - staticfile_buildpack
+    buildpacks: [
+      "binary_buildpack",
+      "staticfile_buildpack"
+    ]
   }')
 
   put_with_params "$CCR_SOURCE" "$params" | jq -e '.version | keys == ["timestamp"]'
@@ -336,6 +336,40 @@ it_can_push_an_app_with_multiple_buildpacks() {
   assert::equals "binary_buildpack,staticfile_buildpack" "$(cf::get_app_buildpacks "$app_name")"
 }
 
+it_can_push_an_app_with_deprecated_buildpack_param() {
+  local org=${1:?org null or not set}
+  local space=${2:?space null or not set}
+  local app_name=${3:?app_name null or not set}
+
+  local project=$(create_static_app "$app_name", "---
+applications:
+- name: $app_name
+  memory: 64M
+  disk_quota: 64M
+  path: content")
+
+  local params=$(jq -n \
+  --arg org "$org" \
+  --arg space "$space" \
+  --arg app_name "$app_name" \
+  --arg path "$project/content" \
+  --arg manifest "$project/manifest.yml" \
+  '{
+    command: "push",
+    org: $org,
+    space: $space,
+    app_name: $app_name,
+    path: $path,
+    manifest: $manifest,
+    buildpack: "staticfile_buildpack"
+  }')
+
+  put_with_params "$CCR_SOURCE" "$params" | jq -e '.version | keys == ["timestamp"]'
+
+  assert::success cf::is_app_started "$app_name"
+  assert::equals "staticfile_buildpack" "$(cf::get_app_buildpacks "$app_name")"
+}
+
 org=$(generate_test_name_with_spaces "Org")
 space=$(generate_test_name_with_spaces "Space")
 
@@ -418,9 +452,16 @@ describe "push an app with stack"
 describe "push an app with multiple buildpacks"
 {
   app_name=$(generate_test_name_with_spaces "App")
-  stack=cflinuxfs3
 
-  run it_can_push_an_app_with_stack \"$org\" \"$space\" \"$app_name\"
+  run it_can_push_an_app_with_multiple_buildpacks \"$org\" \"$space\" \"$app_name\"
+  run it_can_delete_an_app \"$org\" \"$space\" \"$app_name\"
+}
+
+describe "push an app with deprecated buildpack param"
+{
+  app_name=$(generate_test_name_with_spaces "App")
+
+  run it_can_push_an_app_with_deprecated_buildpack_param \"$org\" \"$space\" \"$app_name\"
   run it_can_delete_an_app \"$org\" \"$space\" \"$app_name\"
 }
 

resource/commands/push.sh

@@ -1,7 +1,16 @@
+json_array_push() {
+  local array=${1:?array null or not set}
+  local value=${2:-}
+  if [ -n "$value" ]; then
+    echo "$array" | jq --arg value "$value" '. + [ $value ]'
+  else
+    echo "$array"
+  fi
+}
 
 app_name=$(get_option '.app_name')
-buildpack=$(get_option '.buildpack')
-buildpacks=$(get_option '.buildpacks')
+# backwards compatibility for deprecated 'buildpack' param (https://github.com/nulldriver/cf-cli-resource/issues/87)
+buildpacks=$(get_option '.buildpacks' "$(json_array_push '[]' "$(get_option '.buildpack')")")
 startup_command=$(get_option '.startup_command')
 docker_image=$(get_option '.docker_image')
 docker_username=$(get_option '.docker_username')
@@ -36,7 +45,6 @@ fi
 
 args=()
 [ -n "$app_name" ]        && args+=("$app_name")
-[ -n "$buildpack" ]       && args+=(-b "$buildpack")
 [ -n "$startup_command" ] && args+=(-c "$startup_command")
 [ -n "$docker_image" ]    && args+=(--docker-image "$docker_image")
 [ -n "$docker_username" ] && args+=(--docker-username "$docker_username")

resource/lib/cf-functions.sh

@@ -828,12 +828,12 @@ function cf::get_app_buildpacks() {
   local app_name=${1:?app_name null or not set}
 
   local output
-  if ! output=$(cf::curl "/v2/apps/$(cf::get_app_guid "$app_name")/droplets/current"); then
+  if ! output=$(cf::curl "/v3/apps/$(cf::get_app_guid "$app_name")"); then
     logger::error "$output"
     exit 1
   fi
 
-  echo $output | jq -r '.buildpacks | map(.name) | join(",")'
+  echo $output | jq -r '.lifecycle | select(.type == "buildpack") | .data.buildpacks | join(",")'
 }
 
 function cf::scale() {