fix(pkg/cleaner): refactor localDirs to accept a filter function

and use it to return only directories with the git suffix in them

Author: Aaron Schlesinger

pkg/cleaner/cleaner.go

@@ -20,7 +20,8 @@ const (
 	dotGitSuffix = ".git"
 )
 
-func localDirs(gitHome string) ([]string, error) {
+// localDirs returns all of the local directories immediately under gitHome that filter returns true for. filter will receive only the names of each of the top level directories (not their fully qualified paths), and should return true if it should be included in the output
+func localDirs(gitHome string, filter func(string) bool) ([]string, error) {
 	fileInfos, err := ioutil.ReadDir(gitHome)
 	if err != nil {
 		return nil, err
@@ -31,7 +32,9 @@ func localDirs(gitHome string) ([]string, error) {
 		if len(nm) <= 0 || nm == "." || !fileInfo.IsDir() {
 			continue
 		}
-		ret = append(ret, filepath.Join(gitHome, nm))
+		if filter(nm) {
+			ret = append(ret, filepath.Join(gitHome, nm))
+		}
 	}
 	return ret, nil
 }
@@ -71,6 +74,10 @@ func stripSuffixes(strs []string, suffix string) []string {
 	return ret
 }
 
+func dirHasGitSuffix(dir string) bool {
+	return strings.HasSuffix(dir, dotGitSuffix)
+}
+
 // Run starts the deleted app cleaner. Every pollSleepDuration, it compares the result of nsLister.List with the directories in the top level of gitHome on the local file system. On any error, it uses log messages to output a human readable description of what happened.
 func Run(gitHome string, nsLister k8s.NamespaceLister, repoLock sshd.RepositoryLock, pollSleepDuration time.Duration) error {
 	for {
@@ -86,7 +93,7 @@ func Run(gitHome string, nsLister k8s.NamespaceLister, repoLock sshd.RepositoryL
 			log.Printf("Cleaner found namespaces %s", lst)
 		}
 
-		gitDirs, err := localDirs(gitHome)
+		gitDirs, err := localDirs(gitHome, dirHasGitSuffix)
 		if err != nil {
 			log.Printf("Cleaner error listing local git directories (%s)", err)
 			continue

pkg/cleaner/cleaner_test.go

@@ -20,12 +20,20 @@ func TestGetDiff(t *testing.T) {
 	assert.Equal(t, len(diff), 1, "number of items in the disjunction")
 }
 
+func TestDirHasGitSuffix(t *testing.T) {
+	assert.True(t, dirHasGitSuffix("a.git"), "'a.git' reported no git suffix")
+	assert.False(t, dirHasGitSuffix("abc"), "'a' reported git suffix")
+}
+
 func TestLocalDirs(t *testing.T) {
 	wd, err := os.Getwd()
 	assert.NoErr(t, err)
 	pkgDir, err := filepath.Abs(wd + "/..")
 	assert.NoErr(t, err)
-	lDirs, err := localDirs(pkgDir)
+	lDirs, err := localDirs(pkgDir, func(dir string) bool {
+		// no directories with any dots in them
+		return len(strings.Split(dir, ".")) == 1
+	})
 	assert.NoErr(t, err)
 
 	expectedPackages := map[string]int{