fix: correct goreport detected errors (#26)

Author: xoanmm

cmd/run.go

@@ -13,18 +13,29 @@ import (
 )
 
 const (
-	GitCommitUser  = "git-commit-user"
+	// GitCommitUser is the user login used for commit changes
+	GitCommitUser = "git-commit-user"
+	// GitCommitEmail is the email used for commit changes
 	GitCommitEmail = "git-commit-email"
-	GitPassword    = "git-password"
-	GitBranch      = "git-branch"
-	GitRepoUrl     = "git-repo-url"
-	GitFile        = "git-file"
-	GitDir         = "git-dir"
-
-	AppName       = "app-name"
-	SshPrivateKey = "ssh-private-key"
-	DryRun        = "dry-run"
-	LogLevel      = "logLevel"
+	// GitPassword is the git password used for auth
+	GitPassword = "git-password"
+	// GitBranch is the branch of the git repository
+	GitBranch = "git-branch"
+	// GitRepoURL is the git repository url
+	GitRepoURL = "git-repo-url"
+	// GitFile is the file that is going to be changed
+	GitFile = "git-file"
+	// GitDir is the directory where the file to be changed is located
+	GitDir = "git-dir"
+	// AppName is the name of the helm application
+	AppName = "app-name"
+	// SSHPrivateKey is the location of the SSH private key used for auth
+	SSHPrivateKey = "ssh-private-key"
+	// DryRun is going to indicate if the changes are going to be committed or not
+	DryRun = "dry-run"
+	// LogLevel will indicate the log level
+	LogLevel = "logLevel"
+	// HelmKeyValues will be used for indicate the key and values to be changed in helm
 	HelmKeyValues = "helm-key-values"
 )
 
@@ -39,10 +50,10 @@ var runCmd = &cobra.Command{
 		gitEmail, _ := cmd.Flags().GetString(GitCommitEmail)
 		gitPass, _ := cmd.Flags().GetString(GitPassword)
 		gitBranch, _ := cmd.Flags().GetString(GitBranch)
-		gitRepoURL, _ := cmd.Flags().GetString(GitRepoUrl)
+		gitRepoURL, _ := cmd.Flags().GetString(GitRepoURL)
 		gitFile, _ := cmd.Flags().GetString(GitFile)
 		gitDir, _ := cmd.Flags().GetString(GitDir)
-		sshKey, _ := cmd.Flags().GetString(SshPrivateKey)
+		sshKey, _ := cmd.Flags().GetString(SSHPrivateKey)
 		appName, _ := cmd.Flags().GetString(AppName)
 		logLevel, _ := cmd.Flags().GetString(LogLevel)
 		dryRun, _ := cmd.Flags().GetBool(DryRun)
@@ -138,18 +149,18 @@ func init() {
 	runCmd.Flags().String(GitCommitEmail, "", "E-Mail address to use for Git commits")
 	runCmd.Flags().String(GitPassword, "", "Password for github user")
 	runCmd.Flags().String(GitBranch, "develop", "branch")
-	runCmd.Flags().String(GitRepoUrl, "", "git repo url")
+	runCmd.Flags().String(GitRepoURL, "", "git repo url")
 	runCmd.Flags().String(GitFile, "", "file eg. values.yaml")
 	runCmd.Flags().String(GitDir, "", "file eg. /production/charts/")
 	runCmd.Flags().String(AppName, "", "app name")
-	runCmd.Flags().String(SshPrivateKey, "", "ssh private key")
+	runCmd.Flags().String(SSHPrivateKey, "", "ssh private key")
 	runCmd.Flags().Bool(DryRun, false, "run in dry-run mode. If set to true, do not perform any changes")
 	runCmd.Flags().String(LogLevel, "info", "set the loglevel to one of trace|debug|info|warn|error")
 	runCmd.Flags().StringToString(HelmKeyValues, nil, "helm key-values sets")
 
 	_ = runCmd.MarkFlagRequired(GitCommitUser)
 	_ = runCmd.MarkFlagRequired(GitCommitEmail)
-	_ = runCmd.MarkFlagRequired(GitRepoUrl)
+	_ = runCmd.MarkFlagRequired(GitRepoURL)
 	_ = runCmd.MarkFlagRequired(GitFile)
 	_ = runCmd.MarkFlagRequired(HelmKeyValues)
 	_ = runCmd.MarkFlagRequired(AppName)

internal/app/decoder/decoder_yaml.go

@@ -1,10 +1,12 @@
 package decoder
 
 import (
-	yaml "gopkg.in/yaml.v3"
 	"io"
+
+	yaml "gopkg.in/yaml.v3"
 )
 
+// Decoder container the methods to Init a Decode a Decoder
 type Decoder interface {
 	Init(reader io.Reader)
 	Decode(node *yaml.Node) error
@@ -14,6 +16,7 @@ type yamlDecoder struct {
 	decoder yaml.Decoder
 }
 
+// NewYamlDecoder creates a new Decoder
 func NewYamlDecoder() Decoder {
 	return &yamlDecoder{}
 }

internal/app/git/creds.go

@@ -57,7 +57,7 @@ func isHTTPSURL(url string) bool {
 
 // generateAuthForSSH generate the necessary public keys as auth for git repository using
 // the provided privateKeyFile containing a valid SSH private key
-func generateAuthForSSH(repoUrl string, userName string, privateKeyFile string, password string) (ssh.AuthMethod, error) {
+func generateAuthForSSH(repoURL string, userName string, privateKeyFile string, password string) (ssh.AuthMethod, error) {
 	publicKeys, err := ssh.NewPublicKeysFromFile("git", privateKeyFile, password)
 	if err != nil {
 		log.Warnf("generate publickeys failed: %s\n", err.Error())
@@ -67,16 +67,16 @@ func generateAuthForSSH(repoUrl string, userName string, privateKeyFile string,
 }
 
 // fromSSH generate a valid credentials using ssh key
-func (c Credentials) fromSSH(repoUrl string, password string) (ssh.AuthMethod, error) {
-	if c.allowsSshAuth() {
-		sshPublicKeys, err := generateAuthForSSH(repoUrl, c.Username, c.SSHPrivKey, password)
+func (c Credentials) fromSSH(repoURL string, password string) (ssh.AuthMethod, error) {
+	if c.allowsSSHAuth() {
+		sshPublicKeys, err := generateAuthForSSH(repoURL, c.Username, c.SSHPrivKey, password)
 		if err != nil {
 			return nil, err
 		}
 		return sshPublicKeys, nil
 	}
 
-	return nil, sshPrivateKeyNotProvided(repoUrl)
+	return nil, sshPrivateKeyNotProvided(repoURL)
 }
 
 // generatAuthFor generate a valid credentials for go-git library using
@@ -100,7 +100,7 @@ func (c Credentials) from(repoURL string) (*http.BasicAuth, error) {
 
 // allowSshAuth check if necessary attributes for generate an SSH
 // credentials are provided
-func (c Credentials) allowsSshAuth() bool {
+func (c Credentials) allowsSSHAuth() bool {
 	return c.SSHPrivKey != ""
 }
 
@@ -112,18 +112,18 @@ func (c Credentials) allowsAuth() bool {
 
 // sshPrivateKeyNotProvided return an error used when sshPrivKey
 // is not provided for generate and SSH credentials
-func sshPrivateKeyNotProvided(repoUrl string) error {
-	return fmt.Errorf("sshPrivKey not provided for authenticatication to repository %s", repoUrl)
+func sshPrivateKeyNotProvided(repoURL string) error {
+	return fmt.Errorf("sshPrivKey not provided for authenticatication to repository %s", repoURL)
 }
 
 // UserAndPasswordNotProvided return an error used when
 // username or password are not provided for generate and  credentials
-func UserAndPasswordNotProvided(repoUrl string) error {
-	return fmt.Errorf("no value provided for username and password for authentication to repository %s", repoUrl)
+func UserAndPasswordNotProvided(repoURL string) error {
+	return fmt.Errorf("no value provided for username and password for authentication to repository %s", repoURL)
 }
 
 // unknownRepositoryType return an error used when
 // the repository provided is not  or SSH type
-func unknownRepositoryType(repoUrl string) error {
-	return fmt.Errorf("unknown repository type for git repository URL %s", repoUrl)
+func unknownRepositoryType(repoURL string) error {
+	return fmt.Errorf("unknown repository type for git repository URL %s", repoURL)
 }

internal/app/log/log.go

@@ -18,17 +18,17 @@ import (
 	logger "github.com/sirupsen/logrus"
 )
 
-// LogContext contains a structured context for logging
-type LogContext struct {
+// Context contains a structured context for logging
+type Context struct {
 	fields    logger.Fields
 	normalOut io.Writer
 	errorOut  io.Writer
 	mutex     sync.RWMutex
 }
 
-// NewContext returns a LogContext with default settings
-func NewContext() *LogContext {
-	var logctx LogContext
+// NewContext returns a Context with default settings
+func NewContext() *Context {
+	var logctx Context
 	logctx.fields = make(logger.Fields)
 	logctx.normalOut = os.Stdout
 	logctx.errorOut = os.Stderr
@@ -55,20 +55,20 @@ func SetLogLevel(logLevel string) error {
 }
 
 // WithContext is an alias for NewContext
-func WithContext() *LogContext {
+func WithContext() *Context {
 	return NewContext()
 }
 
 // AddField adds a structured field to logctx
-func (logctx *LogContext) AddField(key string, value interface{}) *LogContext {
+func (logctx *Context) AddField(key string, value interface{}) *Context {
 	logctx.mutex.Lock()
 	logctx.fields[key] = value
 	logctx.mutex.Unlock()
 	return logctx
 }
 
 // Tracef logs a debug message for logctx to stdout
-func (logctx *LogContext) Tracef(format string, args ...interface{}) {
+func (logctx *Context) Tracef(format string, args ...interface{}) {
 	logger.SetOutput(logctx.normalOut)
 	if logctx.fields != nil && len(logctx.fields) > 0 {
 		logger.WithFields(logctx.fields).Tracef(format, args...)
@@ -78,7 +78,7 @@ func (logctx *LogContext) Tracef(format string, args ...interface{}) {
 }
 
 // Debugf logs a debug message for logctx to stdout
-func (logctx *LogContext) Debugf(format string, args ...interface{}) {
+func (logctx *Context) Debugf(format string, args ...interface{}) {
 	logger.SetOutput(logctx.normalOut)
 	if logctx.fields != nil && len(logctx.fields) > 0 {
 		logger.WithFields(logctx.fields).Debugf(format, args...)
@@ -88,7 +88,7 @@ func (logctx *LogContext) Debugf(format string, args ...interface{}) {
 }
 
 // Infof logs an informational message for logctx to stdout
-func (logctx *LogContext) Infof(format string, args ...interface{}) {
+func (logctx *Context) Infof(format string, args ...interface{}) {
 	logger.SetOutput(logctx.normalOut)
 	if logctx.fields != nil && len(logctx.fields) > 0 {
 		logger.WithFields(logctx.fields).Infof(format, args...)
@@ -98,7 +98,7 @@ func (logctx *LogContext) Infof(format string, args ...interface{}) {
 }
 
 // Warnf logs a warning message for logctx to stdout
-func (logctx *LogContext) Warnf(format string, args ...interface{}) {
+func (logctx *Context) Warnf(format string, args ...interface{}) {
 	logger.SetOutput(logctx.normalOut)
 	if logctx.fields != nil && len(logctx.fields) > 0 {
 		logger.WithFields(logctx.fields).Warnf(format, args...)
@@ -108,7 +108,7 @@ func (logctx *LogContext) Warnf(format string, args ...interface{}) {
 }
 
 // Errorf logs a non-fatal error message for logctx to stdout
-func (logctx *LogContext) Errorf(format string, args ...interface{}) {
+func (logctx *Context) Errorf(format string, args ...interface{}) {
 	logger.SetOutput(logctx.errorOut)
 	if logctx.fields != nil && len(logctx.fields) > 0 {
 		logger.WithFields(logctx.fields).Errorf(format, args...)
@@ -118,7 +118,7 @@ func (logctx *LogContext) Errorf(format string, args ...interface{}) {
 }
 
 // Fatalf logs a fatal error message for logctx to stdout
-func (logctx *LogContext) Fatalf(format string, args ...interface{}) {
+func (logctx *Context) Fatalf(format string, args ...interface{}) {
 	logger.SetOutput(logctx.errorOut)
 	if logctx.fields != nil && len(logctx.fields) > 0 {
 		logger.WithFields(logctx.fields).Fatalf(format, args...)
@@ -127,19 +127,19 @@ func (logctx *LogContext) Fatalf(format string, args ...interface{}) {
 	}
 }
 
-// Debugf logs a warning message without context to stdout
+// Tracef logs a trace message without context to stdout
 func Tracef(format string, args ...interface{}) {
 	logCtx := NewContext()
 	logCtx.Tracef(format, args...)
 }
 
-// Debugf logs a warning message without context to stdout
+// Debugf logs a debug message without context to stdout
 func Debugf(format string, args ...interface{}) {
 	logCtx := NewContext()
 	logCtx.Debugf(format, args...)
 }
 
-// Infof logs a warning message without context to stdout
+// Infof logs an informational message without context to stdout
 func Infof(format string, args ...interface{}) {
 	logCtx := NewContext()
 	logCtx.Infof(format, args...)

internal/app/updater/commit.go

@@ -43,12 +43,12 @@ func commitChangesLocked(cfg HelmUpdaterConfig, state *SyncIterationState) (*[]C
 }
 
 // cloneRepository clones the git repository in a temporal directory.
-func cloneRepository(appName string, repoUrl string, authCreds transport.AuthMethod, tempRoot string) (*git.Repository, error) {
+func cloneRepository(appName string, repoURL string, authCreds transport.AuthMethod, tempRoot string) (*git.Repository, error) {
 	logCtx := log.WithContext().AddField("application", appName)
-	logCtx.Infof("Cloning git repository %s in temporal folder located in %s", repoUrl, tempRoot)
+	logCtx.Infof("Cloning git repository %s in temporal folder located in %s", repoURL, tempRoot)
 	r, err := git.PlainClone(tempRoot, false, &git.CloneOptions{
 		Auth:     authCreds,
-		URL:      repoUrl,
+		URL:      repoURL,
 		Progress: os.Stdout,
 	})
 	if err != nil {
@@ -160,7 +160,7 @@ func configureCommitMessage(appName string, apps []ChangeEntry, helmUpdaterConfi
 
 // createTempFileInDirectory creates a temporal directory where a copy of
 // the git repository is going to be stored.
-func CreateTempFileInDirectory(dirName string, applicationName string, repoURL string) (*string, error) {
+func createTempFileInDirectory(dirName string, applicationName string, repoURL string) (*string, error) {
 	logCtx := log.WithContext().AddField("application", applicationName)
 	tempRoot, err := ioutil.TempDir(os.TempDir(), dirName)
 	if err != nil {
@@ -260,8 +260,8 @@ func fetchLatestChangesGitRepository(appName string, gitR git.Repository, creds
 }
 
 // cloneGitRepositoryInBranch clone git repository with a specific branch checking if that branch exists already
-func cloneGitRepositoryInBranch(appName string, repoUrl string, creds transport.AuthMethod, tempRoot string, gitConfBranch string) (*git.Worktree, error) {
-	gitR, err := cloneRepository(appName, repoUrl, creds, tempRoot)
+func cloneGitRepositoryInBranch(appName string, repoURL string, creds transport.AuthMethod, tempRoot string, gitConfBranch string) (*git.Worktree, error) {
+	gitR, err := cloneRepository(appName, repoURL, creds, tempRoot)
 	if err != nil {
 		return nil, err
 	}
@@ -291,7 +291,7 @@ func commitChangesGit(cfg HelmUpdaterConfig, write changeWriter) (*[]ChangeEntry
 		return nil, fmt.Errorf("could not get creds for repo '%s': %v", cfg.AppName, err)
 	}
 
-	tempRoot, err := CreateTempFileInDirectory(fmt.Sprintf("git-%s", cfg.AppName), cfg.AppName, cfg.GitConf.RepoURL)
+	tempRoot, err := createTempFileInDirectory(fmt.Sprintf("git-%s", cfg.AppName), cfg.AppName, cfg.GitConf.RepoURL)
 	if err != nil {
 		return nil, err
 	}

internal/app/utils/capture.go

@@ -5,6 +5,7 @@ import (
 	"os"
 )
 
+// CaptureStdout get the stdout output
 func CaptureStdout(callback func()) (string, error) {
 	oldStdout := os.Stdout
 	oldStderr := os.Stderr
@@ -30,6 +31,7 @@ func CaptureStdout(callback func()) (string, error) {
 	return string(data), err
 }
 
+// CaptureStderr get the error output
 func CaptureStderr(callback func()) (string, error) {
 	oldStdout := os.Stdout
 	oldStderr := os.Stderr

internal/app/utils/route_utils.go

@@ -6,7 +6,7 @@ import (
 	"strings"
 )
 
-// UpdateApplication get the relative path folder based in number of relative paths indicated
+// GetRouteRelativePath get the relative path folder based in number of relative paths indicated
 func GetRouteRelativePath(numRelativePath int, relativePath string) (*string, error) {
 	wd, err := os.Getwd()
 	if err != nil {