Skip to content

Commit

Permalink
SUP-1361: Add timeouts to pipeline resource api (#385)
Browse files Browse the repository at this point in the history 
* Add retries to pipeline resource

* Update changelog
  • Loading branch information
@lizrabuya
lizrabuya authored Sep 1, 2023
1 parent ef09b49 commit 777660b
Show file tree
Hide file tree
Showing 2 changed files with 115 additions and 28 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ All notable changes to this project will be documented in this file.
- SUP-1322: Team member resource retries [[PR #381](https://github.com/buildkite/terraform-provider-buildkite/pull/381)] @james2791
- SUP-1402: Agent token resource retries [[PR #382](https://github.com/buildkite/terraform-provider-buildkite/pull/382)] @james2791
- SUP-1399: Add retry to pipeline team resource [[PR #384](https://github.com/buildkite/terraform-provider-buildkite/pull/384)] @lizrabuya
- SUP-1361: Add timeouts to pipeline resource api[[PR #385](https://github.com/buildkite/terraform-provider-buildkite/pull/385)] @lizrabuya

### Changes

Expand Down
142 changes: 114 additions & 28 deletions buildkite/resource_pipeline.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import (
"context"
"fmt"
"log"
"time"
"unsafe"

custom_modifier "github.com/buildkite/terraform-provider-buildkite/internal/planmodifier"
Expand All @@ -22,6 +23,7 @@ import (
"github.com/hashicorp/terraform-plugin-framework/resource/schema/stringplanmodifier"
"github.com/hashicorp/terraform-plugin-framework/schema/validator"
"github.com/hashicorp/terraform-plugin-framework/types"
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/retry"
"github.com/shurcooL/graphql"
)

Expand Down Expand Up @@ -214,8 +216,19 @@ func (p *pipelineResource) Create(ctx context.Context, req resource.CreateReques
Tags: getTagsFromSchema(&plan),
}

timeouts, diags := p.client.timeouts.Create(ctx, DefaultTimeout)
resp.Diagnostics.Append(diags...)
if resp.Diagnostics.HasError() {
return
}

var response *createPipelineResponse
log.Printf("Creating pipeline %s ...", plan.Name.ValueString())
response, err := createPipeline(ctx, p.client.genqlient, input)
err := retry.RetryContext(ctx, timeouts, func() *retry.RetryError {
var err error
response, err = createPipeline(ctx, p.client.genqlient, input)
return retryContextError(err)
})

if err != nil {
resp.Diagnostics.AddError("Failed to create pipeline", err.Error())
Expand All @@ -237,7 +250,7 @@ func (p *pipelineResource) Create(ctx context.Context, req resource.CreateReques
state.Teams = teams

if len(plan.ProviderSettings) > 0 {
pipelineExtraInfo, err := updatePipelineExtraInfo(ctx, response.PipelineCreate.Pipeline.Slug, plan.ProviderSettings[0], p.client)
pipelineExtraInfo, err := updatePipelineExtraInfo(ctx, response.PipelineCreate.Pipeline.Slug, plan.ProviderSettings[0], p.client, timeouts)
if err != nil {
resp.Diagnostics.AddError("Unable to set pipeline info from REST", err.Error())
return
Expand All @@ -246,7 +259,7 @@ func (p *pipelineResource) Create(ctx context.Context, req resource.CreateReques
updatePipelineResourceExtraInfo(&state, &pipelineExtraInfo)
} else {
// no provider_settings provided, but we still need to read in the badge url
extraInfo, err := getPipelineExtraInfo(ctx, p.client, response.PipelineCreate.Pipeline.Slug)
extraInfo, err := getPipelineExtraInfo(ctx, p.client, response.PipelineCreate.Pipeline.Slug, timeouts)
if err != nil {
resp.Diagnostics.AddError("Unable to read pipeline info from REST", err.Error())
return
Expand All @@ -265,17 +278,31 @@ func (p *pipelineResource) Delete(ctx context.Context, req resource.DeleteReques
return
}

timeout, diags := p.client.timeouts.Delete(ctx, DefaultTimeout)
resp.Diagnostics.Append(diags...)
if resp.Diagnostics.HasError() {
return
}

if p.archiveOnDelete {
log.Printf("Pipeline %s set to archive on delete. Archiving...", state.Name.ValueString())
_, err := archivePipeline(ctx, p.client.genqlient, state.Id.ValueString())

err := retry.RetryContext(ctx, timeout, func() *retry.RetryError {
_, err := archivePipeline(ctx, p.client.genqlient, state.Id.ValueString())
return retryContextError(err)
})
if err != nil {
resp.Diagnostics.AddError("Could not archive pipeline", err.Error())
}
return
}

log.Printf("Deleting pipeline %s ...", state.Name.ValueString())
_, err := deletePipeline(ctx, p.client.genqlient, state.Id.ValueString())
err := retry.RetryContext(ctx, timeout, func() *retry.RetryError {
log.Printf("Deleting pipeline %s ...", state.Name.ValueString())
_, err := deletePipeline(ctx, p.client.genqlient, state.Id.ValueString())
return retryContextError(err)
})

if err != nil {
resp.Diagnostics.AddError("Could not delete pipeline", err.Error())
}
Expand All @@ -293,7 +320,19 @@ func (p *pipelineResource) Read(ctx context.Context, req resource.ReadRequest, r
return
}

response, err := getNode(ctx, p.client.genqlient, state.Id.ValueString())
timeouts, diags := p.client.timeouts.Read(ctx, DefaultTimeout)
resp.Diagnostics.Append(diags...)
if resp.Diagnostics.HasError() {
return
}

var response *getNodeResponse
err := retry.RetryContext(ctx, timeouts, func() *retry.RetryError {
var err error
response, err = getNode(ctx, p.client.genqlient, state.Id.ValueString())
return retryContextError(err)
})

if err != nil {
resp.Diagnostics.AddError(
"Unable to read pipeline",
Expand All @@ -309,7 +348,7 @@ func (p *pipelineResource) Read(ctx context.Context, req resource.ReadRequest, r
return
}

extraInfo, err := getPipelineExtraInfo(ctx, p.client, pipelineNode.Slug)
extraInfo, err := getPipelineExtraInfo(ctx, p.client, pipelineNode.Slug, timeouts)
if err != nil {
resp.Diagnostics.AddError("Unable to read pipeline info from REST", err.Error())
return
Expand Down Expand Up @@ -612,8 +651,19 @@ func (p *pipelineResource) Update(ctx context.Context, req resource.UpdateReques
Tags: getTagsFromSchema(&plan),
}

log.Printf("Updating pipeline %s ...", input.Name)
response, err := updatePipeline(ctx, p.client.genqlient, input)
timeouts, diags := p.client.timeouts.Read(ctx, DefaultTimeout)
resp.Diagnostics.Append(diags...)
if resp.Diagnostics.HasError() {
return
}

var response *updatePipelineResponse
err := retry.RetryContext(ctx, timeouts, func() *retry.RetryError {
var err error
log.Printf("Updating pipeline %s ...", input.Name)
response, err = updatePipeline(ctx, p.client.genqlient, input)
return retryContextError(err)
})

if err != nil {
resp.Diagnostics.AddError("Unable to update pipeline %s", state.Name.ValueString())
Expand All @@ -623,15 +673,15 @@ func (p *pipelineResource) Update(ctx context.Context, req resource.UpdateReques
setPipelineModel(&state, &response.PipelineUpdate.Pipeline)

// plan.Teams has what we want. state.Teams has what exists on the server. we need to make them match
err = p.reconcileTeamPipelinesToPlan(ctx, plan.Teams, state.Teams, &response.PipelineUpdate.Pipeline, response.PipelineUpdate.Pipeline.Id)
err = p.reconcileTeamPipelinesToPlan(ctx, plan.Teams, state.Teams, &response.PipelineUpdate.Pipeline, response.PipelineUpdate.Pipeline.Id, timeouts)
if err != nil {
resp.Diagnostics.AddError("Unable to reconcile team pipelines", err.Error())
return
}
state.Teams = plan.Teams

if len(plan.ProviderSettings) > 0 {
pipelineExtraInfo, err := updatePipelineExtraInfo(ctx, response.PipelineUpdate.Pipeline.Slug, plan.ProviderSettings[0], p.client)
pipelineExtraInfo, err := updatePipelineExtraInfo(ctx, response.PipelineUpdate.Pipeline.Slug, plan.ProviderSettings[0], p.client, timeouts)
if err != nil {
resp.Diagnostics.AddError("Unable to set pipeline info from REST", err.Error())
return
Expand All @@ -640,7 +690,7 @@ func (p *pipelineResource) Update(ctx context.Context, req resource.UpdateReques
updatePipelineResourceExtraInfo(&state, &pipelineExtraInfo)
} else {
// no provider_settings provided, but we still need to read in the badge url
extraInfo, err := getPipelineExtraInfo(ctx, p.client, response.PipelineUpdate.Pipeline.Slug)
extraInfo, err := getPipelineExtraInfo(ctx, p.client, response.PipelineUpdate.Pipeline.Slug, timeouts)
if err != nil {
resp.Diagnostics.AddError("Unable to read pipeline info from REST", err.Error())
return
Expand Down Expand Up @@ -719,15 +769,21 @@ type PipelineExtraSettings struct {
SeparatePullRequestStatuses *bool `json:"separate_pull_request_statuses,omitempty"`
}

func getPipelineExtraInfo(ctx context.Context, client *Client, slug string) (*PipelineExtraInfo, error) {
func getPipelineExtraInfo(ctx context.Context, client *Client, slug string, timeouts time.Duration) (*PipelineExtraInfo, error) {
pipelineExtraInfo := PipelineExtraInfo{}
err := client.makeRequest(ctx, "GET", fmt.Sprintf("/v2/organizations/%s/pipelines/%s", client.organization, slug), nil, &pipelineExtraInfo)

err := retry.RetryContext(ctx, timeouts, func() *retry.RetryError {
err := client.makeRequest(ctx, "GET", fmt.Sprintf("/v2/organizations/%s/pipelines/%s", client.organization, slug), nil, &pipelineExtraInfo)
return retryContextError(err)
})

if err != nil {
return nil, err
}

return &pipelineExtraInfo, nil
}
func updatePipelineExtraInfo(ctx context.Context, slug string, settings *providerSettingsModel, client *Client) (PipelineExtraInfo, error) {
func updatePipelineExtraInfo(ctx context.Context, slug string, settings *providerSettingsModel, client *Client, timeouts time.Duration) (PipelineExtraInfo, error) {
payload := map[string]any{
"provider_settings": PipelineExtraSettings{
TriggerMode: settings.TriggerMode.ValueStringPointer(),
Expand All @@ -753,7 +809,11 @@ func updatePipelineExtraInfo(ctx context.Context, slug string, settings *provide
}

pipelineExtraInfo := PipelineExtraInfo{}
err := client.makeRequest(ctx, "PATCH", fmt.Sprintf("/v2/organizations/%s/pipelines/%s", client.organization, slug), payload, &pipelineExtraInfo)
err := retry.RetryContext(ctx, timeouts, func() *retry.RetryError {
err := client.makeRequest(ctx, "PATCH", fmt.Sprintf("/v2/organizations/%s/pipelines/%s", client.organization, slug), payload, &pipelineExtraInfo)
return retryContextError(err)
})

if err != nil {
return pipelineExtraInfo, err
}
Expand Down Expand Up @@ -788,7 +848,7 @@ func (p *pipelineResource) getTeamPipelinesFromSchema(plan *pipelineResourceMode
}

// reconcileTeamPipelines plan.Teams has what we want - adds/updates/deletes the teamPipelines on buildkite to match the teams in terraform resource data
func (p *pipelineResource) reconcileTeamPipelinesToPlan(ctx context.Context, planTeams []*pipelineTeamModel, stateTeams []*pipelineTeamModel, data pipelineResponse, pipelineId string) error {
func (p *pipelineResource) reconcileTeamPipelinesToPlan(ctx context.Context, planTeams []*pipelineTeamModel, stateTeams []*pipelineTeamModel, data pipelineResponse, pipelineId string, timeouts time.Duration) error {

var toAdd []*pipelineTeamModel
var toUpdate []*pipelineTeamModel
Expand Down Expand Up @@ -840,19 +900,19 @@ func (p *pipelineResource) reconcileTeamPipelinesToPlan(ctx context.Context, pla
}

// Add any teams that don't already exist
err := createTeamPipelines(ctx, toAdd, pipelineId, p.client)
err := createTeamPipelines(ctx, toAdd, pipelineId, p.client, timeouts)
if err != nil {
return err
}

// Update any teams access levels that need updating
err = updateTeamPipelines(ctx, toUpdate, p.client)
err = updateTeamPipelines(ctx, toUpdate, p.client, timeouts)
if err != nil {
return err
}

// Remove any teams that shouldn't exist
err = deleteTeamPipelines(ctx, toDelete, p.client)
err = deleteTeamPipelines(ctx, toDelete, p.client, timeouts)
if err != nil {
return err
}
Expand All @@ -861,14 +921,24 @@ func (p *pipelineResource) reconcileTeamPipelinesToPlan(ctx context.Context, pla
}

// createTeamPipelines grants access to a pipeline for the teams specified
func createTeamPipelines(ctx context.Context, teamPipelines []*pipelineTeamModel, pipelineID string, client *Client) error {
func createTeamPipelines(ctx context.Context, teamPipelines []*pipelineTeamModel, pipelineID string, client *Client, timeouts time.Duration) error {
for _, teamPipeline := range teamPipelines {
log.Printf("Granting teamPipeline %s %s access to pipeline id '%s'...", teamPipeline.Slug, teamPipeline.AccessLevel, pipelineID)
teamID, err := GetTeamID(string(teamPipeline.Slug.ValueString()), client)
var teamID string
err := retry.RetryContext(ctx, timeouts, func() *retry.RetryError {
var err error
teamID, err = GetTeamID(string(teamPipeline.Slug.ValueString()), client)
return retryContextError(err)
})
if err != nil {
return fmt.Errorf("Unable to get ID for team slug %s (%v)", teamPipeline.Slug.ValueString(), err)
}
resp, err := teamPipelineCreate(ctx, client.genqlient, teamID, pipelineID, PipelineAccessLevels(teamPipeline.AccessLevel.ValueString()))
var resp *teamPipelineCreateResponse
err = retry.RetryContext(ctx, timeouts, func() *retry.RetryError {
var err error
resp, err = teamPipelineCreate(ctx, client.genqlient, teamID, pipelineID, PipelineAccessLevels(teamPipeline.AccessLevel.ValueString()))
return retryContextError(err)
})
if err != nil {
log.Printf("Unable to create team pipeline %s", teamPipeline.Slug)
return err
Expand All @@ -880,10 +950,13 @@ func createTeamPipelines(ctx context.Context, teamPipelines []*pipelineTeamModel
}

// Update access levels for the given teamPipelines
func updateTeamPipelines(ctx context.Context, teamPipelines []*pipelineTeamModel, client *Client) error {
func updateTeamPipelines(ctx context.Context, teamPipelines []*pipelineTeamModel, client *Client, timeouts time.Duration) error {
for _, teamPipeline := range teamPipelines {
log.Printf("Updating access to %s for teamPipeline id '%s'...", teamPipeline.AccessLevel, teamPipeline.PipelineTeamId)
_, err := teamPipelineUpdate(ctx, client.genqlient, teamPipeline.PipelineTeamId.ValueString(), PipelineAccessLevels(teamPipeline.AccessLevel.ValueString()))
err := retry.RetryContext(ctx, timeouts, func() *retry.RetryError {
_, err := teamPipelineUpdate(ctx, client.genqlient, teamPipeline.PipelineTeamId.ValueString(), PipelineAccessLevels(teamPipeline.AccessLevel.ValueString()))
return retryContextError(err)
})
if err != nil {
log.Printf("Unable to update team pipeline")
return err
Expand All @@ -892,10 +965,13 @@ func updateTeamPipelines(ctx context.Context, teamPipelines []*pipelineTeamModel
return nil
}

func deleteTeamPipelines(ctx context.Context, teamPipelines []*pipelineTeamModel, client *Client) error {
func deleteTeamPipelines(ctx context.Context, teamPipelines []*pipelineTeamModel, client *Client, timeouts time.Duration) error {
for _, teamPipeline := range teamPipelines {
log.Printf("Removing access for teamPipeline %s (id=%s)...", teamPipeline.Slug, teamPipeline.PipelineTeamId)
_, err := teamPipelineDelete(ctx, client.genqlient, teamPipeline.PipelineTeamId.ValueString())
err := retry.RetryContext(ctx, timeouts, func() *retry.RetryError {
_, err := teamPipelineDelete(ctx, client.genqlient, teamPipeline.PipelineTeamId.ValueString())
return retryContextError(err)
})
if err != nil {
log.Printf("Unable to delete team pipeline")
return err
Expand Down Expand Up @@ -933,3 +1009,13 @@ func updatePipelineResourceExtraInfo(state *pipelineResourceModel, pipeline *Pip
},
}
}

func retryContextError(err error) *retry.RetryError {
if err != nil {
if isRetryableError(err) {
return retry.RetryableError(err)
}
return retry.NonRetryableError(err)
}
return nil
}

0 comments on commit 777660b

Please sign in to comment.