Skip to content

Commit

Permalink
fix: validate that coder_script has a way to run (#162)
Browse files Browse the repository at this point in the history
Previously, this would just silently push the script and
it would never run, because it wasn't configured to do so.

This changes it so all scripts have to be ran at some point.
  • Loading branch information
kylecarbs authored Sep 25, 2023
1 parent 73943b2 commit a9ebf4b
Show file tree
Hide file tree
Showing 2 changed files with 82 additions and 0 deletions.
7 changes: 7 additions & 0 deletions provider/script.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,13 @@ func scriptResource() *schema.Resource {
Description: "Use this resource to run a script from an agent.",
CreateContext: func(ctx context.Context, rd *schema.ResourceData, i interface{}) diag.Diagnostics {
rd.SetId(uuid.NewString())
runOnStart, _ := rd.Get("run_on_start").(bool)
runOnStop, _ := rd.Get("run_on_stop").(bool)
cron, _ := rd.Get("cron").(string)

if !runOnStart && !runOnStop && cron == "" {
return diag.Errorf("at least one of run_on_start, run_on_stop, or cron must be set")
}
return nil
},
ReadContext: schema.NoopContext,
Expand Down
75 changes: 75 additions & 0 deletions provider/script_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
package provider_test

import (
"regexp"
"testing"

"github.com/coder/terraform-provider-coder/provider"
"github.com/stretchr/testify/require"

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

func TestScript(t *testing.T) {
t.Parallel()

resource.Test(t, resource.TestCase{
Providers: map[string]*schema.Provider{
"coder": provider.New(),
},
IsUnitTest: true,
Steps: []resource.TestStep{{
Config: `
provider "coder" {
}
resource "coder_script" "example" {
agent_id = "some id"
display_name = "Hey"
script = "Wow"
cron = "* * * * *"
}
`,
Check: func(state *terraform.State) error {
require.Len(t, state.Modules, 1)
require.Len(t, state.Modules[0].Resources, 1)
script := state.Modules[0].Resources["coder_script.example"]
require.NotNil(t, script)
t.Logf("script attributes: %#v", script.Primary.Attributes)
for key, expected := range map[string]string{
"agent_id": "some id",
"display_name": "Hey",
"script": "Wow",
"cron": "* * * * *",
} {
require.Equal(t, expected, script.Primary.Attributes[key])
}
return nil
},
}},
})
}

func TestScriptNeverRuns(t *testing.T) {
t.Parallel()

resource.Test(t, resource.TestCase{
Providers: map[string]*schema.Provider{
"coder": provider.New(),
},
IsUnitTest: true,
Steps: []resource.TestStep{{
Config: `
provider "coder" {
}
resource "coder_script" "example" {
agent_id = ""
display_name = "Hey"
script = "Wow"
}
`,
ExpectError: regexp.MustCompile(`at least one of run_on_start, run_on_stop, or cron must be set`),
}},
})
}

0 comments on commit a9ebf4b

Please sign in to comment.