Skip to content

feat: add expiration_policy parameter to prebuild resource #404

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
May 23, 2025
Merged
Show file tree
Hide file tree
Changes from 8 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/data-sources/workspace_preset.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,3 +51,14 @@ data "coder_workspace_preset" "example" {
Required:

- `instances` (Number) The number of workspaces to keep in reserve for this preset.

Optional:

- `cache_invalidation` (Block Set, Max: 1) Configuration block that defines TTL (time-to-live) behavior for prebuilds. Use this to automatically invalidate and delete prebuilds after a certain period, ensuring they stay up-to-date. (see [below for nested schema](#nestedblock--prebuilds--cache_invalidation))

<a id="nestedblock--prebuilds--cache_invalidation"></a>
### Nested Schema for `prebuilds.cache_invalidation`

Required:

- `invalidate_after_secs` (Number) Time in seconds after which an unclaimed prebuild is considered expired and eligible for cleanup.
11 changes: 6 additions & 5 deletions integration/integration_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -90,11 +90,12 @@ func TestIntegration(t *testing.T) {
// TODO (sasswart): the cli doesn't support presets yet.
// once it does, the value for workspace_parameter.value
// will be the preset value.
"workspace_parameter.value": `param value`,
"workspace_parameter.icon": `param icon`,
"workspace_preset.name": `preset`,
"workspace_preset.parameters.param": `preset param value`,
"workspace_preset.prebuilds.instances": `1`,
"workspace_parameter.value": `param value`,
"workspace_parameter.icon": `param icon`,
"workspace_preset.name": `preset`,
"workspace_preset.parameters.param": `preset param value`,
"workspace_preset.prebuilds.instances": `1`,
"workspace_preset.prebuilds.cache_invalidation.invalidate_after_secs": `86400`,
},
},
{
Expand Down
4 changes: 4 additions & 0 deletions integration/test-data-source/main.tf
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@ data "coder_workspace_preset" "preset" {

prebuilds {
instances = 1
cache_invalidation {
invalidate_after_secs = 86400
}
}
}

Expand All @@ -52,6 +55,7 @@ locals {
"workspace_preset.name" : data.coder_workspace_preset.preset.name,
"workspace_preset.parameters.param" : data.coder_workspace_preset.preset.parameters.param,
"workspace_preset.prebuilds.instances" : tostring(one(data.coder_workspace_preset.preset.prebuilds).instances),
"workspace_preset.prebuilds.cache_invalidation.invalidate_after_secs" : tostring(one(one(data.coder_workspace_preset.preset.prebuilds).cache_invalidation).invalidate_after_secs),
}
}

Expand Down
24 changes: 23 additions & 1 deletion provider/workspace_preset.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,12 @@ type WorkspacePreset struct {
}

type WorkspacePrebuild struct {
Instances int `mapstructure:"instances"`
Instances int `mapstructure:"instances"`
CacheInvalidation []CacheInvalidation `mapstructure:"cache_invalidation"`
}

type CacheInvalidation struct {
InvalidateAfterSecs int `mapstructure:"invalidate_after_secs"`
}

func workspacePresetDataSource() *schema.Resource {
Expand Down Expand Up @@ -81,6 +86,23 @@ func workspacePresetDataSource() *schema.Resource {
ForceNew: true,
ValidateFunc: validation.IntAtLeast(0),
},
"cache_invalidation": {
Type: schema.TypeSet,
Description: "Configuration block that defines TTL (time-to-live) behavior for prebuilds. Use this to automatically invalidate and delete prebuilds after a certain period, ensuring they stay up-to-date.",
Optional: true,
MaxItems: 1,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"invalidate_after_secs": {
Type: schema.TypeInt,
Description: "Time in seconds after which an unclaimed prebuild is considered expired and eligible for cleanup.",
Required: true,
ForceNew: true,
ValidateFunc: validation.IntAtLeast(0),
},
},
},
},
},
},
},
Expand Down
63 changes: 63 additions & 0 deletions provider/workspace_preset_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,69 @@ func TestWorkspacePreset(t *testing.T) {
return nil
},
},
{
Name: "Prebuilds is set with a cache_invalidation field without its required fields",
Config: `
data "coder_workspace_preset" "preset_1" {
name = "preset_1"
parameters = {
"region" = "us-east1-a"
}
prebuilds {
instances = 1
cache_invalidation {}
}
}`,
// Note: Match only the beginning of the error message to make the test more reliable.
// The full error message includes formatting differences like newlines, which could
// cause the test to fail unnecessarily.
ExpectError: regexp.MustCompile("The argument \"invalidate_after_secs\" is required,"),
},
{
Name: "Prebuilds is set with a cache_invalidation field with its required fields",
Config: `
data "coder_workspace_preset" "preset_1" {
name = "preset_1"
parameters = {
"region" = "us-east1-a"
}
prebuilds {
instances = 1
cache_invalidation {
invalidate_after_secs = 86400
}
}
}`,
ExpectError: nil,
Check: func(state *terraform.State) error {
require.Len(t, state.Modules, 1)
require.Len(t, state.Modules[0].Resources, 1)
resource := state.Modules[0].Resources["data.coder_workspace_preset.preset_1"]
require.NotNil(t, resource)
attrs := resource.Primary.Attributes
require.Equal(t, attrs["name"], "preset_1")
require.Equal(t, attrs["prebuilds.0.cache_invalidation.0.invalidate_after_secs"], "86400")
return nil
},
},
{
Name: "Prebuilds is set with a cache_invalidation field with its required fields and an unexpected argument",
Config: `
data "coder_workspace_preset" "preset_1" {
name = "preset_1"
parameters = {
"region" = "us-east1-a"
}
prebuilds {
instances = 1
cache_invalidation {
invalidate_after_secs = 86400
invalid_argument = "test"
}
}
}`,
ExpectError: regexp.MustCompile("An argument named \"invalid_argument\" is not expected here."),
},
}

for _, testcase := range testcases {
Expand Down
Loading