feat: add datasources for some notification profiles [ENG-5557] (#98)

[ENG-5557](https://stacklet.atlassian.net/browse/ENG-5557)

### what

add support for fetching notification profiles for
- email
- servicenow
- symphony

Other ones will be added in a followup branch

### why

provide access to notifications profiles

### testing

testing in sandbox, will add tests once resources are also available

### docs

updated here


[ENG-5557]:
https://stacklet.atlassian.net/browse/ENG-5557?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ

Author: albertodonato

docs/data-sources/configuration_profile_email.md

@@ -0,0 +1,37 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "stacklet_configuration_profile_email Data Source - terraform-provider-stacklet"
+subcategory: ""
+description: |-
+  Retrieve information about the email configuration profile.
+---
+
+# stacklet_configuration_profile_email (Data Source)
+
+Retrieve information about the email configuration profile.
+
+## Example Usage
+
+```terraform
+data "stacklet_configuration_profile_email" "example" {}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Read-Only
+
+- `from` (String) The email from field value.
+- `id` (String) The GraphQL Node ID of the configuration profile.
+- `profile` (String) The profile name.
+- `smtp` (Attributes) SMTP configuration. (see [below for nested schema](#nestedatt--smtp))
+
+<a id="nestedatt--smtp"></a>
+### Nested Schema for `smtp`
+
+Read-Only:
+
+- `port` (String) SMTP server port.
+- `server` (String) SMTP server hostname or IP address.
+- `ssl` (Boolean) Whether SSL/TLS is enabled.
+- `username` (String) Authentication username.

docs/data-sources/configuration_profile_servicenow.md

@@ -0,0 +1,29 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "stacklet_configuration_profile_servicenow Data Source - terraform-provider-stacklet"
+subcategory: ""
+description: |-
+  Retrieve information about the ServiceNow configuration profile.
+---
+
+# stacklet_configuration_profile_servicenow (Data Source)
+
+Retrieve information about the ServiceNow configuration profile.
+
+## Example Usage
+
+```terraform
+data "stacklet_configuration_profile_servicenow" "example" {}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Read-Only
+
+- `closed_state` (String) The state for closed tickets.
+- `endpoint` (String) The ServiceNow instance endpoint.
+- `id` (String) The GraphQL Node ID of the configuration profile.
+- `issue_type` (String) The type of issue to use for tickets.
+- `profile` (String) The profile name.
+- `username` (String) The ServiceNow instance authentication username.

docs/data-sources/configuration_profile_symphony.md

@@ -0,0 +1,27 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "stacklet_configuration_profile_symphony Data Source - terraform-provider-stacklet"
+subcategory: ""
+description: |-
+  Retrieve information about the Symphony configuration profile.
+---
+
+# stacklet_configuration_profile_symphony (Data Source)
+
+Retrieve information about the Symphony configuration profile.
+
+## Example Usage
+
+```terraform
+data "stacklet_configuration_profile_symphony" "example" {}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Read-Only
+
+- `agent_domain` (String) The Symphony agent domain.
+- `id` (String) The GraphQL Node ID of the configuration profile.
+- `profile` (String) The profile name.
+- `service_account` (String) The Symphony service account.

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

@@ -0,0 +1 @@
+data "stacklet_configuration_profile_email" "example" {}

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

@@ -0,0 +1 @@
+data "stacklet_configuration_profile_servicenow" "example" {}

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

@@ -0,0 +1 @@
+data "stacklet_configuration_profile_symphony" "example" {}

internal/api/api.go

@@ -14,6 +14,7 @@ type API struct {
 	AccountGroup            accountGroupAPI
 	AccountGroupMapping     accountGroupMappingAPI
 	Binding                 bindingAPI
+	ConfigurationProfile    configurationProfileAPI
 	Platform                platformAPI
 	Policy                  policyAPI
 	PolicyCollection        policyCollectionAPI
@@ -31,6 +32,7 @@ func New(c *graphql.Client) *API {
 		AccountGroup:            accountGroupAPI{c},
 		AccountGroupMapping:     accountGroupMappingAPI{c},
 		Binding:                 bindingAPI{c},
+		ConfigurationProfile:    configurationProfileAPI{c},
 		Platform:                platformAPI{c},
 		Policy:                  policyAPI{c},
 		PolicyCollection:        policyCollectionAPI{c},

internal/api/configuration_profile.go

@@ -0,0 +1,75 @@
+// Copyright (c) 2025 - Stacklet, Inc.
+
+package api
+
+import (
+	"context"
+
+	"github.com/hasura/go-graphql-client"
+)
+
+// ConfigurationProfile is the data returned for configuration profiles.
+type ConfigurationProfile struct {
+	ID      string
+	Profile string
+	Record  struct {
+		TypeName                string                  `graphql:"__typename"`
+		EmailConfiguration      EmailConfiguration      `graphql:"... on EmailConfiguration"`
+		ServiceNowConfiguration ServiceNowConfiguration `graphql:"... on ServiceNowConfiguration"`
+		SymphonyConfiguration   SymphonyConfiguration   `graphql:"... on SymphonyConfiguration"`
+	}
+}
+
+// EmailConfiguration is the configuration for email profiles.
+type EmailConfiguration struct {
+	FromEmail string
+	SesRegion *string
+	SMTP      *SMTPConfiguration `graphql:"smtp"`
+}
+
+// SMTPConfiguration is the SMTP server configuration.
+type SMTPConfiguration struct {
+	Server   string
+	Port     string
+	SSL      *bool `graphql:"ssl"`
+	Username *string
+}
+
+// ServiceNowConfiguration is the configuration for ServiceNow profiles.
+type ServiceNowConfiguration struct {
+	Endpoint    string
+	User        string
+	Password    string
+	IssueType   string
+	ClosedState string
+}
+
+// SymphonyConfiguration is the configuration for Symphony profiles.
+type SymphonyConfiguration struct {
+	AgentDomain    string
+	ServiceAccount string
+}
+
+type configurationProfileAPI struct {
+	c *graphql.Client
+}
+
+// Read returns data for a configuration profile.
+func (a configurationProfileAPI) Read(ctx context.Context, name ConfigurationProfileName) (*ConfigurationProfile, error) {
+	var query struct {
+		Configuration ConfigurationProfile `graphql:"profile(name: $name, scope: $scope)"`
+	}
+	variables := map[string]any{
+		"name":  graphql.String(string(name)),
+		"scope": graphql.String("0"), // always use the global scope
+	}
+	if err := a.c.Query(ctx, &query, variables); err != nil {
+		return nil, NewAPIError(err)
+	}
+
+	if query.Configuration.ID == "" {
+		return nil, NotFound{"Configuration profile not found"}
+	}
+
+	return &query.Configuration, nil
+}

internal/api/enums.go

@@ -37,3 +37,18 @@ var REPORT_SOURCES = []ReportSource{
 	ReportSourceControl,
 	ReportSourcePolicy,
 }
+
+// ConfigurationProfileName is the name for a configuration profile.
+//
+// This is defined as a type since profiles are looked up by names matching
+// type.
+type ConfigurationProfileName string
+
+const (
+	ConfigurationProfileEmail      = ConfigurationProfileName("email")
+	ConfigurationProfileSlack      = ConfigurationProfileName("slack")
+	ConfigurationProfileTeams      = ConfigurationProfileName("teams")
+	ConfigurationProfileServiceNow = ConfigurationProfileName("servicenow")
+	ConfigurationProfileJira       = ConfigurationProfileName("jira")
+	ConfigurationProfileSymphony   = ConfigurationProfileName("symphony")
+)

internal/datasources/configuration_profile_email.go

@@ -0,0 +1,126 @@
+// Copyright (c) 2025 - Stacklet, Inc.
+
+package datasources
+
+import (
+	"context"
+
+	"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/stacklet/terraform-provider-stacklet/internal/api"
+	"github.com/stacklet/terraform-provider-stacklet/internal/errors"
+	"github.com/stacklet/terraform-provider-stacklet/internal/models"
+	"github.com/stacklet/terraform-provider-stacklet/internal/providerdata"
+)
+
+var (
+	_ datasource.DataSource = &configurationProfileEmailDataSource{}
+)
+
+func NewConfigurationProfileEmailDataSource() datasource.DataSource {
+	return &configurationProfileEmailDataSource{}
+}
+
+type configurationProfileEmailDataSource struct {
+	api *api.API
+}
+
+func (d *configurationProfileEmailDataSource) Metadata(_ context.Context, req datasource.MetadataRequest, resp *datasource.MetadataResponse) {
+	resp.TypeName = req.ProviderTypeName + "_configuration_profile_email"
+}
+
+func (d *configurationProfileEmailDataSource) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) {
+	resp.Schema = schema.Schema{
+		Description: "Retrieve information about the email configuration profile.",
+		Attributes: map[string]schema.Attribute{
+			"id": schema.StringAttribute{
+				Description: "The GraphQL Node ID of the configuration profile.",
+				Computed:    true,
+			},
+			"profile": schema.StringAttribute{
+				Description: "The profile name.",
+				Computed:    true,
+			},
+			"from": schema.StringAttribute{
+				Description: "The email from field value.",
+				Computed:    true,
+			},
+			"smtp": schema.SingleNestedAttribute{
+				Description: "SMTP configuration.",
+				Computed:    true,
+				Attributes: map[string]schema.Attribute{
+					"server": schema.StringAttribute{
+						Description: "SMTP server hostname or IP address.",
+						Computed:    true,
+					},
+					"port": schema.StringAttribute{
+						Description: "SMTP server port.",
+						Computed:    true,
+					},
+					"ssl": schema.BoolAttribute{
+						Description: "Whether SSL/TLS is enabled.",
+						Computed:    true,
+					},
+					"username": schema.StringAttribute{
+						Description: "Authentication username.",
+						Computed:    true,
+					},
+				},
+			},
+		},
+	}
+}
+
+func (d *configurationProfileEmailDataSource) Configure(ctx context.Context, req datasource.ConfigureRequest, resp *datasource.ConfigureResponse) {
+	if pd, err := providerdata.GetDataSourceProviderData(req); err != nil {
+		errors.AddDiagError(&resp.Diagnostics, err)
+	} else if pd != nil {
+		d.api = pd.API
+	}
+}
+
+func (d *configurationProfileEmailDataSource) Read(ctx context.Context, req datasource.ReadRequest, resp *datasource.ReadResponse) {
+	var data models.ConfigurationProfileEmailDataSource
+	resp.Diagnostics.Append(req.Config.Get(ctx, &data)...)
+	if resp.Diagnostics.HasError() {
+		return
+	}
+
+	config, err := d.api.ConfigurationProfile.Read(ctx, api.ConfigurationProfileEmail)
+	if err != nil {
+		errors.AddDiagError(&resp.Diagnostics, err)
+		return
+	}
+
+	data.ID = types.StringValue(config.ID)
+	data.Profile = types.StringValue(config.Profile)
+	data.From = types.StringValue(config.Record.EmailConfiguration.FromEmail)
+
+	if smtp := config.Record.EmailConfiguration.SMTP; smtp != nil {
+		smtpAttrs := map[string]attr.Value{
+			"server": types.StringValue(smtp.Server),
+			"port":   types.StringValue(smtp.Port),
+			"ssl":    types.BoolValue(smtp.SSL != nil && *smtp.SSL),
+			"username": func() types.String {
+				if smtp.Username != nil {
+					return types.StringValue(*smtp.Username)
+				}
+				return types.StringNull()
+			}(),
+		}
+
+		smtpObj, diags := types.ObjectValue(models.SMTP{}.AttributeTypes(), smtpAttrs)
+		resp.Diagnostics.Append(diags...)
+		if resp.Diagnostics.HasError() {
+			return
+		}
+		data.SMTP = smtpObj
+	} else {
+		data.SMTP = types.ObjectNull(models.SMTP{}.AttributeTypes())
+	}
+
+	resp.Diagnostics.Append(resp.State.Set(ctx, &data)...)
+}