github: Remove redundant options

Signed-off-by: Matheus Pimenta <[email protected]>

Author: matheuscscp

git/github/client.go

@@ -33,10 +33,10 @@ import (
 )
 
 const (
-	AppIDKey             = "githubAppID"
-	AppInstallationIDKey = "githubAppInstallationID"
-	AppPrivateKey        = "githubAppPrivateKey"
-	AppBaseUrlKey        = "githubAppBaseURL"
+	KeyAppID             = "githubAppID"
+	KeyAppInstallationID = "githubAppInstallationID"
+	KeyAppPrivateKey     = "githubAppPrivateKey"
+	KeyAppBaseURL        = "githubAppBaseURL"
 
 	AccessTokenUsername = "x-access-token"
 )
@@ -111,51 +111,22 @@ func New(opts ...OptFunc) (*Client, error) {
 	return p, nil
 }
 
-// WithInstallationID configures the installation ID of the GitHub App.
-func WithInstllationID(installationID string) OptFunc {
-	return func(p *Client) {
-		p.installationID = installationID
-	}
-}
-
-// WithAppID configures the app ID of the GitHub App.
-func WithAppID(appID string) OptFunc {
-	return func(p *Client) {
-		p.appID = appID
-	}
-}
-
-// WithPrivateKey configures the private key of the GitHub App.
-func WithPrivateKey(pk []byte) OptFunc {
-	return func(p *Client) {
-		p.privateKey = pk
-	}
-}
-
-// WithAppBaseURL configures the GitHub API endpoint to use to fetch GitHub App
-// installation token.
-func WithAppBaseURL(appBaseURL string) OptFunc {
-	return func(p *Client) {
-		p.apiURL = appBaseURL
-	}
-}
-
 // WithAppData configures the client using data from a map
 func WithAppData(appData map[string][]byte) OptFunc {
 	return func(p *Client) {
-		val, ok := appData[AppIDKey]
+		val, ok := appData[KeyAppID]
 		if ok {
 			p.appID = string(val)
 		}
-		val, ok = appData[AppInstallationIDKey]
+		val, ok = appData[KeyAppInstallationID]
 		if ok {
 			p.installationID = string(val)
 		}
-		val, ok = appData[AppPrivateKey]
+		val, ok = appData[KeyAppPrivateKey]
 		if ok {
 			p.privateKey = val
 		}
-		val, ok = appData[AppBaseUrlKey]
+		val, ok = appData[KeyAppBaseURL]
 		if ok {
 			p.apiURL = string(val)
 		}
@@ -249,10 +220,10 @@ func GetCredentials(ctx context.Context, opts ...OptFunc) (string, string, error
 
 func (p *Client) buildCacheKey() string {
 	keyParts := []string{
-		fmt.Sprintf("%s=%s", AppIDKey, p.appID),
-		fmt.Sprintf("%s=%s", AppInstallationIDKey, p.installationID),
-		fmt.Sprintf("%s=%s", AppBaseUrlKey, p.apiURL),
-		fmt.Sprintf("%s=%s", AppPrivateKey, string(p.privateKey)),
+		fmt.Sprintf("%s=%s", KeyAppID, p.appID),
+		fmt.Sprintf("%s=%s", KeyAppInstallationID, p.installationID),
+		fmt.Sprintf("%s=%s", KeyAppBaseURL, p.apiURL),
+		fmt.Sprintf("%s=%s", KeyAppPrivateKey, string(p.privateKey)),
 	}
 	rawKey := strings.Join(keyParts, ",")
 	hash := sha256.Sum256([]byte(rawKey))

git/github/client_test.go

@@ -45,26 +45,33 @@ func TestClient_Options(t *testing.T) {
 		opts    []OptFunc
 		wantErr error
 	}{
-		{
-			name: "Create new client",
-			opts: []OptFunc{WithInstllationID(installationID), WithAppID(appID), WithPrivateKey(kp.PrivateKey)},
-		},
 		{
 			name: "Create new client with proxy",
-			opts: []OptFunc{WithInstllationID(installationID), WithAppID(appID), WithPrivateKey(kp.PrivateKey), WithProxyURL((proxy))},
+			opts: []OptFunc{
+				WithAppData(map[string][]byte{
+					KeyAppID:             []byte(appID),
+					KeyAppInstallationID: []byte(installationID),
+					KeyAppPrivateKey:     kp.PrivateKey,
+				}),
+				WithProxyURL(proxy),
+			},
 		},
 		{
-			name: "Create new client with custom api url",
-			opts: []OptFunc{WithAppBaseURL(gitHubEnterpriseURL), WithInstllationID(installationID), WithAppID(appID), WithPrivateKey(kp.PrivateKey)},
+			name: "Create new client",
+			opts: []OptFunc{WithAppData(map[string][]byte{
+				KeyAppID:             []byte(appID),
+				KeyAppInstallationID: []byte(installationID),
+				KeyAppPrivateKey:     kp.PrivateKey,
+			})},
 		},
 		{
-			name: "Create new client with app data",
+			name: "Create new client with custom api url",
 			opts: []OptFunc{WithAppData(map[string][]byte{
-				AppIDKey:             []byte(appID),
-				AppInstallationIDKey: []byte(installationID),
-				AppPrivateKey:        kp.PrivateKey,
-			},
-			)},
+				KeyAppID:             []byte(appID),
+				KeyAppInstallationID: []byte(installationID),
+				KeyAppBaseURL:        []byte(gitHubEnterpriseURL),
+				KeyAppPrivateKey:     kp.PrivateKey,
+			})},
 		},
 		{
 			name:    "Create new client with empty data",
@@ -74,56 +81,56 @@ func TestClient_Options(t *testing.T) {
 		{
 			name: "Create new client with app data with missing AppID Key",
 			opts: []OptFunc{WithAppData(map[string][]byte{
-				AppInstallationIDKey: []byte(installationID),
-				AppPrivateKey:        kp.PrivateKey,
+				KeyAppInstallationID: []byte(installationID),
+				KeyAppPrivateKey:     kp.PrivateKey,
 			},
 			)},
 			wantErr: errors.New("app ID must be provided to use github app authentication"),
 		},
 		{
 			name: "Create new client with app data with missing AppInstallationID Key",
 			opts: []OptFunc{WithAppData(map[string][]byte{
-				AppIDKey:      []byte("123"),
-				AppPrivateKey: kp.PrivateKey,
+				KeyAppID:         []byte("123"),
+				KeyAppPrivateKey: kp.PrivateKey,
 			},
 			)},
 			wantErr: errors.New("app installation ID must be provided to use github app authentication"),
 		},
 		{
 			name: "Create new client with app data with missing private Key",
 			opts: []OptFunc{WithAppData(map[string][]byte{
-				AppIDKey:             []byte(appID),
-				AppInstallationIDKey: []byte(installationID),
+				KeyAppID:             []byte(appID),
+				KeyAppInstallationID: []byte(installationID),
 			},
 			)},
 			wantErr: errors.New("private key must be provided to use github app authentication"),
 		},
 		{
 			name: "Create new client with invalid appID in app data",
 			opts: []OptFunc{WithAppData(map[string][]byte{
-				AppIDKey:             []byte("abc"),
-				AppInstallationIDKey: []byte(installationID),
-				AppPrivateKey:        kp.PrivateKey,
+				KeyAppID:             []byte("abc"),
+				KeyAppInstallationID: []byte(installationID),
+				KeyAppPrivateKey:     kp.PrivateKey,
 			},
 			)},
 			wantErr: errors.New("invalid app id, err: strconv.Atoi: parsing \"abc\": invalid syntax"),
 		},
 		{
 			name: "Create new client with invalid installationID in app data",
 			opts: []OptFunc{WithAppData(map[string][]byte{
-				AppIDKey:             []byte(appID),
-				AppInstallationIDKey: []byte("abc"),
-				AppPrivateKey:        kp.PrivateKey,
+				KeyAppID:             []byte(appID),
+				KeyAppInstallationID: []byte("abc"),
+				KeyAppPrivateKey:     kp.PrivateKey,
 			},
 			)},
 			wantErr: errors.New("invalid app installation id, err: strconv.Atoi: parsing \"abc\": invalid syntax"),
 		},
 		{
 			name: "Create new client with invalid private key in app data",
 			opts: []OptFunc{WithAppData(map[string][]byte{
-				AppIDKey:             []byte(appID),
-				AppInstallationIDKey: []byte(installationID),
-				AppPrivateKey:        []byte("  "),
+				KeyAppID:             []byte(appID),
+				KeyAppInstallationID: []byte(installationID),
+				KeyAppPrivateKey:     []byte("  "),
 			},
 			)},
 			wantErr: errors.New("could not parse private key: invalid key: Key must be a PEM encoded PKCS1 or PKCS8 key"),
@@ -230,7 +237,12 @@ func TestClient_GetCredentials(t *testing.T) {
 			kp, err := ssh.GenerateKeyPair(ssh.RSA_4096)
 			g.Expect(err).ToNot(HaveOccurred())
 			opts := []OptFunc{
-				WithAppBaseURL(srv.URL), WithInstllationID("123"), WithAppID("456"), WithPrivateKey(kp.PrivateKey),
+				WithAppData(map[string][]byte{
+					KeyAppID:             []byte("123"),
+					KeyAppInstallationID: []byte("456"),
+					KeyAppBaseURL:        []byte(srv.URL),
+					KeyAppPrivateKey:     kp.PrivateKey,
+				}),
 			}
 			opts = append(opts, tt.opts...)
 

git/gogit/go.mod

@@ -14,7 +14,7 @@ require (
 	github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5
 	github.com/elazarl/goproxy v1.7.2
 	github.com/fluxcd/gitkit v0.6.0
-	github.com/fluxcd/pkg/git v0.33.0
+	github.com/fluxcd/pkg/git v0.34.0
 	github.com/fluxcd/pkg/gittestserver v0.18.0
 	github.com/fluxcd/pkg/ssh v0.20.0
 	github.com/fluxcd/pkg/version v0.9.0

git/internal/e2e/github_test.go

@@ -149,9 +149,11 @@ func TestGitHubE2E(t *testing.T) {
 				var data map[string][]byte
 				authOptions, err = git.NewAuthOptions(*repoURL, data)
 				username, password, err := pkggithub.GetCredentials(context.Background(),
-					pkggithub.WithAppID(githubAppID),
-					pkggithub.WithInstllationID(githubAppInstallID),
-					pkggithub.WithPrivateKey(githubAppPrivateKey))
+					pkggithub.WithAppData(map[string][]byte{
+						pkggithub.KeyAppID:             []byte(githubAppID),
+						pkggithub.KeyAppInstallationID: []byte(githubAppInstallID),
+						pkggithub.KeyAppPrivateKey:     githubAppPrivateKey,
+					}))
 				if err != nil {
 					return nil, nil, err
 				}

git/internal/e2e/go.mod

@@ -13,8 +13,8 @@ replace (
 
 require (
 	github.com/fluxcd/go-git-providers v0.22.0
-	github.com/fluxcd/pkg/git v0.33.0
-	github.com/fluxcd/pkg/git/gogit v0.36.0
+	github.com/fluxcd/pkg/git v0.34.0
+	github.com/fluxcd/pkg/git/gogit v0.37.0
 	github.com/fluxcd/pkg/gittestserver v0.18.0
 	github.com/fluxcd/pkg/ssh v0.20.0
 	github.com/go-git/go-git/v5 v5.16.2

oci/tests/integration/go.mod

@@ -20,8 +20,8 @@ require (
 	github.com/fluxcd/pkg/apis/meta v1.17.0
 	github.com/fluxcd/pkg/auth v0.21.0
 	github.com/fluxcd/pkg/cache v0.10.0
-	github.com/fluxcd/pkg/git v0.33.0
-	github.com/fluxcd/pkg/git/gogit v0.36.0
+	github.com/fluxcd/pkg/git v0.34.0
+	github.com/fluxcd/pkg/git/gogit v0.37.0
 	github.com/fluxcd/pkg/runtime v0.69.0
 	github.com/fluxcd/test-infra/tftestenv v0.0.0-20250626232827-e0ca9c3f8d7b
 	github.com/go-git/go-git/v5 v5.16.2