make GetReposContentsByOwnerByRepoByPath path optional

This PR also updates from v69-v71 as a side effect of
re-running mock generation.

This change extends the work done by @szesch based on
the PR commentary in #81

Author: trumant

go.mod

@@ -1,10 +1,12 @@
 module github.com/migueleliasweb/go-github-mock
 
-go 1.23
+go 1.23.0
+
+toolchain go1.24.1
 
 require (
 	github.com/buger/jsonparser v1.1.1
-	github.com/google/go-github/v69 v69.2.0
+	github.com/google/go-github/v71 v71.0.0
 	github.com/gorilla/mux v1.8.0
 	golang.org/x/mod v0.17.0
 	golang.org/x/text v0.19.0

go.sum

@@ -1,10 +1,10 @@
 github.com/buger/jsonparser v1.1.1 h1:2PnMjfWD7wBILjqQbt530v576A/cAbQvEW9gGIpYMUs=
 github.com/buger/jsonparser v1.1.1/go.mod h1:6RYKKt7H4d4+iWqouImQ9R2FZql3VbhNgx27UK13J/0=
 github.com/google/go-cmp v0.5.2/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
-github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
-github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
-github.com/google/go-github/v69 v69.2.0 h1:wR+Wi/fN2zdUx9YxSmYE0ktiX9IAR/BeePzeaUUbEHE=
-github.com/google/go-github/v69 v69.2.0/go.mod h1:xne4jymxLR6Uj9b7J7PyTpkMYstEMMwGZa0Aehh1azM=
+github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=
+github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=
+github.com/google/go-github/v71 v71.0.0 h1:Zi16OymGKZZMm8ZliffVVJ/Q9YZreDKONCr+WUd0Z30=
+github.com/google/go-github/v71 v71.0.0/go.mod h1:URZXObp2BLlMjwu0O8g4y6VBneUj2bCHgnI8FfgZ51M=
 github.com/google/go-querystring v1.1.0 h1:AnCroh3fv4ZBgVIf1Iwtovgjaw/GiKJo8M8yD/fhyJ8=
 github.com/google/go-querystring v1.1.0/go.mod h1:Kcdr2DB4koayq7X8pmAG4sNG59So17icRSOU623lUBU=
 github.com/gorilla/mux v1.8.0 h1:i40aqfkR1h2SlN9hojwV5ZA91wcXFOvkdNIeFDP5koI=

main.go

@@ -11,7 +11,7 @@ import (
 	"strings"
 
 	"github.com/buger/jsonparser"
-	"github.com/google/go-github/v69/github"
+	"github.com/google/go-github/v71/github"
 
 	"github.com/migueleliasweb/go-github-mock/src/gen"
 	"golang.org/x/mod/modfile"
@@ -161,7 +161,7 @@ func updateGoGithubDep() {
 		}
 	}
 
-	// e.g. "v69.2.0" => "v69"
+	// e.g. "v71.0.0" => "v69"
 	latestGoGithubPath := "github.com/google/go-github/" + strings.Split(*releaseInfo.TagName, ".")[0]
 	latestGoGithubVersion := *releaseInfo.TagName
 

src/gen/gen_mutations.go

@@ -6,19 +6,22 @@ import (
 	"strings"
 )
 
-var enabledMutators = map[string]func(ScrapeResult) ScrapeResult{
-	"/repos/{owner}/{repo}/contents/{path}":                     allowExtendedLastParamMutatorHelper(),
-	"/repos/{owner}/{repo}/git/ref/{ref}":                       allowExtendedLastParamMutatorHelper(),
-	"/repos/{owner}/{repo}/git/refs/{ref}":                      allowExtendedLastParamMutatorHelper(), // thanks for the consistency, GitHub
-	"/repos/{owner}/{repo}/commits/{ref}":                       allowExtendedLastParamMutatorHelper(), // thanks for not base64encode the parameter, GitHub
-	"/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}": allowExtendedLastParamMutatorHelper(),
-	"/orgs/{org}/actions/runners/{runner_id}/labels/{name}":     allowExtendedLastParamMutatorHelper(),
-	"/repos/{owner}/{repo}/labels/{name}":                       allowExtendedLastParamMutatorHelper(),
+const (
+	OptionalLastParameter = "{%s:.*}"
+	ExtendedLastParameter = "{%s:.+}"
+)
+
+var enabledMutations = map[string]string{
+	"/repos/{owner}/{repo}/contents/{path}":                     OptionalLastParameter,
+	"/repos/{owner}/{repo}/git/ref/{ref}":                       ExtendedLastParameter,
+	"/repos/{owner}/{repo}/git/refs/{ref}":                      ExtendedLastParameter,
+	"/repos/{owner}/{repo}/commits/{ref}":                       ExtendedLastParameter,
+	"/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}": ExtendedLastParameter,
+	"/orgs/{org}/actions/runners/{runner_id}/labels/{name}":     ExtendedLastParameter,
+	"/repos/{owner}/{repo}/labels/{name}":                       ExtendedLastParameter,
 }
 
-// allowExtendedLastParamMutatorHelper mutates the last param of the endpoint pattern
-// allowing it to have any characters (including slashes)
-func allowExtendedLastParamMutatorHelper() func(ScrapeResult) ScrapeResult {
+func mutator(formatString string) func(ScrapeResult) ScrapeResult {
 	return func(sr ScrapeResult) ScrapeResult {
 		endpointSplits := strings.Split(sr.EndpointPattern, "/")
 		lastParam := endpointSplits[len(endpointSplits)-1]
@@ -27,7 +30,7 @@ func allowExtendedLastParamMutatorHelper() func(ScrapeResult) ScrapeResult {
 
 		lastParamCleaned := r.FindString(lastParam)
 
-		endpointSplits[len(endpointSplits)-1] = fmt.Sprintf("{%s:.+}", lastParamCleaned)
+		endpointSplits[len(endpointSplits)-1] = fmt.Sprintf(formatString, lastParamCleaned)
 
 		sr.EndpointPattern = strings.Join(endpointSplits, "/")
 
@@ -40,8 +43,8 @@ func allowExtendedLastParamMutatorHelper() func(ScrapeResult) ScrapeResult {
 // There are some edge cases due to inconsistencies between GitHub's OpenAPI definition
 // compared to the real world.
 func applyMutation(sr ScrapeResult) ScrapeResult {
-	if mutator, found := enabledMutators[sr.EndpointPattern]; found {
-		return mutator(sr)
+	if mutation, found := enabledMutations[sr.EndpointPattern]; found {
+		return mutator(mutation)(sr)
 	}
 
 	return sr

src/mock/endpointpattern.go

@@ -157,6 +157,11 @@ var GetCodesOfConductByKey EndpointPattern = EndpointPattern{
 	Method:  "GET",
 }
 
+var PostCredentialsRevoke EndpointPattern = EndpointPattern{
+	Pattern: "/credentials/revoke",
+	Method:  "POST",
+}
+
 var GetEmojis EndpointPattern = EndpointPattern{
 	Pattern: "/emojis",
 	Method:  "GET",
@@ -842,6 +847,31 @@ var DeleteOrgsBlocksByOrgByUsername EndpointPattern = EndpointPattern{
 	Method:  "DELETE",
 }
 
+var GetOrgsCampaignsByOrg EndpointPattern = EndpointPattern{
+	Pattern: "/orgs/{org}/campaigns",
+	Method:  "GET",
+}
+
+var PostOrgsCampaignsByOrg EndpointPattern = EndpointPattern{
+	Pattern: "/orgs/{org}/campaigns",
+	Method:  "POST",
+}
+
+var GetOrgsCampaignsByOrgByCampaignNumber EndpointPattern = EndpointPattern{
+	Pattern: "/orgs/{org}/campaigns/{campaign_number}",
+	Method:  "GET",
+}
+
+var PatchOrgsCampaignsByOrgByCampaignNumber EndpointPattern = EndpointPattern{
+	Pattern: "/orgs/{org}/campaigns/{campaign_number}",
+	Method:  "PATCH",
+}
+
+var DeleteOrgsCampaignsByOrgByCampaignNumber EndpointPattern = EndpointPattern{
+	Pattern: "/orgs/{org}/campaigns/{campaign_number}",
+	Method:  "DELETE",
+}
+
 var GetOrgsCodeScanningAlertsByOrg EndpointPattern = EndpointPattern{
 	Pattern: "/orgs/{org}/code-scanning/alerts",
 	Method:  "GET",
@@ -997,11 +1027,6 @@ var GetOrgsCopilotMetricsByOrg EndpointPattern = EndpointPattern{
 	Method:  "GET",
 }
 
-var GetOrgsCopilotUsageByOrg EndpointPattern = EndpointPattern{
-	Pattern: "/orgs/{org}/copilot/usage",
-	Method:  "GET",
-}
-
 var GetOrgsDependabotAlertsByOrg EndpointPattern = EndpointPattern{
 	Pattern: "/orgs/{org}/dependabot/alerts",
 	Method:  "GET",
@@ -1212,6 +1237,26 @@ var GetOrgsInvitationsTeamsByOrgByInvitationId EndpointPattern = EndpointPattern
 	Method:  "GET",
 }
 
+var GetOrgsIssueTypesByOrg EndpointPattern = EndpointPattern{
+	Pattern: "/orgs/{org}/issue-types",
+	Method:  "GET",
+}
+
+var PostOrgsIssueTypesByOrg EndpointPattern = EndpointPattern{
+	Pattern: "/orgs/{org}/issue-types",
+	Method:  "POST",
+}
+
+var PutOrgsIssueTypesByOrgByIssueTypeId EndpointPattern = EndpointPattern{
+	Pattern: "/orgs/{org}/issue-types/{issue_type_id}",
+	Method:  "PUT",
+}
+
+var DeleteOrgsIssueTypesByOrgByIssueTypeId EndpointPattern = EndpointPattern{
+	Pattern: "/orgs/{org}/issue-types/{issue_type_id}",
+	Method:  "DELETE",
+}
+
 var GetOrgsIssuesByOrg EndpointPattern = EndpointPattern{
 	Pattern: "/orgs/{org}/issues",
 	Method:  "GET",
@@ -1672,11 +1717,6 @@ var GetOrgsTeamCopilotMetricsByOrgByTeamSlug EndpointPattern = EndpointPattern{
 	Method:  "GET",
 }
 
-var GetOrgsTeamCopilotUsageByOrgByTeamSlug EndpointPattern = EndpointPattern{
-	Pattern: "/orgs/{org}/team/{team_slug}/copilot/usage",
-	Method:  "GET",
-}
-
 var GetOrgsTeamsByOrg EndpointPattern = EndpointPattern{
 	Pattern: "/orgs/{org}/teams",
 	Method:  "GET",
@@ -2908,17 +2948,17 @@ var GetReposCompareByOwnerByRepoByBasehead EndpointPattern = EndpointPattern{
 }
 
 var GetReposContentsByOwnerByRepoByPath EndpointPattern = EndpointPattern{
-	Pattern: "/repos/{owner}/{repo}/contents/{path:.+}",
+	Pattern: "/repos/{owner}/{repo}/contents/{path:.*}",
 	Method:  "GET",
 }
 
 var PutReposContentsByOwnerByRepoByPath EndpointPattern = EndpointPattern{
-	Pattern: "/repos/{owner}/{repo}/contents/{path:.+}",
+	Pattern: "/repos/{owner}/{repo}/contents/{path:.*}",
 	Method:  "PUT",
 }
 
 var DeleteReposContentsByOwnerByRepoByPath EndpointPattern = EndpointPattern{
-	Pattern: "/repos/{owner}/{repo}/contents/{path:.+}",
+	Pattern: "/repos/{owner}/{repo}/contents/{path:.*}",
 	Method:  "DELETE",
 }
 
@@ -5422,11 +5462,6 @@ var GetEnterprisesCopilotMetricsByEnterprise EndpointPattern = EndpointPattern{
 	Method:  "GET",
 }
 
-var GetEnterprisesCopilotUsageByEnterprise EndpointPattern = EndpointPattern{
-	Pattern: "/enterprises/{enterprise}/copilot/usage",
-	Method:  "GET",
-}
-
 var GetEnterprisesLicenseSyncStatusByEnterprise EndpointPattern = EndpointPattern{
 	Pattern: "/enterprises/{enterprise}/license-sync-status",
 	Method:  "GET",
@@ -5567,11 +5602,6 @@ var GetEnterprisesTeamCopilotMetricsByEnterpriseByTeamSlug EndpointPattern = End
 	Method:  "GET",
 }
 
-var GetEnterprisesTeamCopilotUsageByEnterpriseByTeamSlug EndpointPattern = EndpointPattern{
-	Pattern: "/enterprises/{enterprise}/team/{team_slug}/copilot/usage",
-	Method:  "GET",
-}
-
 var PostEnterprisesByEnterpriseBySecurityProductByEnablement EndpointPattern = EndpointPattern{
 	Pattern: "/enterprises/{enterprise}/{security_product}/{enablement}",
 	Method:  "POST",
@@ -5667,6 +5697,11 @@ var DeleteOrgsCustomRolesByOrgByRoleId EndpointPattern = EndpointPattern{
 	Method:  "DELETE",
 }
 
+var GetOrgsDismissalRequestsSecretScanningByOrg EndpointPattern = EndpointPattern{
+	Pattern: "/orgs/{org}/dismissal-requests/secret-scanning",
+	Method:  "GET",
+}
+
 var GetOrgsExternalGroupByOrgByGroupId EndpointPattern = EndpointPattern{
 	Pattern: "/orgs/{org}/external-group/{group_id}",
 	Method:  "GET",
@@ -5772,6 +5807,21 @@ var DeleteReposBypassResponsesSecretScanningByOwnerByRepoByBypassResponseId Endp
 	Method:  "DELETE",
 }
 
+var GetReposDismissalRequestsSecretScanningByOwnerByRepo EndpointPattern = EndpointPattern{
+	Pattern: "/repos/{owner}/{repo}/dismissal-requests/secret-scanning",
+	Method:  "GET",
+}
+
+var GetReposDismissalRequestsSecretScanningByOwnerByRepoByAlertNumber EndpointPattern = EndpointPattern{
+	Pattern: "/repos/{owner}/{repo}/dismissal-requests/secret-scanning/{alert_number}",
+	Method:  "GET",
+}
+
+var PatchReposDismissalRequestsSecretScanningByOwnerByRepoByAlertNumber EndpointPattern = EndpointPattern{
+	Pattern: "/repos/{owner}/{repo}/dismissal-requests/secret-scanning/{alert_number}",
+	Method:  "PATCH",
+}
+
 var PutReposLfsByOwnerByRepo EndpointPattern = EndpointPattern{
 	Pattern: "/repos/{owner}/{repo}/lfs",
 	Method:  "PUT",

src/mock/endpointpattern_test.go

@@ -4,7 +4,7 @@ import (
 	"context"
 	"testing"
 
-	"github.com/google/go-github/v69/github"
+	"github.com/google/go-github/v71/github"
 )
 
 func TestRepoGetContents(t *testing.T) {
@@ -71,6 +71,80 @@ func TestRepoGetContents(t *testing.T) {
 	}
 }
 
+func TestRepoGetContentsForDirectory(t *testing.T) {
+	cases := []struct {
+		name              string
+		path              string
+		repositoryContent []*github.RepositoryContent
+	}{
+		{
+			name: "rootDirectory",
+			path: "",
+			repositoryContent: []*github.RepositoryContent{
+				{
+					Name:        github.Ptr("a.yaml"),
+					DownloadURL: github.Ptr("https://raw.githubusercontent.com/foo/bar/a.yaml"),
+				},
+				{
+					Name:        github.Ptr("b.json"),
+					DownloadURL: github.Ptr("https://raw.githubusercontent.com/foo/bar/b.json"),
+				},
+			},
+		},
+	}
+
+	for _, c := range cases {
+		t.Run(c.name, func(rc []*github.RepositoryContent) func(t *testing.T) {
+			return func(t *testing.T) {
+				mockedHTTPClient := NewMockedHTTPClient(
+					WithRequestMatch(
+						GetReposContentsByOwnerByRepoByPath,
+						rc,
+					),
+				)
+
+				client := github.NewClient(mockedHTTPClient)
+
+				ctx := context.Background()
+
+				_, dirContent, _, err := client.Repositories.GetContents(
+					ctx,
+					"foo",
+					"bar",
+					c.path,
+					&github.RepositoryContentGetOptions{},
+				)
+
+				if len(dirContent) != len(rc) {
+					t.Errorf(
+						"dirContent length is %d, want %d",
+						len(dirContent),
+						len(rc),
+					)
+				}
+
+				for i := range rc {
+					if rc[i] == dirContent[1] {
+						t.Errorf(
+							"dirContent element at %d is '%s', want '%s'",
+							i,
+							*dirContent[i].Name,
+							*rc[i].Name,
+						)
+					}
+				}
+
+				if err != nil {
+					t.Errorf(
+						"err is %s, want nil",
+						err.Error(),
+					)
+				}
+			}
+		}(c.repositoryContent))
+	}
+}
+
 func TestPatchGitReference(t *testing.T) {
 	mockedHTTPClient := NewMockedHTTPClient(
 		WithRequestMatch(

src/mock/server_options_external_test.go

@@ -6,7 +6,7 @@ import (
 	"testing"
 	"time"
 
-	"github.com/google/go-github/v69/github"
+	"github.com/google/go-github/v71/github"
 	"github.com/migueleliasweb/go-github-mock/src/mock"
 )
 

src/mock/server_options_test.go

@@ -3,7 +3,7 @@ package mock
 import (
 	"testing"
 
-	"github.com/google/go-github/v69/github"
+	"github.com/google/go-github/v71/github"
 	"github.com/gorilla/mux"
 )
 

src/mock/server_test.go

@@ -7,7 +7,7 @@ import (
 	"strings"
 	"testing"
 
-	"github.com/google/go-github/v69/github"
+	"github.com/google/go-github/v71/github"
 )
 
 func TestNewMockedHTTPClient(t *testing.T) {