From 695c6cc245afaf70997923b57f446ffa051f7cb5 Mon Sep 17 00:00:00 2001 From: Carlos Gajardo Date: Tue, 27 Feb 2024 00:42:58 -0300 Subject: [PATCH] Migrate datasource pagerduty_service --- .../data_source_pagerduty_service.go | 148 ++++++++++++++++++ .../data_source_pagerduty_service_test.go | 13 +- 2 files changed, 154 insertions(+), 7 deletions(-) create mode 100644 pagerdutyplugin/data_source_pagerduty_service.go rename {pagerduty => pagerdutyplugin}/data_source_pagerduty_service_test.go (93%) diff --git a/pagerdutyplugin/data_source_pagerduty_service.go b/pagerdutyplugin/data_source_pagerduty_service.go new file mode 100644 index 000000000..d3f47733f --- /dev/null +++ b/pagerdutyplugin/data_source_pagerduty_service.go @@ -0,0 +1,148 @@ +package pagerduty + +import ( + "context" + "fmt" + "log" + "time" + + "github.com/PagerDuty/go-pagerduty" + "github.com/PagerDuty/terraform-provider-pagerduty/util" + "github.com/hashicorp/terraform-plugin-framework/attr" + "github.com/hashicorp/terraform-plugin-framework/datasource" + "github.com/hashicorp/terraform-plugin-framework/datasource/schema" + "github.com/hashicorp/terraform-plugin-framework/diag" + "github.com/hashicorp/terraform-plugin-framework/path" + "github.com/hashicorp/terraform-plugin-framework/types" + "github.com/hashicorp/terraform-plugin-sdk/v2/helper/retry" +) + +type dataSourceService struct{ client *pagerduty.Client } + +var _ datasource.DataSource = (*dataSourceService)(nil) + +func (d *dataSourceService) Metadata(ctx context.Context, req datasource.MetadataRequest, resp *datasource.MetadataResponse) { +} + +func (d *dataSourceService) Schema(ctx context.Context, req datasource.SchemaRequest, resp *datasource.SchemaResponse) { + resp.Schema = schema.Schema{ + Attributes: map[string]schema.Attribute{ + "id": schema.StringAttribute{Computed: true}, + "name": schema.StringAttribute{Required: true}, + "auto_resolve_timeout": schema.Int64Attribute{Computed: true}, + "acknowledgement_timeout": schema.Int64Attribute{Computed: true}, + "alert_creation": schema.StringAttribute{Computed: true}, + "description": schema.StringAttribute{Computed: true}, + "escalation_policy": schema.StringAttribute{Computed: true}, + "type": schema.StringAttribute{Computed: true}, + "teams": schema.ListNestedAttribute{ + Computed: true, + Description: "The set of teams associated with the service", + NestedObject: schema.NestedAttributeObject{ + Attributes: map[string]schema.Attribute{ + "id": schema.StringAttribute{Computed: true}, + "name": schema.StringAttribute{Computed: true}, + }, + }, + }, + }, + } +} + +func (d *dataSourceService) Read(ctx context.Context, req datasource.ReadRequest, resp *datasource.ReadResponse) { + log.Printf("[INFO] Reading PagerDuty service") + + var searchName types.String + if d := req.Config.GetAttribute(ctx, path.Root("name"), &searchName); d.HasError() { + resp.Diagnostics.Append(d...) + return + } + opts := pagerduty.ListServiceOptions{Query: searchName.ValueString()} + + var found *pagerduty.Service + err := retry.RetryContext(ctx, 5*time.Minute, func() *retry.RetryError { + resp, err := d.client.ListServicesWithContext(ctx, opts) + if err != nil { + if util.IsBadRequestError(err) { + return retry.NonRetryableError(err) + } + + // Delaying retry by 30s as recommended by PagerDuty + // https://developer.pagerduty.com/docs/rest-api-v2/rate-limiting/#what-are-possible-workarounds-to-the-events-api-rate-limit + time.Sleep(30 * time.Second) + return retry.RetryableError(err) + } + + for _, service := range resp.Services { + if service.Name == searchName.ValueString() { + found = &service + break + } + } + return nil + }) + if err != nil { + resp.Diagnostics.AddError( + fmt.Sprintf("Error searching Service %s", searchName), + err.Error(), + ) + return + } + + if found == nil { + resp.Diagnostics.AddError( + fmt.Sprintf("Unable to locate any service with the name: %s", searchName), + "", + ) + return + } + model := flattenServiceData(ctx, found, &resp.Diagnostics) + resp.Diagnostics.Append(resp.State.Set(ctx, &model)...) +} + +type dataSourceServiceModel struct { + ID types.String `tfsdk:"id"` + Name types.String `tfsdk:"name"` + AutoResolveTimeout types.Int64 `tfsdk:"auto_resolve_timeout"` + AcknowledgementTimeout types.Int64 `tfsdk:"acknowledgement_timeout"` + AlertCreation types.String `tfsdk:"alert_creation"` + Description types.String `tfsdk:"description"` + EscalationPolicy types.String `tfsdk:"escalation_policy"` + Type types.String `tfsdk:"type"` + Teams types.List `tfsdk:"teams"` +} + +func flattenServiceData(ctx context.Context, service *pagerduty.Service, diags *diag.Diagnostics) dataSourceServiceModel { + teamObjectType := types.ObjectType{ + AttrTypes: map[string]attr.Type{ + "id": types.StringType, + "name": types.StringType, + }, + } + + teams, d := types.ListValueFrom(ctx, teamObjectType, service.Teams) + diags.Append(d...) + if d.HasError() { + return dataSourceServiceModel{} + } + + model := dataSourceServiceModel{ + ID: types.StringValue(service.ID), + Name: types.StringValue(service.Name), + Type: types.StringValue(service.Type), + AutoResolveTimeout: types.Int64Null(), + AcknowledgementTimeout: types.Int64Null(), + AlertCreation: types.StringValue(service.AlertCreation), + Description: types.StringValue(service.Description), + EscalationPolicy: types.StringValue(service.EscalationPolicy.ID), + Teams: teams, + } + + if service.AutoResolveTimeout != nil { + model.AutoResolveTimeout = types.Int64Value(int64(*service.AutoResolveTimeout)) + } + if service.AcknowledgementTimeout != nil { + model.AcknowledgementTimeout = types.Int64Value(int64(*service.AcknowledgementTimeout)) + } + return model +} diff --git a/pagerduty/data_source_pagerduty_service_test.go b/pagerdutyplugin/data_source_pagerduty_service_test.go similarity index 93% rename from pagerduty/data_source_pagerduty_service_test.go rename to pagerdutyplugin/data_source_pagerduty_service_test.go index cefdf1985..19afe2ae6 100644 --- a/pagerduty/data_source_pagerduty_service_test.go +++ b/pagerdutyplugin/data_source_pagerduty_service_test.go @@ -17,8 +17,8 @@ func TestAccDataSourcePagerDutyService_Basic(t *testing.T) { teamname := fmt.Sprintf("tf-%s", acctest.RandString(5)) resource.Test(t, resource.TestCase{ - PreCheck: func() { testAccPreCheck(t) }, - Providers: testAccProviders, + PreCheck: func() { testAccPreCheck(t) }, + ProtoV5ProviderFactories: testAccProtoV5ProviderFactories(), Steps: []resource.TestStep{ { Config: testAccDataSourcePagerDutyServiceConfig(username, email, service, escalationPolicy, teamname), @@ -38,8 +38,8 @@ func TestAccDataSourcePagerDutyService_HasNoTeam(t *testing.T) { teamname := fmt.Sprintf("tf-%s", acctest.RandString(5)) resource.Test(t, resource.TestCase{ - PreCheck: func() { testAccPreCheck(t) }, - Providers: testAccProviders, + PreCheck: func() { testAccPreCheck(t) }, + ProtoV5ProviderFactories: testAccProtoV5ProviderFactories(), Steps: []resource.TestStep{ { Config: testAccDataSourcePagerDutyServiceConfig(username, email, service, escalationPolicy, teamname), @@ -59,8 +59,8 @@ func TestAccDataSourcePagerDutyService_HasOneTeam(t *testing.T) { teamname := fmt.Sprintf("tf-%s", acctest.RandString(5)) resource.Test(t, resource.TestCase{ - PreCheck: func() { testAccPreCheck(t) }, - Providers: testAccProviders, + PreCheck: func() { testAccPreCheck(t) }, + ProtoV5ProviderFactories: testAccProtoV5ProviderFactories(), Steps: []resource.TestStep{ { Config: testAccDataSourcePagerDutyServiceConfig(username, email, service, escalationPolicy, teamname), @@ -75,7 +75,6 @@ func TestAccDataSourcePagerDutyService_HasOneTeam(t *testing.T) { func testAccDataSourcePagerDutyService(src, n string) resource.TestCheckFunc { return func(s *terraform.State) error { - srcR := s.RootModule().Resources[src] srcA := srcR.Primary.Attributes