Add singular data source for retrieving a Python package from an Artifact Registry repository (#14611)

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_npm_package":             artifactregistry.DataSourceArtifactRegistryNpmPackage(),
 	"google_artifact_registry_package":                 artifactregistry.DataSourceArtifactRegistryPackage(),
+	"google_artifact_registry_python_package":          artifactregistry.DataSourceArtifactRegistryPythonPackage(),
 	"google_artifact_registry_repositories":            artifactregistry.DataSourceArtifactRegistryRepositories(),
 	"google_artifact_registry_repository":              artifactregistry.DataSourceArtifactRegistryRepository(),
 	"google_artifact_registry_tag":                     artifactregistry.DataSourceArtifactRegistryTag(),

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

@@ -0,0 +1,275 @@
+package artifactregistry
+
+import (
+	"fmt"
+	"net/url"
+	"sort"
+	"strings"
+	"time"
+
+	"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"
+)
+
+type PythonPackage struct {
+	name        string
+	packageName string
+	version     string
+	createTime  string
+	updateTime  string
+}
+
+func DataSourceArtifactRegistryPythonPackage() *schema.Resource {
+	return &schema.Resource{
+		Read: DataSourceArtifactRegistryPythonPackageRead,
+
+		Schema: map[string]*schema.Schema{
+			"project": {
+				Type:        schema.TypeString,
+				Optional:    true,
+				Description: "Project ID of the project.",
+			},
+			"location": {
+				Type:        schema.TypeString,
+				Required:    true,
+				Description: "The region of the Artifact Registry repository.",
+			},
+			"repository_id": {
+				Type:        schema.TypeString,
+				Required:    true,
+				Description: "The repository ID containing the Python package.",
+			},
+			"package_name": {
+				Type:        schema.TypeString,
+				Required:    true,
+				Description: "The name of the Python package.",
+			},
+			"version": {
+				Type:        schema.TypeString,
+				Computed:    true,
+				Description: "The version of the Python package.",
+			},
+			"name": {
+				Type:        schema.TypeString,
+				Computed:    true,
+				Description: "The fully qualified name of the Python 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 DataSourceArtifactRegistryPythonPackageRead(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
+	}
+
+	var res PythonPackage
+
+	packageName, version := parsePythonPackage(d.Get("package_name").(string))
+
+	if version != "" {
+		// fetch package by version
+		// https://cloud.google.com/artifact-registry/docs/reference/rest/v1/projects.locations.repositories.pythonPackages/get
+		packageUrlSafe := url.QueryEscape(packageName)
+		urlRequest, err := tpgresource.ReplaceVars(d, config, fmt.Sprintf("{{ArtifactRegistryBasePath}}projects/{{project}}/locations/{{location}}/repositories/{{repository_id}}/pythonPackages/%s:%s", packageUrlSafe, version))
+		if err != nil {
+			return fmt.Errorf("Error setting api endpoint")
+		}
+
+		resGet, err := transport_tpg.SendRequest(transport_tpg.SendRequestOptions{
+			Config:    config,
+			Method:    "GET",
+			RawURL:    urlRequest,
+			UserAgent: userAgent,
+		})
+		if err != nil {
+			return err
+		}
+
+		res = convertPythonPackageResponseToStruct(resGet)
+	} else {
+		// fetch the list of packages, ordered by update time
+		// https://cloud.google.com/artifact-registry/docs/reference/rest/v1/projects.locations.repositories.pythonPackages/list
+		urlRequest, err := tpgresource.ReplaceVars(d, config, "{{ArtifactRegistryBasePath}}projects/{{project}}/locations/{{location}}/repositories/{{repository_id}}/pythonPackages")
+		if err != nil {
+			return fmt.Errorf("Error setting api endpoint")
+		}
+
+		// to reduce the number of pages we need to fetch, we set the pageSize to 1000(max)
+		urlRequest, err = transport_tpg.AddQueryParams(urlRequest, map[string]string{"pageSize": "1000"})
+		if err != nil {
+			return err
+		}
+
+		res, err = retrieveAndFilterPythonPackages(d, config, urlRequest, userAgent, packageName, version)
+		if err != nil {
+			return err
+		}
+	}
+
+	// Set Terraform schema fields
+	if err := d.Set("project", project); err != nil {
+		return err
+	}
+	if err := d.Set("name", res.name); err != nil {
+		return err
+	}
+	if err := d.Set("version", res.version); err != nil {
+		return err
+	}
+	if err := d.Set("create_time", res.createTime); err != nil {
+		return err
+	}
+	if err := d.Set("update_time", res.updateTime); err != nil {
+		return err
+	}
+
+	d.SetId(res.name)
+
+	return nil
+}
+
+func parsePythonPackage(pkg string) (packageName string, version string) {
+	splitByColon := strings.Split(pkg, ":")
+
+	if len(splitByColon) == 2 {
+		packageName = splitByColon[0]
+		version = splitByColon[1]
+	} else {
+		packageName = pkg
+	}
+
+	return packageName, version
+}
+
+func retrieveAndFilterPythonPackages(d *schema.ResourceData, config *transport_tpg.Config, urlRequest string, userAgent string, packageName string, version string) (PythonPackage, error) {
+	// Paging through the list method until either:
+	// if a version was provided, the matching package name and version pair
+	// otherwise, return the first matching package name
+
+	var allPackages []PythonPackage
+
+	for {
+		resListPythonPackages, token, err := retrieveListOfPythonPackages(config, urlRequest, userAgent)
+		if err != nil {
+			return PythonPackage{}, err
+		}
+
+		for _, pkg := range resListPythonPackages {
+			if strings.Contains(pkg.name, "/"+url.QueryEscape(packageName)+":") {
+				allPackages = append(allPackages, pkg)
+			}
+		}
+
+		if token == "" {
+			break
+		}
+
+		urlRequest, err = transport_tpg.AddQueryParams(urlRequest, map[string]string{"pageToken": token})
+		if err != nil {
+			return PythonPackage{}, err
+		}
+	}
+
+	if len(allPackages) == 0 {
+		return PythonPackage{}, fmt.Errorf("Requested Python package was not found.")
+	}
+
+	// Client-side sort by updateTime descending (latest first)
+	sort.Slice(allPackages, func(i, j int) bool {
+		// Parse RFC3339 timestamps, fallback to string compare if parse fails
+		ti, err1 := time.Parse(time.RFC3339, allPackages[i].updateTime)
+		tj, err2 := time.Parse(time.RFC3339, allPackages[j].updateTime)
+		if err1 == nil && err2 == nil {
+			return ti.After(tj)
+		}
+		return allPackages[i].updateTime > allPackages[j].updateTime
+	})
+
+	if version != "" {
+		for _, pkg := range allPackages {
+			if pkg.version == version {
+				return pkg, nil
+			}
+		}
+		return PythonPackage{}, fmt.Errorf("Requested version was not found.")
+	}
+
+	// Return the latest package if no version specified
+	return allPackages[0], nil
+}
+
+func retrieveListOfPythonPackages(config *transport_tpg.Config, urlRequest string, userAgent string) ([]PythonPackage, string, error) {
+	resList, err := transport_tpg.SendRequest(transport_tpg.SendRequestOptions{
+		Config:    config,
+		Method:    "GET",
+		RawURL:    urlRequest,
+		UserAgent: userAgent,
+	})
+	if err != nil {
+		return make([]PythonPackage, 0), "", err
+	}
+
+	if nextPageToken, ok := resList["nextPageToken"].(string); ok {
+		return flattenPythonPackageDataSourceListResponse(resList), nextPageToken, nil
+	} else {
+		return flattenPythonPackageDataSourceListResponse(resList), "", nil
+	}
+}
+
+func flattenPythonPackageDataSourceListResponse(res map[string]interface{}) []PythonPackage {
+	var pythonPackages []PythonPackage
+
+	resPythonPackages, _ := res["pythonPackages"].([]interface{})
+
+	for _, resPackage := range resPythonPackages {
+		pkg, _ := resPackage.(map[string]interface{})
+		pythonPackages = append(pythonPackages, convertPythonPackageResponseToStruct(pkg))
+	}
+
+	return pythonPackages
+}
+
+func convertPythonPackageResponseToStruct(res map[string]interface{}) PythonPackage {
+	var pythonPackage PythonPackage
+
+	if name, ok := res["name"].(string); ok {
+		pythonPackage.name = name
+	}
+
+	if packageName, ok := res["packageName"].(string); ok {
+		pythonPackage.packageName = packageName
+	}
+
+	if version, ok := res["version"].(string); ok {
+		pythonPackage.version = version
+	}
+
+	if createTime, ok := res["createTime"].(string); ok {
+		pythonPackage.createTime = createTime
+	}
+
+	if updateTime, ok := res["updateTime"].(string); ok {
+		pythonPackage.updateTime = updateTime
+	}
+
+	return pythonPackage
+}

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

@@ -0,0 +1,67 @@
+package artifactregistry_test
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/hashicorp/terraform-plugin-testing/helper/resource"
+	"github.com/hashicorp/terraform-plugin-testing/terraform"
+	"github.com/hashicorp/terraform-provider-google/google/acctest"
+)
+
+func TestAccDataSourceArtifactRegistryPythonPackage_basic(t *testing.T) {
+	acctest.SkipIfVcr(t)
+	t.Parallel()
+
+	// At the moment there are no public Python 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 Python packages available in Artifact Registry")
+
+	resourceName := "data.google_artifact_registry_python_package.test"
+
+	acctest.VcrTest(t, resource.TestCase{
+		PreCheck:                 func() { acctest.AccTestPreCheck(t) },
+		ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories(t),
+		Steps: []resource.TestStep{
+			{
+				Config: testAccDataSourceArtifactRegistryPythonPackageConfig,
+				Check: resource.ComposeTestCheckFunc(
+					resource.TestCheckResourceAttrSet(resourceName, "project"),
+					resource.TestCheckResourceAttrSet(resourceName, "location"),
+					resource.TestCheckResourceAttrSet(resourceName, "repository_id"),
+					resource.TestCheckResourceAttrSet(resourceName, "package_name"),
+					resource.TestCheckResourceAttrSet(resourceName, "name"),
+					resource.TestCheckResourceAttrSet(resourceName, "version"),
+					validatePythonPackageTimestamps(resourceName),
+				),
+			},
+		},
+	})
+}
+
+const testAccDataSourceArtifactRegistryPythonPackageConfig = `
+data "google_artifact_registry_python_package" "test" {
+  project       = "example-project"
+  location      = "us"
+  repository_id = "example-repo"
+  package_name  = "example-package"
+}
+`
+
+func validatePythonPackageTimestamps(dataSourceName string) resource.TestCheckFunc {
+	return func(s *terraform.State) error {
+		res, ok := s.RootModule().Resources[dataSourceName]
+		if !ok {
+			return fmt.Errorf("can't find %s in state", dataSourceName)
+		}
+
+		for _, attr := range []string{"create_time", "update_time"} {
+			if ts, ok := res.Primary.Attributes[attr]; !ok || !isRFC3339(ts) {
+				return fmt.Errorf("%s is not RFC3339: %s", attr, ts)
+			}
+		}
+
+		return nil
+	}
+}