wip

Author: sfc-gh-jcieslak

pkg/acceptance/bettertestspoc/assert/resourceshowoutputassert/listings_datasource_show_output_ext.go

@@ -0,0 +1,18 @@
+package resourceshowoutputassert
+
+import (
+	"testing"
+
+	"github.com/Snowflake-Labs/terraform-provider-snowflake/pkg/acceptance/bettertestspoc/assert"
+)
+
+// ListingsDatasourceShowOutput is a temporary workaround to have better show output assertions in data source acceptance tests.
+func ListingsDatasourceShowOutput(t *testing.T, name string) *ListingShowOutputAssert {
+	t.Helper()
+
+	l := ListingShowOutputAssert{
+		ResourceAssert: assert.NewDatasourceAssert("data."+name, "show_output", "listings.0."),
+	}
+	l.AddAssertion(assert.ValueSet("show_output.#", "1"))
+	return &l
+}

pkg/acceptance/bettertestspoc/config/datasourcemodel/gen/datasource_schema_def.go

@@ -110,6 +110,10 @@ var allDatasourcesSchemaDefs = []DatasourceSchemaDef{
 		name:   "Services",
 		schema: datasources.Services().Schema,
 	},
+	{
+		name:   "Listings",
+		schema: datasources.Listings().Schema,
+	},
 	{
 		name:   "Streamlits",
 		schema: datasources.Streamlits().Schema,

pkg/acceptance/bettertestspoc/config/datasourcemodel/listings_model_ext.go

@@ -0,0 +1,24 @@
+package datasourcemodel
+
+import (
+    tfconfig "github.com/hashicorp/terraform-plugin-testing/config"
+)
+
+func (l *ListingsModel) WithLimit(rows int) *ListingsModel {
+    return l.WithLimitValue(
+        tfconfig.ObjectVariable(map[string]tfconfig.Variable{
+            "rows": tfconfig.IntegerVariable(rows),
+        }),
+    )
+}
+
+func (l *ListingsModel) WithRowsAndFrom(rows int, from string) *ListingsModel {
+    return l.WithLimitValue(
+        tfconfig.ObjectVariable(map[string]tfconfig.Variable{
+            "rows": tfconfig.IntegerVariable(rows),
+            "from": tfconfig.StringVariable(from),
+        }),
+    )
+}
+
+

pkg/acceptance/bettertestspoc/config/datasourcemodel/listings_model_gen.go

@@ -0,0 +1,104 @@
+package datasources
+
+import (
+	"context"
+
+	"github.com/Snowflake-Labs/terraform-provider-snowflake/pkg/internal/provider"
+	providerdatasources "github.com/Snowflake-Labs/terraform-provider-snowflake/pkg/provider/datasources"
+	"github.com/Snowflake-Labs/terraform-provider-snowflake/pkg/resources"
+	"github.com/Snowflake-Labs/terraform-provider-snowflake/pkg/schemas"
+	"github.com/Snowflake-Labs/terraform-provider-snowflake/pkg/sdk"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+)
+
+var listingsSchema = map[string]*schema.Schema{
+	"with_describe": {
+		Type:        schema.TypeBool,
+		Optional:    true,
+		Default:     true,
+		Description: "Runs DESC LISTING for each listing returned by SHOW LISTINGS. The output of describe is saved to the description field. By default this value is set to true.",
+	},
+	"like":        likeSchema,
+	"starts_with": startsWithSchema,
+	"limit":       limitFromSchema,
+	"listings": {
+		Type:        schema.TypeList,
+		Computed:    true,
+		Description: "Holds the aggregated output of all listings details queries.",
+		Elem: &schema.Resource{
+			Schema: map[string]*schema.Schema{
+				resources.ShowOutputAttributeName: {
+					Type:        schema.TypeList,
+					Computed:    true,
+					Description: "Holds the output of SHOW LISTINGS.",
+					Elem:        &schema.Resource{Schema: schemas.ShowListingSchema},
+				},
+				resources.DescribeOutputAttributeName: {
+					Type:        schema.TypeList,
+					Computed:    true,
+					Description: "Holds the output of DESCRIBE LISTING.",
+					Elem:        &schema.Resource{Schema: schemas.DescribeListingSchema},
+				},
+			},
+		},
+	},
+}
+
+func Listings() *schema.Resource {
+	return &schema.Resource{
+		ReadContext: TrackingReadWrapper(providerdatasources.Listings, ReadListings),
+		Schema:      listingsSchema,
+		Description: "Data source used to get details of filtered listings. Filtering is aligned with the current possibilities for SHOW LISTINGS query (`like`, `starts_with`, and `limit` are supported). The results of SHOW and DESCRIBE are encapsulated in one output collection.",
+	}
+}
+
+func ReadListings(ctx context.Context, d *schema.ResourceData, meta any) diag.Diagnostics {
+	client := meta.(*provider.Context).Client
+	req := sdk.NewShowListingRequest()
+
+	if v, ok := d.GetOk("like"); ok {
+		req.WithLike(sdk.Like{Pattern: sdk.String(v.(string))})
+	}
+	if v, ok := d.GetOk("starts_with"); ok {
+		req.WithStartsWith(v.(string))
+	}
+	if v, ok := d.GetOk("limit"); ok {
+		l := v.([]any)[0].(map[string]any)
+		limit := sdk.LimitFrom{}
+		if rv, ok := l["rows"]; ok {
+			limit.Rows = sdk.Int(rv.(int))
+		}
+		if fv, ok := l["from"]; ok {
+			limit.From = sdk.String(fv.(string))
+		}
+		req.WithLimit(limit)
+	}
+
+	listings, err := client.Listings.Show(ctx, req)
+	if err != nil {
+		return diag.FromErr(err)
+	}
+	d.SetId("listings_read")
+
+	flattened := make([]map[string]any, len(listings))
+	for i, listing := range listings {
+		listing := listing
+		var describe []map[string]any
+		if d.Get("with_describe").(bool) {
+			details, err := client.Listings.Describe(ctx, sdk.NewDescribeListingRequest(listing.ID()))
+			if err != nil {
+				return diag.FromErr(err)
+			}
+			describe = []map[string]any{schemas.ListingDetailsToSchema(details)}
+		}
+		flattened[i] = map[string]any{
+			resources.ShowOutputAttributeName:     []map[string]any{schemas.ListingToSchema(&listing)},
+			resources.DescribeOutputAttributeName: describe,
+		}
+	}
+	if err := d.Set("listings", flattened); err != nil {
+		return diag.FromErr(err)
+	}
+	return nil
+}

pkg/datasources/listings.go

@@ -38,6 +38,7 @@ const (
 	SecurityIntegrations           datasource = "snowflake_security_integrations"
 	SemanticViews                  datasource = "snowflake_semantic_views"
 	Services                       datasource = "snowflake_services"
+	Listings                       datasource = "snowflake_listings"
 	Sequences                      datasource = "snowflake_sequences"
 	Shares                         datasource = "snowflake_shares"
 	Stages                         datasource = "snowflake_stages"

pkg/provider/datasources/datasources.go

@@ -618,6 +618,7 @@ func getDataSources() map[string]*schema.Resource {
 		"snowflake_secrets":                            datasources.Secrets(),
 		"snowflake_security_integrations":              datasources.SecurityIntegrations(),
 		"snowflake_services":                           datasources.Services(),
+		"snowflake_listings":                           datasources.Listings(),
 		"snowflake_sequences":                          datasources.Sequences(),
 		"snowflake_shares":                             datasources.Shares(),
 		"snowflake_stages":                             datasources.Stages(),