Files
cairnobs/terraform/internal/provider/dashboard_data_source.go
T
jcoffey-dev eb38611aa8 Add read-only data sources for all three Terraform resources
Mechanical, low-risk follow-up -- no new architectural question, no new
external service, no new write path. Each of sentry_dashboard,
sentry_alert_rule, and sentry_notification_target gets a matching data
source: a single Required id attribute in, every other attribute
Computed out, backed by the exact same getDashboard/getRule/
getNotificationTarget client methods and dashboardModelFromAPI/
alertRuleModelFromAPI/notificationTargetModelFromAPI conversion
functions the resources already use and already have tests for -- these
data sources add no new client code at all, just a thin
datasource.DataSource wrapper reusing what Create/Read/Update/Delete
already exercise.

sentry_notification_target's data source carries the same secret
caveat its resource does (Sensitive, but alerting's GET /targets/{id}
returns it unredacted, so it's a real plaintext value in Terraform
state) -- named again here rather than assumed obvious from the
resource's own docs.

Verified: provider_test.go's new schema-validation tests confirm each
data source's id is Required and everything else Computed, no
Terraform binary needed. Three new real acceptance tests
(TestAccDashboardDataSource_basic and its two siblings) each create a
resource then look it up via the matching data source, using
resource.TestCheckResourceAttrPair to prove the data source's Read
actually agrees with what the resource wrote -- not just that both
compile. Skip-gated by TF_ACC same as the existing six acceptance
tests, and needs the same live api/alerting services this environment
has no Docker access to bring up, so not run here -- same disclosed gap
as everything else Docker-gated in this repo.
2026-08-15 10:28:08 -07:00

85 lines
2.9 KiB
Go

package provider
import (
"context"
"fmt"
"github.com/hashicorp/terraform-plugin-framework/datasource"
"github.com/hashicorp/terraform-plugin-framework/datasource/schema"
)
var (
_ datasource.DataSource = &dashboardDataSource{}
_ datasource.DataSourceWithConfigure = &dashboardDataSource{}
)
func newDashboardDataSource() datasource.DataSource {
return &dashboardDataSource{}
}
// dashboardDataSource looks up an existing dashboard by ID -- read-only,
// GET /dashboards/{id} only, no lifecycle of its own. Reuses
// dashboardResourceModel/dashboardModelFromAPI from
// dashboard_resource.go directly rather than defining a parallel type:
// a data source's attribute set here is exactly the resource's (every
// field Computed except id, which the caller supplies), so there's
// nothing a second struct would express that the first doesn't already.
type dashboardDataSource struct {
client *client
}
func (d *dashboardDataSource) Metadata(_ context.Context, req datasource.MetadataRequest, resp *datasource.MetadataResponse) {
resp.TypeName = req.ProviderTypeName + "_dashboard"
}
func (d *dashboardDataSource) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) {
resp.Schema = schema.Schema{
Description: "Looks up an existing Sentry dashboard by ID. See the sentry_dashboard resource for how one is created/managed.",
Attributes: map[string]schema.Attribute{
"id": schema.StringAttribute{
Required: true,
Description: "Dashboard ID to look up.",
},
"tenant_id": schema.StringAttribute{Computed: true},
"name": schema.StringAttribute{Computed: true},
"description": schema.StringAttribute{Computed: true},
"default_earliest": schema.StringAttribute{Computed: true},
"default_latest": schema.StringAttribute{Computed: true},
"created_by": schema.StringAttribute{Computed: true},
"created_at": schema.StringAttribute{Computed: true},
"updated_at": schema.StringAttribute{Computed: true},
},
}
}
func (d *dashboardDataSource) Configure(_ context.Context, req datasource.ConfigureRequest, resp *datasource.ConfigureResponse) {
if req.ProviderData == nil {
return
}
data, ok := req.ProviderData.(*providerData)
if !ok {
resp.Diagnostics.AddError(
"Unexpected Data Source Configure Type",
fmt.Sprintf("Expected *provider.providerData, got: %T. This is a provider bug -- please report it.", req.ProviderData),
)
return
}
d.client = data.api
}
func (d *dashboardDataSource) Read(ctx context.Context, req datasource.ReadRequest, resp *datasource.ReadResponse) {
var config dashboardResourceModel
resp.Diagnostics.Append(req.Config.Get(ctx, &config)...)
if resp.Diagnostics.HasError() {
return
}
out, err := d.client.getDashboard(ctx, config.ID.ValueString())
if err != nil {
resp.Diagnostics.AddError("Reading Dashboard", err.Error())
return
}
resp.Diagnostics.Append(resp.State.Set(ctx, dashboardModelFromAPI(out))...)
}