feat(cleaner): write unit test for cleaner

Author: smothiki

boot.go

@@ -74,7 +74,7 @@ func main() {
 				log.Printf("Starting deleted app cleaner")
 				cleanerErrCh := make(chan error)
 				go func() {
-					if err := cleaner.Run(gitHomeDir, kubeClient.Namespaces()); err != nil {
+					if err := cleaner.Run(gitHomeDir, kubeClient.Namespaces(), fs); err != nil {
 						cleanerErrCh <- err
 					}
 				}()

pkg/cleaner/cleaner.go

@@ -3,34 +3,38 @@ package cleaner
 
 import (
 	"log"
-	"os"
 
 	"k8s.io/kubernetes/pkg/api"
 
 	"github.com/deis/builder/pkg/k8s"
+	"github.com/deis/builder/pkg/sys"
 )
 
 const (
 	dotGitSuffix = ".git"
 )
 
-// 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.NamespaceWatcher) error {
-
+// Run starts the deleted app cleaner. This function listens to the Kubernetes event stream for events that indicate namespaces that were `DELETED`.
+// If the namespace name matches a folder on the local filesystem, this func deletes that folder.
+// Note that this function blocks until the watcher returned by `nsLister.Watch` is closed, so you should launch it in a goroutine.
+func Run(gitHome string, nsLister k8s.NamespaceWatcher, fs sys.FS) error {
 	watcher, err := nsLister.Watch(nil, nil, "")
 	if err != nil {
 		log.Printf("unable to get watch events (%s)", err)
 	}
 	for {
 		event := <-watcher.ResultChan()
 		if event.Type == "DELETED" {
-			namespace := event.Object.(*api.Namespace)
-			appToDelete := gitHome + "/" + namespace.ObjectMeta.Name + dotGitSuffix
-			if err := os.RemoveAll(appToDelete); err != nil {
-				log.Printf("Cleaner error removing deleted app %s (%s)", appToDelete, err)
+			switch event.Object.(type) {
+			case (*api.Namespace):
+				namespace := event.Object.(*api.Namespace)
+				appToDelete := gitHome + "/" + namespace.ObjectMeta.Name + dotGitSuffix
+				if err := fs.RemoveAll(appToDelete); err != nil {
+					log.Printf("Cleaner error removing deleted app %s (%s)", appToDelete, err)
+				}
+			default:
 			}
 		}
-
 	}
 
 }

pkg/cleaner/cleaner_test.go

@@ -0,0 +1,60 @@
+package cleaner
+
+import (
+	"testing"
+
+	"time"
+
+	"github.com/deis/builder/pkg/sys"
+	"k8s.io/kubernetes/pkg/api"
+	"k8s.io/kubernetes/pkg/fields"
+	"k8s.io/kubernetes/pkg/labels"
+	"k8s.io/kubernetes/pkg/watch"
+)
+
+type namespace struct {
+}
+
+// Watch returns a watch.Interface that watches the requested namespaces.
+func (r *namespace) Watch(label labels.Selector, field fields.Selector, resourceversion string) (watch.Interface, error) {
+	nst := watch.NewFake()
+	go func() {
+		nst.Add(&api.Namespace{ObjectMeta: api.ObjectMeta{Name: "dir1"}})
+		nst.Modify(&api.Namespace{ObjectMeta: api.ObjectMeta{Name: "dir1"}})
+		nst.Delete(&api.Namespace{ObjectMeta: api.ObjectMeta{Name: "dir1"}})
+		nst.Modify(&api.Namespace{ObjectMeta: api.ObjectMeta{Name: "dir2"}})
+		nst.Delete(nil)
+		nst.Add(&api.Pod{ObjectMeta: api.ObjectMeta{Name: "dir3"}})
+		nst.Delete(&api.Pod{ObjectMeta: api.ObjectMeta{Name: "dir3"}})
+		nst.Stop()
+	}()
+	return nst, nil
+}
+
+func (r *namespace) IsAnAPIObject() {}
+
+func TestCleanerRun(t *testing.T) {
+	ns := &namespace{}
+	fs := sys.NewFakeFS()
+	dirhome := "/home/git"
+	fs.Files["/home/git/dir1.git"] = []byte{}
+	fs.Files["/home/git/dir2.git"] = []byte{}
+	fs.Files["/home/git/dir3.git"] = []byte{}
+	go Run(dirhome, ns, fs)
+	time.Sleep(5 * time.Second)
+	// Namespace with name dir1 got deleted directory should be deleted
+	_, ok := fs.Files["/home/git/dir1.git"]
+	if ok {
+		t.Fatal("Test failed: Deleting a namespace should delete respective direcotry")
+	}
+	// Namespace with name dir2 got modified directory should not be deleted
+	_, ok = fs.Files["/home/git/dir2.git"]
+	if !ok {
+		t.Fatal("Test failed: Modyfiying a namespace should not delete respective direcotry")
+	}
+	// Pod with name dir3 got deleted directory should not be deleted
+	_, ok = fs.Files["/home/git/dir3.git"]
+	if !ok {
+		t.Fatal("Test failed: Deleting a pod should not delete respective direcotry")
+	}
+}

pkg/sys/fs.go

@@ -3,12 +3,14 @@ package sys
 import (
 	"fmt"
 	"io/ioutil"
+	"os"
 )
 
 // FS is the interface to a file system
 type FS interface {
 	// ReadAll gets the contents of filename, or an error if the file didn't exist or there was an error reading it
 	ReadFile(filename string) ([]byte, error)
+	RemoveAll(name string) error
 }
 
 // RealFS returns an FS object that interacts with the real local filesystem
@@ -22,6 +24,10 @@ func (r *realFS) ReadFile(name string) ([]byte, error) {
 	return ioutil.ReadFile(name)
 }
 
+func (r *realFS) RemoveAll(name string) error {
+	return os.RemoveAll(name)
+}
+
 // FakeFileNotFound is the error returned by FakeFS when a requested file isn't found
 type FakeFileNotFound struct {
 	Filename string
@@ -47,3 +53,12 @@ func (f *FakeFS) ReadFile(name string) ([]byte, error) {
 	}
 	return b, nil
 }
+
+func (f *FakeFS) RemoveAll(name string) error {
+	_, ok := f.Files[name]
+	if !ok {
+		return FakeFileNotFound{Filename: name}
+	}
+	delete(f.Files, name)
+	return nil
+}