feat: Update Terraform provider to support "dir" in "coder_agent"

This allows users to specify a starting directory for shell sessions.
coder · kylecarbs · May 2, 2022 · Apr 29, 2022 · Apr 29, 2022 · Apr 30, 2022
commit 24f99e637bfe102fc38b48d492e6d0fb573c0ff4
diff --git a/agent/agent.go b/agent/agent.go
@@ -38,6 +38,7 @@ type Metadata struct {
 	OwnerUsername        string            `json:"owner_username"`
 	EnvironmentVariables map[string]string `json:"environment_variables"`
 	StartupScript        string            `json:"startup_script"`
+	Directory            string            `json:"directory"`
 }
 
 type Dialer func(ctx context.Context, logger slog.Logger) (Metadata, *peerbroker.Listener, error)
@@ -66,6 +67,7 @@ type agent struct {
 	// Environment variables sent by Coder to inject for shell sessions.
 	// These are atomic because values can change after reconnect.
 	envVars       atomic.Value
+	directory     atomic.String
 	ownerEmail    atomic.String
 	ownerUsername atomic.String
 	startupScript atomic.Bool
@@ -98,6 +100,7 @@ func (a *agent) run(ctx context.Context) {
 		return
 	default:
 	}
+	a.directory.Store(options.Directory)
 	a.envVars.Store(options.EnvironmentVariables)
 	a.ownerEmail.Store(options.OwnerEmail)
 	a.ownerUsername.Store(options.OwnerUsername)
@@ -308,6 +311,11 @@ func (a *agent) handleSSHSession(session ssh.Session) error {
 		caller = "/c"
 	}
 	cmd := exec.CommandContext(session.Context(), shell, caller, command)
+	cmd.Dir = a.directory.Load()
+	if cmd.Dir == "" {
+		// Default to $HOME if a directory is not set!
+		cmd.Dir = os.Getenv("HOME")
+	}
 	cmd.Env = append(os.Environ(), session.Environ()...)
 	executablePath, err := os.Executable()
 	if err != nil {

diff --git a/coderd/database/dump.sql b/coderd/database/dump.sql
diff --git a/coderd/database/migrations/000009_agent_directory.down.sql b/coderd/database/migrations/000009_agent_directory.down.sql
@@ -0,0 +1,2 @@
+ALTER TABLE ONLY workspace_agents
+	DROP COLUMN IF EXISTS directory;
diff --git a/coderd/database/migrations/000009_agent_directory.up.sql b/coderd/database/migrations/000009_agent_directory.up.sql
@@ -0,0 +1,3 @@
+ALTER TABLE ONLY workspace_agents
+    -- UNIX paths are a maximum length of 4096.
+    ADD COLUMN IF NOT EXISTS directory varchar(4096) DEFAULT '' NOT NULL;
diff --git a/coderd/database/models.go b/coderd/database/models.go
diff --git a/coderd/database/queries.sql.go b/coderd/database/queries.sql.go
diff --git a/coderd/provisionerdaemons.go b/coderd/provisionerdaemons.go
@@ -243,6 +243,8 @@ func (server *provisionerdServer) AcquireJob(ctx context.Context, _ *proto.Empty
 					WorkspaceTransition: transition,
 					WorkspaceName:       workspace.Name,
 					WorkspaceOwner:      owner.Username,
+					WorkspaceId:         workspace.ID.String(),
+					WorkspaceOwnerId:    owner.ID.String(),
 				},
 			},
 		}

diff --git a/coderd/workspaceagents.go b/coderd/workspaceagents.go
@@ -131,6 +131,7 @@ func (api *api) workspaceAgentMetadata(rw http.ResponseWriter, r *http.Request)
 		OwnerUsername:        owner.Username,
 		EnvironmentVariables: apiAgent.EnvironmentVariables,
 		StartupScript:        apiAgent.StartupScript,
+		Directory:            apiAgent.Directory,
 	})
 }
 
@@ -339,6 +340,7 @@ func convertWorkspaceAgent(dbAgent database.WorkspaceAgent, agentUpdateFrequency
 		OperatingSystem:      dbAgent.OperatingSystem,
 		StartupScript:        dbAgent.StartupScript.String,
 		EnvironmentVariables: envs,
+		Directory:            dbAgent.Directory,
 	}
 	if dbAgent.FirstConnectedAt.Valid {
 		workspaceAgent.FirstConnectedAt = &dbAgent.FirstConnectedAt.Time

diff --git a/codersdk/workspaceresources.go b/codersdk/workspaceresources.go
@@ -45,6 +45,7 @@ type WorkspaceAgent struct {
 	EnvironmentVariables map[string]string    `json:"environment_variables"`
 	OperatingSystem      string               `json:"operating_system"`
 	StartupScript        string               `json:"startup_script,omitempty"`
+	Directory            string               `json:"directory,omitempty"`
 }
 
 type WorkspaceAgentResourceMetadata struct {

diff --git a/provisioner/terraform/provision.go b/provisioner/terraform/provision.go
@@ -124,6 +124,8 @@ func (t *terraform) Provision(stream proto.DRPCProvisioner_ProvisionStream) erro
 		"CODER_WORKSPACE_TRANSITION="+strings.ToLower(start.Metadata.WorkspaceTransition.String()),
 		"CODER_WORKSPACE_NAME="+start.Metadata.WorkspaceName,
 		"CODER_WORKSPACE_OWNER="+start.Metadata.WorkspaceOwner,
+		"CODER_WORKSPACE_ID="+start.Metadata.WorkspaceId,
+		"CODER_WORKSPACE_OWNER_ID="+start.Metadata.WorkspaceOwnerId,
 	)
 	for key, value := range provisionersdk.AgentScriptEnv() {
 		env = append(env, key+"="+value)
@@ -330,6 +332,12 @@ func parseTerraformPlan(ctx context.Context, terraform *tfexec.Terraform, planfi
 				agent.StartupScript = startupScript
 			}
 		}
+		if directoryRaw, has := resource.Expressions["dir"]; has {
+			dir, ok := directoryRaw.ConstantValue.(string)
+			if ok {
+				agent.Directory = dir
+			}
+		}
 
 		agents[resource.Address] = agent
 	}
@@ -381,6 +389,7 @@ func parseTerraformApply(ctx context.Context, terraform *tfexec.Terraform, state
 			Auth            string            `mapstructure:"auth"`
 			OperatingSystem string            `mapstructure:"os"`
 			Architecture    string            `mapstructure:"arch"`
+			Directory       string            `mapstructure:"dir"`
 			ID              string            `mapstructure:"id"`
 			Token           string            `mapstructure:"token"`
 			Env             map[string]string `mapstructure:"env"`
@@ -405,6 +414,7 @@ func parseTerraformApply(ctx context.Context, terraform *tfexec.Terraform, state
 				StartupScript:   attrs.StartupScript,
 				OperatingSystem: attrs.OperatingSystem,
 				Architecture:    attrs.Architecture,
+				Directory:       attrs.Directory,
 			}
 			switch attrs.Auth {
 			case "token":

diff --git a/provisioner/terraform/provision_test.go b/provisioner/terraform/provision_test.go
@@ -28,7 +28,7 @@ terraform {
 	required_providers {
 		coder = {
 			source = "coder/coder"
-			version = "0.3.1"
+			version = "0.3.3"
 		}
 	}
 }
@@ -160,6 +160,7 @@ provider "coder" {
 			resource "coder_agent" "A" {
 				os = "windows"
 				arch = "arm64"
+				dir = "C:\\System32"
 			}
 			resource "null_resource" "A" {
 				depends_on = [
@@ -184,6 +185,7 @@ provider "coder" {
 							Name:            "A",
 							OperatingSystem: "windows",
 							Architecture:    "arm64",
+							Directory:       "C:\\System32",
 							Auth: &proto.Agent_Token{
 								Token: "",
 							},
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		ALTER TABLE ONLY workspace_agents
		DROP COLUMN IF EXISTS directory;