Merge pull request #465 from uselagoon/build-hook-execution

rocketeerbkw · web-flow · commit e349bc3d6ce6 · 2025-10-23T12:50:11.000-05:00
feat: support for build hook entrypoints
diff --git a/Dockerfile b/Dockerfile
@@ -94,6 +94,7 @@ RUN architecture=$(case $(uname -m) in x86_64 | amd64) echo "amd64" ;; aarch64 |
 
 RUN mkdir -p /kubectl-build-deploy/git
 RUN mkdir -p /kubectl-build-deploy/lagoon
+RUN mkdir -p /kubectl-build-deploy/hooks
 
 WORKDIR /kubectl-build-deploy/git
 
diff --git a/cmd/root.go b/cmd/root.go
@@ -107,6 +107,7 @@ func init() {
 	rootCmd.AddCommand(identifyCmd)
 	rootCmd.AddCommand(validateCmd)
 	rootCmd.AddCommand(collectCmd)
+	rootCmd.AddCommand(runCmd)
 
 	rootCmd.PersistentFlags().StringP("lagoon-yml", "l", ".lagoon.yml",
 		"The .lagoon.yml file to read")
diff --git a/cmd/run_hooks.go b/cmd/run_hooks.go
@@ -0,0 +1,45 @@
+package cmd
+
+import (
+	"fmt"
+	"os"
+
+	"github.com/spf13/cobra"
+	"github.com/uselagoon/build-deploy-tool/internal/hooks"
+)
+
+var runCmd = &cobra.Command{
+	Use:     "run",
+	Aliases: []string{"r"},
+	Short:   "Run commands",
+}
+
+var runHookCmd = &cobra.Command{
+	Use:     "hooks",
+	Aliases: []string{"hook", "h"},
+	Short:   "Run build hooks",
+	Long:    "Run build hooks of specific types at entrypoints in a build",
+	Run: func(cmd *cobra.Command, args []string) {
+		hookName, err := cmd.Flags().GetString("hook-name")
+		if err != nil {
+			fmt.Printf("error reading hook-name flag: %v\n", err)
+			os.Exit(1)
+		}
+		hookDir, err := cmd.Flags().GetString("hook-directory")
+		if err != nil {
+			fmt.Printf("error reading hook-directory flag: %v\n", err)
+			os.Exit(1)
+		}
+		dir := fmt.Sprintf("/kubectl-build-deploy/hooks/%s", hookDir)
+		err = hooks.RunHooks(hookName, dir)
+		if err != nil {
+			os.Exit(1)
+		}
+	},
+}
+
+func init() {
+	runCmd.AddCommand(runHookCmd)
+	runHookCmd.Flags().StringP("hook-name", "N", "", "The name of the hooks run")
+	runHookCmd.Flags().StringP("hook-directory", "D", "", "The name of the hook directory to run")
+}
diff --git a/internal/hooks/hooks.go b/internal/hooks/hooks.go
@@ -0,0 +1,84 @@
+package hooks
+
+import (
+	"bytes"
+	"fmt"
+	"io"
+	"os"
+	"os/exec"
+	"path/filepath"
+	"time"
+)
+
+func RunHooks(hookName, hookDir string) error {
+	if _, err := os.Stat(hookDir); os.IsNotExist(err) {
+		// there are no hooks to run, so just bail
+		return nil
+	}
+	files, err := os.ReadDir(hookDir)
+	if err != nil {
+		// there was an error getting the list of files in the hookdirectory
+		// just bail to prevent issues
+		fmt.Printf("failed to read hook directory: %s", err)
+		return nil
+	}
+
+	hookCount := 0
+	for _, file := range files {
+		if file.IsDir() || !isExecutable(fmt.Sprintf("%s/%s", hookDir, file.Name())) {
+			// skip if directory or not executable
+			continue
+		}
+		hookCount++
+
+		// print the step header for build log parser
+		fmt.Printf("##############################################\nBEGIN %s - %d\n##############################################\n", hookName, hookCount)
+		st := time.Now()
+		binaryPath := filepath.Join(hookDir, file.Name())
+
+		// execute the binary and capture its error
+		// stream stdout and stderr
+		var stdBuffer bytes.Buffer
+		mw := io.MultiWriter(os.Stdout, &stdBuffer)
+		cmd := exec.Command(binaryPath)
+		cmd.Stdout = mw
+		cmd.Stderr = mw
+		err := cmd.Run()
+		exitCode := cmd.ProcessState.ExitCode()
+
+		var warning string
+		if exitCode == 1 {
+			// for 1 return the error and fail the build
+			return fmt.Errorf("hook %s %d failed with exit code %d: %v", hookName, hookCount, exitCode, err)
+		} else if exitCode > 1 {
+			// if the exit code is greater than 1, we will consider as a warning
+			// set the warning flag for the step footer
+			warning = " WithWarnings"
+			// add to the warnings counter to add to the end of the build to flag build as warning
+			f, err := os.OpenFile("/tmp/warnings", os.O_APPEND|os.O_WRONLY|os.O_CREATE, 0600)
+			if err != nil {
+				panic(err)
+			}
+			defer f.Close()
+			if _, err = f.WriteString(fmt.Sprintf("%s:%d\n", hookName, hookCount)); err != nil {
+				panic(err)
+			}
+		}
+
+		et := time.Now()
+		diff := time.Time{}.Add(et.Sub(st))
+		tz, _ := et.Zone()
+		// print the step footer for build log parser
+		fmt.Printf("##############################################\nSTEP %s - %d: Completed at %s (%s) Duration %s Elapsed %s%s\n##############################################\n", hookName, hookCount, et.Format("2006-01-02 15:04:05"), tz, diff.Format("15:04:05"), diff.Format("15:04:05"), warning)
+	}
+
+	return nil
+}
+
+func isExecutable(filename string) bool {
+	info, err := os.Stat(filename)
+	if err != nil {
+		return false
+	}
+	return (info.Mode() & 0111) != 0
+}
diff --git a/legacy/build-deploy-docker-compose.sh b/legacy/build-deploy-docker-compose.sh
@@ -215,6 +215,8 @@ function cleanupCertificates() {
   done
 }
 
+touch /tmp/warnings
+
 ##############################################
 ### PREPARATION
 ##############################################
@@ -262,11 +264,12 @@ if [ ! -z "$(featureFlag IMAGECACHE_REGISTRY)" ]; then
   [[ $last_char != "/" ]] && IMAGECACHE_REGISTRY="$IMAGECACHE_REGISTRY/"; :
 fi
 
-set +e
 currentStepEnd="$(date +"%Y-%m-%d %H:%M:%S")"
 finalizeBuildStep "${buildStartTime}" "${previousStepEnd}" "${currentStepEnd}" "${NAMESPACE}" "initialSetup" "Initial Environment Setup" "false"
+build-deploy-tool run hooks --hook-name "Pre .lagoon.yml Validation" --hook-directory "pre-lagoon-yaml-validation"
 previousStepEnd=${currentStepEnd}
 
+set +e
 # Validate `lagoon.yml` first to try detect any errors here first
 beginBuildStep ".lagoon.yml Validation" "lagoonYmlValidation"
 ##############################################
@@ -324,6 +327,9 @@ fi
 
 currentStepEnd="$(date +"%Y-%m-%d %H:%M:%S")"
 finalizeBuildStep "${buildStartTime}" "${previousStepEnd}" "${currentStepEnd}" "${NAMESPACE}" "lagoonYmlValidation" ".lagoon.yml Validation" "false"
+set -e
+build-deploy-tool run hooks --hook-name "Pre Docker Compose Validation" --hook-directory "pre-docker-compose-validation"
+set +e
 previousStepEnd=${currentStepEnd}
 
 # The attempt to valid the `docker-compose.yaml` file
@@ -452,11 +458,9 @@ if [[ "$DOCKER_COMPOSE_WARNING_COUNT" -gt 0 ]]; then
   echo "##############################################"
   currentStepEnd="$(date +"%Y-%m-%d %H:%M:%S")"
   finalizeBuildStep "${buildStartTime}" "${previousStepEnd}" "${currentStepEnd}" "${NAMESPACE}" "dockerComposeValidationWarning" "Docker Compose Validation" "true"
-  previousStepEnd=${currentStepEnd}
 else
   currentStepEnd="$(date +"%Y-%m-%d %H:%M:%S")"
   finalizeBuildStep "${buildStartTime}" "${previousStepEnd}" "${currentStepEnd}" "${NAMESPACE}" "dockerComposeValidation" "Docker Compose Validation" "false"
-  previousStepEnd=${currentStepEnd}
 fi
 set -e
 
@@ -480,6 +484,8 @@ else
 fi
 ##################
 
+build-deploy-tool run hooks --hook-name "Pre Configure Variables" --hook-directory "pre-configure-variables"
+previousStepEnd=${currentStepEnd}
 beginBuildStep "Configure Variables" "configuringVariables"
 
 ##############################################
@@ -641,6 +647,7 @@ LAGOON_POSTROLLOUT_DISABLED=$(apiEnvVarCheck LAGOON_POSTROLLOUT_DISABLED "false"
 
 currentStepEnd="$(date +"%Y-%m-%d %H:%M:%S")"
 finalizeBuildStep "${buildStartTime}" "${buildStartTime}" "${currentStepEnd}" "${NAMESPACE}" "configureVars" "Configure Variables" "false"
+build-deploy-tool run hooks --hook-name "Pre Container Registry Login" --hook-directory "pre-registry-login"
 previousStepEnd=${currentStepEnd}
 beginBuildStep "Container Registry Login" "registryLogin"
 
@@ -1006,6 +1013,7 @@ fi
 # set that the image build and push phase has ended
 IMAGE_BUILD_PUSH_COMPLETE="true"
 
+build-deploy-tool run hooks --hook-name "Pre Service Configuration Phase" --hook-directory "pre-service-configuration-phase"
 previousStepEnd=${currentStepEnd}
 beginBuildStep "Service Configuration Phase" "serviceConfigurationPhase"
 
@@ -1097,6 +1105,7 @@ fi
 
 currentStepEnd="$(date +"%Y-%m-%d %H:%M:%S")"
 finalizeBuildStep "${buildStartTime}" "${previousStepEnd}" "${currentStepEnd}" "${NAMESPACE}" "serviceConfigurationComplete" "Service Configuration Phase" "false"
+build-deploy-tool run hooks --hook-name "Pre Route Configuration" --hook-directory "pre-route-configuration"
 previousStepEnd=${currentStepEnd}
 beginBuildStep "Route/Ingress Configuration" "configuringRoutes"
 
@@ -1124,6 +1133,7 @@ fi
 
 currentStepEnd="$(date +"%Y-%m-%d %H:%M:%S")"
 finalizeBuildStep "${buildStartTime}" "${previousStepEnd}" "${currentStepEnd}" "${NAMESPACE}" "configuringRoutesComplete" "Route/Ingress Configuration" "false"
+build-deploy-tool run hooks --hook-name "Pre Route Cleanup" --hook-directory "pre-route-cleanup"
 previousStepEnd=${currentStepEnd}
 beginBuildStep "Route/Ingress Cleanup" "cleanupRoutes"
 
@@ -1231,6 +1241,7 @@ if [ "${CURRENT_CHALLENGE_ROUTES[@]}" != "" ]; then
   currentStepEnd="$(date +"%Y-%m-%d %H:%M:%S")"
   finalizeBuildStep "${buildStartTime}" "${previousStepEnd}" "${currentStepEnd}" "${NAMESPACE}" "staleChallengesComplete" "Route/Ingress Certificate Challenges" "true"
 fi
+build-deploy-tool run hooks --hook-name "Pre Update Secrets" --hook-directory "pre-update-secrets"
 previousStepEnd=${currentStepEnd}
 beginBuildStep "Update Environment Secrets" "updateEnvSecrets"
 
@@ -1508,6 +1519,7 @@ LAGOONPLATFORMENV_SHA=$(kubectl --insecure-skip-tls-verify -n ${NAMESPACE} get s
 CONFIG_MAP_SHA=$(echo $LAGOONENV_SHA$LAGOONPLATFORMENV_SHA | sha256sum | awk '{print $1}')
 export CONFIG_MAP_SHA
 
+build-deploy-tool run hooks --hook-name "Pre Backup Configuration" --hook-directory "pre-backup-configuration"
 previousStepEnd=${currentStepEnd}
 beginBuildStep "Backup Configuration" "configuringBackups"
 
@@ -1562,6 +1574,7 @@ fi
 
 currentStepEnd="$(date +"%Y-%m-%d %H:%M:%S")"
 finalizeBuildStep "${buildStartTime}" "${previousStepEnd}" "${currentStepEnd}" "${NAMESPACE}" "backupConfigurationComplete" "Backup Configuration" "false"
+build-deploy-tool run hooks --hook-name "Pre Pre-Rollout Tasks" --hook-directory "pre-pre-rollout"
 previousStepEnd=${currentStepEnd}
 beginBuildStep "Pre-Rollout Tasks" "runningPreRolloutTasks"
 
@@ -1578,6 +1591,7 @@ else
 fi
 
 currentStepEnd="$(date +"%Y-%m-%d %H:%M:%S")"
+build-deploy-tool run hooks --hook-name "Pre Deployment Templating" --hook-directory "pre-deployment-templating"
 previousStepEnd=${currentStepEnd}
 beginBuildStep "Deployment Templating" "templatingDeployments"
 
@@ -1617,6 +1631,7 @@ build-deploy-tool template lagoon-services --saved-templates-path ${LAGOON_SERVI
 
 currentStepEnd="$(date +"%Y-%m-%d %H:%M:%S")"
 finalizeBuildStep "${buildStartTime}" "${previousStepEnd}" "${currentStepEnd}" "${NAMESPACE}" "deploymentTemplatingComplete" "Deployment Templating" "false"
+build-deploy-tool run hooks --hook-name "Pre Applying Deployments" --hook-directory "pre-applying-deployments"
 previousStepEnd=${currentStepEnd}
 beginBuildStep "Applying Deployments" "applyingDeployments"
 
@@ -1683,6 +1698,7 @@ fi
 
 currentStepEnd="$(date +"%Y-%m-%d %H:%M:%S")"
 finalizeBuildStep "${buildStartTime}" "${previousStepEnd}" "${currentStepEnd}" "${NAMESPACE}" "deploymentApplyComplete" "Applying Deployments" "false"
+build-deploy-tool run hooks --hook-name "Pre Cronjob Cleanup" --hook-directory "pre-cronjob-cleanup"
 previousStepEnd=${currentStepEnd}
 beginBuildStep "Cronjob Cleanup" "cleaningUpCronjobs"
 
@@ -1716,6 +1732,7 @@ done
 
 currentStepEnd="$(date +"%Y-%m-%d %H:%M:%S")"
 finalizeBuildStep "${buildStartTime}" "${previousStepEnd}" "${currentStepEnd}" "${NAMESPACE}" "cronjobCleanupComplete" "Cronjob Cleanup" "false"
+build-deploy-tool run hooks --hook-name "Pre Post-Rollout Tasks" --hook-directory "pre-post-rollout"
 previousStepEnd=${currentStepEnd}
 beginBuildStep "Post-Rollout Tasks" "runningPostRolloutTasks"
 
@@ -1733,6 +1750,7 @@ else
 fi
 
 currentStepEnd="$(date +"%Y-%m-%d %H:%M:%S")"
+build-deploy-tool run hooks --hook-name "Pre Finalizing Build" --hook-directory "pre-finalizing-build"
 previousStepEnd=${currentStepEnd}
 beginBuildStep "Build and Deploy" "finalizingBuild"
 
@@ -1803,6 +1821,8 @@ if [ "$(featureFlag INSIGHTS)" = enabled ]; then
 
 fi
 
+EXTRA_WARNINGS=$(cat /tmp/warnings | wc -l)
+BUILD_WARNING_COUNT=$((BUILD_WARNING_COUNT + EXTRA_WARNINGS))
 if [[ "$BUILD_WARNING_COUNT" -gt 0 ]]; then
   beginBuildStep "Completed With Warnings" "deployCompletedWithWarnings"
   echo "This build completed with ${BUILD_WARNING_COUNT} warnings, you should scan the build for warnings and correct them as necessary"
diff --git a/legacy/build-deploy.sh b/legacy/build-deploy.sh
@@ -9,6 +9,8 @@ echo "##############################################"
 
 NAMESPACE=$(cat /var/run/secrets/kubernetes.io/serviceaccount/namespace)
 LAGOON_VERSION=$(cat /lagoon/version)
+export NAMESPACE
+export LAGOON_VERSION
 
 echo -e "##############################################\nBEGIN Checkout Repository\n##############################################"
 if [ "$BUILD_TYPE" == "pullrequest" ]; then
