Skip to content

fix(provisioner/terraform): decode Terraform action hook log lines #31701

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.

Sign up for GitHub

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

Draft
sreya wants to merge 1 commit into
base: main
Choose a base branch
from
+71 −2
Draft

fix(provisioner/terraform): decode Terraform action hook log lines #31701

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
26 changes: 24 additions & 2 deletions provisioner/terraform/executor.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -776,7 +776,7 @@ func extractTimingSpan(log *terraformProvisionLog) (time.Time, *timingSpan, erro
return ts, &timingSpan{
kind: typ,
messageCode: log.MessageCode,
action: log.Hook.Action,
action: string(log.Hook.Action),
provider: log.Hook.Resource.Provider,
resource: log.Hook.Resource.Addr,
}, nil
Expand Down Expand Up @@ -814,10 +814,32 @@ type terraformProvisionLog struct {
}

type terraformProvisionLogHook struct {
Action string `json:"action"`
Action terraformHookAction `json:"action"`
Resource terraformProvisionLogHookResource `json:"resource"`
}

// terraformHookAction is the "action" of a hook message. Resource hooks use a
// string (e.g. "create"), but Terraform 1.14+ action hooks (action_start,
// action_progress, ...) use an object describing the action. Accept both so
// that those lines still decode and their @message is logged.
type terraformHookAction string

func (a *terraformHookAction) UnmarshalJSON(b []byte) error {
var s string
if err := json.Unmarshal(b, &s); err == nil {
*a = terraformHookAction(s)
return nil
}
var obj struct {
Addr string `json:"addr"`
}
if err := json.Unmarshal(b, &obj); err != nil {
return err
}
*a = terraformHookAction(obj.Addr)
return nil
}

type terraformProvisionLogHookResource struct {
Addr string `json:"addr"`
Provider string `json:"implied_provider"`
Expand Down
47 changes: 47 additions & 0 deletions provisioner/terraform/executor_internal_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -303,3 +303,50 @@ func TestChecksumFileCRC32(t *testing.T) {
require.Zero(t, checksum)
})
}

func TestParseTerraformLogLineHookAction(t *testing.T) {
t.Parallel()

tests := []struct {
name string
line string
wantMessage string
wantAction terraformHookAction
}{
{
name: "ResourceHook",
line: `{"@level":"info","@message":"coder_agent.main: Creating...","hook":{"action":"create","resource":{"addr":"coder_agent.main","implied_provider":"coder"}},"type":"apply_start"}`,
wantMessage: "coder_agent.main: Creating...",
wantAction: "create",
},
{
// Terraform 1.14+ actions describe the action as an object.
name: "ActionProgress",
line: `{"@level":"info","@message":"kubernetes_deployment_v1.main[0] (0): action.example_wait.workspace - pod is Ready","hook":{"action":{"addr":"action.example_wait.workspace","module":"","action":"action.example_wait.workspace","implied_provider":"example","action_type":"example_wait","action_name":"workspace","action_key":null},"message":"pod is Ready","lifecycle":{"resource":{"addr":"kubernetes_deployment_v1.main[0]"},"trigger_index":0,"actions_index":0,"trigger_event":"AfterCreate","on_failure":"ActionOnFailureHalt"}},"type":"action_progress"}`,
wantMessage: "kubernetes_deployment_v1.main[0] (0): action.example_wait.workspace - pod is Ready",
wantAction: "action.example_wait.workspace",
},
{
name: "ActionStart",
line: `{"@level":"info","@message":"kubernetes_deployment_v1.main[0].trigger[0]: Action started: action.example_wait.workspace","hook":{"action":{"addr":"action.example_wait.workspace"},"lifecycle":{"resource":{"addr":"kubernetes_deployment_v1.main[0]"}}},"type":"action_start"}`,
wantMessage: "kubernetes_deployment_v1.main[0].trigger[0]: Action started: action.example_wait.workspace",
wantAction: "action.example_wait.workspace",
},
{
// Anything else still falls back to logging the raw line.
name: "UnknownShape",
line: `{"@level":"info","@message":"x","hook":{"action":42},"type":"apply_start"}`,
wantMessage: `{"@level":"info","@message":"x","hook":{"action":42},"type":"apply_start"}`,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
t.Parallel()
log := parseTerraformLogLine([]byte(tt.line))
require.NotNil(t, log)
require.Equal(t, "info", log.Level)
require.Equal(t, tt.wantMessage, log.Message)
require.Equal(t, tt.wantAction, log.Hook.Action)
})
}
}
Loading