-
Notifications
You must be signed in to change notification settings - Fork 933
[FEAT] Add support for Enterprise Cost Centers #3000
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
vmvarela
wants to merge
33
commits into
integrations:main
Choose a base branch
from
vmvarela:cost-centers
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
33 commits
Select commit
Hold shift + click to select a range
efab2d8
feat(utils): add shared helper functions for cost centers
github-actions[bot] 7da8d3c
feat(cost-centers): add retry logic utilities for cost center operations
github-actions[bot] 4034934
feat(cost-centers): add github_enterprise_cost_center resource
github-actions[bot] 2c5f59c
feat(cost-centers): add github_enterprise_cost_center_users resource
github-actions[bot] a1cdf11
feat(cost-centers): add github_enterprise_cost_center_organizations r…
github-actions[bot] 790d3f9
feat(cost-centers): add github_enterprise_cost_center_repositories re…
github-actions[bot] 0169707
feat(cost-centers): add data sources for enterprise cost centers
github-actions[bot] 70ffa0e
feat(cost-centers): register cost center resources and data sources
github-actions[bot] fd7ee76
docs(cost-centers): add usage example
github-actions[bot] b381d96
fix(cost-centers): update go-github import to v82
github-actions[bot] 841d1e9
fix: removed linter config, it shouldn't be needed
vmvarela 78d73ae
fix(cost-centers): remove unnecessary expandStringSet function
vmvarela 4396ca4
fix(cost-centers): check deleted state in Read instead of Update
vmvarela 7210fb5
fix(cost-centers): separate Create and Update for users resource
vmvarela e479cb4
fix(cost-centers): separate Create and Update for organizations resource
vmvarela c0a1149
fix(cost-centers): separate Create and Update for repositories resource
vmvarela e4d5a68
fix(cost-centers): correct resource type strings in CheckDestroy func…
vmvarela 32fe45d
refactor(cost-centers): use type constants instead of magic strings
vmvarela fda96bf
fix(cost-centers): use terraform-plugin-testing imports in test files
vmvarela 196e438
fix(cost-centers): document generic chunk helper lint exception
vmvarela c38514d
fix: address review - rename single-char variables and remove unneces…
vmvarela 25f43d0
fix: address review - rename maxResourcesPerRequest to maxCostCenterR…
vmvarela c0d7219
fix: address review - simplify import test with ImportStateIdPrefix
vmvarela c0ce0cf
fix: address review - add unit tests for errIs404, errIsRetryable, ch…
vmvarela 371f37c
fix: address review - migrate cost center tests to ConfigStateChecks
vmvarela 35e0092
fix(cost-centers): update go-github import from v82 to v83
vmvarela 8395f25
fix(cost-centers): add default 'all' value to state field in cost cen…
vmvarela 757c071
fix(cost-center): populate name on import via API lookup
vmvarela c27c343
fix(cost-center): align sub-resource IDs with main resource
vmvarela bd51909
fix(cost-center): validate no existing assignments on Create
vmvarela 9cc1b71
refactor(cost-center): simplify Update diff with map pattern
vmvarela 34031c6
fix(cost-center): Delete removes all linked resources from API
vmvarela e7db627
fix(cost-center): add missing sub-resources to website sidebar
vmvarela File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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,115 @@ | ||
| terraform { | ||
| required_providers { | ||
| github = { | ||
| source = "integrations/github" | ||
| version = "~> 6.11" | ||
| } | ||
| } | ||
| } | ||
|
|
||
| provider "github" { | ||
| token = var.github_token | ||
| owner = var.enterprise_slug | ||
| } | ||
|
|
||
| variable "github_token" { | ||
| description = "GitHub classic personal access token (PAT) for an enterprise admin" | ||
| type = string | ||
| sensitive = true | ||
| } | ||
|
|
||
| variable "enterprise_slug" { | ||
| description = "The GitHub Enterprise slug" | ||
| type = string | ||
| } | ||
|
|
||
| variable "cost_center_name" { | ||
| description = "Name for the cost center" | ||
| type = string | ||
| } | ||
|
|
||
| variable "users" { | ||
| description = "Usernames to assign to the cost center" | ||
| type = list(string) | ||
| default = [] | ||
| } | ||
|
|
||
| variable "organizations" { | ||
| description = "Organization logins to assign to the cost center" | ||
| type = list(string) | ||
| default = [] | ||
| } | ||
|
|
||
| variable "repositories" { | ||
| description = "Repositories (full name, e.g. org/repo) to assign to the cost center" | ||
| type = list(string) | ||
| default = [] | ||
| } | ||
|
|
||
| # The cost center resource manages only the cost center entity itself. | ||
| resource "github_enterprise_cost_center" "example" { | ||
| enterprise_slug = var.enterprise_slug | ||
| name = var.cost_center_name | ||
| } | ||
|
|
||
| # Use separate authoritative resources for assignments. | ||
| # These are optional - only create them if you have items to assign. | ||
|
|
||
| resource "github_enterprise_cost_center_users" "example" { | ||
| count = length(var.users) > 0 ? 1 : 0 | ||
|
|
||
| enterprise_slug = var.enterprise_slug | ||
| cost_center_id = github_enterprise_cost_center.example.id | ||
| usernames = var.users | ||
| } | ||
|
|
||
| resource "github_enterprise_cost_center_organizations" "example" { | ||
| count = length(var.organizations) > 0 ? 1 : 0 | ||
|
|
||
| enterprise_slug = var.enterprise_slug | ||
| cost_center_id = github_enterprise_cost_center.example.id | ||
| organization_logins = var.organizations | ||
| } | ||
|
|
||
| resource "github_enterprise_cost_center_repositories" "example" { | ||
| count = length(var.repositories) > 0 ? 1 : 0 | ||
|
|
||
| enterprise_slug = var.enterprise_slug | ||
| cost_center_id = github_enterprise_cost_center.example.id | ||
| repository_names = var.repositories | ||
| } | ||
|
|
||
| # Data sources for reading cost center information | ||
| data "github_enterprise_cost_center" "by_id" { | ||
| enterprise_slug = var.enterprise_slug | ||
| cost_center_id = github_enterprise_cost_center.example.id | ||
| } | ||
|
|
||
| data "github_enterprise_cost_centers" "active" { | ||
| enterprise_slug = var.enterprise_slug | ||
| state = "active" | ||
|
|
||
| depends_on = [github_enterprise_cost_center.example] | ||
| } | ||
|
|
||
| output "cost_center" { | ||
| description = "Created cost center" | ||
| value = { | ||
| id = github_enterprise_cost_center.example.id | ||
| name = github_enterprise_cost_center.example.name | ||
| state = github_enterprise_cost_center.example.state | ||
| azure_subscription = github_enterprise_cost_center.example.azure_subscription | ||
| } | ||
| } | ||
|
|
||
| output "cost_center_from_data_source" { | ||
| description = "Cost center fetched by data source (includes all assignments)" | ||
| value = { | ||
| id = data.github_enterprise_cost_center.by_id.cost_center_id | ||
| name = data.github_enterprise_cost_center.by_id.name | ||
| state = data.github_enterprise_cost_center.by_id.state | ||
| users = sort(tolist(data.github_enterprise_cost_center.by_id.users)) | ||
| organizations = sort(tolist(data.github_enterprise_cost_center.by_id.organizations)) | ||
| repositories = sort(tolist(data.github_enterprise_cost_center.by_id.repositories)) | ||
| } | ||
| } | ||
This file contains hidden or 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,113 @@ | ||
| package github | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| "github.com/hashicorp/terraform-plugin-sdk/v2/diag" | ||
| "github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema" | ||
| ) | ||
|
|
||
| func dataSourceGithubEnterpriseCostCenter() *schema.Resource { | ||
| return &schema.Resource{ | ||
| Description: "Use this data source to retrieve information about a specific enterprise cost center.", | ||
| ReadContext: dataSourceGithubEnterpriseCostCenterRead, | ||
|
|
||
vmvarela marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| Schema: map[string]*schema.Schema{ | ||
| "enterprise_slug": { | ||
| Type: schema.TypeString, | ||
| Required: true, | ||
| Description: "The slug of the enterprise.", | ||
| }, | ||
| "cost_center_id": { | ||
| Type: schema.TypeString, | ||
| Required: true, | ||
| Description: "The ID of the cost center.", | ||
| }, | ||
| "name": { | ||
| Type: schema.TypeString, | ||
| Computed: true, | ||
| Description: "The name of the cost center.", | ||
| }, | ||
| "state": { | ||
| Type: schema.TypeString, | ||
| Computed: true, | ||
| Description: "The state of the cost center.", | ||
| }, | ||
| "azure_subscription": { | ||
| Type: schema.TypeString, | ||
| Computed: true, | ||
| Description: "The Azure subscription associated with the cost center.", | ||
| }, | ||
| "users": { | ||
| Type: schema.TypeSet, | ||
| Computed: true, | ||
| Elem: &schema.Schema{Type: schema.TypeString}, | ||
| Description: "The usernames assigned to this cost center.", | ||
| }, | ||
| "organizations": { | ||
| Type: schema.TypeSet, | ||
| Computed: true, | ||
| Elem: &schema.Schema{Type: schema.TypeString}, | ||
| Description: "The organization logins assigned to this cost center.", | ||
| }, | ||
| "repositories": { | ||
| Type: schema.TypeSet, | ||
| Computed: true, | ||
| Elem: &schema.Schema{Type: schema.TypeString}, | ||
| Description: "The repositories (full name) assigned to this cost center.", | ||
| }, | ||
| }, | ||
| } | ||
| } | ||
|
|
||
| func dataSourceGithubEnterpriseCostCenterRead(ctx context.Context, d *schema.ResourceData, meta any) diag.Diagnostics { | ||
| client := meta.(*Owner).v3client | ||
| enterpriseSlug := d.Get("enterprise_slug").(string) | ||
| costCenterID := d.Get("cost_center_id").(string) | ||
|
|
||
| cc, _, err := client.Enterprise.GetCostCenter(ctx, enterpriseSlug, costCenterID) | ||
| if err != nil { | ||
| return diag.FromErr(err) | ||
| } | ||
|
|
||
| d.SetId(costCenterID) | ||
vmvarela marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| if err := d.Set("name", cc.Name); err != nil { | ||
| return diag.FromErr(err) | ||
| } | ||
|
|
||
| if err := d.Set("state", cc.GetState()); err != nil { | ||
| return diag.FromErr(err) | ||
| } | ||
| if err := d.Set("azure_subscription", cc.GetAzureSubscription()); err != nil { | ||
| return diag.FromErr(err) | ||
| } | ||
|
|
||
| users := make([]string, 0) | ||
| organizations := make([]string, 0) | ||
| repositories := make([]string, 0) | ||
| for _, resource := range cc.Resources { | ||
| if resource == nil { | ||
| continue | ||
| } | ||
| switch resource.Type { | ||
| case CostCenterResourceTypeUser: | ||
| users = append(users, resource.Name) | ||
| case CostCenterResourceTypeOrg: | ||
| organizations = append(organizations, resource.Name) | ||
| case CostCenterResourceTypeRepo: | ||
| repositories = append(repositories, resource.Name) | ||
| } | ||
| } | ||
|
|
||
| if err := d.Set("users", users); err != nil { | ||
| return diag.FromErr(err) | ||
| } | ||
| if err := d.Set("organizations", organizations); err != nil { | ||
| return diag.FromErr(err) | ||
| } | ||
| if err := d.Set("repositories", repositories); err != nil { | ||
| return diag.FromErr(err) | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
This file contains hidden or 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,44 @@ | ||
| package github | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "testing" | ||
|
|
||
| "github.com/hashicorp/terraform-plugin-testing/compare" | ||
| "github.com/hashicorp/terraform-plugin-testing/helper/acctest" | ||
| "github.com/hashicorp/terraform-plugin-testing/helper/resource" | ||
| "github.com/hashicorp/terraform-plugin-testing/knownvalue" | ||
| "github.com/hashicorp/terraform-plugin-testing/statecheck" | ||
| "github.com/hashicorp/terraform-plugin-testing/tfjsonpath" | ||
| ) | ||
|
|
||
| func TestAccGithubEnterpriseCostCenterDataSource(t *testing.T) { | ||
| randomID := acctest.RandString(5) | ||
|
|
||
| resource.Test(t, resource.TestCase{ | ||
| PreCheck: func() { skipUnlessEnterprise(t) }, | ||
| ProviderFactories: providerFactories, | ||
| Steps: []resource.TestStep{{ | ||
| Config: fmt.Sprintf(` | ||
| data "github_enterprise" "enterprise" { | ||
| slug = "%s" | ||
| } | ||
|
|
||
| resource "github_enterprise_cost_center" "test" { | ||
| enterprise_slug = data.github_enterprise.enterprise.slug | ||
| name = "%s%s" | ||
| } | ||
|
|
||
| data "github_enterprise_cost_center" "test" { | ||
| enterprise_slug = data.github_enterprise.enterprise.slug | ||
| cost_center_id = github_enterprise_cost_center.test.id | ||
| } | ||
| `, testAccConf.enterpriseSlug, testResourcePrefix, randomID), | ||
| ConfigStateChecks: []statecheck.StateCheck{ | ||
| statecheck.CompareValuePairs("data.github_enterprise_cost_center.test", tfjsonpath.New("cost_center_id"), "github_enterprise_cost_center.test", tfjsonpath.New("id"), compare.ValuesSame()), | ||
| statecheck.CompareValuePairs("data.github_enterprise_cost_center.test", tfjsonpath.New("name"), "github_enterprise_cost_center.test", tfjsonpath.New("name"), compare.ValuesSame()), | ||
| statecheck.ExpectKnownValue("data.github_enterprise_cost_center.test", tfjsonpath.New("state"), knownvalue.StringExact("active")), | ||
| }, | ||
| }}, | ||
| }) | ||
| } |
This file contains hidden or 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,100 @@ | ||||||||
| package github | ||||||||
|
|
||||||||
| import ( | ||||||||
| "context" | ||||||||
|
|
||||||||
| "github.com/google/go-github/v83/github" | ||||||||
| "github.com/hashicorp/terraform-plugin-sdk/v2/diag" | ||||||||
| "github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema" | ||||||||
| "github.com/hashicorp/terraform-plugin-sdk/v2/helper/validation" | ||||||||
| ) | ||||||||
|
|
||||||||
| func dataSourceGithubEnterpriseCostCenters() *schema.Resource { | ||||||||
| return &schema.Resource{ | ||||||||
| Description: "Use this data source to retrieve a list of enterprise cost centers.", | ||||||||
| ReadContext: dataSourceGithubEnterpriseCostCentersRead, | ||||||||
|
|
||||||||
| Schema: map[string]*schema.Schema{ | ||||||||
| "enterprise_slug": { | ||||||||
| Type: schema.TypeString, | ||||||||
| Required: true, | ||||||||
| Description: "The slug of the enterprise.", | ||||||||
| }, | ||||||||
| "state": { | ||||||||
| Type: schema.TypeString, | ||||||||
| Optional: true, | ||||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
If you add a default your logic in the read function would be much simpler.
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Done |
||||||||
| Default: "all", | ||||||||
| ValidateDiagFunc: validation.ToDiagFunc(validation.StringInSlice([]string{"all", "active", "deleted"}, false)), | ||||||||
| Description: "Filter cost centers by state. Valid values are 'all', 'active', and 'deleted'.", | ||||||||
| }, | ||||||||
| "cost_centers": { | ||||||||
| Type: schema.TypeSet, | ||||||||
| Computed: true, | ||||||||
| Description: "The list of cost centers.", | ||||||||
| Elem: &schema.Resource{ | ||||||||
| Schema: map[string]*schema.Schema{ | ||||||||
| "id": { | ||||||||
| Type: schema.TypeString, | ||||||||
| Computed: true, | ||||||||
| Description: "The cost center ID.", | ||||||||
| }, | ||||||||
| "name": { | ||||||||
| Type: schema.TypeString, | ||||||||
| Computed: true, | ||||||||
| Description: "The name of the cost center.", | ||||||||
| }, | ||||||||
| "state": { | ||||||||
| Type: schema.TypeString, | ||||||||
| Computed: true, | ||||||||
| Description: "The state of the cost center.", | ||||||||
| }, | ||||||||
| "azure_subscription": { | ||||||||
| Type: schema.TypeString, | ||||||||
| Computed: true, | ||||||||
| Description: "The Azure subscription associated with the cost center.", | ||||||||
| }, | ||||||||
| }, | ||||||||
| }, | ||||||||
| }, | ||||||||
| }, | ||||||||
| } | ||||||||
| } | ||||||||
|
|
||||||||
| func dataSourceGithubEnterpriseCostCentersRead(ctx context.Context, d *schema.ResourceData, meta any) diag.Diagnostics { | ||||||||
| client := meta.(*Owner).v3client | ||||||||
| enterpriseSlug := d.Get("enterprise_slug").(string) | ||||||||
| stateFilter := d.Get("state").(string) | ||||||||
|
|
||||||||
| var opts github.ListCostCenterOptions | ||||||||
| if stateFilter != "all" { | ||||||||
| opts.State = github.Ptr(stateFilter) | ||||||||
| } | ||||||||
|
|
||||||||
| result, _, err := client.Enterprise.ListCostCenters(ctx, enterpriseSlug, &opts) | ||||||||
| if err != nil { | ||||||||
| return diag.FromErr(err) | ||||||||
| } | ||||||||
|
|
||||||||
| items := make([]any, 0, len(result.CostCenters)) | ||||||||
| for _, cc := range result.CostCenters { | ||||||||
| if cc == nil { | ||||||||
| continue | ||||||||
| } | ||||||||
| items = append(items, map[string]any{ | ||||||||
| "id": cc.ID, | ||||||||
| "name": cc.Name, | ||||||||
| "state": cc.GetState(), | ||||||||
| "azure_subscription": cc.GetAzureSubscription(), | ||||||||
| }) | ||||||||
| } | ||||||||
|
|
||||||||
| id, err := buildID(enterpriseSlug, stateFilter) | ||||||||
| if err != nil { | ||||||||
| return diag.FromErr(err) | ||||||||
| } | ||||||||
| d.SetId(id) | ||||||||
| if err := d.Set("cost_centers", items); err != nil { | ||||||||
| return diag.FromErr(err) | ||||||||
| } | ||||||||
| return nil | ||||||||
| } | ||||||||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.