feat(provisioners) - add endpoint to fetch tags associated to a key using its id

defelmnq · defelmnq · commit f40cbf37c2fa · 2024-11-14T07:06:46.000+01:00
diff --git a/coderd/coderd.go b/coderd/coderd.go
@@ -1135,6 +1135,11 @@ func New(options *Options) *API {
 				})
 			})
 		})
+		r.Route("/provisionerkeys", func(r chi.Router) {
+			r.Route("/{provisionerkeyid}", func(r chi.Router) {
+				r.Get("/tags", api.getProvisionKeyTags)
+			})
+		})
 		r.Route("/workspaceagents", func(r chi.Router) {
 			r.Post("/azure-instance-identity", api.postWorkspaceAuthAzureInstanceIdentity)
 			r.Post("/aws-instance-identity", api.postWorkspaceAuthAWSInstanceIdentity)
diff --git a/coderd/provisionerkeys.go b/coderd/provisionerkeys.go
@@ -0,0 +1,42 @@
+package coderd
+
+import (
+	"net/http"
+
+	"github.com/go-chi/chi/v5"
+	"github.com/google/uuid"
+
+	"github.com/coder/coder/v2/coderd/httpapi"
+	"github.com/coder/coder/v2/codersdk"
+)
+
+// Returns tags from a provisioner key.
+// The purpose of this function is to return the provisioner tags
+// associated with the provisioner key using the ID.
+// GET /provisionerkeys/{provisionerkeyid}/tags
+func (api *API) getProvisionKeyTags(rw http.ResponseWriter, r *http.Request) {
+	var (
+		ctx   = r.Context()
+		keyID = chi.URLParam(r, "provisionerkeyid")
+	)
+
+	parsedKeyID, err := uuid.Parse(keyID)
+	if err != nil {
+		httpapi.Write(ctx, rw, http.StatusBadRequest, codersdk.Response{
+			Message: "Invalid provisioner key.",
+			Detail:  err.Error(),
+		})
+		return
+	}
+
+	key, err := api.Database.GetProvisionerKeyByID(ctx, parsedKeyID)
+	if err != nil {
+		httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{
+			Message: "Internal error fetching provisioner tags.",
+			Detail:  err.Error(),
+		})
+		return
+	}
+
+	httpapi.Write(ctx, rw, http.StatusOK, key.Tags)
+}
diff --git a/coderd/provisionerkeys_test.go b/coderd/provisionerkeys_test.go
@@ -0,0 +1,48 @@
+package coderd_test
+
+import (
+	"context"
+	"testing"
+
+	"github.com/google/uuid"
+	"github.com/stretchr/testify/require"
+
+	"github.com/coder/coder/v2/coderd/coderdtest"
+	"github.com/coder/coder/v2/codersdk"
+	"github.com/coder/coder/v2/testutil"
+)
+
+func TestProvisionerKeyTags(t *testing.T) {
+	t.Parallel()
+	t.Run("GetTags", func(t *testing.T) {
+		t.Parallel()
+
+		ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitShort)
+		defer cancel()
+
+		client := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerDaemon: true})
+		user := coderdtest.CreateFirstUser(t, client)
+
+		key, err := client.CreateProvisionerKey(ctx, user.OrganizationID, codersdk.CreateProvisionerKeyRequest{
+			Tags: map[string]string{"key1": "value1", "key2": "value2"},
+		})
+		require.NoError(t, err)
+
+		keyID, err := uuid.Parse(key.Key)
+		require.NoError(t, err)
+
+		tags, err := client.GetProvisionTagsByKeyID(ctx, keyID)
+		require.NoError(t, err)
+		require.Equal(t, tags, codersdk.ProvisionerKeyTags{"key1": "value1", "key2": "value2"})
+	})
+
+	t.Run("InvalidKeyID", func(t *testing.T) {
+		t.Parallel()
+		ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitShort)
+		defer cancel()
+
+		client := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerDaemon: true})
+		_, err := client.GetProvisionTagsByKeyID(ctx, uuid.MustParse("00000000-0000-0000-0000-000000000000"))
+		require.Error(t, err)
+	})
+}
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)
 }
 
+// GetProvisionTagsByKeyID returns the provisioner tags associated with the provisioner key ID.
+func (c *Client) GetProvisionTagsByKeyID(ctx context.Context, provisionerKeyID uuid.UUID) (ProvisionerKeyTags, error) {
+	res, err := c.Request(ctx, http.MethodGet,
+		fmt.Sprintf("/api/v2/provisionerkeys/%s/tags", provisionerKeyID.String()),
+		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,
