Skip to content

feat: add coder_devcontainer resource #368

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 2 commits into from
Mar 20, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
29 changes: 29 additions & 0 deletions docs/resources/devcontainer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "coder_devcontainer Resource - terraform-provider-coder"
subcategory: ""
description: |-
Define a Dev Container the agent should know of and attempt to autostart.
---

# coder_devcontainer (Resource)

Define a Dev Container the agent should know of and attempt to autostart.



<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `agent_id` (String) The `id` property of a `coder_agent` resource to associate with.
- `workspace_folder` (String) The workspace folder to for the Dev Container.

### Optional

- `config_path` (String) The path to the Dev Container configuration file (devcontainer.json).

### Read-Only

- `id` (String) The ID of this resource.
46 changes: 46 additions & 0 deletions provider/devcontainer.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
package provider

import (
"context"

"github.com/google/uuid"
"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/validation"
)

func devcontainerResource() *schema.Resource {
return &schema.Resource{
SchemaVersion: 1,

Description: "Define a Dev Container the agent should know of and attempt to autostart.",
CreateContext: func(_ context.Context, rd *schema.ResourceData, _ interface{}) diag.Diagnostics {
rd.SetId(uuid.NewString())

return nil
},
ReadContext: schema.NoopContext,
DeleteContext: schema.NoopContext,
Schema: map[string]*schema.Schema{
"agent_id": {
Type: schema.TypeString,
Description: "The `id` property of a `coder_agent` resource to associate with.",
ForceNew: true,
Required: true,
},
"workspace_folder": {
Type: schema.TypeString,
Description: "The workspace folder to for the Dev Container.",
ForceNew: true,
Required: true,
ValidateFunc: validation.StringIsNotEmpty,
},
"config_path": {
Type: schema.TypeString,
Description: "The path to the Dev Container configuration file (devcontainer.json).",
ForceNew: true,
Optional: true,
},
},
}
}
98 changes: 98 additions & 0 deletions provider/devcontainer_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
package provider_test

import (
"regexp"
"testing"

"github.com/stretchr/testify/require"

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

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

resource.Test(t, resource.TestCase{
ProviderFactories: coderFactory(),
IsUnitTest: true,
Steps: []resource.TestStep{{
Config: `
provider "coder" {
}
resource "coder_devcontainer" "example" {
agent_id = "king"
workspace_folder = "/workspace"
config_path = "/workspace/devcontainer.json"
}
`,
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_devcontainer.example"]
require.NotNil(t, script)
t.Logf("script attributes: %#v", script.Primary.Attributes)
for key, expected := range map[string]string{
"agent_id": "king",
"workspace_folder": "/workspace",
"config_path": "/workspace/devcontainer.json",
} {
require.Equal(t, expected, script.Primary.Attributes[key])
}
return nil
},
}},
})
}

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

resource.Test(t, resource.TestCase{
ProviderFactories: coderFactory(),
IsUnitTest: true,
Steps: []resource.TestStep{{
Config: `
provider "coder" {
}
resource "coder_devcontainer" "example" {
agent_id = "king"
workspace_folder = "/workspace"
}
`,
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_devcontainer.example"]
require.NotNil(t, script)
t.Logf("script attributes: %#v", script.Primary.Attributes)
for key, expected := range map[string]string{
"agent_id": "king",
"workspace_folder": "/workspace",
} {
require.Equal(t, expected, script.Primary.Attributes[key])
}
return nil
},
}},
})
}

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

resource.Test(t, resource.TestCase{
ProviderFactories: coderFactory(),
IsUnitTest: true,
Steps: []resource.TestStep{{
Config: `
provider "coder" {
}
resource "coder_devcontainer" "example" {
agent_id = ""
}
`,
ExpectError: regexp.MustCompile(`The argument "workspace_folder" is required, but no definition was found.`),
}},
})
}
1 change: 1 addition & 0 deletions provider/provider.go
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ func New() *schema.Provider {
"coder_metadata": metadataResource(),
"coder_script": scriptResource(),
"coder_env": envResource(),
"coder_devcontainer": devcontainerResource(),
},
}
}
Expand Down
Loading