package views import ( "fmt" "testing" "time" "github.com/hashicorp/terraform/internal/addrs" "github.com/hashicorp/terraform/internal/terminal" "github.com/hashicorp/terraform/plans" "github.com/hashicorp/terraform/states" "github.com/hashicorp/terraform/terraform" "github.com/zclconf/go-cty/cty" ) // Test a sequence of hooks associated with creating a resource func TestJSONHook_create(t *testing.T) { streams, done := terminal.StreamsForTesting(t) hook := newJSONHook(NewJSONView(NewView(streams))) now := time.Now() hook.timeNow = func() time.Time { return now } after := make(chan time.Time, 1) hook.timeAfter = func(time.Duration) <-chan time.Time { return after } addr := addrs.Resource{ Mode: addrs.ManagedResourceMode, Type: "test_instance", Name: "boop", }.Instance(addrs.NoKey).Absolute(addrs.RootModuleInstance) priorState := cty.NullVal(cty.Object(map[string]cty.Type{ "id": cty.String, "bar": cty.List(cty.String), })) plannedNewState := cty.ObjectVal(map[string]cty.Value{ "id": cty.StringVal("test"), "bar": cty.ListVal([]cty.Value{ cty.StringVal("baz"), }), }) action, err := hook.PreApply(addr, states.CurrentGen, plans.Create, priorState, plannedNewState) testHookReturnValues(t, action, err) action, err = hook.PreProvisionInstanceStep(addr, "local-exec") testHookReturnValues(t, action, err) hook.ProvisionOutput(addr, "local-exec", `Executing: ["/bin/sh" "-c" "touch /etc/motd"]`) action, err = hook.PostProvisionInstanceStep(addr, "local-exec", nil) testHookReturnValues(t, action, err) // Travel 10s into the future, notify the progress goroutine, and sleep // briefly to allow it to execute now = now.Add(10 * time.Second) after <- now time.Sleep(1 * time.Millisecond) // Travel 10s into the future, notify the progress goroutine, and sleep // briefly to allow it to execute now = now.Add(10 * time.Second) after <- now time.Sleep(1 * time.Millisecond) // Travel 2s into the future. We have arrived! now = now.Add(2 * time.Second) action, err = hook.PostApply(addr, states.CurrentGen, plannedNewState, nil) testHookReturnValues(t, action, err) // Shut down the progress goroutine if still active hook.applyingLock.Lock() for key, progress := range hook.applying { close(progress.done) <-progress.heartbeatDone delete(hook.applying, key) } hook.applyingLock.Unlock() wantResource := map[string]interface{}{ "addr": string("test_instance.boop"), "implied_provider": string("test"), "module": string(""), "resource": string("test_instance.boop"), "resource_key": nil, "resource_name": string("boop"), "resource_type": string("test_instance"), } want := []map[string]interface{}{ { "@level": "info", "@message": "test_instance.boop: Creating...", "@module": "terraform.ui", "type": "apply_start", "hook": map[string]interface{}{ "action": string("create"), "resource": wantResource, }, }, { "@level": "info", "@message": "test_instance.boop: Provisioning with 'local-exec'...", "@module": "terraform.ui", "type": "provision_start", "hook": map[string]interface{}{ "provisioner": "local-exec", "resource": wantResource, }, }, { "@level": "info", "@message": `test_instance.boop: (local-exec): Executing: ["/bin/sh" "-c" "touch /etc/motd"]`, "@module": "terraform.ui", "type": "provision_progress", "hook": map[string]interface{}{ "output": `Executing: ["/bin/sh" "-c" "touch /etc/motd"]`, "provisioner": "local-exec", "resource": wantResource, }, }, { "@level": "info", "@message": "test_instance.boop: (local-exec) Provisioning complete", "@module": "terraform.ui", "type": "provision_complete", "hook": map[string]interface{}{ "provisioner": "local-exec", "resource": wantResource, }, }, { "@level": "info", "@message": "test_instance.boop: Still creating... [10s elapsed]", "@module": "terraform.ui", "type": "apply_progress", "hook": map[string]interface{}{ "action": string("create"), "elapsed_seconds": float64(10), "resource": wantResource, }, }, { "@level": "info", "@message": "test_instance.boop: Still creating... [20s elapsed]", "@module": "terraform.ui", "type": "apply_progress", "hook": map[string]interface{}{ "action": string("create"), "elapsed_seconds": float64(20), "resource": wantResource, }, }, { "@level": "info", "@message": "test_instance.boop: Creation complete after 22s [id=test]", "@module": "terraform.ui", "type": "apply_complete", "hook": map[string]interface{}{ "action": string("create"), "elapsed_seconds": float64(22), "id_key": "id", "id_value": "test", "resource": wantResource, }, }, } testJSONViewOutputEquals(t, done(t).Stdout(), want) } func TestJSONHook_errors(t *testing.T) { streams, done := terminal.StreamsForTesting(t) hook := newJSONHook(NewJSONView(NewView(streams))) addr := addrs.Resource{ Mode: addrs.ManagedResourceMode, Type: "test_instance", Name: "boop", }.Instance(addrs.NoKey).Absolute(addrs.RootModuleInstance) priorState := cty.NullVal(cty.Object(map[string]cty.Type{ "id": cty.String, "bar": cty.List(cty.String), })) plannedNewState := cty.ObjectVal(map[string]cty.Value{ "id": cty.StringVal("test"), "bar": cty.ListVal([]cty.Value{ cty.StringVal("baz"), }), }) action, err := hook.PreApply(addr, states.CurrentGen, plans.Delete, priorState, plannedNewState) testHookReturnValues(t, action, err) provisionError := fmt.Errorf("provisioner didn't want to") action, err = hook.PostProvisionInstanceStep(addr, "local-exec", provisionError) testHookReturnValues(t, action, err) applyError := fmt.Errorf("provider was sad") action, err = hook.PostApply(addr, states.CurrentGen, plannedNewState, applyError) testHookReturnValues(t, action, err) // Shut down the progress goroutine hook.applyingLock.Lock() for key, progress := range hook.applying { close(progress.done) <-progress.heartbeatDone delete(hook.applying, key) } hook.applyingLock.Unlock() wantResource := map[string]interface{}{ "addr": string("test_instance.boop"), "implied_provider": string("test"), "module": string(""), "resource": string("test_instance.boop"), "resource_key": nil, "resource_name": string("boop"), "resource_type": string("test_instance"), } want := []map[string]interface{}{ { "@level": "info", "@message": "test_instance.boop: Destroying...", "@module": "terraform.ui", "type": "apply_start", "hook": map[string]interface{}{ "action": string("delete"), "resource": wantResource, }, }, { "@level": "info", "@message": "test_instance.boop: (local-exec) Provisioning errored", "@module": "terraform.ui", "type": "provision_errored", "hook": map[string]interface{}{ "provisioner": "local-exec", "resource": wantResource, }, }, { "@level": "info", "@message": "test_instance.boop: Destruction errored after 0s", "@module": "terraform.ui", "type": "apply_errored", "hook": map[string]interface{}{ "action": string("delete"), "elapsed_seconds": float64(0), "resource": wantResource, }, }, } testJSONViewOutputEquals(t, done(t).Stdout(), want) } func TestJSONHook_refresh(t *testing.T) { streams, done := terminal.StreamsForTesting(t) hook := newJSONHook(NewJSONView(NewView(streams))) addr := addrs.Resource{ Mode: addrs.DataResourceMode, Type: "test_data_source", Name: "beep", }.Instance(addrs.NoKey).Absolute(addrs.RootModuleInstance) state := cty.ObjectVal(map[string]cty.Value{ "id": cty.StringVal("honk"), "bar": cty.ListVal([]cty.Value{ cty.StringVal("baz"), }), }) action, err := hook.PreRefresh(addr, states.CurrentGen, state) testHookReturnValues(t, action, err) action, err = hook.PostRefresh(addr, states.CurrentGen, state, state) testHookReturnValues(t, action, err) wantResource := map[string]interface{}{ "addr": string("data.test_data_source.beep"), "implied_provider": string("test"), "module": string(""), "resource": string("data.test_data_source.beep"), "resource_key": nil, "resource_name": string("beep"), "resource_type": string("test_data_source"), } want := []map[string]interface{}{ { "@level": "info", "@message": "data.test_data_source.beep: Refreshing state... [id=honk]", "@module": "terraform.ui", "type": "refresh_start", "hook": map[string]interface{}{ "resource": wantResource, "id_key": "id", "id_value": "honk", }, }, { "@level": "info", "@message": "data.test_data_source.beep: Refresh complete [id=honk]", "@module": "terraform.ui", "type": "refresh_complete", "hook": map[string]interface{}{ "resource": wantResource, "id_key": "id", "id_value": "honk", }, }, } testJSONViewOutputEquals(t, done(t).Stdout(), want) } func testHookReturnValues(t *testing.T, action terraform.HookAction, err error) { t.Helper() if err != nil { t.Fatal(err) } if action != terraform.HookActionContinue { t.Fatalf("Expected hook to continue, given: %#v", action) } }