diff --git a/github/acc_test.go b/github/acc_test.go index 87bac1d698..5105c913fe 100644 --- a/github/acc_test.go +++ b/github/acc_test.go @@ -300,6 +300,24 @@ func skipUnlessEnterprise(t *testing.T) { } } +func skipUnlessHasAppInstallations(t *testing.T) { + t.Helper() + + meta, err := getTestMeta() + if err != nil { + t.Fatalf("failed to get test meta: %s", err) + } + + installations, _, err := meta.v3client.Organizations.ListInstallations(context.Background(), meta.name, nil) + if err != nil { + t.Fatalf("failed to list app installations: %s", err) + } + + if len(installations.Installations) == 0 { + t.Skip("Skipping because no GitHub App installations found in the test organization") + } +} + func skipUnlessMode(t *testing.T, testModes ...testMode) { if !slices.Contains(testModes, testAccConf.authMode) { t.Skip("Skipping as not supported test mode") diff --git a/github/data_source_github_organization_app_installations.go b/github/data_source_github_organization_app_installations.go new file mode 100644 index 0000000000..49e0b8d86e --- /dev/null +++ b/github/data_source_github_organization_app_installations.go @@ -0,0 +1,269 @@ +package github + +import ( + "context" + + "github.com/google/go-github/v82/github" + "github.com/hashicorp/terraform-plugin-sdk/v2/diag" + "github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema" +) + +func dataSourceGithubOrganizationAppInstallations() *schema.Resource { + return &schema.Resource{ + ReadContext: dataSourceGithubOrganizationAppInstallationsRead, + Description: "Use this data source to retrieve all GitHub App installations of the organization.", + + Schema: map[string]*schema.Schema{ + "installations": { + Type: schema.TypeList, + Computed: true, + Description: "List of GitHub App installations in the organization.", + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + "id": { + Type: schema.TypeInt, + Computed: true, + Description: "The ID of the GitHub App installation.", + }, + "app_slug": { + Type: schema.TypeString, + Computed: true, + Description: "The URL-friendly name of the GitHub App.", + }, + "app_id": { + Type: schema.TypeInt, + Computed: true, + Description: "The ID of the GitHub App.", + }, + "repository_selection": { + Type: schema.TypeString, + Computed: true, + Description: "Whether the installation has access to all repositories or only selected ones. Possible values are 'all' or 'selected'.", + }, + "permissions": { + Type: schema.TypeMap, + Computed: true, + Elem: &schema.Schema{Type: schema.TypeString}, + Description: "The permissions granted to the GitHub App installation.", + }, + "events": { + Type: schema.TypeList, + Computed: true, + Elem: &schema.Schema{Type: schema.TypeString}, + Description: "The list of events the GitHub App installation subscribes to.", + }, + "client_id": { + Type: schema.TypeString, + Computed: true, + Description: "The OAuth client ID of the GitHub App.", + }, + "target_id": { + Type: schema.TypeInt, + Computed: true, + Description: "The ID of the account the GitHub App is installed on.", + }, + "target_type": { + Type: schema.TypeString, + Computed: true, + Description: "The type of account the GitHub App is installed on. Possible values are 'Organization' or 'User'.", + }, + "suspended": { + Type: schema.TypeBool, + Computed: true, + Description: "Whether the GitHub App installation is currently suspended.", + }, + "single_file_paths": { + Type: schema.TypeList, + Computed: true, + Elem: &schema.Schema{Type: schema.TypeString}, + Description: "The list of single file paths the GitHub App installation has access to.", + }, + "created_at": { + Type: schema.TypeString, + Computed: true, + Description: "The date the GitHub App installation was created.", + }, + "updated_at": { + Type: schema.TypeString, + Computed: true, + Description: "The date the GitHub App installation was last updated.", + }, + }, + }, + }, + }, + } +} + +func dataSourceGithubOrganizationAppInstallationsRead(ctx context.Context, d *schema.ResourceData, m any) diag.Diagnostics { + meta := m.(*Owner) + owner := meta.name + client := meta.v3client + + options := &github.ListOptions{ + PerPage: maxPerPage, + } + + results := make([]map[string]any, 0) + for { + appInstallations, resp, err := client.Organizations.ListInstallations(ctx, owner, options) + if err != nil { + return diag.FromErr(err) + } + + results = append(results, flattenGitHubAppInstallations(appInstallations.Installations)...) + if resp.NextPage == 0 { + break + } + + options.Page = resp.NextPage + } + + d.SetId(owner) + if err := d.Set("installations", results); err != nil { + return diag.FromErr(err) + } + + return nil +} + +func flattenGitHubAppInstallations(orgAppInstallations []*github.Installation) []map[string]any { + results := make([]map[string]any, 0) + + if orgAppInstallations == nil { + return results + } + + for _, appInstallation := range orgAppInstallations { + result := make(map[string]any) + + result["id"] = appInstallation.GetID() + result["app_slug"] = appInstallation.GetAppSlug() + result["app_id"] = appInstallation.GetAppID() + result["repository_selection"] = appInstallation.GetRepositorySelection() + result["client_id"] = appInstallation.GetClientID() + result["target_id"] = appInstallation.GetTargetID() + result["target_type"] = appInstallation.GetTargetType() + result["suspended"] = !appInstallation.GetSuspendedAt().IsZero() + if appInstallation.Events != nil { + result["events"] = appInstallation.Events + } else { + result["events"] = []string{} + } + + result["permissions"] = flattenInstallationPermissions(appInstallation.Permissions) + + if appInstallation.SingleFilePaths != nil { + result["single_file_paths"] = appInstallation.SingleFilePaths + } else { + result["single_file_paths"] = []string{} + } + + result["created_at"] = appInstallation.GetCreatedAt().Format("2006-01-02T15:04:05Z") + result["updated_at"] = appInstallation.GetUpdatedAt().Format("2006-01-02T15:04:05Z") + + results = append(results, result) + } + + return results +} + +func flattenInstallationPermissions(perms *github.InstallationPermissions) map[string]string { + permissions := make(map[string]string) + if perms == nil { + return permissions + } + + if v := perms.GetActions(); v != "" { + permissions["actions"] = v + } + if v := perms.GetAdministration(); v != "" { + permissions["administration"] = v + } + if v := perms.GetChecks(); v != "" { + permissions["checks"] = v + } + if v := perms.GetContents(); v != "" { + permissions["contents"] = v + } + if v := perms.GetDeployments(); v != "" { + permissions["deployments"] = v + } + if v := perms.GetEnvironments(); v != "" { + permissions["environments"] = v + } + if v := perms.GetIssues(); v != "" { + permissions["issues"] = v + } + if v := perms.GetMetadata(); v != "" { + permissions["metadata"] = v + } + if v := perms.GetMembers(); v != "" { + permissions["members"] = v + } + if v := perms.GetOrganizationAdministration(); v != "" { + permissions["organization_administration"] = v + } + if v := perms.GetOrganizationHooks(); v != "" { + permissions["organization_hooks"] = v + } + if v := perms.GetOrganizationPlan(); v != "" { + permissions["organization_plan"] = v + } + if v := perms.GetOrganizationProjects(); v != "" { + permissions["organization_projects"] = v + } + if v := perms.GetOrganizationSecrets(); v != "" { + permissions["organization_secrets"] = v + } + if v := perms.GetOrganizationSelfHostedRunners(); v != "" { + permissions["organization_self_hosted_runners"] = v + } + if v := perms.GetOrganizationUserBlocking(); v != "" { + permissions["organization_user_blocking"] = v + } + if v := perms.GetPackages(); v != "" { + permissions["packages"] = v + } + if v := perms.GetPages(); v != "" { + permissions["pages"] = v + } + if v := perms.GetPullRequests(); v != "" { + permissions["pull_requests"] = v + } + if v := perms.GetRepositoryHooks(); v != "" { + permissions["repository_hooks"] = v + } + if v := perms.GetRepositoryProjects(); v != "" { + permissions["repository_projects"] = v + } + if v := perms.GetRepositoryPreReceiveHooks(); v != "" { + permissions["repository_pre_receive_hooks"] = v + } + if v := perms.GetSecrets(); v != "" { + permissions["secrets"] = v + } + if v := perms.GetSecretScanningAlerts(); v != "" { + permissions["secret_scanning_alerts"] = v + } + if v := perms.GetSecurityEvents(); v != "" { + permissions["security_events"] = v + } + if v := perms.GetSingleFile(); v != "" { + permissions["single_file"] = v + } + if v := perms.GetStatuses(); v != "" { + permissions["statuses"] = v + } + if v := perms.GetTeamDiscussions(); v != "" { + permissions["team_discussions"] = v + } + if v := perms.GetVulnerabilityAlerts(); v != "" { + permissions["vulnerability_alerts"] = v + } + if v := perms.GetWorkflows(); v != "" { + permissions["workflows"] = v + } + + return permissions +} diff --git a/github/data_source_github_organization_app_installations_test.go b/github/data_source_github_organization_app_installations_test.go new file mode 100644 index 0000000000..51f0be64fa --- /dev/null +++ b/github/data_source_github_organization_app_installations_test.go @@ -0,0 +1,31 @@ +package github + +import ( + "testing" + + "github.com/hashicorp/terraform-plugin-testing/helper/resource" +) + +func TestAccGithubOrganizationAppInstallations(t *testing.T) { + t.Run("basic", func(t *testing.T) { + config := `data "github_organization_app_installations" "test" {}` + + resource.Test(t, resource.TestCase{ + PreCheck: func() { + skipUnlessHasOrgs(t) + skipUnlessHasAppInstallations(t) + }, + ProviderFactories: providerFactories, + Steps: []resource.TestStep{ + { + Config: config, + Check: resource.ComposeAggregateTestCheckFunc( + resource.TestCheckResourceAttrSet("data.github_organization_app_installations.test", "installations.0.id"), + resource.TestCheckResourceAttrSet("data.github_organization_app_installations.test", "installations.0.app_slug"), + resource.TestCheckResourceAttrSet("data.github_organization_app_installations.test", "installations.0.app_id"), + ), + }, + }, + }) + }) +} diff --git a/github/provider.go b/github/provider.go index 2edcca6079..2d18019542 100644 --- a/github/provider.go +++ b/github/provider.go @@ -268,6 +268,7 @@ func Provider() *schema.Provider { "github_organization_team_sync_groups": dataSourceGithubOrganizationTeamSyncGroups(), "github_organization_teams": dataSourceGithubOrganizationTeams(), "github_organization_webhooks": dataSourceGithubOrganizationWebhooks(), + "github_organization_app_installations": dataSourceGithubOrganizationAppInstallations(), "github_ref": dataSourceGithubRef(), "github_release": dataSourceGithubRelease(), "github_release_asset": dataSourceGithubReleaseAsset(), diff --git a/website/docs/d/organization_app_installations.html.markdown b/website/docs/d/organization_app_installations.html.markdown new file mode 100644 index 0000000000..4f2ec8957c --- /dev/null +++ b/website/docs/d/organization_app_installations.html.markdown @@ -0,0 +1,40 @@ +--- +layout: "github" +page_title: "GitHub: github_organization_app_installations" +description: |- + Get information on all GitHub App installations of the organization. +--- + +# github\_organization\_app_installations + +Use this data source to retrieve all GitHub App installations of the organization. + +## Example Usage + +To retrieve *all* GitHub App installations of the organization: + +```hcl +data "github_organization_app_installations" "all" {} +``` + +## Attributes Reference + +* `installations` - List of GitHub App installations in the organization. Each `installation` block consists of the fields documented below. + +--- + +The `installation` block consists of: + + * `id` - The ID of the GitHub App installation. + * `app_slug` - The URL-friendly name of the GitHub App. + * `app_id` - The ID of the GitHub App. + * `repository_selection` - Whether the installation has access to all repositories or only selected ones. Possible values are `all` or `selected`. + * `permissions` - A map of the permissions granted to the GitHub App installation. + * `events` - The list of events the GitHub App installation subscribes to. + * `client_id` - The OAuth client ID of the GitHub App. + * `target_id` - The ID of the account the GitHub App is installed on. + * `target_type` - The type of account the GitHub App is installed on. Possible values are `Organization` or `User`. + * `suspended` - Whether the GitHub App installation is currently suspended. + * `single_file_paths` - The list of single file paths the GitHub App installation has access to. + * `created_at` - The date the GitHub App installation was created. + * `updated_at` - The date the GitHub App installation was last updated.