Add plural data source for retrieving NPM Packages from an Artifact Registry repository (#14805)

Author: bestefreund

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

@@ -31,6 +31,7 @@ var handwrittenDatasources = map[string]*schema.Resource{
 	"google_artifact_registry_locations":               artifactregistry.DataSourceGoogleArtifactRegistryLocations(),
 	"google_artifact_registry_maven_artifact":          artifactregistry.DataSourceArtifactRegistryMavenArtifact(),
 	"google_artifact_registry_npm_package":             artifactregistry.DataSourceArtifactRegistryNpmPackage(),
+	"google_artifact_registry_npm_packages":            artifactregistry.DataSourceArtifactRegistryNpmPackages(),
 	"google_artifact_registry_package":                 artifactregistry.DataSourceArtifactRegistryPackage(),
 	"google_artifact_registry_python_package":          artifactregistry.DataSourceArtifactRegistryPythonPackage(),
 	"google_artifact_registry_repositories":            artifactregistry.DataSourceArtifactRegistryRepositories(),

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

@@ -0,0 +1,182 @@
+package artifactregistry
+
+import (
+	"fmt"
+	"net/http"
+	"net/url"
+	"strings"
+
+	"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 DataSourceArtifactRegistryNpmPackages() *schema.Resource {
+	return &schema.Resource{
+		Read: dataSourceArtifactRegistryNpmPackagesRead,
+		Schema: map[string]*schema.Schema{
+			"location": {
+				Type:     schema.TypeString,
+				Required: true,
+			},
+			"repository_id": {
+				Type:     schema.TypeString,
+				Required: true,
+			},
+			"project": {
+				Type:     schema.TypeString,
+				Optional: true,
+			},
+			"npm_packages": {
+				Type:     schema.TypeList,
+				Computed: true,
+				Elem: &schema.Resource{
+					Schema: map[string]*schema.Schema{
+						"package_name": {
+							Type:        schema.TypeString,
+							Required:    true,
+							Description: "The name of the Npm package.",
+						},
+						"version": {
+							Type:        schema.TypeString,
+							Computed:    true,
+							Description: "The version of the Npm package.",
+						},
+						"tags": {
+							Type:        schema.TypeList,
+							Computed:    true,
+							Description: "The tags associated with the Npm package.",
+							Elem:        &schema.Schema{Type: schema.TypeString},
+						},
+						"name": {
+							Type:        schema.TypeString,
+							Computed:    true,
+							Description: "The fully qualified name of the Npm package.",
+						},
+						"create_time": {
+							Type:        schema.TypeString,
+							Computed:    true,
+							Description: "The time the package was created.",
+						},
+						"update_time": {
+							Type:        schema.TypeString,
+							Computed:    true,
+							Description: "The time the package was last updated.",
+						},
+					},
+				},
+			},
+		},
+	}
+}
+
+func dataSourceArtifactRegistryNpmPackagesRead(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}}/npmPackages"))
+	if err != nil {
+		return fmt.Errorf("Error setting resource path: %s", err)
+	}
+
+	urlRequest := basePath + resourcePath
+
+	headers := make(http.Header)
+	npmPackages := 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 Npm packages: %s", err)
+		}
+
+		if items, ok := res["npmPackages"].([]interface{}); ok {
+			for _, item := range items {
+				pkg := item.(map[string]interface{})
+
+				name, ok := pkg["name"].(string)
+				if !ok {
+					return fmt.Errorf("Error getting Artifact Registry Npm package name: %s", err)
+				}
+
+				lastComponent := name[strings.LastIndex(name, "/")+1:]
+				packageName := strings.SplitN(lastComponent, ":", 2)[0]
+
+				var tags []string
+				if rawTags, ok := pkg["tags"].([]interface{}); ok {
+					for _, tag := range rawTags {
+						if tagStr, ok := tag.(string); ok {
+							tags = append(tags, tagStr)
+						}
+					}
+				}
+
+				getString := func(m map[string]interface{}, key string) string {
+					if v, ok := m[key].(string); ok {
+						return v
+					}
+					return ""
+				}
+
+				npmPackages = append(npmPackages, map[string]interface{}{
+					"package_name": packageName,
+					"name":         name,
+					"version":      getString(pkg, "version"),
+					"tags":         tags,
+					"create_time":  getString(pkg, "createTime"),
+					"update_time":  getString(pkg, "updateTime"),
+				})
+			}
+		}
+
+		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("npm_packages", npmPackages); err != nil {
+		return fmt.Errorf("Error setting Artifact Registry Npm packages: %s", err)
+	}
+
+	d.SetId(resourcePath)
+
+	return nil
+}

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

@@ -0,0 +1,42 @@
+package artifactregistry_test
+
+import (
+	"testing"
+
+	"github.com/hashicorp/terraform-plugin-testing/helper/resource"
+	"github.com/hashicorp/terraform-provider-google/google/acctest"
+)
+
+func TestAccDataSourceArtifactRegistryNpmPackages_basic(t *testing.T) {
+	t.Parallel()
+
+	// At the moment there are no public NPM packages available in Artifact Registry.
+	// This test is skipped to avoid unnecessary failures.
+	// As soon as there are public packages available, this test can be enabled by removing the skip and adjusting the configuration accordingly.
+	t.Skip("No public NPM packages available in Artifact Registry")
+
+	acctest.VcrTest(t, resource.TestCase{
+		PreCheck:                 func() { acctest.AccTestPreCheck(t) },
+		ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories(t),
+		Steps: []resource.TestStep{
+			{
+				Config: testAccDataSourceArtifactRegistryNpmPackagesConfig,
+				Check: resource.ComposeTestCheckFunc(
+					resource.TestCheckResourceAttrSet("data.google_artifact_registry_npm_packages.test", "project"),
+					resource.TestCheckResourceAttrSet("data.google_artifact_registry_npm_packages.test", "location"),
+					resource.TestCheckResourceAttrSet("data.google_artifact_registry_npm_packages.test", "repository_id"),
+					resource.TestCheckResourceAttrSet("data.google_artifact_registry_npm_packages.test", "npm_packages.0.package_name"),
+					resource.TestCheckResourceAttrSet("data.google_artifact_registry_npm_packages.test", "npm_packages.0.name"),
+				),
+			},
+		},
+	})
+}
+
+const testAccDataSourceArtifactRegistryNpmPackagesConfig = `
+data "google_artifact_registry_npm_packages" "test" {
+  project       = "example-project"
+  location      = "us"
+  repository_id = "example-repo"
+}
+`

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

@@ -0,0 +1,48 @@
+---
+subcategory: "Artifact Registry"
+description: |-
+  Get information about Npm packages within a Google Artifact Registry repository.
+---
+
+# google_artifact_registry_npm_packages
+
+Get information about Artifact Registry Npm packages.
+See [the official documentation](https://cloud.google.com/artifact-registry/docs/nodejs)
+and [API](https://cloud.google.com/artifact-registry/docs/reference/rest/v1/projects.locations.repositories.npmPackages/list).
+
+## Example Usage
+
+```hcl
+data "google_artifact_registry_npm_packages" "my_packages" {
+  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.
+
+* `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:
+
+* `npm_packages` - A list of all retrieved Artifact Registry Npm packages. Structure is [defined below](#nested_npm_packages).
+
+<a name="nested_npm_packages"></a>The `npm_packages` block supports:
+
+* `name` - The fully qualified name of the fetched package.  This name has the form: `projects/{{project}}/locations/{{location}}/repository/{{repository_id}}/npmPackages/{{npmPackage}}`. For example, `projects/example-project/locations/us-central1/repository/example-repo/npmPackages/my-test-package:0.0.1`
+
+* `package_name` - Extracted short name of the package (last part of `name`, without version). For example, from `.../my-test-package:0.0.1` → `my-test-package`.
+
+* `version` - Version of this 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 updated.