feat: record who created a run

internal/http/html/static/templates/partials/run_item.tmpl

@@ -12,6 +12,12 @@
               | <a id="vcs-username" href="{{ $.IngressAttributes.SenderHTMLURL }}">@{{ . }}</a>
             </span>
           {{ end }}
+        {{ else }}
+          {{ with .CreatedBy }}
+            <span class="inline-block max-w-[16rem] truncate" id="run-created-by">
+              | @{{ . }}
+            </span>
+          {{ end }}
         {{ end }}
         <span>{{ durationRound .CreatedAt }} ago</span>
       </div>

internal/integration/run_test.go

@@ -4,6 +4,7 @@ import (
 	"testing"
 
 	"github.com/leg100/otf/internal"
+	"github.com/leg100/otf/internal/auth"
 	"github.com/leg100/otf/internal/cloud"
 	"github.com/leg100/otf/internal/configversion"
 	"github.com/leg100/otf/internal/daemon"
@@ -23,8 +24,13 @@ func TestRun(t *testing.T) {
 		svc, _, ctx := setup(t, &config{Config: daemon.Config{DisableScheduler: true}})
 		cv := svc.createConfigurationVersion(t, ctx, nil, nil)
 
-		_, err := svc.CreateRun(ctx, cv.WorkspaceID, run.RunCreateOptions{})
+		run, err := svc.CreateRun(ctx, cv.WorkspaceID, run.RunCreateOptions{})
 		require.NoError(t, err)
+
+		user, err := auth.UserFromContext(ctx)
+		require.NoError(t, err)
+		assert.NotNil(t, run.CreatedBy)
+		assert.Equal(t, user.Username, *run.CreatedBy)
 	})
 
 	// test the "magic string" behaviour specific to OTF: if
@@ -115,6 +121,11 @@ func TestRun(t *testing.T) {
 		require.NoError(t, err)
 
 		assert.Equal(t, want, got)
+
+		user, err := auth.UserFromContext(ctx)
+		require.NoError(t, err)
+		assert.NotNil(t, got.CreatedBy)
+		assert.Equal(t, user.Username, *got.CreatedBy)
 	})
 
 	t.Run("list", func(t *testing.T) {

internal/run/db.go

@@ -42,6 +42,7 @@ type (
 		ConfigurationVersionID pgtype.Text                   `json:"configuration_version_id"`
 		WorkspaceID            pgtype.Text                   `json:"workspace_id"`
 		PlanOnly               bool                          `json:"plan_only"`
+		CreatedBy              pgtype.Text                   `json:"created_by"`
 		ExecutionMode          pgtype.Text                   `json:"execution_mode"`
 		Latest                 bool                          `json:"latest"`
 		OrganizationName       pgtype.Text                   `json:"organization_name"`
@@ -87,6 +88,9 @@ func (result pgresult) toRun() *Run {
 			ResourceReport:   reportFromDB(result.ApplyResourceReport),
 		},
 	}
+	if result.CreatedBy.Status == pgtype.Present {
+		run.CreatedBy = &result.CreatedBy.String
+	}
 	if result.ForceCancelAvailableAt.Status == pgtype.Present {
 		run.ForceCancelAvailableAt = internal.Time(result.ForceCancelAvailableAt.Time.UTC())
 	}
@@ -113,6 +117,7 @@ func (db *pgdb) CreateRun(ctx context.Context, run *Run) error {
 			PlanOnly:               run.PlanOnly,
 			ConfigurationVersionID: sql.String(run.ConfigurationVersionID),
 			WorkspaceID:            sql.String(run.WorkspaceID),
+			CreatedBy:              sql.StringPtr(run.CreatedBy),
 		})
 		if err != nil {
 			return fmt.Errorf("inserting run: %w", err)

internal/run/factory.go

@@ -51,7 +51,7 @@ func (f *factory) NewRun(ctx context.Context, workspaceID string, opts RunCreate
 		return nil, err
 	}
 
-	return newRun(cv, ws, opts), nil
+	return newRun(ctx, cv, ws, opts), nil
 }
 
 // createConfigVersionFromVCS creates a config version from the vcs repo

internal/run/run.go

@@ -3,11 +3,13 @@
 package run
 
 import (
+	"context"
 	"errors"
 	"fmt"
 	"time"
 
 	"github.com/leg100/otf/internal"
+	"github.com/leg100/otf/internal/auth"
 	"github.com/leg100/otf/internal/configversion"
 	"github.com/leg100/otf/internal/rbac"
 	"github.com/leg100/otf/internal/resource"
@@ -68,6 +70,10 @@ type (
 
 		// IngressAttributes is non-nil if run was triggered by a VCS event.
 		IngressAttributes *configversion.IngressAttributes `json:"ingress_attributes"`
+
+		// Username of user who created the run. This is nil if the run was
+		// instead triggered by a VCS event.
+		CreatedBy *string
 	}
 
 	// RunList represents a list of runs.
@@ -133,7 +139,7 @@ type (
 )
 
 // newRun creates a new run with defaults.
-func newRun(cv *configversion.ConfigurationVersion, ws *workspace.Workspace, opts RunCreateOptions) *Run {
+func newRun(ctx context.Context, cv *configversion.ConfigurationVersion, ws *workspace.Workspace, opts RunCreateOptions) *Run {
 	run := Run{
 		ID:                     internal.NewID("run"),
 		CreatedAt:              internal.CurrentTimestamp(),
@@ -152,6 +158,10 @@ func newRun(cv *configversion.ConfigurationVersion, ws *workspace.Workspace, opt
 	run.Apply = NewPhase(run.ID, internal.ApplyPhase)
 	run.updateStatus(internal.RunPending)
 
+	if user, _ := auth.UserFromContext(ctx); user != nil {
+		run.CreatedBy = &user.Username
+	}
+
 	if opts.IsDestroy != nil {
 		run.IsDestroy = *opts.IsDestroy
 	}

internal/run/run_test.go

@@ -1,26 +1,38 @@
 package run
 
 import (
+	"context"
 	"testing"
 
 	"github.com/leg100/otf/internal"
+	"github.com/leg100/otf/internal/auth"
 	"github.com/leg100/otf/internal/configversion"
 	"github.com/leg100/otf/internal/workspace"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 )
 
+func TestRun_New_CreatedBy(t *testing.T) {
+	ctx := context.Background()
+	ctx = internal.AddSubjectToContext(ctx, &auth.User{Username: "terry"})
+	run := newRun(ctx, &configversion.ConfigurationVersion{}, &workspace.Workspace{}, RunCreateOptions{})
+	assert.NotNil(t, run.CreatedBy)
+	assert.Equal(t, "terry", *run.CreatedBy)
+}
+
 func TestRun_States(t *testing.T) {
+	ctx := context.Background()
+
 	t.Run("pending", func(t *testing.T) {
-		run := newRun(&configversion.ConfigurationVersion{}, &workspace.Workspace{}, RunCreateOptions{})
+		run := newRun(ctx, &configversion.ConfigurationVersion{}, &workspace.Workspace{}, RunCreateOptions{})
 
 		require.Equal(t, internal.RunPending, run.Status)
 		require.Equal(t, PhasePending, run.Plan.Status)
 		require.Equal(t, PhasePending, run.Apply.Status)
 	})
 
 	t.Run("enqueue plan", func(t *testing.T) {
-		run := newRun(&configversion.ConfigurationVersion{}, &workspace.Workspace{}, RunCreateOptions{})
+		run := newRun(ctx, &configversion.ConfigurationVersion{}, &workspace.Workspace{}, RunCreateOptions{})
 
 		require.NoError(t, run.EnqueuePlan())
 
@@ -30,7 +42,7 @@ func TestRun_States(t *testing.T) {
 	})
 
 	t.Run("start plan", func(t *testing.T) {
-		run := newRun(&configversion.ConfigurationVersion{}, &workspace.Workspace{}, RunCreateOptions{})
+		run := newRun(ctx, &configversion.ConfigurationVersion{}, &workspace.Workspace{}, RunCreateOptions{})
 		run.Status = internal.RunPlanQueued
 
 		require.NoError(t, run.Start(internal.PlanPhase))
@@ -41,7 +53,7 @@ func TestRun_States(t *testing.T) {
 	})
 
 	t.Run("finish plan", func(t *testing.T) {
-		run := newRun(&configversion.ConfigurationVersion{}, &workspace.Workspace{}, RunCreateOptions{})
+		run := newRun(ctx, &configversion.ConfigurationVersion{}, &workspace.Workspace{}, RunCreateOptions{})
 		run.Status = internal.RunPlanning
 
 		require.NoError(t, run.Finish(internal.PlanPhase, PhaseFinishOptions{}))
@@ -52,7 +64,7 @@ func TestRun_States(t *testing.T) {
 	})
 
 	t.Run("finish plan with errors", func(t *testing.T) {
-		run := newRun(&configversion.ConfigurationVersion{}, &workspace.Workspace{}, RunCreateOptions{})
+		run := newRun(ctx, &configversion.ConfigurationVersion{}, &workspace.Workspace{}, RunCreateOptions{})
 		run.Status = internal.RunPlanning
 
 		require.NoError(t, run.Finish(internal.PlanPhase, PhaseFinishOptions{Errored: true}))
@@ -63,7 +75,7 @@ func TestRun_States(t *testing.T) {
 	})
 
 	t.Run("finish plan with resource changes", func(t *testing.T) {
-		run := newRun(&configversion.ConfigurationVersion{}, &workspace.Workspace{}, RunCreateOptions{})
+		run := newRun(ctx, &configversion.ConfigurationVersion{}, &workspace.Workspace{}, RunCreateOptions{})
 		run.Status = internal.RunPlanning
 
 		run.Plan.ResourceReport = &Report{Additions: 1}
@@ -76,7 +88,7 @@ func TestRun_States(t *testing.T) {
 	})
 
 	t.Run("finish plan with output changes", func(t *testing.T) {
-		run := newRun(&configversion.ConfigurationVersion{}, &workspace.Workspace{}, RunCreateOptions{})
+		run := newRun(ctx, &configversion.ConfigurationVersion{}, &workspace.Workspace{}, RunCreateOptions{})
 		run.Status = internal.RunPlanning
 
 		run.Plan.OutputReport = &Report{Additions: 1}
@@ -89,7 +101,7 @@ func TestRun_States(t *testing.T) {
 	})
 
 	t.Run("finish plan with changes on run with autoapply enabled", func(t *testing.T) {
-		run := newRun(&configversion.ConfigurationVersion{}, &workspace.Workspace{}, RunCreateOptions{
+		run := newRun(ctx, &configversion.ConfigurationVersion{}, &workspace.Workspace{}, RunCreateOptions{
 			AutoApply: internal.Bool(true),
 		})
 		run.Status = internal.RunPlanning
@@ -104,7 +116,7 @@ func TestRun_States(t *testing.T) {
 	})
 
 	t.Run("enqueue apply", func(t *testing.T) {
-		run := newRun(&configversion.ConfigurationVersion{}, &workspace.Workspace{}, RunCreateOptions{})
+		run := newRun(ctx, &configversion.ConfigurationVersion{}, &workspace.Workspace{}, RunCreateOptions{})
 		run.Status = internal.RunPlanned
 
 		require.NoError(t, run.EnqueueApply())
@@ -114,7 +126,7 @@ func TestRun_States(t *testing.T) {
 	})
 
 	t.Run("start apply", func(t *testing.T) {
-		run := newRun(&configversion.ConfigurationVersion{}, &workspace.Workspace{}, RunCreateOptions{})
+		run := newRun(ctx, &configversion.ConfigurationVersion{}, &workspace.Workspace{}, RunCreateOptions{})
 		run.Status = internal.RunApplyQueued
 
 		require.NoError(t, run.Start(internal.ApplyPhase))
@@ -124,7 +136,7 @@ func TestRun_States(t *testing.T) {
 	})
 
 	t.Run("finish apply", func(t *testing.T) {
-		run := newRun(&configversion.ConfigurationVersion{}, &workspace.Workspace{}, RunCreateOptions{})
+		run := newRun(ctx, &configversion.ConfigurationVersion{}, &workspace.Workspace{}, RunCreateOptions{})
 		run.Status = internal.RunApplying
 
 		require.NoError(t, run.Finish(internal.ApplyPhase, PhaseFinishOptions{}))
@@ -134,19 +146,19 @@ func TestRun_States(t *testing.T) {
 	})
 
 	t.Run("finish apply with errors", func(t *testing.T) {
-		run := newRun(&configversion.ConfigurationVersion{}, &workspace.Workspace{}, RunCreateOptions{})
+		run := newRun(ctx, &configversion.ConfigurationVersion{}, &workspace.Workspace{}, RunCreateOptions{})
 		run.Status = internal.RunApplying
 
 		require.NoError(t, run.Finish(internal.ApplyPhase, PhaseFinishOptions{Errored: true}))
 
 		require.Equal(t, internal.RunErrored, run.Status)
 		require.Equal(t, PhaseErrored, run.Apply.Status)
 	})
-}
 
-func TestRun_Cancel(t *testing.T) {
-	run := newRun(&configversion.ConfigurationVersion{}, &workspace.Workspace{}, RunCreateOptions{})
-	err := run.Cancel()
-	require.NoError(t, err)
-	assert.NotZero(t, run.ForceCancelAvailableAt)
+	t.Run("cancel run", func(t *testing.T) {
+		run := newRun(ctx, &configversion.ConfigurationVersion{}, &workspace.Workspace{}, RunCreateOptions{})
+		err := run.Cancel()
+		require.NoError(t, err)
+		assert.NotZero(t, run.ForceCancelAvailableAt)
+	})
 }

internal/sql/migrations/20230802183439_add_created_by_user_to_runs.sql

@@ -0,0 +1,5 @@
+-- +goose Up
+ALTER TABLE runs ADD COLUMN created_by TEXT;
+
+-- +goose Down
+ALTER TABLE runs DROP COLUMN created_by;