refactor: Use testJSONBody helper for request body assertions in tests

[Not-Dhananjay-Mishra]

An alternate implementation of #4170 that uses a generic testJSONBody helper.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.69%. Comparing base (a75818a) to head (adefbee).
⚠️ Report is 2 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #4183   +/-   ##
=======================================
  Coverage   93.69%   93.69%           
=======================================
  Files         210      210           
  Lines       19763    19763           
=======================================
  Hits        18517    18517           
  Misses       1049     1049           
  Partials      197      197           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[Not-Dhananjay-Mishra]

This approach works well when a struct is passed directly to a method then to API without any modifications. However, if a method modifies the struct internally, a separate want struct would need to be created inside the test for comparison otherwise we have to use testBody (string).

[gmlewis]

Thank you, @Not-Dhananjay-Mishra!

Overall, I really prefer the outcome of this PR over #4170.

I see that both PRs were a great deal of work (thank you both for your time and effort to clean up all the cases so that we can thoroughly investigate this!) and the final state of this one looks much cleaner to me and in my opinion seems to create a better developer experience overall.

LGTM.

Thoughts, @alexandear ?

[alexandear]

Looks good to me.

Thank you for the tremendous amount of work.

I've left a few minor comments.

[alexandear]

Please also update these testBody:

❯ rg testBody
github/copilot_test.go
909:            testBody(t, r, `{"selected_teams":["team1","team2"]}`+"\n")
947:            testBody(t, r, `{"selected_teams":["team1","team2"]}`+"\n")
985:            testBody(t, r, `{"selected_usernames":["user1","user2"]}`+"\n")
1023:           testBody(t, r, `{"selected_usernames":["user1","user2"]}`+"\n")

github/repos_releases_test.go
740:                    testBody(t, r, "Upload me !\n")
945:            testBody(t, r, "Upload me !\n")
1066:           testBody(t, r, "Upload me !\n")

github/github_test.go
192:func testBody(t *testing.T, r *http.Request, want string) {

github/pulls_test.go
489:                    testBody(t, r, tt.wantUpdate+"\n")
807:                    testBody(t, r, test.wantBody+"\n")
826:            testBody(t, r, expectedBody+"\n")

github/repos_test.go
2939:                           testBody(t, r, `{"dismissal_restrictions":{}}`+"\n")
3496:           testBody(t, r, `{"names":[]}`+"\n")
3519:           testBody(t, r, `{"names":[]}`+"\n")

github/activity_notifications_test.go
102:            testBody(t, r, `{"last_read_at":"2006-01-02T15:04:05Z"}`+"\n")
126:            testBody(t, r, `{}`+"\n")
145:            testBody(t, r, `{"last_read_at":"2006-01-02T15:04:05Z"}`+"\n")
174:            testBody(t, r, `{}`+"\n")

github/authorizations_test.go
22:             testBody(t, r, `{"access_token":"a"}`+"\n")
59:             testBody(t, r, `{"access_token":"a"}`+"\n")
96:             testBody(t, r, `{"access_token":"a"}`+"\n")
124:            testBody(t, r, `{"access_token":"a"}`+"\n")

github/codespaces_orgs_test.go
93:             testBody(t, r, `{"selected_usernames":["u1"]}`+"\n")
123:            testBody(t, r, `{"selected_usernames":["u1"]}`+"\n")

github/dependabot_secrets_test.go
176:            testBody(t, r, `{"key_id":"1234","encrypted_value":"QIv="}`+"\n")
358:            testBody(t, r, `{"key_id":"1234","encrypted_value":"QIv=","visibility":"selected","selected_repository_ids":["1296269","1269280"]}`+"\n")
438:            testBody(t, r, `{"selected_repository_ids":[64780797]}`+"\n")

Only testBody from github/repos_releases_test.go should be untouched. I think we can rename it to testPlainBody.

[Not-Dhananjay-Mishra]

Thanks @alexandear, for detailed review!
Changed testBody to testPlainBody and updated the remaining tests.

[gmlewis]

Thank you, @Not-Dhananjay-Mishra and @alexandear!
LGTM.
Merging.