Adds support for VCS source_directory and tag_prefix options (#1154)

Author: jillirami

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Unreleased
 
+## Enhancements
+* Adds support for `RegistryModule` VCS source_directory and tag_prefix options, by @jillrami [#1154] (https://github.com/hashicorp/go-tfe/pull/1154)
+
 # v1.89.0
 
 ## Enhancements
@@ -15,7 +18,6 @@
 * Adds BETA support for reading, testing and updating Organization Audit Configuration by @glennsarti-hashi [#1151](https://github.com/hashicorp/go-tfe/pull/1151)
 * Adds `Completed` status to `StackConfiguration` by @hwatkins05-hashicorp [#1163](https://github.com/hashicorp/go-tfe/pull/1163)
 
-
 # v1.87.0
 
 ## Bug Fixes

helper_test.go

@@ -991,6 +991,15 @@ func createOrganization(t *testing.T, client *Client) (*Organization, func()) {
 	})
 }
 
+func createOrganizationWithMonorepoSupport(t *testing.T, client *Client) (*Organization, func()) {
+	return createOrganizationWithOptions(t, client, OrganizationCreateOptions{
+		Name:                           String("tst-" + randomString(t)),
+		Email:                          String(fmt.Sprintf("%[email protected]", randomString(t))),
+		CostEstimationEnabled:          Bool(true),
+		RegistryMonorepoSupportEnabled: Bool(true),
+	})
+}
+
 func createOrganizationWithOptions(t *testing.T, client *Client, options OrganizationCreateOptions) (*Organization, func()) {
 	ctx := context.Background()
 	org, err := client.Organizations.Create(ctx, options)

organization.go

@@ -258,6 +258,9 @@ type OrganizationCreateOptions struct {
 	// Optional: StacksEnabled toggles whether stacks are enabled for the organization. This setting
 	// is considered BETA, SUBJECT TO CHANGE, and likely unavailable to most users.
 	StacksEnabled *bool `jsonapi:"attr,stacks-enabled,omitempty"`
+
+	// Optional: RegistryMonorepoSupportEnabled toggles whether monorepo support is enabled for the organization
+	RegistryMonorepoSupportEnabled *bool `jsonapi:"attr,registry-monorepo-support-enabled,omitempty"`
 }
 
 // OrganizationUpdateOptions represents the options for updating an organization.
@@ -313,6 +316,9 @@ type OrganizationUpdateOptions struct {
 	// Optional: StacksEnabled toggles whether stacks are enabled for the organization. This setting
 	// is considered BETA, SUBJECT TO CHANGE, and likely unavailable to most users.
 	StacksEnabled *bool `jsonapi:"attr,stacks-enabled,omitempty"`
+
+	// Optional: RegistryMonorepoSupportEnabled toggles whether monorepo support is enabled for the organization
+	RegistryMonorepoSupportEnabled *bool `jsonapi:"attr,registry-monorepo-support-enabled,omitempty"`
 }
 
 // ReadRunQueueOptions represents the options for showing the queue.

registry_module.go

@@ -370,6 +370,10 @@ type RegistryModuleVCSRepoOptions struct {
 	// **Note: This field is still in BETA and subject to change.**
 	Branch *string `json:"branch,omitempty"`
 	Tags   *bool   `json:"tags,omitempty"`
+
+	// Optional: If set, the registry module will be branch-based or tag-based
+	SourceDirectory *string `json:"source-directory,omitempty"`
+	TagPrefix       *string `json:"tag-prefix,omitempty"`
 }
 
 type RegistryModuleVCSRepoUpdateOptions struct {
@@ -380,6 +384,10 @@ type RegistryModuleVCSRepoUpdateOptions struct {
 	// **Note: This field is still in BETA and subject to change.**
 	Branch *string `json:"branch,omitempty"`
 	Tags   *bool   `json:"tags,omitempty"`
+
+	// Optional: If set, the registry module will be branch-based or tag-based
+	SourceDirectory *string `json:"source-directory,omitempty"`
+	TagPrefix       *string `json:"tag-prefix,omitempty"`
 }
 
 // List all the registry modules within an organization.

registry_module_integration_test.go

@@ -962,6 +962,149 @@ func TestRegistryModulesCreateBranchBasedWithVCSConnection(t *testing.T) {
 	})
 }
 
+func TestRegistryModulesCreateMonorepoBranchBasedWithVCSConnection(t *testing.T) {
+	skipUnlessBeta(t)
+
+	githubIdentifier := os.Getenv("GITHUB_REGISTRY_MODULE_IDENTIFIER")
+	if githubIdentifier == "" {
+		t.Skip("Export a valid GITHUB_REGISTRY_MODULE_IDENTIFIER before running this test")
+	}
+	repositoryName := strings.Split(githubIdentifier, "/")[1]
+	registryModuleProvider := strings.SplitN(repositoryName, "-", 3)[1]
+	registryModuleName := strings.SplitN(repositoryName, "-", 3)[2]
+
+	githubBranch := os.Getenv("GITHUB_REGISTRY_MODULE_BRANCH")
+	if githubBranch == "" {
+		githubBranch = "main"
+	}
+
+	client := testClient(t)
+	ctx := context.Background()
+
+	orgTest, orgTestCleanup := createOrganizationWithMonorepoSupport(t, client)
+	t.Cleanup(orgTestCleanup)
+
+	oauthTokenTest, oauthTokenTestCleanup := createOAuthToken(t, client, orgTest)
+	t.Cleanup(oauthTokenTestCleanup)
+
+	t.Run("with valid options including source directory", func(t *testing.T) {
+		sourceDirectory := "src"
+
+		options := RegistryModuleCreateWithVCSConnectionOptions{
+			VCSRepo: &RegistryModuleVCSRepoOptions{
+				OrganizationName:  String(orgTest.Name),
+				Identifier:        String(githubIdentifier),
+				OAuthTokenID:      String(oauthTokenTest.ID),
+				DisplayIdentifier: String(githubIdentifier),
+				Branch:            String(githubBranch),
+				SourceDirectory:   String(sourceDirectory),
+			},
+		}
+		rm, err := client.RegistryModules.CreateWithVCSConnection(ctx, options)
+		require.NoError(t, err)
+		assert.NotEmpty(t, rm.ID)
+		assert.Equal(t, registryModuleName, rm.Name)
+		assert.Equal(t, registryModuleProvider, rm.Provider)
+		assert.Equal(t, githubBranch, rm.VCSRepo.Branch)
+		assert.Equal(t, false, rm.VCSRepo.Tags)
+		assert.Equal(t, sourceDirectory, rm.VCSRepo.SourceDirectory)
+	})
+}
+
+func TestRegistryModulesCreateTagBasedWithVCSConnection(t *testing.T) {
+	skipUnlessBeta(t)
+
+	githubIdentifier := os.Getenv("GITHUB_REGISTRY_MODULE_IDENTIFIER")
+	if githubIdentifier == "" {
+		t.Skip("Export a valid GITHUB_REGISTRY_MODULE_IDENTIFIER before running this test")
+	}
+	repositoryName := strings.Split(githubIdentifier, "/")[1]
+	registryModuleProvider := strings.SplitN(repositoryName, "-", 3)[1]
+	registryModuleName := strings.SplitN(repositoryName, "-", 3)[2]
+
+	githubBranch := os.Getenv("GITHUB_REGISTRY_MODULE_BRANCH")
+	if githubBranch == "" {
+		githubBranch = "main"
+	}
+
+	client := testClient(t)
+	ctx := context.Background()
+
+	orgTest, orgTestCleanup := createOrganizationWithMonorepoSupport(t, client)
+	t.Cleanup(orgTestCleanup)
+
+	oauthTokenTest, oauthTokenTestCleanup := createOAuthToken(t, client, orgTest)
+	t.Cleanup(oauthTokenTestCleanup)
+
+	t.Run("with monorepo publishing", func(t *testing.T) {
+		sourceDirectory := "src"
+		tagPrefix := "v"
+
+		options := RegistryModuleCreateWithVCSConnectionOptions{
+			VCSRepo: &RegistryModuleVCSRepoOptions{
+				Identifier:        String(githubIdentifier),
+				OAuthTokenID:      String(oauthTokenTest.ID),
+				DisplayIdentifier: String(githubIdentifier),
+				Branch:            String(githubBranch),
+				SourceDirectory:   String(sourceDirectory),
+				TagPrefix:         String(tagPrefix),
+			},
+		}
+		rm, err := client.RegistryModules.CreateWithVCSConnection(ctx, options)
+		require.NoError(t, err)
+		assert.NotEmpty(t, rm.ID)
+		assert.Equal(t, registryModuleName, rm.Name)
+		assert.Equal(t, registryModuleProvider, rm.Provider)
+		assert.Equal(t, rm.VCSRepo.Branch, githubBranch)
+		assert.Equal(t, rm.VCSRepo.Identifier, githubIdentifier)
+		assert.Equal(t, rm.VCSRepo.IngressSubmodules, true)
+		assert.Equal(t, rm.VCSRepo.OAuthTokenID, oauthTokenTest.ID)
+		assert.Equal(t, rm.VCSRepo.RepositoryHTTPURL, fmt.Sprintf("https://github.com/%s", githubIdentifier))
+		assert.Equal(t, rm.VCSRepo.ServiceProvider, string(ServiceProviderGithub))
+		assert.Regexp(t, fmt.Sprintf("^%s/webhooks/vcs/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$", regexp.QuoteMeta(DefaultConfig().Address)), rm.VCSRepo.WebhookURL)
+
+		if rm.VCSRepo.SourceDirectory != sourceDirectory {
+			t.Errorf("expected SourceDirectory %q, got %q", sourceDirectory, rm.VCSRepo.SourceDirectory)
+		}
+		if rm.VCSRepo.TagPrefix != tagPrefix {
+			t.Errorf("expected TagPrefix %q, got %q", tagPrefix, rm.VCSRepo.TagPrefix)
+		}
+	})
+
+	t.Run("without monorepo publishing", func(t *testing.T) {
+		tagPrefix := "v"
+
+		options := RegistryModuleCreateWithVCSConnectionOptions{
+			VCSRepo: &RegistryModuleVCSRepoOptions{
+				Identifier:        String(githubIdentifier),
+				OAuthTokenID:      String(oauthTokenTest.ID),
+				DisplayIdentifier: String(githubIdentifier),
+				Branch:            String(githubBranch),
+				TagPrefix:         String(tagPrefix),
+			},
+		}
+		rm, err := client.RegistryModules.CreateWithVCSConnection(ctx, options)
+		require.NoError(t, err)
+		assert.NotEmpty(t, rm.ID)
+		assert.Equal(t, registryModuleName, rm.Name)
+		assert.Equal(t, registryModuleProvider, rm.Provider)
+		assert.Equal(t, rm.VCSRepo.Branch, githubBranch)
+		assert.Equal(t, rm.VCSRepo.Identifier, githubIdentifier)
+		assert.Equal(t, rm.VCSRepo.IngressSubmodules, true)
+		assert.Equal(t, rm.VCSRepo.OAuthTokenID, oauthTokenTest.ID)
+		assert.Equal(t, rm.VCSRepo.RepositoryHTTPURL, fmt.Sprintf("https://github.com/%s", githubIdentifier))
+		assert.Equal(t, rm.VCSRepo.ServiceProvider, string(ServiceProviderGithub))
+		assert.Regexp(t, fmt.Sprintf("^%s/webhooks/vcs/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$", regexp.QuoteMeta(DefaultConfig().Address)), rm.VCSRepo.WebhookURL)
+
+		if rm.VCSRepo.SourceDirectory != "" {
+			t.Errorf("expected SourceDirectory %q, got %q", "", rm.VCSRepo.SourceDirectory)
+		}
+		if rm.VCSRepo.TagPrefix != tagPrefix {
+			t.Errorf("expected TagPrefix %q, got %q", tagPrefix, rm.VCSRepo.TagPrefix)
+		}
+	})
+}
+
 func TestRegistryModulesCreateBranchBasedWithVCSConnectionWithTesting(t *testing.T) {
 	skipUnlessBeta(t)
 

workspace.go

@@ -273,6 +273,8 @@ type VCSRepo struct {
 	Tags              bool   `jsonapi:"attr,tags"`
 	TagsRegex         string `jsonapi:"attr,tags-regex"`
 	WebhookURL        string `jsonapi:"attr,webhook-url"`
+	SourceDirectory   string `jsonapi:"attr,source-directory"`
+	TagPrefix         string `jsonapi:"attr,tag-prefix"`
 }
 
 // Note: the fields of this struct are bool pointers instead of bool values, in order to simplify support for