Skip to content

[MAINT] Improve provider tests #3061

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.

Sign up for GitHub

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

Merged
nickfloyd merged 9 commits into from
Jan 9, 2026
Merged

[MAINT] Improve provider tests #3061

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
c2f5793
Ensure that `token` is never configured together with `app_auth`
deiga Jan 1, 2026
5c5494f
Add test to verify that `GITHUB_TOKEN` and `app_auth` are not set at …
deiga Jan 1, 2026
0d2f2c2
Ensure `max_per_page` test actually runs
deiga Jan 1, 2026
7fac1a6
Ensure `max_retries` is actually tested
deiga Jan 1, 2026
1cc898d
Fix indentation
deiga Jan 1, 2026
a4d10fd
Use `ExactlyOneOf` instead of `ConflictsWith`
deiga Jan 1, 2026
d5d8d6e
Add some more infor logging
deiga Jan 2, 2026
b45ac72
Fix brackets
deiga Jan 2, 2026
0ecb31a
Update Org test to ensure it actually tests
deiga Jan 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 11 additions & 8 deletions github/provider.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,11 @@ func Provider() *schema.Provider {
p := &schema.Provider{
Schema: map[string]*schema.Schema{
"token": {
Type: schema.TypeString,
Optional: true,
DefaultFunc: schema.EnvDefaultFunc("GITHUB_TOKEN", nil),
Description: descriptions["token"],
Type: schema.TypeString,
Optional: true,
DefaultFunc: schema.EnvDefaultFunc("GITHUB_TOKEN", nil),
Description: descriptions["token"],
ExactlyOneOf: []string{"app_auth"},
},
"owner": {
Type: schema.TypeString,
Expand Down Expand Up @@ -93,10 +94,11 @@ func Provider() *schema.Provider {
Description: descriptions["parallel_requests"],
},
"app_auth": {
Type: schema.TypeList,
Optional: true,
MaxItems: 1,
Description: descriptions["app_auth"],
Type: schema.TypeList,
Optional: true,
MaxItems: 1,
Description: descriptions["app_auth"],
ExactlyOneOf: []string{"token"},
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"id": {
Expand Down Expand Up @@ -414,6 +416,7 @@ func providerConfigure(p *schema.Provider) schema.ConfigureContextFunc {
}

if token == "" {
log.Printf("[INFO] No token found, using GitHub CLI to get token from hostname %s", baseURL.Host)
token = tokenFromGHCLI(baseURL)
}

Expand Down
116 changes: 90 additions & 26 deletions github/provider_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package github

import (
"fmt"
"regexp"
"testing"

"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
Expand Down Expand Up @@ -53,7 +54,7 @@ func TestAccProviderConfigure(t *testing.T) {
t.Run("can be configured to run anonymously", func(t *testing.T) {
config := `
provider "github" {
token = ""
token = ""
}
data "github_ip_ranges" "test" {}
`
Expand All @@ -77,7 +78,7 @@ func TestAccProviderConfigure(t *testing.T) {
insecure = true
}
data "github_ip_ranges" "test" {}
`
`

resource.Test(t, resource.TestCase{
ProviderFactories: providerFactories,
Expand Down Expand Up @@ -116,39 +117,42 @@ func TestAccProviderConfigure(t *testing.T) {
config := fmt.Sprintf(`
provider "github" {
token = "%s"
owner = "%s"
}`, testAccConf.token, testAccConf.owner)
owner = "%[2]s"
}

data "github_organization" "test" {
name = "%[2]s"
}
`, testAccConf.token, testAccConf.owner)

resource.Test(t, resource.TestCase{
PreCheck: func() { skipUnlessHasOrgs(t) },
ProviderFactories: providerFactories,
Steps: []resource.TestStep{
{
Config: config,
PlanOnly: true,
ExpectNonEmptyPlan: false,
Config: config,
},
},
})
})

t.Run("can be configured with an organization account legacy", func(t *testing.T) {
config := fmt.Sprintf(`
t.Run("can be configured with an organization account legacy", func(t *testing.T) {
config := fmt.Sprintf(`
provider "github" {
token = "%s"
organization = "%s"
}`, testAccConf.token, testAccConf.owner)

resource.Test(t, resource.TestCase{
PreCheck: func() { skipUnlessHasOrgs(t) },
ProviderFactories: providerFactories,
Steps: []resource.TestStep{
{
Config: config,
PlanOnly: true,
ExpectNonEmptyPlan: false,
},
resource.Test(t, resource.TestCase{
PreCheck: func() { skipUnlessHasOrgs(t) },
ProviderFactories: providerFactories,
Steps: []resource.TestStep{
{
Config: config,
PlanOnly: true,
ExpectNonEmptyPlan: false,
},
})
},
})
})

Expand All @@ -172,11 +176,15 @@ func TestAccProviderConfigure(t *testing.T) {
})

t.Run("can be configured with max retries", func(t *testing.T) {
testMaxRetries := -1
config := fmt.Sprintf(`
provider "github" {
owner = "%s"
max_retries = 3
}`, testAccConf.owner)
max_retries = %d
}

data "github_ip_ranges" "test" {}
`, testAccConf.owner, testMaxRetries)

resource.Test(t, resource.TestCase{
PreCheck: func() { skipUnauthenticated(t) },
Expand All @@ -185,17 +193,22 @@ func TestAccProviderConfigure(t *testing.T) {
{
Config: config,
ExpectNonEmptyPlan: false,
ExpectError: regexp.MustCompile("max_retries must be greater than or equal to 0"),
},
},
})
})

t.Run("can be configured with max per page", func(t *testing.T) {
config := `
testMaxPerPage := 101
config := fmt.Sprintf(`
provider "github" {
owner = "%s"
max_per_page = 100
}`
max_per_page = %d
}

data "github_ip_ranges" "test" {}
`, testAccConf.owner, testMaxPerPage)

resource.Test(t, resource.TestCase{
PreCheck: func() { skipUnauthenticated(t) },
Expand All @@ -205,13 +218,64 @@ func TestAccProviderConfigure(t *testing.T) {
Config: config,
ExpectNonEmptyPlan: false,
Check: func(_ *terraform.State) error {
if maxPerPage != 100 {
return fmt.Errorf("max_per_page should be set to 100, got %d", maxPerPage)
if maxPerPage != testMaxPerPage {
return fmt.Errorf("max_per_page should be set to %d, got %d", testMaxPerPage, maxPerPage)
}
return nil
},
},
},
})
})
t.Run("should not allow both token and app_auth to be configured", func(t *testing.T) {
config := fmt.Sprintf(`
provider "github" {
owner = "%s"
token = "%s"
app_auth {
id = "1234567890"
installation_id = "1234567890"
pem_file = "1234567890"
}
}

data "github_ip_ranges" "test" {}
`, testAccConf.owner, testAccConf.token)

resource.Test(t, resource.TestCase{
PreCheck: func() { skipUnauthenticated(t) },
ProviderFactories: providerFactories,
Steps: []resource.TestStep{
{
Config: config,
ExpectError: regexp.MustCompile("only one of `app_auth,token` can be specified"),
},
},
})
})
t.Run("should not allow app_auth and GITHUB_TOKEN to be configured", func(t *testing.T) {
config := fmt.Sprintf(`
provider "github" {
owner = "%s"
app_auth {
id = "1234567890"
installation_id = "1234567890"
pem_file = "1234567890"
}
}

data "github_ip_ranges" "test" {}
`, testAccConf.owner)

resource.Test(t, resource.TestCase{
PreCheck: func() { skipUnauthenticated(t); t.Setenv("GITHUB_TOKEN", "1234567890") },
ProviderFactories: providerFactories,
Steps: []resource.TestStep{
{
Config: config,
ExpectError: regexp.MustCompile("only one of `app_auth,token` can be specified"),
},
},
})
})
}