From 27e7398ab0af536bc84cc149f9a996dcc0d46c9b Mon Sep 17 00:00:00 2001 From: Ori Rawlings Date: Fri, 20 Mar 2026 17:04:30 -0500 Subject: [PATCH] feat: Add `github_team_external_groups` data source Fixes #3295 --- docs/data-sources/team_external_groups.md | 39 ++++++++ .../data-source-1.tf | 3 + ...data_source_github_team_external_groups.go | 89 +++++++++++++++++++ ...source_github_team_external_groups_test.go | 61 +++++++++++++ github/provider.go | 1 + 5 files changed, 193 insertions(+) create mode 100644 docs/data-sources/team_external_groups.md create mode 100644 examples/data-sources/github_team_external_groups/data-source-1.tf create mode 100644 github/data_source_github_team_external_groups.go create mode 100644 github/data_source_github_team_external_groups_test.go diff --git a/docs/data-sources/team_external_groups.md b/docs/data-sources/team_external_groups.md new file mode 100644 index 0000000000..1ad797633e --- /dev/null +++ b/docs/data-sources/team_external_groups.md @@ -0,0 +1,39 @@ +--- +page_title: "github_team_external_groups (Data Source) - GitHub" +subcategory: "" +description: |- + Retrieve external groups for a specific GitHub team. +--- + +# github_team_external_groups (Data Source) + +Retrieve external groups for a specific GitHub team. + +## Example Usage + +```terraform +data "github_team_external_groups" "example" { + slug = "example" +} +``` + + +## Schema + +### Required + +- `slug` (String) The slug of the GitHub team. + +### Read-Only + +- `external_groups` (List of Object) (see [below for nested schema](#nestedatt--external_groups)) +- `id` (String) The ID of this resource. + + +### Nested Schema for `external_groups` + +Read-Only: + +- `group_id` (Number) +- `group_name` (String) +- `updated_at` (String) diff --git a/examples/data-sources/github_team_external_groups/data-source-1.tf b/examples/data-sources/github_team_external_groups/data-source-1.tf new file mode 100644 index 0000000000..508de945f7 --- /dev/null +++ b/examples/data-sources/github_team_external_groups/data-source-1.tf @@ -0,0 +1,3 @@ +data "github_team_external_groups" "example" { + slug = "example" +} diff --git a/github/data_source_github_team_external_groups.go b/github/data_source_github_team_external_groups.go new file mode 100644 index 0000000000..e7058eca68 --- /dev/null +++ b/github/data_source_github_team_external_groups.go @@ -0,0 +1,89 @@ +package github + +import ( + "context" + "encoding/json" + + "github.com/hashicorp/terraform-plugin-sdk/v2/diag" + "github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema" +) + +func dataSourceGithubTeamExternalGroups() *schema.Resource { + return &schema.Resource{ + Description: "Retrieve external groups for a specific GitHub team.", + ReadContext: dataSourceGithubTeamExternalGroupsRead, + Schema: map[string]*schema.Schema{ + "slug": { + Type: schema.TypeString, + Required: true, + Description: "The slug of the GitHub team.", + }, + "external_groups": { + Type: schema.TypeList, + Computed: true, + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + "group_id": { + Type: schema.TypeInt, + Computed: true, + }, + "group_name": { + Type: schema.TypeString, + Computed: true, + }, + "updated_at": { + Type: schema.TypeString, + Computed: true, + }, + }, + }, + }, + }, + } +} + +func dataSourceGithubTeamExternalGroupsRead(ctx context.Context, d *schema.ResourceData, meta any) diag.Diagnostics { + owner, ok := meta.(*Owner) + if !ok { + return diag.Errorf("expected type of %s to be *Owner", meta) + } + err := checkOrganization(owner) + if err != nil { + return diag.FromErr(err) + } + client := owner.v3client + orgName := owner.name + slug, ok := d.Get("slug").(string) + if !ok { + return diag.Errorf("expected type of %s to be string", d.Get("slug")) + } + + externalGroups, _, err := client.Teams.ListExternalGroupsForTeamBySlug(ctx, orgName, slug) + if err != nil { + return diag.FromErr(err) + } + + // convert to JSON in order to marshal to format we can return + jsonGroups, err := json.Marshal(externalGroups.Groups) + if err != nil { + return diag.FromErr(err) + } + + groupsState := make([]map[string]any, 0) + err = json.Unmarshal(jsonGroups, &groupsState) + if err != nil { + return diag.FromErr(err) + } + + if err := d.Set("external_groups", groupsState); err != nil { + return diag.FromErr(err) + } + + id, err := buildID(orgName, slug) + if err != nil { + return diag.FromErr(err) + } + d.SetId(id) + + return nil +} diff --git a/github/data_source_github_team_external_groups_test.go b/github/data_source_github_team_external_groups_test.go new file mode 100644 index 0000000000..f993dd0650 --- /dev/null +++ b/github/data_source_github_team_external_groups_test.go @@ -0,0 +1,61 @@ +package github + +import ( + "fmt" + "regexp" + "testing" + + "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 TestAccGithubTeamExternalGroupsDataSource(t *testing.T) { + t.Run("errors when querying a non-existing team", func(t *testing.T) { + config := ` + data "github_team_external_groups" "test" { + slug = "non-existing-team-slug" + } + ` + + resource.Test(t, resource.TestCase{ + PreCheck: func() { skipUnlessEMUEnterprise(t) }, + ProviderFactories: providerFactories, + Steps: []resource.TestStep{ + { + Config: config, + ExpectError: regexp.MustCompile(`Not Found`), + }, + }, + }) + }) + + t.Run("returns empty list for team without external groups", func(t *testing.T) { + randomID := acctest.RandStringFromCharSet(5, acctest.CharSetAlphaNum) + teamName := fmt.Sprintf("%steam-%s", testResourcePrefix, randomID) + config := fmt.Sprintf(` + resource "github_team" "test" { + name = "%s" + } + + data "github_team_external_groups" "test" { + slug = github_team.test.slug + } + `, teamName) + + resource.Test(t, resource.TestCase{ + PreCheck: func() { skipUnlessEMUEnterprise(t) }, + ProviderFactories: providerFactories, + Steps: []resource.TestStep{ + { + Config: config, + ConfigStateChecks: []statecheck.StateCheck{ + statecheck.ExpectKnownValue("data.github_team_external_groups.test", tfjsonpath.New("external_groups"), knownvalue.ListSizeExact(0)), + }, + }, + }, + }) + }) +} diff --git a/github/provider.go b/github/provider.go index 73e93dc5e5..4df9281142 100644 --- a/github/provider.go +++ b/github/provider.go @@ -336,6 +336,7 @@ func NewProvider(version, commit string) func() *schema.Provider { "github_team": dataSourceGithubTeam(), "github_team_members": dataSourceGithubTeamMembers(), "github_team_repositories": dataSourceGithubTeamRepositories(), + "github_team_external_groups": dataSourceGithubTeamExternalGroups(), "github_tree": dataSourceGithubTree(), "github_user": dataSourceGithubUser(), "github_user_external_identity": dataSourceGithubUserExternalIdentity(),