From 77069ca16bf2b7bbf4e0ab6a82e57e2356a0a370 Mon Sep 17 00:00:00 2001
From: Xiang Li <xiangli.cs@gmail.com>
Date: Wed, 2 Dec 2015 14:21:15 -0800
Subject: [PATCH] pkg/fileutil: make purgeTest more robust

1. Add a few comments to the test.

2. Provide a more robust way to check the purging
result. Tolerate slow io operations.
---
 pkg/fileutil/purge_test.go | 23 ++++++++++++++++++++---
 1 file changed, 20 insertions(+), 3 deletions(-)

diff --git a/pkg/fileutil/purge_test.go b/pkg/fileutil/purge_test.go
index 0b11b23a5..a7b41b9e6 100644
--- a/pkg/fileutil/purge_test.go
+++ b/pkg/fileutil/purge_test.go
@@ -39,7 +39,11 @@ func TestPurgeFile(t *testing.T) {
 	}
 
 	stop := make(chan struct{})
+
+	// keep at most 3 most recent files
 	errch := PurgeFile(dir, "test", 3, time.Millisecond, stop)
+
+	// create 5 more files
 	for i := 5; i < 10; i++ {
 		_, err = os.Create(path.Join(dir, fmt.Sprintf("%d.test", i)))
 		if err != nil {
@@ -47,14 +51,27 @@ func TestPurgeFile(t *testing.T) {
 		}
 		time.Sleep(10 * time.Millisecond)
 	}
-	fnames, err := ReadDir(dir)
-	if err != nil {
-		t.Fatal(err)
+
+	// purge routine should purge 7 out of 10 files and only keep the
+	// 3 most recent ones.
+	// wait for purging for at most 100ms.
+	var fnames []string
+	for i := 0; i < 10; i++ {
+		fnames, err = ReadDir(dir)
+		if err != nil {
+			t.Fatal(err)
+		}
+		if len(fnames) <= 3 {
+			break
+		}
+		time.Sleep(10 * time.Millisecond)
 	}
 	wnames := []string{"7.test", "8.test", "9.test"}
 	if !reflect.DeepEqual(fnames, wnames) {
 		t.Errorf("filenames = %v, want %v", fnames, wnames)
 	}
+
+	// no error should be reported from purge routine
 	select {
 	case err := <-errch:
 		t.Errorf("unexpected purge error %v", err)