feat(tmc): add default branch to synced stack data (#1186)

# Reason for This Change To link back to stack changes in a Git repository from Terramate Cloud, the default branch must be known. Currently, the backend just assumes "main". ## Description of Changes * A new attribute `default_branch` has been added to the Stack structure. The client always sets this field. * Tests have been updated accordingly to include the DefaultBranch when comparing results. * A new test has been added for a default branch that is not "main".
terramate-io · Oct 20, 2023 · cead9ef · cead9ef
2 parents 2059930 + d7c12e5
commit cead9ef
Show file tree

Hide file tree

Showing 5 changed files with 133 additions and 68 deletions.
diff --git a/cloud/types.go b/cloud/types.go
@@ -58,6 +58,7 @@ type (
 	// Stack represents the stack as defined by the user HCL code.
 	Stack struct {
 		Repository      string   `json:"repository"`
+		DefaultBranch   string   `json:"default_branch"`
 		Path            string   `json:"path"`
 		MetaID          string   `json:"meta_id"`
 		MetaName        string   `json:"meta_name,omitempty"`
@@ -336,6 +337,9 @@ func (s Stack) Validate() error {
 	if s.Repository == "" {
 		return errors.E(`missing "repository" field`)
 	}
+	if s.DefaultBranch == "" {
+		return errors.E(`missing "default_branch" field`)
+	}
 	if s.Path == "" {
 		return errors.E(`missing "path" field`)
 	}

diff --git a/cmd/terramate/cli/cloud_sync_deployment.go b/cmd/terramate/cli/cloud_sync_deployment.go
@@ -84,6 +84,7 @@ func (c *cli) createCloudDeployment(runStacks []ExecContext) {
 				MetaDescription: run.Stack.Description,
 				MetaTags:        tags,
 				Repository:      c.prj.prettyRepo(),
+				DefaultBranch:   c.prj.gitcfg().DefaultBranch,
 				Path:            run.Stack.Dir.String(),
 			},
 			CommitSHA:         deploymentCommitSHA,

diff --git a/cmd/terramate/cli/cloud_sync_drift.go b/cmd/terramate/cli/cloud_sync_drift.go
@@ -66,6 +66,7 @@ func (c *cli) cloudSyncDriftStatus(runContext ExecContext, exitCode int, err err
 	_, err = c.cloud.client.CreateStackDrift(ctx, c.cloud.run.orgUUID, cloud.DriftStackPayloadRequest{
 		Stack: cloud.Stack{
 			Repository:      c.prj.prettyRepo(),
+			DefaultBranch:   c.prj.gitcfg().DefaultBranch,
 			Path:            st.Dir.String(),
 			MetaID:          st.ID,
 			MetaName:        st.Name,

diff --git a/cmd/terramate/e2etests/run_cloud_drift_test.go b/cmd/terramate/e2etests/run_cloud_drift_test.go
@@ -38,13 +38,14 @@ func TestCLIRunWithCloudSyncDriftStatus(t *testing.T) {
 		drifts expectedDriftStackPayloadRequests
 	}
 	type testcase struct {
-		name       string
-		layout     []string
-		runflags   []string
-		env        []string
-		workingDir string
-		cmd        []string
-		want       want
+		name          string
+		layout        []string
+		runflags      []string
+		env           []string
+		workingDir    string
+		defaultBranch string
+		cmd           []string
+		want          want
 	}
 
 	absPlanFilePath := test.WriteFile(t, t.TempDir(), "out.tfplan", ``)
@@ -77,10 +78,11 @@ func TestCLIRunWithCloudSyncDriftStatus(t *testing.T) {
 					{
 						DriftStackPayloadRequest: cloud.DriftStackPayloadRequest{
 							Stack: cloud.Stack{
-								Repository: "local",
-								Path:       "/stack",
-								MetaName:   "stack",
-								MetaID:     "stack",
+								Repository:    "local",
+								DefaultBranch: "main",
+								Path:          "/stack",
+								MetaName:      "stack",
+								MetaID:        "stack",
 							},
 							Status: stack.Failed,
 						},
@@ -104,10 +106,11 @@ func TestCLIRunWithCloudSyncDriftStatus(t *testing.T) {
 					{
 						DriftStackPayloadRequest: cloud.DriftStackPayloadRequest{
 							Stack: cloud.Stack{
-								Repository: "local",
-								Path:       "/s1",
-								MetaName:   "s1",
-								MetaID:     "s1",
+								Repository:    "local",
+								DefaultBranch: "main",
+								Path:          "/s1",
+								MetaName:      "s1",
+								MetaID:        "s1",
 							},
 							Status: stack.Failed,
 						},
@@ -133,21 +136,23 @@ func TestCLIRunWithCloudSyncDriftStatus(t *testing.T) {
 					{
 						DriftStackPayloadRequest: cloud.DriftStackPayloadRequest{
 							Stack: cloud.Stack{
-								Repository: "local",
-								Path:       "/s1",
-								MetaName:   "s1",
-								MetaID:     "s1",
+								Repository:    "local",
+								DefaultBranch: "main",
+								Path:          "/s1",
+								MetaName:      "s1",
+								MetaID:        "s1",
 							},
 							Status: stack.Failed,
 						},
 					},
 					{
 						DriftStackPayloadRequest: cloud.DriftStackPayloadRequest{
 							Stack: cloud.Stack{
-								Repository: "local",
-								Path:       "/s2",
-								MetaName:   "s2",
-								MetaID:     "s2",
+								Repository:    "local",
+								DefaultBranch: "main",
+								Path:          "/s2",
+								MetaName:      "s2",
+								MetaID:        "s2",
 							},
 							Status: stack.Failed,
 						},
@@ -174,21 +179,23 @@ func TestCLIRunWithCloudSyncDriftStatus(t *testing.T) {
 					{
 						DriftStackPayloadRequest: cloud.DriftStackPayloadRequest{
 							Stack: cloud.Stack{
-								Repository: "local",
-								Path:       "/s1",
-								MetaName:   "s1",
-								MetaID:     "s1",
+								Repository:    "local",
+								DefaultBranch: "main",
+								Path:          "/s1",
+								MetaName:      "s1",
+								MetaID:        "s1",
 							},
 							Status: stack.Failed,
 						},
 					},
 					{
 						DriftStackPayloadRequest: cloud.DriftStackPayloadRequest{
 							Stack: cloud.Stack{
-								Repository: "local",
-								Path:       "/s2",
-								MetaName:   "s2",
-								MetaID:     "s2",
+								Repository:    "local",
+								DefaultBranch: "main",
+								Path:          "/s2",
+								MetaName:      "s2",
+								MetaID:        "s2",
 							},
 							Status: stack.OK,
 						},
@@ -207,10 +214,11 @@ func TestCLIRunWithCloudSyncDriftStatus(t *testing.T) {
 					{
 						DriftStackPayloadRequest: cloud.DriftStackPayloadRequest{
 							Stack: cloud.Stack{
-								Repository: "local",
-								Path:       "/stack",
-								MetaName:   "stack",
-								MetaID:     "stack",
+								Repository:    "local",
+								DefaultBranch: "main",
+								Path:          "/stack",
+								MetaName:      "stack",
+								MetaID:        "stack",
 							},
 							Status: stack.Drifted,
 						},
@@ -236,10 +244,11 @@ func TestCLIRunWithCloudSyncDriftStatus(t *testing.T) {
 					{
 						DriftStackPayloadRequest: cloud.DriftStackPayloadRequest{
 							Stack: cloud.Stack{
-								Repository: "local",
-								Path:       "/parent/child",
-								MetaName:   "child",
-								MetaID:     "child",
+								Repository:    "local",
+								DefaultBranch: "main",
+								Path:          "/parent/child",
+								MetaName:      "child",
+								MetaID:        "child",
 							},
 							Status: stack.OK,
 						},
@@ -259,21 +268,23 @@ func TestCLIRunWithCloudSyncDriftStatus(t *testing.T) {
 					{
 						DriftStackPayloadRequest: cloud.DriftStackPayloadRequest{
 							Stack: cloud.Stack{
-								Repository: "local",
-								Path:       "/s1",
-								MetaName:   "s1",
-								MetaID:     "s1",
+								Repository:    "local",
+								DefaultBranch: "main",
+								Path:          "/s1",
+								MetaName:      "s1",
+								MetaID:        "s1",
 							},
 							Status: stack.Drifted,
 						},
 					},
 					{
 						DriftStackPayloadRequest: cloud.DriftStackPayloadRequest{
 							Stack: cloud.Stack{
-								Repository: "local",
-								Path:       "/s2",
-								MetaName:   "s2",
-								MetaID:     "s2",
+								Repository:    "local",
+								DefaultBranch: "main",
+								Path:          "/s2",
+								MetaName:      "s2",
+								MetaID:        "s2",
 							},
 							Status: stack.Drifted,
 						},
@@ -300,10 +311,11 @@ func TestCLIRunWithCloudSyncDriftStatus(t *testing.T) {
 					{
 						DriftStackPayloadRequest: cloud.DriftStackPayloadRequest{
 							Stack: cloud.Stack{
-								Repository: "local",
-								Path:       "/s1",
-								MetaName:   "s1",
-								MetaID:     "s1",
+								Repository:    "local",
+								DefaultBranch: "main",
+								Path:          "/s1",
+								MetaName:      "s1",
+								MetaID:        "s1",
 							},
 							Status: stack.Drifted,
 						},
@@ -331,10 +343,11 @@ func TestCLIRunWithCloudSyncDriftStatus(t *testing.T) {
 					{
 						DriftStackPayloadRequest: cloud.DriftStackPayloadRequest{
 							Stack: cloud.Stack{
-								Repository: "local",
-								Path:       "/s1",
-								MetaName:   "s1",
-								MetaID:     "s1",
+								Repository:    "local",
+								DefaultBranch: "main",
+								Path:          "/s1",
+								MetaName:      "s1",
+								MetaID:        "s1",
 							},
 							Status: stack.Drifted,
 						},
@@ -372,10 +385,11 @@ func TestCLIRunWithCloudSyncDriftStatus(t *testing.T) {
 					{
 						DriftStackPayloadRequest: cloud.DriftStackPayloadRequest{
 							Stack: cloud.Stack{
-								Repository: "local",
-								Path:       "/s1",
-								MetaName:   "s1",
-								MetaID:     "s1",
+								Repository:    "local",
+								DefaultBranch: "main",
+								Path:          "/s1",
+								MetaName:      "s1",
+								MetaID:        "s1",
 							},
 							Status: stack.Drifted,
 							Details: &cloud.DriftDetails{
@@ -391,10 +405,11 @@ func TestCLIRunWithCloudSyncDriftStatus(t *testing.T) {
 					{
 						DriftStackPayloadRequest: cloud.DriftStackPayloadRequest{
 							Stack: cloud.Stack{
-								Repository: "local",
-								Path:       "/s2",
-								MetaName:   "s2",
-								MetaID:     "s2",
+								Repository:    "local",
+								DefaultBranch: "main",
+								Path:          "/s2",
+								MetaName:      "s2",
+								MetaID:        "s2",
 							},
 							Status: stack.Drifted,
 							Details: &cloud.DriftDetails{
@@ -410,13 +425,56 @@ func TestCLIRunWithCloudSyncDriftStatus(t *testing.T) {
 				},
 			},
 		},
+		{
+			name: "drift with different default branch",
+			layout: []string{
+				"s:stack:id=stack",
+				`f:cfg.tm.hcl:terramate {
+					config {
+						git {
+							default_branch = "trunk"
+						}
+					}
+				}`,
+			},
+			cmd: []string{
+				testHelperBin, "exit", "2",
+			},
+			defaultBranch: "trunk",
+			want: want{
+				drifts: expectedDriftStackPayloadRequests{
+					{
+						DriftStackPayloadRequest: cloud.DriftStackPayloadRequest{
+							Stack: cloud.Stack{
+								Repository:    "local",
+								DefaultBranch: "trunk",
+								Path:          "/stack",
+								MetaName:      "stack",
+								MetaID:        "stack",
+							},
+							Status: stack.Drifted,
+						},
+					},
+				},
+			},
+		},
 	} {
 		tc := tc
 		t.Run(tc.name, func(t *testing.T) {
 			// NOTE: this test needs to be serial :-(
 			startFakeTMCServer(t)
 
-			s := sandbox.New(t)
+			defaultBranch := tc.defaultBranch
+			if defaultBranch == "" {
+				defaultBranch = "main"
+			}
+
+			s := sandbox.NewWithGitConfig(t, sandbox.GitConfig{
+				LocalBranchName:         defaultBranch,
+				DefaultRemoteName:       "origin",
+				DefaultRemoteBranchName: defaultBranch,
+			})
+
 			s.Env, _ = test.PrependToPath(os.Environ(), filepath.Dir(terraformTestBin))
 
 			s.BuildTree(tc.layout)

diff --git a/cmd/terramate/e2etests/run_cloud_signal_test.go b/cmd/terramate/e2etests/run_cloud_signal_test.go
@@ -154,10 +154,11 @@ func TestCLIRunWithCloudSyncDriftStatusWithSignals(t *testing.T) {
 					{
 						DriftStackPayloadRequest: cloud.DriftStackPayloadRequest{
 							Stack: cloud.Stack{
-								Repository: "local",
-								Path:       "/s1",
-								MetaName:   "s1",
-								MetaID:     "s1",
+								Repository:    "local",
+								DefaultBranch: "main",
+								Path:          "/s1",
+								MetaName:      "s1",
+								MetaID:        "s1",
 							},
 							Status: stack.Failed,
 						},