no code provisioning in registry modules #562

miguelhrocha · 2022-10-25T17:34:03Z

Description

This change aligns with the next release of TFE which will include no-code modules provisioning introduced on TFC during the last HashiConf.

The way to create these modules is to either enable this property at the time of creation or with the newly introduce update operation.

Testing plan

Using integration tests

go test -run TestRegistryModulesCreate/with_valid_options/with_no-code_attribute -v ./... -tags=integration
go test -run TestRegistryModuleUpdate -v ./... -tags=integration

Using TFE instance

Flip the no_code feature on the TFE configuration

func main() {
	ctx := context.Background()
	cfg := &tfe.Config{
		Address:           "https://your-tfe-local-address",
		Token:             "API_TOKEN",
		RetryServerErrors: true,
	}

	client, _ := tfe.NewClient(cfg)

	org := "YOUR_ORG_NAME"
	opts := tfe.RegistryModuleCreateOptions{
		Name:         tfe.String("iam"),
		Provider:     tfe.String("aws"),
		NoCode:       true,
		RegistryName: tfe.PrivateRegistry,
		Namespace:    "terraform-aws-modules",
	}
	client.RegistryModules.Create(ctx, org, opts)
}

External links

Create Registry Module API

Output from tests

Including output from tests may require access to a TFE instance. Ignore this section if you have no environment to test against.

Update endpoint changes

$ envchain go-tfe go test -run TestRegistryModuleUpdate -v ./... -tags=integration
=== RUN   TestRegistryModuleUpdate
=== RUN   TestRegistryModuleUpdate/enable_no-code
=== RUN   TestRegistryModuleUpdate/disable_no-code
--- PASS: TestRegistryModuleUpdate (5.34s)
    --- PASS: TestRegistryModuleUpdate/enable_no-code (0.42s)
    --- PASS: TestRegistryModuleUpdate/disable_no-code (0.35s)
PASS
ok  	github.com/hashicorp/go-tfe	5.511s
?   	github.com/hashicorp/go-tfe/examples/organizations	[no test files]
?   	github.com/hashicorp/go-tfe/examples/workspaces	[no test files]
?   	github.com/hashicorp/go-tfe/mocks	[no test files]
?   	github.com/hashicorp/go-tfe/test	[no test files]

Create endpoint changes

$ envchain go-tfe go test -run TestRegistryModulesCreate/with_valid_options/with_no-code_attribute -v ./... -tags=integration
=== RUN   TestRegistryModulesCreate
=== RUN   TestRegistryModulesCreate/with_valid_options
=== RUN   TestRegistryModulesCreate/with_valid_options/with_no-code_attribute
=== RUN   TestRegistryModulesCreate/with_valid_options/with_no-code_attribute/permissions_are_properly_decoded
=== RUN   TestRegistryModulesCreate/with_valid_options/with_no-code_attribute/relationships_are_properly_decoded
=== RUN   TestRegistryModulesCreate/with_valid_options/with_no-code_attribute/timestamps_are_properly_decoded
--- PASS: TestRegistryModulesCreate (1.88s)
    --- PASS: TestRegistryModulesCreate/with_valid_options (0.37s)
        --- PASS: TestRegistryModulesCreate/with_valid_options/with_no-code_attribute (0.37s)
            --- PASS: TestRegistryModulesCreate/with_valid_options/with_no-code_attribute/permissions_are_properly_decoded (0.00s)
            --- PASS: TestRegistryModulesCreate/with_valid_options/with_no-code_attribute/relationships_are_properly_decoded (0.00s)
            --- PASS: TestRegistryModulesCreate/with_valid_options/with_no-code_attribute/timestamps_are_properly_decoded (0.00s)
=== RUN   TestRegistryModulesCreateVersion
=== RUN   TestRegistryModulesCreateVersion/with_valid_options
--- PASS: TestRegistryModulesCreateVersion (2.49s)
    --- PASS: TestRegistryModulesCreateVersion/with_valid_options (0.38s)
=== RUN   TestRegistryModulesCreateWithVCSConnection
    registry_module_integration_test.go:443: Export a valid GITHUB_REGISTRY_MODULE_IDENTIFIER before running this test
--- SKIP: TestRegistryModulesCreateWithVCSConnection (0.00s)
PASS
ok  	github.com/hashicorp/go-tfe	5.348s
?   	github.com/hashicorp/go-tfe/examples/organizations	[no test files]
?   	github.com/hashicorp/go-tfe/examples/workspaces	[no test files]
?   	github.com/hashicorp/go-tfe/mocks	[no test files]
?   	github.com/hashicorp/go-tfe/test	[no test files]

registry_module.go

Co-authored-by: UKEME BASSEY <ukeme.bassey@hashicorp.com>

registry_module_integration_test.go

Uk1288

Looking good!

…o-tfe into miguelhrocha/no-code-modules

annawinkler

Hi @miguelhrocha - thank you for your PR! 🥳 Could you please add a changelog entry for this update? We have contributing guidelines here that might be helpful. Thanks!

miguelhrocha · 2022-11-03T16:53:44Z

Thanks for reaching out @annawinkler ! Sorry for missing this, I've updated the PR b1e5d0c 👍🏼

annawinkler · 2022-11-08T23:11:55Z

Hi @miguelhrocha - when I tested with the example you included in the PR description, I saw this error:

"Namespace" cannot be populated when "RegistryName" is "private"

Based on what I'm reading in the docs, I would still expect this error, so in my test, I changed: RegistryName: tfe.PublicRegistry.

annawinkler · 2022-11-08T23:15:46Z

registry_module.go

+	namespace := url.QueryEscape(moduleID.Namespace)
+	name := url.QueryEscape(moduleID.Name)
+	provider := url.QueryEscape(moduleID.Provider)
+	url := fmt.Sprintf("organizations/%s/registry-modules/%s/%s/%s/%s", org, registryName, namespace, name, provider)


💅 A small style suggestion - in this file (& the rest of the code), we generally avoid creating variables for each URL element like on this line.

annawinkler

I think we're almost there - I left a few more suggestions.

I'll be out and I don't want to block this PR. I think it's close!

annawinkler · 2022-11-08T23:43:37Z

🥳 I tested locally with a local tfc, and verified that if I create one Registry Module with no code = true, and one with no code = false, when I look at the API scope RegistryModule.no_code_allowed_for_org the correct objects are returned.

annawinkler · 2022-11-09T17:03:57Z

💅 One final request - please squash merge the commits into one commit. Thanks!

sebasslash

The code here looks great 🚀 . There is one minor non-blocking comment below ⬇️

I may even go so far as to say if you can squash your 10 commits to 3 (if possible): one for your implementation, one for your tests, and one for your changelog/housekeeping changes. You don't have to follow this structure but it helps keep our history clean 😄

registry_module.go

miguelhrocha · 2022-11-11T14:03:36Z

Hi @sebasslash !

Thanks for reviewing my code 😄 I had to resolve some conflicts so I implemented your proposal. I will use the merge squash functionality from GitHub 👍🏼

sebasslash

Changes look good! 🚀 Feel free to merge when you're ready 👍

github-actions · 2022-11-15T11:59:59Z

Reminder to the contributor that merged this PR: if your changes have added important functionality or fixed a relevant bug, open a follow-up PR to update CHANGELOG.md with a note on your changes.

miguelhrocha added 4 commits October 25, 2022 19:32

add update api for registry modules

daac631

add no code properties to registry modules create

9e91c72

fix create module with no code attribute test

d099f90

add beta tags for the no code attributes

1e612e9

miguelhrocha marked this pull request as ready for review October 26, 2022 10:34

miguelhrocha requested a review from a team as a code owner October 26, 2022 10:34

This was referenced Oct 26, 2022

🚧 [WIP] 🚧 no code modules attribute hashicorp/terraform-provider-tfe#672

Closed

Introduce no-code modules in registry modules hashicorp/terraform-provider-tfe#673

Merged

annawinkler changed the title ~~no code provisiniong in registry modules~~ no code provisioning in registry modules Oct 31, 2022

Uk1288 reviewed Nov 3, 2022

View reviewed changes

registry_module.go Outdated Show resolved Hide resolved

Update registry_module.go

f2ad981

Co-authored-by: UKEME BASSEY <ukeme.bassey@hashicorp.com>

Uk1288 reviewed Nov 3, 2022

View reviewed changes

registry_module_integration_test.go Show resolved Hide resolved

Uk1288 previously approved these changes Nov 3, 2022

View reviewed changes

miguelhrocha added 2 commits November 3, 2022 14:53

add no-code module default value in create tests

6bb5c5a

Merge branch 'miguelhrocha/no-code-modules' of github.com:hashicorp/g…

e2592cd

…o-tfe into miguelhrocha/no-code-modules

miguelhrocha dismissed Uk1288’s stale review via e2592cd November 3, 2022 13:55

miguelhrocha requested a review from Uk1288 November 3, 2022 13:55

annawinkler previously requested changes Nov 3, 2022

View reviewed changes

miguelhrocha added 2 commits November 3, 2022 17:49

Merge branch 'main' into miguelhrocha/no-code-modules

e7fcc3c

add changelog entry

b1e5d0c

miguelhrocha requested a review from annawinkler November 3, 2022 16:54

Merge branch 'main' into miguelhrocha/no-code-modules

706233f

annawinkler reviewed Nov 8, 2022

View reviewed changes

sebasslash previously approved these changes Nov 10, 2022

View reviewed changes

registry_module.go Outdated Show resolved Hide resolved

miguelhrocha dismissed sebasslash’s stale review via e0f218d November 11, 2022 14:01

miguelhrocha added 2 commits November 11, 2022 15:01

Remove omitempty from RegistryModule's NoCode

e0f218d

Merge branch 'main' into miguelhrocha/no-code-modules

c204d50

miguelhrocha requested a review from sebasslash November 11, 2022 14:02

Fix NoCode Update struct

824b58b

sebasslash approved these changes Nov 14, 2022

View reviewed changes

miguelhrocha merged commit 6dcc99c into main Nov 15, 2022

miguelhrocha deleted the miguelhrocha/no-code-modules branch November 15, 2022 11:58

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

no code provisioning in registry modules #562

no code provisioning in registry modules #562

miguelhrocha commented Oct 25, 2022 •

edited

Uk1288 left a comment

annawinkler left a comment

miguelhrocha commented Nov 3, 2022

annawinkler commented Nov 8, 2022

annawinkler Nov 8, 2022

annawinkler left a comment

annawinkler commented Nov 8, 2022

annawinkler commented Nov 9, 2022

sebasslash left a comment

miguelhrocha commented Nov 11, 2022

sebasslash left a comment

github-actions bot commented Nov 15, 2022

no code provisioning in registry modules #562

no code provisioning in registry modules #562

Conversation

miguelhrocha commented Oct 25, 2022 • edited

Description

Testing plan

Using integration tests

Using TFE instance

External links

Output from tests

Update endpoint changes

Create endpoint changes

Uk1288 left a comment

Choose a reason for hiding this comment

annawinkler left a comment

Choose a reason for hiding this comment

miguelhrocha commented Nov 3, 2022

annawinkler commented Nov 8, 2022

annawinkler Nov 8, 2022

Choose a reason for hiding this comment

annawinkler left a comment

Choose a reason for hiding this comment

annawinkler commented Nov 8, 2022

annawinkler commented Nov 9, 2022

sebasslash left a comment

Choose a reason for hiding this comment

miguelhrocha commented Nov 11, 2022

sebasslash left a comment

Choose a reason for hiding this comment

github-actions bot commented Nov 15, 2022

miguelhrocha commented Oct 25, 2022 •

edited