Jordan/gcp debug pulumi (#1403)

* s/DebugPulumi/DebugPulumiNodeJS/g

* setup DebugPulumiGolang

* use DebugPulumiGolang for gcp cd

* DEFANG_PULUMI_DIR is required to DebugPulumiNodeJS

* wip

* feat: add ErrLocalPulumiStopped to avoid debugger

---------

Co-authored-by: Jordan Stephens <[email protected]>

Author: lionello

src/cmd/cli/command/compose.go

@@ -224,7 +224,7 @@ func handleComposeUpErr(ctx context.Context, err error, project *compose.Project
 		printDefangHint("To start a new project, do:", "new")
 	}
 
-	if nonInteractive {
+	if nonInteractive || errors.Is(err, byoc.ErrLocalPulumiStopped) {
 		return err
 	}
 

src/pkg/cli/client/byoc/aws/byoc.go

@@ -430,7 +430,7 @@ func (b *ByocAws) runCdCommand(ctx context.Context, cmd cdCmd) (ecs.TaskArn, err
 	}
 	env["DEFANG_MODE"] = strings.ToLower(cmd.mode.String())
 
-	if term.DoDebug() || os.Getenv("DEFANG_PULUMI_DIR") != "" {
+	if os.Getenv("DEFANG_PULUMI_DIR") != "" {
 		// Convert the environment to a human-readable array of KEY=VALUE strings for debugging
 		debugEnv := []string{"AWS_REGION=" + b.driver.Region.String()}
 		if awsProfile := os.Getenv("AWS_PROFILE"); awsProfile != "" {
@@ -439,7 +439,7 @@ func (b *ByocAws) runCdCommand(ctx context.Context, cmd cdCmd) (ecs.TaskArn, err
 		for k, v := range env {
 			debugEnv = append(debugEnv, k+"="+v)
 		}
-		if err := byoc.DebugPulumi(ctx, debugEnv, cmd.cmd...); err != nil {
+		if err := byoc.DebugPulumiNodeJS(ctx, debugEnv, cmd.cmd...); err != nil {
 			return nil, err
 		}
 	}

src/pkg/cli/client/byoc/common.go

@@ -5,6 +5,7 @@ import (
 	"errors"
 	"os"
 	"os/exec"
+	"path"
 	"strings"
 
 	"github.com/DefangLabs/defang/src/pkg"
@@ -19,6 +20,7 @@ const (
 var (
 	DefangPrefix           = pkg.Getenv("DEFANG_PREFIX", "Defang") // prefix for all resources created by Defang
 	DefangPulumiBackend    = os.Getenv("DEFANG_PULUMI_BACKEND")
+	ErrLocalPulumiStopped  = errors.New("local pulumi command succeeded; stopping")
 	PulumiConfigPassphrase = pkg.Getenv("PULUMI_CONFIG_PASSPHRASE", "asdf")
 )
 
@@ -44,6 +46,7 @@ func GetPulumiBackend(stateUrl string) (string, string, error) {
 }
 
 func runLocalCommand(ctx context.Context, dir string, env []string, cmd ...string) error {
+	term.Debug("Running local command `", cmd, "` in dir ", dir)
 	// TODO - use enums to define commands instead of passing strings down from the caller
 	// #nosec G204
 	command := exec.CommandContext(ctx, cmd[0], cmd[1:]...)
@@ -54,7 +57,7 @@ func runLocalCommand(ctx context.Context, dir string, env []string, cmd ...strin
 	return command.Run()
 }
 
-func DebugPulumi(ctx context.Context, env []string, cmd ...string) error {
+func DebugPulumiNodeJS(ctx context.Context, env []string, cmd ...string) error {
 	// Locally we use the "dev" script from package.json to run Pulumi commands, which uses ts-node
 	localCmd := append([]string{"npm", "run", "dev"}, cmd...)
 	term.Debug(strings.Join(append(env, localCmd...), " "))
@@ -73,7 +76,35 @@ func DebugPulumi(ctx context.Context, env []string, cmd ...string) error {
 		return err
 	}
 	// We always return an error to stop the CLI from "tailing" the cloud logs
-	return errors.New("local pulumi command succeeded; stopping")
+	return ErrLocalPulumiStopped
+}
+
+func DebugPulumiGolang(ctx context.Context, env []string, cmd ...string) error {
+	localCmd := append([]string{"go", "run", "./..."}, cmd...)
+	term.Debug(strings.Join(append(env, localCmd...), " "))
+
+	dir := os.Getenv("DEFANG_PULUMI_DIR")
+	if dir == "" {
+		return nil // show the shell command, but use regular Pulumi command in cloud task
+	}
+
+	if gopath, err := exec.Command("go", "env", "GOPATH").Output(); err != nil {
+		return err
+	} else {
+		env = append(env, "GOPATH="+strings.TrimSpace(string(gopath)))
+	}
+
+	// Run the Pulumi command locally
+	env = append([]string{
+		"PATH=" + os.Getenv("PATH"),
+		"USER=" + pkg.GetCurrentUser(), // needed for Pulumi
+		"HOME=" + os.Getenv("HOME"),    // needed for go
+	}, env...)
+	if err := runLocalCommand(ctx, path.Join(dir, "cd", "gcp"), env, localCmd...); err != nil {
+		return err
+	}
+	// We always return an error to stop the CLI from "tailing" the cloud logs
+	return ErrLocalPulumiStopped
 }
 
 func GetPrivateDomain(projectName string) string {

src/pkg/cli/client/byoc/common_test.go

@@ -1,6 +1,10 @@
 package byoc
 
-import "testing"
+import (
+	"context"
+	"os"
+	"testing"
+)
 
 func TestGetPulumiBackend(t *testing.T) {
 	const stateUrl = "s3://my-bucket"
@@ -78,3 +82,37 @@ func TestGetPulumiBackend(t *testing.T) {
 		})
 	}
 }
+
+func TestDebugPulumiGolang(t *testing.T) {
+	pulumiDir := os.Getenv("DEFANG_PULUMI_DIR")
+	if pulumiDir == "" {
+		t.Skip("DEFANG_PULUMI_DIR not set; skipping local Pulumi Golang test")
+	}
+
+	// REGION=us-central1 GCP_PROJECT_ID=jordan-project-463223 PULUMI_COPILOT=false PROJECT=nodejs-http PULUMI_BACKEND_URL=gs://defang-cd-tk0ak2pj5jwi PULUMI_CONFIG_PASSPHRASE=asdf PULUMI_SKIP_UPDATE_CHECK=true DEFANG_PREFIX=Defang DEFANG_STATE_URL=gs://defang-cd-tk0ak2pj5jwi GCP_PROJECT=jordan-project-463223 STACK=beta DEFANG_ORG=defang DEFANG_DEBUG=1 DEFANG_MODE=mode_unspecified DOMAIN=beta.nodejs-http.jordanstephens.defang.app DEFANG_JSON= REGION=us-central1 DEFANG_ETAG=iqzc5ldbyhsg
+	envs := []string{
+		"REGION=us-central1",
+		"GCP_PROJECT_ID=jordan-project-463223",
+		"PULUMI_COPILOT=false",
+		"PROJECT=golang-http",
+		"PULUMI_BACKEND_URL=gs://defang-cd-tk0ak2pj5jwi",
+		"PULUMI_CONFIG_PASSPHRASE=asdf",
+		"PULUMI_SKIP_UPDATE_CHECK=true",
+		"DEFANG_PREFIX=Defang",
+		"DEFANG_STATE_URL=gs://defang-cd-tk0ak2pj5jwi",
+		"GCP_PROJECT=jordan-project-463223",
+		"STACK=beta",
+		"DEFANG_ORG=defang",
+		"DEFANG_DEBUG=1",
+		"DEFANG_MODE=mode_unspecified",
+		"DOMAIN=beta.nodejs-http.jordanstephens.defang.app",
+		"DEFANG_JSON=",
+		"REGION=us-central1",
+		"DEFANG_ETAG=iqzc5ldbyhsg",
+	}
+
+	err := DebugPulumiGolang(context.Background(), envs, "up", "CqIBCgwKA2FwcDIFCLgXGAESNGFwcC0tMzAwMC5iZXRhLm5vZGVqcy1odHRwLmpvcmRhbnN0ZXBoZW5zLmRlZmFuZy5hcHAaC25vZGVqcy1odHRwIgxpcXpjNWxkYnloc2cqDEJVSUxEX1FVRVVFREouYXBwLmJldGEubm9kZWpzLWh0dHAuam9yZGFuc3RlcGhlbnMuZGVmYW5nLmFwcHgBkAEBIugEbmFtZTogbm9kZWpzLWh0dHAKc2VydmljZXM6CiAgYXBwOgogICAgYnVpbGQ6CiAgICAgIGNvbnRleHQ6IGdzOi8vZGVmYW5nLWNkLXRrMGFrMnBqNWp3aS91cGxvYWRzL3NoYTI1Ni03R2Z4eG51dmEwWkclMkJrYkxKVGI0SFVmZndFNGkwTDByT0JwT29Zdm03RVklM0QudGFyLmd6CiAgICAgIGRvY2tlcmZpbGU6IERvY2tlcmZpbGUKICAgIGRlcGxveToKICAgICAgcmVzb3VyY2VzOgogICAgICAgIHJlc2VydmF0aW9uczoKICAgICAgICAgIG1lbW9yeTogIjI2ODQzNTQ1NiIKICAgIGhlYWx0aGNoZWNrOgogICAgICB0ZXN0OgogICAgICAgIC0gQ01ECiAgICAgICAgLSBjdXJsCiAgICAgICAgLSAtZgogICAgICAgIC0gaHR0cDovL2xvY2FsaG9zdDozMDAwLwogICAgbmV0d29ya3M6CiAgICAgIGRlZmF1bHQ6IG51bGwKICAgIHBvcnRzOgogICAgICAtIG1vZGU6IGluZ3Jlc3MKICAgICAgICB0YXJnZXQ6IDMwMDAKICAgICAgICBwdWJsaXNoZWQ6ICIzMDAwIgogICAgICAgIHByb3RvY29sOiB0Y3AKICAgICAgICBhcHBfcHJvdG9jb2w6IGh0dHAKICAgIHJlc3RhcnQ6IHVubGVzcy1zdG9wcGVkCm5ldHdvcmtzOgogIGRlZmF1bHQ6CiAgICBuYW1lOiBub2RlanMtaHR0cF9kZWZhdWx0CiqDAWluZGV4LmRvY2tlci5pby9kZWZhbmdpby9jZDpwdWJsaWMtZ2NwLXYwLjYuMC04ODQtZzRlYzEwNDc3QHNoYTI1Njo1YWRhYzFmZWI1NzJmZDkzMzQwY2VkNWFlZGQ4NTE2ZDdkNTRiZDQwOWJiYWExNTRiYzY4YTQxMGJhZDg3OTM1")
+	if err != nil {
+		t.Fatal(err)
+	}
+}

src/pkg/cli/client/byoc/do/byoc.go

@@ -608,7 +608,7 @@ func (b *ByocDo) runCdCommand(ctx context.Context, projectName, delegateDomain s
 		for i, v := range env {
 			debugEnv[i] = v.Key + "=" + v.Value
 		}
-		if err := byoc.DebugPulumi(ctx, debugEnv, cmd...); err != nil {
+		if err := byoc.DebugPulumiNodeJS(ctx, debugEnv, cmd...); err != nil {
 			return nil, err
 		}
 	}

src/pkg/cli/client/byoc/gcp/byoc.go

@@ -372,6 +372,19 @@ func (b *ByocGcp) runCdCommand(ctx context.Context, cmd cdCommand) (string, erro
 		env[k] = v
 	}
 
+	if os.Getenv("DEFANG_PULUMI_DIR") != "" {
+		debugEnv := []string{"REGION=" + b.driver.Region}
+		if gcpProject := os.Getenv("GCP_PROJECT_ID"); gcpProject != "" {
+			debugEnv = append(debugEnv, "GCP_PROJECT_ID="+gcpProject)
+		}
+		for k, v := range env {
+			debugEnv = append(debugEnv, k+"="+v)
+		}
+		if err := byoc.DebugPulumiGolang(ctx, debugEnv, cmd.Command...); err != nil {
+			return "", err
+		}
+	}
+
 	execution, err := b.driver.Run(ctx, gcp.JobNameCD, env, cmd.Command...)
 	if err != nil {
 		return "", err