refactor: add initial support for builder plugins

A builder plugin implements some method for 'building' artifacts from a given source code archive. This refactor moves the majority of the image building code into separate plugins, allowing us to implement other builders, but also simplifying the common pugin codebase. Also move the pre-build-buildpack hook from the build-env plugin to builder-herokuish.
2019-07-30 14:29:48 -04:00
parent af8ade0a09
commit 0a8d5eb744
15 changed files with 209 additions and 124 deletions
--- a/plugins/builder-herokuish/builder-build
+++ b/plugins/builder-herokuish/builder-build
@@ -0,0 +1,50 @@
+#!/usr/bin/env bash
+set -eo pipefail
+[[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_AVAILABLE_PATH/config/functions"
+
+trigger-builder-build-builder-herokuish() {
+  declare desc="builder-herokuish builder-build plugin trigger"
+  declare trigger="trigger-builder-build-builder-herokuish"
+  declare BUILDER_TYPE="$1" APP="$2" SOURCECODE_WORK_DIR="$3"
+
+  if [[ "$BUILDER_TYPE" != "herokuish" ]]; then
+    return
+  fi
+
+  local IMAGE=$(get_app_image_name "$APP")
+  local DOKKU_APP_CACHE_DIR="$DOKKU_ROOT/$APP/cache"
+  local DOKKU_APP_HOST_CACHE_DIR="$DOKKU_HOST_ROOT/$APP/cache"
+  local DOCKER_COMMIT_LABEL_ARGS=("--change" "LABEL org.label-schema.schema-version=1.0" "--change" "LABEL org.label-schema.vendor=dokku" "--change" "LABEL com.dokku.app-name=$APP")
+  local DOCKER_RUN_LABEL_ARGS="--label=com.dokku.app-name=$APP"
+  local CID
+
+  pushd "$SOURCECODE_WORK_DIR" &>/dev/null
+
+  eval "$(config_export app "$APP")"
+
+  DOKKU_IMAGE="$(config_get "$APP" DOKKU_IMAGE || echo "$DOKKU_IMAGE")"
+  CID=$(tar -c . | "$DOCKER_BIN" run "${DOCKER_RUN_LABEL_ARGS[@]}" $DOKKU_GLOBAL_RUN_ARGS -i -a stdin "$DOKKU_IMAGE" /bin/bash -c "mkdir -p /app && tar -xC /app")
+  test "$("$DOCKER_BIN" wait "$CID")" -eq 0
+
+  "$DOCKER_BIN" commit "${DOCKER_COMMIT_LABEL_ARGS[@]}" "$CID" "$IMAGE" >/dev/null
+  [[ -d $DOKKU_APP_CACHE_DIR ]] || mkdir -p "$DOKKU_APP_CACHE_DIR"
+  plugn trigger pre-build-buildpack "$APP"
+
+  local DOCKER_ARGS=$(: | plugn trigger docker-args-build "$APP" "$BUILDER_TYPE")
+  [[ "$DOKKU_TRACE" ]] && DOCKER_ARGS+=" -e TRACE=true "
+  DOCKER_ARGS+=$(: | plugn trigger docker-args-process-build "$APP" "$IMAGE_TAG" "$BUILDER_TYPE")
+
+  declare -a ARG_ARRAY
+  eval "ARG_ARRAY=($DOCKER_ARGS)"
+  # shellcheck disable=SC2086
+  CID=$("$DOCKER_BIN" run "${DOCKER_RUN_LABEL_ARGS[@]}" $DOKKU_GLOBAL_RUN_ARGS -d -v $DOKKU_APP_HOST_CACHE_DIR:/cache -e CACHE_PATH=/cache "${ARG_ARRAY[@]}" $IMAGE /build)
+  "$DOCKER_BIN" attach "$CID"
+  test "$("$DOCKER_BIN" wait "$CID")" -eq 0
+
+  "$DOCKER_BIN" commit "${DOCKER_COMMIT_LABEL_ARGS[@]}" "$CID" "$IMAGE" >/dev/null
+
+  plugn trigger post-build-buildpack "$APP"
+}
+
+trigger-builder-build-builder-herokuish "$@"
--- a/plugins/builder-herokuish/builder-release
+++ b/plugins/builder-herokuish/builder-release
@@ -0,0 +1,36 @@
+#!/usr/bin/env bash
+set -eo pipefail
+[[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_AVAILABLE_PATH/config/functions"
+
+trigger-builder-release-builder-herokuish() {
+  declare desc="builder-herokuish builder-release plugin trigger"
+  declare trigger="trigger-builder-release-builder-herokuish"
+  declare BUILDER_TYPE="$1" APP="$2" IMAGE_TAG="$3"
+
+  if [[ "$BUILDER_TYPE" != "herokuish" ]]; then
+    return
+  fi
+
+  local CID
+  local IMAGE=$(get_app_image_name "$APP" "$IMAGE_TAG")
+  local DOCKER_COMMIT_LABEL_ARGS=("--change" "LABEL org.label-schema.schema-version=1.0" "--change" "LABEL org.label-schema.vendor=dokku" "--change" "LABEL com.dokku.app-name=$APP")
+  local DOCKER_RUN_LABEL_ARGS="--label=com.dokku.app-name=$APP"
+
+  plugn trigger pre-release-buildpack "$APP" "$IMAGE_TAG"
+  if [[ -n $(config_export global) ]]; then
+    CID=$(config_export global | "$DOCKER_BIN" run "${DOCKER_RUN_LABEL_ARGS[@]}" $DOKKU_GLOBAL_RUN_ARGS -i -a stdin "$IMAGE" /bin/bash -c "mkdir -p /app/.profile.d && cat > /app/.profile.d/00-global-env.sh")
+    test "$("$DOCKER_BIN" wait "$CID")" -eq 0
+
+    "$DOCKER_BIN" commit "${DOCKER_COMMIT_LABEL_ARGS[@]}" "$CID" "$IMAGE" >/dev/null
+  fi
+  if [[ -n $(config_export app "$APP") ]]; then
+    CID=$(config_export app "$APP" | "$DOCKER_BIN" run "${DOCKER_RUN_LABEL_ARGS[@]}" $DOKKU_GLOBAL_RUN_ARGS -i -a stdin "$IMAGE" /bin/bash -c "mkdir -p /app/.profile.d && cat > /app/.profile.d/01-app-env.sh")
+    test "$("$DOCKER_BIN" wait "$CID")" -eq 0
+
+    "$DOCKER_BIN" commit "${DOCKER_COMMIT_LABEL_ARGS[@]}" "$CID" "$IMAGE" >/dev/null
+  fi
+  plugn trigger post-release-buildpack "$APP" "$IMAGE_TAG"
+}
+
+trigger-builder-release-builder-herokuish "$@"
--- a/plugins/builder-herokuish/docker-args-build
+++ b/plugins/builder-herokuish/docker-args-build
@@ -0,0 +1,28 @@
+#!/usr/bin/env bash
+set -eo pipefail
+[[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_AVAILABLE_PATH/config/functions"
+
+trigger-docker-args-builder-herokuish() {
+  declare desc="builder-herokuish docker-args plugin trigger"
+  declare trigger="trigger-docker-args-builder-herokuish"
+  local APP="$1"
+  local STDIN
+  local DOKKU_APP_TYPE
+  local DOKKU_APP_USER
+
+  STDIN=$(cat)
+  DOKKU_APP_TYPE=$(config_get "$APP" DOKKU_APP_TYPE || true)
+  DOKKU_APP_USER=$(config_get "$APP" DOKKU_APP_USER || true)
+  DOKKU_APP_USER=${DOKKU_APP_USER:="herokuishuser"}
+
+  if [[ "$DOKKU_APP_TYPE" == "herokuish" ]]; then
+    local docker_args="$STDIN --env=USER=${DOKKU_APP_USER}"
+  else
+    local docker_args="$STDIN"
+  fi
+
+  echo -n "$docker_args"
+}
+
+trigger-docker-args-builder-herokuish "$@"
--- a/plugins/builder-herokuish/docker-args-deploy
+++ b/plugins/builder-herokuish/docker-args-deploy
@@ -0,0 +1 @@
+docker-args-build
--- a/plugins/builder-herokuish/docker-args-run
+++ b/plugins/builder-herokuish/docker-args-run
@@ -0,0 +1 @@
+docker-args-build
--- a/plugins/builder-herokuish/plugin.toml
+++ b/plugins/builder-herokuish/plugin.toml
@@ -0,0 +1,4 @@
+[plugin]
+description = "dokku core builder-herokuish plugin"
+version = "0.17.9"
+[plugin.config]
--- a/plugins/builder-herokuish/pre-build-buildpack
+++ b/plugins/builder-herokuish/pre-build-buildpack
@@ -0,0 +1,37 @@
+#!/usr/bin/env bash
+set -eo pipefail
+[[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
+source "$PLUGIN_AVAILABLE_PATH/config/functions"
+
+trigger-pre-build-buildpack-builder-herokuish() {
+  declare desc="builder-herokuish pre-build-buildpack plugin trigger"
+  declare trigger="trigger-pre-build-buildpack-builder-herokuish"
+  declare APP="$1"
+  local IMAGE CID
+
+  local DOCKER_COMMIT_LABEL_ARGS=("--change" "LABEL org.label-schema.schema-version=1.0" "--change" "LABEL org.label-schema.vendor=dokku" "--change" "LABEL com.dokku.app-name=$APP")
+  local DOCKER_RUN_LABEL_ARGS="--label=com.dokku.app-name=$APP"
+
+  verify_app_name "$APP"
+  IMAGE=$(get_app_image_name "$APP")
+
+  [[ -z $(config_get --global CURL_CONNECT_TIMEOUT) ]] && config_set --global CURL_CONNECT_TIMEOUT=90
+  [[ -z $(config_get --global CURL_TIMEOUT) ]] && config_set --global CURL_TIMEOUT=600
+
+  dokku_log_info1 "Adding BUILD_ENV to build environment..."
+  # create build env files for use in buildpacks like this:
+  # https://github.com/niteoweb/heroku-buildpack-buildout/blob/5879fa3418f7d8e079f1aa5816ba1adde73f4948/bin/compile#L34
+  CID=$(config_bundle --merged "$APP" | "$DOCKER_BIN" run "${DOCKER_RUN_LABEL_ARGS[@]}" $DOKKU_GLOBAL_RUN_ARGS -i -a stdin "$IMAGE" /bin/bash -c "mkdir -p /tmp/env; cat | tar -x -C /tmp/env")
+  test "$("$DOCKER_BIN" wait "$CID")" -eq 0
+
+  "$DOCKER_BIN" commit "${DOCKER_COMMIT_LABEL_ARGS[@]}" "$CID" "$IMAGE" >/dev/null
+
+  # create build env for 'old style' buildpacks and dokku plugins
+  CID=$(config_export app "$APP" --format envfile --merged | "$DOCKER_BIN" run "${DOCKER_RUN_LABEL_ARGS[@]}" $DOKKU_GLOBAL_RUN_ARGS -i -a stdin "$IMAGE" /bin/bash -c "cat >> /app/.env")
+  test "$("$DOCKER_BIN" wait "$CID")" -eq 0
+
+  "$DOCKER_BIN" commit "${DOCKER_COMMIT_LABEL_ARGS[@]}" "$CID" "$IMAGE" >/dev/null
+}
+
+trigger-pre-build-buildpack-builder-herokuish "$@"