improve testing strategy and errors handling

defelmnq · defelmnq · commit 7ba597983a9b · 2024-11-19T16:08:44.000Z
diff --git a/enterprise/coderd/provisionerkeys.go b/enterprise/coderd/provisionerkeys.go
@@ -214,7 +214,9 @@ func (*API) fetchProvisionerKey(rw http.ResponseWriter, r *http.Request) {
 	pk, ok := httpmw.ProvisionerKeyAuthOptional(r)
 	// extra check but this one should never happen as it is covered by the auth middleware
 	if !ok {
-		httpapi.Forbidden(rw)
+		httpapi.Write(ctx, rw, http.StatusForbidden, codersdk.Response{
+			Message: fmt.Sprintf("unable to auth: please provide the %s header", codersdk.ProvisionerDaemonKey),
+		})
 		return
 	}
 
diff --git a/enterprise/coderd/provisionerkeys_test.go b/enterprise/coderd/provisionerkeys_test.go
@@ -135,40 +135,64 @@ func TestProvisionerKeys(t *testing.T) {
 	require.ErrorContains(t, err, "reserved")
 }
 
-func TestProvisionerKey(t *testing.T) {
+func TestGetProvisionerKey(t *testing.T) {
 	t.Parallel()
-	t.Run("GetKey", func(t *testing.T) {
-		t.Parallel()
 
-		ctx := testutil.Context(t, testutil.WaitShort)
+	tests := []struct {
+		name        string
+		useFakeKey  bool
+		fakeKey     string
+		success     bool
+		expectedErr string
+	}{
+		{
+			name:        "ok",
+			useFakeKey:  false,
+			success:     true,
+			expectedErr: "",
+		},
+	}
 
-		dv := coderdtest.DeploymentValues(t)
-		client, owner := coderdenttest.New(t, &coderdenttest.Options{
-			Options: &coderdtest.Options{
-				DeploymentValues: dv,
-			},
-			LicenseOptions: &coderdenttest.LicenseOptions{
-				Features: license.Features{
-					codersdk.FeatureMultipleOrganizations:      1,
-					codersdk.FeatureExternalProvisionerDaemons: 1,
-				},
-			},
-		})
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
 
-		// nolint:gocritic
-		key, err := client.CreateProvisionerKey(ctx, owner.OrganizationID, codersdk.CreateProvisionerKeyRequest{
-			Name: "my-test-key",
-			Tags: map[string]string{"key1": "value1", "key2": "value2"},
-		})
-		require.NoError(t, err)
+			t.Parallel()
 
-		fetchedKey, err := client.GetProvisionerKey(ctx, key.Key)
-		require.NoError(t, err)
-		require.Equal(t, fetchedKey.Name, "my-test-key")
-		require.Equal(t, fetchedKey.Tags, codersdk.ProvisionerKeyTags{"key1": "value1", "key2": "value2"})
+			ctx := testutil.Context(t, testutil.WaitShort)
 
-		erroneousPK, err := client.GetProvisionerKey(ctx, "abcdefghijklmnopqrstuvwxyz01234567890123456")
-		require.Empty(t, erroneousPK)
-		require.Error(t, err)
-	})
+			dv := coderdtest.DeploymentValues(t)
+			client, owner := coderdenttest.New(t, &coderdenttest.Options{
+				Options: &coderdtest.Options{
+					DeploymentValues: dv,
+				},
+				LicenseOptions: &coderdenttest.LicenseOptions{
+					Features: license.Features{
+						codersdk.FeatureMultipleOrganizations:      1,
+						codersdk.FeatureExternalProvisionerDaemons: 1,
+					},
+				},
+			})
+
+			// nolint:gocritic - ruleguard: This client is operating as the owner user, which has unrestricted permissions.
+			key, err := client.CreateProvisionerKey(ctx, owner.OrganizationID, codersdk.CreateProvisionerKeyRequest{
+				Name: "my-test-key",
+				Tags: map[string]string{"key1": "value1", "key2": "value2"},
+			})
+			require.NoError(t, err)
+
+			pk := key.Key
+			if tt.useFakeKey {
+				pk = tt.fakeKey
+			}
+
+			fetchedKey, err := client.GetProvisionerKey(ctx, pk)
+			if !tt.success {
+				require.ErrorContains(t, err, tt.expectedErr)
+			} else {
+				require.NoError(t, err)
+				require.Equal(t, fetchedKey.Name, "my-test-key")
+				require.Equal(t, fetchedKey.Tags, codersdk.ProvisionerKeyTags{"key1": "value1", "key2": "value2"})
+			}
+		})
+	}
 }
