changes endpoint to return all pk details

coder · defelmnq · Nov 25, 2024 · Nov 14, 2024 · Nov 14, 2024 · Nov 14, 2024
commit c629f07f8a175e163086ff2a063028e413bb7685
diff --git a/codersdk/provisionerdaemons.go b/codersdk/provisionerdaemons.go
@@ -368,21 +368,23 @@ func (c *Client) ListProvisionerKeys(ctx context.Context, organizationID uuid.UU
 	return resp, json.NewDecoder(res.Body).Decode(&resp)
 }
 
-// FetchProvisionerTagsByKey returns the provisioner tags associated with the provisioner key.
-func (c *Client) FetchProvisionerTagsByKey(ctx context.Context, organizationID uuid.UUID, provisionerKey string) (ProvisionerKeyTags, error) {
+// GetProvisionerKey returns the provisioner key.
+func (c *Client) GetProvisionerKey(ctx context.Context, pk string) (ProvisionerKey, error) {
 	res, err := c.Request(ctx, http.MethodGet,
-		fmt.Sprintf("/api/v2/organizations/%s/provisionerkeys/%s/tags", organizationID.String(), provisionerKey),
-		nil,
+		fmt.Sprintf("/api/v2/provisionerkeys/%s", pk), nil,
+		func(req *http.Request) {
+			req.Header.Add(ProvisionerDaemonKey, pk)
+		},
 	)
 	if err != nil {
-		return nil, xerrors.Errorf("make request: %w", err)
+		return ProvisionerKey{}, xerrors.Errorf("make request: %w", err)
 	}
 	defer res.Body.Close()
 
 	if res.StatusCode != http.StatusOK {
-		return nil, ReadBodyAsError(res)
+		return ProvisionerKey{}, ReadBodyAsError(res)
 	}
-	var resp ProvisionerKeyTags
+	var resp ProvisionerKey
 	return resp, json.NewDecoder(res.Body).Decode(&resp)
 }
 

diff --git a/enterprise/coderd/coderd.go b/enterprise/coderd/coderd.go
@@ -339,6 +339,15 @@ func New(ctx context.Context, options *Options) (_ *API, err error) {
 				r.Get("/", api.groupByOrganization)
 			})
 		})
+		r.Route("/provisionerkeys", func(r chi.Router) {
+			r.Use(
+				httpmw.ExtractProvisionerDaemonAuthenticated(httpmw.ExtractProvisionerAuthConfig{
+					DB:       api.Database,
+					Optional: false,
+				}),
+			)
+			r.Get("/{provisionerkey}", api.getProvisionerKey)
+		})
 		r.Route("/organizations/{organization}/provisionerkeys", func(r chi.Router) {
 			r.Use(
 				apiKeyMiddleware,
@@ -352,7 +361,6 @@ func New(ctx context.Context, options *Options) (_ *API, err error) {
 				r.Use(
 					httpmw.ExtractProvisionerKeyParam(options.Database),
 				)
-				r.Get("/tags", api.fetchProvisionerKeyTags)
 				r.Delete("/", api.deleteProvisionerKey)
 			})
 		})

diff --git a/enterprise/coderd/provisionerkeys.go b/enterprise/coderd/provisionerkeys.go
@@ -200,35 +200,42 @@
 	httpapi.Write(ctx, rw, http.StatusNoContent, nil)
 }
 
-// @Summary Get provisioner key tags by ID
-// @ID get-provisioner-key-tags-by-id
-// @Security CoderSessionToken
+// @Summary Get provisioner key details
+// @ID get-provisioner-key
+// @Security CoderProvisionerDaemonKey
 // @Produce json
 // @Tags Enterprise
-// @Param organization path string true "Organization ID"
 // @Param provisionerkey path string true "Provisioner Key"
-// @Success 200 {object} codersdk.ProvisionerKeyTags
-// @Router /organizations/{organization}/provisionerkeys/{provisionerkey}/tags [get]
-func (*API) fetchProvisionerKeyTags(rw http.ResponseWriter, r *http.Request) {
-	var (
-		ctx = r.Context()
-		pk  = httpmw.ProvisionerKeyParam(r)
-	)
-
-	httpapi.Write(ctx, rw, http.StatusOK, codersdk.ProvisionerKeyTags(pk.Tags))
+// @Success 200 {object} codersdk.ProvisionerKey
+// @Router provisionerkeys/{provisionerkey} [get]
+func (*API) getProvisionerKey(rw http.ResponseWriter, r *http.Request) {
+	ctx := r.Context()
+
+	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)
+		return
+	}
+
+	httpapi.Write(ctx, rw, http.StatusOK, convertProvisionerKey(pk))
+}
+
+func convertProvisionerKey(dbKey database.ProvisionerKey) codersdk.ProvisionerKey {
+	return codersdk.ProvisionerKey{
+		ID:             dbKey.ID,
+		CreatedAt:      dbKey.CreatedAt,
+		OrganizationID: dbKey.OrganizationID,
+		Name:           dbKey.Name,
+		Tags:           codersdk.ProvisionerKeyTags(dbKey.Tags),
+		// HashedSecret - never include the access token in the API response
+	}
 }
 
 func convertProvisionerKeys(dbKeys []database.ProvisionerKey) []codersdk.ProvisionerKey {
 	keys := make([]codersdk.ProvisionerKey, 0, len(dbKeys))
 	for _, dbKey := range dbKeys {
-		keys = append(keys, codersdk.ProvisionerKey{
-			ID:             dbKey.ID,
-			CreatedAt:      dbKey.CreatedAt,
-			OrganizationID: dbKey.OrganizationID,
-			Name:           dbKey.Name,
-			Tags:           codersdk.ProvisionerKeyTags(dbKey.Tags),
-			// HashedSecret - never include the access token in the API response
-		})
+		keys = append(keys, convertProvisionerKey(dbKey))
 	}
 
 	slices.SortFunc(keys, func(key1, key2 codersdk.ProvisionerKey) int {

diff --git a/enterprise/coderd/provisionerkeys_test.go b/enterprise/coderd/provisionerkeys_test.go
@@ -134,12 +134,12 @@
 	require.ErrorContains(t, err, "reserved")
 }
 
-func TestProvisionerKeyTags(t *testing.T) {
+func TestProvisionerKey(t *testing.T) {
 	t.Parallel()
-	t.Run("GetTags", func(t *testing.T) {
+	t.Run("GetKey", func(t *testing.T) {
 		t.Parallel()
 
-		ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong*10)
+		ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitShort)
 		t.Cleanup(cancel)
 		dv := coderdtest.DeploymentValues(t)
 		client, owner := coderdenttest.New(t, &coderdenttest.Options{
@@ -153,18 +153,18 @@
 			},
 		})
 
-		//nolint:gocritic // Not the purpose of this test
-		_, err := client.CreateProvisionerKey(ctx, owner.OrganizationID, codersdk.CreateProvisionerKeyRequest{
-			Name: "key",
+		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)
 
-		tags, err := client.FetchProvisionerTagsByKey(ctx, owner.OrganizationID, "key")
+		_, err = client.GetProvisionerKey(ctx, key.Key)
 		require.NoError(t, err)
-		require.Equal(t, tags, codersdk.ProvisionerKeyTags{"key1": "value1", "key2": "value2"})
+		// require.Equal(t, tags, codersdk.ProvisionerKeyTags{"key1": "value1", "key2": "value2"})
 
-		_, err = client.FetchProvisionerTagsByKey(ctx, owner.OrganizationID, "invalid_key")
-		require.ErrorContains(t, err, "Resource not found")
+		erroneousPK, err := client.GetProvisionerKey(ctx, "abcdefghijklmnopqrstuvwxyz01234567890123456")
+		require.Empty(t, erroneousPK)
+		require.Error(t, err)
 	})
 }