-
Notifications
You must be signed in to change notification settings - Fork 9.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #31821 from glennsarti/gs/TF-707-add-pre-apply
Add support for pre-apply task results in the cloud backend
- Loading branch information
Showing
6 changed files
with
262 additions
and
32 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| package cloud | ||
|
|
||
| import ( | ||
| "context" | ||
| "strings" | ||
|
|
||
| tfe "github.com/hashicorp/go-tfe" | ||
| ) | ||
|
|
||
| type taskStages map[tfe.Stage]*tfe.TaskStage | ||
|
|
||
| func (b *Cloud) runTaskStages(ctx context.Context, client *tfe.Client, runId string) (taskStages, error) { | ||
| taskStages := make(taskStages, 0) | ||
| result, err := client.Runs.ReadWithOptions(ctx, runId, &tfe.RunReadOptions{ | ||
| Include: []tfe.RunIncludeOpt{tfe.RunTaskStages}, | ||
| }) | ||
| if err == nil { | ||
| for _, t := range result.TaskStages { | ||
| if t != nil { | ||
| taskStages[t.Stage] = t | ||
| } | ||
| } | ||
| } else { | ||
| // This error would be expected for older versions of TFE that do not allow | ||
| // fetching task_stages. | ||
| if !strings.HasSuffix(err.Error(), "Invalid include parameter") { | ||
| return taskStages, generalError("Failed to retrieve run", err) | ||
| } | ||
| } | ||
|
|
||
| return taskStages, nil | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,207 @@ | ||
| package cloud | ||
|
|
||
| import ( | ||
| "context" | ||
| "errors" | ||
| "testing" | ||
|
|
||
| "github.com/golang/mock/gomock" | ||
| "github.com/hashicorp/go-tfe" | ||
| tfemocks "github.com/hashicorp/go-tfe/mocks" | ||
| ) | ||
|
|
||
| func MockAllTaskStages(t *testing.T, client *tfe.Client) (RunID string) { | ||
| ctrl := gomock.NewController(t) | ||
|
|
||
| RunID = "run-all_task_stages" | ||
|
|
||
| mockRunsAPI := tfemocks.NewMockRuns(ctrl) | ||
|
|
||
| goodRun := tfe.Run{ | ||
| TaskStages: []*tfe.TaskStage{ | ||
| { | ||
| Stage: tfe.PrePlan, | ||
| }, | ||
| { | ||
| Stage: tfe.PostPlan, | ||
| }, | ||
| { | ||
| Stage: tfe.PreApply, | ||
| }, | ||
| }, | ||
| } | ||
| mockRunsAPI. | ||
| EXPECT(). | ||
| ReadWithOptions(gomock.Any(), RunID, gomock.Any()). | ||
| Return(&goodRun, nil). | ||
| AnyTimes() | ||
|
|
||
| // Mock a bad Read response | ||
| mockRunsAPI. | ||
| EXPECT(). | ||
| ReadWithOptions(gomock.Any(), gomock.Any(), gomock.Any()). | ||
| Return(nil, tfe.ErrInvalidOrg). | ||
| AnyTimes() | ||
|
|
||
| // Wire up the mock interfaces | ||
| client.Runs = mockRunsAPI | ||
| return | ||
| } | ||
|
|
||
| func MockPrePlanTaskStage(t *testing.T, client *tfe.Client) (RunID string) { | ||
| ctrl := gomock.NewController(t) | ||
|
|
||
| RunID = "run-pre_plan_task_stage" | ||
|
|
||
| mockRunsAPI := tfemocks.NewMockRuns(ctrl) | ||
|
|
||
| goodRun := tfe.Run{ | ||
| TaskStages: []*tfe.TaskStage{ | ||
| { | ||
| Stage: tfe.PrePlan, | ||
| }, | ||
| }, | ||
| } | ||
| mockRunsAPI. | ||
| EXPECT(). | ||
| ReadWithOptions(gomock.Any(), RunID, gomock.Any()). | ||
| Return(&goodRun, nil). | ||
| AnyTimes() | ||
|
|
||
| // Mock a bad Read response | ||
| mockRunsAPI. | ||
| EXPECT(). | ||
| ReadWithOptions(gomock.Any(), gomock.Any(), gomock.Any()). | ||
| Return(nil, tfe.ErrInvalidOrg). | ||
| AnyTimes() | ||
|
|
||
| // Wire up the mock interfaces | ||
| client.Runs = mockRunsAPI | ||
| return | ||
| } | ||
|
|
||
| func MockTaskStageUnsupported(t *testing.T, client *tfe.Client) (RunID string) { | ||
| ctrl := gomock.NewController(t) | ||
|
|
||
| RunID = "run-unsupported_task_stage" | ||
|
|
||
| mockRunsAPI := tfemocks.NewMockRuns(ctrl) | ||
|
|
||
| mockRunsAPI. | ||
| EXPECT(). | ||
| ReadWithOptions(gomock.Any(), RunID, gomock.Any()). | ||
| Return(nil, errors.New("Invalid include parameter")). | ||
| AnyTimes() | ||
|
|
||
| mockRunsAPI. | ||
| EXPECT(). | ||
| ReadWithOptions(gomock.Any(), gomock.Any(), gomock.Any()). | ||
| Return(nil, tfe.ErrInvalidOrg). | ||
| AnyTimes() | ||
|
|
||
| client.Runs = mockRunsAPI | ||
| return | ||
| } | ||
|
|
||
| func TestTaskStagesWithAllStages(t *testing.T) { | ||
| b, bCleanup := testBackendWithName(t) | ||
| defer bCleanup() | ||
|
|
||
| config := &tfe.Config{ | ||
| Token: "not-a-token", | ||
| } | ||
| client, _ := tfe.NewClient(config) | ||
| runID := MockAllTaskStages(t, client) | ||
|
|
||
| ctx := context.TODO() | ||
| taskStages, err := b.runTaskStages(ctx, client, runID) | ||
|
|
||
| if err != nil { | ||
| t.Fatalf("Expected to not error but received %s", err) | ||
| } | ||
|
|
||
| for _, stageName := range []tfe.Stage{ | ||
| tfe.PrePlan, | ||
| tfe.PostPlan, | ||
| tfe.PreApply, | ||
| } { | ||
| if stage, ok := taskStages[stageName]; ok { | ||
| if stage.Stage != stageName { | ||
| t.Errorf("Expected task stage indexed by %s to find a Task Stage with the same index, but receieved %s", stageName, stage.Stage) | ||
| } | ||
| } else { | ||
| t.Errorf("Expected task stage indexed by %s to exist, but it did not", stageName) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| func TestTaskStagesWithOneStage(t *testing.T) { | ||
| b, bCleanup := testBackendWithName(t) | ||
| defer bCleanup() | ||
|
|
||
| config := &tfe.Config{ | ||
| Token: "not-a-token", | ||
| } | ||
| client, _ := tfe.NewClient(config) | ||
| runID := MockPrePlanTaskStage(t, client) | ||
|
|
||
| ctx := context.TODO() | ||
| taskStages, err := b.runTaskStages(ctx, client, runID) | ||
|
|
||
| if err != nil { | ||
| t.Fatalf("Expected to not error but received %s", err) | ||
| } | ||
|
|
||
| if _, ok := taskStages[tfe.PrePlan]; !ok { | ||
| t.Errorf("Expected task stage indexed by %s to exist, but it did not", tfe.PrePlan) | ||
| } | ||
|
|
||
| for _, stageName := range []tfe.Stage{ | ||
| tfe.PostPlan, | ||
| tfe.PreApply, | ||
| } { | ||
| if _, ok := taskStages[stageName]; ok { | ||
| t.Errorf("Expected task stage indexed by %s to not exist, but it did", stageName) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| func TestTaskStagesWithOldTFC(t *testing.T) { | ||
| b, bCleanup := testBackendWithName(t) | ||
| defer bCleanup() | ||
|
|
||
| config := &tfe.Config{ | ||
| Token: "not-a-token", | ||
| } | ||
| client, _ := tfe.NewClient(config) | ||
| runID := MockTaskStageUnsupported(t, client) | ||
|
|
||
| ctx := context.TODO() | ||
| taskStages, err := b.runTaskStages(ctx, client, runID) | ||
|
|
||
| if err != nil { | ||
| t.Fatalf("Expected to not error but received %s", err) | ||
| } | ||
|
|
||
| if len(taskStages) != 0 { | ||
| t.Errorf("Expected task stage to be empty, but found %d stages", len(taskStages)) | ||
| } | ||
| } | ||
|
|
||
| func TestTaskStagesWithErrors(t *testing.T) { | ||
| b, bCleanup := testBackendWithName(t) | ||
| defer bCleanup() | ||
|
|
||
| config := &tfe.Config{ | ||
| Token: "not-a-token", | ||
| } | ||
| client, _ := tfe.NewClient(config) | ||
| MockTaskStageUnsupported(t, client) | ||
|
|
||
| ctx := context.TODO() | ||
| _, err := b.runTaskStages(ctx, client, "this run ID will not exist is invalid anyway") | ||
|
|
||
| if err == nil { | ||
| t.Error("Expected to error but did not") | ||
| } | ||
| } |