From 7decf4a0eec957575cd2470ed241cdba13237f47 Mon Sep 17 00:00:00 2001
From: Simon Pasquier <spasquie@redhat.com>
Date: Fri, 15 Feb 2019 10:38:45 +0100
Subject: [PATCH] storage/remote: adapt tests for Travis CI

Signed-off-by: Simon Pasquier <spasquie@redhat.com>
---
 .travis.yml                        |  1 +
 storage/remote/wal_watcher.go      |  2 +-
 storage/remote/wal_watcher_test.go | 97 +++++++++++++-----------------
 3 files changed, 43 insertions(+), 57 deletions(-)

diff --git a/.travis.yml b/.travis.yml
index bb704e9cd4..231bfcac97 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -10,5 +10,6 @@ go:
 go_import_path: github.com/prometheus/prometheus
 
 script:
+- go test -race -v ./storage/remote/...
 - make check_license style unused test staticcheck check_assets
 - git diff --exit-code
diff --git a/storage/remote/wal_watcher.go b/storage/remote/wal_watcher.go
index 0568fc14bd..b3e93dcb46 100644
--- a/storage/remote/wal_watcher.go
+++ b/storage/remote/wal_watcher.go
@@ -276,7 +276,7 @@ func (w *WALWatcher) runWatcher() {
 	}
 }
 
-// Use tail true to indicate thatreader is currently on a segment that is
+// Use tail true to indicate that the reader is currently on a segment that is
 // actively being written to. If false, assume it's a full segment and we're
 // replaying it on start to cache the series records.
 func (w *WALWatcher) watch(wl *wal.WAL, reader *wal.LiveReader, tail bool) error {
diff --git a/storage/remote/wal_watcher_test.go b/storage/remote/wal_watcher_test.go
index f16c8f0ce8..e89583ea7c 100644
--- a/storage/remote/wal_watcher_test.go
+++ b/storage/remote/wal_watcher_test.go
@@ -31,6 +31,23 @@ import (
 	"github.com/prometheus/tsdb/wal"
 )
 
+var defaultRetry = 100 * time.Millisecond
+
+// retry executes f() n times at each interval until it returns true.
+func retry(t *testing.T, interval time.Duration, n int, f func() bool) {
+	t.Helper()
+	ticker := time.NewTicker(interval)
+	for i := 0; i <= n; i++ {
+		if f() {
+			return
+		}
+		t.Logf("retry %d/%d", i, n)
+		<-ticker.C
+	}
+	ticker.Stop()
+	t.Logf("function returned false")
+}
+
 type writeToMock struct {
 	samplesAppended      int
 	seriesLabels         map[uint64][]prompb.Label
@@ -141,21 +158,13 @@ func Test_readToEnd_noCheckpoint(t *testing.T) {
 	st := timestamp.FromTime(time.Now())
 	watcher := NewWALWatcher(nil, "", wt, dir, st)
 	go watcher.Start()
-	i := 0
-	ticker := time.NewTicker(100 * time.Millisecond)
-	for range ticker.C {
-		if wt.checkNumLabels() >= seriesCount*10*2 {
-			break
-		}
-		i++
-		if i >= 10 {
-			break
-		}
+	defer watcher.Stop()
 
-	}
-	watcher.Stop()
-	ticker.Stop()
-	testutil.Equals(t, seriesCount, wt.checkNumLabels())
+	expected := seriesCount
+	retry(t, defaultRetry, 10, func() bool {
+		return wt.checkNumLabels() >= expected
+	})
+	testutil.Equals(t, expected, wt.checkNumLabels())
 }
 
 func Test_readToEnd_withCheckpoint(t *testing.T) {
@@ -227,25 +236,18 @@ func Test_readToEnd_withCheckpoint(t *testing.T) {
 
 	_, _, err = w.Segments()
 	testutil.Ok(t, err)
+
 	wt := newWriteToMock()
 	st := timestamp.FromTime(time.Now())
 	watcher := NewWALWatcher(nil, "", wt, dir, st)
 	go watcher.Start()
-	i := 0
-	ticker := time.NewTicker(100 * time.Millisecond)
-	for range ticker.C {
-		if wt.checkNumLabels() >= seriesCount*10*2 {
-			break
-		}
-		i++
-		if i >= 20 {
-			break
-		}
+	defer watcher.Stop()
 
-	}
-	watcher.Stop()
-	ticker.Stop()
-	testutil.Equals(t, seriesCount*10*2, wt.checkNumLabels())
+	expected := seriesCount * 10 * 2
+	retry(t, defaultRetry, 20, func() bool {
+		return wt.checkNumLabels() >= expected
+	})
+	testutil.Equals(t, expected, wt.checkNumLabels())
 }
 
 func Test_readCheckpoint(t *testing.T) {
@@ -301,21 +303,13 @@ func Test_readCheckpoint(t *testing.T) {
 	st := timestamp.FromTime(time.Now())
 	watcher := NewWALWatcher(nil, "", wt, dir, st)
 	go watcher.Start()
-	i := 0
-	ticker := time.NewTicker(100 * time.Millisecond)
-	for range ticker.C {
-		if wt.checkNumLabels() >= seriesCount*10*2 {
-			break
-		}
-		i++
-		if i >= 8 {
-			break
-		}
+	defer watcher.Stop()
 
-	}
-	watcher.Stop()
-	ticker.Stop()
-	testutil.Equals(t, seriesCount*10, wt.checkNumLabels())
+	expected := seriesCount * 10
+	retry(t, defaultRetry, 10, func() bool {
+		return wt.checkNumLabels() >= expected
+	})
+	testutil.Equals(t, expected, wt.checkNumLabels())
 }
 
 func Test_checkpoint_seriesReset(t *testing.T) {
@@ -366,21 +360,12 @@ func Test_checkpoint_seriesReset(t *testing.T) {
 	st := timestamp.FromTime(time.Now())
 	watcher := NewWALWatcher(nil, "", wt, dir, st)
 	go watcher.Start()
-	i := 0
-	ticker := time.NewTicker(100 * time.Millisecond)
-	for range ticker.C {
-		if wt.checkNumLabels() >= seriesCount*10*2 {
-			break
-		}
+	defer watcher.Stop()
 
-		i++
-		if i >= 50 {
-			break
-		}
-
-	}
-	watcher.Stop()
-	ticker.Stop()
+	expected := seriesCount * 10
+	retry(t, defaultRetry, 50, func() bool {
+		return wt.checkNumLabels() >= expected
+	})
 	testutil.Equals(t, seriesCount*10, wt.checkNumLabels())
 
 	// If you modify the checkpoint and truncate segment #'s run the test to see how