Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings
Merged
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
21 changes: 21 additions & 0 deletions 21 coderd/templatebuilder/compose_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,27 @@ func TestCompose(t *testing.T) {
require.Contains(t, result.ExtraFiles, "cloud-init/cloud-config.yaml.tftpl")
})

t.Run("GCPWindowsBase", func(t *testing.T) {
t.Parallel()
result, err := templatebuilder.Compose(templatebuilder.ComposeRequest{
BaseTemplateID: "gcp-windows",
RegistryURL: "https://registry.coder.com",
})
require.NoError(t, err)
require.NotEmpty(t, result.MainTF)
require.Contains(t, string(result.MainTF), `resource "coder_agent" "main"`)
})

t.Run("AzureLinuxExtraFiles", func(t *testing.T) {
t.Parallel()
result, err := templatebuilder.Compose(templatebuilder.ComposeRequest{
BaseTemplateID: "azure-linux",
RegistryURL: "https://registry.coder.com",
})
require.NoError(t, err)
require.Contains(t, result.ExtraFiles, "cloud-init/cloud-config.yaml.tftpl")
})

t.Run("SensitiveVariable", func(t *testing.T) {
t.Parallel()
result, err := templatebuilder.Compose(templatebuilder.ComposeRequest{
Expand Down
113 changes: 109 additions & 4 deletions 113 coderd/templatebuilder/errors.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,45 @@ package templatebuilder
import "strings"

// networkErrorPatterns are substrings found in provisioner job output when
// the Terraform registry or provider endpoints are unreachable.
// the Terraform registry or provider endpoints are unreachable. These are
// intentionally not augmented with diagnostic context because the canned
// message is self-explanatory and the underlying logs rarely add value.
var networkErrorPatterns = []string{
"no such host",
"connection refused",
"i/o timeout",
"dial tcp: lookup",
"network is unreachable",
"no route to host",
"TLS handshake timeout",
"tls handshake timeout",
}

// authErrorPatterns are substrings that indicate cloud provider
// authentication or credential failures. Matching is case-insensitive
// (the combined text is lowercased before comparison).
var authErrorPatterns = []string{
"no valid credential sources found",
"could not find default credentials",
"unauthorizedaccess",
"authorizationfailed",
"authfailure",
"accessdenied",
"invalidclienttokenid",
"expiredtoken",
"signaturedoesnotmatch",
"not authorized to perform",
}

// maxLogContextLines caps how many relevant log lines are included in
// the error detail to avoid returning excessive output.
const maxLogContextLines = 20

// ClassifyProvisionerError inspects a provisioner job error and its log
// lines, returning a user-friendly message for known failure modes.
// If the error is not recognized, the raw jobError is returned unchanged.
// For unrecognized errors, the raw jobError is returned with relevant
// log context appended so the user can diagnose the failure.
func ClassifyProvisionerError(jobError string, logs []string) string {
combined := jobError + "\n" + strings.Join(logs, "\n")
combined := strings.ToLower(jobError + "\n" + strings.Join(logs, "\n"))

for _, pattern := range networkErrorPatterns {
if strings.Contains(combined, pattern) {
Expand All @@ -28,5 +51,87 @@ func ClassifyProvisionerError(jobError string, logs []string) string {
}
}

for _, pattern := range authErrorPatterns {
if strings.Contains(combined, pattern) {
msg := "Cloud provider authentication failed. " +
"Check that valid credentials are configured for the provisioner."
if diag := extractDiagnostics(logs); diag != "" {
msg += "\n\n" + diag
}
return msg
}
}

// For unrecognized errors, include relevant Terraform output so the
// user can diagnose the failure.
if diag := extractDiagnostics(logs); diag != "" {
return jobError + "\n\n" + diag
}
return jobError
}

// diagnosticPrefixes identify Terraform diagnostic output lines worth
// surfacing. Terraform formats errors as blocks starting with "Error:"
// or "Warning:" followed by indented detail lines.
var diagnosticPrefixes = []string{
"Error:",
"Warning:",
"error:",
"warning:",
}

// isDiagnosticStart returns true if the line begins a Terraform
// diagnostic block.
func isDiagnosticStart(line string) bool {
for _, prefix := range diagnosticPrefixes {
if strings.HasPrefix(line, prefix) {
return true
}
}
return false
}

// extractDiagnostics pulls Terraform diagnostic blocks from provisioner
// log output. It keeps lines that start a diagnostic (Error:/Warning:)
// and subsequent indented or context lines, up to maxLogContextLines.
func extractDiagnostics(logs []string) string {
var lines []string
inBlock := false

for _, line := range logs {
if len(lines) >= maxLogContextLines {
lines = append(lines, "... (truncated)")
break
}

trimmed := strings.TrimSpace(line)
if trimmed == "" {
if inBlock {
// Blank line inside a block: keep it to preserve
// readability, but end the block.
lines = append(lines, "")
inBlock = false
}
continue
}

if isDiagnosticStart(trimmed) {
inBlock = true
lines = append(lines, trimmed)
continue
}

if inBlock {
lines = append(lines, trimmed)
continue
}

// Capture "on <file> line <N>" references that appear
// outside the main diagnostic block in some Terraform versions.
if strings.HasPrefix(trimmed, "on ") && strings.Contains(trimmed, " line ") {
lines = append(lines, trimmed)
}
}

return strings.Join(lines, "\n")
}
Loading
Loading
Morty Proxy This is a proxified and sanitized view of the page, visit original site.