Merge pull request #988 from hashicorp/sams/TFECO-6399-read-by-external-id

Enable alternative reading of a registry module by its ID

Author: dsa0x

CHANGELOG.md

@@ -4,6 +4,8 @@
 
 * Add support for enabling Stacks on an organization by @brandonc [#987](https://github.com/hashicorp/go-tfe/pull/987)
 * Add support for filtering by key/value tags by @brandonc [#987](https://github.com/hashicorp/go-tfe/pull/987)
+* Add support for reading a registry module by its unique identifier by @dsa0x
+ [#988](https://github.com/hashicorp/go-tfe/pull/988)
 
 # v1.68.0
 

registry_module.go

@@ -109,7 +109,10 @@ const (
 
 // RegistryModuleID represents the set of IDs that identify a RegistryModule
 // Use NewPublicRegistryModuleID or NewPrivateRegistryModuleID to build one
+
 type RegistryModuleID struct {
+	// The unique ID of the module. If given, the other fields are ignored.
+	ID string
 	// The organization the module belongs to, see RegistryModule.Organization.Name
 	Organization string
 	// The name of the module, see RegistryModule.Name
@@ -523,24 +526,29 @@ func (r *registryModules) Read(ctx context.Context, moduleID RegistryModuleID) (
 		return nil, err
 	}
 
-	if moduleID.RegistryName == "" {
-		log.Println("[WARN] Support for using the RegistryModuleID without RegistryName is deprecated as of release 1.5.0 and may be removed in a future version. The preferred method is to include the RegistryName in RegistryModuleID.")
-		moduleID.RegistryName = PrivateRegistry
-	}
+	var u string
+	if moduleID.ID == "" {
+		if moduleID.RegistryName == "" {
+			log.Println("[WARN] Support for using the RegistryModuleID without RegistryName is deprecated as of release 1.5.0 and may be removed in a future version. The preferred method is to include the RegistryName in RegistryModuleID.")
+			moduleID.RegistryName = PrivateRegistry
+		}
 
-	if moduleID.RegistryName == PrivateRegistry && strings.TrimSpace(moduleID.Namespace) == "" {
-		log.Println("[WARN] Support for using the RegistryModuleID without Namespace is deprecated as of release 1.5.0 and may be removed in a future version. The preferred method is to include the Namespace in RegistryModuleID.")
-		moduleID.Namespace = moduleID.Organization
-	}
+		if moduleID.RegistryName == PrivateRegistry && strings.TrimSpace(moduleID.Namespace) == "" {
+			log.Println("[WARN] Support for using the RegistryModuleID without Namespace is deprecated as of release 1.5.0 and may be removed in a future version. The preferred method is to include the Namespace in RegistryModuleID.")
+			moduleID.Namespace = moduleID.Organization
+		}
 
-	u := fmt.Sprintf(
-		"organizations/%s/registry-modules/%s/%s/%s/%s",
-		url.PathEscape(moduleID.Organization),
-		url.PathEscape(string(moduleID.RegistryName)),
-		url.PathEscape(moduleID.Namespace),
-		url.PathEscape(moduleID.Name),
-		url.PathEscape(moduleID.Provider),
-	)
+		u = fmt.Sprintf(
+			"organizations/%s/registry-modules/%s/%s/%s/%s",
+			url.PathEscape(moduleID.Organization),
+			url.PathEscape(string(moduleID.RegistryName)),
+			url.PathEscape(moduleID.Namespace),
+			url.PathEscape(moduleID.Name),
+			url.PathEscape(moduleID.Provider),
+		)
+	} else {
+		u = fmt.Sprintf("registry-modules/%s", url.PathEscape(moduleID.ID))
+	}
 
 	req, err := r.client.NewRequest("GET", u, nil)
 	if err != nil {
@@ -690,6 +698,10 @@ func (r *registryModules) DeleteVersion(ctx context.Context, moduleID RegistryMo
 }
 
 func (o RegistryModuleID) valid() error {
+	if validString(&o.ID) && validStringID(&o.ID) {
+		return nil
+	}
+
 	if !validStringID(&o.Organization) {
 		return ErrInvalidOrg
 	}

registry_module_integration_test.go

@@ -1193,6 +1193,27 @@ func TestRegistryModulesRead(t *testing.T) {
 		})
 	})
 
+	t.Run("with a unique ID field for private module", func(t *testing.T) {
+		rm, err := client.RegistryModules.Read(ctx, RegistryModuleID{
+			ID: registryModuleTest.ID,
+		})
+		require.NoError(t, err)
+		require.NotEmpty(t, rm)
+		assert.Equal(t, registryModuleTest.ID, rm.ID)
+
+		t.Run("permissions are properly decoded", func(t *testing.T) {
+			require.NotEmpty(t, rm.Permissions)
+			assert.True(t, rm.Permissions.CanDelete)
+			assert.True(t, rm.Permissions.CanResync)
+			assert.True(t, rm.Permissions.CanRetry)
+		})
+
+		t.Run("timestamps are properly decoded", func(t *testing.T) {
+			assert.NotEmpty(t, rm.CreatedAt)
+			assert.NotEmpty(t, rm.UpdatedAt)
+		})
+	})
+
 	t.Run("without a name", func(t *testing.T) {
 		rm, err := client.RegistryModules.Read(ctx, RegistryModuleID{
 			Organization: orgTest.Name,