feat: Add DevURL support

kylecarbs · kylecarbs · commit 83102e7355a4 · 2022-05-06T01:29:13.000Z
This adds what are presently named "devurls" in v1.
It seems this may be a dated term, since this allows
much more than accessing applications via URL.

"coder open &lt;name&gt;" will launch any _devurls_ defined
here. If in the web, it'll open either a web terminal or
port forward to the desired application. If in the terminal,
it'll open the browser, or launch the command over SSH.
diff --git a/docs/resources/devurl.md b/docs/resources/devurl.md
@@ -0,0 +1,63 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "coder_devurl Resource - terraform-provider-coder"
+subcategory: ""
+description: |-
+  Use this resource to define shortcuts to access applications in a workspace.
+---
+
+# coder_devurl (Resource)
+
+Use this resource to define shortcuts to access applications in a workspace.
+
+## Example Usage
+
+```terraform
+resource "coder_agent" "dev" {
+  os             = "linux"
+  arch           = "amd64"
+  dir            = "/workspace"
+  startup_script = <<EOF
+curl -fsSL https://code-server.dev/install.sh | sh
+code-server --auth none --port 13337
+EOF
+}
+
+resource "coder_devurl" "code-server" {
+  agent_id = coder_agent.dev.id
+  name     = "VS Code"
+  icon     = "builtin:vscode"
+  target   = "http://localhost:13337"
+}
+
+resource "coder_devurl" "vim" {
+  agent_id = coder_agent.dev.id
+  name     = "Vim"
+  icon     = "builtin:vim"
+  command  = "vim"
+}
+
+resource "coder_devurl" "intellij" {
+  agent_id = coder_agent.dev.id
+  icon     = "builtin:intellij"
+  name     = "JetBrains IntelliJ"
+  command  = "projector run"
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `agent_id` (String) The "id" property of a "coder_agent" resource to associate with.
+
+### Optional
+
+- `command` (String) A command to run in a terminal opening this DevURL. In the web, this will open in a new tab. In the CLI, this will SSH and execute the command.
+- `icon` (String) An icon to display in the dashboard.
+- `id` (String) The ID of this resource.
+- `name` (String) A display name to identify the DevURL.
+- `target` (String) A URL to be proxied to from inside the workspace.
+
+
diff --git a/examples/resources/coder_devurl/resource.tf b/examples/resources/coder_devurl/resource.tf
@@ -0,0 +1,30 @@
+resource "coder_agent" "dev" {
+  os             = "linux"
+  arch           = "amd64"
+  dir            = "/workspace"
+  startup_script = <<EOF
+curl -fsSL https://code-server.dev/install.sh | sh
+code-server --auth none --port 13337
+EOF
+}
+
+resource "coder_devurl" "code-server" {
+  agent_id = coder_agent.dev.id
+  name     = "VS Code"
+  icon     = "builtin:vscode"
+  target   = "http://localhost:13337"
+}
+
+resource "coder_devurl" "vim" {
+  agent_id = coder_agent.dev.id
+  name     = "Vim"
+  icon     = "builtin:vim"
+  command  = "vim"
+}
+
+resource "coder_devurl" "intellij" {
+  agent_id = coder_agent.dev.id
+  icon     = "builtin:intellij"
+  name     = "JetBrains IntelliJ"
+  command  = "projector run"
+}
diff --git a/internal/provider/provider.go b/internal/provider/provider.go
@@ -227,6 +227,54 @@ func New() *schema.Provider {
 					},
 				},
 			},
+			"coder_devurl": {
+				Description: "Use this resource to define shortcuts to access applications in a workspace.",
+				CreateContext: func(c context.Context, resourceData *schema.ResourceData, i interface{}) diag.Diagnostics {
+					resourceData.SetId(uuid.NewString())
+					return nil
+				},
+				ReadContext: func(c context.Context, resourceData *schema.ResourceData, i interface{}) diag.Diagnostics {
+					return nil
+				},
+				DeleteContext: func(ctx context.Context, rd *schema.ResourceData, i interface{}) diag.Diagnostics {
+					return nil
+				},
+				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,
+					},
+					"name": {
+						Type:        schema.TypeString,
+						Description: "A display name to identify the DevURL.",
+						ForceNew:    true,
+						Optional:    true,
+					},
+					"icon": {
+						Type:        schema.TypeString,
+						Description: "An icon to display in the dashboard.",
+						ForceNew:    true,
+						Optional:    true,
+					},
+					"command": {
+						Type: schema.TypeString,
+						Description: "A command to run in a terminal opening this DevURL. In the web, " +
+							"this will open in a new tab. In the CLI, this will SSH and execute the command.",
+						ConflictsWith: []string{"target"},
+						Optional:      true,
+						ForceNew:      true,
+					},
+					"target": {
+						Type:          schema.TypeString,
+						Description:   "A URL to be proxied to from inside the workspace.",
+						ForceNew:      true,
+						Optional:      true,
+						ConflictsWith: []string{"command"},
+					},
+				},
+			},
 		},
 	}
 }
diff --git a/internal/provider/provider_test.go b/internal/provider/provider_test.go
@@ -134,3 +134,47 @@ func TestAgentInstance(t *testing.T) {
 		}},
 	})
 }
+
+func TestDevURL(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_agent" "dev" {
+					os = "linux"
+					arch = "amd64"
+				}
+				resource "coder_devurl" "code-server" {
+					agent_id = coder_agent.dev.id
+					name = "code-server"
+					icon = "builtin:vim"
+					target = "http://localhost:13337"
+				}
+				`,
+			Check: func(state *terraform.State) error {
+				require.Len(t, state.Modules, 1)
+				require.Len(t, state.Modules[0].Resources, 2)
+				resource := state.Modules[0].Resources["coder_devurl.code-server"]
+				require.NotNil(t, resource)
+				for _, key := range []string{
+					"agent_id",
+					"name",
+					"icon",
+					"target",
+				} {
+					value := resource.Primary.Attributes[key]
+					t.Logf("%q = %q", key, value)
+					require.NotNil(t, value)
+					require.Greater(t, len(value), 0)
+				}
+				return nil
+			},
+		}},
+	})
+}
