feat(lock): change cleaner code to listen to k8s namespace events

Author: smothiki

boot.go

@@ -49,7 +49,6 @@ func main() {
 					os.Exit(1)
 				}
 				pushLock := sshd.NewInMemoryRepositoryLock()
-				cleanerRef := cleaner.NewRef()
 				circ := sshd.NewCircuit()
 
 				s3Client, err := storage.GetClient(cnf.HealthSrvTestStorageRegion)
@@ -72,15 +71,15 @@ func main() {
 				log.Printf("Starting deleted app cleaner")
 				cleanerErrCh := make(chan error)
 				go func() {
-					if err := cleanerRef.Run(gitHomeDir, kubeClient.Namespaces(), cnf.CleanerPollSleepDuration()); err != nil {
+					if err := cleaner.Run(gitHomeDir, kubeClient.Namespaces()); err != nil {
 						cleanerErrCh <- err
 					}
 				}()
 
 				log.Printf("Starting SSH server on %s:%d", cnf.SSHHostIP, cnf.SSHHostPort)
 				sshCh := make(chan int)
 				go func() {
-					sshCh <- pkg.RunBuilder(cnf.SSHHostIP, cnf.SSHHostPort, gitHomeDir, circ, pushLock, cleanerRef)
+					sshCh <- pkg.RunBuilder(cnf.SSHHostIP, cnf.SSHHostPort, gitHomeDir, circ, pushLock)
 				}()
 
 				select {

pkg/builder.go

@@ -10,7 +10,6 @@ import (
 
 	"github.com/Masterminds/cookoo"
 	clog "github.com/Masterminds/cookoo/log"
-	"github.com/deis/builder/pkg/cleaner"
 	"github.com/deis/builder/pkg/sshd"
 )
 
@@ -28,7 +27,7 @@ const (
 // Git.
 //
 // Run returns on of the Status* status code constants.
-func RunBuilder(sshHostIP string, sshHostPort int, gitHomeDir string, sshServerCircuit *sshd.Circuit, pushLock sshd.RepositoryLock, cleanerRef cleaner.Ref) int {
+func RunBuilder(sshHostIP string, sshHostPort int, gitHomeDir string, sshServerCircuit *sshd.Circuit, pushLock sshd.RepositoryLock) int {
 	reg, router, ocxt := cookoo.Cookoo()
 	log.SetFlags(0) // Time is captured elsewhere.
 
@@ -59,7 +58,7 @@ func RunBuilder(sshHostIP string, sshHostPort int, gitHomeDir string, sshServerC
 	// Start the SSH service.
 	// TODO: We could refactor Serve to be a command, and then run this as
 	// a route.
-	if err := sshd.Serve(reg, router, sshServerCircuit, gitHomeDir, pushLock, cleanerRef, cxt); err != nil {
+	if err := sshd.Serve(reg, router, sshServerCircuit, gitHomeDir, pushLock, cxt); err != nil {
 		clog.Errf(cxt, "SSH server failed: %s", err)
 		return StatusLocalError
 	}

pkg/cleaner/cleaner.go

@@ -2,131 +2,35 @@
 package cleaner
 
 import (
-	"io/ioutil"
 	"log"
 	"os"
-	"path/filepath"
-	"strings"
-	"sync"
-	"time"
 
-	"github.com/deis/builder/pkg/k8s"
 	"k8s.io/kubernetes/pkg/api"
-	"k8s.io/kubernetes/pkg/fields"
-	"k8s.io/kubernetes/pkg/labels"
+
+	"github.com/deis/builder/pkg/k8s"
 )
 
 const (
 	dotGitSuffix = ".git"
 )
 
-type Ref struct {
-	mut *sync.Mutex
-}
-
-func NewRef() Ref {
-	return Ref{mut: new(sync.Mutex)}
-}
-
-func (c Ref) Lock() {
-	c.mut.Lock()
-}
-
-func (c Ref) Unlock() {
-	c.mut.Unlock()
-}
+// 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 {
 
-// 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)
+	watcher, err := nsLister.Watch(nil, nil, "")
 	if err != nil {
-		return nil, err
-	}
-	var ret []string
-	for _, fileInfo := range fileInfos {
-		nm := fileInfo.Name()
-		if len(nm) <= 0 || nm == "." || !fileInfo.IsDir() {
-			continue
-		}
-		if filter(nm) {
-			ret = append(ret, filepath.Join(gitHome, nm))
-		}
-	}
-	return ret, nil
-}
-
-// getDiff gets the directories that are not in namespaceList
-func getDiff(namespaceList []api.Namespace, dirs []string) []string {
-	var ret []string
-
-	// create a set of lowercase namespace names
-	namespacesSet := make(map[string]struct{})
-	for _, ns := range namespaceList {
-		lowerName := strings.ToLower(ns.Name)
-		namespacesSet[lowerName] = struct{}{}
+		log.Printf("unable to get watch events (%s)", err)
 	}
-
-	// get dirs not in the namespaces set
-	for _, dir := range dirs {
-		lowerName := strings.ToLower(dir)
-		if _, ok := namespacesSet[lowerName]; !ok {
-			ret = append(ret, lowerName)
-		}
-	}
-
-	return ret
-}
-
-func stripSuffixes(strs []string, suffix string) []string {
-	ret := make([]string, len(strs))
-	for i, str := range strs {
-		idx := strings.LastIndex(str, suffix)
-		if idx >= 0 {
-			ret[i] = str[:idx]
-		} else {
-			ret[i] = str
-		}
-	}
-	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 (c Ref) Run(gitHome string, nsLister k8s.NamespaceLister, pollSleepDuration time.Duration) error {
 	for {
-		nsList, err := nsLister.List(labels.Everything(), fields.Everything())
-		if err != nil {
-			log.Printf("Cleaner error listing namespaces (%s)", err)
-			continue
-		} else {
-			lst := make([]string, len(nsList.Items))
-			for i, ns := range nsList.Items {
-				lst[i] = strings.ToLower(ns.Name)
+		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)
 			}
 		}
 
-		gitDirs, err := localDirs(gitHome, dirHasGitSuffix)
-		if err != nil {
-			log.Printf("Cleaner error listing local git directories (%s)", err)
-			continue
-		}
-
-		gitDirs = stripSuffixes(gitDirs, dotGitSuffix)
-
-		appsToDelete := getDiff(nsList.Items, gitDirs)
-
-		for _, appToDelete := range appsToDelete {
-			dirToDelete := appToDelete + dotGitSuffix
-			c.Lock()
-			if err := os.RemoveAll(dirToDelete); err != nil {
-				log.Printf("Cleaner error removing deleted app %s (%s)", dirToDelete, err)
-			}
-			c.Unlock()
-		}
-
-		time.Sleep(pollSleepDuration)
 	}
+
 }

pkg/cleaner/cleaner_test.go

@@ -4,6 +4,7 @@ import (
 	"k8s.io/kubernetes/pkg/api"
 	"k8s.io/kubernetes/pkg/fields"
 	"k8s.io/kubernetes/pkg/labels"
+	"k8s.io/kubernetes/pkg/watch"
 )
 
 // NamespaceLister is a (k8s.io/kubernetes/pkg/client/unversioned).NamespaceInterface compatible interface which only has the List function. It's used in places that only need List to make them easier to test and more easily swappable with other implementations.
@@ -14,4 +15,10 @@ import (
 //	nsl = kubeClient.Namespaces()
 type NamespaceLister interface {
 	List(labels.Selector, fields.Selector) (*api.NamespaceList, error)
+
+}
+
+
+type NamespaceWatcher interface{
+	Watch(label labels.Selector, field fields.Selector, resourceVersion string) (watch.Interface, error)
 }