Add Organization Module Sharing Resource #425
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| package tfe | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "log" | ||
| "strings" | ||
|
|
||
| tfe "github.com/hashicorp/go-tfe" | ||
| "github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema" | ||
| ) | ||
|
|
||
| func resourceTFEOrganizationModuleSharing() *schema.Resource { | ||
| return &schema.Resource{ | ||
| Create: resourceTFEOrganizationModuleSharingCreate, | ||
| Read: resourceTFEOrganizationModuleSharingRead, | ||
| Update: resourceTFEOrganizationModuleSharingUpdate, | ||
| Delete: resourceTFEOrganizationModuleSharingDelete, | ||
| Schema: map[string]*schema.Schema{ | ||
| "organization": { | ||
| Type: schema.TypeString, | ||
| Required: true, | ||
| DiffSuppressFunc: func(k, old, new string, d *schema.ResourceData) bool { | ||
| return strings.EqualFold(old, new) | ||
| }, | ||
| }, | ||
|
|
||
| "module_consumers": { | ||
| Type: schema.TypeList, | ||
| Elem: &schema.Schema{Type: schema.TypeString}, | ||
| Required: true, | ||
| }, | ||
| }, | ||
| } | ||
| } | ||
|
|
||
| func resourceTFEOrganizationModuleSharingCreate(d *schema.ResourceData, meta interface{}) error { | ||
| // Get the organization name that will share "produce" modules | ||
| producer := d.Get("organization").(string) | ||
|
|
||
| log.Printf("[DEBUG] Create %s module consumers", producer) | ||
| d.SetId(producer) | ||
|
|
||
| return resourceTFEOrganizationModuleSharingUpdate(d, meta) | ||
| } | ||
|
|
||
| func resourceTFEOrganizationModuleSharingUpdate(d *schema.ResourceData, meta interface{}) error { | ||
| tfeClient := meta.(*tfe.Client) | ||
|
|
||
| var consumers []string | ||
| for _, name := range d.Get("module_consumers").([]interface{}) { | ||
| // ignore empty strings | ||
| if name == nil { | ||
| continue | ||
| } | ||
| consumers = append(consumers, name.(string)) | ||
| } | ||
|
|
||
| log.Printf("[DEBUG] Update %s module consumers", d.Id()) | ||
| err := tfeClient.Admin.Organizations.UpdateModuleConsumers(ctx, d.Id(), consumers) | ||
| if err != nil { | ||
| return fmt.Errorf("error updating module consumers to %s: %w", d.Id(), err) | ||
| } | ||
|
|
||
| return resourceTFEOrganizationModuleSharingRead(d, meta) | ||
| } | ||
|
|
||
| func resourceTFEOrganizationModuleSharingRead(d *schema.ResourceData, meta interface{}) error { | ||
| tfeClient := meta.(*tfe.Client) | ||
|
|
||
| options := tfe.AdminOrganizationListModuleConsumersOptions{} | ||
|
|
||
| log.Printf("[DEBUG] Read configuration of module sharing for organization: %s", d.Id()) | ||
| for { | ||
| consumerList, err := tfeClient.Admin.Organizations.ListModuleConsumers(ctx, d.Id(), options) | ||
| if err != nil { | ||
| if err == tfe.ErrResourceNotFound { | ||
| log.Printf("[DEBUG] Organization %s does not longer exist", d.Id()) | ||
| d.SetId("") | ||
| return nil | ||
| } | ||
| return fmt.Errorf("Error reading organization %s module consumer list: %w", d.Id(), err) | ||
| } | ||
|
|
||
| if consumerList.CurrentPage >= consumerList.TotalPages { | ||
| break | ||
| } | ||
|
|
||
| options.PageNumber = consumerList.NextPage | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| func resourceTFEOrganizationModuleSharingDelete(d *schema.ResourceData, meta interface{}) error { | ||
| tfeClient := meta.(*tfe.Client) | ||
|
|
||
| log.Printf("[DEBUG] Disable module sharing for organization: %s", d.Id()) | ||
| err := tfeClient.Admin.Organizations.UpdateModuleConsumers(ctx, d.Id(), []string{}) | ||
| if err != nil { | ||
| if err == tfe.ErrResourceNotFound { | ||
| return nil | ||
| } | ||
| return fmt.Errorf("failed to delete module sharing for organization %s: %w", d.Id(), err) | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,163 @@ | ||
| package tfe | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "math/rand" | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource" | ||
| ) | ||
|
|
||
| func TestAccTFEOrganizationModuleSharing_basic(t *testing.T) { | ||
| skipIfFreeOnly(t) | ||
|
There was a problem hiding this comment. Should these be skipped for Terraform Cloud as well? |
||
| skipIfCloud(t) | ||
|
|
||
| rInt1 := rand.New(rand.NewSource(time.Now().UnixNano())).Int() | ||
| rInt2 := rand.New(rand.NewSource(time.Now().UnixNano())).Int() | ||
| rInt3 := rand.New(rand.NewSource(time.Now().UnixNano())).Int() | ||
|
|
||
| // Destroying a module sharing relationship is effectively updating | ||
| // the module sharing resource consumers to be an empty array | ||
| // We've omitted CheckDestroy since verifying the module sharing | ||
| // has been deleted requires the organizations to exist (and they are destroyed | ||
| // prior to CheckDestroy being executed) | ||
| resource.Test(t, resource.TestCase{ | ||
| PreCheck: func() { testAccPreCheck(t) }, | ||
| Providers: testAccProviders, | ||
| Steps: []resource.TestStep{ | ||
| { | ||
| Config: testAccTFEOrganizationModuleSharing_basic(rInt1, rInt2, rInt3), | ||
| Check: resource.ComposeAggregateTestCheckFunc( | ||
| // organization attribute */ | ||
| resource.TestCheckResourceAttr( | ||
| "tfe_organization_module_sharing.producer", "organization", fmt.Sprintf("tst-terraform-%d", rInt1)), | ||
|
|
||
| // module_consumers attribute | ||
| resource.TestCheckResourceAttr( | ||
| "tfe_organization_module_sharing.producer", "module_consumers.#", "2"), | ||
| resource.TestCheckResourceAttrSet( | ||
| "tfe_organization_module_sharing.producer", "module_consumers.0"), | ||
| resource.TestCheckResourceAttrSet( | ||
| "tfe_organization_module_sharing.producer", "module_consumers.1"), | ||
| ), | ||
| }, | ||
| }, | ||
| }) | ||
| } | ||
|
|
||
| func TestAccTFEOrganizationModuleSharing_emptyOrg(t *testing.T) { | ||
| skipIfFreeOnly(t) | ||
| skipIfCloud(t) | ||
|
|
||
| rInt1 := rand.New(rand.NewSource(time.Now().UnixNano())).Int() | ||
| rInt2 := rand.New(rand.NewSource(time.Now().UnixNano())).Int() | ||
|
|
||
| resource.Test(t, resource.TestCase{ | ||
| PreCheck: func() { testAccPreCheck(t) }, | ||
| Providers: testAccProviders, | ||
| Steps: []resource.TestStep{ | ||
| { | ||
| Config: testAccTFEOrganizationModuleSharing_emptyOrg(rInt1, rInt2), | ||
| Check: resource.ComposeAggregateTestCheckFunc( | ||
| // organization attribute */ | ||
| resource.TestCheckResourceAttr( | ||
| "tfe_organization_module_sharing.foo", "organization", fmt.Sprintf("tst-terraform-%d", rInt1)), | ||
|
|
||
| // module_consumers attribute | ||
| // even though we've provided an empty string, | ||
| // we'll have two entries here since they are ignored | ||
| resource.TestCheckResourceAttr( | ||
| "tfe_organization_module_sharing.foo", "module_consumers.#", "2"), | ||
| resource.TestCheckResourceAttr( | ||
| "tfe_organization_module_sharing.foo", "module_consumers.0", ""), | ||
| resource.TestCheckResourceAttr( | ||
| "tfe_organization_module_sharing.foo", "module_consumers.1", fmt.Sprintf("tst-terraform-%d", rInt2)), | ||
| ), | ||
| }, | ||
| }, | ||
| }) | ||
| } | ||
|
|
||
| func TestAccTFEOrganizationModuleSharing_stopSharing(t *testing.T) { | ||
| skipIfFreeOnly(t) | ||
| skipIfCloud(t) | ||
|
|
||
| rInt1 := rand.New(rand.NewSource(time.Now().UnixNano())).Int() | ||
|
|
||
| // This test will serve as a proxy for CheckDestroy, since | ||
| // setting a module_consumers to an empty array of | ||
| // "destroys" the resource | ||
| resource.Test(t, resource.TestCase{ | ||
| PreCheck: func() { testAccPreCheck(t) }, | ||
| Providers: testAccProviders, | ||
| Steps: []resource.TestStep{ | ||
| { | ||
| Config: testAccTFEOrganizationModuleSharing_stopSharing(rInt1), | ||
| Check: resource.ComposeAggregateTestCheckFunc( | ||
| // organization attribute */ | ||
| resource.TestCheckResourceAttr( | ||
| "tfe_organization_module_sharing.foo", "organization", fmt.Sprintf("tst-terraform-%d", rInt1)), | ||
|
|
||
| // module_consumers attribute | ||
| resource.TestCheckResourceAttr( | ||
| "tfe_organization_module_sharing.foo", "module_consumers.#", "0"), | ||
| ), | ||
| }, | ||
| }, | ||
| }) | ||
| } | ||
|
|
||
| func testAccTFEOrganizationModuleSharing_basic(rInt1 int, rInt2 int, rInt3 int) string { | ||
| return fmt.Sprintf(` | ||
| resource "tfe_organization" "foobar" { | ||
| name = "tst-terraform-%d" | ||
| email = "[email protected]" | ||
| } | ||
|
|
||
| resource "tfe_organization" "foo" { | ||
| name = "tst-terraform-%d" | ||
| email = "[email protected]" | ||
| } | ||
|
|
||
| resource "tfe_organization" "bar" { | ||
| name = "tst-terraform-%d" | ||
| email = "[email protected]" | ||
| } | ||
|
|
||
| resource "tfe_organization_module_sharing" "producer" { | ||
| organization = tfe_organization.foobar.id | ||
| module_consumers = [tfe_organization.foo.id, tfe_organization.bar.id] | ||
| }`, rInt1, rInt2, rInt3) | ||
| } | ||
|
|
||
| func testAccTFEOrganizationModuleSharing_emptyOrg(rInt1 int, rInt2 int) string { | ||
| return fmt.Sprintf(` | ||
| resource "tfe_organization" "foo" { | ||
| name = "tst-terraform-%d" | ||
| email = "[email protected]" | ||
| } | ||
|
|
||
| resource "tfe_organization" "bar" { | ||
| name = "tst-terraform-%d" | ||
| email = "[email protected]" | ||
| } | ||
|
|
||
| resource "tfe_organization_module_sharing" "foo" { | ||
| organization = tfe_organization.foo.id | ||
| module_consumers = ["", tfe_organization.bar.id] | ||
| }`, rInt1, rInt2) | ||
| } | ||
|
|
||
| func testAccTFEOrganizationModuleSharing_stopSharing(rInt1 int) string { | ||
| return fmt.Sprintf(` | ||
| resource "tfe_organization" "foo" { | ||
| name = "tst-terraform-%d" | ||
| email = "[email protected]" | ||
| } | ||
|
|
||
| resource "tfe_organization_module_sharing" "foo" { | ||
| organization = tfe_organization.foo.id | ||
| module_consumers = [] | ||
| }`, rInt1) | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| --- | ||
| layout: "tfe" | ||
| page_title: "Terraform Enterprise: tfe_organization_module_sharing" | ||
| sidebar_current: "docs-resource-tfe-organization-module-sharing" | ||
| description: |- | ||
| Manage module sharing for an organization. | ||
| --- | ||
|
|
||
| # tfe_organization_module_sharing | ||
|
|
||
| Manage module sharing for an organization. | ||
|
|
||
| ~> **NOTE:** This resource requires using the provider with | ||
| an instance of Terraform Enterprise at least as recent as v202004-1. | ||
|
|
||
| ## Example Usage | ||
|
|
||
| Basic usage: | ||
|
|
||
| ```hcl | ||
| resource "tfe_organization_module_sharing" "test" { | ||
| organization = "my-org-name" | ||
| module_consumers = ["my-org-name-2", "my-org-name-3"] | ||
| } | ||
| ``` | ||
|
|
||
| ## Argument Reference | ||
|
|
||
| The following arguments are supported: | ||
|
|
||
| * `organization` - (Required) Name of the organization. | ||
| * `module_consumers` - (Required) Names of the organizations to consume the module registry. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Something may be amiss- is this entire function body supposed to be this line? Otherwise it looks like we are updating 2x