Skip to content

test: add coverage for bypass_modes in rulesets #2802

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
merged 2 commits into from
Oct 22, 2025
Merged

test: add coverage for bypass_modes in rulesets #2802

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
373826b
test: add coverage for bypass_modes in rulesets
oikarinen Oct 22, 2025
379f167
Merge branch 'main' into ruleset-bypass-tests
nickfloyd Oct 22, 2025
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
229 changes: 213 additions & 16 deletions github/resource_github_organization_ruleset_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -303,6 +303,23 @@ func TestGithubOrganizationRulesets(t *testing.T) {
target = "branch"
enforcement = "active"

bypass_actors {
actor_type = "DeployKey"
bypass_mode = "always"
}

bypass_actors {
actor_id = 5
actor_type = "RepositoryRole"
bypass_mode = "always"
}

bypass_actors {
actor_id = 1
actor_type = "OrganizationAdmin"
bypass_mode = "always"
}

conditions {
ref_name {
include = ["~ALL"]
Expand All @@ -323,39 +340,147 @@ func TestGithubOrganizationRulesets(t *testing.T) {
dismiss_stale_reviews_on_push = true
require_last_push_approval = true
}
}
}
`, randomID)

bypass_actors {
actor_type = "DeployKey"
bypass_mode = "always"
}
check := resource.ComposeTestCheckFunc(
resource.TestCheckResourceAttr(
"github_organization_ruleset.test", "bypass_actors.#",
"3",
),
resource.TestCheckResourceAttr(
"github_organization_ruleset.test", "bypass_actors.0.actor_type",
"DeployKey",
),
resource.TestCheckResourceAttr(
"github_organization_ruleset.test", "bypass_actors.0.bypass_mode",
"always",
),
resource.TestCheckResourceAttr(
"github_organization_ruleset.test", "bypass_actors.1.actor_id",
"5",
),
resource.TestCheckResourceAttr(
"github_organization_ruleset.test", "bypass_actors.1.actor_type",
"RepositoryRole",
),
resource.TestCheckResourceAttr(
"github_organization_ruleset.test", "bypass_actors.1.bypass_mode",
"always",
),
resource.TestCheckResourceAttr(
"github_organization_ruleset.test", "bypass_actors.2.actor_id",
"1",
),
resource.TestCheckResourceAttr(
"github_organization_ruleset.test", "bypass_actors.2.actor_type",
"OrganizationAdmin",
),
resource.TestCheckResourceAttr(
"github_organization_ruleset.test", "bypass_actors.2.bypass_mode",
"always",
),
)

bypass_actors {
actor_id = 5
actor_type = "RepositoryRole"
bypass_mode = "always"
}
testCase := func(t *testing.T, mode string) {
resource.Test(t, resource.TestCase{
PreCheck: func() { skipUnlessMode(t, mode) },
Providers: testAccProviders,
Steps: []resource.TestStep{
{
Config: config,
Check: check,
},
},
})
}

t.Run("with an enterprise account", func(t *testing.T) {
testCase(t, enterprise)
})

})

t.Run("Creates organization ruleset with all bypass_modes", func(t *testing.T) {

bypass_actors {
actor_id = 0
actor_type = "OrganizationAdmin"
bypass_mode = "always"
config := fmt.Sprintf(`
resource "github_organization_ruleset" "test" {
name = "test-bypass-modes-%s"
target = "branch"
enforcement = "active"

bypass_actors {
actor_id = 1
actor_type = "OrganizationAdmin"
bypass_mode = "always"
}

bypass_actors {
actor_id = 5
actor_type = "RepositoryRole"
bypass_mode = "pull_request"
}

bypass_actors {
actor_id = 2
actor_type = "RepositoryRole"
bypass_mode = "exempt"
}

conditions {
ref_name {
include = ["~ALL"]
exclude = []
}
}

rules {
creation = true
}
}
`, randomID)

check := resource.ComposeTestCheckFunc(
resource.TestCheckResourceAttr(
"github_organization_ruleset.test", "bypass_actors.#",
"3",
),
resource.TestCheckResourceAttr(
"github_organization_ruleset.test", "bypass_actors.0.actor_id",
"1",
),
resource.TestCheckResourceAttr(
"github_organization_ruleset.test", "bypass_actors.0.actor_type",
"0",
"OrganizationAdmin",
),
resource.TestCheckResourceAttr(
"github_organization_ruleset.test", "bypass_actors.1.actor_type",
"github_organization_ruleset.test", "bypass_actors.0.bypass_mode",
"always",
),
resource.TestCheckResourceAttr(
"github_organization_ruleset.test", "bypass_actors.1.actor_id",
"5",
),
resource.TestCheckResourceAttr(
"github_organization_ruleset.test", "bypass_actors.1.actor_type",
"RepositoryRole",
),
resource.TestCheckResourceAttr(
"github_organization_ruleset.test", "bypass_actors.1.bypass_mode",
"pull_request",
),
resource.TestCheckResourceAttr(
"github_organization_ruleset.test", "bypass_actors.2.actor_id",
"2",
),
resource.TestCheckResourceAttr(
"github_organization_ruleset.test", "bypass_actors.2.actor_type",
"0",
"RepositoryRole",
),
resource.TestCheckResourceAttr(
"github_organization_ruleset.test", "bypass_actors.2.bypass_mode",
"exempt",
),
)

Expand All @@ -378,4 +503,76 @@ func TestGithubOrganizationRulesets(t *testing.T) {

})

t.Run("Updates organization ruleset bypass_mode without error", func(t *testing.T) {

config := fmt.Sprintf(`
resource "github_organization_ruleset" "test" {
name = "test-bypass-update-%s"
target = "branch"
enforcement = "active"

bypass_actors {
actor_id = 1
actor_type = "OrganizationAdmin"
bypass_mode = "always"
}

conditions {
ref_name {
include = ["~ALL"]
exclude = []
}
}

rules {
creation = true
}
}
`, randomID)

configUpdated := strings.Replace(
config,
`bypass_mode = "always"`,
`bypass_mode = "exempt"`,
1,
)

checks := map[string]resource.TestCheckFunc{
"before": resource.ComposeTestCheckFunc(
resource.TestCheckResourceAttr(
"github_organization_ruleset.test", "bypass_actors.0.bypass_mode",
"always",
),
),
"after": resource.ComposeTestCheckFunc(
resource.TestCheckResourceAttr(
"github_organization_ruleset.test", "bypass_actors.0.bypass_mode",
"exempt",
),
),
}

testCase := func(t *testing.T, mode string) {
resource.Test(t, resource.TestCase{
PreCheck: func() { skipUnlessMode(t, mode) },
Providers: testAccProviders,
Steps: []resource.TestStep{
{
Config: config,
Check: checks["before"],
},
{
Config: configUpdated,
Check: checks["after"],
},
},
})
}

t.Run("with an enterprise account", func(t *testing.T) {
testCase(t, enterprise)
})

})

}
Loading
Loading