refactor: segregate errors, config file not found interface

Author: spacez320

errors.go

@@ -0,0 +1,84 @@
+package viper
+
+import (
+	"fmt"
+)
+
+/* ConfigFileNotFoundError types */
+
+// For matching on any ConfigFileNotFoundFrom*Error
+type ConfigFileNotFoundError interface {
+	Error() string
+	Name() string
+	Locations() string
+}
+
+// ConfigFileNotFoundError denotes failing to find configuration file.
+type ConfigFileNotFoundFromFinderError struct {
+	name, locations string
+}
+
+// Error returns the formatted configuration error.
+func (fnfe ConfigFileNotFoundFromFinderError) Error() string {
+	message := fmt.Sprintf("Config file %q Not Found", fnfe.name)
+	if fnfe.locations != "" {
+		message += fmt.Sprintf(" in %q", fnfe.locations)
+	}
+
+	return message
+}
+
+func (fnfe ConfigFileNotFoundFromFinderError) Name() string {
+	return fnfe.name
+}
+
+func (fnfe ConfigFileNotFoundFromFinderError) Locations() string {
+	return fnfe.locations
+}
+
+// ConfigFileNotFoundError denotes failing to find configuration file.
+type ConfigFileNotFoundFromReadError struct {
+	name string
+}
+
+// Error returns the formatted configuration error.
+func (fnfe ConfigFileNotFoundFromReadError) Error() string {
+	return fmt.Sprintf("Config file %q Not Found", fnfe.name)
+}
+
+func (fnfe ConfigFileNotFoundFromReadError) Name() string {
+	return fnfe.name
+}
+
+func (fnfe ConfigFileNotFoundFromReadError) Locations() string {
+	return ""
+}
+
+/* Other error types */
+
+// ConfigFileAlreadyExistsError denotes failure to write new configuration file.
+type ConfigFileAlreadyExistsError string
+
+// Error returns the formatted error when configuration already exists.
+func (faee ConfigFileAlreadyExistsError) Error() string {
+	return fmt.Sprintf("Config File %q Already Exists", string(faee))
+}
+
+// ConfigMarshalError happens when failing to marshal the configuration.
+type ConfigMarshalError struct {
+	err error
+}
+
+// Error returns the formatted configuration error.
+func (e ConfigMarshalError) Error() string {
+	return fmt.Sprintf("While marshaling config: %s", e.err.Error())
+}
+
+// UnsupportedConfigError denotes encountering an unsupported
+// configuration filetype.
+type UnsupportedConfigError string
+
+// Error returns the formatted configuration error.
+func (str UnsupportedConfigError) Error() string {
+	return fmt.Sprintf("Unsupported Config Type %q", string(str))
+}

file.go

@@ -50,7 +50,7 @@ func (v *Viper) findConfigFileWithFinder(finder Finder) (string, error) {
 	}
 
 	if len(results) == 0 {
-		return "", ConfigFileNotFoundError{
+		return "", ConfigFileNotFoundFromFinderError{
 			name: v.configName, locations: fmt.Sprintf("%s", v.configPaths),
 		}
 	}
@@ -71,7 +71,7 @@ func (v *Viper) findConfigFileOld() (string, error) {
 			return file, nil
 		}
 	}
-	return "", ConfigFileNotFoundError{
+	return "", ConfigFileNotFoundFromFinderError{
 		name: v.configName, locations: fmt.Sprintf("%s", v.configPaths),
 	}
 }

viper.go

@@ -44,54 +44,12 @@ import (
 	"github.com/spf13/viper/internal/features"
 )
 
-// ConfigMarshalError happens when failing to marshal the configuration.
-type ConfigMarshalError struct {
-	err error
-}
-
-// Error returns the formatted configuration error.
-func (e ConfigMarshalError) Error() string {
-	return fmt.Sprintf("While marshaling config: %s", e.err.Error())
-}
-
 var v *Viper
 
 func init() {
 	v = New()
 }
 
-// UnsupportedConfigError denotes encountering an unsupported
-// configuration filetype.
-type UnsupportedConfigError string
-
-// Error returns the formatted configuration error.
-func (str UnsupportedConfigError) Error() string {
-	return fmt.Sprintf("Unsupported Config Type %q", string(str))
-}
-
-// ConfigFileNotFoundError denotes failing to find configuration file.
-type ConfigFileNotFoundError struct {
-	name, locations string
-}
-
-// Error returns the formatted configuration error.
-func (fnfe ConfigFileNotFoundError) Error() string {
-	message := fmt.Sprintf("Config file %q Not Found", fnfe.name)
-	if fnfe.locations != "" {
-		message += fmt.Sprintf(" in %q", fnfe.locations)
-	}
-
-	return message
-}
-
-// ConfigFileAlreadyExistsError denotes failure to write new configuration file.
-type ConfigFileAlreadyExistsError string
-
-// Error returns the formatted error when configuration already exists.
-func (faee ConfigFileAlreadyExistsError) Error() string {
-	return fmt.Sprintf("Config File %q Already Exists", string(faee))
-}
-
 // A DecoderConfigOption can be passed to viper.Unmarshal to configure
 // mapstructure.DecoderConfig options.
 type DecoderConfigOption func(*mapstructure.DecoderConfig)
@@ -1537,7 +1495,7 @@ func (v *Viper) ReadInConfig() error {
 		return err
 	}
 	if !exists {
-		return ConfigFileNotFoundError{name: filename, locations: ""}
+		return ConfigFileNotFoundFromReadError{name: filename}
 	}
 	file, err := afero.ReadFile(v.fs, filename)
 	if err != nil {

viper_test.go

@@ -1583,7 +1583,7 @@ func TestWrongConfigWithSetConfigFileNotFound(t *testing.T) {
 	v.SetConfigFile(`whatareyoutalkingabout.yaml`)
 
 	err := v.ReadInConfig()
-	assert.IsType(t, ConfigFileNotFoundError{name: "", locations: ""}, err)
+	assert.IsType(t, ConfigFileNotFoundFromReadError{}, err)
 
 	// Even though config did not load and the error might have
 	// been ignored by the client, the default still loads
@@ -1669,7 +1669,7 @@ func TestWrongDirsSearchNotFound(t *testing.T) {
 	v.AddConfigPath(`thispathaintthere`)
 
 	err := v.ReadInConfig()
-	assert.IsType(t, ConfigFileNotFoundError{name: "", locations: ""}, err)
+	assert.IsType(t, ConfigFileNotFoundFromFinderError{name: "", locations: ""}, err)
 
 	// Even though config did not load and the error might have
 	// been ignored by the client, the default still loads
@@ -1687,7 +1687,7 @@ func TestWrongDirsSearchNotFoundForMerge(t *testing.T) {
 	v.AddConfigPath(`thispathaintthere`)
 
 	err := v.MergeInConfig()
-	assert.Equal(t, reflect.TypeOf(ConfigFileNotFoundError{name: "", locations: ""}), reflect.TypeOf(err))
+	assert.Equal(t, reflect.TypeOf(ConfigFileNotFoundFromFinderError{name: "", locations: ""}), reflect.TypeOf(err))
 
 	// Even though config did not load and the error might have
 	// been ignored by the client, the default still loads