Skip to content

feat(fleet-ide): add Fleet IDE module for JetBrains integration #176

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

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all 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
60 changes: 60 additions & 0 deletions .icons/fleet.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
72 changes: 72 additions & 0 deletions registry/coder/modules/fleet-ide/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
---
display_name: JetBrains Fleet
description: Add a one-click button to launch JetBrains Fleet IDE to connect to your workspace.
icon: ../../../../.icons/jetbrains.svg
maintainer_github: coder
verified: false
tags: [ide, jetbrains, fleet]
---

# Fleet IDE

This module adds a Fleet IDE button to your Coder workspace that opens the workspace in JetBrains Fleet using SSH remote development.

JetBrains Fleet is a next-generation IDE that supports collaborative development and distributed architectures. It connects to your Coder workspace via SSH, providing a seamless remote development experience.

```tf
module "fleet_ide" {
count = data.coder_workspace.me.start_count
source = "registry.coder.com/coder/fleet-ide/coder"
version = "1.0.0"
agent_id = coder_agent.example.id
}
```

![Fleet IDE](../.images/fleet-ide.png)

## Requirements

- JetBrains Fleet must be installed locally on your development machine
- Download Fleet from: https://www.jetbrains.com/fleet/

> [IMPORTANT]
> Fleet needs you to either have Coder CLI installed with `coder config-ssh` run or [Coder Desktop](https://coder.com/docs/user-guides/desktop).

## Examples

### Basic usage

```tf
module "fleet_ide" {
count = data.coder_workspace.me.start_count
source = "registry.coder.com/coder/fleet-ide/coder"
version = "1.0.0"
agent_id = coder_agent.example.id
}
```

### Open a specific folder

```tf
module "fleet_ide" {
count = data.coder_workspace.me.start_count
source = "registry.coder.com/coder/fleet-ide/coder"
version = "1.0.0"
agent_id = coder_agent.example.id
folder = "/home/coder/project"
}
```

### Customize app name and grouping

```tf
module "fleet_ide" {
count = data.coder_workspace.me.start_count
source = "registry.coder.com/coder/fleet-ide/coder"
version = "1.0.0"
agent_id = coder_agent.example.id
display_name = "Fleet"
group = "JetBrains IDEs"
order = 1
}
```
90 changes: 90 additions & 0 deletions registry/coder/modules/fleet-ide/main.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
import { describe, expect, it } from "bun:test";
import {
runTerraformApply,
runTerraformInit,
testRequiredVariables,
} from "~test";

describe("fleet-ide", async () => {
await runTerraformInit(import.meta.dir);

testRequiredVariables(import.meta.dir, {
agent_id: "foo",
});

it("default output", async () => {
const state = await runTerraformApply(import.meta.dir, {
agent_id: "foo",
});
expect(state.outputs.fleet_url.value).toBe(
"fleet://fleet.ssh/https://mydeployment.coder.com?workspace=default&owner=default",
);

const coder_app = state.resources.find(
(res) => res.type === "coder_app" && res.name === "fleet",
);

expect(coder_app).not.toBeNull();
expect(coder_app?.instances.length).toBe(1);
expect(coder_app?.instances[0].attributes.order).toBeNull();
});

it("adds folder", async () => {
const state = await runTerraformApply(import.meta.dir, {
agent_id: "foo",
folder: "/foo/bar",
});
expect(state.outputs.fleet_url.value).toBe(
"fleet://fleet.ssh/https://mydeployment.coder.com?workspace=default&owner=default&pwd=/foo/bar",
);
});

it("custom display name and slug", async () => {
const state = await runTerraformApply(import.meta.dir, {
agent_id: "foo",
display_name: "My Fleet",
slug: "my-fleet",
});
expect(state.outputs.fleet_url.value).toBe(
"fleet://fleet.ssh/https://mydeployment.coder.com?workspace=default&owner=default",
);

const coder_app = state.resources.find(
(res) => res.type === "coder_app" && res.name === "fleet",
);

expect(coder_app).not.toBeNull();
expect(coder_app?.instances[0].attributes.display_name).toBe("My Fleet");
expect(coder_app?.instances[0].attributes.slug).toBe("my-fleet");
});

it("expect order to be set", async () => {
const state = await runTerraformApply(import.meta.dir, {
agent_id: "foo",
order: "22",
});

const coder_app = state.resources.find(
(res) => res.type === "coder_app" && res.name === "fleet",
);

expect(coder_app).not.toBeNull();
expect(coder_app?.instances.length).toBe(1);
expect(coder_app?.instances[0].attributes.order).toBe(22);
});

it("expect group to be set", async () => {
const state = await runTerraformApply(import.meta.dir, {
agent_id: "foo",
group: "JetBrains IDEs",
});

const coder_app = state.resources.find(
(res) => res.type === "coder_app" && res.name === "fleet",
);

expect(coder_app).not.toBeNull();
expect(coder_app?.instances.length).toBe(1);
expect(coder_app?.instances[0].attributes.group).toBe("JetBrains IDEs");
});
});
72 changes: 72 additions & 0 deletions registry/coder/modules/fleet-ide/main.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
terraform {
required_version = ">= 1.0"

required_providers {
coder = {
source = "coder/coder"
version = ">= 2.5"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess we are using the 2.5 version because of the group property.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I based this off of the other modules that work the same way but yeah ultmately

}
}
}

variable "agent_id" {
type = string
description = "The ID of a Coder agent."
}

variable "folder" {
type = string
description = "The folder to open in Fleet IDE."
default = ""
}

variable "order" {
type = number
description = "The order determines the position of app in the UI presentation. The lowest order is shown first and apps with equal order are sorted by name (ascending order)."
default = null
}

variable "group" {
type = string
description = "The name of a group that this app belongs to."
default = null
}

variable "slug" {
type = string
description = "The slug of the app."
default = "fleet"
}

variable "display_name" {
type = string
description = "The display name of the app."
default = "JetBrains Fleet"
}

data "coder_workspace" "me" {}
data "coder_workspace_owner" "me" {}

resource "coder_app" "fleet" {
agent_id = var.agent_id
external = true
icon = "/icon/fleet.svg"
slug = var.slug
display_name = var.display_name
order = var.order
group = var.group
url = join("", [
"fleet://fleet.ssh/",
data.coder_workspace.me.access_url,
"?workspace=",
data.coder_workspace.me.name,
"&owner=",
data.coder_workspace_owner.me.name,
var.folder != "" ? join("", ["&pwd=", var.folder]) : ""
])
}

output "fleet_url" {
value = coder_app.fleet.url
description = "Fleet IDE connection URL."
}