feat(provisioners) - add endpoint to fetch tags associated to a key u…

…sing its id fix: change from database.StringMap to codersdk.ProvisionerKeyTags in endpoint response improve annotations for endpoint move logic to enterprise part generate new doc move logic to enterprise part generate doc
coder · defelmnq · Nov 25, 2024 · Nov 14, 2024 · Nov 14, 2024 · Nov 14, 2024
commit 995a04679eb42ccdf4c8b751770ce9b3535f56e0
diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go
diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json
diff --git a/codersdk/provisionerdaemons.go b/codersdk/provisionerdaemons.go
@@ -368,6 +368,24 @@ func (c *Client) ListProvisionerKeys(ctx context.Context, organizationID uuid.UU
 	return resp, json.NewDecoder(res.Body).Decode(&resp)
 }
 
+// GetProvisionTagsByKey returns the provisioner tags associated with the provisioner key.
+func (c *Client) GetProvisionTagsByKey(ctx context.Context, organizationID uuid.UUID, provisionerKey string) (ProvisionerKeyTags, error) {
+	res, err := c.Request(ctx, http.MethodGet,
+		fmt.Sprintf("/api/v2/organizations/%s/provisionerkeys/%s/tags", organizationID.String(), provisionerKey),
+		nil,
+	)
+	if err != nil {
+		return nil, xerrors.Errorf("make request: %w", err)
+	}
+	defer res.Body.Close()
+
+	if res.StatusCode != http.StatusOK {
+		return nil, ReadBodyAsError(res)
+	}
+	var resp ProvisionerKeyTags
+	return resp, json.NewDecoder(res.Body).Decode(&resp)
+}
+
 // ListProvisionerKeyDaemons lists all provisioner keys with their associated daemons for an organization.
 func (c *Client) ListProvisionerKeyDaemons(ctx context.Context, organizationID uuid.UUID) ([]ProvisionerKeyDaemons, error) {
 	res, err := c.Request(ctx, http.MethodGet,

diff --git a/docs/reference/api/enterprise.md b/docs/reference/api/enterprise.md
diff --git a/enterprise/coderd/coderd.go b/enterprise/coderd/coderd.go
@@ -352,6 +352,7 @@ 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,6 +200,23 @@
 	httpapi.Write(ctx, rw, http.StatusNoContent, nil)
 }
 
+// @Summary Get provisioner key tags by ID
+// @ID get-provisioner-key-tags-by-id
+// @Produce json
+// @Tags Enterprise
+// @Param organization path string true "Organization ID"
+// @Param provisionerkeyid path string true "Provisioner Key ID" format(uuid)
+// @Success 200 {object} codersdk.ProvisionerKeyTags
+// @Router /organizations/{organization}/provisionerkeys/{provisionerkeyid}/tags [get]
+func (api *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))
+}
+
 func convertProvisionerKeys(dbKeys []database.ProvisionerKey) []codersdk.ProvisionerKey {
 	keys := make([]codersdk.ProvisionerKey, 0, len(dbKeys))
 	for _, dbKey := range dbKeys {

diff --git a/enterprise/coderd/provisionerkeys_test.go b/enterprise/coderd/provisionerkeys_test.go
@@ -133,3 +133,38 @@
 	err = orgAdmin.DeleteProvisionerKey(ctx, owner.OrganizationID, codersdk.ProvisionerKeyNamePSK)
 	require.ErrorContains(t, err, "reserved")
 }
+
+func TestProvisionerKeyTags(t *testing.T) {
+	t.Parallel()
+	t.Run("GetTags", func(t *testing.T) {
+		t.Parallel()
+
+		ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong*10)
+		t.Cleanup(cancel)
+		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,
+				},
+			},
+		})
+
+		//nolint:gocritic // Not the purpose of this test
+		_, err := client.CreateProvisionerKey(ctx, owner.OrganizationID, codersdk.CreateProvisionerKeyRequest{
+			Name: "key",
+			Tags: map[string]string{"key1": "value1", "key2": "value2"},
+		})
+		require.NoError(t, err)
+
+		tags, err := client.GetProvisionTagsByKeyID(ctx, owner.OrganizationID, "key")
+		require.NoError(t, err)
+		require.Equal(t, tags, codersdk.ProvisionerKeyTags{"key1": "value1", "key2": "value2"})
+
+		err = client.DeleteProvisionerKey(ctx, owner.OrganizationID, "invalid_key")
+		require.ErrorContains(t, err, "Resource not found")
+	})
+}
-Original file line number
+Diff line change
@@ Expand Up @@
     				r.Use(
     					httpmw.ExtractProvisionerKeyParam(options.Database),
     				)
+    				r.Get("/tags", api.fetchProvisionerKeyTags)
     				r.Delete("/", api.deleteProvisionerKey)
     			})
     		})
@@ Expand Down @@