Allow dotfiles to be ignored. (#17)

Author: BenPope

README.md

@@ -106,10 +106,11 @@ import (
 
 // for full docs on gostats visit https://github.com/lyft/gostats
 store := stats.NewDefaultStore()
-runtime := loader.New("runtime_path", "runtime_subdirectory", store.Scope("runtime"), &DirectoryRefresher{})
+runtime := loader.New("runtime_path", "runtime_subdirectory", store.Scope("runtime"), &DirectoryRefresher{}, AllowDotFiles)
 ```
 
 The Loader will use filesystem events to update the filesystem snapshot it has.
+Dotfiles can be allowed by passing `AllowDotFiles` or ignored by passing `IgnoreDotFiles`.
 
 #### Snapshot
 
@@ -160,7 +161,7 @@ And the runtime loader is setup like so:
 
 ```Go
 store := stats.NewDefaultStore()
-runtime := loader.New("/runtime", "config", stats.Scope("runtime"))
+runtime := loader.New("/runtime", "config", stats.Scope("runtime"), AllowDotFiles)
 ```
 
 The values in all three files can be obtained the following way:

loader/loader.go

@@ -40,6 +40,7 @@ type Loader struct {
 	updateLock      sync.RWMutex
 	callbacks       []chan<- int
 	stats           loaderStats
+	ignoreDotfiles  bool
 }
 
 func (l *Loader) Snapshot() snapshot.IFace {
@@ -90,7 +91,15 @@ func (l *Loader) walkDirectoryCallback(path string, info os.FileInfo, err error)
 	}
 
 	logger.Debugf("runtime: processing %s", path)
+	if l.ignoreDotfiles && info.IsDir() && strings.HasPrefix(info.Name(), ".") {
+		return filepath.SkipDir
+	}
+
 	if !info.IsDir() {
+		if l.ignoreDotfiles && strings.HasPrefix(info.Name(), ".") {
+			return nil
+		}
+
 		contents, err := ioutil.ReadFile(path)
 
 		if err != nil {
@@ -148,7 +157,12 @@ func getFileSystemOp(ev fsnotify.Event) FileSystemOp {
 	return -1
 }
 
-func New(runtimePath string, runtimeSubdirectory string, scope stats.Scope, refresher Refresher) IFace {
+const (
+	AllowDotFiles  = false
+	IgnoreDotFiles = true
+)
+
+func New(runtimePath string, runtimeSubdirectory string, scope stats.Scope, refresher Refresher, ignoreDotfiles bool) IFace {
 	if runtimePath == "" || runtimeSubdirectory == "" {
 		logger.Warnf("no runtime configuration. using nil loader.")
 		return NewNil()
@@ -168,7 +182,7 @@ func New(runtimePath string, runtimeSubdirectory string, scope stats.Scope, refr
 
 	newLoader := Loader{
 		watcher, runtimePath, runtimeSubdirectory, nil, nil, sync.RWMutex{}, nil,
-		newLoaderStats(scope)}
+		newLoaderStats(scope), ignoreDotfiles}
 	newLoader.onRuntimeChanged()
 
 	go func() {

loader/loader_test.go

@@ -33,7 +33,7 @@ func makeFileInDir(assert *require.Assertions, path string, text string) {
 func TestNilRuntime(t *testing.T) {
 	assert := require.New(t)
 
-	loader := New("", "", nullScope, &SymlinkRefresher{RuntimePath: ""})
+	loader := New("", "", nullScope, &SymlinkRefresher{RuntimePath: ""}, AllowDotFiles)
 	snapshot := loader.Snapshot()
 	assert.Equal("", snapshot.Get("foo"))
 	assert.Equal(uint64(100), snapshot.GetInteger("bar", 100))
@@ -57,7 +57,7 @@ func TestSymlinkRefresher(t *testing.T) {
 	err = os.Symlink(tempDir+"/testdir1", tempDir+"/current")
 	assert.NoError(err)
 
-	loader := New(tempDir+"/current", "app", nullScope, &SymlinkRefresher{RuntimePath: tempDir + "/current"})
+	loader := New(tempDir+"/current", "app", nullScope, &SymlinkRefresher{RuntimePath: tempDir + "/current"}, AllowDotFiles)
 	runtime_update := make(chan int)
 	loader.AddUpdateCallback(runtime_update)
 	snapshot := loader.Snapshot()
@@ -101,6 +101,30 @@ func TestSymlinkRefresher(t *testing.T) {
 	assert.EqualValues([]string{"dir.file2", "dir2.file3", "file1"}, keys)
 }
 
+func TestIgnoreDotfiles(t *testing.T) {
+	assert := require.New(t)
+
+	// Setup base test directory.
+	tempDir, err := ioutil.TempDir("", "runtime_test")
+	assert.NoError(err)
+	defer os.RemoveAll(tempDir)
+
+	// Make test files for runtime snapshot.
+	makeFileInDir(assert, tempDir+"/testdir1/app/dir3/.file4", ".file4")
+	makeFileInDir(assert, tempDir+"/testdir1/app/.dir/file5", ".dir")
+	assert.NoError(err)
+
+	loaderIgnoreDotfiles := New(tempDir+"/testdir1", "app", nullScope, &SymlinkRefresher{RuntimePath: tempDir + "/testdir1"}, IgnoreDotFiles)
+	snapshot := loaderIgnoreDotfiles.Snapshot()
+	assert.Equal("", snapshot.Get("dir3..file4"))
+	assert.Equal("", snapshot.Get(".dir.file5"))
+
+	loaderIncludeDotfiles := New(tempDir+"/testdir1", "app", nullScope, &SymlinkRefresher{RuntimePath: tempDir + "/testdir1"}, AllowDotFiles)
+	snapshot = loaderIncludeDotfiles.Snapshot()
+	assert.Equal(".file4", snapshot.Get("dir3..file4"))
+	assert.Equal(".dir", snapshot.Get(".dir.file5"))
+}
+
 func TestDirectoryRefresher(t *testing.T) {
 	assert := require.New(t)
 
@@ -113,7 +137,7 @@ func TestDirectoryRefresher(t *testing.T) {
 	err = os.MkdirAll(appDir, os.ModeDir|os.ModePerm)
 	assert.NoError(err)
 
-	loader := New(tempDir, "app", nullScope, &DirectoryRefresher{})
+	loader := New(tempDir, "app", nullScope, &DirectoryRefresher{}, AllowDotFiles)
 	runtime_update := make(chan int)
 	loader.AddUpdateCallback(runtime_update)
 	snapshot := loader.Snapshot()