package provider_test

import (

"regexp"

"testing"

"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"

"github.com/hashicorp/terraform-plugin-sdk/v2/terraform"

"github.com/stretchr/testify/require"

)

func TestWorkspacePreset(t *testing.T) {

t.Parallel()

type testcase struct {

Name string

Config string

ExpectError *regexp.Regexp

Check func(state *terraform.State) error

}

testcases := []testcase{

{

Name: "Happy Path",

Config: `

data "coder_workspace_preset" "preset_1" {

name = "preset_1"

description = <<-EOT

# Select the machine image

See the [registry](https://container.registry.blah/namespace) for options.

EOT

icon = "/icon/region.svg"

parameters = {

"region" = "us-east1-a"

}

}`,

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["description"], "# Select the machine image\nSee the [registry](https://container.registry.blah/namespace) for options.\n")

require.Equal(t, attrs["icon"], "/icon/region.svg")

require.Equal(t, attrs["parameters.region"], "us-east1-a")

return nil

},

},

{

Name: "Name field is not provided",

Config: `

data "coder_workspace_preset" "preset_1" {

parameters = {

"region" = "us-east1-a"

}

}`,

// This validation is done by Terraform, but it could still break if we misconfigure the schema.

// So we test it here to make sure we don't regress.

ExpectError: regexp.MustCompile("The argument \"name\" is required, but no definition was found"),

},

{

Name: "Name field is empty",

Config: `

data "coder_workspace_preset" "preset_1" {

name = ""

parameters = {

"region" = "us-east1-a"

}

}`,

// This validation is done by Terraform, but it could still break if we misconfigure the schema.

// So we test it here to make sure we don't regress.

ExpectError: regexp.MustCompile("expected \"name\" to not be an empty string"),

},

{

Name: "Name field is not a string",

Config: `

data "coder_workspace_preset" "preset_1" {

name = [1, 2, 3]

parameters = {

"region" = "us-east1-a"

}

}`,

// This validation is done by Terraform, but it could still break if we misconfigure the schema.

// So we test it here to make sure we don't regress.

ExpectError: regexp.MustCompile("Incorrect attribute value type"),

},

{

Name: "Description field is empty",

Config: `

data "coder_workspace_preset" "preset_1" {

name = "preset_1"

description = ""

parameters = {

"region" = "us-east1-a"

}

}`,

// This validation is done by Terraform, but it could still break if we misconfigure the schema.

// So we test it here to make sure we don't regress.

ExpectError: nil,

},

{

Name: "Description field exceeds maximum supported length (128 characters)",

Config: `

data "coder_workspace_preset" "preset_1" {

name = "preset_1"

description = "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Curabitur vehicula leo sit amet mi laoreet, sed ornare velit tincidunt. Proin gravida lacinia blandit."

parameters = {

"region" = "us-east1-a"

}

}`,

// This validation is done by Terraform, but it could still break if we misconfigure the schema.

// So we test it here to make sure we don't regress.

ExpectError: regexp.MustCompile(`expected length of description to be in the range \(0 - 128\)`),

},

{

Name: "Icon field is empty",

Config: `

data "coder_workspace_preset" "preset_1" {

name = "preset_1"

icon = ""

parameters = {

"region" = "us-east1-a"

}

}`,

// This validation is done by Terraform, but it could still break if we misconfigure the schema.

// So we test it here to make sure we don't regress.

ExpectError: nil,

},

{

Name: "Icon field is an invalid URL",

Config: `

data "coder_workspace_preset" "preset_1" {

name = "preset_1"

icon = "/icon%.svg"

parameters = {

"region" = "us-east1-a"

}

}`,

// This validation is done by Terraform, but it could still break if we misconfigure the schema.

// So we test it here to make sure we don't regress.

ExpectError: regexp.MustCompile("invalid URL escape"),

},

{

Name: "Icon field exceeds maximum supported length (256 characters)",

Config: `

data "coder_workspace_preset" "preset_1" {

name = "preset_1"

icon = "https://example.com/path/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.svg"

parameters = {

"region" = "us-east1-a"

}

}`,

// This validation is done by Terraform, but it could still break if we misconfigure the schema.

// So we test it here to make sure we don't regress.

ExpectError: regexp.MustCompile(`expected length of icon to be in the range \(0 - 256\)`),

},

{

Name: "Parameters field is not provided",

Config: `

data "coder_workspace_preset" "preset_1" {

name = "preset_1"

}`,

// This validation is done by Terraform, but it could still break if we misconfigure the schema.

// So we test it here to make sure we don't regress.

ExpectError: nil,

},

{

Name: "Parameters field is empty",

Config: `

data "coder_workspace_preset" "preset_1" {

name = "preset_1"

parameters = {}

}`,

// This validation is *not* done by Terraform, because MinItems doesn't work with maps.

// We've implemented the validation in ReadContext, so we test it here to make sure we don't regress.

ExpectError: nil,

},

{

Name: "Parameters field is not a map",

Config: `

data "coder_workspace_preset" "preset_1" {

name = "preset_1"

parameters = "not a map"

}`,

// This validation is done by Terraform, but it could still break if we misconfigure the schema.

// So we test it here to make sure we don't regress.

ExpectError: regexp.MustCompile("Inappropriate value for attribute \"parameters\": map of string required"),

},

{

Name: "Prebuilds is set, but not its required fields",

Config: `

data "coder_workspace_preset" "preset_1" {

name = "preset_1"

parameters = {

"region" = "us-east1-a"

}

prebuilds {}

}`,

ExpectError: regexp.MustCompile("The argument \"instances\" is required, but no definition was found."),

},

{

Name: "Prebuilds is set, and so are its required fields",

Config: `

data "coder_workspace_preset" "preset_1" {

name = "preset_1"

parameters = {

"region" = "us-east1-a"

}

prebuilds {

instances = 1

}

}`,

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.instances"], "1")

return nil

},

},

{

Name: "Prebuilds is set with a expiration_policy field without its required fields",

Config: `

data "coder_workspace_preset" "preset_1" {

name = "preset_1"

parameters = {

"region" = "us-east1-a"

}

prebuilds {

instances = 1

expiration_policy {}

}

}`,

ExpectError: regexp.MustCompile(`The argument "ttl" is required, but no definition was found.`),

},

{

Name: "Prebuilds is set with a expiration_policy field with its required fields",

Config: `

data "coder_workspace_preset" "preset_1" {

name = "preset_1"

parameters = {

"region" = "us-east1-a"

}

prebuilds {

instances = 1

expiration_policy {

ttl = 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.expiration_policy.0.ttl"], "86400")

return nil

},

},

{

Name: "Prebuilds block with expiration_policy.ttl set to 0 seconds (disables expiration)",

Config: `

data "coder_workspace_preset" "preset_1" {

name = "preset_1"

parameters = {

"region" = "us-east1-a"

}

prebuilds {

instances = 1

expiration_policy {

ttl = 0

}

}

}`,

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.expiration_policy.0.ttl"], "0")

return nil

},

},

{

Name: "Prebuilds block with expiration_policy.ttl set to 30 minutes (below 1 hour limit)",

Config: `

data "coder_workspace_preset" "preset_1" {

name = "preset_1"

parameters = {

"region" = "us-east1-a"

}

prebuilds {

instances = 1

expiration_policy {

ttl = 1800

}

}

}`,

ExpectError: regexp.MustCompile(`"prebuilds.0.expiration_policy.0.ttl" must be 0 or between 3600 and 31536000, got 1800`),

},

{

Name: "Prebuilds block with expiration_policy.ttl set to 2 years (exceeds 1 year limit)",

Config: `

data "coder_workspace_preset" "preset_1" {

name = "preset_1"

parameters = {

"region" = "us-east1-a"

}

prebuilds {

instances = 1

expiration_policy {

ttl = 63072000

}

}

}`,

ExpectError: regexp.MustCompile(`"prebuilds.0.expiration_policy.0.ttl" must be 0 or between 3600 and 31536000, got 63072000`),

},

{

Name: "Prebuilds is set with a expiration_policy 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

expiration_policy {

ttl = 86400

invalid_argument = "test"

}

}

}`,

ExpectError: regexp.MustCompile("An argument named \"invalid_argument\" is not expected here."),

},

{

Name: "Prebuilds is set with an empty scheduling field",

Config: `

data "coder_workspace_preset" "preset_1" {

name = "preset_1"

prebuilds {

instances = 1

scheduling {}

}

}`,

ExpectError: regexp.MustCompile(`The argument "[^"]+" is required, but no definition was found.`),

},

{

Name: "Prebuilds is set with an scheduling field, but without timezone",

Config: `

data "coder_workspace_preset" "preset_1" {

name = "preset_1"

prebuilds {

instances = 1

scheduling {

schedule {

cron = "* 8-18 * * 1-5"

instances = 3

}

}

}

}`,

ExpectError: regexp.MustCompile(`The argument "timezone" is required, but no definition was found.`),

},

{

Name: "Prebuilds is set with an scheduling field, but without schedule",

Config: `

data "coder_workspace_preset" "preset_1" {

name = "preset_1"

prebuilds {

instances = 1

scheduling {

timezone = "UTC"

}

}

}`,

ExpectError: regexp.MustCompile(`At least 1 "schedule" blocks are required.`),

},

{

Name: "Prebuilds is set with an scheduling.schedule field, but without cron",

Config: `

data "coder_workspace_preset" "preset_1" {

name = "preset_1"

prebuilds {

instances = 1

scheduling {

timezone = "UTC"

schedule {

instances = 3

}

}

}

}`,

ExpectError: regexp.MustCompile(`The argument "cron" is required, but no definition was found.`),

},

{

Name: "Prebuilds is set with an scheduling.schedule field, but without instances",

Config: `

data "coder_workspace_preset" "preset_1" {

name = "preset_1"

prebuilds {

instances = 1

scheduling {

timezone = "UTC"

schedule {

cron = "* 8-18 * * 1-5"

}

}

}

}`,

ExpectError: regexp.MustCompile(`The argument "instances" is required, but no definition was found.`),

},

{

Name: "Prebuilds is set with an scheduling.schedule field, but with invalid type for instances",

Config: `

data "coder_workspace_preset" "preset_1" {

name = "preset_1"

prebuilds {

instances = 1

scheduling {

timezone = "UTC"

schedule {

cron = "* 8-18 * * 1-5"

instances = "not_a_number"

}

}

}

}`,

ExpectError: regexp.MustCompile(`Inappropriate value for attribute "instances": a number is required`),

},

{

Name: "Prebuilds is set with an scheduling field with 1 schedule",

Config: `

data "coder_workspace_preset" "preset_1" {

name = "preset_1"

prebuilds {

instances = 1

scheduling {

timezone = "UTC"

schedule {

cron = "* 8-18 * * 1-5"

instances = 3

}

}

}

}`,

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.scheduling.0.timezone"], "UTC")

require.Equal(t, attrs["prebuilds.0.scheduling.0.schedule.0.cron"], "* 8-18 * * 1-5")

require.Equal(t, attrs["prebuilds.0.scheduling.0.schedule.0.instances"], "3")

return nil

},

},

{

Name: "Prebuilds is set with an scheduling field with 2 schedules",

Config: `

data "coder_workspace_preset" "preset_1" {

name = "preset_1"

prebuilds {

instances = 1

scheduling {

timezone = "UTC"

schedule {

cron = "* 8-18 * * 1-5"

instances = 3

}

schedule {

cron = "* 8-14 * * 6"

instances = 1

}

}

}

}`,

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.scheduling.0.timezone"], "UTC")

require.Equal(t, attrs["prebuilds.0.scheduling.0.schedule.0.cron"], "* 8-18 * * 1-5")

require.Equal(t, attrs["prebuilds.0.scheduling.0.schedule.0.instances"], "3")

require.Equal(t, attrs["prebuilds.0.scheduling.0.schedule.1.cron"], "* 8-14 * * 6")

require.Equal(t, attrs["prebuilds.0.scheduling.0.schedule.1.instances"], "1")

return nil

},

},

{

Name: "Prebuilds is set with an scheduling.schedule field, but the cron includes a disallowed minute field",

Config: `

data "coder_workspace_preset" "preset_1" {

name = "preset_1"

prebuilds {

instances = 1

scheduling {

timezone = "UTC"

schedule {

cron = "30 8-18 * * 1-5"

instances = "1"

}

}

}

}`,

ExpectError: regexp.MustCompile(`cron spec failed validation: minute field should be *`),

},

{

Name: "Prebuilds is set with an scheduling.schedule field, but the cron hour field is invalid",

Config: `

data "coder_workspace_preset" "preset_1" {

name = "preset_1"

prebuilds {

instances = 1

scheduling {

timezone = "UTC"

schedule {

cron = "* 25-26 * * 1-5"

instances = "1"

}

}

}

}`,

ExpectError: regexp.MustCompile(`failed to parse cron spec: end of range \(26\) above maximum \(23\): 25-26`),

},

{

Name: "Prebuilds is set with a valid scheduling.timezone field",

Config: `

data "coder_workspace_preset" "preset_1" {

name = "preset_1"

prebuilds {

instances = 1

scheduling {

timezone = "America/Los_Angeles"

schedule {

cron = "* 8-18 * * 1-5"

instances = 3

}

}

}

}`,

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.scheduling.0.timezone"], "America/Los_Angeles")

return nil

},

},

{

Name: "Prebuilds is set with an invalid scheduling.timezone field",

Config: `

data "coder_workspace_preset" "preset_1" {

name = "preset_1"

prebuilds {

instances = 1

scheduling {

timezone = "InvalidLocation"

schedule {

cron = "* 8-18 * * 1-5"

instances = 3

}

}

}

}`,

ExpectError: regexp.MustCompile(`failed to load timezone "InvalidLocation": unknown time zone InvalidLocation`),

},

{

Name: "Prebuilds is set with an scheduling field, with 2 overlapping schedules",

Config: `

data "coder_workspace_preset" "preset_1" {

name = "preset_1"

prebuilds {

instances = 1

scheduling {

timezone = "UTC"

schedule {

cron = "* 8-18 * * 1-5"

instances = 3

}

schedule {

cron = "* 18-19 * * 5-6"

instances = 1

}

}

}

}`,

ExpectError: regexp.MustCompile(`schedules overlap with each other: schedules overlap: \* 8-18 \* \* 1-5 and \* 18-19 \* \* 5-6`),

},

{

Name: "Default field set to true",

Config: `

data "coder_workspace_preset" "preset_1" {

name = "preset_1"

default = true

parameters = {

"region" = "us-east1-a"

}

}`,

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)

require.Equal(t, resource.Primary.Attributes["default"], "true")

return nil

},

},

{

Name: "Default field set to false",

Config: `

data "coder_workspace_preset" "preset_1" {

name = "preset_1"

default = false

parameters = {

"region" = "us-east1-a"

}

}`,

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)

require.Equal(t, resource.Primary.Attributes["default"], "false")

return nil

},

},

{

Name: "Default field not provided (defaults to false)",

Config: `

data "coder_workspace_preset" "preset_1" {

name = "preset_1"

parameters = {

"region" = "us-east1-a"

}

}`,

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)

require.Equal(t, resource.Primary.Attributes["default"], "false")

return nil

},

},

}

for _, testcase := range testcases {

t.Run(testcase.Name, func(t *testing.T) {

t.Parallel()

resource.Test(t, resource.TestCase{

ProviderFactories: coderFactory(),

IsUnitTest: true,

Steps: []resource.TestStep{{

Config: testcase.Config,

ExpectError: testcase.ExpectError,

Check: testcase.Check,

}},

})

})

}

}