Skip to content

refactor: Use testJSONBody helper for request body assertions in tests #4183

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
gmlewis merged 4 commits into from
May 1, 2026
Merged

refactor: Use testJSONBody helper for request body assertions in tests #4183

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ae42331
add testJSONBody
Not-Dhananjay-Mishra Apr 29, 2026
f61bfa0
use testJSONBody
Not-Dhananjay-Mishra Apr 30, 2026
01f4c41
feedback
Not-Dhananjay-Mishra May 1, 2026
adefbee
fix
Not-Dhananjay-Mishra May 1, 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
29 changes: 16 additions & 13 deletions github/actions_oidc_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,16 +87,17 @@ func TestActionsService_SetOrgOIDCSubjectClaimCustomTemplate(t *testing.T) {
t.Parallel()
client, mux, _ := setup(t)

input := &OIDCSubjectClaimCustomTemplate{
IncludeClaimKeys: []string{"repo", "context"},
}

mux.HandleFunc("/orgs/o/actions/oidc/customization/sub", func(w http.ResponseWriter, r *http.Request) {
testMethod(t, r, "PUT")
testHeader(t, r, "Content-Type", "application/json")
testBody(t, r, `{"include_claim_keys":["repo","context"]}`+"\n")
testJSONBody(t, r, input)
w.WriteHeader(http.StatusCreated)
})

input := &OIDCSubjectClaimCustomTemplate{
IncludeClaimKeys: []string{"repo", "context"},
}
ctx := t.Context()
_, err := client.Actions.SetOrgOIDCSubjectClaimCustomTemplate(ctx, "o", input)
if err != nil {
Expand All @@ -119,17 +120,18 @@ func TestActionsService_SetRepoOIDCSubjectClaimCustomTemplate(t *testing.T) {
t.Parallel()
client, mux, _ := setup(t)

input := &OIDCSubjectClaimCustomTemplate{
UseDefault: Ptr(false),
IncludeClaimKeys: []string{"repo", "context"},
}

mux.HandleFunc("/repos/o/r/actions/oidc/customization/sub", func(w http.ResponseWriter, r *http.Request) {
testMethod(t, r, "PUT")
testHeader(t, r, "Content-Type", "application/json")
testBody(t, r, `{"use_default":false,"include_claim_keys":["repo","context"]}`+"\n")
testJSONBody(t, r, input)
w.WriteHeader(http.StatusCreated)
})

input := &OIDCSubjectClaimCustomTemplate{
UseDefault: Ptr(false),
IncludeClaimKeys: []string{"repo", "context"},
}
ctx := t.Context()
_, err := client.Actions.SetRepoOIDCSubjectClaimCustomTemplate(ctx, "o", "r", input)
if err != nil {
Expand All @@ -152,16 +154,17 @@ func TestActionService_SetRepoOIDCSubjectClaimCustomTemplateToDefault(t *testing
t.Parallel()
client, mux, _ := setup(t)

input := &OIDCSubjectClaimCustomTemplate{
UseDefault: Ptr(true),
}

mux.HandleFunc("/repos/o/r/actions/oidc/customization/sub", func(w http.ResponseWriter, r *http.Request) {
testMethod(t, r, "PUT")
testHeader(t, r, "Content-Type", "application/json")
testBody(t, r, `{"use_default":true}`+"\n")
testJSONBody(t, r, input)
w.WriteHeader(http.StatusCreated)
})

input := &OIDCSubjectClaimCustomTemplate{
UseDefault: Ptr(true),
}
ctx := t.Context()
_, err := client.Actions.SetRepoOIDCSubjectClaimCustomTemplate(ctx, "o", "r", input)
if err != nil {
Expand Down
67 changes: 17 additions & 50 deletions github/actions_permissions_enterprise_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
package github

import (
"encoding/json"
"fmt"
"net/http"
"testing"
Expand Down Expand Up @@ -55,14 +54,8 @@ func TestActionsService_UpdateActionsPermissionsInEnterprise(t *testing.T) {
input := &ActionsPermissionsEnterprise{EnabledOrganizations: Ptr("all"), AllowedActions: Ptr("selected")}

mux.HandleFunc("/enterprises/e/actions/permissions", func(w http.ResponseWriter, r *http.Request) {
var v *ActionsPermissionsEnterprise
assertNilError(t, json.NewDecoder(r.Body).Decode(&v))

testMethod(t, r, "PUT")
if !cmp.Equal(v, input) {
t.Errorf("Request body = %+v, want %+v", v, input)
}

testJSONBody(t, r, input)
fmt.Fprint(w, `{"enabled_organizations": "all", "allowed_actions": "selected"}`)
})

Expand Down Expand Up @@ -140,28 +133,34 @@ func TestActionsService_SetEnabledOrgsInEnterprise(t *testing.T) {
t.Parallel()
client, mux, _ := setup(t)

input := []int64{123, 1234}

mux.HandleFunc("/enterprises/e/actions/permissions/organizations", func(w http.ResponseWriter, r *http.Request) {
testMethod(t, r, "PUT")
testHeader(t, r, "Content-Type", "application/json")
testBody(t, r, `{"selected_organization_ids":[123,1234]}`+"\n")
testJSONBody(t, r, struct {
IDs []int64 `json:"selected_organization_ids"`
}{
IDs: input,
})
w.WriteHeader(http.StatusNoContent)
})

ctx := t.Context()
_, err := client.Actions.SetEnabledOrgsInEnterprise(ctx, "e", []int64{123, 1234})
_, err := client.Actions.SetEnabledOrgsInEnterprise(ctx, "e", input)
if err != nil {
t.Errorf("Actions.SetEnabledOrgsInEnterprise returned error: %v", err)
}

const methodName = "SetEnabledOrgsInEnterprise"

testBadOptions(t, methodName, func() (err error) {
_, err = client.Actions.SetEnabledOrgsInEnterprise(ctx, "\n", []int64{123, 1234})
_, err = client.Actions.SetEnabledOrgsInEnterprise(ctx, "\n", input)
return err
})

testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) {
return client.Actions.SetEnabledOrgsInEnterprise(ctx, "e", []int64{123, 1234})
return client.Actions.SetEnabledOrgsInEnterprise(ctx, "e", input)
})
}

Expand Down Expand Up @@ -260,14 +259,8 @@ func TestActionsService_UpdateActionsAllowedInEnterprise(t *testing.T) {
input := &ActionsAllowed{GithubOwnedAllowed: Ptr(true), VerifiedAllowed: Ptr(false), PatternsAllowed: []string{"a/b"}}

mux.HandleFunc("/enterprises/e/actions/permissions/selected-actions", func(w http.ResponseWriter, r *http.Request) {
var v *ActionsAllowed
assertNilError(t, json.NewDecoder(r.Body).Decode(&v))

testMethod(t, r, "PUT")
if !cmp.Equal(v, input) {
t.Errorf("Request body = %+v, want %+v", v, input)
}

testJSONBody(t, r, input)
fmt.Fprint(w, `{"github_owned_allowed":true, "verified_allowed":false, "patterns_allowed":["a/b"]}`)
})

Expand Down Expand Up @@ -338,14 +331,8 @@ func TestActionsService_UpdateDefaultWorkflowPermissionsInEnterprise(t *testing.
input := &DefaultWorkflowPermissionEnterprise{DefaultWorkflowPermissions: Ptr("read"), CanApprovePullRequestReviews: Ptr(true)}

mux.HandleFunc("/enterprises/e/actions/permissions/workflow", func(w http.ResponseWriter, r *http.Request) {
var v *DefaultWorkflowPermissionEnterprise
assertNilError(t, json.NewDecoder(r.Body).Decode(&v))

testMethod(t, r, "PUT")
if !cmp.Equal(v, input) {
t.Errorf("Request body = %+v, want %+v", v, input)
}

testJSONBody(t, r, input)
fmt.Fprint(w, `{ "default_workflow_permissions": "read", "can_approve_pull_request_reviews": true }`)
})

Expand Down Expand Up @@ -420,13 +407,8 @@ func TestActionsService_UpdateArtifactAndLogRetentionPeriodInEnterprise(t *testi
input := &ArtifactPeriodOpt{Days: Ptr(90)}

mux.HandleFunc("/enterprises/e/actions/permissions/artifact-and-log-retention", func(w http.ResponseWriter, r *http.Request) {
var v *ArtifactPeriodOpt
assertNilError(t, json.NewDecoder(r.Body).Decode(&v))

testMethod(t, r, "PUT")
if !cmp.Equal(v, input) {
t.Errorf("Request body = %+v, want %+v", v, input)
}
testJSONBody(t, r, input)
w.WriteHeader(http.StatusNoContent)
})

Expand Down Expand Up @@ -492,13 +474,8 @@ func TestActionsService_UpdateSelfHostedRunnerPermissionsInEnterprise(t *testing
input := &SelfHostRunnerPermissionsEnterprise{DisableSelfHostedRunnersForAllOrgs: Ptr(false)}

mux.HandleFunc("/enterprises/e/actions/permissions/self-hosted-runners", func(w http.ResponseWriter, r *http.Request) {
var v *SelfHostRunnerPermissionsEnterprise
assertNilError(t, json.NewDecoder(r.Body).Decode(&v))

testMethod(t, r, "PUT")
if !cmp.Equal(v, input) {
t.Errorf("Request body = %+v, want %+v", v, input)
}
testJSONBody(t, r, input)
w.WriteHeader(http.StatusNoContent)
})

Expand Down Expand Up @@ -573,13 +550,8 @@ func TestActionsService_UpdatePrivateRepoForkPRWorkflowSettingsInEnterprise(t *t
}

mux.HandleFunc("/enterprises/e/actions/permissions/fork-pr-workflows-private-repos", func(w http.ResponseWriter, r *http.Request) {
var v *WorkflowsPermissionsOpt
assertNilError(t, json.NewDecoder(r.Body).Decode(&v))

testMethod(t, r, "PUT")
if !cmp.Equal(v, input) {
t.Errorf("Request body = %+v, want %+v", v, input)
}
testJSONBody(t, r, input)
w.WriteHeader(http.StatusNoContent)
})

Expand Down Expand Up @@ -645,13 +617,8 @@ func TestActionsService_UpdateEnterpriseForkPRContributorApprovalPermissions(t *
input := ContributorApprovalPermissions{ApprovalPolicy: "require_approval"}

mux.HandleFunc("/enterprises/e/actions/permissions/fork-pr-contributor-approval", func(w http.ResponseWriter, r *http.Request) {
var v *ContributorApprovalPermissions
assertNilError(t, json.NewDecoder(r.Body).Decode(&v))

testMethod(t, r, "PUT")
if !cmp.Equal(v, &input) {
t.Errorf("Request body = %+v, want %+v", v, &input)
}
testJSONBody(t, r, input)
w.WriteHeader(http.StatusNoContent)
})

Expand Down
Loading
Loading