Merge branch 'refactor/config-err-private' into 'master'

refactor: make config validation errors private

Closes #664

See merge request gitlab-org/gitlab-pages!644

2 files changed, 24 insertions, 24 deletions

diff --git a/internal/config/validate.go b/internal/config/validate.go
index 1e6edca0..3039d00a 100644
--- a/internal/config/validate.go
+++ b/internal/config/validate.go
@@ -10,14 +10,14 @@ import (
 )
 
 var (
-	ErrNoListener                       = errors.New("no listener defined, please specify at least one --listen-* flag")
-	ErrAuthNoSecret                     = errors.New("auth-secret must be defined if authentication is supported")
-	ErrAuthNoClientID                   = errors.New("auth-client-id must be defined if authentication is supported")
-	ErrAuthNoClientSecret               = errors.New("auth-client-secret must be defined if authentication is supported")
-	ErrAuthNoGitlabServer               = errors.New("gitlab-server must be defined if authentication is supported")
-	ErrAuthNoRedirect                   = errors.New("auth-redirect-uri must be defined if authentication is supported")
-	ErrArtifactsServerUnsupportedScheme = errors.New("artifacts-server scheme must be either http:// or https://")
-	ErrArtifactsServerInvalidTimeout    = errors.New("artifacts-server-timeout must be greater than or equal to 1")
+	errNoListener                       = errors.New("no listener defined, please specify at least one --listen-* flag")
+	errAuthNoSecret                     = errors.New("auth-secret must be defined if authentication is supported")
+	errAuthNoClientID                   = errors.New("auth-client-id must be defined if authentication is supported")
+	errAuthNoClientSecret               = errors.New("auth-client-secret must be defined if authentication is supported")
+	errAuthNoGitlabServer               = errors.New("gitlab-server must be defined if authentication is supported")
+	errAuthNoRedirect                   = errors.New("auth-redirect-uri must be defined if authentication is supported")
+	errArtifactsServerUnsupportedScheme = errors.New("artifacts-server scheme must be either http:// or https://")
+	errArtifactsServerInvalidTimeout    = errors.New("artifacts-server-timeout must be greater than or equal to 1")
 )
 
 // Validate values populated in Config
@@ -39,7 +39,7 @@ func validateListeners(config *Config) error {
 		config.ListenHTTPSStrings.Len() == 0 &&
 		config.ListenHTTPSProxyv2Strings.Len() == 0 &&
 		config.ListenProxyStrings.Len() == 0 {
-		return ErrNoListener
+		return errNoListener
 	}
 
 	return nil
@@ -53,19 +53,19 @@ func validateAuthConfig(config *Config) error {
 
 	var result *multierror.Error
 	if config.Authentication.Secret == "" {
-		result = multierror.Append(result, ErrAuthNoSecret)
+		result = multierror.Append(result, errAuthNoSecret)
 	}
 	if config.Authentication.ClientID == "" {
-		result = multierror.Append(result, ErrAuthNoClientID)
+		result = multierror.Append(result, errAuthNoClientID)
 	}
 	if config.Authentication.ClientSecret == "" {
-		result = multierror.Append(result, ErrAuthNoClientSecret)
+		result = multierror.Append(result, errAuthNoClientSecret)
 	}
 	if config.GitLab.PublicServer == "" {
-		result = multierror.Append(result, ErrAuthNoGitlabServer)
+		result = multierror.Append(result, errAuthNoGitlabServer)
 	}
 	if config.Authentication.RedirectURI == "" {
-		result = multierror.Append(result, ErrAuthNoRedirect)
+		result = multierror.Append(result, errAuthNoRedirect)
 	}
 	return result.ErrorOrNil()
 }
@@ -84,11 +84,11 @@ func validateArtifactsServerConfig(config *Config) error {
 
 	// url.Parse ensures that the Scheme attribute is always lower case.
 	if u.Scheme != "http" && u.Scheme != "https" {
-		result = multierror.Append(result, ErrArtifactsServerUnsupportedScheme)
+		result = multierror.Append(result, errArtifactsServerUnsupportedScheme)
 	}
 
 	if config.ArtifactsServer.TimeoutSeconds < 1 {
-		result = multierror.Append(result, ErrArtifactsServerInvalidTimeout)
+		result = multierror.Append(result, errArtifactsServerInvalidTimeout)
 	}
 
 	return result.ErrorOrNil()
diff --git a/internal/config/validate_test.go b/internal/config/validate_test.go
index e9aca9dc..87eb26b3 100644
--- a/internal/config/validate_test.go
+++ b/internal/config/validate_test.go
@@ -16,7 +16,7 @@ func TestConfigValidate(t *testing.T) {
 		{
 			name:        "no_listeners",
 			cfg:         noListeners,
-			expectedErr: ErrNoListener,
+			expectedErr: errNoListener,
 		},
 		{
 			name: "no_auth",
@@ -25,27 +25,27 @@ func TestConfigValidate(t *testing.T) {
 		{
 			name:        "auth_no_secret",
 			cfg:         authNoSecret,
-			expectedErr: ErrAuthNoSecret,
+			expectedErr: errAuthNoSecret,
 		},
 		{
 			name:        "auth_no_client_id",
 			cfg:         authNoClientID,
-			expectedErr: ErrAuthNoClientID,
+			expectedErr: errAuthNoClientID,
 		},
 		{
 			name:        "auth_no_client_secret",
 			cfg:         authNoClientSecret,
-			expectedErr: ErrAuthNoClientSecret,
+			expectedErr: errAuthNoClientSecret,
 		},
 		{
 			name:        "auth_no_gitlab_Server",
 			cfg:         authNoPublicServer,
-			expectedErr: ErrAuthNoGitlabServer,
+			expectedErr: errAuthNoGitlabServer,
 		},
 		{
 			name:        "auth_no_redirect",
 			cfg:         authNoRedirect,
-			expectedErr: ErrAuthNoRedirect,
+			expectedErr: errAuthNoRedirect,
 		},
 		{
 			name: "artifact_no_url",
@@ -54,12 +54,12 @@ func TestConfigValidate(t *testing.T) {
 		{
 			name:        "artifact_malformed_scheme",
 			cfg:         artifactsMalformedScheme,
-			expectedErr: ErrArtifactsServerUnsupportedScheme,
+			expectedErr: errArtifactsServerUnsupportedScheme,
 		},
 		{
 			name:        "artifact_invalid_timeout",
 			cfg:         artifactsInvalidTimeout,
-			expectedErr: ErrArtifactsServerInvalidTimeout,
+			expectedErr: errArtifactsServerInvalidTimeout,
 		},
 	}
 	for _, tt := range tests {