[datadog_service_definitions] Adds basic data for service definitions

datadog/fwprovider/data_source_datadog_service_definitions.go

@@ -0,0 +1,150 @@
+package fwprovider
+
+import (
+	"context"
+	"encoding/json"
+	"fmt"
+
+	"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
+	"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/types"
+
+	"github.com/terraform-providers/terraform-provider-datadog/datadog/internal/utils"
+)
+
+var (
+	_ datasource.DataSource = &datadogServiceDefinitionsDataSource{}
+)
+
+type ServiceDefinitionSchema struct {
+	Application string `json:"application"`
+	DDService   string `json:"dd-service"`
+	Description string `json:"description"`
+	Team        string `json:"team"`
+	Tier        string `json:"tier"`
+}
+
+type ServiceDefinitionModel struct {
+	ID          types.String `tfsdk:"id" json:"-"`
+	Application types.String `tfsdk:"application"`
+	Service     types.String `tfsdk:"service"`
+	Description types.String `tfsdk:"description"`
+	Team        types.String `tfsdk:"team"`
+}
+
+type datadogServiceDefinitionsDataSourceModel struct {
+	// Query Parameters
+	RetrieveAll types.Bool `tfsdk:"retrieve_all"`
+
+	// Results
+	ID                 types.String              `tfsdk:"id"`
+	ServiceDefinitions []*ServiceDefinitionModel `tfsdk:"service_definitions"`
+}
+
+func NewDatadogServiceDefinitionsDataSource() datasource.DataSource {
+	return &datadogServiceDefinitionsDataSource{}
+}
+
+type datadogServiceDefinitionsDataSource struct {
+	Api  *datadogV2.ServiceDefinitionApi
+	Auth context.Context
+}
+
+func (r *datadogServiceDefinitionsDataSource) Configure(_ context.Context, request datasource.ConfigureRequest, response *datasource.ConfigureResponse) {
+	providerData, _ := request.ProviderData.(*FrameworkProvider)
+	r.Api = providerData.DatadogApiInstances.GetServiceDefinitionApiV2()
+	r.Auth = providerData.Auth
+}
+
+func (d *datadogServiceDefinitionsDataSource) Metadata(_ context.Context, req datasource.MetadataRequest, resp *datasource.MetadataResponse) {
+	resp.TypeName = "service_definitions"
+}
+
+func (d *datadogServiceDefinitionsDataSource) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) {
+	resp.Schema = schema.Schema{
+		Description: "Use this data source to retrieve information about existing Datadog service definitions.",
+		Attributes: map[string]schema.Attribute{
+			// Datasource ID
+			"id": utils.ResourceIDAttribute(),
+			// Datasource Parameters
+			"retrieve_all": schema.BoolAttribute{
+				Description: "Retrieve all service definitions.",
+				Required:    true,
+			},
+
+			// Computed values
+			"service_definitions": schema.ListAttribute{
+				Computed:    true,
+				Description: "List of service definitions.",
+				ElementType: types.ObjectType{
+					AttrTypes: map[string]attr.Type{
+						"id":          types.StringType,
+						"application": types.StringType,
+						"service":     types.StringType,
+						"description": types.StringType,
+						"team":        types.StringType,
+					},
+				},
+			},
+		},
+	}
+
+}
+
+func (d *datadogServiceDefinitionsDataSource) Read(ctx context.Context, req datasource.ReadRequest, resp *datasource.ReadResponse) {
+	var state datadogServiceDefinitionsDataSourceModel
+	resp.Diagnostics.Append(req.Config.Get(ctx, &state)...)
+	if resp.Diagnostics.HasError() {
+		return
+	}
+
+	var optionalParams datadogV2.ListServiceDefinitionsOptionalParameters
+	pageSize := 100
+	pageNumber := int64(0)
+	optionalParams.WithPageSize(int64(pageSize))
+
+	var serviceDefinitons []datadogV2.ServiceDefinitionData
+	for {
+		optionalParams.WithPageNumber(pageNumber)
+
+		ddResp, _, err := d.Api.ListServiceDefinitions(d.Auth, optionalParams)
+		if err != nil {
+			resp.Diagnostics.Append(utils.FrameworkErrorDiag(err, "error getting service definitions"))
+			return
+		}
+
+		serviceDefinitons = append(serviceDefinitons, ddResp.GetData()...)
+		if len(ddResp.GetData()) < pageSize {
+			break
+		}
+		pageNumber++
+	}
+	d.updateState(&state, &serviceDefinitons)
+	resp.Diagnostics.Append(resp.State.Set(ctx, &state)...)
+}
+
+func (r *datadogServiceDefinitionsDataSource) updateState(state *datadogServiceDefinitionsDataSourceModel, serviceDefinitionData *[]datadogV2.ServiceDefinitionData) {
+	var serviceDefinitions []*ServiceDefinitionModel
+
+	for _, serviceDefinition := range *serviceDefinitionData {
+		var schema ServiceDefinitionSchema
+		jsonData, _ := json.MarshalIndent(serviceDefinition.Attributes.Schema, "", "  ")
+		_ = json.Unmarshal(jsonData, &schema)
+
+		s := ServiceDefinitionModel{
+			ID:          types.StringValue(serviceDefinition.GetId()),
+			Application: types.StringValue(schema.Application),
+			Service:     types.StringValue(schema.DDService),
+			Description: types.StringValue(schema.Description),
+			Team:        types.StringValue(schema.Team),
+		}
+
+		serviceDefinitions = append(serviceDefinitions, &s)
+	}
+
+	hashingData := fmt.Sprintf("datadog_service_definitions:%t", state.RetrieveAll.ValueBool())
+	state.ID = types.StringValue(utils.ConvertToSha256(hashingData))
+	state.ServiceDefinitions = serviceDefinitions
+}

datadog/fwprovider/framework_provider.go

@@ -76,6 +76,7 @@ var Datasources = []func() datasource.DataSource{
 	NewSensitiveDataScannerGroupOrderDatasource,
 	NewDatadogUsersDataSource,
 	NewSecurityMonitoringSuppressionDataSource,
+	NewDatadogServiceDefinitionsDataSource,
 }
 
 // FrameworkProvider struct

datadog/internal/utils/api_instances_helper.go

@@ -74,6 +74,7 @@ type ApiInstances struct {
 	rolesApiV2                 *datadogV2.RolesApi
 	rumApiV2                   *datadogV2.RUMApi
 	securityMonitoringApiV2    *datadogV2.SecurityMonitoringApi
+	serviceDefinitionsApiV2    *datadogV2.ServiceDefinitionApi
 	sensitiveDataScannerApiV2  *datadogV2.SensitiveDataScannerApi
 	serviceAccountsApiV2       *datadogV2.ServiceAccountsApi
 	spansMetricsApiV2          *datadogV2.SpansMetricsApi
@@ -539,6 +540,14 @@ func (i *ApiInstances) GetServiceAccountsApiV2() *datadogV2.ServiceAccountsApi {
 	return i.serviceAccountsApiV2
 }
 
+// GetServiceDefinitionsApiV2 get instance of ServiceDefinitionsApi
+func (i *ApiInstances) GetServiceDefinitionApiV2() *datadogV2.ServiceDefinitionApi {
+	if i.serviceDefinitionsApiV2 == nil {
+		i.serviceDefinitionsApiV2 = datadogV2.NewServiceDefinitionApi(i.HttpClient)
+	}
+	return i.serviceDefinitionsApiV2
+}
+
 // GetUsageMeteringApiV2 get instance of UsageMeteringApi
 func (i *ApiInstances) GetUsageMeteringApiV2() *datadogV2.UsageMeteringApi {
 	if i.usageMeteringApiV2 == nil {

datadog/tests/data_source_datadog_service_definitions_test.go

@@ -0,0 +1,47 @@
+package test
+
+import (
+	"context"
+	"fmt"
+	"strings"
+	"testing"
+
+	"github.com/hashicorp/terraform-plugin-testing/helper/resource"
+)
+
+func TestAccDatadogServiceDefinitionsDatasource(t *testing.T) {
+	ctx, _, accProviders := testAccFrameworkMuxProviders(context.Background(), t)
+	uniq := strings.ToLower(uniqueEntityName(ctx, t))
+
+	resource.Test(t, resource.TestCase{
+		PreCheck:                 func() { testAccPreCheck(t) },
+		ProtoV5ProviderFactories: accProviders,
+		Steps: []resource.TestStep{
+			{
+				Config: testAccDatasourceServiceDefinitionsConfig(uniq),
+				Check:  resource.TestCheckResourceAttr("data.datadog_service_definitions.foo", "service", uniq),
+			},
+		},
+	})
+}
+
+func testAccDatasourceServiceDefinitionsConfig(uniq string) string {
+	return fmt.Sprintf(`
+data "datadog_service_definitions" "foo" {
+  retrieve_all    = true
+  depends_on = [
+	  datadog_service_definition_yaml.service_definition_v2_2
+  ]
+}
+
+resource "datadog_service_definition_yaml" "service_definition_v2_2" {
+  service_definition = <<EOF
+  schema-version: v2.2
+  dd-service: %[1]s
+  description: my datadog service 
+  tier: high
+  lifecycle: production
+  application: socialplate
+  EOF
+`, uniq)
+}

datadog/tests/provider_test.go

@@ -78,6 +78,7 @@ var testFiles2EndpointTags = map[string]string{
 	"tests/data_source_datadog_sensitive_data_scanner_group_order_test":      "sensitive-data-scanner",
 	"tests/data_source_datadog_sensitive_data_scanner_standard_pattern_test": "sensitive-data-scanner",
 	"tests/data_source_datadog_service_account_test":                         "users",
+	"tests/data_source_datadog_service_definitions_test":                     "service-definitions",
 	"tests/data_source_datadog_service_level_objective_test":                 "service-level-objectives",
 	"tests/data_source_datadog_service_level_objectives_test":                "service-level-objectives",
 	"tests/data_source_datadog_synthetics_global_variable_test":              "synthetics",

docs/data-sources/service_definitions.md

@@ -0,0 +1,42 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "datadog_service_definitions Data Source - terraform-provider-datadog"
+subcategory: ""
+description: |-
+  Use this data source to retrieve information about existing Datadog service definitions.
+---
+
+# datadog_service_definitions (Data Source)
+
+Use this data source to retrieve information about existing Datadog service definitions.
+
+## Example Usage
+
+```terraform
+data "datadog_service_definitions" "foo" {
+  retrieve_all = true
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `retrieve_all` (Boolean) Retrieve all service definitions.
+
+### Read-Only
+
+- `id` (String) The ID of this resource.
+- `service_definitions` (List of Object) List of service definitions. (see [below for nested schema](#nestedatt--service_definitions))
+
+<a id="nestedatt--service_definitions"></a>
+### Nested Schema for `service_definitions`
+
+Read-Only:
+
+- `application` (String)
+- `description` (String)
+- `id` (String)
+- `service` (String)
+- `team` (String)

examples/data-sources/datadog_service_definitions/data-source.tf

@@ -0,0 +1,3 @@
+data "datadog_service_definitions" "foo" {
+  retrieve_all = true
+}