feat(harness): add dry run support to harness and drop outputs when stack run is in dry run mode (#380)

Author: floreks

go.mod

@@ -35,7 +35,7 @@ require (
 	github.com/opencost/opencost/core v0.0.0-20241216191657-30e5d9a27f41
 	github.com/orcaman/concurrent-map/v2 v2.0.1
 	github.com/pkg/errors v0.9.1
-	github.com/pluralsh/console/go/client v1.31.0
+	github.com/pluralsh/console/go/client v1.32.0
 	github.com/pluralsh/controller-reconcile-helper v0.1.0
 	github.com/pluralsh/gophoenix v0.1.3-0.20231201014135-dff1b4309e34
 	github.com/pluralsh/polly v0.1.10

go.sum

@@ -1736,8 +1736,8 @@ github.com/pkg/sftp v1.10.1/go.mod h1:lYOWFsE0bwd1+KfKJaKeuokY15vzFx25BLbzYYoAxZ
 github.com/pkg/sftp v1.13.1/go.mod h1:3HaPG6Dq1ILlpPZRO0HVMrsydcdLt6HRDccSgb87qRg=
 github.com/planetscale/vtprotobuf v0.6.1-0.20240319094008-0393e58bdf10 h1:GFCKgmp0tecUJ0sJuv4pzYCqS9+RGSn52M3FUwPs+uo=
 github.com/planetscale/vtprotobuf v0.6.1-0.20240319094008-0393e58bdf10/go.mod h1:t/avpk3KcrXxUnYOhZhMXJlSEyie6gQbtLq5NM3loB8=
-github.com/pluralsh/console/go/client v1.31.0 h1:rmuPcJdJQetg5c0n7rv1cyd0l107vsGqEKBrt2oatKw=
-github.com/pluralsh/console/go/client v1.31.0/go.mod h1:ZDRhjfDzbFLrHCfP3k6SaLlTDcjALCL8KIKQCYIHSJM=
+github.com/pluralsh/console/go/client v1.32.0 h1:V/VoiohHmhdwmPxQBDoF167yoau8jGWV+sxXV90dCgk=
+github.com/pluralsh/console/go/client v1.32.0/go.mod h1:ZDRhjfDzbFLrHCfP3k6SaLlTDcjALCL8KIKQCYIHSJM=
 github.com/pluralsh/controller-reconcile-helper v0.1.0 h1:BV3dYZFH5rn8ZvZjtpkACSv/GmLEtRftNQj/Y4ddHEo=
 github.com/pluralsh/controller-reconcile-helper v0.1.0/go.mod h1:RxAbvSB4/jkvx616krCdNQXPbpGJXW3J1L3rASxeFOA=
 github.com/pluralsh/gophoenix v0.1.3-0.20231201014135-dff1b4309e34 h1:ab2PN+6if/Aq3/sJM0AVdy1SYuMAnq4g20VaKhTm/Bw=

pkg/harness/controller/controller.go

@@ -150,30 +150,34 @@ func (in *stackRunController) completeStackRun(status gqlclient.StackStatus, sta
 	var output []*gqlclient.StackOutputAttributes
 	var err error
 
-	if in.tool != nil {
-		state, err = in.tool.State()
-		if err != nil {
-			klog.ErrorS(err, "could not prepare state attributes")
-		}
+	serviceErrorAttributes := make([]*gqlclient.ServiceErrorAttributes, 0)
+	if stackRunErr != nil {
+		serviceErrorAttributes = append(serviceErrorAttributes, &gqlclient.ServiceErrorAttributes{
+			Source:  "harness",
+			Message: stackRunErr.Error(),
+		})
+	}
 
-		klog.V(log.LogLevelTrace).InfoS("generated console state", "state", state)
+	if in.tool == nil {
+		return stackrun.CompleteStackRun(in.consoleClient, in.stackRunID, &gqlclient.StackRunAttributes{
+			Errors: serviceErrorAttributes,
+		})
+	}
 
+	state, err = in.tool.State()
+	if err != nil {
+		klog.ErrorS(err, "could not prepare state attributes")
+	}
+	klog.V(log.LogLevelTrace).InfoS("generated console state", "state", state)
+
+	if !in.stackRun.DryRun {
 		output, err = in.tool.Output()
 		if err != nil {
 			klog.ErrorS(err, "could not prepare output attributes")
 		}
-
 		klog.V(log.LogLevelTrace).InfoS("generated console output", "output", output)
 	}
 
-	serviceErrorAttributes := make([]*gqlclient.ServiceErrorAttributes, 0)
-	if stackRunErr != nil {
-		serviceErrorAttributes = append(serviceErrorAttributes, &gqlclient.ServiceErrorAttributes{
-			Source:  "harness",
-			Message: stackRunErr.Error(),
-		})
-	}
-
 	return stackrun.CompleteStackRun(in.consoleClient, in.stackRunID, &gqlclient.StackRunAttributes{
 		Errors: serviceErrorAttributes,
 		Output: output,

pkg/harness/stackrun/v1/types.go

@@ -11,21 +11,27 @@ import (
 )
 
 type StackRun struct {
-	ID           string
+	ID      string
+	Tarball string
+
+	ExecWorkDir *string
+	ApprovedAt  *string
+
+	Approval    bool
+	ManageState bool
+	DryRun      bool
+
+	Variables map[string]interface{}
+
 	Status       gqlclient.StackStatus
 	Type         gqlclient.StackType
-	Tarball      string
-	Steps        []*gqlclient.RunStepFragment
-	Files        []*gqlclient.StackFileFragment
-	Environment  []*gqlclient.StackEnvironmentFragment
-	ExecWorkDir  *string
-	Approval     bool
-	ApprovedAt   *string
-	ManageState  bool
 	Creds        *gqlclient.StackRunBaseFragment_PluralCreds
 	StateUrls    *gqlclient.StackRunBaseFragment_StateUrls
-	Variables    map[string]interface{}
 	PolicyEngine *gqlclient.PolicyEngineFragment
+
+	Steps       []*gqlclient.RunStepFragment
+	Files       []*gqlclient.StackFileFragment
+	Environment []*gqlclient.StackEnvironmentFragment
 }
 
 func (in *StackRun) MaxSeverity() int {
@@ -53,6 +59,7 @@ func (in *StackRun) FromStackRunBaseFragment(fragment *gqlclient.StackRunBaseFra
 		StateUrls:    fragment.StateUrls,
 		Variables:    fragment.Variables,
 		PolicyEngine: fragment.PolicyEngine,
+		DryRun:       fragment.DryRun,
 	}
 }