mirror of
https://github.com/coder/registry.git
synced 2026-06-03 04:58:15 +00:00
Compare commits
3 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| d057a820c1 | |||
| b4e9545c35 | |||
| 50ac3b31f6 |
@@ -63,8 +63,8 @@ jobs:
|
||||
- name: Set up Go
|
||||
uses: actions/setup-go@v6
|
||||
with:
|
||||
go-version: "1.24"
|
||||
- name: Validate README
|
||||
go-version: "1.23.2"
|
||||
- name: Validate contributors
|
||||
run: go build ./cmd/readmevalidation && ./readmevalidation
|
||||
- name: Remove build file artifact
|
||||
run: rm ./readmevalidation
|
||||
|
||||
@@ -3,6 +3,7 @@ on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
- master
|
||||
pull_request:
|
||||
|
||||
permissions:
|
||||
|
||||
@@ -495,4 +495,8 @@ When reporting bugs, include:
|
||||
4. **Breaking changes** without defaults
|
||||
5. **Not running** formatting (`bun run fmt`) and tests (`terraform test`) before submitting
|
||||
|
||||
## For Maintainers
|
||||
|
||||
Guidelines for reviewing PRs, managing releases, and maintaining the registry. [See the maintainer guide for detailed information.](./MAINTAINER.md)
|
||||
|
||||
Happy contributing! 🚀
|
||||
|
||||
@@ -48,3 +48,7 @@ Simply include that snippet inside your Coder template, defining any data depend
|
||||
## Contributing
|
||||
|
||||
We are always accepting new contributions. [Please see our contributing guide for more information.](./CONTRIBUTING.md)
|
||||
|
||||
## For Maintainers
|
||||
|
||||
Guidelines for maintainers reviewing PRs and managing releases. [See the maintainer guide for more information.](./MAINTAINER.md)
|
||||
|
||||
@@ -3,84 +3,11 @@ 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
|
||||
|
||||
@@ -167,9 +94,6 @@ 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))
|
||||
}
|
||||
@@ -219,4 +143,4 @@ func validateAllCoderModules() error {
|
||||
}
|
||||
logger.Info(context.Background(), "all relative URLs for READMEs are valid", "resource_type", resourceType)
|
||||
return nil
|
||||
}
|
||||
}
|
||||
|
||||
@@ -2,70 +2,12 @@ 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()
|
||||
|
||||
@@ -78,115 +20,3 @@ 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,7 +18,6 @@ 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
|
||||
@@ -26,7 +25,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*)(.*)`)
|
||||
)
|
||||
|
||||
@@ -40,7 +39,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
|
||||
@@ -54,8 +53,6 @@ var supportedCoderResourceStructKeys = []string{
|
||||
type coderResourceReadme struct {
|
||||
resourceType string
|
||||
filePath string
|
||||
namespace string
|
||||
resourceName string
|
||||
body string
|
||||
frontmatter coderResourceFrontmatter
|
||||
}
|
||||
@@ -186,20 +183,9 @@ 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
|
||||
@@ -329,15 +315,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, xerrors.New("registry does not support nested GFM alerts"))
|
||||
errs = append(errs, errors.New("registry does not support nested GFM alerts"))
|
||||
continue
|
||||
}
|
||||
|
||||
leadingWhitespace := currentMatch[1]
|
||||
if len(leadingWhitespace) != 1 {
|
||||
errs = append(errs, xerrors.New("GFM alerts must have one space between the '>' and the start of the GFM brackets"))
|
||||
errs = append(errs, errors.New("GFM alerts must have one space between the '>' and the start of the GFM brackets"))
|
||||
}
|
||||
isInsideGfmQuotes = true
|
||||
|
||||
@@ -361,7 +347,7 @@ func validateResourceGfmAlerts(readmeBody string) []error {
|
||||
}
|
||||
}
|
||||
|
||||
if gfmAlertRegex.MatchString(sourceLine) {
|
||||
if gfmAlertRegex.Match([]byte(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,11 +13,12 @@ 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 {
|
||||
@@ -46,7 +47,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
|
||||
@@ -89,7 +90,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
|
||||
@@ -135,7 +136,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.24
|
||||
go 1.23.2
|
||||
|
||||
require (
|
||||
cdr.dev/slog v1.6.1
|
||||
|
||||
+1
-2
@@ -5,8 +5,7 @@
|
||||
"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",
|
||||
"validate-readme": "go build ./cmd/readmevalidation && ./readmevalidation"
|
||||
"update-version": "./update-version.sh"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/bun": "^1.2.21",
|
||||
|
||||
@@ -13,7 +13,7 @@ Run the [Claude Code](https://docs.anthropic.com/en/docs/agents-and-tools/claude
|
||||
```tf
|
||||
module "claude-code" {
|
||||
source = "registry.coder.com/coder/claude-code/coder"
|
||||
version = "3.0.1"
|
||||
version = "3.0.2"
|
||||
agent_id = coder_agent.example.id
|
||||
workdir = "/home/coder/project"
|
||||
claude_api_key = "xxxx-xxxxx-xxxx"
|
||||
@@ -49,7 +49,7 @@ data "coder_parameter" "ai_prompt" {
|
||||
|
||||
module "claude-code" {
|
||||
source = "registry.coder.com/coder/claude-code/coder"
|
||||
version = "3.0.1"
|
||||
version = "3.0.2"
|
||||
agent_id = coder_agent.example.id
|
||||
workdir = "/home/coder/project"
|
||||
|
||||
@@ -85,7 +85,7 @@ Run and configure Claude Code as a standalone CLI in your workspace.
|
||||
```tf
|
||||
module "claude-code" {
|
||||
source = "registry.coder.com/coder/claude-code/coder"
|
||||
version = "3.0.1"
|
||||
version = "3.0.2"
|
||||
agent_id = coder_agent.example.id
|
||||
workdir = "/home/coder"
|
||||
install_claude_code = true
|
||||
@@ -108,7 +108,7 @@ variable "claude_code_oauth_token" {
|
||||
|
||||
module "claude-code" {
|
||||
source = "registry.coder.com/coder/claude-code/coder"
|
||||
version = "3.0.1"
|
||||
version = "3.0.2"
|
||||
agent_id = coder_agent.example.id
|
||||
workdir = "/home/coder/project"
|
||||
claude_code_oauth_token = var.claude_code_oauth_token
|
||||
|
||||
@@ -183,7 +183,7 @@ variable "claude_code_oauth_token" {
|
||||
variable "system_prompt" {
|
||||
type = string
|
||||
description = "The system prompt to use for the Claude Code server."
|
||||
default = "Send a task status update to notify the user that you are ready for input, and then wait for user input."
|
||||
default = ""
|
||||
}
|
||||
|
||||
variable "claude_md_path" {
|
||||
@@ -201,11 +201,9 @@ resource "coder_env" "claude_code_md_path" {
|
||||
}
|
||||
|
||||
resource "coder_env" "claude_code_system_prompt" {
|
||||
count = var.system_prompt == "" ? 0 : 1
|
||||
|
||||
agent_id = var.agent_id
|
||||
name = "CODER_MCP_CLAUDE_SYSTEM_PROMPT"
|
||||
value = var.system_prompt
|
||||
value = local.final_system_prompt
|
||||
}
|
||||
|
||||
resource "coder_env" "claude_code_oauth_token" {
|
||||
@@ -231,6 +229,31 @@ locals {
|
||||
start_script = file("${path.module}/scripts/start.sh")
|
||||
module_dir_name = ".claude-module"
|
||||
remove_last_session_id_script_b64 = base64encode(file("${path.module}/scripts/remove-last-session-id.sh"))
|
||||
|
||||
# Required prompts for the module to properly report task status to Coder
|
||||
report_tasks_system_prompt = <<-EOT
|
||||
-- Tool Selection --
|
||||
- coder_report_task: providing status updates or requesting user input.
|
||||
|
||||
-- Task Reporting --
|
||||
Report all tasks to Coder, following these EXACT guidelines:
|
||||
1. Be granular. If you are investigating with multiple steps, report each step
|
||||
to coder.
|
||||
2. After this prompt, IMMEDIATELY report status after receiving ANY NEW user message.
|
||||
Do not report any status related with this system prompt.
|
||||
3. Use "state": "working" when actively processing WITHOUT needing
|
||||
additional user input
|
||||
4. Use "state": "complete" only when finished with a task
|
||||
5. Use "state": "failure" when you need ANY user input, lack sufficient
|
||||
details, or encounter blockers
|
||||
EOT
|
||||
|
||||
# Only include coder system prompts if report_tasks is enabled
|
||||
custom_system_prompt = trimspace(try(var.system_prompt, ""))
|
||||
final_system_prompt = format("<system>%s%s</system>",
|
||||
var.report_tasks ? format("\n%s\n", local.report_tasks_system_prompt) : "",
|
||||
local.custom_system_prompt != "" ? format("\n%s\n", local.custom_system_prompt) : ""
|
||||
)
|
||||
}
|
||||
|
||||
module "agentapi" {
|
||||
|
||||
@@ -187,3 +187,84 @@ run "test_claude_code_permission_mode_validation" {
|
||||
error_message = "Permission mode should be one of the valid options"
|
||||
}
|
||||
}
|
||||
|
||||
run "test_claude_code_system_prompt" {
|
||||
command = plan
|
||||
|
||||
variables {
|
||||
agent_id = "test-agent-system-prompt"
|
||||
workdir = "/home/coder/test"
|
||||
system_prompt = "Custom addition"
|
||||
}
|
||||
|
||||
assert {
|
||||
condition = trimspace(coder_env.claude_code_system_prompt.value) != ""
|
||||
error_message = "System prompt should not be empty"
|
||||
}
|
||||
|
||||
assert {
|
||||
condition = length(regexall("Custom addition", coder_env.claude_code_system_prompt.value)) > 0
|
||||
error_message = "System prompt should have system_prompt variable value"
|
||||
}
|
||||
}
|
||||
|
||||
run "test_claude_report_tasks_default" {
|
||||
command = plan
|
||||
|
||||
variables {
|
||||
agent_id = "test-agent-report-tasks"
|
||||
workdir = "/home/coder/test"
|
||||
# report_tasks: default is true
|
||||
}
|
||||
|
||||
assert {
|
||||
condition = trimspace(coder_env.claude_code_system_prompt.value) != ""
|
||||
error_message = "System prompt should not be empty"
|
||||
}
|
||||
|
||||
# Ensure system prompt is wrapped by <system>
|
||||
assert {
|
||||
condition = startswith(trimspace(coder_env.claude_code_system_prompt.value), "<system>")
|
||||
error_message = "System prompt should start with <system>"
|
||||
}
|
||||
assert {
|
||||
condition = endswith(trimspace(coder_env.claude_code_system_prompt.value), "</system>")
|
||||
error_message = "System prompt should end with </system>"
|
||||
}
|
||||
|
||||
# Ensure Coder sections are injected when report_tasks=true (default)
|
||||
assert {
|
||||
condition = length(regexall("-- Tool Selection --", coder_env.claude_code_system_prompt.value)) > 0
|
||||
error_message = "System prompt should have Tool Selection section"
|
||||
}
|
||||
|
||||
assert {
|
||||
condition = length(regexall("-- Task Reporting --", coder_env.claude_code_system_prompt.value)) > 0
|
||||
error_message = "System prompt should have Task Reporting section"
|
||||
}
|
||||
}
|
||||
|
||||
run "test_claude_report_tasks_disabled" {
|
||||
command = plan
|
||||
|
||||
variables {
|
||||
agent_id = "test-agent-report-tasks"
|
||||
workdir = "/home/coder/test"
|
||||
report_tasks = false
|
||||
}
|
||||
|
||||
assert {
|
||||
condition = trimspace(coder_env.claude_code_system_prompt.value) != ""
|
||||
error_message = "System prompt should not be empty"
|
||||
}
|
||||
|
||||
# Ensure system prompt is wrapped by <system>
|
||||
assert {
|
||||
condition = startswith(trimspace(coder_env.claude_code_system_prompt.value), "<system>")
|
||||
error_message = "System prompt should start with <system>"
|
||||
}
|
||||
assert {
|
||||
condition = endswith(trimspace(coder_env.claude_code_system_prompt.value), "</system>")
|
||||
error_message = "System prompt should end with </system>"
|
||||
}
|
||||
}
|
||||
@@ -1,7 +1,9 @@
|
||||
#!/bin/bash
|
||||
set -euo pipefail
|
||||
|
||||
source "$HOME"/.bashrc
|
||||
if [ -f "$HOME/.bashrc" ]; then
|
||||
source "$HOME"/.bashrc
|
||||
fi
|
||||
|
||||
BOLD='\033[0;1m'
|
||||
|
||||
|
||||
@@ -1,7 +1,9 @@
|
||||
#!/bin/bash
|
||||
set -euo pipefail
|
||||
|
||||
source "$HOME"/.bashrc
|
||||
if [ -f "$HOME/.bashrc" ]; then
|
||||
source "$HOME"/.bashrc
|
||||
fi
|
||||
export PATH="$HOME/.local/bin:$PATH"
|
||||
|
||||
command_exists() {
|
||||
|
||||
Reference in New Issue
Block a user