chore(coderd/coderdtest): wait for provisioner daemons to be connected

johnstcn · johnstcn · commit 9689ae600173 · 2024-12-19T11:15:29.000Z
diff --git a/coderd/coderdtest/coderdtest.go b/coderd/coderdtest/coderdtest.go
@@ -559,6 +559,8 @@ func NewWithAPI(t testing.TB, options *Options) (*codersdk.Client, io.Closer, *c
 	var provisionerCloser io.Closer = nopcloser{}
 	if options.IncludeProvisionerDaemon {
 		provisionerCloser = NewTaggedProvisionerDaemon(t, coderAPI, "test", options.ProvisionerDaemonTags)
+		// Wait for the provisioner daemon to be ready before continuing.
+		AwaitProvisionerDaemonsConnected(t, coderAPI)
 	}
 	client := codersdk.New(serverURL)
 	t.Cleanup(func() {
@@ -570,6 +572,36 @@ func NewWithAPI(t testing.TB, options *Options) (*codersdk.Client, io.Closer, *c
 	return client, provisionerCloser, coderAPI
 }
 
+// AwaitProvisionerDaemonsConnected waits for the provisioner daemon to connect.
+func AwaitProvisionerDaemonsConnected(t testing.TB, api *coderd.API) {
+	ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitShort)
+	defer cancel()
+	for {
+		select {
+		case <-ctx.Done():
+			t.Fatal("provisioner daemon did not connect in time")
+		case <-time.After(testutil.IntervalFast):
+			// nolint:gocritic // used for testing only
+			daemons, err := api.Database.GetProvisionerDaemons(dbauthz.AsSystemReadProvisionerDaemons(ctx))
+			if err != nil {
+				if errors.Is(err, sql.ErrNoRows) {
+					t.Logf("no provisioner daemons found yet")
+					continue
+				}
+				require.NoError(t, err)
+			}
+			if len(daemons) == 0 {
+				t.Logf("no provisioner daemons found yet")
+				continue
+			}
+			for _, daemon := range daemons {
+				t.Logf("found provisioner daemon %q", daemon.Name)
+			}
+			return
+		}
+	}
+}
+
 // ProvisionerdCloser wraps a provisioner daemon as an io.Closer that can be called multiple times
 type ProvisionerdCloser struct {
 	mu     sync.Mutex
diff --git a/coderd/templateversions_test.go b/coderd/templateversions_test.go
@@ -172,8 +172,8 @@ func TestPostTemplateVersionsByOrganization(t *testing.T) {
 		require.Equal(t, provisionersdk.ScopeOrganization, version.Job.Tags[provisionersdk.TagScope])
 		if assert.Equal(t, version.Job.Status, codersdk.ProvisionerJobPending) {
 			assert.NotNil(t, version.MatchedProvisioners)
-			assert.Equal(t, version.MatchedProvisioners.Available, 1)
-			assert.Equal(t, version.MatchedProvisioners.Count, 1)
+			assert.Equal(t, 1, version.MatchedProvisioners.Available)
+			assert.Equal(t, 1, version.MatchedProvisioners.Count)
 			assert.True(t, version.MatchedProvisioners.MostRecentlySeen.Valid)
 		}
 
diff --git a/enterprise/coderd/coderdenttest/coderdenttest.go b/enterprise/coderd/coderdenttest/coderdenttest.go
@@ -121,6 +121,8 @@ func NewWithAPI(t *testing.T, options *Options) (
 	var provisionerCloser io.Closer = nopcloser{}
 	if options.IncludeProvisionerDaemon {
 		provisionerCloser = coderdtest.NewProvisionerDaemon(t, coderAPI.AGPL)
+		// Wait for provisioner daemons to be connected befroe continuing
+		coderdtest.AwaitProvisionerDaemonsConnected(t, coderAPI.AGPL)
 	}
 
 	t.Cleanup(func() {

Original file line number	Diff line number	Diff line change
`@@ -121,6 +121,8 @@ func NewWithAPI(t testing.T, options Options) (`
`121`	`121`	`var provisionerCloser io.Closer = nopcloser{}`
`122`	`122`	`if options.IncludeProvisionerDaemon {`
`123`	`123`	`provisionerCloser = coderdtest.NewProvisionerDaemon(t, coderAPI.AGPL)`
	`124`	`+ // Wait for provisioner daemons to be connected befroe continuing`
	`125`	`+ coderdtest.AwaitProvisionerDaemonsConnected(t, coderAPI.AGPL)`
`124`	`126`	`}`
`125`	`127`
`126`	`128`	`t.Cleanup(func() {`