feat: add tags to provisioner keys api

coder · f0ssel · Jul 25, 2024 · Jul 23, 2024 · Jul 23, 2024 · Jul 23, 2024
commit 2090d2aef380f11c93cb7382625f448f79fa4762
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/coderd/database/dbmem/dbmem.go b/coderd/database/dbmem/dbmem.go
@@ -6586,6 +6586,7 @@ func (q *FakeQuerier) InsertProvisionerKey(_ context.Context, arg database.Inser
 		OrganizationID: arg.OrganizationID,
 		Name:           strings.ToLower(arg.Name),
 		HashedSecret:   arg.HashedSecret,
+		Tags:           arg.Tags,
 	}
 	q.provisionerKeys = append(q.provisionerKeys, provisionerKey)
 
@@ -7276,13 +7277,7 @@ func (q *FakeQuerier) ListProvisionerKeysByOrganization(_ context.Context, organ
 	keys := make([]database.ProvisionerKey, 0)
 	for _, key := range q.provisionerKeys {
 		if key.OrganizationID == organizationID {
-			keys = append(keys, database.ProvisionerKey{
-				ID:             key.ID,
-				CreatedAt:      key.CreatedAt,
-				OrganizationID: key.OrganizationID,
-				Name:           key.Name,
-				HashedSecret:   key.HashedSecret,
-			})
+			keys = append(keys, key)
 		}
 	}
 

diff --git a/coderd/database/dump.sql b/coderd/database/dump.sql
diff --git a/coderd/database/migrations/000229_provisioner_key_tags.down.sql b/coderd/database/migrations/000229_provisioner_key_tags.down.sql
@@ -0,0 +1 @@
+ALTER TABLE provisioner_keys DROP COLUMN tags;
diff --git a/coderd/database/migrations/000229_provisioner_key_tags.up.sql b/coderd/database/migrations/000229_provisioner_key_tags.up.sql
@@ -0,0 +1,2 @@
+ALTER TABLE provisioner_keys ADD COLUMN tags jsonb DEFAULT '{}'::jsonb NOT NULL;
+ALTER TABLE provisioner_keys ALTER COLUMN tags DROP DEFAULT;
diff --git a/coderd/database/models.go b/coderd/database/models.go
diff --git a/coderd/database/queries.sql.go b/coderd/database/queries.sql.go
diff --git a/coderd/database/queries/provisionerkeys.sql b/coderd/database/queries/provisionerkeys.sql
@@ -5,10 +5,11 @@ INSERT INTO
         created_at,
         organization_id,
 		name,
-		hashed_secret
+		hashed_secret,
+        tags
 	)
 VALUES
-	($1, $2, $3, lower(@name), $4) RETURNING *;
+	($1, $2, $3, lower(@name), $4, $5) RETURNING *;
 
 -- name: GetProvisionerKeyByID :one
 SELECT

diff --git a/coderd/database/sqlc.yaml b/coderd/database/sqlc.yaml
@@ -44,6 +44,9 @@ sql:
           - column: "provisioner_daemons.tags"
             go_type:
               type: "StringMap"
+          - column: "provisioner_keys.tags"
+            go_type:
+              type: "StringMap"
           - column: "provisioner_jobs.tags"
             go_type:
               type: "StringMap"

diff --git a/coderd/provisionerkey/provisionerkey.go b/coderd/provisionerkey/provisionerkey.go
@@ -14,7 +14,7 @@ import (
 	"github.com/coder/coder/v2/cryptorand"
 )
 
-func New(organizationID uuid.UUID, name string) (database.InsertProvisionerKeyParams, string, error) {
+func New(organizationID uuid.UUID, name string, tags map[string]string) (database.InsertProvisionerKeyParams, string, error) {
 	id := uuid.New()
 	secret, err := cryptorand.HexString(64)
 	if err != nil {
@@ -23,12 +23,17 @@ func New(organizationID uuid.UUID, name string) (database.InsertProvisionerKeyPa
 	hashedSecret := HashSecret(secret)
 	token := fmt.Sprintf("%s:%s", id, secret)
 
+	if tags == nil {
+		tags = map[string]string{}
+	}
+
 	return database.InsertProvisionerKeyParams{
 		ID:             id,
 		CreatedAt:      dbtime.Now(),
 		OrganizationID: organizationID,
 		Name:           name,
 		HashedSecret:   hashedSecret,
+		Tags:           tags,
 	}, token, nil
 }
 

diff --git a/codersdk/provisionerdaemons.go b/codersdk/provisionerdaemons.go
@@ -279,10 +279,12 @@ type ProvisionerKey struct {
 	OrganizationID uuid.UUID `json:"organization" table:"organization_id" format:"uuid"`
 	Name           string    `json:"name" table:"name,default_sort"`
 	// HashedSecret - never include the access token in the API response
+	Tags map[string]string `json:"tags" table:"tags"`
 }
 
 type CreateProvisionerKeyRequest struct {
-	Name string `json:"name"`
+	Name string            `json:"name"`
+	Tags map[string]string `json:"tags"`
 }
 
 type CreateProvisionerKeyResponse struct {

diff --git a/docs/api/enterprise.md b/docs/api/enterprise.md
diff --git a/docs/api/schemas.md b/docs/api/schemas.md
diff --git a/enterprise/coderd/provisionerkeys.go b/enterprise/coderd/provisionerkeys.go
@@ -54,7 +54,7 @@ func (api *API) postProvisionerKey(rw http.ResponseWriter, r *http.Request) {
 		return
 	}
 
-	params, token, err := provisionerkey.New(organization.ID, req.Name)
+	params, token, err := provisionerkey.New(organization.ID, req.Name, req.Tags)
 	if err != nil {
 		httpapi.InternalServerError(rw, err)
 		return
@@ -143,6 +143,7 @@ func convertProvisionerKeys(dbKeys []database.ProvisionerKey) []codersdk.Provisi
 			OrganizationID: dbKey.OrganizationID,
 			Name:           dbKey.Name,
 			// HashedSecret - never include the access token in the API response
+			Tags: dbKey.Tags,
 		})
 	}
 	return keys

diff --git a/enterprise/coderd/provisionerkeys_test.go b/enterprise/coderd/provisionerkeys_test.go
@@ -69,9 +69,13 @@ func TestProvisionerKeys(t *testing.T) {
 	require.NoError(t, err, "org admin list provisioner keys")
 	require.Len(t, keys, 0, "org admin list provisioner keys")
 
+	tags := map[string]string{
+		"my": "way",
+	}
 	// org admin can create a provisioner key
 	_, err = orgAdmin.CreateProvisionerKey(ctx, owner.OrganizationID, codersdk.CreateProvisionerKeyRequest{
 		Name: "Key", // case insensitive
+		Tags: tags,
 	})
 	require.NoError(t, err, "org admin create provisioner key")
 
@@ -97,6 +101,8 @@ func TestProvisionerKeys(t *testing.T) {
 	keys, err = orgAdmin.ListProvisionerKeys(ctx, owner.OrganizationID)
 	require.NoError(t, err, "org admin list provisioner keys")
 	require.Len(t, keys, 1, "org admin list provisioner keys")
+	require.Equal(t, "key", keys[0].Name, "org admin list provisioner keys name matches")
+	require.EqualValues(t, tags, keys[0].Tags, "org admin list provisioner keys tags match")
 
 	// org admin can delete a provisioner key
 	err = orgAdmin.DeleteProvisionerKey(ctx, owner.OrganizationID, "key") // using lowercase here works

diff --git a/site/src/api/typesGenerated.ts b/site/src/api/typesGenerated.ts
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		ALTER TABLE provisioner_keys ADD COLUMN tags jsonb DEFAULT '{}'::jsonb NOT NULL;
		ALTER TABLE provisioner_keys ALTER COLUMN tags DROP DEFAULT;