Merge pull request #107 from howbazaar/update-loggo

Update to use the latest loggo.

Minor changes to deal with changes in the loggo functions.

(Review request: http://reviews.vapour.ws/r/5350/)

Author: jujubot

checkers/log.go

@@ -31,7 +31,7 @@ func (s SimpleMessages) GoString() string {
 	return fmt.Sprintf("SimpleMessages{\n%s\n}", strings.Join(out, "\n"))
 }
 
-func logToSimpleMessages(log []loggo.TestLogValues) SimpleMessages {
+func logToSimpleMessages(log []loggo.Entry) SimpleMessages {
 	out := make(SimpleMessages, len(log))
 	for i, val := range log {
 		out[i].Level = val.Level
@@ -47,10 +47,10 @@ type logMatches struct {
 func (checker *logMatches) Check(params []interface{}, _ []string) (result bool, error string) {
 	var obtained SimpleMessages
 	switch params[0].(type) {
-	case []loggo.TestLogValues:
-		obtained = logToSimpleMessages(params[0].([]loggo.TestLogValues))
+	case []loggo.Entry:
+		obtained = logToSimpleMessages(params[0].([]loggo.Entry))
 	default:
-		return false, "Obtained value must be of type []loggo.TestLogValues or SimpleMessage"
+		return false, "Obtained value must be of type []loggo.Entry or SimpleMessage"
 	}
 
 	var expected SimpleMessages

checkers/log_test.go

@@ -43,7 +43,7 @@ type LogMatchesSuite struct{}
 var _ = gc.Suite(&LogMatchesSuite{})
 
 func (s *LogMatchesSuite) TestMatchSimpleMessage(c *gc.C) {
-	log := []loggo.TestLogValues{
+	log := []loggo.Entry{
 		{Level: loggo.INFO, Message: "foo bar"},
 		{Level: loggo.INFO, Message: "12345"},
 	}
@@ -68,7 +68,7 @@ func (s *LogMatchesSuite) TestMatchSimpleMessage(c *gc.C) {
 }
 
 func (s *LogMatchesSuite) TestMatchSimpleMessages(c *gc.C) {
-	log := []loggo.TestLogValues{
+	log := []loggo.Entry{
 		{Level: loggo.INFO, Message: "foo bar"},
 		{Level: loggo.INFO, Message: "12345"},
 	}
@@ -93,7 +93,7 @@ func (s *LogMatchesSuite) TestMatchSimpleMessages(c *gc.C) {
 }
 
 func (s *LogMatchesSuite) TestMatchStrings(c *gc.C) {
-	log := []loggo.TestLogValues{
+	log := []loggo.Entry{
 		{Level: loggo.INFO, Message: "foo bar"},
 		{Level: loggo.INFO, Message: "12345"},
 	}
@@ -103,7 +103,7 @@ func (s *LogMatchesSuite) TestMatchStrings(c *gc.C) {
 }
 
 func (s *LogMatchesSuite) TestMatchInexact(c *gc.C) {
-	log := []loggo.TestLogValues{
+	log := []loggo.Entry{
 		{Level: loggo.INFO, Message: "foo bar"},
 		{Level: loggo.INFO, Message: "baz"},
 		{Level: loggo.DEBUG, Message: "12345"},
@@ -169,11 +169,11 @@ func (s *LogMatchesSuite) TestLogMatchesOnlyAcceptsSliceTestLogValues(c *gc.C) {
 	expected := jc.SimpleMessages{}
 	result, err := jc.LogMatches.Check([]interface{}{obtained, expected}, nil)
 	c.Assert(result, gc.Equals, false)
-	c.Assert(err, gc.Equals, "Obtained value must be of type []loggo.TestLogValues or SimpleMessage")
+	c.Assert(err, gc.Equals, "Obtained value must be of type []loggo.Entry or SimpleMessage")
 }
 
 func (s *LogMatchesSuite) TestLogMatchesOnlyAcceptsStringOrSimpleMessages(c *gc.C) {
-	obtained := []loggo.TestLogValues{
+	obtained := []loggo.Entry{
 		{Level: loggo.INFO, Message: "foo bar"},
 		{Level: loggo.INFO, Message: "baz"},
 		{Level: loggo.DEBUG, Message: "12345"},
@@ -185,7 +185,7 @@ func (s *LogMatchesSuite) TestLogMatchesOnlyAcceptsStringOrSimpleMessages(c *gc.
 }
 
 func (s *LogMatchesSuite) TestLogMatchesFailsOnInvalidRegex(c *gc.C) {
-	var obtained interface{} = []loggo.TestLogValues{{Level: loggo.INFO, Message: "foo bar"}}
+	var obtained interface{} = []loggo.Entry{{Level: loggo.INFO, Message: "foo bar"}}
 	var expected interface{} = []string{"[]foo"}
 
 	result, err := jc.LogMatches.Check([]interface{}{obtained, expected}, nil /* unused */)

log.go

@@ -4,14 +4,17 @@
 package testing
 
 import (
+	"flag"
 	"fmt"
 	"os"
-	"time"
+	"path/filepath"
 
 	"github.com/juju/loggo"
 	gc "gopkg.in/check.v1"
 )
 
+var logLocation = flag.Bool("loggo.location", false, "Also log the location of the loggo call")
+
 // LoggingSuite redirects the juju logger to the test logger
 // when embedded in a gocheck suite type.
 type LoggingSuite struct{}
@@ -27,19 +30,27 @@ var logConfig = func() string {
 	return "DEBUG"
 }()
 
-func (w *gocheckWriter) Write(level loggo.Level, module, filename string, line int, timestamp time.Time, message string) {
+func (w *gocheckWriter) Write(entry loggo.Entry) {
+	filename := filepath.Base(entry.Filename)
+	var message string
+	if *logLocation {
+		message = fmt.Sprintf("%s %s %s:%d %s", entry.Level, entry.Module, filename, entry.Line, entry.Message)
+	} else {
+		message = fmt.Sprintf("%s %s %s", entry.Level, entry.Module, entry.Message)
+	}
 	// Magic calldepth value...
-	// TODO (frankban) Document why we are using this magic value.
-	w.c.Output(3, fmt.Sprintf("%s %s %s", level, module, message))
+	// The value says "how far up the call stack do we go to find the location".
+	// It is used to match the standard library log function, and isn't actually
+	// used by gocheck.
+	w.c.Output(3, message)
 }
 
 func (s *LoggingSuite) SetUpSuite(c *gc.C) {
 	s.setUp(c)
 }
 
 func (s *LoggingSuite) TearDownSuite(c *gc.C) {
-	loggo.ResetLoggers()
-	loggo.ResetWriters()
+	loggo.ResetLogging()
 }
 
 func (s *LoggingSuite) SetUpTest(c *gc.C) {
@@ -51,17 +62,16 @@ func (s *LoggingSuite) TearDownTest(c *gc.C) {
 
 type discardWriter struct{}
 
-func (discardWriter) Write(level loggo.Level, name, filename string, line int, timestamp time.Time, message string) {
+func (discardWriter) Write(entry loggo.Entry) {
 }
 
 func (s *LoggingSuite) setUp(c *gc.C) {
-	loggo.ResetWriters()
+	loggo.ResetLogging()
 	// Don't use the default writer for the test logging, which
 	// means we can still get logging output from tests that
 	// replace the default writer.
-	loggo.ReplaceDefaultWriter(discardWriter{})
-	loggo.RegisterWriter("loggingsuite", &gocheckWriter{c}, loggo.TRACE)
-	loggo.ResetLoggers()
+	loggo.RegisterWriter(loggo.DefaultWriterName, discardWriter{})
+	loggo.RegisterWriter("loggingsuite", &gocheckWriter{c})
 	err := loggo.ConfigureLoggers(logConfig)
 	c.Assert(err, gc.IsNil)
 }

log_test.go

@@ -40,7 +40,7 @@ func (*logSuite) TestLog(c *gc.C) {
 
 	c.Assert(c.GetTestLog(), gc.Matches,
 		".*DEBUG test message 1\n"+
-			".*TRACE juju message 3\n",
+			".*TRACE juju message 3\n$",
 	)
 	c.Assert(logger.EffectiveLogLevel(), gc.Equals, loggo.WARNING)
 	c.Assert(jujuLogger.EffectiveLogLevel(), gc.Equals, loggo.WARNING)