docs: fix golint warnings

Author: stang

cmd/git-remote-https+iap/main.go

@@ -16,20 +16,19 @@ import (
 )
 
 const (
-	BinaryName = "git-remote-https+iap"
-
 	// DebugEnvVariable is the name of the environment variable that needs to be set in order to enable debug logging
 	DebugEnvVariable = "GIT_IAP_VERBOSE"
 )
 
 var (
-	version string
+	binaryName = os.Args[0]
+	version    string
 
 	// only used in configureCmd
 	repoURL, helperID, helperSecret, clientID string
 
 	rootCmd = &cobra.Command{
-		Use:   fmt.Sprintf("%s remote url", BinaryName),
+		Use:   fmt.Sprintf("%s remote url", binaryName),
 		Short: "git-remote-helper that handles authentication for GCP Identity Aware Proxy",
 		Args:  cobra.ExactArgs(2),
 		Run:   execute,
@@ -84,18 +83,18 @@ func main() {
 
 func execute(cmd *cobra.Command, args []string) {
 	remote, url := args[0], args[1]
-	log.Debug().Msgf("%s %s %s", BinaryName, remote, url)
+	log.Debug().Msgf("%s %s %s", binaryName, remote, url)
 
 	handleIAPAuthCookieFor(url)
 	git.PassThruRemoteHTTPSHelper(remote, url)
 }
 
 func printVersion(cmd *cobra.Command, args []string) {
-	fmt.Printf("%s %s\n", BinaryName, version)
+	fmt.Printf("%s %s\n", binaryName, version)
 }
 
 func installGitProtocol(cmd *cobra.Command, args []string) {
-	p := strings.TrimLeft(BinaryName, "git-remote-")
+	p := strings.TrimLeft(binaryName, "git-remote-")
 	git.InstallProtocol(p)
 	log.Info().Msgf("%s protocol configured in git!", p)
 }

internal/git/git.go

@@ -33,6 +33,8 @@ func ConfigGetURLMatch(key, url string) string {
 	return strings.TrimSpace(string(stdout.Bytes()))
 }
 
+// SetGlobalConfig allows to set system-wide Git configuration.
+// The application exits in case of error.
 func SetGlobalConfig(url, section, key, value string) {
 	x := fmt.Sprintf("%s.%s.%s", section, url, key)
 	args := []string{"config", "--global", x, value}
@@ -43,6 +45,8 @@ func SetGlobalConfig(url, section, key, value string) {
 	}
 }
 
+// PassThruRemoteHTTPSHelper exec the git-remote-https helper,
+// which allows the caller to transparently pass-thru it.
 func PassThruRemoteHTTPSHelper(remote, url string) {
 	u, err := _url.Parse(url)
 	if err != nil {
@@ -63,6 +67,8 @@ func PassThruRemoteHTTPSHelper(remote, url string) {
 	}
 }
 
+// StoreCredentials persists credentials on disk, using the built-in
+// git-credential-store helper.
 func StoreCredentials(protocol, host, username, password string) error {
 	var stdin bytes.Buffer
 
@@ -80,6 +86,7 @@ func StoreCredentials(protocol, host, username, password string) error {
 	return res
 }
 
+// GetCredentials retrieves credentials from the built-in git-credential-store helper.
 func GetCredentials(protocol, host, username string) (string, error) {
 	var stdin, stdout bytes.Buffer
 
@@ -102,6 +109,7 @@ func GetCredentials(protocol, host, username string) (string, error) {
 	return "", fmt.Errorf("GetCredentials - not found for protocol=%s,host=%s,username=%s", protocol, host, username)
 }
 
+// InstallProtocol configure Git to allow a given protocol on the system.
 func InstallProtocol(protocol string) {
 	protocol = fmt.Sprintf("protocol.%s.allow", protocol)
 	args := []string{"config", "--global", protocol, "always"}

internal/iap/cookie.go

@@ -21,6 +21,7 @@ const (
 	IAPCookieName = "GCP_IAAP_AUTH_TOKEN"
 )
 
+// A Cookie holds pieces of information required to manage the IAP cookie
 type Cookie struct {
 	JarPath string
 	Domain  string

internal/iap/token.go

@@ -17,11 +17,16 @@ import (
 )
 
 const (
+	// CacheProtocol is the protocol used when saving the refresh-token in git-credential-store
+	// It can be an arbitrary value.
 	CacheProtocol = "iap"
+
+	// CacheUsername is the username used when saving the refresh-token in git-credential-store.
+	// It can be an arbitrary value.
 	CacheUsername = "refresh-token"
 )
 
-type Token struct {
+type token struct {
 	AccessToken string `json:"access_token"`
 	ExpiresIn   int    `json:"expires_in"`
 	Scope       string `json:"scope"`
@@ -95,9 +100,12 @@ func getRefreshTokenFromCache(key string) (string, error) {
 	return git.GetCredentials(CacheProtocol, key, CacheUsername)
 }
 
-// GetIAPAuthToken returns a raw IAP auth token for the given args
+// GetIAPAuthToken take care of the IAP Authentication process when relevant.
+// It optmize this workflow by detecting cases where an existing IAP auth token is already available,
+// and caching a refresh-token.
+// It returns a raw IAP auth token and any error encountered.
 func GetIAPAuthToken(domain, helperID, helperSecret, IAPclientID string) (string, error) {
-	var result Token
+	var result token
 
 	refreshToken, err := getRefreshTokenFromCache(domain)
 	if err != nil {