Skip to content

Commit 0ee6dc0

Browse files
ethanndicksonethanndickson
authored
chore: add missing template data source fields (#79)
1 parent 3bfb793 commit 0ee6dc0

File tree

6 files changed

+161
-10
lines changed

6 files changed

+161
-10
lines changed

‎.gitignore

+7
Original file line numberDiff line numberDiff line change
@@ -39,3 +39,10 @@ terraform-provider-coderd
3939
integration/integration.tfrc
4040

4141
*.tfstate
42+
43+
# Local .terraform directories
44+
**/.terraform/*
45+
46+
47+
# Ignore transient lock info files created by terraform apply
48+
.terraform.tfstate.lock.info

‎docs/data-sources/template.md

+42
Original file line numberDiff line numberDiff line change
@@ -47,12 +47,15 @@ resource "coderd_template" "debian-main" {
4747

4848
### Read-Only
4949

50+
- `acl` (Attributes) (Enterprise) Access control list for the template. (see [below for nested schema](#nestedatt--acl))
5051
- `active_user_count` (Number) Number of active users using the template.
5152
- `active_version_id` (String) ID of the active version of the template.
5253
- `activity_bump_ms` (Number) Duration to bump the deadline of a workspace when it receives activity.
5354
- `allow_user_autostart` (Boolean) Whether users can autostart workspaces created from the template.
5455
- `allow_user_autostop` (Boolean) Whether users can customize autostop behavior for workspaces created from the template.
5556
- `allow_user_cancel_workspace_jobs` (Boolean) Whether users can cancel jobs in workspaces created from the template.
57+
- `auto_start_permitted_days_of_week` (Set of String) List of days of the week in which autostart is allowed to happen, for all workspaces created from this template. Defaults to all days. If no days are specified, autostart is not allowed.
58+
- `auto_stop_requirement` (Attributes) The auto-stop requirement for all workspaces created from this template. (see [below for nested schema](#nestedatt--auto_stop_requirement))
5659
- `created_at` (Number) Unix timestamp of when the template was created.
5760
- `created_by_user_id` (String) ID of the user who created the template.
5861
- `default_ttl_ms` (Number) Default time-to-live for workspaces created from the template.
@@ -62,7 +65,46 @@ resource "coderd_template" "debian-main" {
6265
- `display_name` (String) Display name of the template.
6366
- `failure_ttl_ms` (Number) Automatic cleanup TTL for failed workspace builds.
6467
- `icon` (String) URL of the template's icon.
68+
- `max_port_share_level` (String) The maximum port share level for workspaces created from the template.
6569
- `require_active_version` (Boolean) Whether workspaces created from the template must be up-to-date on the latest active version.
6670
- `time_til_dormant_autodelete_ms` (Number) Duration of inactivity after the workspace becomes dormant before a workspace is automatically deleted.
6771
- `time_til_dormant_ms` (Number) Duration of inactivity before a workspace is considered dormant.
6872
- `updated_at` (Number) Unix timestamp of when the template was last updated.
73+
74+
<a id="nestedatt--acl"></a>
75+
### Nested Schema for `acl`
76+
77+
Read-Only:
78+
79+
- `groups` (Attributes Set) (see [below for nested schema](#nestedatt--acl--groups))
80+
- `users` (Attributes Set) (see [below for nested schema](#nestedatt--acl--users))
81+
82+
<a id="nestedatt--acl--groups"></a>
83+
### Nested Schema for `acl.groups`
84+
85+
Read-Only:
86+
87+
- `id` (String)
88+
- `role` (String)
89+
90+
91+
<a id="nestedatt--acl--users"></a>
92+
### Nested Schema for `acl.users`
93+
94+
Read-Only:
95+
96+
- `id` (String)
97+
- `role` (String)
98+
99+
100+
101+
<a id="nestedatt--auto_stop_requirement"></a>
102+
### Nested Schema for `auto_stop_requirement`
103+
104+
Optional:
105+
106+
- `weeks` (Number) Weeks is the number of weeks between required restarts. Weeks are synced across all workspaces (and Coder deployments) using modulo math on a hardcoded epoch week of January 2nd, 2023 (the first Monday of 2023). Values of 0 or 1 indicate weekly restarts. Values of 2 indicate fortnightly restarts, etc.
107+
108+
Read-Only:
109+
110+
- `days_of_week` (Set of String) List of days of the week on which restarts are required. Restarts happen within the user's quiet hours (in their configured timezone). If no days are specified, restarts are not required.

‎docs/resources/template.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ resource "coderd_template" "ubuntu-main" {
6969
- `auto_start_permitted_days_of_week` (Set of String) (Enterprise) List of days of the week in which autostart is allowed to happen, for all workspaces created from this template. Defaults to all days. If no days are specified, autostart is not allowed.
7070
- `auto_stop_requirement` (Attributes) (Enterprise) The auto-stop requirement for all workspaces created from this template. (see [below for nested schema](#nestedatt--auto_stop_requirement))
7171
- `default_ttl_ms` (Number) The default time-to-live for all workspaces created from this template, in milliseconds.
72-
- `deprecation_message` (String) If set, the template will be marked as deprecated with the provided message and users will be blocked from creating new workspaces from it.
72+
- `deprecation_message` (String) If set, the template will be marked as deprecated with the provided message and users will be blocked from creating new workspaces from it. Does nothing if set when the resource is created.
7373
- `description` (String) A description of the template.
7474
- `display_name` (String) The display name of the template. Defaults to the template name.
7575
- `failure_ttl_ms` (Number) (Enterprise) The max lifetime before Coder stops all resources for failed workspaces created from this template, in milliseconds.

‎internal/provider/template_data_source.go

+84-7
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ import (
77
"github.com/coder/coder/v2/codersdk"
88
"github.com/google/uuid"
99
"github.com/hashicorp/terraform-plugin-framework-validators/stringvalidator"
10+
"github.com/hashicorp/terraform-plugin-framework/attr"
1011
"github.com/hashicorp/terraform-plugin-framework/datasource"
1112
"github.com/hashicorp/terraform-plugin-framework/datasource/schema"
1213
"github.com/hashicorp/terraform-plugin-framework/path"
@@ -42,10 +43,10 @@ type TemplateDataSourceModel struct {
4243
DeprecationMessage types.String `tfsdk:"deprecation_message"`
4344
Icon types.String `tfsdk:"icon"`
4445

45-
DefaultTTLMillis types.Int64 `tfsdk:"default_ttl_ms"`
46-
ActivityBumpMillis types.Int64 `tfsdk:"activity_bump_ms"`
47-
// TODO: AutostopRequirement
48-
// TODO: AutostartRequirement
46+
DefaultTTLMillis types.Int64 `tfsdk:"default_ttl_ms"`
47+
ActivityBumpMillis types.Int64 `tfsdk:"activity_bump_ms"`
48+
AutostopRequirement types.Object `tfsdk:"auto_stop_requirement"`
49+
AutostartPermittedDaysOfWeek types.Set `tfsdk:"auto_start_permitted_days_of_week"`
4950

5051
AllowUserAutostart types.Bool `tfsdk:"allow_user_autostart"`
5152
AllowUserAutostop types.Bool `tfsdk:"allow_user_autostop"`
@@ -55,14 +56,14 @@ type TemplateDataSourceModel struct {
5556
TimeTilDormantMillis types.Int64 `tfsdk:"time_til_dormant_ms"`
5657
TimeTilDormantAutoDeleteMillis types.Int64 `tfsdk:"time_til_dormant_autodelete_ms"`
5758

58-
RequireActiveVersion types.Bool `tfsdk:"require_active_version"`
59-
// TODO: MaxPortShareLevel
59+
RequireActiveVersion types.Bool `tfsdk:"require_active_version"`
60+
MaxPortShareLevel types.String `tfsdk:"max_port_share_level"`
6061

6162
CreatedByUserID UUID `tfsdk:"created_by_user_id"`
6263
CreatedAt types.Int64 `tfsdk:"created_at"` // Unix timestamp
6364
UpdatedAt types.Int64 `tfsdk:"updated_at"` // Unix timestamp
6465

65-
// TODO: ACL-related stuff
66+
ACL types.Object `tfsdk:"acl"`
6667
}
6768

6869
func (d *TemplateDataSource) Metadata(ctx context.Context, req datasource.MetadataRequest, resp *datasource.MetadataResponse) {
@@ -134,6 +135,27 @@ func (d *TemplateDataSource) Schema(ctx context.Context, req datasource.SchemaRe
134135
MarkdownDescription: "Duration to bump the deadline of a workspace when it receives activity.",
135136
Computed: true,
136137
},
138+
"auto_stop_requirement": schema.SingleNestedAttribute{
139+
MarkdownDescription: "The auto-stop requirement for all workspaces created from this template.",
140+
Computed: true,
141+
Attributes: map[string]schema.Attribute{
142+
"days_of_week": schema.SetAttribute{
143+
MarkdownDescription: "List of days of the week on which restarts are required. Restarts happen within the user's quiet hours (in their configured timezone). If no days are specified, restarts are not required.",
144+
Computed: true,
145+
ElementType: types.StringType,
146+
},
147+
"weeks": schema.Int64Attribute{
148+
MarkdownDescription: "Weeks is the number of weeks between required restarts. Weeks are synced across all workspaces (and Coder deployments) using modulo math on a hardcoded epoch week of January 2nd, 2023 (the first Monday of 2023). Values of 0 or 1 indicate weekly restarts. Values of 2 indicate fortnightly restarts, etc.",
149+
Optional: true,
150+
Computed: true,
151+
},
152+
},
153+
},
154+
"auto_start_permitted_days_of_week": schema.SetAttribute{
155+
MarkdownDescription: "List of days of the week in which autostart is allowed to happen, for all workspaces created from this template. Defaults to all days. If no days are specified, autostart is not allowed.",
156+
Computed: true,
157+
ElementType: types.StringType,
158+
},
137159
"allow_user_autostart": schema.BoolAttribute{
138160
MarkdownDescription: "Whether users can autostart workspaces created from the template.",
139161
Computed: true,
@@ -162,6 +184,10 @@ func (d *TemplateDataSource) Schema(ctx context.Context, req datasource.SchemaRe
162184
MarkdownDescription: "Whether workspaces created from the template must be up-to-date on the latest active version.",
163185
Computed: true,
164186
},
187+
"max_port_share_level": schema.StringAttribute{
188+
MarkdownDescription: "The maximum port share level for workspaces created from the template.",
189+
Computed: true,
190+
},
165191
"created_by_user_id": schema.StringAttribute{
166192
MarkdownDescription: "ID of the user who created the template.",
167193
CustomType: UUIDType,
@@ -175,6 +201,14 @@ func (d *TemplateDataSource) Schema(ctx context.Context, req datasource.SchemaRe
175201
MarkdownDescription: "Unix timestamp of when the template was last updated.",
176202
Computed: true,
177203
},
204+
"acl": schema.SingleNestedAttribute{
205+
MarkdownDescription: "(Enterprise) Access control list for the template.",
206+
Computed: true,
207+
Attributes: map[string]schema.Attribute{
208+
"users": computedPermissionAttribute,
209+
"groups": computedPermissionAttribute,
210+
},
211+
},
178212
},
179213
}
180214
}
@@ -244,6 +278,33 @@ func (d *TemplateDataSource) Read(ctx context.Context, req datasource.ReadReques
244278
return
245279
}
246280

281+
acl, err := client.TemplateACL(ctx, template.ID)
282+
if err != nil {
283+
resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Failed to get template ACL: %s", err))
284+
return
285+
}
286+
tfACL := convertResponseToACL(acl)
287+
aclObj, diag := types.ObjectValueFrom(ctx, aclTypeAttr, tfACL)
288+
if diag.HasError() {
289+
resp.Diagnostics.Append(diag...)
290+
return
291+
}
292+
293+
asrObj, diag := types.ObjectValueFrom(ctx, autostopRequirementTypeAttr, AutostopRequirement{
294+
DaysOfWeek: template.AutostopRequirement.DaysOfWeek,
295+
Weeks: template.AutostopRequirement.Weeks,
296+
})
297+
resp.Diagnostics.Append(diag...)
298+
if resp.Diagnostics.HasError() {
299+
return
300+
}
301+
autoStartDays := make([]attr.Value, 0, len(template.AutostartRequirement.DaysOfWeek))
302+
for _, day := range template.AutostartRequirement.DaysOfWeek {
303+
autoStartDays = append(autoStartDays, types.StringValue(day))
304+
}
305+
data.ACL = aclObj
306+
data.AutostartPermittedDaysOfWeek = types.SetValueMust(types.StringType, autoStartDays)
307+
data.AutostopRequirement = asrObj
247308
data.OrganizationID = UUIDValue(template.OrganizationID)
248309
data.ID = UUIDValue(template.ID)
249310
data.Name = types.StringValue(template.Name)
@@ -263,10 +324,26 @@ func (d *TemplateDataSource) Read(ctx context.Context, req datasource.ReadReques
263324
data.TimeTilDormantMillis = types.Int64Value(template.TimeTilDormantMillis)
264325
data.TimeTilDormantAutoDeleteMillis = types.Int64Value(template.TimeTilDormantAutoDeleteMillis)
265326
data.RequireActiveVersion = types.BoolValue(template.RequireActiveVersion)
327+
data.MaxPortShareLevel = types.StringValue(string(template.MaxPortShareLevel))
266328
data.CreatedByUserID = UUIDValue(template.CreatedByID)
267329
data.CreatedAt = types.Int64Value(template.CreatedAt.Unix())
268330
data.UpdatedAt = types.Int64Value(template.UpdatedAt.Unix())
269331

270332
// Save data into Terraform state
271333
resp.Diagnostics.Append(resp.State.Set(ctx, &data)...)
272334
}
335+
336+
// computedPermissionAttribute is the attribute schema for a computed instance of `[]Permission`.
337+
var computedPermissionAttribute = schema.SetNestedAttribute{
338+
Computed: true,
339+
NestedObject: schema.NestedAttributeObject{
340+
Attributes: map[string]schema.Attribute{
341+
"id": schema.StringAttribute{
342+
Computed: true,
343+
},
344+
"role": schema.StringAttribute{
345+
Computed: true,
346+
},
347+
},
348+
},
349+
}

‎internal/provider/template_data_source_test.go

+25
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,16 @@ func TestAccTemplateDataSource(t *testing.T) {
9999
})
100100
require.NoError(t, err)
101101

102+
err = client.UpdateTemplateACL(ctx, tpl.ID, codersdk.UpdateTemplateACL{
103+
UserPerms: map[string]codersdk.TemplateRole{
104+
firstUser.ID.String(): codersdk.TemplateRoleAdmin,
105+
},
106+
GroupPerms: map[string]codersdk.TemplateRole{
107+
firstUser.OrganizationIDs[0].String(): codersdk.TemplateRoleUse,
108+
},
109+
})
110+
require.NoError(t, err)
111+
102112
checkFn := resource.ComposeAggregateTestCheckFunc(
103113
resource.TestCheckResourceAttr("data.coderd_template.test", "organization_id", tpl.OrganizationID.String()),
104114
resource.TestCheckResourceAttr("data.coderd_template.test", "id", tpl.ID.String()),
@@ -112,16 +122,31 @@ func TestAccTemplateDataSource(t *testing.T) {
112122
resource.TestCheckResourceAttr("data.coderd_template.test", "icon", tpl.Icon),
113123
resource.TestCheckResourceAttr("data.coderd_template.test", "default_ttl_ms", strconv.FormatInt(tpl.DefaultTTLMillis, 10)),
114124
resource.TestCheckResourceAttr("data.coderd_template.test", "activity_bump_ms", strconv.FormatInt(tpl.ActivityBumpMillis, 10)),
125+
resource.TestCheckResourceAttr("data.coderd_template.test", "auto_stop_requirement.days_of_week.#", strconv.FormatInt(int64(len(tpl.AutostopRequirement.DaysOfWeek)), 10)),
126+
resource.TestCheckResourceAttr("data.coderd_template.test", "auto_stop_requirement.weeks", strconv.FormatInt(tpl.AutostopRequirement.Weeks, 10)),
127+
resource.TestCheckResourceAttr("data.coderd_template.test", "auto_start_permitted_days_of_week.#", strconv.FormatInt(int64(len(tpl.AutostartRequirement.DaysOfWeek)), 10)),
128+
resource.TestCheckResourceAttr("data.coderd_template.test", "allow_user_cancel_workspace_jobs", "true"),
115129
resource.TestCheckResourceAttr("data.coderd_template.test", "allow_user_autostart", strconv.FormatBool(tpl.AllowUserAutostart)),
116130
resource.TestCheckResourceAttr("data.coderd_template.test", "allow_user_autostop", strconv.FormatBool(tpl.AllowUserAutostop)),
117131
resource.TestCheckResourceAttr("data.coderd_template.test", "allow_user_cancel_workspace_jobs", strconv.FormatBool(tpl.AllowUserCancelWorkspaceJobs)),
118132
resource.TestCheckResourceAttr("data.coderd_template.test", "failure_ttl_ms", strconv.FormatInt(tpl.FailureTTLMillis, 10)),
119133
resource.TestCheckResourceAttr("data.coderd_template.test", "time_til_dormant_ms", strconv.FormatInt(tpl.TimeTilDormantMillis, 10)),
120134
resource.TestCheckResourceAttr("data.coderd_template.test", "time_til_dormant_autodelete_ms", strconv.FormatInt(tpl.TimeTilDormantAutoDeleteMillis, 10)),
121135
resource.TestCheckResourceAttr("data.coderd_template.test", "require_active_version", strconv.FormatBool(tpl.RequireActiveVersion)),
136+
resource.TestCheckResourceAttr("data.coderd_template.test", "max_port_share_level", string(tpl.MaxPortShareLevel)),
122137
resource.TestCheckResourceAttr("data.coderd_template.test", "created_by_user_id", firstUser.ID.String()),
123138
resource.TestCheckResourceAttr("data.coderd_template.test", "created_at", strconv.Itoa(int(tpl.CreatedAt.Unix()))),
124139
resource.TestCheckResourceAttr("data.coderd_template.test", "updated_at", strconv.Itoa(int(tpl.UpdatedAt.Unix()))),
140+
resource.TestCheckResourceAttr("data.coderd_template.test", "acl.groups.#", "1"),
141+
resource.TestCheckResourceAttr("data.coderd_template.test", "acl.users.#", "1"),
142+
resource.TestMatchTypeSetElemNestedAttrs("data.coderd_template.test", "acl.groups.*", map[string]*regexp.Regexp{
143+
"id": regexp.MustCompile(firstUser.OrganizationIDs[0].String()),
144+
"role": regexp.MustCompile("^use$"),
145+
}),
146+
resource.TestMatchTypeSetElemNestedAttrs("data.coderd_template.test", "acl.users.*", map[string]*regexp.Regexp{
147+
"id": regexp.MustCompile(firstUser.ID.String()),
148+
"role": regexp.MustCompile("^admin$"),
149+
}),
125150
)
126151

127152
t.Run("TemplateByOrgAndNameOK", func(t *testing.T) {

‎internal/provider/template_resource.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -361,7 +361,7 @@ func (r *TemplateResource) Schema(ctx context.Context, req resource.SchemaReques
361361
Default: booldefault.StaticBool(false),
362362
},
363363
"deprecation_message": schema.StringAttribute{
364-
MarkdownDescription: "If set, the template will be marked as deprecated with the provided message and users will be blocked from creating new workspaces from it.",
364+
MarkdownDescription: "If set, the template will be marked as deprecated with the provided message and users will be blocked from creating new workspaces from it. Does nothing if set when the resource is created.",
365365
Optional: true,
366366
Computed: true,
367367
Default: stringdefault.StaticString(""),
@@ -586,8 +586,8 @@ func (r *TemplateResource) Read(ctx context.Context, req resource.ReadRequest, r
586586
}
587587
tfACL := convertResponseToACL(acl)
588588
aclObj, diag := types.ObjectValueFrom(ctx, aclTypeAttr, tfACL)
589-
diag.Append(diag...)
590589
if diag.HasError() {
590+
resp.Diagnostics.Append(diag...)
591591
return
592592
}
593593
data.ACL = aclObj

0 commit comments

Comments
 (0)