Add a datasource for retrieving a list of projects (#3178)

<!-- This change is generated by MagicModules. -->
/cc @rileykarson

google/data_source_google_projects.go

@@ -0,0 +1,78 @@
+package google
+
+import (
+	"fmt"
+	"github.com/hashicorp/terraform/helper/schema"
+)
+
+func dataSourceGoogleProjects() *schema.Resource {
+	return &schema.Resource{
+		Read: datasourceGoogleProjectsRead,
+		Schema: map[string]*schema.Schema{
+			"filter": {
+				Type:     schema.TypeString,
+				Required: true,
+			},
+			"projects": {
+				Type:     schema.TypeList,
+				Computed: true,
+				Elem: &schema.Resource{
+					Schema: map[string]*schema.Schema{
+						"project_id": {
+							Type:     schema.TypeString,
+							Computed: true,
+						},
+					},
+				},
+			},
+		},
+	}
+}
+
+func datasourceGoogleProjectsRead(d *schema.ResourceData, meta interface{}) error {
+	config := meta.(*Config)
+
+	params := make(map[string]string)
+
+	params["filter"] = d.Get("filter").(string)
+	url := "https://cloudresourcemanager.googleapis.com/v1/projects"
+
+	url, err := addQueryParams(url, params)
+	if err != nil {
+		return err
+	}
+
+	res, err := sendRequest(config, "GET", url, nil)
+	if err != nil {
+		return fmt.Errorf("Error retrieving projects: %s", err)
+	}
+
+	if err := d.Set("projects", flattenDatasourceGoogleProjectsProjects(res["projects"], d)); err != nil {
+		return fmt.Errorf("Error retrieving projects: %s", err)
+	}
+
+	d.SetId(d.Get("filter").(string))
+
+	return nil
+}
+
+func flattenDatasourceGoogleProjectsProjects(v interface{}, d *schema.ResourceData) interface{} {
+	if v == nil {
+		return v
+	}
+
+	l := v.([]interface{})
+	transformed := make([]interface{}, 0, len(l))
+	for _, raw := range l {
+		original := raw.(map[string]interface{})
+		if len(original) < 1 {
+			// Do not include empty json objects coming back from the api
+			continue
+		}
+		transformed = append(transformed, map[string]interface{}{
+			"project_id": original["projectId"],
+		})
+	}
+
+	return transformed
+}

google/data_source_google_projects_test.go

@@ -0,0 +1,36 @@
+package google
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/hashicorp/terraform/helper/resource"
+)
+
+func TestAccDataSourceGoogleProjects_basic(t *testing.T) {
+	t.Parallel()
+
+	project := getTestProjectFromEnv()
+
+	resource.Test(t, resource.TestCase{
+		PreCheck:  func() { testAccPreCheck(t) },
+		Providers: testAccProviders,
+		Steps: []resource.TestStep{
+			{
+				Config: testAccCheckGoogleProjectsConfig(project),
+				Check: resource.ComposeTestCheckFunc(
+					// We can't guarantee no project won't have our project ID as a prefix, so we'll check set-ness rather than correctness
+					resource.TestCheckResourceAttrSet("data.google_projects.my-project", "projects.0.project_id"),
+				),
+			},
+		},
+	})
+}
+
+func testAccCheckGoogleProjectsConfig(project string) string {
+	return fmt.Sprintf(`
+data "google_projects" "my-project" {
+  filter = "projectId:%s"
+}
+`, project)
+}

google/provider.go

@@ -112,6 +112,7 @@ func Provider() terraform.ResourceProvider {
 			"google_netblock_ip_ranges":                       dataSourceGoogleNetblockIpRanges(),
 			"google_organization":                             dataSourceGoogleOrganization(),
 			"google_project":                                  dataSourceGoogleProject(),
+			"google_projects":                                 dataSourceGoogleProjects(),
 			"google_project_services":                         dataSourceGoogleProjectServices(),
 			"google_service_account":                          dataSourceGoogleServiceAccount(),
 			"google_service_account_key":                      dataSourceGoogleServiceAccountKey(),

website/docs/d/google_projects.html.markdown

@@ -0,0 +1,43 @@
+---
+layout: "google"
+page_title: "Google: google_projects"
+sidebar_current: "docs-google-datasource-projects"
+description: |-
+  Retrieve a set of projects based on a filter.
+---
+
+# google\_projects
+
+Retrieve information about a set of projects based on a filter. See the
+[REST API](https://cloud.google.com/resource-manager/reference/rest/v1/projects/list)
+for more details.
+
+## Example Usage - searching for projects about to be deleted in an org
+
+```hcl
+data "google_projects" "my-org-projects" {
+  filter = "parent.id:012345678910 lifecycleState:DELETE_REQUESTED"
+}
+
+data "google_project" "deletion-candidate" {
+   project_id = "${data.google_projects.my-org-projects.projects.0.project_id}"
+}
+```
+
+## Argument Reference
+
+The following arguments are supported:
+
+* `filter` - (Optional) A string filter as defined in the [REST API](https://cloud.google.com/resource-manager/reference/rest/v1/projects/list#query-parameters).
+
+
+## Attributes Reference
+
+The following attributes are exported:
+
+* `projects` - A list of projects matching the provided filter. Structure is defined below.
+
+The `projects` block supports:
+
+* `project_id` - The project id of the project.
+

website/google.erb

@@ -138,6 +138,9 @@
       <li<%= sidebar_current("docs-google-datasource-project") %>>
       <a href="/docs/providers/google/d/google_project.html">google_project</a>
       </li>
+      <li<%= sidebar_current("docs-google-datasource-projects") %>>
+      <a href="/docs/providers/google/d/google_projects.html">google_projects</a>
+      </li>
       <li<%= sidebar_current("docs-google-datasource-service-account") %>>
       <a href="/docs/providers/google/d/datasource_google_service_account.html">google_service_account</a>
       </li>