shishantbiswas/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-06-02 20:48:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(coderd): add support for presets to the coder API (#16526)

Browse Source 
This pull request builds on the existing migrations and queries to add
support for presets to the coder API.
This commit is contained in:
Sas Swart
2025-02-12 14:41:14 +02:00
committed by GitHub
parent ec50a35c08
commit 71cbf735e5
18 changed files with 447 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Makefile
+1 -1
View File
@@ -809,7 +809,7 @@ provisioner/terraform/testdata/version:
.PHONY: provisioner/terraform/testdata/version
test:
$(GIT_FLAGS) gotestsum --format standard-quiet -- -v -short -count=1 ./...
$(GIT_FLAGS) gotestsum --format standard-quiet -- -v -short -count=1 ./... $(if $(RUN),-run $(RUN))
.PHONY: test
test-cli:
coderd/apidoc/docs.go
Generated
+66
View File
@@ -5605,6 +5605,44 @@ const docTemplate = `{
}
}
},
"/templateversions/{templateversion}/presets": {
"get": {
"security": [
{
"CoderSessionToken": []
}
],
"produces": [
"application/json"
],
"tags": [
"Templates"
],
"summary": "Get template version presets",
"operationId": "get-template-version-presets",
"parameters": [
{
"type": "string",
"format": "uuid",
"description": "Template version ID",
"name": "templateversion",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/codersdk.Preset"
}
}
}
}
}
},
"/templateversions/{templateversion}/resources": {
"get": {
"security": [
@@ -12967,6 +13005,34 @@ const docTemplate = `{
}
}
},
"codersdk.Preset": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"parameters": {
"type": "array",
"items": {
"$ref": "#/definitions/codersdk.PresetParameter"
}
}
}
},
"codersdk.PresetParameter": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"codersdk.PrometheusConfig": {
"type": "object",
"properties": {
coderd/apidoc/swagger.json
Generated
+62
View File
@@ -4951,6 +4951,40 @@
}
}
},
"/templateversions/{templateversion}/presets": {
"get": {
"security": [
{
"CoderSessionToken": []
}
],
"produces": ["application/json"],
"tags": ["Templates"],
"summary": "Get template version presets",
"operationId": "get-template-version-presets",
"parameters": [
{
"type": "string",
"format": "uuid",
"description": "Template version ID",
"name": "templateversion",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/codersdk.Preset"
}
}
}
}
}
},
"/templateversions/{templateversion}/resources": {
"get": {
"security": [
@@ -11700,6 +11734,34 @@
}
}
},
"codersdk.Preset": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"parameters": {
"type": "array",
"items": {
"$ref": "#/definitions/codersdk.PresetParameter"
}
}
}
},
"codersdk.PresetParameter": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"codersdk.PrometheusConfig": {
"type": "object",
"properties": {
coderd/coderd.go
+1
View File
@@ -1058,6 +1058,7 @@ func New(options *Options) *API {
r.Get("/rich-parameters", api.templateVersionRichParameters)
r.Get("/external-auth", api.templateVersionExternalAuth)
r.Get("/variables", api.templateVersionVariables)
r.Get("/presets", api.templateVersionPresets)
r.Get("/resources", api.templateVersionResources)
r.Get("/logs", api.templateVersionLogs)
r.Route("/dry-run", func(r chi.Router) {
coderd/database/dbauthz/dbauthz_test.go
-3
View File
@@ -886,7 +886,6 @@ func (s *MethodTestSuite) TestOrganization() {
JobID: job.ID,
})
insertPresetParams := database.InsertPresetParams{
ID: uuid.New(),
TemplateVersionID: workspaceBuild.TemplateVersionID,
Name: "test",
}
@@ -3817,13 +3816,11 @@ func (s *MethodTestSuite) TestSystemFunctions() {
CreatedBy: user.ID,
})
preset, err := db.InsertPreset(ctx, database.InsertPresetParams{
ID: uuid.New(),
TemplateVersionID: templateVersion.ID,
Name: "test",
})
require.NoError(s.T(), err)
_, err = db.InsertPresetParameters(ctx, database.InsertPresetParametersParams{
ID: uuid.New(),
TemplateVersionPresetID: preset.ID,
Names: []string{"test"},
Values: []string{"test"},
coderd/database/dbmem/dbmem.go
+1
View File
@@ -8149,6 +8149,7 @@ func (q *FakeQuerier) InsertPreset(_ context.Context, arg database.InsertPresetP
q.mutex.Lock()
defer q.mutex.Unlock()
//nolint:gosimple // arg needs to keep its type for interface reasons and that type is not appropriate for preset below.
preset := database.TemplateVersionPreset{
ID: uuid.New(),
TemplateVersionID: arg.TemplateVersionID,
coderd/database/dump.sql
Generated
+2 -2
View File
@@ -1266,14 +1266,14 @@ COMMENT ON COLUMN template_version_parameters.display_order IS 'Specifies the or
COMMENT ON COLUMN template_version_parameters.ephemeral IS 'The value of an ephemeral parameter will not be preserved between consecutive workspace builds.';
CREATE TABLE template_version_preset_parameters (
id uuid NOT NULL,
id uuid DEFAULT gen_random_uuid() NOT NULL,
template_version_preset_id uuid NOT NULL,
name text NOT NULL,
value text NOT NULL
);
CREATE TABLE template_version_presets (
id uuid NOT NULL,
id uuid DEFAULT gen_random_uuid() NOT NULL,
template_version_id uuid NOT NULL,
name text NOT NULL,
created_at timestamp with time zone DEFAULT CURRENT_TIMESTAMP NOT NULL
coderd/database/migrations/000292_generate_default_preset_parameter_ids.down.sql
+5
View File
@@ -0,0 +1,5 @@
ALTER TABLE template_version_presets
ALTER COLUMN id DROP DEFAULT;
ALTER TABLE template_version_preset_parameters
ALTER COLUMN id DROP DEFAULT;
coderd/database/migrations/000292_generate_default_preset_parameter_ids.up.sql
+5
View File
@@ -0,0 +1,5 @@
ALTER TABLE template_version_presets
ALTER COLUMN id SET DEFAULT gen_random_uuid();
ALTER TABLE template_version_preset_parameters
ALTER COLUMN id SET DEFAULT gen_random_uuid();
coderd/database/queries.sql.go
+7 -20
View File
@@ -5494,25 +5494,19 @@ func (q *sqlQuerier) GetPresetsByTemplateVersionID(ctx context.Context, template
const insertPreset = `-- name: InsertPreset :one
INSERT INTO
template_version_presets (id, template_version_id, name, created_at)
template_version_presets (template_version_id, name, created_at)
VALUES
($1, $2, $3, $4) RETURNING id, template_version_id, name, created_at
($1, $2, $3) RETURNING id, template_version_id, name, created_at
`
type InsertPresetParams struct {
ID uuid.UUID `db:"id" json:"id"`
TemplateVersionID uuid.UUID `db:"template_version_id" json:"template_version_id"`
Name string `db:"name" json:"name"`
CreatedAt time.Time `db:"created_at" json:"created_at"`
}
func (q *sqlQuerier) InsertPreset(ctx context.Context, arg InsertPresetParams) (TemplateVersionPreset, error) {
row := q.db.QueryRowContext(ctx, insertPreset,
arg.ID,
arg.TemplateVersionID,
arg.Name,
arg.CreatedAt,
)
row := q.db.QueryRowContext(ctx, insertPreset, arg.TemplateVersionID, arg.Name, arg.CreatedAt)
var i TemplateVersionPreset
err := row.Scan(
&i.ID,
@@ -5525,29 +5519,22 @@ func (q *sqlQuerier) InsertPreset(ctx context.Context, arg InsertPresetParams) (
const insertPresetParameters = `-- name: InsertPresetParameters :many
INSERT INTO
template_version_preset_parameters (id, template_version_preset_id, name, value)
template_version_preset_parameters (template_version_preset_id, name, value)
SELECT
$1,
$2,
unnest($3 :: TEXT[]),
unnest($4 :: TEXT[])
unnest($2 :: TEXT[]),
unnest($3 :: TEXT[])
RETURNING id, template_version_preset_id, name, value
`
type InsertPresetParametersParams struct {
ID uuid.UUID `db:"id" json:"id"`
TemplateVersionPresetID uuid.UUID `db:"template_version_preset_id" json:"template_version_preset_id"`
Names []string `db:"names" json:"names"`
Values []string `db:"values" json:"values"`
}
func (q *sqlQuerier) InsertPresetParameters(ctx context.Context, arg InsertPresetParametersParams) ([]TemplateVersionPresetParameter, error) {
rows, err := q.db.QueryContext(ctx, insertPresetParameters,
arg.ID,
arg.TemplateVersionPresetID,
pq.Array(arg.Names),
pq.Array(arg.Values),
)
rows, err := q.db.QueryContext(ctx, insertPresetParameters, arg.TemplateVersionPresetID, pq.Array(arg.Names), pq.Array(arg.Values))
if err != nil {
return nil, err
}
coderd/database/queries/presets.sql
+3 -4
View File
@@ -1,14 +1,13 @@
-- name: InsertPreset :one
INSERT INTO
template_version_presets (id, template_version_id, name, created_at)
template_version_presets (template_version_id, name, created_at)
VALUES
(@id, @template_version_id, @name, @created_at) RETURNING *;
(@template_version_id, @name, @created_at) RETURNING *;
-- name: InsertPresetParameters :many
INSERT INTO
template_version_preset_parameters (id, template_version_preset_id, name, value)
template_version_preset_parameters (template_version_preset_id, name, value)
SELECT
@id,
@template_version_preset_id,
unnest(@names :: TEXT[]),
unnest(@values :: TEXT[])
coderd/presets.go
+57
View File
@@ -0,0 +1,57 @@
package coderd
import (
"net/http"
"github.com/coder/coder/v2/coderd/httpapi"
"github.com/coder/coder/v2/coderd/httpmw"
"github.com/coder/coder/v2/codersdk"
)
// @Summary Get template version presets
// @ID get-template-version-presets
// @Security CoderSessionToken
// @Produce json
// @Tags Templates
// @Param templateversion path string true "Template version ID" format(uuid)
// @Success 200 {array} codersdk.Preset
// @Router /templateversions/{templateversion}/presets [get]
func (api *API) templateVersionPresets(rw http.ResponseWriter, r *http.Request) {
ctx := r.Context()
templateVersion := httpmw.TemplateVersionParam(r)
presets, err := api.Database.GetPresetsByTemplateVersionID(ctx, templateVersion.ID)
if err != nil {
httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{
Message: "Internal error fetching template version presets.",
Detail: err.Error(),
})
return
}
presetParams, err := api.Database.GetPresetParametersByTemplateVersionID(ctx, templateVersion.ID)
if err != nil {
httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{
Message: "Internal error fetching template version presets.",
Detail: err.Error(),
})
return
}
var res []codersdk.Preset
for _, preset := range presets {
sdkPreset := codersdk.Preset{
ID: preset.ID,
Name: preset.Name,
}
for _, presetParam := range presetParams {
sdkPreset.Parameters = append(sdkPreset.Parameters, codersdk.PresetParameter{
Name: presetParam.Name,
Value: presetParam.Value,
})
}
res = append(res, sdkPreset)
}
httpapi.Write(ctx, rw, http.StatusOK, res)
}
coderd/presets_test.go
+76
View File
@@ -0,0 +1,76 @@
package coderd_test
import (
"testing"
"github.com/stretchr/testify/require"
"github.com/coder/coder/v2/coderd/coderdtest"
"github.com/coder/coder/v2/coderd/database"
"github.com/coder/coder/v2/coderd/database/dbauthz"
"github.com/coder/coder/v2/coderd/httpmw"
"github.com/coder/coder/v2/coderd/rbac"
"github.com/coder/coder/v2/codersdk"
"github.com/coder/coder/v2/testutil"
)
func TestTemplateVersionPresets(t *testing.T) {
// TODO (sasswart): Test case: what if a user tries to read presets or preset parameters from a different org?
t.Parallel()
givenPreset := codersdk.Preset{
Name: "My Preset",
Parameters: []codersdk.PresetParameter{
{
Name: "preset_param1",
Value: "A1B2C3",
},
{
Name: "preset_param2",
Value: "D4E5F6",
},
},
}
ctx := testutil.Context(t, testutil.WaitShort)
client, db := coderdtest.NewWithDatabase(t, &coderdtest.Options{IncludeProvisionerDaemon: true})
user := coderdtest.CreateFirstUser(t, client)
version := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, nil)
// nolint:gocritic // This is a test
provisionerCtx := dbauthz.AsProvisionerd(ctx)
dbPreset, err := db.InsertPreset(provisionerCtx, database.InsertPresetParams{
Name: givenPreset.Name,
TemplateVersionID: version.ID,
})
require.NoError(t, err)
var presetParameterNames []string
var presetParameterValues []string
for _, presetParameter := range givenPreset.Parameters {
presetParameterNames = append(presetParameterNames, presetParameter.Name)
presetParameterValues = append(presetParameterValues, presetParameter.Value)
}
_, err = db.InsertPresetParameters(provisionerCtx, database.InsertPresetParametersParams{
TemplateVersionPresetID: dbPreset.ID,
Names: presetParameterNames,
Values: presetParameterValues,
})
require.NoError(t, err)
userSubject, _, err := httpmw.UserRBACSubject(ctx, db, user.UserID, rbac.ScopeAll)
require.NoError(t, err)
userCtx := dbauthz.As(ctx, userSubject)
gotPresets, err := client.TemplateVersionPresets(userCtx, version.ID)
require.NoError(t, err)
require.Equal(t, 1, len(gotPresets))
require.Equal(t, givenPreset.Name, gotPresets[0].Name)
for _, presetParameter := range givenPreset.Parameters {
require.Contains(t, gotPresets[0].Parameters, presetParameter)
}
}
coderd/wsbuilder/wsbuilder.go
+14 -17
View File
@@ -363,23 +363,20 @@ func (b *Builder) buildTx(authFunc func(action policy.Action, object rbac.Object
var workspaceBuild database.WorkspaceBuild
err = b.store.InTx(func(store database.Store) error {
err = store.InsertWorkspaceBuild(b.ctx, database.InsertWorkspaceBuildParams{
ID: workspaceBuildID,
CreatedAt: now,
UpdatedAt: now,
WorkspaceID: b.workspace.ID,
TemplateVersionID: templateVersionID,
BuildNumber: buildNum,
ProvisionerState: state,
InitiatorID: b.initiator,
Transition: b.trans,
JobID: provisionerJob.ID,
Reason: b.reason,
Deadline: time.Time{}, // set by provisioner upon completion
MaxDeadline: time.Time{}, // set by provisioner upon completion
TemplateVersionPresetID: uuid.NullUUID{
UUID: uuid.Nil,
Valid: false,
},
ID: workspaceBuildID,
CreatedAt: now,
UpdatedAt: now,
WorkspaceID: b.workspace.ID,
TemplateVersionID: templateVersionID,
BuildNumber: buildNum,
ProvisionerState: state,
InitiatorID: b.initiator,
Transition: b.trans,
JobID: provisionerJob.ID,
Reason: b.reason,
Deadline: time.Time{}, // set by provisioner upon completion
MaxDeadline: time.Time{}, // set by provisioner upon completion
TemplateVersionPresetID: uuid.NullUUID{}, // TODO (sasswart): add this in from the caller
})
if err != nil {
code := http.StatusInternalServerError
codersdk/presets.go
+36
View File
@@ -0,0 +1,36 @@
package codersdk
import (
"context"
"encoding/json"
"fmt"
"net/http"
"github.com/google/uuid"
"golang.org/x/xerrors"
)
type Preset struct {
ID uuid.UUID
Name string
Parameters []PresetParameter
}
type PresetParameter struct {
Name string
Value string
}
// TemplateVersionPresets returns the presets associated with a template version.
func (c *Client) TemplateVersionPresets(ctx context.Context, templateVersionID uuid.UUID) ([]Preset, error) {
res, err := c.Request(ctx, http.MethodGet, fmt.Sprintf("/api/v2/templateversions/%s/presets", templateVersionID), nil)
if err != nil {
return nil, xerrors.Errorf("do request: %w", err)
}
defer res.Body.Close()
if res.StatusCode != http.StatusOK {
return nil, ReadBodyAsError(res)
}
var presets []Preset
return presets, json.NewDecoder(res.Body).Decode(&presets)
}
docs/reference/api/schemas.md
Generated
+39
View File
@@ -4427,6 +4427,45 @@ Git clone makes use of this by parsing the URL from: 'Username for "https://gith
| `address` | [serpent.HostPort](#serpenthostport) | false | | |
| `enable` | boolean | false | | |
## codersdk.Preset
```json
{
"id": "string",
"name": "string",
"parameters": [
{
"name": "string",
"value": "string"
}
]
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
|--------------|---------------------------------------------------------------|----------|--------------|-------------|
| `id` | string | false | | |
| `name` | string | false | | |
| `parameters` | array of [codersdk.PresetParameter](#codersdkpresetparameter) | false | | |
## codersdk.PresetParameter
```json
{
"name": "string",
"value": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
|---------|--------|----------|--------------|-------------|
| `name` | string | false | | |
| `value` | string | false | | |
## codersdk.PrometheusConfig
```json
docs/reference/api/templates.md
Generated
+59
View File
@@ -2672,6 +2672,65 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/p
To perform this operation, you must be authenticated. [Learn more](authentication.md).
## Get template version presets
### Code samples
```shell
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/presets \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
```
`GET /templateversions/{templateversion}/presets`
### Parameters
| Name | In | Type | Required | Description |
|-------------------|------|--------------|----------|---------------------|
| `templateversion` | path | string(uuid) | true | Template version ID |
### Example responses
> 200 Response
```json
[
{
"id": "string",
"name": "string",
"parameters": [
{
"name": "string",
"value": "string"
}
]
}
]
```
### Responses
| Status | Meaning | Description | Schema |
|--------|---------------------------------------------------------|-------------|-------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.Preset](schemas.md#codersdkpreset) |
<h3 id="get-template-version-presets-responseschema">Response Schema</h3>
Status Code **200**
| Name | Type | Required | Restrictions | Description |
|----------------|--------|----------|--------------|-------------|
| `[array item]` | array | false | | |
| `» id` | string | false | | |
| `» name` | string | false | | |
| `» parameters` | array | false | | |
| `»» name` | string | false | | |
| `»» value` | string | false | | |
To perform this operation, you must be authenticated. [Learn more](authentication.md).
## Get resources by template version
### Code samples
site/src/api/typesGenerated.ts
Generated
+13
View File
@@ -1550,6 +1550,19 @@ export interface PprofConfig {
readonly address: string;
}
// From codersdk/presets.go
export interface Preset {
readonly ID: string;
readonly Name: string;
readonly Parameters: readonly PresetParameter[];
}
// From codersdk/presets.go
export interface PresetParameter {
readonly Name: string;
readonly Value: string;
}
// From codersdk/deployment.go
export interface PrometheusConfig {
readonly enable: boolean;