Rename source to script

coder · kylecarbs · Sep 25, 2023 · Sep 3, 2023 · Sep 5, 2023 · Sep 5, 2023
commit 78f01d1032b38bf377e6b13186c6f99b5b6e84e4
diff --git a/agent/agent.go b/agent/agent.go
@@ -656,6 +656,7 @@ func (a *agent) run(ctx context.Context) error {
 			} else {
 				a.setLifecycle(ctx, codersdk.WorkspaceAgentLifecycleReady)
 			}
+			a.scriptRunner.StartCRON()
 		})
 		if err != nil {
 			return xerrors.Errorf("track conn goroutine: %w", err)

diff --git a/agent/agent_test.go b/agent/agent_test.go
@@ -1209,7 +1209,7 @@ func TestAgent_Lifecycle(t *testing.T) {
 
 		_, client, _, _, _ := setupAgent(t, agentsdk.Manifest{
 			Scripts: []codersdk.WorkspaceAgentScript{{
-				Source:     "sleep 3",
+				Script:     "sleep 3",
 				Timeout:    time.Nanosecond,
 				RunOnStart: true,
 			}},
@@ -1234,7 +1234,7 @@ func TestAgent_Lifecycle(t *testing.T) {
 
 		_, client, _, _, _ := setupAgent(t, agentsdk.Manifest{
 			Scripts: []codersdk.WorkspaceAgentScript{{
-				Source:     "false",
+				Script:     "false",
 				Timeout:    30 * time.Second,
 				RunOnStart: true,
 			}},
@@ -1259,7 +1259,7 @@ func TestAgent_Lifecycle(t *testing.T) {
 
 		_, client, _, _, _ := setupAgent(t, agentsdk.Manifest{
 			Scripts: []codersdk.WorkspaceAgentScript{{
-				Source:     "true",
+				Script:     "true",
 				Timeout:    30 * time.Second,
 				RunOnStart: true,
 			}},
@@ -1284,7 +1284,7 @@ func TestAgent_Lifecycle(t *testing.T) {
 
 		_, client, _, _, closer := setupAgent(t, agentsdk.Manifest{
 			Scripts: []codersdk.WorkspaceAgentScript{{
-				Source:    "sleep 3",
+				Script:    "sleep 3",
 				Timeout:   30 * time.Second,
 				RunOnStop: true,
 			}},
@@ -1325,7 +1325,7 @@ func TestAgent_Lifecycle(t *testing.T) {
 
 		_, client, _, _, closer := setupAgent(t, agentsdk.Manifest{
 			Scripts: []codersdk.WorkspaceAgentScript{{
-				Source:    "sleep 3",
+				Script:    "sleep 3",
 				Timeout:   time.Nanosecond,
 				RunOnStop: true,
 			}},
@@ -1367,7 +1367,7 @@ func TestAgent_Lifecycle(t *testing.T) {
 
 		_, client, _, _, closer := setupAgent(t, agentsdk.Manifest{
 			Scripts: []codersdk.WorkspaceAgentScript{{
-				Source:    "false",
+				Script:    "false",
 				Timeout:   30 * time.Second,
 				RunOnStop: true,
 			}},
@@ -1417,11 +1417,11 @@ func TestAgent_Lifecycle(t *testing.T) {
 				DERPMap: derpMap,
 				Scripts: []codersdk.WorkspaceAgentScript{{
 					LogPath:    "coder-startup-script.log",
-					Source:     "echo 1",
+					Script:     "echo 1",
 					RunOnStart: true,
 				}, {
 					LogPath:   "coder-shutdown-script.log",
-					Source:    "echo " + expected,
+					Script:    "echo " + expected,
 					RunOnStop: true,
 				}},
 			},

diff --git a/agent/agentscripts/agentscripts.go b/agent/agentscripts/agentscripts.go
@@ -25,7 +25,7 @@ var (
 	// ErrTimeout is returned when a script times out.
 	ErrTimeout = xerrors.New("script timed out")
 
-	parser = cron.NewParser(cron.Minute | cron.Hour | cron.Dom | cron.Month | cron.Dow)
+	parser = cron.NewParser(cron.Second | cron.Minute | cron.Hour | cron.Dom | cron.Month | cron.DowOptional)
 )
 
 // Options are a set of options for the runner.
@@ -82,6 +82,12 @@ func (r *Runner) Init(scripts []codersdk.WorkspaceAgentScript) error {
 	return nil
 }
 
+// StartCRON starts the cron scheduler.
+// This is done async to allow for the caller to execute scripts prior.
+func (r *Runner) StartCRON() {
+	r.cron.Start()
+}
+
 // Execute runs a set of scripts according to a filter.
 func (r *Runner) Execute(filter func(script codersdk.WorkspaceAgentScript) bool) error {
 	if filter == nil {
@@ -114,7 +120,7 @@ func (r *Runner) Execute(filter func(script codersdk.WorkspaceAgentScript) bool)
 func (r *Runner) run(script codersdk.WorkspaceAgentScript) error {
 	logger := r.Logger.With(slog.F("log_source", script.LogPath))
 	ctx := r.ctx
-	logger.Info(ctx, "running agent script", slog.F("script", script.Source))
+	logger.Info(ctx, "running agent script", slog.F("script", script.Script))
 
 	logPath := script.LogPath
 	if logPath == "" {
@@ -142,7 +148,7 @@ func (r *Runner) run(script codersdk.WorkspaceAgentScript) error {
 		defer cancel()
 	}
 
-	cmdPty, err := r.SSHServer.CreateCommand(ctx, script.Source, nil)
+	cmdPty, err := r.SSHServer.CreateCommand(ctx, script.Script, nil)
 	if err != nil {
 		return xerrors.Errorf("%s script: create command: %w", logPath, err)
 	}

diff --git a/agent/agentscripts/agentscripts_test.go b/agent/agentscripts/agentscripts_test.go
@@ -31,7 +31,7 @@ func TestExecuteBasic(t *testing.T) {
 	})
 	defer runner.Close()
 	err := runner.Init([]codersdk.WorkspaceAgentScript{{
-		Source: "echo hello",
+		Script: "echo hello",
 	}})
 	require.NoError(t, err)
 	require.NoError(t, runner.Execute(func(script codersdk.WorkspaceAgentScript) bool {
@@ -46,7 +46,7 @@ func TestTimeout(t *testing.T) {
 	runner := setup(t, nil)
 	defer runner.Close()
 	err := runner.Init([]codersdk.WorkspaceAgentScript{{
-		Source:  "sleep 3",
+		Script:  "sleep 3",
 		Timeout: time.Nanosecond,
 	}})
 	require.NoError(t, err)

diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go
diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json
diff --git a/coderd/database/dbfake/dbfake.go b/coderd/database/dbfake/dbfake.go
@@ -4645,7 +4645,7 @@ func (q *FakeQuerier) InsertWorkspaceAgentScripts(_ context.Context, arg databas
 			LogSourceID:      source,
 			WorkspaceAgentID: arg.WorkspaceAgentID,
 			LogPath:          arg.LogPath[index],
-			Source:           arg.Source[index],
+			Script:           arg.Script[index],
 			Cron:             arg.Cron[index],
 			StartBlocksLogin: arg.StartBlocksLogin[index],
 			RunOnStart:       arg.RunOnStart[index],

diff --git a/coderd/database/dump.sql b/coderd/database/dump.sql
diff --git a/coderd/database/migrations/000155_workspace_agent_script.up.sql b/coderd/database/migrations/000155_workspace_agent_script.up.sql
@@ -13,7 +13,7 @@ CREATE TABLE workspace_agent_scripts (
 	log_source_id uuid NOT NULL,
 	log_path text NOT NULL,
 	created_at timestamptz NOT NULL,
-	source text NOT NULL,
+	script text NOT NULL,
 	cron text NOT NULL,
 	start_blocks_login boolean NOT NULL,
 	run_on_start boolean 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/database/queries/workspacescripts.sql b/coderd/database/queries/workspacescripts.sql
@@ -1,12 +1,12 @@
 -- name: InsertWorkspaceAgentScripts :many
 INSERT INTO
-	workspace_agent_scripts (workspace_agent_id, log_source_id, log_path, created_at, source, cron, start_blocks_login, run_on_start, run_on_stop, timeout)
+	workspace_agent_scripts (workspace_agent_id, log_source_id, log_path, created_at, script, cron, start_blocks_login, run_on_start, run_on_stop, timeout)
 SELECT
 	@workspace_agent_id :: uuid AS workspace_agent_id,
 	unnest(@log_source_id :: uuid [ ]) AS log_source_id,
 	unnest(@log_path :: text [ ]) AS log_path,
 	unnest(@created_at :: timestamptz [ ]) AS created_at,
-	unnest(@source :: text [ ]) AS source,
+	unnest(@script :: text [ ]) AS script,
 	unnest(@cron :: text [ ]) AS cron,
 	unnest(@start_blocks_login :: boolean [ ]) AS start_blocks_login,
 	unnest(@run_on_start :: boolean [ ]) AS run_on_start,

diff --git a/coderd/provisionerdserver/provisionerdserver.go b/coderd/provisionerdserver/provisionerdserver.go
@@ -1299,7 +1299,7 @@ func InsertWorkspaceResource(ctx context.Context, db database.Store, jobID uuid.
 			logSourceDisplayNames = append(logSourceDisplayNames, script.DisplayName)
 			logSourceIcons = append(logSourceIcons, script.Icon)
 			scriptLogPaths = append(scriptLogPaths, script.LogPath)
-			scriptSources = append(scriptSources, script.Source)
+			scriptSources = append(scriptSources, script.Script)
 			scriptCron = append(scriptCron, script.Cron)
 			scriptTimeout = append(scriptTimeout, script.Timeout)
 			scriptStartBlocksLogin = append(scriptStartBlocksLogin, script.StartBlocksLogin)
@@ -1323,7 +1323,7 @@ func InsertWorkspaceResource(ctx context.Context, db database.Store, jobID uuid.
 			LogSourceID:      logSourceIDs,
 			LogPath:          scriptLogPaths,
 			CreatedAt:        logSourceCreatedAt,
-			Source:           scriptSources,
+			Script:           scriptSources,
 			Cron:             scriptCron,
 			Timeout:          scriptTimeout,
 			StartBlocksLogin: scriptStartBlocksLogin,

diff --git a/coderd/workspaceagents.go b/coderd/workspaceagents.go
@@ -1322,7 +1322,7 @@ func convertScripts(dbScripts []database.WorkspaceAgentScript) []codersdk.Worksp
 		scripts = append(scripts, codersdk.WorkspaceAgentScript{
 			LogPath:          dbScript.LogPath,
 			LogSourceID:      dbScript.LogSourceID,
-			Source:           dbScript.Source,
+			Script:           dbScript.Script,
 			CRON:             dbScript.Cron,
 			RunOnStart:       dbScript.RunOnStart,
 			RunOnStop:        dbScript.RunOnStop,

diff --git a/codersdk/workspaceagents.go b/codersdk/workspaceagents.go
@@ -188,7 +188,7 @@ type WorkspaceAgentLogSource struct {
 type WorkspaceAgentScript struct {
 	LogSourceID      uuid.UUID     `json:"log_source_id" format:"uuid"`
 	LogPath          string        `json:"log_path"`
-	Source           string        `json:"source"`
+	Script           string        `json:"script"`
 	CRON             string        `json:"cron"`
 	RunOnStart       bool          `json:"run_on_start"`
 	RunOnStop        bool          `json:"run_on_stop"`

diff --git a/docs/api/agents.md b/docs/api/agents.md