Ignore unknown config files in config dir
authorBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>
Fri, 1 Feb 2019 06:45:35 +0000 (07:45 +0100)
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>
Fri, 1 Feb 2019 06:47:40 +0000 (07:47 +0100)
Swap files etc.

Fixes #5646

config/configLoader.go
config/configLoader_test.go [new file with mode: 0644]
hugolib/config.go
hugolib/configdir_test.go

index f2265dc6a88d39f90a4574dd158114e176a1e86c..b8aa3fda38b0c8b2b1286d9e4e1fa6f174b439ff 100644 (file)
@@ -14,6 +14,9 @@
 package config
 
 import (
+       "path/filepath"
+       "strings"
+
        "github.com/gohugoio/hugo/common/maps"
        "github.com/gohugoio/hugo/parser/metadecoders"
        "github.com/spf13/afero"
@@ -21,9 +24,23 @@ import (
 )
 
 var (
-       ValidConfigFileExtensions = []string{"toml", "yaml", "yml", "json"}
+       ValidConfigFileExtensions                    = []string{"toml", "yaml", "yml", "json"}
+       validConfigFileExtensionsMap map[string]bool = make(map[string]bool)
 )
 
+func init() {
+       for _, ext := range ValidConfigFileExtensions {
+               validConfigFileExtensionsMap[ext] = true
+       }
+}
+
+// IsValidConfigFilename returns whether filename is one of the supported
+// config formats in Hugo.
+func IsValidConfigFilename(filename string) bool {
+       ext := strings.ToLower(strings.TrimPrefix(filepath.Ext(filename), "."))
+       return validConfigFileExtensionsMap[ext]
+}
+
 // FromConfigString creates a config from the given YAML, JSON or TOML config. This is useful in tests.
 func FromConfigString(config, configType string) (Provider, error) {
        v := newViper()
diff --git a/config/configLoader_test.go b/config/configLoader_test.go
new file mode 100644 (file)
index 0000000..06a00df
--- /dev/null
@@ -0,0 +1,34 @@
+// Copyright 2019 The Hugo Authors. All rights reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package config
+
+import (
+       "strings"
+       "testing"
+
+       "github.com/stretchr/testify/require"
+)
+
+func TestIsValidConfigFileName(t *testing.T) {
+       assert := require.New(t)
+
+       for _, ext := range ValidConfigFileExtensions {
+               filename := "config." + ext
+               assert.True(IsValidConfigFilename(filename), ext)
+               assert.True(IsValidConfigFilename(strings.ToUpper(filename)))
+       }
+
+       assert.False(IsValidConfigFilename(""))
+       assert.False(IsValidConfigFilename("config.toml.swp"))
+}
index 5b56333df852105c80162472d7a2e620d293686d..6a1de32beecaad55724f2a8e3f327eebf07eb17a 100644 (file)
@@ -283,6 +283,10 @@ func (l configLoader) loadConfigFromConfigDir(v *viper.Viper) ([]string, error)
                                return nil
                        }
 
+                       if !config.IsValidConfigFilename(path) {
+                               return nil
+                       }
+
                        name := helpers.Filename(filepath.Base(path))
 
                        item, err := metadecoders.Default.UnmarshalFileToMap(sourceFs, path)
index 80fcda61fbdccbdf8979a3d1f4ec434bd431ecf9..c1afbb14e37b31d8bb994206b3a65c6d76c35f78 100644 (file)
@@ -97,7 +97,9 @@ p3 = "p3params_no_production"
        fb = fb.WithWorkingDir("config/development")
 
        // This is set in all the config.toml variants above, but this will win.
-       fb.Add("config.toml", `paginatePath = "pag_development"`)
+       fb.Add("config.TOML", `paginatePath = "pag_development"`)
+       // Issue #5646
+       fb.Add("config.toml.swp", `p3 = "paginatePath = "nono"`)
 
        fb.Add("params.no.toml", `p3 = "p3params_no_development"`)
        fb.Add("params.toml", `p3 = "p3params_development"`)