[MAINT][FEAT] Fix Org Ruleset tests && enable `allowed_merge_methods` by deiga · Pull Request #2976 · integrations/terraform-provider-github

deiga · 2025-12-07T18:12:45Z

Resolves #2530, #2536, #2717

Before the change?

Running TEST="./github" TESTARGS="-run TestGithubOrganizationRulesets" make testacc would fail due to multiple issues in the test setup

After the change?

Running TEST="./github" TESTARGS="-run TestGithubOrganizationRulesets" make testacc will show all tests as passing
Switch from NewSubsystemLoggingHTTPTransport to NewLoggingHTTPTransport as we don't actually initialize a Subsystem anywhere, which creates spam.
Migrate github/resource_github_organization_ruleset.go and github/resource_github_repository.go to use Context aware CRUD methods
Add rules.pull_requests.allowed_merge_methods handling to github/resource_github_repository_ruleset.go and github/resource_github_organization_ruleset.go

Pull request checklist

~~Schema migrations have been created if needed (example)~~
Tests for the changes have been added (for bug fixes / features)
Docs have been reviewed and added / updated if needed (for bug fixes / features)

Does this introduce a breaking change?

Please see our docs on breaking changes to help!

Yes
No

github-actions · 2025-12-07T18:12:54Z

👋 Hi! Thank you for this contribution! Just to let you know, our GitHub SDK team does a round of issue and PR reviews twice a week, every Monday and Friday! We have a process in place for prioritizing and responding to your input. Because you are a part of this community please feel free to comment, add to, or pick up any issues/PRs that are labeled with Status: Up for grabs. You & others like you are the reason all of this works! So thank you & happy coding! 🚀

stevehipwell · 2025-12-08T10:16:17Z

@deiga would it be possible to hold off on this until we get #2941 merged?

deiga · 2025-12-08T12:11:04Z

@deiga would it be possible to hold off on this until we get #2941 merged?

@stevehipwell Sure! Would you want to rebase that branch on top of go-github-v68, so that I could use it as a base for this PR?

stevehipwell · 2025-12-08T12:32:20Z

@deiga the acceptance tests PR should be compatible with the v6 releases, so the v7 branch would be rebased on it. I'm currently re-running the tests to get it ready to be merged and I'm picking up defects in the currently released code.

stevehipwell

I've added some minor suggestions on structuring the TF test code to make it easier to read and more idiomatic. But my main concern here is the actor ID change.

Also is there a reason you didn't add the other missing ruleset rules? Just curious.

…sport` Updated the logging transport in the RateLimitedHTTPClient function to use NewLoggingHTTPTransport. As the subsystem would need to be explicitly inititated in each resource Signed-off-by: Timo Sand <[email protected]>

Signed-off-by: Timo Sand <[email protected]>

It's a required field in the API and go-github doesn't use `omitempty`, so it submits `nil` if it isn't sent explicitly. This change tries to keep it in the state, without having a configuration option for it (poor choice?) And it defaults to all 3 available merge methods if it can't set something from the state. Signed-off-by: Timo Sand <[email protected]>

This is a required field and the SDK doesn't omit if it's empty Signed-off-by: Timo Sand <[email protected]>

Signed-off-by: Timo Sand <[email protected]>

…on_rulesets_without_errors` to pass Signed-off-by: Timo Sand <[email protected]>

…null` Signed-off-by: Timo Sand <[email protected]>

Signed-off-by: Timo Sand <[email protected]>

…_all_bypass_modes` Main fix: `bypass_actors` is returned as sorted from GH API so tests need re-indexing Signed-off-by: Timo Sand <[email protected]>

Co-authored-by: Steve Hipwell <[email protected]>

Signed-off-by: Timo Sand <[email protected]>

With the recent changes to the SDK and the Create method we less often purely refresh state if it hasn't changed upstream, leading to us ignoring the return value of `actor_id` often Signed-off-by: Timo Sand <[email protected]>

Signed-off-by: Timo Sand <[email protected]>

stevehipwell

This looks great.

LGTM

…integrations#2976) * Switch from `NewSubsystemLoggingHTTPTransport` to `NewLoggingHTTPTransport` Updated the logging transport in the RateLimitedHTTPClient function to use NewLoggingHTTPTransport. As the subsystem would need to be explicitly inititated in each resource Signed-off-by: Timo Sand <[email protected]> * Ensure `update_allows_fetch_and_merge` isn't added for Org Ruleset Signed-off-by: Timo Sand <[email protected]> * Need to have one of `repository_name` or `repository_id` defined Signed-off-by: Timo Sand <[email protected]> * Update indentation Signed-off-by: Timo Sand <[email protected]> * Add handling of `AllowedMergeMethods` It's a required field in the API and go-github doesn't use `omitempty`, so it submits `nil` if it isn't sent explicitly. This change tries to keep it in the state, without having a configuration option for it (poor choice?) And it defaults to all 3 available merge methods if it can't set something from the state. Signed-off-by: Timo Sand <[email protected]> * Add `allowed_merge_methods` to `rules` for Org & Repo rulesets This is a required field and the SDK doesn't omit if it's empty Signed-off-by: Timo Sand <[email protected]> * Fixed type conversion for `allowed_merge_methods` Signed-off-by: Timo Sand <[email protected]> * Update test content to actually pass the GH API Signed-off-by: Timo Sand <[email protected]> * Enable `TestGithubOrganizationRulesets/Creates_and_updates_organization_rulesets_without_errors` to pass Signed-off-by: Timo Sand <[email protected]> * Add workaround for GH API bug that OrgAdmin actor_id is returned as `null` Signed-off-by: Timo Sand <[email protected]> * `make fmt` Signed-off-by: Timo Sand <[email protected]> * Fix `TestGithubOrganizationRulesets/Creates_organization_ruleset_with_all_bypass_modes` Main fix: `bypass_actors` is returned as sorted from GH API so tests need re-indexing Signed-off-by: Timo Sand <[email protected]> * Update github/resource_github_organization_ruleset_test.go Co-authored-by: Steve Hipwell <[email protected]> * Update github/resource_github_organization_ruleset_test.go Co-authored-by: Steve Hipwell <[email protected]> * Update github/resource_github_organization_ruleset_test.go Co-authored-by: Steve Hipwell <[email protected]> * Fix casing of constant Signed-off-by: Timo Sand <[email protected]> * Fix attribute reference Signed-off-by: Timo Sand <[email protected]> * Refactor `Providers` => `ProviderFactories` in org ruleset tests Signed-off-by: Timo Sand <[email protected]> * Remove "normalizing" `actor_id`` With the recent changes to the SDK and the Create method we less often purely refresh state if it hasn't changed upstream, leading to us ignoring the return value of `actor_id` often Signed-off-by: Timo Sand <[email protected]> * Refactor to use `tflog` in `resource_github_organization_ruleset.go` Signed-off-by: Timo Sand <[email protected]> --------- Signed-off-by: Timo Sand <[email protected]> Co-authored-by: Steve Hipwell <[email protected]>

github-actions Bot added the Type: Bug Something isn't working as documented label Dec 7, 2025

deiga changed the title ~~Ensure tests use GITHUB_TEST_* values for Owner and Organization~~ [MAINT] Fix Org Ruleset tests Dec 7, 2025

deiga marked this pull request as ready for review December 7, 2025 18:14

deiga mentioned this pull request Dec 10, 2025

[MAINT] Fix github_organization_ruleset and github_repository_ruleset with push target #2958

Merged

5 tasks

deiga marked this pull request as draft December 10, 2025 14:37

deiga changed the base branch from go-github-v68 to main January 7, 2026 22:14

deiga force-pushed the fix-org-ruleset-tests branch from 3752c16 to d222f43 Compare January 7, 2026 23:19

deiga marked this pull request as ready for review January 7, 2026 23:20

stevehipwell requested changes Jan 8, 2026

View reviewed changes

stevehipwell added this to the v6.10.0 Release milestone Jan 8, 2026

deiga changed the title ~~[MAINT] Fix Org Ruleset tests~~ [MAINT][FEAT] Fix Org Ruleset tests && enable allowed_merge_methods Jan 9, 2026

deiga and others added 15 commits January 9, 2026 20:26

Ensure update_allows_fetch_and_merge isn't added for Org Ruleset

f66df44

Signed-off-by: Timo Sand <[email protected]>

Need to have one of repository_name or repository_id defined

c721d5f

Signed-off-by: Timo Sand <[email protected]>

Update indentation

54bef07

Signed-off-by: Timo Sand <[email protected]>

Add allowed_merge_methods to rules for Org & Repo rulesets

9ad6826

This is a required field and the SDK doesn't omit if it's empty Signed-off-by: Timo Sand <[email protected]>

Fixed type conversion for allowed_merge_methods

be40093

Signed-off-by: Timo Sand <[email protected]>

Update test content to actually pass the GH API

5ab94ed

Signed-off-by: Timo Sand <[email protected]>

Enable `TestGithubOrganizationRulesets/Creates_and_updates_organizati…

d4bd616

…on_rulesets_without_errors` to pass Signed-off-by: Timo Sand <[email protected]>

Add workaround for GH API bug that OrgAdmin actor_id is returned as `…

9b2c813

…null` Signed-off-by: Timo Sand <[email protected]>

make fmt

5a79ef4

Signed-off-by: Timo Sand <[email protected]>

Fix `TestGithubOrganizationRulesets/Creates_organization_ruleset_with…

e106555

…_all_bypass_modes` Main fix: `bypass_actors` is returned as sorted from GH API so tests need re-indexing Signed-off-by: Timo Sand <[email protected]>

Update github/resource_github_organization_ruleset_test.go

358c381

Co-authored-by: Steve Hipwell <[email protected]>

Update github/resource_github_organization_ruleset_test.go

0d5ec83

Co-authored-by: Steve Hipwell <[email protected]>

Update github/resource_github_organization_ruleset_test.go

fac074e

Co-authored-by: Steve Hipwell <[email protected]>

deiga added 5 commits January 9, 2026 20:26

Fix casing of constant

eaab724

Signed-off-by: Timo Sand <[email protected]>

Fix attribute reference

f120242

Signed-off-by: Timo Sand <[email protected]>

Refactor Providers => ProviderFactories in org ruleset tests

efc7a58

Signed-off-by: Timo Sand <[email protected]>

Remove "normalizing" actor_id`

903cd04

With the recent changes to the SDK and the Create method we less often purely refresh state if it hasn't changed upstream, leading to us ignoring the return value of `actor_id` often Signed-off-by: Timo Sand <[email protected]>

Refactor to use tflog in resource_github_organization_ruleset.go

ac1b510

Signed-off-by: Timo Sand <[email protected]>

deiga force-pushed the fix-org-ruleset-tests branch from 62ed5c4 to ac1b510 Compare January 9, 2026 20:11

deiga requested a review from stevehipwell January 9, 2026 20:11

stevehipwell approved these changes Jan 9, 2026

View reviewed changes

nickfloyd merged commit 16c1e02 into integrations:main Jan 9, 2026
8 checks passed

deiga deleted the fix-org-ruleset-tests branch January 10, 2026 06:02

kpocius mentioned this pull request Jan 16, 2026

[BUG]: Breaking change introduced with no documentation in 6.10.0 (allowed_merge_methods) #3082

Closed

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[MAINT][FEAT] Fix Org Ruleset tests && enable `allowed_merge_methods`#2976

[MAINT][FEAT] Fix Org Ruleset tests && enable `allowed_merge_methods`#2976
nickfloyd merged 20 commits intointegrations:mainfrom
F-Secure-web:fix-org-ruleset-tests

deiga commented Dec 7, 2025 •

edited

Loading

Uh oh!

github-actions Bot commented Dec 7, 2025

Uh oh!

stevehipwell commented Dec 8, 2025

Uh oh!

deiga commented Dec 8, 2025

Uh oh!

stevehipwell commented Dec 8, 2025

Uh oh!

stevehipwell left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

stevehipwell left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

deiga commented Dec 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Before the change?

After the change?

Pull request checklist

Does this introduce a breaking change?

Uh oh!

github-actions Bot commented Dec 7, 2025

Uh oh!

stevehipwell commented Dec 8, 2025

Uh oh!

deiga commented Dec 8, 2025

Uh oh!

stevehipwell commented Dec 8, 2025

Uh oh!

stevehipwell left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

stevehipwell left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

deiga commented Dec 7, 2025 •

edited

Loading