Fix logger failing when getting expected failure

code-asher · code-asher · commit 6fab6a2854cb · 2023-06-02T15:20:11.000-08:00
diff --git a/coderd/coderdtest/coderdtest.go b/coderd/coderdtest/coderdtest.go
@@ -134,6 +134,10 @@ type Options struct {
 	ConfigSSH codersdk.SSHConfigResponse
 
 	SwaggerEndpoint bool
+
+	// LoggerIgnoreErrors causes the test logger to not fatal the test on Fatal
+	// and not error the test on Error or Critical.
+	LoggerIgnoreErrors bool
 }
 
 // New constructs a codersdk client connected to an in-memory API instance.
@@ -375,7 +379,7 @@ func NewWithAPI(t testing.TB, options *Options) (*codersdk.Client, io.Closer, *c
 	setHandler(coderAPI.RootHandler)
 	var provisionerCloser io.Closer = nopcloser{}
 	if options.IncludeProvisionerDaemon {
-		provisionerCloser = NewProvisionerDaemon(t, coderAPI)
+		provisionerCloser = NewProvisionerDaemon(t, coderAPI, options.LoggerIgnoreErrors)
 	}
 	client := codersdk.New(serverURL)
 	t.Cleanup(func() {
@@ -390,7 +394,7 @@ func NewWithAPI(t testing.TB, options *Options) (*codersdk.Client, io.Closer, *c
 // NewProvisionerDaemon launches a provisionerd instance configured to work
 // well with coderd testing. It registers the "echo" provisioner for
 // quick testing.
-func NewProvisionerDaemon(t testing.TB, coderAPI *coderd.API) io.Closer {
+func NewProvisionerDaemon(t testing.TB, coderAPI *coderd.API, loggerIgnoreErrors bool) io.Closer {
 	echoClient, echoServer := provisionersdk.MemTransportPipe()
 	ctx, cancelFunc := context.WithCancel(context.Background())
 	t.Cleanup(func() {
@@ -410,7 +414,7 @@ func NewProvisionerDaemon(t testing.TB, coderAPI *coderd.API) io.Closer {
 		return coderAPI.CreateInMemoryProvisionerDaemon(ctx, 0)
 	}, &provisionerd.Options{
 		Filesystem:          fs,
-		Logger:              slogtest.Make(t, nil).Named("provisionerd").Leveled(slog.LevelDebug),
+		Logger:              slogtest.Make(t, &slogtest.Options{IgnoreErrors: loggerIgnoreErrors}).Named("provisionerd").Leveled(slog.LevelDebug),
 		JobPollInterval:     50 * time.Millisecond,
 		UpdateInterval:      250 * time.Millisecond,
 		ForceCancelInterval: time.Second,
diff --git a/coderd/workspacebuilds_test.go b/coderd/workspacebuilds_test.go
@@ -593,7 +593,7 @@ func TestWorkspaceBuildStatus(t *testing.T) {
 	// initial returned state is "pending"
 	require.EqualValues(t, codersdk.WorkspaceStatusPending, workspace.LatestBuild.Status)
 
-	closeDaemon = coderdtest.NewProvisionerDaemon(t, api)
+	closeDaemon = coderdtest.NewProvisionerDaemon(t, api, false)
 	// after successful build is "running"
 	_ = coderdtest.AwaitWorkspaceBuildJob(t, client, workspace.LatestBuild.ID)
 
@@ -628,7 +628,7 @@ func TestWorkspaceBuildStatus(t *testing.T) {
 	require.NoError(t, err)
 	require.EqualValues(t, codersdk.WorkspaceStatusCanceled, workspace.LatestBuild.Status)
 
-	_ = coderdtest.NewProvisionerDaemon(t, api)
+	_ = coderdtest.NewProvisionerDaemon(t, api, false)
 	// after successful delete is "deleted"
 	build = coderdtest.CreateWorkspaceBuild(t, client, workspace, database.WorkspaceTransitionDelete)
 	_ = coderdtest.AwaitWorkspaceBuildJob(t, client, build.ID)
diff --git a/coderd/workspaces_test.go b/coderd/workspaces_test.go
@@ -1636,7 +1636,10 @@ func TestWorkspaceExtend(t *testing.T) {
 
 func TestWorkspaceWatcher(t *testing.T) {
 	t.Parallel()
-	client, closeFunc := coderdtest.NewWithProvisionerCloser(t, &coderdtest.Options{IncludeProvisionerDaemon: true})
+	client, closeFunc := coderdtest.NewWithProvisionerCloser(t, &coderdtest.Options{
+		IncludeProvisionerDaemon: true,
+		LoggerIgnoreErrors:       true,
+	})
 	defer closeFunc.Close()
 	user := coderdtest.CreateFirstUser(t, client)
 	authToken := uuid.NewString()
diff --git a/enterprise/coderd/coderdenttest/coderdenttest.go b/enterprise/coderd/coderdenttest/coderdenttest.go
@@ -81,7 +81,7 @@ func NewWithAPI(t *testing.T, options *Options) (*codersdk.Client, io.Closer, *c
 	setHandler(coderAPI.AGPL.RootHandler)
 	var provisionerCloser io.Closer = nopcloser{}
 	if options.IncludeProvisionerDaemon {
-		provisionerCloser = coderdtest.NewProvisionerDaemon(t, coderAPI.AGPL)
+		provisionerCloser = coderdtest.NewProvisionerDaemon(t, coderAPI.AGPL, options.LoggerIgnoreErrors)
 	}
 
 	t.Cleanup(func() {
diff --git a/enterprise/coderd/workspacequota_test.go b/enterprise/coderd/workspacequota_test.go
@@ -42,9 +42,9 @@ func TestWorkspaceQuota(t *testing.T) {
 		client, _, api := coderdenttest.NewWithAPI(t, &coderdenttest.Options{
 			UserWorkspaceQuota: max,
 		})
-		coderdtest.NewProvisionerDaemon(t, api.AGPL)
-		coderdtest.NewProvisionerDaemon(t, api.AGPL)
-		coderdtest.NewProvisionerDaemon(t, api.AGPL)
+		coderdtest.NewProvisionerDaemon(t, api.AGPL, false)
+		coderdtest.NewProvisionerDaemon(t, api.AGPL, false)
+		coderdtest.NewProvisionerDaemon(t, api.AGPL, false)
 
 		user := coderdtest.CreateFirstUser(t, client)
 		coderdenttest.AddLicense(t, client, coderdenttest.LicenseOptions{

Original file line number	Diff line number	Diff line change
`@@ -81,7 +81,7 @@ func NewWithAPI(t testing.T, options Options) (codersdk.Client, io.Closer, c`
`81`	`81`	`setHandler(coderAPI.AGPL.RootHandler)`
`82`	`82`	`var provisionerCloser io.Closer = nopcloser{}`
`83`	`83`	`if options.IncludeProvisionerDaemon {`
`84`		`- provisionerCloser = coderdtest.NewProvisionerDaemon(t, coderAPI.AGPL)`
	`84`	`+ provisionerCloser = coderdtest.NewProvisionerDaemon(t, coderAPI.AGPL, options.LoggerIgnoreErrors)`
`85`	`85`	`}`
`86`	`86`
`87`	`87`	`t.Cleanup(func() {`