Add singular data source for retrieving a Maven artifact from an Artifact Registry repository (#14782)

Author: bestefreund

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

@@ -29,6 +29,7 @@ var handwrittenDatasources = map[string]*schema.Resource{
 	"google_artifact_registry_docker_image":            artifactregistry.DataSourceArtifactRegistryDockerImage(),
 	"google_artifact_registry_docker_images":           artifactregistry.DataSourceArtifactRegistryDockerImages(),
 	"google_artifact_registry_locations":               artifactregistry.DataSourceGoogleArtifactRegistryLocations(),
+	"google_artifact_registry_maven_artifact":          artifactregistry.DataSourceArtifactRegistryMavenArtifact(),
 	"google_artifact_registry_npm_package":             artifactregistry.DataSourceArtifactRegistryNpmPackage(),
 	"google_artifact_registry_package":                 artifactregistry.DataSourceArtifactRegistryPackage(),
 	"google_artifact_registry_python_package":          artifactregistry.DataSourceArtifactRegistryPythonPackage(),

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

@@ -0,0 +1,282 @@
+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 MavenArtifact struct {
+	name       string
+	pomUri     string
+	version    string
+	createTime string
+	updateTime string
+}
+
+func DataSourceArtifactRegistryMavenArtifact() *schema.Resource {
+	return &schema.Resource{
+		Read: DataSourceArtifactRegistryMavenArtifactRead,
+
+		Schema: map[string]*schema.Schema{
+			"project": {
+				Type:     schema.TypeString,
+				Optional: true,
+			},
+			"location": {
+				Type:     schema.TypeString,
+				Required: true,
+			},
+			"repository_id": {
+				Type:     schema.TypeString,
+				Required: true,
+			},
+			"group_id": {
+				Type:     schema.TypeString,
+				Required: true,
+			},
+			"artifact_id": {
+				Type:     schema.TypeString,
+				Required: true,
+			},
+			"name": {
+				Type:     schema.TypeString,
+				Computed: true,
+			},
+			"pom_uri": {
+				Type:     schema.TypeString,
+				Computed: true,
+			},
+			"version": {
+				Type:     schema.TypeString,
+				Computed: true,
+			},
+			"create_time": {
+				Type:     schema.TypeString,
+				Computed: true,
+			},
+			"update_time": {
+				Type:     schema.TypeString,
+				Computed: true,
+			},
+		},
+	}
+}
+
+func DataSourceArtifactRegistryMavenArtifactRead(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 MavenArtifact
+
+	artifactId, version := parseMavenArtifact(d.Get("artifact_id").(string))
+
+	groupId := d.Get("group_id").(string)
+
+	packageName := fmt.Sprintf("%s:%s", groupId, artifactId)
+
+	if version != "" {
+		// fetch package by version
+		// https://cloud.google.com/artifact-registry/docs/reference/rest/v1/projects.locations.repositories.mavenArtifacts/get
+		packageUrlSafe := url.QueryEscape(packageName)
+		urlRequest, err := tpgresource.ReplaceVars(d, config, fmt.Sprintf("{{ArtifactRegistryBasePath}}projects/{{project}}/locations/{{location}}/repositories/{{repository_id}}/mavenArtifacts/%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 = convertMavenArtifactResponseToStruct(resGet)
+	} else {
+		// fetch the list of packages, ordered by update time
+		// https://cloud.google.com/artifact-registry/docs/reference/rest/v1/projects.locations.repositories.mavenArtifacts/list
+		urlRequest, err := tpgresource.ReplaceVars(d, config, "{{ArtifactRegistryBasePath}}projects/{{project}}/locations/{{location}}/repositories/{{repository_id}}/mavenArtifacts")
+		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 = retrieveAndFilterMavenArtifacts(d, config, urlRequest, userAgent, groupId, artifactId, 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("pom_uri", res.pomUri); 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 parseMavenArtifact(pkg string) (artifactId string, version string) {
+	splitByColon := strings.Split(pkg, ":")
+
+	if len(splitByColon) == 2 {
+		artifactId = splitByColon[0]
+		version = splitByColon[1]
+	} else {
+		artifactId = pkg
+	}
+
+	return artifactId, version
+}
+
+func retrieveAndFilterMavenArtifacts(d *schema.ResourceData, config *transport_tpg.Config, urlRequest string, userAgent string, groupId string, artifactId string, version string) (MavenArtifact, 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 []MavenArtifact
+
+	for {
+		resListMavenArtifacts, token, err := retrieveListOfMavenArtifacts(config, urlRequest, userAgent)
+		if err != nil {
+			return MavenArtifact{}, err
+		}
+
+		for _, pkg := range resListMavenArtifacts {
+			if strings.Contains(pkg.name, "/"+url.QueryEscape(groupId)+":"+url.QueryEscape(artifactId)+":") {
+				allPackages = append(allPackages, pkg)
+			}
+		}
+
+		if token == "" {
+			break
+		}
+
+		urlRequest, err = transport_tpg.AddQueryParams(urlRequest, map[string]string{"pageToken": token})
+		if err != nil {
+			return MavenArtifact{}, err
+		}
+	}
+
+	if len(allPackages) == 0 {
+		return MavenArtifact{}, fmt.Errorf("Requested Maven 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 MavenArtifact{}, fmt.Errorf("Requested version was not found.")
+	}
+
+	// Return the latest package if no version specified
+	return allPackages[0], nil
+}
+
+func retrieveListOfMavenArtifacts(config *transport_tpg.Config, urlRequest string, userAgent string) ([]MavenArtifact, string, error) {
+	resList, err := transport_tpg.SendRequest(transport_tpg.SendRequestOptions{
+		Config:    config,
+		Method:    "GET",
+		RawURL:    urlRequest,
+		UserAgent: userAgent,
+	})
+	if err != nil {
+		return make([]MavenArtifact, 0), "", err
+	}
+
+	if nextPageToken, ok := resList["nextPageToken"].(string); ok {
+		return flattenMavenArtifactDataSourceListResponse(resList), nextPageToken, nil
+	} else {
+		return flattenMavenArtifactDataSourceListResponse(resList), "", nil
+	}
+}
+
+func flattenMavenArtifactDataSourceListResponse(res map[string]interface{}) []MavenArtifact {
+	var mavenArtifacts []MavenArtifact
+
+	resMavenArtifacts, _ := res["mavenArtifacts"].([]interface{})
+
+	for _, resPackage := range resMavenArtifacts {
+		pkg, _ := resPackage.(map[string]interface{})
+		mavenArtifacts = append(mavenArtifacts, convertMavenArtifactResponseToStruct(pkg))
+	}
+
+	return mavenArtifacts
+}
+
+func convertMavenArtifactResponseToStruct(res map[string]interface{}) MavenArtifact {
+	var mavenArtifact MavenArtifact
+
+	if name, ok := res["name"].(string); ok {
+		mavenArtifact.name = name
+	}
+
+	if pomUri, ok := res["pomUri"].(string); ok {
+		mavenArtifact.pomUri = pomUri
+	}
+
+	if version, ok := res["version"].(string); ok {
+		mavenArtifact.version = version
+	}
+
+	if createTime, ok := res["createTime"].(string); ok {
+		mavenArtifact.createTime = createTime
+	}
+
+	if updateTime, ok := res["updateTime"].(string); ok {
+		mavenArtifact.updateTime = updateTime
+	}
+
+	return mavenArtifact
+}

mmv1/third_party/terraform/services/artifactregistry/data_source_artifact_registry_maven_artifact_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 TestAccDataSourceArtifactRegistryMavenArtifact_basic(t *testing.T) {
+	acctest.SkipIfVcr(t)
+	t.Parallel()
+
+	// At the moment there are no public Maven artifacts available in Artifact Registry.
+	// This test is skipped to avoid unnecessary failures.
+	// As soon as there are public artifacts available, this test can be enabled by removing the skip and adjusting the configuration accordingly.
+	t.Skip("No public Maven artifacts available in Artifact Registry")
+
+	resourceName := "data.google_artifact_registry_maven_artifact.test"
+
+	acctest.VcrTest(t, resource.TestCase{
+		PreCheck:                 func() { acctest.AccTestPreCheck(t) },
+		ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories(t),
+		Steps: []resource.TestStep{
+			{
+				Config: testAccDataSourceArtifactRegistryMavenArtifactConfig,
+				Check: resource.ComposeTestCheckFunc(
+					resource.TestCheckResourceAttrSet(resourceName, "project"),
+					resource.TestCheckResourceAttrSet(resourceName, "location"),
+					resource.TestCheckResourceAttrSet(resourceName, "repository_id"),
+					resource.TestCheckResourceAttrSet(resourceName, "artifact_id"),
+					resource.TestCheckResourceAttrSet(resourceName, "name"),
+					validateMavenArtifactTimestamps(resourceName),
+				),
+			},
+		},
+	})
+}
+
+const testAccDataSourceArtifactRegistryMavenArtifactConfig = `
+data "google_artifact_registry_maven_artifact" "test" {
+  project       = "example-project"
+  location      = "us"
+  repository_id = "example-repo"
+  group_id      = "com.example"
+  artifact_id   = "example-artifact"
+}
+`
+
+func validateMavenArtifactTimestamps(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
+	}
+}