fix: Add tests for instance and app association

This was regressed in #2187. There was bad testing around this before, and this should prevent a similiar situation from happening again!
coder · kylecarbs · Jun 9, 2022 · Jun 9, 2022 · Jun 9, 2022 · bc84d9f09d8a12dacae54e94477509bcf9702970
commit bc84d9f09d8a12dacae54e94477509bcf9702970
diff --git a/provisioner/terraform/resources.go b/provisioner/terraform/resources.go
@@ -120,17 +120,86 @@ func ConvertResources(module *tfjson.StateModule, rawGraph string) ([]*proto.Res
 		}
 	}
 
+	type appAttributes struct {
+		AgentID      string `mapstructure:"agent_id"`
+		Name         string `mapstructure:"name"`
+		Icon         string `mapstructure:"icon"`
+		URL          string `mapstructure:"url"`
+		Command      string `mapstructure:"command"`
+		RelativePath bool   `mapstructure:"relative_path"`
+	}
+	// Associate Apps with agents.
+	for _, resource := range tfResources {
+		if resource.Type != "coder_app" {
+			continue
+		}
+		var attrs appAttributes
+		err = mapstructure.Decode(resource.AttributeValues, &attrs)
+		if err != nil {
+			return nil, xerrors.Errorf("decode app attributes: %w", err)
+		}
+		if attrs.Name == "" {
+			// Default to the resource name if none is set!
+			attrs.Name = resource.Name
+		}
+		for _, agent := range agents {
+			if agent.Id != attrs.AgentID {
+				continue
+			}
+			agent.Apps = append(agent.Apps, &proto.App{
+				Name:         attrs.Name,
+				Command:      attrs.Command,
+				Url:          attrs.URL,
+				Icon:         attrs.Icon,
+				RelativePath: attrs.RelativePath,
+			})
+		}
+	}
+
 	for _, resource := range tfResources {
 		if resource.Mode == tfjson.DataResourceMode {
 			continue
 		}
 		if resource.Type == "coder_agent" || resource.Type == "coder_agent_instance" || resource.Type == "coder_app" {
 			continue
 		}
+		agents := findAgents(resourceDependencies, agents, convertAddressToLabel(resource.Address))
+		for _, agent := range agents {
+			// Didn't use instance identity.
+			if agent.GetToken() != "" {
+				continue
+			}
+
+			// These resource types are for automatically associating an instance ID
+			// with an agent for authentication.
+			key, isValid := map[string]string{
+				"google_compute_instance":         "instance_id",
+				"aws_instance":                    "id",
+				"azurerm_linux_virtual_machine":   "id",
+				"azurerm_windows_virtual_machine": "id",
+			}[resource.Type]
+			if !isValid {
+				// The resource type doesn't support
+				// automatically setting the instance ID.
+				continue
+			}
+			instanceIDRaw, valid := resource.AttributeValues[key]
+			if !valid {
+				continue
+			}
+			instanceID, valid := instanceIDRaw.(string)
+			if !valid {
+				continue
+			}
+			agent.Auth = &proto.Agent_InstanceId{
+				InstanceId: instanceID,
+			}
+		}
+
 		resources = append(resources, &proto.Resource{
 			Name:   resource.Name,
 			Type:   resource.Type,
-			Agents: findAgents(resourceDependencies, agents, convertAddressToLabel(resource.Address)),
+			Agents: agents,
 		})
 	}
 

diff --git a/provisioner/terraform/resources_test.go b/provisioner/terraform/resources_test.go
@@ -11,6 +11,7 @@ import (
 	tfjson "github.com/hashicorp/terraform-json"
 	"github.com/stretchr/testify/require"
 
+	"github.com/coder/coder/cryptorand"
 	"github.com/coder/coder/provisioner/terraform"
 	"github.com/coder/coder/provisionersdk/proto"
 )
@@ -74,6 +75,21 @@ func TestConvertResources(t *testing.T) {
 				Auth:            &proto.Agent_Token{},
 			}},
 		}},
+		"multiple-apps": {{
+			Name: "dev",
+			Type: "null_resource",
+			Agents: []*proto.Agent{{
+				Name:            "dev1",
+				OperatingSystem: "linux",
+				Architecture:    "amd64",
+				Apps: []*proto.App{{
+					Name: "app1",
+				}, {
+					Name: "app2",
+				}},
+				Auth: &proto.Agent_Token{},
+			}},
+		}},
 	} {
 		folderName := folderName
 		expected := expected
@@ -140,3 +156,69 @@ func TestConvertResources(t *testing.T) {
 		})
 	}
 }
+
+func TestInstanceIDAssociation(t *testing.T) {
+	t.Parallel()
+	type tc struct {
+		Auth          string
+		ResourceType  string
+		InstanceIDKey string
+	}
+	for _, tc := range []tc{{
+		Auth:          "google-instance-identity",
+		ResourceType:  "google_compute_instance",
+		InstanceIDKey: "instance_id",
+	}, {
+		Auth:          "aws-instance-identity",
+		ResourceType:  "aws_instance",
+		InstanceIDKey: "id",
+	}, {
+		Auth:          "azure-instance-identity",
+		ResourceType:  "azurerm_linux_virtual_machine",
+		InstanceIDKey: "id",
+	}, {
+		Auth:          "azure-instance-identity",
+		ResourceType:  "azurerm_windows_virtual_machine",
+		InstanceIDKey: "id",
+	}} {
+		tc := tc
+		t.Run(tc.ResourceType, func(t *testing.T) {
+			t.Parallel()
+			instanceID, err := cryptorand.String(12)
+			require.NoError(t, err)
+			resources, err := terraform.ConvertResources(&tfjson.StateModule{
+				Resources: []*tfjson.StateResource{{
+					Address: "coder_agent.dev",
+					Type:    "coder_agent",
+					Name:    "dev",
+					AttributeValues: map[string]interface{}{
+						"arch": "amd64",
+						"auth": tc.Auth,
+					},
+				}, {
+					Address:   tc.ResourceType + ".dev",
+					Type:      tc.ResourceType,
+					Name:      "dev",
+					DependsOn: []string{"coder_agent.dev"},
+					AttributeValues: map[string]interface{}{
+						tc.InstanceIDKey: instanceID,
+					},
+				}},
+				// This is manually created to join the edges.
+			}, `digraph {
+	compound = "true"
+	newrank = "true"
+	subgraph "root" {
+		"[root] coder_agent.dev" [label = "coder_agent.dev", shape = "box"]
+		"[root] `+tc.ResourceType+`.dev" [label = "`+tc.ResourceType+`.dev", shape = "box"]
+		"[root] `+tc.ResourceType+`.dev" -> "[root] coder_agent.dev"
+	}
+}
+`)
+			require.NoError(t, err)
+			require.Len(t, resources, 1)
+			require.Len(t, resources[0].Agents, 1)
+			require.Equal(t, resources[0].Agents[0].GetInstanceId(), instanceID)
+		})
+	}
+}
diff --git a/...rm/testdata/calling-module/with-module.tf → ...testdata/calling-module/calling-module.tf b/...rm/testdata/calling-module/with-module.tf → ...testdata/calling-module/calling-module.tf
diff --git a/provisioner/terraform/testdata/calling-module/calling-module.tfstate.json b/provisioner/terraform/testdata/calling-module/calling-module.tfstate.json
diff --git a/provisioner/terraform/testdata/chaining-resources/chaining-resources.tfstate.json b/provisioner/terraform/testdata/chaining-resources/chaining-resources.tfstate.json
diff --git a/.../testdata/instance-id/with-instance-id.tf → ...aform/testdata/instance-id/instance-id.tf b/.../testdata/instance-id/with-instance-id.tf → ...aform/testdata/instance-id/instance-id.tf
diff --git a/provisioner/terraform/testdata/instance-id/instance-id.tfstate.json b/provisioner/terraform/testdata/instance-id/instance-id.tfstate.json
diff --git a/...a/multiple-agents/with-multiple-agents.tf → ...stdata/multiple-agents/multiple-agents.tf b/...a/multiple-agents/with-multiple-agents.tf → ...stdata/multiple-agents/multiple-agents.tf
diff --git a/provisioner/terraform/testdata/multiple-agents/multiple-agents.tfstate.json b/provisioner/terraform/testdata/multiple-agents/multiple-agents.tfstate.json
diff --git a/provisioner/terraform/testdata/multiple-apps/multiple-apps.tf b/provisioner/terraform/testdata/multiple-apps/multiple-apps.tf
@@ -0,0 +1,27 @@
+terraform {
+  required_providers {
+    coder = {
+      source  = "coder/coder"
+      version = "0.4.2"
+    }
+  }
+}
+
+resource "coder_agent" "dev1" {
+  os   = "linux"
+  arch = "amd64"
+}
+
+resource "coder_app" "app1" {
+  agent_id = coder_agent.dev1.id
+}
+
+resource "coder_app" "app2" {
+  agent_id = coder_agent.dev1.id
+}
+
+resource "null_resource" "dev" {
+  depends_on = [
+    coder_agent.dev1
+  ]
+}
diff --git a/provisioner/terraform/testdata/multiple-apps/multiple-apps.tfplan.dot b/provisioner/terraform/testdata/multiple-apps/multiple-apps.tfplan.dot