mirror of
https://github.com/coder/registry.git
synced 2026-06-04 13:38:14 +00:00
Compare commits
14 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| d8c9ad122c | |||
| 056937a758 | |||
| af8b4f02fd | |||
| 2de6a57a3f | |||
| 494e4deb72 | |||
| 60fec19d7d | |||
| 343a2f2bb8 | |||
| 9cc3d5a776 | |||
| 9c00c576a3 | |||
| 5419676276 | |||
| 7e94395bd1 | |||
| 3b6b1ba4b9 | |||
| 5b6d878fd7 | |||
| 72d7ee418b |
@@ -48,7 +48,7 @@ jobs:
|
||||
- name: Validate formatting
|
||||
run: bun fmt:ci
|
||||
- name: Check for typos
|
||||
uses: crate-ci/typos@v1.36.3
|
||||
uses: crate-ci/typos@v1.37.2
|
||||
with:
|
||||
config: .github/typos.toml
|
||||
validate-readme-files:
|
||||
@@ -63,8 +63,8 @@ jobs:
|
||||
- name: Set up Go
|
||||
uses: actions/setup-go@v6
|
||||
with:
|
||||
go-version: "1.23.2"
|
||||
- name: Validate contributors
|
||||
go-version: "1.24"
|
||||
- name: Validate README
|
||||
run: go build ./cmd/readmevalidation && ./readmevalidation
|
||||
- name: Remove build file artifact
|
||||
run: rm ./readmevalidation
|
||||
|
||||
@@ -3,7 +3,6 @@ on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
- master
|
||||
pull_request:
|
||||
|
||||
permissions:
|
||||
|
||||
@@ -3,11 +3,84 @@ package main
|
||||
import (
|
||||
"bufio"
|
||||
"context"
|
||||
"regexp"
|
||||
"strings"
|
||||
|
||||
"golang.org/x/xerrors"
|
||||
)
|
||||
|
||||
var (
|
||||
// Matches Terraform source lines with registry.coder.com URLs
|
||||
// Pattern: source = "registry.coder.com/namespace/module/coder"
|
||||
terraformSourceRe = regexp.MustCompile(`^\s*source\s*=\s*"` + registryDomain + `/([a-zA-Z0-9-]+)/([a-zA-Z0-9-]+)/coder"`)
|
||||
)
|
||||
|
||||
func validateModuleSourceURL(rm coderResourceReadme) []error {
|
||||
var errs []error
|
||||
|
||||
// Skip validation if we couldn't parse namespace/resourceName from path
|
||||
if rm.namespace == "" || rm.resourceName == "" {
|
||||
return []error{xerrors.Errorf("invalid module path format: %s", rm.filePath)}
|
||||
}
|
||||
|
||||
expectedSource := registryDomain + "/" + rm.namespace + "/" + rm.resourceName + "/coder"
|
||||
|
||||
trimmed := strings.TrimSpace(rm.body)
|
||||
foundCorrectSource := false
|
||||
var incorrectSources []string
|
||||
isInsideTerraform := false
|
||||
|
||||
lineScanner := bufio.NewScanner(strings.NewReader(trimmed))
|
||||
for lineScanner.Scan() {
|
||||
nextLine := lineScanner.Text()
|
||||
|
||||
if strings.HasPrefix(nextLine, "```") {
|
||||
if strings.HasPrefix(nextLine, "```tf") {
|
||||
isInsideTerraform = true
|
||||
continue
|
||||
}
|
||||
if isInsideTerraform {
|
||||
// End of current terraform block, continue to look for more
|
||||
isInsideTerraform = false
|
||||
}
|
||||
continue
|
||||
}
|
||||
|
||||
if !isInsideTerraform {
|
||||
continue
|
||||
}
|
||||
|
||||
// Check for source line in terraform blocks
|
||||
if matches := terraformSourceRe.FindStringSubmatch(nextLine); matches != nil {
|
||||
actualNamespace := matches[1]
|
||||
actualModule := matches[2]
|
||||
actualSource := registryDomain + "/" + actualNamespace + "/" + actualModule + "/coder"
|
||||
|
||||
if actualSource == expectedSource {
|
||||
foundCorrectSource = true
|
||||
} else {
|
||||
// Collect incorrect sources but don't return immediately
|
||||
incorrectSources = append(incorrectSources, actualSource)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// If we found the correct source, ignore any incorrect ones
|
||||
if foundCorrectSource {
|
||||
return nil
|
||||
}
|
||||
|
||||
// If we found incorrect sources but no correct one, report the first incorrect source
|
||||
if len(incorrectSources) > 0 {
|
||||
errs = append(errs, xerrors.Errorf("incorrect source URL format: found %q, expected %q", incorrectSources[0], expectedSource))
|
||||
return errs
|
||||
}
|
||||
|
||||
// If we found no sources at all
|
||||
errs = append(errs, xerrors.Errorf("did not find correct source URL %q in any Terraform code block", expectedSource))
|
||||
return errs
|
||||
}
|
||||
|
||||
func validateCoderModuleReadmeBody(body string) []error {
|
||||
var errs []error
|
||||
|
||||
@@ -94,6 +167,9 @@ func validateCoderModuleReadme(rm coderResourceReadme) []error {
|
||||
for _, err := range validateCoderModuleReadmeBody(rm.body) {
|
||||
errs = append(errs, addFilePathToError(rm.filePath, err))
|
||||
}
|
||||
for _, err := range validateModuleSourceURL(rm) {
|
||||
errs = append(errs, addFilePathToError(rm.filePath, err))
|
||||
}
|
||||
for _, err := range validateResourceGfmAlerts(rm.body) {
|
||||
errs = append(errs, addFilePathToError(rm.filePath, err))
|
||||
}
|
||||
@@ -143,4 +219,4 @@ func validateAllCoderModules() error {
|
||||
}
|
||||
logger.Info(context.Background(), "all relative URLs for READMEs are valid", "resource_type", resourceType)
|
||||
return nil
|
||||
}
|
||||
}
|
||||
@@ -2,12 +2,70 @@ package main
|
||||
|
||||
import (
|
||||
_ "embed"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
//go:embed testSamples/sampleReadmeBody.md
|
||||
var testBody string
|
||||
|
||||
// Test bodies extracted for better readability
|
||||
var (
|
||||
validModuleBody = `# Test Module
|
||||
|
||||
` + "```tf\n" + `module "test-module" {
|
||||
source = "registry.coder.com/test-namespace/test-module/coder"
|
||||
version = "1.0.0"
|
||||
agent_id = coder_agent.example.id
|
||||
}
|
||||
` + "```\n"
|
||||
|
||||
wrongNamespaceBody = `# Test Module
|
||||
|
||||
` + "```tf\n" + `module "test-module" {
|
||||
source = "registry.coder.com/wrong-namespace/test-module/coder"
|
||||
version = "1.0.0"
|
||||
agent_id = coder_agent.example.id
|
||||
}
|
||||
` + "```\n"
|
||||
|
||||
missingSourceBody = `# Test Module
|
||||
|
||||
` + "```tf\n" + `module "test-module" {
|
||||
version = "1.0.0"
|
||||
agent_id = coder_agent.example.id
|
||||
}
|
||||
` + "```\n"
|
||||
|
||||
multipleBlocksValidBody = `# Test Module
|
||||
|
||||
` + "```tf\n" + `module "other-module" {
|
||||
source = "registry.coder.com/other/module/coder"
|
||||
version = "1.0.0"
|
||||
}
|
||||
` + "```\n" + `
|
||||
` + "```tf\n" + `module "test-module" {
|
||||
source = "registry.coder.com/test-namespace/test-module/coder"
|
||||
version = "1.0.0"
|
||||
agent_id = coder_agent.example.id
|
||||
}
|
||||
` + "```\n"
|
||||
|
||||
multipleBlocksInvalidBody = `# Test Module
|
||||
|
||||
` + "```tf\n" + `module "test-module" {
|
||||
source = "registry.coder.com/wrong-namespace/test-module/coder"
|
||||
version = "1.0.0"
|
||||
}
|
||||
` + "```\n" + `
|
||||
` + "```tf\n" + `module "other-module" {
|
||||
source = "registry.coder.com/another-wrong/test-module/coder"
|
||||
version = "1.0.0"
|
||||
agent_id = coder_agent.example.id
|
||||
}
|
||||
` + "```\n"
|
||||
)
|
||||
|
||||
func TestValidateCoderResourceReadmeBody(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
@@ -20,3 +78,115 @@ func TestValidateCoderResourceReadmeBody(t *testing.T) {
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
func TestValidateModuleSourceURL(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
t.Run("Valid source URL format", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
rm := coderResourceReadme{
|
||||
resourceType: "modules",
|
||||
filePath: "registry/test-namespace/modules/test-module/README.md",
|
||||
namespace: "test-namespace",
|
||||
resourceName: "test-module",
|
||||
body: validModuleBody,
|
||||
}
|
||||
errs := validateModuleSourceURL(rm)
|
||||
if len(errs) != 0 {
|
||||
t.Errorf("Expected no errors, got: %v", errs)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("Invalid source URL format - wrong namespace", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
rm := coderResourceReadme{
|
||||
resourceType: "modules",
|
||||
filePath: "registry/test-namespace/modules/test-module/README.md",
|
||||
namespace: "test-namespace",
|
||||
resourceName: "test-module",
|
||||
body: wrongNamespaceBody,
|
||||
}
|
||||
errs := validateModuleSourceURL(rm)
|
||||
if len(errs) != 1 {
|
||||
t.Errorf("Expected 1 error, got %d: %v", len(errs), errs)
|
||||
}
|
||||
if !strings.Contains(errs[0].Error(), "incorrect source URL format") {
|
||||
t.Errorf("Expected source URL format error, got: %s", errs[0].Error())
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("Missing source URL", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
rm := coderResourceReadme{
|
||||
resourceType: "modules",
|
||||
filePath: "registry/test-namespace/modules/test-module/README.md",
|
||||
namespace: "test-namespace",
|
||||
resourceName: "test-module",
|
||||
body: missingSourceBody,
|
||||
}
|
||||
errs := validateModuleSourceURL(rm)
|
||||
if len(errs) != 1 {
|
||||
t.Errorf("Expected 1 error, got %d: %v", len(errs), errs)
|
||||
}
|
||||
if !strings.Contains(errs[0].Error(), "did not find correct source URL") {
|
||||
t.Errorf("Expected missing source URL error, got: %s", errs[0].Error())
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("Invalid file path format", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
rm := coderResourceReadme{
|
||||
resourceType: "modules",
|
||||
filePath: "invalid/path/format",
|
||||
namespace: "", // Empty because path parsing failed
|
||||
resourceName: "", // Empty because path parsing failed
|
||||
body: "# Test Module",
|
||||
}
|
||||
errs := validateModuleSourceURL(rm)
|
||||
if len(errs) != 1 {
|
||||
t.Errorf("Expected 1 error, got %d: %v", len(errs), errs)
|
||||
}
|
||||
if !strings.Contains(errs[0].Error(), "invalid module path format") {
|
||||
t.Errorf("Expected path format error, got: %s", errs[0].Error())
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("Multiple blocks with valid source in second block", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
rm := coderResourceReadme{
|
||||
resourceType: "modules",
|
||||
filePath: "registry/test-namespace/modules/test-module/README.md",
|
||||
namespace: "test-namespace",
|
||||
resourceName: "test-module",
|
||||
body: multipleBlocksValidBody,
|
||||
}
|
||||
errs := validateModuleSourceURL(rm)
|
||||
if len(errs) != 0 {
|
||||
t.Errorf("Expected no errors, got: %v", errs)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("Multiple blocks with incorrect source in second block", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
rm := coderResourceReadme{
|
||||
resourceType: "modules",
|
||||
filePath: "registry/test-namespace/modules/test-module/README.md",
|
||||
namespace: "test-namespace",
|
||||
resourceName: "test-module",
|
||||
body: multipleBlocksInvalidBody,
|
||||
}
|
||||
errs := validateModuleSourceURL(rm)
|
||||
if len(errs) != 1 {
|
||||
t.Errorf("Expected 1 error, got %d: %v", len(errs), errs)
|
||||
}
|
||||
if !strings.Contains(errs[0].Error(), "incorrect source URL format") {
|
||||
t.Errorf("Expected source URL format error, got: %s", errs[0].Error())
|
||||
}
|
||||
})
|
||||
}
|
||||
@@ -18,6 +18,7 @@ var (
|
||||
supportedResourceTypes = []string{"modules", "templates"}
|
||||
operatingSystems = []string{"windows", "macos", "linux"}
|
||||
gfmAlertTypes = []string{"NOTE", "IMPORTANT", "CAUTION", "WARNING", "TIP"}
|
||||
registryDomain = "registry.coder.com"
|
||||
|
||||
// TODO: This is a holdover from the validation logic used by the Coder Modules repo. It gives us some assurance, but
|
||||
// realistically, we probably want to parse any Terraform code snippets, and make some deeper guarantees about how it's
|
||||
@@ -25,7 +26,7 @@ var (
|
||||
terraformVersionRe = regexp.MustCompile(`^\s*\bversion\s+=`)
|
||||
|
||||
// Matches the format "> [!INFO]". Deliberately using a broad pattern to catch formatting issues that can mess up
|
||||
// the renderer for the Registry website
|
||||
// the renderer for the Registry website.
|
||||
gfmAlertRegex = regexp.MustCompile(`^>(\s*)\[!(\w+)\](\s*)(.*)`)
|
||||
)
|
||||
|
||||
@@ -39,7 +40,7 @@ type coderResourceFrontmatter struct {
|
||||
}
|
||||
|
||||
// A slice version of the struct tags from coderResourceFrontmatter. Might be worth using reflection to generate this
|
||||
// list at runtime in the future, but this should be okay for now
|
||||
// list at runtime in the future, but this should be okay for now.
|
||||
var supportedCoderResourceStructKeys = []string{
|
||||
"description", "icon", "display_name", "verified", "tags", "supported_os",
|
||||
// TODO: This is an old, officially deprecated key from the archived coder/modules repo. We can remove this once we
|
||||
@@ -53,6 +54,8 @@ var supportedCoderResourceStructKeys = []string{
|
||||
type coderResourceReadme struct {
|
||||
resourceType string
|
||||
filePath string
|
||||
namespace string
|
||||
resourceName string
|
||||
body string
|
||||
frontmatter coderResourceFrontmatter
|
||||
}
|
||||
@@ -183,9 +186,20 @@ func parseCoderResourceReadme(resourceType string, rm readme) (coderResourceRead
|
||||
return coderResourceReadme{}, []error{xerrors.Errorf("%q: failed to parse: %v", rm.filePath, err)}
|
||||
}
|
||||
|
||||
// Extract namespace and resource name from file path
|
||||
// Expected path format: registry/<namespace>/<resourceType>/<resource-name>/README.md
|
||||
var namespace, resourceName string
|
||||
parts := strings.Split(path.Clean(rm.filePath), "/")
|
||||
if len(parts) >= 5 && parts[0] == "registry" && parts[2] == resourceType && parts[4] == "README.md" {
|
||||
namespace = parts[1]
|
||||
resourceName = parts[3]
|
||||
}
|
||||
|
||||
return coderResourceReadme{
|
||||
resourceType: resourceType,
|
||||
filePath: rm.filePath,
|
||||
namespace: namespace,
|
||||
resourceName: resourceName,
|
||||
body: body,
|
||||
frontmatter: yml,
|
||||
}, nil
|
||||
@@ -315,15 +329,15 @@ func validateResourceGfmAlerts(readmeBody string) []error {
|
||||
}
|
||||
|
||||
// Nested GFM alerts is such a weird mistake that it's probably not really safe to keep trying to process the
|
||||
// rest of the content, so this will prevent any other validations from happening for the given line
|
||||
// rest of the content, so this will prevent any other validations from happening for the given line.
|
||||
if isInsideGfmQuotes {
|
||||
errs = append(errs, errors.New("registry does not support nested GFM alerts"))
|
||||
errs = append(errs, xerrors.New("registry does not support nested GFM alerts"))
|
||||
continue
|
||||
}
|
||||
|
||||
leadingWhitespace := currentMatch[1]
|
||||
if len(leadingWhitespace) != 1 {
|
||||
errs = append(errs, errors.New("GFM alerts must have one space between the '>' and the start of the GFM brackets"))
|
||||
errs = append(errs, xerrors.New("GFM alerts must have one space between the '>' and the start of the GFM brackets"))
|
||||
}
|
||||
isInsideGfmQuotes = true
|
||||
|
||||
@@ -347,7 +361,7 @@ func validateResourceGfmAlerts(readmeBody string) []error {
|
||||
}
|
||||
}
|
||||
|
||||
if gfmAlertRegex.Match([]byte(sourceLine)) {
|
||||
if gfmAlertRegex.MatchString(sourceLine) {
|
||||
errs = append(errs, xerrors.Errorf("README has an incomplete GFM alert at the end of the file"))
|
||||
}
|
||||
|
||||
|
||||
@@ -26,7 +26,7 @@ type contributorProfileFrontmatter struct {
|
||||
}
|
||||
|
||||
// A slice version of the struct tags from contributorProfileFrontmatter. Might be worth using reflection to generate
|
||||
// this list at runtime in the future, but this should be okay for now
|
||||
// this list at runtime in the future, but this should be okay for now.
|
||||
var supportedContributorProfileStructKeys = []string{"display_name", "bio", "status", "avatar", "linkedin", "github", "website", "support_email"}
|
||||
|
||||
type contributorProfileReadme struct {
|
||||
|
||||
@@ -13,12 +13,11 @@ import (
|
||||
|
||||
var supportedUserNameSpaceDirectories = append(supportedResourceTypes, ".images")
|
||||
|
||||
// validNameRe validates that names contain only alphanumeric characters and hyphens
|
||||
// validNameRe validates that names contain only alphanumeric characters and hyphens.
|
||||
var validNameRe = regexp.MustCompile(`^[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`)
|
||||
|
||||
|
||||
// validateCoderResourceSubdirectory validates that the structure of a module or template within a namespace follows all
|
||||
// expected file conventions
|
||||
// expected file conventions.
|
||||
func validateCoderResourceSubdirectory(dirPath string) []error {
|
||||
resourceDir, err := os.Stat(dirPath)
|
||||
if err != nil {
|
||||
@@ -47,7 +46,7 @@ func validateCoderResourceSubdirectory(dirPath string) []error {
|
||||
continue
|
||||
}
|
||||
|
||||
// Validate module/template name
|
||||
// Validate module/template name.
|
||||
if !validNameRe.MatchString(f.Name()) {
|
||||
errs = append(errs, xerrors.Errorf("%q: name contains invalid characters (only alphanumeric characters and hyphens are allowed)", path.Join(dirPath, f.Name())))
|
||||
continue
|
||||
@@ -90,7 +89,7 @@ func validateRegistryDirectory() []error {
|
||||
continue
|
||||
}
|
||||
|
||||
// Validate namespace name
|
||||
// Validate namespace name.
|
||||
if !validNameRe.MatchString(nDir.Name()) {
|
||||
allErrs = append(allErrs, xerrors.Errorf("%q: namespace name contains invalid characters (only alphanumeric characters and hyphens are allowed)", namespacePath))
|
||||
continue
|
||||
@@ -136,7 +135,7 @@ func validateRegistryDirectory() []error {
|
||||
|
||||
// validateRepoStructure validates that the structure of the repo is "correct enough" to do all necessary validation
|
||||
// checks. It is NOT an exhaustive validation of the entire repo structure – it only checks the parts of the repo that
|
||||
// are relevant for the main validation steps
|
||||
// are relevant for the main validation steps.
|
||||
func validateRepoStructure() error {
|
||||
var errs []error
|
||||
if vrdErrs := validateRegistryDirectory(); len(vrdErrs) != 0 {
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
module coder.com/coder-registry
|
||||
|
||||
go 1.23.2
|
||||
go 1.24
|
||||
|
||||
require (
|
||||
cdr.dev/slog v1.6.1
|
||||
|
||||
+2
-1
@@ -5,7 +5,8 @@
|
||||
"fmt:ci": "bun x prettier --check . && terraform fmt -check -recursive -diff",
|
||||
"terraform-validate": "./scripts/terraform_validate.sh",
|
||||
"test": "./scripts/terraform_test_all.sh",
|
||||
"update-version": "./update-version.sh"
|
||||
"update-version": "./update-version.sh",
|
||||
"validate-readme": "go build ./cmd/readmevalidation && ./readmevalidation"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/bun": "^1.2.21",
|
||||
|
||||
@@ -42,7 +42,7 @@ run "test_claude_code_with_api_key" {
|
||||
}
|
||||
|
||||
assert {
|
||||
condition = coder_env.claude_api_key.value == "test-api-key-123"
|
||||
condition = coder_env.claude_api_key[0].value == "test-api-key-123"
|
||||
error_message = "Claude API key value should match the input"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -10,6 +10,8 @@ tags: [ide, jetbrains, parameter, gateway]
|
||||
|
||||
This module adds a JetBrains Gateway Button to open any workspace with a single click.
|
||||
|
||||
> We recommend using the [Coder Toolbox module](https://registry.coder.com/modules/coder/jetbrains), which offers significant stability and connectivity benefits over Gateway. Reference our [documentation](https://coder.com/docs/user-guides/workspace-access/jetbrains/toolbox) for more information.
|
||||
|
||||
JetBrains recommends a minimum of 4 CPU cores and 8GB of RAM.
|
||||
Consult the [JetBrains documentation](https://www.jetbrains.com/help/idea/prerequisites.html#min_requirements) to confirm other system requirements.
|
||||
|
||||
@@ -17,7 +19,7 @@ Consult the [JetBrains documentation](https://www.jetbrains.com/help/idea/prereq
|
||||
module "jetbrains_gateway" {
|
||||
count = data.coder_workspace.me.start_count
|
||||
source = "registry.coder.com/coder/jetbrains-gateway/coder"
|
||||
version = "1.2.2"
|
||||
version = "1.2.4"
|
||||
agent_id = coder_agent.example.id
|
||||
folder = "/home/coder/example"
|
||||
jetbrains_ides = ["CL", "GO", "IU", "PY", "WS"]
|
||||
@@ -35,7 +37,7 @@ module "jetbrains_gateway" {
|
||||
module "jetbrains_gateway" {
|
||||
count = data.coder_workspace.me.start_count
|
||||
source = "registry.coder.com/coder/jetbrains-gateway/coder"
|
||||
version = "1.2.2"
|
||||
version = "1.2.4"
|
||||
agent_id = coder_agent.example.id
|
||||
folder = "/home/coder/example"
|
||||
jetbrains_ides = ["GO", "WS"]
|
||||
@@ -49,7 +51,7 @@ module "jetbrains_gateway" {
|
||||
module "jetbrains_gateway" {
|
||||
count = data.coder_workspace.me.start_count
|
||||
source = "registry.coder.com/coder/jetbrains-gateway/coder"
|
||||
version = "1.2.2"
|
||||
version = "1.2.4"
|
||||
agent_id = coder_agent.example.id
|
||||
folder = "/home/coder/example"
|
||||
jetbrains_ides = ["IU", "PY"]
|
||||
@@ -64,7 +66,7 @@ module "jetbrains_gateway" {
|
||||
module "jetbrains_gateway" {
|
||||
count = data.coder_workspace.me.start_count
|
||||
source = "registry.coder.com/coder/jetbrains-gateway/coder"
|
||||
version = "1.2.2"
|
||||
version = "1.2.4"
|
||||
agent_id = coder_agent.example.id
|
||||
folder = "/home/coder/example"
|
||||
jetbrains_ides = ["IU", "PY"]
|
||||
@@ -89,7 +91,7 @@ module "jetbrains_gateway" {
|
||||
module "jetbrains_gateway" {
|
||||
count = data.coder_workspace.me.start_count
|
||||
source = "registry.coder.com/coder/jetbrains-gateway/coder"
|
||||
version = "1.2.2"
|
||||
version = "1.2.4"
|
||||
agent_id = coder_agent.example.id
|
||||
folder = "/home/coder/example"
|
||||
jetbrains_ides = ["GO", "WS"]
|
||||
@@ -107,7 +109,7 @@ Due to the highest priority of the `ide_download_link` parameter in the `(jetbra
|
||||
module "jetbrains_gateway" {
|
||||
count = data.coder_workspace.me.start_count
|
||||
source = "registry.coder.com/coder/jetbrains-gateway/coder"
|
||||
version = "1.2.2"
|
||||
version = "1.2.4"
|
||||
agent_id = coder_agent.example.id
|
||||
folder = "/home/coder/example"
|
||||
jetbrains_ides = ["GO", "WS"]
|
||||
|
||||
@@ -20,7 +20,7 @@ describe("jetbrains-gateway", async () => {
|
||||
folder: "/home/coder",
|
||||
});
|
||||
expect(state.outputs.url.value).toBe(
|
||||
"jetbrains-gateway://connect#type=coder&workspace=default&owner=default&folder=/home/coder&url=https://mydeployment.coder.com&token=$SESSION_TOKEN&ide_product_code=IU&ide_build_number=243.21565.193&ide_download_link=https://download.jetbrains.com/idea/ideaIU-2024.3.tar.gz&agent_id=foo",
|
||||
"jetbrains-gateway://connect#type=coder&workspace=default&owner=default&folder=/home/coder&url=https://mydeployment.coder.com&token=$SESSION_TOKEN&ide_product_code=IU&ide_build_number=243.21565.193&ide_download_link=https://download.jetbrains.com/idea/ideaIU-2024.3.tar.gz&agent=",
|
||||
);
|
||||
|
||||
const coder_app = state.resources.find(
|
||||
@@ -40,4 +40,28 @@ describe("jetbrains-gateway", async () => {
|
||||
});
|
||||
expect(state.outputs.identifier.value).toBe("IU");
|
||||
});
|
||||
|
||||
it("optionally includes agent when an agent name is provided", async () => {
|
||||
const state = await runTerraformApply(import.meta.dir, {
|
||||
agent_id: "foo",
|
||||
agent_name: "main",
|
||||
folder: "/home/coder",
|
||||
});
|
||||
|
||||
expect(state.outputs.url.value).toBe(
|
||||
"jetbrains-gateway://connect#type=coder&workspace=default&owner=default&folder=/home/coder&url=https://mydeployment.coder.com&token=$SESSION_TOKEN&ide_product_code=IU&ide_build_number=243.21565.193&ide_download_link=https://download.jetbrains.com/idea/ideaIU-2024.3.tar.gz&agent=main",
|
||||
);
|
||||
});
|
||||
|
||||
it("includes the agent parameter even when the provided value is blank", async () => {
|
||||
const state = await runTerraformApply(import.meta.dir, {
|
||||
agent_id: "foo",
|
||||
agent_name: " ",
|
||||
folder: "/home/coder",
|
||||
});
|
||||
|
||||
expect(state.outputs.url.value).toBe(
|
||||
"jetbrains-gateway://connect#type=coder&workspace=default&owner=default&folder=/home/coder&url=https://mydeployment.coder.com&token=$SESSION_TOKEN&ide_product_code=IU&ide_build_number=243.21565.193&ide_download_link=https://download.jetbrains.com/idea/ideaIU-2024.3.tar.gz&agent= ",
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
@@ -30,15 +30,14 @@ variable "agent_id" {
|
||||
|
||||
variable "slug" {
|
||||
type = string
|
||||
description = "The slug for the coder_app. Allows resuing the module with the same template."
|
||||
description = "The slug for the coder_app. Allows reusing the module with the same template."
|
||||
default = "gateway"
|
||||
}
|
||||
|
||||
variable "agent_name" {
|
||||
type = string
|
||||
description = "Agent name. (unused). Will be removed in a future version"
|
||||
|
||||
default = ""
|
||||
description = "Agent name."
|
||||
default = ""
|
||||
}
|
||||
|
||||
variable "folder" {
|
||||
@@ -348,8 +347,8 @@ resource "coder_app" "gateway" {
|
||||
local.build_number,
|
||||
"&ide_download_link=",
|
||||
local.download_link,
|
||||
"&agent_id=",
|
||||
var.agent_id,
|
||||
"&agent=",
|
||||
var.agent_name,
|
||||
])
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user