Adding Datasource for Pub/Sub Subscription (#6972) (#13296)

* Adding Datasource for Pub/Sub Subscription

* Removing unintended spaces

* Added documentation for the datasource

* Update mmv1/third_party/terraform/website/docs/d/pubsub_subscription.html.markdown

Co-authored-by: Sarah French <[email protected]>

Co-authored-by: Sarah French <[email protected]>
Signed-off-by: Modular Magician <[email protected]>

Signed-off-by: Modular Magician <[email protected]>
Co-authored-by: Sarah French <[email protected]>

Author: modular-magician

.changelog/6972.txt

@@ -0,0 +1,3 @@
+```release-note:new-datasource
+`data_source_google_pubsub_subscription`
+```

google/data_source_pubsub_subscription.go

@@ -0,0 +1,30 @@
+package google
+
+import (
+	"fmt"
+
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+)
+
+func dataSourceGooglePubsubSubscription() *schema.Resource {
+
+	dsSchema := datasourceSchemaFromResourceSchema(resourcePubsubSubscription().Schema)
+	addRequiredFieldsToSchema(dsSchema, "name")
+	addOptionalFieldsToSchema(dsSchema, "project")
+
+	return &schema.Resource{
+		Read:   dataSourceGooglePubsubSubscriptionRead,
+		Schema: dsSchema,
+	}
+}
+
+func dataSourceGooglePubsubSubscriptionRead(d *schema.ResourceData, meta interface{}) error {
+	config := meta.(*Config)
+
+	id, err := replaceVars(d, config, "projects/{{project}}/subscriptions/{{name}}")
+	if err != nil {
+		return fmt.Errorf("Error constructing id: %s", err)
+	}
+	d.SetId(id)
+	return resourcePubsubSubscriptionRead(d, meta)
+}

google/data_source_pubsub_subscription_test.go

@@ -0,0 +1,86 @@
+package google
+
+import (
+	"testing"
+
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
+)
+
+func TestAccDataSourceGooglePubsubSubscription_basic(t *testing.T) {
+	t.Parallel()
+
+	context := map[string]interface{}{
+		"random_suffix": randString(t, 10),
+	}
+
+	vcrTest(t, resource.TestCase{
+		PreCheck:     func() { testAccPreCheck(t) },
+		Providers:    testAccProviders,
+		CheckDestroy: testAccCheckPubsubSubscriptionDestroyProducer(t),
+		Steps: []resource.TestStep{
+			{
+				Config: testAccDataSourceGooglePubsubSubscription_basic(context),
+				Check: resource.ComposeTestCheckFunc(
+					checkDataSourceStateMatchesResourceState("data.google_pubsub_subscription.foo", "google_pubsub_subscription.foo"),
+				),
+			},
+		},
+	})
+}
+
+func TestAccDataSourceGooglePubsubSubscription_optionalProject(t *testing.T) {
+	t.Parallel()
+
+	context := map[string]interface{}{
+		"random_suffix": randString(t, 10),
+	}
+
+	vcrTest(t, resource.TestCase{
+		PreCheck:     func() { testAccPreCheck(t) },
+		Providers:    testAccProviders,
+		CheckDestroy: testAccCheckPubsubSubscriptionDestroyProducer(t),
+		Steps: []resource.TestStep{
+			{
+				Config: testAccDataSourceGooglePubsubSubscription_optionalProject(context),
+				Check: resource.ComposeTestCheckFunc(
+					checkDataSourceStateMatchesResourceState("data.google_pubsub_subscription.foo", "google_pubsub_subscription.foo"),
+				),
+			},
+		},
+	})
+}
+
+func testAccDataSourceGooglePubsubSubscription_basic(context map[string]interface{}) string {
+	return Nprintf(`
+resource "google_pubsub_topic" "foo" {
+  name     = "tf-test-pubsub-%{random_suffix}"
+}
+
+resource "google_pubsub_subscription" "foo" {
+  name     = "tf-test-pubsub-subscription-%{random_suffix}"
+  topic    = google_pubsub_topic.foo.name
+}
+
+data "google_pubsub_subscription" "foo" {
+  name     = google_pubsub_subscription.foo.name
+  project  = google_pubsub_subscription.foo.project
+}
+`, context)
+}
+
+func testAccDataSourceGooglePubsubSubscription_optionalProject(context map[string]interface{}) string {
+	return Nprintf(`
+resource "google_pubsub_topic" "foo" {
+  name     = "tf-test-pubsub-%{random_suffix}"
+}
+
+resource "google_pubsub_subscription" "foo" {
+  name     = "tf-test-pubsub-subscription-%{random_suffix}"
+  topic    = google_pubsub_topic.foo.name
+}
+
+data "google_pubsub_subscription" "foo" {
+  name     = google_pubsub_subscription.foo.name
+}
+`, context)
+}

google/provider.go

@@ -895,6 +895,7 @@ func Provider() *schema.Provider {
 			"google_project":                                      dataSourceGoogleProject(),
 			"google_projects":                                     dataSourceGoogleProjects(),
 			"google_project_organization_policy":                  dataSourceGoogleProjectOrganizationPolicy(),
+			"google_pubsub_subscription":                          dataSourceGooglePubsubSubscription(),
 			"google_pubsub_topic":                                 dataSourceGooglePubsubTopic(),
 			"google_secret_manager_secret":                        dataSourceSecretManagerSecret(),
 			"google_secret_manager_secret_version":                dataSourceSecretManagerSecretVersion(),

website/docs/d/pubsub_subscription.html.markdown

@@ -0,0 +1,35 @@
+---
+subcategory: "Cloud Pub/Sub"
+page_title: "Google: google_pubsub_subscription"
+description: |-
+  Get information about a Google Cloud Pub/Sub Subscription.
+---
+
+# google\_pubsub\_subscription
+
+Get information about a Google Cloud Pub/Sub Subscription. For more information see
+the [official documentation](https://cloud.google.com/pubsub/docs/)
+and [API](https://cloud.google.com/pubsub/docs/apis).
+
+## Example Usage
+
+```hcl
+data "google_pubsub_subscription" "my-pubsub-subscription" {
+  name = "my-pubsub-subscription"
+}
+```
+
+## Argument Reference
+
+The following arguments are supported:
+
+* `name` - (Required) The name of the Cloud Pub/Sub Subscription.
+
+- - -
+
+* `project` - (Optional) The project in which the resource belongs. If it
+    is not provided, the provider project is used.
+
+## Attributes Reference
+
+See [google_pubsub_subscription](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/pubsub_subscription#argument-reference) resource for details of the available attributes.