Support custom diff commands

Author: yolken-segment

cmd/kubeapply/subcmd/diff.go

@@ -223,6 +223,7 @@ func execDiff(
 		ctx,
 		clusterConfig.AbsSubpaths(),
 		clusterConfig.ServerSideApply,
+		"",
 	)
 	return results, "", err
 }

pkg/cluster/client.go

@@ -29,7 +29,15 @@ type ClusterClient interface {
 
 	// Diff gets the diffs between the configs at the given path and the actual state of resources
 	// in the cluster.
-	DiffStructured(ctx context.Context, paths []string, serverSide bool) ([]diff.Result, error)
+	//
+	// The diffCommand argument can be set to use a custom diff command in place of the default
+	// (kubeapply kdiff).
+	DiffStructured(
+		ctx context.Context,
+		paths []string,
+		serverSide bool,
+		diffCommand string,
+	) ([]diff.Result, error)
 
 	// Summary returns a summary of all workloads in the cluster.
 	Summary(ctx context.Context) (string, error)

pkg/cluster/fake_client.go

@@ -103,6 +103,7 @@ func (cc *FakeClusterClient) DiffStructured(
 	ctx context.Context,
 	paths []string,
 	serverSide bool,
+	diffCommand string,
 ) ([]diff.Result, error) {
 	return []diff.Result{
 			{

pkg/cluster/kube/ordered_client.go

@@ -10,6 +10,7 @@ import (
 	"os/exec"
 	"path/filepath"
 	"regexp"
+	"strings"
 
 	"github.com/briandowns/spinner"
 	"github.com/segmentio/kubeapply/data"
@@ -18,8 +19,22 @@ import (
 )
 
 const (
-	structuredDiffScript = "kdiff-wrapper.sh"
-	rawDiffScript        = "raw-diff.sh"
+	rawDiffScript = `#!/bin/bash
+
+diff -u -N $1 $2
+
+# Ensure that we only exit with non-zero status is there was a real error
+if [[ $? -gt 1 ]]; then
+    exit 1
+fi`
+
+	structuredDiffScript = `#!/bin/bash
+
+# This is used as the custom differ for kubectl diff. We need a wrapper script instead
+# of calling 'kubeapply kdiff' directly because kubectl wants a single executable (without
+# any subcommands or arguments).
+
+kubeapply kdiff $1 $2`
 )
 
 // TODO: Switch to a YAML library that supports doing this splitting for us.
@@ -149,10 +164,9 @@ func (k *OrderedClient) Diff(
 	ctx context.Context,
 	configPaths []string,
 	structured bool,
+	diffCommand string,
 	spinner *spinner.Spinner,
 ) ([]byte, error) {
-	var diffCmd string
-
 	tempDir, err := ioutil.TempDir("", "diff")
 	if err != nil {
 		return nil, err
@@ -184,18 +198,36 @@ func (k *OrderedClient) Diff(
 	}
 
 	envVars := []string{}
-	var diffScript string
+	var diffScriptBody string
 
 	if structured {
-		diffScript = structuredDiffScript
+		if diffCommand == "" {
+			diffScriptBody = structuredDiffScript
+		} else {
+			diffScriptBody = strings.Replace(
+				structuredDiffScript,
+				"kubeapply kdiff",
+				diffCommand,
+				-1,
+			)
+		}
 	} else {
-		diffScript = rawDiffScript
+		if diffCommand == "" {
+			diffScriptBody = rawDiffScript
+		} else {
+			diffScriptBody = strings.Replace(
+				rawDiffScript,
+				"diff",
+				diffCommand,
+				-1,
+			)
+		}
 	}
 
-	diffCmd = filepath.Join(tempDir, diffScript)
+	kubectlDiffCmd := filepath.Join(tempDir, "diff.sh")
 	err = ioutil.WriteFile(
-		diffCmd,
-		data.MustAsset(fmt.Sprintf("scripts/%s", diffScript)),
+		kubectlDiffCmd,
+		[]byte(diffScriptBody),
 		0755,
 	)
 	if err != nil {
@@ -204,7 +236,7 @@ func (k *OrderedClient) Diff(
 
 	envVars = append(
 		envVars,
-		fmt.Sprintf("KUBECTL_EXTERNAL_DIFF=%s", diffCmd),
+		fmt.Sprintf("KUBECTL_EXTERNAL_DIFF=%s", kubectlDiffCmd),
 	)
 
 	return runKubectlOutput(

pkg/cluster/kube_client.go

@@ -211,7 +211,7 @@ func (cc *KubeClusterClient) Diff(
 	paths []string,
 	serverSide bool,
 ) ([]byte, error) {
-	rawResults, err := cc.execDiff(ctx, paths, false)
+	rawResults, err := cc.execDiff(ctx, paths, false, "")
 	if err != nil {
 		return nil, fmt.Errorf(
 			"Error running diff: %+v (output: %s)",
@@ -229,8 +229,9 @@ func (cc *KubeClusterClient) DiffStructured(
 	ctx context.Context,
 	paths []string,
 	serverSide bool,
+	diffCommand string,
 ) ([]diff.Result, error) {
-	rawResults, err := cc.execDiff(ctx, paths, true)
+	rawResults, err := cc.execDiff(ctx, paths, true, diffCommand)
 	if err != nil {
 		return nil, fmt.Errorf(
 			"Error running diff: %+v (output: %s)",
@@ -351,6 +352,7 @@ func (cc *KubeClusterClient) execDiff(
 	ctx context.Context,
 	paths []string,
 	structured bool,
+	diffCommand string,
 ) ([]byte, error) {
 	if cc.useLocks {
 		acquireCtx, cancel := context.WithTimeout(ctx, lockAcquistionTimeout)
@@ -378,6 +380,7 @@ func (cc *KubeClusterClient) execDiff(
 		ctx,
 		paths,
 		structured,
+		diffCommand,
 		cc.spinnerObj,
 	)
 	if err != nil || !cc.checkApplyConsistency {

pkg/events/handler.go

@@ -578,6 +578,7 @@ func (whh *WebhookHandler) runDiffs(
 			diffCtx,
 			clusterClient.Config().AbsSubpaths(),
 			clusterClient.Config().ServerSideApply,
+			"",
 		)
 		if err != nil {
 			diffErr = fmt.Errorf(