Add plural data source for retrieving Artifact Registry packages (#14674)

Author: bestefreund

mmv1/third_party/terraform/provider/provider_mmv1_resources.go.tmpl

@@ -34,6 +34,7 @@ var handwrittenDatasources = map[string]*schema.Resource{
 	"google_artifact_registry_npm_package":             artifactregistry.DataSourceArtifactRegistryNpmPackage(),
 	"google_artifact_registry_npm_packages":            artifactregistry.DataSourceArtifactRegistryNpmPackages(),
 	"google_artifact_registry_package":                 artifactregistry.DataSourceArtifactRegistryPackage(),
+	"google_artifact_registry_packages":                artifactregistry.DataSourceArtifactRegistryPackages(),
 	"google_artifact_registry_python_package":          artifactregistry.DataSourceArtifactRegistryPythonPackage(),
 	"google_artifact_registry_repositories":            artifactregistry.DataSourceArtifactRegistryRepositories(),
 	"google_artifact_registry_repository":              artifactregistry.DataSourceArtifactRegistryRepository(),

mmv1/third_party/terraform/services/artifactregistry/data_source_artifact_registry_packages.go

@@ -0,0 +1,181 @@
+package artifactregistry
+
+import (
+	"fmt"
+	"net/http"
+	"net/url"
+
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+	"github.com/hashicorp/terraform-provider-google/google/tpgresource"
+	transport_tpg "github.com/hashicorp/terraform-provider-google/google/transport"
+)
+
+func DataSourceArtifactRegistryPackages() *schema.Resource {
+	return &schema.Resource{
+		Read: dataSourceArtifactRegistryPackagesRead,
+		Schema: map[string]*schema.Schema{
+			"location": {
+				Type:     schema.TypeString,
+				Required: true,
+			},
+			"repository_id": {
+				Type:     schema.TypeString,
+				Required: true,
+			},
+			"filter": {
+				Type:     schema.TypeString,
+				Optional: true,
+			},
+			"project": {
+				Type:     schema.TypeString,
+				Optional: true,
+			},
+			"packages": {
+				Type:     schema.TypeList,
+				Computed: true,
+				Elem: &schema.Resource{
+					Schema: map[string]*schema.Schema{
+						"name": {
+							Type:     schema.TypeString,
+							Computed: true,
+						},
+						"display_name": {
+							Type:     schema.TypeString,
+							Computed: true,
+						},
+						"create_time": {
+							Type:     schema.TypeString,
+							Computed: true,
+						},
+						"update_time": {
+							Type:     schema.TypeString,
+							Computed: true,
+						},
+						"annotations": {
+							Type:     schema.TypeMap,
+							Computed: true,
+							Elem:     &schema.Schema{Type: schema.TypeString},
+						},
+					},
+				},
+			},
+		},
+	}
+}
+
+func dataSourceArtifactRegistryPackagesRead(d *schema.ResourceData, meta interface{}) error {
+	config := meta.(*transport_tpg.Config)
+	userAgent, err := tpgresource.GenerateUserAgentString(d, config.UserAgent)
+	if err != nil {
+		return err
+	}
+
+	project, err := tpgresource.GetProject(d, config)
+	if err != nil {
+		return err
+	}
+
+	basePath, err := tpgresource.ReplaceVars(d, config, "{{ArtifactRegistryBasePath}}")
+	if err != nil {
+		return fmt.Errorf("Error setting Artifact Registry base path: %s", err)
+	}
+
+	resourcePath, err := tpgresource.ReplaceVars(d, config, fmt.Sprintf("projects/{{project}}/locations/{{location}}/repositories/{{repository_id}}/packages"))
+	if err != nil {
+		return fmt.Errorf("Error setting resource path: %s", err)
+	}
+
+	urlRequest := basePath + resourcePath
+
+	filter := ""
+	if v, ok := d.GetOk("filter"); ok {
+		filter = v.(string)
+
+		u, err := url.Parse(urlRequest)
+		if err != nil {
+			return fmt.Errorf("Error parsing URL: %s", err)
+		}
+
+		q := u.Query()
+		q.Set("filter", filter)
+		u.RawQuery = q.Encode()
+		urlRequest = u.String()
+	}
+
+	headers := make(http.Header)
+	packages := make([]map[string]interface{}, 0)
+	pageToken := ""
+
+	for {
+		u, err := url.Parse(urlRequest)
+		if err != nil {
+			return fmt.Errorf("Error parsing URL: %s", err)
+		}
+
+		q := u.Query()
+		if pageToken != "" {
+			q.Set("pageToken", pageToken)
+		}
+		u.RawQuery = q.Encode()
+
+		res, err := transport_tpg.SendRequest(transport_tpg.SendRequestOptions{
+			Config:    config,
+			Method:    "GET",
+			RawURL:    u.String(),
+			UserAgent: userAgent,
+			Headers:   headers,
+		})
+
+		if err != nil {
+			return fmt.Errorf("Error listing Artifact Registry packages: %s", err)
+		}
+
+		if items, ok := res["packages"].([]interface{}); ok {
+			for _, item := range items {
+				pkg := item.(map[string]interface{})
+
+				annotations := make(map[string]string)
+				if anno, ok := pkg["annotations"].(map[string]interface{}); ok {
+					for k, v := range anno {
+						if val, ok := v.(string); ok {
+							annotations[k] = val
+						}
+					}
+				}
+
+				getString := func(m map[string]interface{}, key string) string {
+					if v, ok := m[key].(string); ok {
+						return v
+					}
+					return ""
+				}
+
+				packages = append(packages, map[string]interface{}{
+					"name":         getString(pkg, "name"),
+					"display_name": getString(pkg, "displayName"),
+					"create_time":  getString(pkg, "createTime"),
+					"update_time":  getString(pkg, "updateTime"),
+					"annotations":  annotations,
+				})
+			}
+		}
+
+		if nextToken, ok := res["nextPageToken"].(string); ok && nextToken != "" {
+			pageToken = nextToken
+		} else {
+			break
+		}
+	}
+
+	if err := d.Set("project", project); err != nil {
+		return fmt.Errorf("Error setting project: %s", err)
+	}
+
+	if err := d.Set("packages", packages); err != nil {
+		return fmt.Errorf("Error setting Artifact Registry packages: %s", err)
+	}
+
+	d.SetId(resourcePath)
+
+	return nil
+}

mmv1/third_party/terraform/services/artifactregistry/data_source_artifact_registry_packages_test.go

@@ -0,0 +1,40 @@
+package artifactregistry_test
+
+import (
+	"testing"
+
+	"github.com/hashicorp/terraform-plugin-testing/helper/resource"
+	"github.com/hashicorp/terraform-provider-google/google/acctest"
+)
+
+func TestAccDataSourceArtifactRegistryPackages_basic(t *testing.T) {
+	t.Parallel()
+
+	acctest.VcrTest(t, resource.TestCase{
+		PreCheck:                 func() { acctest.AccTestPreCheck(t) },
+		ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories(t),
+		Steps: []resource.TestStep{
+			{
+				Config: testAccDataSourceArtifactRegistryPackagesConfig,
+				Check: resource.ComposeTestCheckFunc(
+					resource.TestCheckResourceAttrSet("data.google_artifact_registry_packages.this", "project"),
+					resource.TestCheckResourceAttrSet("data.google_artifact_registry_packages.this", "location"),
+					resource.TestCheckResourceAttrSet("data.google_artifact_registry_packages.this", "repository_id"),
+					resource.TestCheckResourceAttrSet("data.google_artifact_registry_packages.this", "packages.0.name"),
+				),
+			},
+		},
+	})
+}
+
+// Test the data source against the public AR repos
+// https://console.cloud.google.com/artifacts/docker/cloudrun/us/container
+// https://console.cloud.google.com/artifacts/docker/go-containerregistry/us/gcr.io
+const testAccDataSourceArtifactRegistryPackagesConfig = `
+data "google_artifact_registry_packages" "this" {
+  project       = "go-containerregistry"
+  location      = "us"
+  repository_id = "gcr.io"
+  filter        = "name=\"projects/go-containerregistry/locations/us/repositories/gcr.io/packages/gcrane\""
+}
+`

mmv1/third_party/terraform/website/docs/d/artifact_registry_packages.html.markdown

@@ -0,0 +1,50 @@
+---
+subcategory: "Artifact Registry"
+description: |-
+  Get information about packages within a Google Artifact Registry repository.
+---
+
+# google_artifact_registry_packages
+
+Get information about Artifact Registry packages.
+See [the official documentation](https://cloud.google.com/artifact-registry/docs/overview)
+and [API](https://cloud.google.com/artifact-registry/docs/reference/rest/v1/projects.locations.repositories.packages/list).
+
+## Example Usage
+
+```hcl
+data "google_artifact_registry_packages" "my_images" {
+  location      = "us-central1"
+  repository_id = "example-repo"
+}
+```
+
+## Argument Reference
+
+The following arguments are supported:
+
+* `location` - (Required) The location of the Artifact Registry repository.
+
+* `repository_id` - (Required) The last part of the repository name to fetch from.
+
+* `filter` - (Optional) An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are `name` and `annotations`. Further information can be found in the [REST API](https://cloud.google.com/artifact-registry/docs/reference/rest/v1/projects.locations.repositories.packages/list#query-parameters).
+
+* `project` - (Optional) The project ID in which the resource belongs. If it is not provided, the provider project is used.
+
+## Attributes Reference
+
+The following attributes are exported:
+
+* `packages` - A list of all retrieved Artifact Registry packages. Structure is [defined below](#nested_packages).
+
+<a name="nested_packages"></a>The `packages` block supports:
+
+* `name` - The name of the package, for example: `projects/p1/locations/us-central1/repositories/repo1/packages/pkg1`. If the package ID part contains slashes, the slashes are escaped.
+
+* `display_name` - The display name of the package.
+
+* `create_time` - The time, as a RFC 3339 string, this package was created. 
+
+* `update_time` - The time, as a RFC 3339 string, this package was last updated. This includes publishing a new version of the package.
+
+* `annotations` - Client specified annotations.