Skip to content

chore: executor_test: reduce test execution time #1876

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
May 30, 2022
Merged

chore: executor_test: reduce test execution time #1876

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a40a41a
chore: executor_test: break out some test helpers, attempt to speed u…
johnstcn May 27, 2022
b0260d7
reduce timeout
johnstcn May 27, 2022
05e4c5e
no asserts in eventually/never
johnstcn May 30, 2022
0d96b34
test: autobuild/executor: add channel for execution stats, use for as…
johnstcn May 30, 2022
4314760
Address PR comments
johnstcn May 30, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Address PR comments
  • Loading branch information
@johnstcn
johnstcn committed May 30, 2022
commit 4314760b2f649427d4976c4817d3d722db8cb7f9
12 changes: 6 additions & 6 deletions coderd/autobuild/executor/lifecycle_executor.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ type Executor struct {
db database.Store
log slog.Logger
tick <-chan time.Time
statsCh chan<- RunStats
statsCh chan<- Stats
}

// RunStats contains information about one run of Executor.
type RunStats struct {
// Stats contains information about one run of Executor.
type Stats struct {
Transitions map[uuid.UUID]database.WorkspaceTransition
Elapsed time.Duration
Error error
Expand All @@ -44,7 +44,7 @@ func New(ctx context.Context, db database.Store, log slog.Logger, tick <-chan ti

// WithStatsChannel will cause Executor to push a RunStats to ch after
// every tick.
func (e *Executor) WithStatsChannel(ch chan<- RunStats) *Executor {
func (e *Executor) WithStatsChannel(ch chan<- Stats) *Executor {
e.statsCh = ch
return e
}
Expand All @@ -67,9 +67,9 @@ func (e *Executor) Run() {
}()
}

func (e *Executor) runOnce(t time.Time) RunStats {
func (e *Executor) runOnce(t time.Time) Stats {
var err error
stats := RunStats{
stats := Stats{
Transitions: make(map[uuid.UUID]database.WorkspaceTransition),
}
defer func() {
Expand Down
112 changes: 56 additions & 56 deletions coderd/autobuild/executor/lifecycle_executor_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,11 @@ func TestExecutorAutostartOK(t *testing.T) {
ctx = context.Background()
err error
tickCh = make(chan time.Time)
statsCh = make(chan executor.RunStats)
statsCh = make(chan executor.Stats)
client = coderdtest.New(t, &coderdtest.Options{
AutobuildTicker: tickCh,
IncludeProvisionerD: true,
AutobuildStatsChannel: statsCh,
AutobuildTicker: tickCh,
IncludeProvisionerD: true,
AutobuildStats: statsCh,
})
// Given: we have a user with a workspace
workspace = mustProvisionWorkspace(t, client)
Expand Down Expand Up @@ -68,11 +68,11 @@ func TestExecutorAutostartTemplateUpdated(t *testing.T) {
ctx = context.Background()
err error
tickCh = make(chan time.Time)
statsCh = make(chan executor.RunStats)
statsCh = make(chan executor.Stats)
client = coderdtest.New(t, &coderdtest.Options{
AutobuildTicker: tickCh,
IncludeProvisionerD: true,
AutobuildStatsChannel: statsCh,
AutobuildTicker: tickCh,
IncludeProvisionerD: true,
AutobuildStats: statsCh,
})
// Given: we have a user with a workspace
workspace = mustProvisionWorkspace(t, client)
Expand Down Expand Up @@ -121,11 +121,11 @@ func TestExecutorAutostartAlreadyRunning(t *testing.T) {
ctx = context.Background()
err error
tickCh = make(chan time.Time)
statsCh = make(chan executor.RunStats)
statsCh = make(chan executor.Stats)
client = coderdtest.New(t, &coderdtest.Options{
AutobuildTicker: tickCh,
IncludeProvisionerD: true,
AutobuildStatsChannel: statsCh,
AutobuildTicker: tickCh,
IncludeProvisionerD: true,
AutobuildStats: statsCh,
})
// Given: we have a user with a workspace
workspace = mustProvisionWorkspace(t, client)
Expand Down Expand Up @@ -158,11 +158,11 @@ func TestExecutorAutostartNotEnabled(t *testing.T) {

var (
tickCh = make(chan time.Time)
statsCh = make(chan executor.RunStats)
statsCh = make(chan executor.Stats)
client = coderdtest.New(t, &coderdtest.Options{
AutobuildTicker: tickCh,
IncludeProvisionerD: true,
AutobuildStatsChannel: statsCh,
AutobuildTicker: tickCh,
IncludeProvisionerD: true,
AutobuildStats: statsCh,
})
// Given: we have a user with a workspace
workspace = mustProvisionWorkspace(t, client, func(cwr *codersdk.CreateWorkspaceRequest) {
Expand Down Expand Up @@ -193,11 +193,11 @@ func TestExecutorAutostopOK(t *testing.T) {

var (
tickCh = make(chan time.Time)
statsCh = make(chan executor.RunStats)
statsCh = make(chan executor.Stats)
client = coderdtest.New(t, &coderdtest.Options{
AutobuildTicker: tickCh,
IncludeProvisionerD: true,
AutobuildStatsChannel: statsCh,
AutobuildTicker: tickCh,
IncludeProvisionerD: true,
AutobuildStats: statsCh,
})
// Given: we have a user with a workspace
workspace = mustProvisionWorkspace(t, client)
Expand Down Expand Up @@ -226,11 +226,11 @@ func TestExecutorAutostopExtend(t *testing.T) {
var (
ctx = context.Background()
tickCh = make(chan time.Time)
statsCh = make(chan executor.RunStats)
statsCh = make(chan executor.Stats)
client = coderdtest.New(t, &coderdtest.Options{
AutobuildTicker: tickCh,
IncludeProvisionerD: true,
AutobuildStatsChannel: statsCh,
AutobuildTicker: tickCh,
IncludeProvisionerD: true,
AutobuildStats: statsCh,
})
// Given: we have a user with a workspace
workspace = mustProvisionWorkspace(t, client)
Expand Down Expand Up @@ -276,11 +276,11 @@ func TestExecutorAutostopAlreadyStopped(t *testing.T) {

var (
tickCh = make(chan time.Time)
statsCh = make(chan executor.RunStats)
statsCh = make(chan executor.Stats)
client = coderdtest.New(t, &coderdtest.Options{
AutobuildTicker: tickCh,
IncludeProvisionerD: true,
AutobuildStatsChannel: statsCh,
AutobuildTicker: tickCh,
IncludeProvisionerD: true,
AutobuildStats: statsCh,
})
// Given: we have a user with a workspace (disabling autostart)
workspace = mustProvisionWorkspace(t, client, func(cwr *codersdk.CreateWorkspaceRequest) {
Expand Down Expand Up @@ -308,11 +308,11 @@ func TestExecutorAutostopNotEnabled(t *testing.T) {

var (
tickCh = make(chan time.Time)
statsCh = make(chan executor.RunStats)
statsCh = make(chan executor.Stats)
client = coderdtest.New(t, &coderdtest.Options{
AutobuildTicker: tickCh,
IncludeProvisionerD: true,
AutobuildStatsChannel: statsCh,
AutobuildTicker: tickCh,
IncludeProvisionerD: true,
AutobuildStats: statsCh,
})
// Given: we have a user with a workspace that has no TTL set
workspace = mustProvisionWorkspace(t, client, func(cwr *codersdk.CreateWorkspaceRequest) {
Expand Down Expand Up @@ -345,11 +345,11 @@ func TestExecutorWorkspaceDeleted(t *testing.T) {
ctx = context.Background()
err error
tickCh = make(chan time.Time)
statsCh = make(chan executor.RunStats)
statsCh = make(chan executor.Stats)
client = coderdtest.New(t, &coderdtest.Options{
AutobuildTicker: tickCh,
IncludeProvisionerD: true,
AutobuildStatsChannel: statsCh,
AutobuildTicker: tickCh,
IncludeProvisionerD: true,
AutobuildStats: statsCh,
})
// Given: we have a user with a workspace
workspace = mustProvisionWorkspace(t, client)
Expand Down Expand Up @@ -384,11 +384,11 @@ func TestExecutorWorkspaceAutostartTooEarly(t *testing.T) {
ctx = context.Background()
err error
tickCh = make(chan time.Time)
statsCh = make(chan executor.RunStats)
statsCh = make(chan executor.Stats)
client = coderdtest.New(t, &coderdtest.Options{
AutobuildTicker: tickCh,
IncludeProvisionerD: true,
AutobuildStatsChannel: statsCh,
AutobuildTicker: tickCh,
IncludeProvisionerD: true,
AutobuildStats: statsCh,
})
futureTime = time.Now().Add(time.Hour)
futureTimeCron = fmt.Sprintf("%d %d * * *", futureTime.Minute(), futureTime.Hour())
Expand Down Expand Up @@ -422,11 +422,11 @@ func TestExecutorWorkspaceAutostopBeforeDeadline(t *testing.T) {

var (
tickCh = make(chan time.Time)
statsCh = make(chan executor.RunStats)
statsCh = make(chan executor.Stats)
client = coderdtest.New(t, &coderdtest.Options{
AutobuildTicker: tickCh,
IncludeProvisionerD: true,
AutobuildStatsChannel: statsCh,
AutobuildTicker: tickCh,
IncludeProvisionerD: true,
AutobuildStats: statsCh,
})
// Given: we have a user with a workspace
workspace = mustProvisionWorkspace(t, client)
Expand All @@ -450,11 +450,11 @@ func TestExecutorWorkspaceAutostopNoWaitChangedMyMind(t *testing.T) {
var (
ctx = context.Background()
tickCh = make(chan time.Time)
statsCh = make(chan executor.RunStats)
statsCh = make(chan executor.Stats)
client = coderdtest.New(t, &coderdtest.Options{
AutobuildTicker: tickCh,
IncludeProvisionerD: true,
AutobuildStatsChannel: statsCh,
AutobuildTicker: tickCh,
IncludeProvisionerD: true,
AutobuildStats: statsCh,
})
// Given: we have a user with a workspace
workspace = mustProvisionWorkspace(t, client)
Expand Down Expand Up @@ -488,17 +488,17 @@ func TestExecutorAutostartMultipleOK(t *testing.T) {
var (
tickCh = make(chan time.Time)
tickCh2 = make(chan time.Time)
statsCh1 = make(chan executor.RunStats)
statsCh2 = make(chan executor.RunStats)
statsCh1 = make(chan executor.Stats)
statsCh2 = make(chan executor.Stats)
client = coderdtest.New(t, &coderdtest.Options{
AutobuildTicker: tickCh,
IncludeProvisionerD: true,
AutobuildStatsChannel: statsCh1,
AutobuildTicker: tickCh,
IncludeProvisionerD: true,
AutobuildStats: statsCh1,
})
_ = coderdtest.New(t, &coderdtest.Options{
AutobuildTicker: tickCh2,
IncludeProvisionerD: true,
AutobuildStatsChannel: statsCh2,
AutobuildTicker: tickCh2,
IncludeProvisionerD: true,
AutobuildStats: statsCh2,
})
// Given: we have a user with a workspace that has autostart enabled (default)
workspace = mustProvisionWorkspace(t, client)
Expand Down
24 changes: 12 additions & 12 deletions coderd/coderdtest/coderdtest.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,15 +56,15 @@ import (
)

type Options struct {
AWSCertificates awsidentity.Certificates
Authorizer rbac.Authorizer
AzureCertificates x509.VerifyOptions
GithubOAuth2Config *coderd.GithubOAuth2Config
GoogleTokenValidator *idtoken.Validator
SSHKeygenAlgorithm gitsshkey.Algorithm
APIRateLimit int
AutobuildTicker <-chan time.Time
AutobuildStatsChannel chan<- executor.RunStats
AWSCertificates awsidentity.Certificates
Authorizer rbac.Authorizer
AzureCertificates x509.VerifyOptions
GithubOAuth2Config *coderd.GithubOAuth2Config
GoogleTokenValidator *idtoken.Validator
SSHKeygenAlgorithm gitsshkey.Algorithm
APIRateLimit int
AutobuildTicker <-chan time.Time
AutobuildStats chan<- executor.Stats

// IncludeProvisionerD when true means to start an in-memory provisionerD
IncludeProvisionerD bool
Expand Down Expand Up @@ -93,9 +93,9 @@ func NewWithAPI(t *testing.T, options *Options) (*codersdk.Client, *coderd.API)
options.AutobuildTicker = ticker
t.Cleanup(func() { close(ticker) })
}
if options.AutobuildStatsChannel != nil {
if options.AutobuildStats != nil {
t.Cleanup(func() {
close(options.AutobuildStatsChannel)
close(options.AutobuildStats)
})
}

Expand Down Expand Up @@ -128,7 +128,7 @@ func NewWithAPI(t *testing.T, options *Options) (*codersdk.Client, *coderd.API)
db,
slogtest.Make(t, nil).Named("autobuild.executor").Leveled(slog.LevelDebug),
options.AutobuildTicker,
).WithStatsChannel(options.AutobuildStatsChannel)
).WithStatsChannel(options.AutobuildStats)
lifecycleExecutor.Run()

srv := httptest.NewUnstartedServer(nil)
Expand Down