Rename CacheLogrusHook to LogCache

Resolves #130 (comment)

Author: Ivan Mirić

tests/network_manager_test.go

@@ -37,9 +37,9 @@ func TestDataURLSkipRequest(t *testing.T) {
 		bt.Browser.Close()
 	})
 
-	logHook := testutils.LogHook(bt.State.Logger)
+	lc := testutils.AttachLogCache(bt.State.Logger)
 
 	p.Goto("data:text/html,hello", nil)
 
-	assert.True(t, logHook.Contains("skipped request handling of data URL"))
+	assert.True(t, lc.Contains("skipped request handling of data URL"))
 }

testutils/logrus_hook.go

@@ -28,56 +28,57 @@ import (
 	"github.com/sirupsen/logrus"
 )
 
-// CacheLogrusHook implements the logrus.Hook interface and could be used to check
+// LogCache implements the logrus.Hook interface and could be used to check
 // if log messages were outputted
-type CacheLogrusHook struct {
+type LogCache struct {
 	HookedLevels []logrus.Level
 	mutex        sync.RWMutex
 	messageCache []logrus.Entry
 }
 
 // Levels just returns whatever was stored in the HookedLevels slice
-func (clh *CacheLogrusHook) Levels() []logrus.Level {
-	return clh.HookedLevels
+func (lc *LogCache) Levels() []logrus.Level {
+	return lc.HookedLevels
 }
 
 // Fire saves whatever message the logrus library passed in the cache
-func (clh *CacheLogrusHook) Fire(e *logrus.Entry) error {
-	clh.mutex.Lock()
-	defer clh.mutex.Unlock()
-	clh.messageCache = append(clh.messageCache, *e)
+func (lc *LogCache) Fire(e *logrus.Entry) error {
+	lc.mutex.Lock()
+	defer lc.mutex.Unlock()
+	lc.messageCache = append(lc.messageCache, *e)
 	return nil
 }
 
 // Drain returns the currently stored messages and deletes them from the cache
-func (clh *CacheLogrusHook) Drain() []logrus.Entry {
-	clh.mutex.Lock()
-	defer clh.mutex.Unlock()
-	res := clh.messageCache
-	clh.messageCache = []logrus.Entry{}
+func (lc *LogCache) Drain() []logrus.Entry {
+	lc.mutex.Lock()
+	defer lc.mutex.Unlock()
+	res := lc.messageCache
+	lc.messageCache = []logrus.Entry{}
 	return res
 }
 
 // Contains returns true if msg is contained in any of the cached logged events
 // or false otherwise.
-func (clh *CacheLogrusHook) Contains(msg string) bool {
-	clh.mutex.RLock()
-	defer clh.mutex.RUnlock()
-	for _, evt := range clh.messageCache {
+func (lc *LogCache) Contains(msg string) bool {
+	lc.mutex.RLock()
+	defer lc.mutex.RUnlock()
+	for _, evt := range lc.messageCache {
 		if strings.Contains(evt.Message, msg) {
 			return true
 		}
 	}
 	return false
 }
 
-var _ logrus.Hook = &CacheLogrusHook{}
+var _ logrus.Hook = &LogCache{}
 
-// LogHook sets logger to DebugLevel, attaches a CacheLogrusHook and returns it.
-func LogHook(logger *logrus.Logger) *CacheLogrusHook {
-	logHook := &CacheLogrusHook{HookedLevels: []logrus.Level{logrus.DebugLevel, logrus.WarnLevel}}
+// AttachLogCache sets logger to DebugLevel, attaches a LogCache hook and
+// returns it.
+func AttachLogCache(logger *logrus.Logger) *LogCache {
+	lc := &LogCache{HookedLevels: []logrus.Level{logrus.DebugLevel, logrus.WarnLevel}}
 	logger.SetLevel(logrus.DebugLevel)
-	logger.AddHook(logHook)
+	logger.AddHook(lc)
 	logger.SetOutput(ioutil.Discard)
-	return logHook
+	return lc
 }