fix: go 1.22 test breakage (#3459)

Author: amanv8060

README.md

@@ -22,19 +22,6 @@ go-github will require the N-1 major release of Go by default.
 
 ## Development
 
-Go version 1.22 introduced significant changes to the pattern syntax and matching
-behavior of `http.ServerMux` which causes a large number of legacy unit tests to break.
-(See https://pkg.go.dev/net/http#hdr-Compatibility-ServeMux for more information.)
-As a result, testing of this repo is currently performed by setting this env variable:
-
-```bash
-export GODEBUG=httpmuxgo121=1
-```
-
-An issue has been created (#3409) requesting assistance in updating all breaking legacy unit
-tests when this `GODEBUG` environment variable is not set and Go 1.23.4 or later is
-used to perform unit tests.
-
 If you're interested in using the [GraphQL API v4][], the recommended library is
 [shurcooL/githubv4][].
 

github/orgs_packages_test.go

@@ -118,7 +118,7 @@ func TestOrganizationsService_GetPackage(t *testing.T) {
 	client, mux, _ := setup(t)
 
 	// don't url escape the package name here since mux will convert it to a slash automatically
-	mux.HandleFunc("/orgs/o/packages/container/hello/hello_docker", func(w http.ResponseWriter, r *http.Request) {
+	mux.HandleFunc("/orgs/o/packages/container/hello%2fhello_docker", func(w http.ResponseWriter, r *http.Request) {
 		testMethod(t, r, "GET")
 		_, err := io.WriteString(w, `{
 			"id": 197,
@@ -177,7 +177,7 @@ func TestOrganizationsService_DeletePackage(t *testing.T) {
 	client, mux, _ := setup(t)
 
 	// don't url escape the package name here since mux will convert it to a slash automatically
-	mux.HandleFunc("/orgs/o/packages/container/hello/hello_docker", func(w http.ResponseWriter, r *http.Request) {
+	mux.HandleFunc("/orgs/o/packages/container/hello%2fhello_docker", func(w http.ResponseWriter, r *http.Request) {
 		testMethod(t, r, "DELETE")
 	})
 
@@ -207,7 +207,7 @@ func TestOrganizationsService_RestorePackage(t *testing.T) {
 	client, mux, _ := setup(t)
 
 	// don't url escape the package name here since mux will convert it to a slash automatically
-	mux.HandleFunc("/orgs/o/packages/container/hello/hello_docker/restore", func(w http.ResponseWriter, r *http.Request) {
+	mux.HandleFunc("/orgs/o/packages/container/hello%2Fhello_docker/restore", func(w http.ResponseWriter, r *http.Request) {
 		testMethod(t, r, "POST")
 	})
 
@@ -233,7 +233,7 @@ func TestOrganizationsService_ListPackagesVersions(t *testing.T) {
 	client, mux, _ := setup(t)
 
 	// don't url escape the package name here since mux will convert it to a slash automatically
-	mux.HandleFunc("/orgs/o/packages/container/hello/hello_docker/versions", func(w http.ResponseWriter, r *http.Request) {
+	mux.HandleFunc("/orgs/o/packages/container/hello%2Fhello_docker/versions", func(w http.ResponseWriter, r *http.Request) {
 		testMethod(t, r, "GET")
 		testFormValues(t, r, values{"per_page": "2", "page": "1", "state": "deleted", "visibility": "internal", "package_type": "container"})
 		_, err := io.WriteString(w, `[
@@ -307,7 +307,7 @@ func TestOrganizationsService_PackageGetVersion(t *testing.T) {
 	client, mux, _ := setup(t)
 
 	// don't url escape the package name here since mux will convert it to a slash automatically
-	mux.HandleFunc("/orgs/o/packages/container/hello/hello_docker/versions/45763", func(w http.ResponseWriter, r *http.Request) {
+	mux.HandleFunc("/orgs/o/packages/container/hello%2Fhello_docker/versions/45763", func(w http.ResponseWriter, r *http.Request) {
 		testMethod(t, r, "GET")
 		_, err := io.WriteString(w, `
 			{
@@ -377,7 +377,7 @@ func TestOrganizationsService_PackageDeleteVersion(t *testing.T) {
 	client, mux, _ := setup(t)
 
 	// don't url escape the package name here since mux will convert it to a slash automatically
-	mux.HandleFunc("/orgs/o/packages/container/hello/hello_docker/versions/45763", func(w http.ResponseWriter, r *http.Request) {
+	mux.HandleFunc("/orgs/o/packages/container/hello%2Fhello_docker/versions/45763", func(w http.ResponseWriter, r *http.Request) {
 		testMethod(t, r, "DELETE")
 	})
 
@@ -403,7 +403,7 @@ func TestOrganizationsService_PackageRestoreVersion(t *testing.T) {
 	client, mux, _ := setup(t)
 
 	// don't url escape the package name here since mux will convert it to a slash automatically
-	mux.HandleFunc("/orgs/o/packages/container/hello/hello_docker/versions/45763/restore", func(w http.ResponseWriter, r *http.Request) {
+	mux.HandleFunc("/orgs/o/packages/container/hello%2Fhello_docker/versions/45763/restore", func(w http.ResponseWriter, r *http.Request) {
 		testMethod(t, r, "POST")
 	})
 

github/repos_commits_test.go

@@ -296,7 +296,7 @@ func TestRepositoriesService_NonAlphabetCharacter_GetCommitSHA1(t *testing.T) {
 
 	const sha1 = "01234abcde"
 
-	mux.HandleFunc("/repos/o/r/commits/master%20hash", func(w http.ResponseWriter, r *http.Request) {
+	mux.HandleFunc("/repos/o/r/commits/master%2520hash", func(w http.ResponseWriter, r *http.Request) {
 		testMethod(t, r, "GET")
 		testHeader(t, r, "Accept", mediaTypeV3SHA)
 
@@ -391,10 +391,14 @@ func TestRepositoriesService_CompareCommits(t *testing.T) {
 
 			base := sample.base
 			head := sample.head
+
+			encodedBase := url.PathEscape(base)
+			encodedHead := url.PathEscape(head)
+
 			escapedBase := url.QueryEscape(base)
 			escapedHead := url.QueryEscape(head)
 
-			pattern := fmt.Sprintf("/repos/o/r/compare/%v...%v", base, head)
+			pattern := fmt.Sprintf("/repos/o/r/compare/%v...%v", encodedBase, encodedHead)
 
 			mux.HandleFunc(pattern, func(w http.ResponseWriter, r *http.Request) {
 				testMethod(t, r, "GET")
@@ -529,7 +533,11 @@ func TestRepositoriesService_CompareCommitsRaw_diff(t *testing.T) {
 
 			base := sample.base
 			head := sample.head
-			pattern := fmt.Sprintf("/repos/o/r/compare/%v...%v", base, head)
+
+			encodedBase := url.PathEscape(base)
+			encodedHead := url.PathEscape(head)
+
+			pattern := fmt.Sprintf("/repos/o/r/compare/%v...%v", encodedBase, encodedHead)
 			const rawStr = "@@diff content"
 
 			mux.HandleFunc(pattern, func(w http.ResponseWriter, r *http.Request) {
@@ -584,7 +592,11 @@ func TestRepositoriesService_CompareCommitsRaw_patch(t *testing.T) {
 
 			base := sample.base
 			head := sample.head
-			pattern := fmt.Sprintf("/repos/o/r/compare/%v...%v", base, head)
+
+			encodedBase := url.PathEscape(base)
+			encodedHead := url.PathEscape(head)
+
+			pattern := fmt.Sprintf("/repos/o/r/compare/%v...%v", encodedBase, encodedHead)
 			const rawStr = "@@patch content"
 
 			mux.HandleFunc(pattern, func(w http.ResponseWriter, r *http.Request) {

github/repos_contents_test.go

@@ -472,7 +472,7 @@ func TestRepositoriesService_GetContents_DirectoryWithSpaces(t *testing.T) {
 	t.Parallel()
 	client, mux, _ := setup(t)
 
-	mux.HandleFunc("/repos/o/r/contents/some directory/file.go", func(w http.ResponseWriter, r *http.Request) {
+	mux.HandleFunc("/repos/o/r/contents/some%20directory/file.go", func(w http.ResponseWriter, r *http.Request) {
 		testMethod(t, r, "GET")
 		fmt.Fprint(w, `{}`)
 	})
@@ -502,7 +502,7 @@ func TestRepositoriesService_GetContents_DirectoryWithPlusChars(t *testing.T) {
 	t.Parallel()
 	client, mux, _ := setup(t)
 
-	mux.HandleFunc("/repos/o/r/contents/some directory+name/file.go", func(w http.ResponseWriter, r *http.Request) {
+	mux.HandleFunc("/repos/o/r/contents/some%20directory%2Bname/file.go", func(w http.ResponseWriter, r *http.Request) {
 		testMethod(t, r, "GET")
 		fmt.Fprint(w, `{}`)
 	})