Merge lp:~noise/ubuntu-push/log-line-nums into lp:ubuntu-push/automatic

[Bret Barker]

log line nums, enabled when logLevel = debug

[Samuele Pedroni (pedronis)]

it breaks the acceptance tests (make acceptance) that do some log parsing, the parsing should be teached to ignore the file name

smaller note:

 buf.Reset()
 logger = NewSimpleLogger(buf, "error")

could be used to simplify the second match in the test

review: Needs Fixing

=== modified file 'logger/logger.go'
--- logger/logger.go	2014-04-11 23:17:40 +0000
+++ logger/logger.go	2015-01-26 21:01:48 +0000
@@ -50,7 +50,8 @@
 }
 
 const (
-	lError = iota
+	calldepthBase = 3
+	lError        = iota
 	lInfo
 	lDebug
 )
@@ -81,8 +82,12 @@
 // level. The level can be, in order: "error", "info", "debug". It takes an
 // io.Writer.
 func NewSimpleLogger(w io.Writer, level string) Logger {
+	flags := log.Ldate | log.Ltime | log.Lmicroseconds
+	if levelToNLevel[level] == lDebug {
+		flags = flags | log.Lshortfile
+	}
 	return NewSimpleLoggerFromMinimalLogger(
-		log.New(w, "", log.Ldate|log.Ltime|log.Lmicroseconds),
+		log.New(w, "", flags),
 		level,
 	)
 }
@@ -92,13 +97,13 @@
 }
 
 func (lg *simpleLogger) Errorf(format string, v ...interface{}) {
-	lg.outputFunc(2, fmt.Sprintf("ERROR "+format, v...))
+	lg.outputFunc(calldepthBase, fmt.Sprintf("ERROR "+format, v...))
 }
 
 var osExit = os.Exit // for testing
 
 func (lg *simpleLogger) Fatalf(format string, v ...interface{}) {
-	lg.outputFunc(2, fmt.Sprintf("ERROR "+format, v...))
+	lg.outputFunc(calldepthBase, fmt.Sprintf("ERROR "+format, v...))
 	osExit(1)
 }
 
@@ -107,18 +112,18 @@
 	stack := make([]byte, 8*1024) // Stack writes less but doesn't fail
 	stackWritten := runtime.Stack(stack, false)
 	stack = stack[:stackWritten]
-	lg.outputFunc(2, fmt.Sprintf("ERROR(PANIC) %s:\n%s", msg, stack))
+	lg.outputFunc(calldepthBase, fmt.Sprintf("ERROR(PANIC) %s:\n%s", msg, stack))
 }
 
 func (lg *simpleLogger) Infof(format string, v ...interface{}) {
 	if lg.nlevel >= lInfo {
-		lg.outputFunc(2, fmt.Sprintf("INFO "+format, v...))
+		lg.outputFunc(calldepthBase, fmt.Sprintf("INFO "+format, v...))
 	}
 }
 
 func (lg *simpleLogger) Debugf(format string, v ...interface{}) {
 	if lg.nlevel >= lDebug {
-		lg.outputFunc(2, fmt.Sprintf("DEBUG "+format, v...))
+		lg.outputFunc(calldepthBase, fmt.Sprintf("DEBUG "+format, v...))
 	}
 }
 
 
=== modified file 'logger/logger_test.go'
--- logger/logger_test.go	2014-04-11 19:05:35 +0000
+++ logger/logger_test.go	2015-01-26 21:01:48 +0000
@@ -163,3 +163,14 @@
 	checkError(`{"lvl": 1}`, "lvl:.*type string")
 	checkError(`{"lvl": "foo"}`, "lvl: not a log level: foo")
 }
+
+func (s *loggerSuite) TestLogLineNo(c *C) {
+	buf := &bytes.Buffer{}
+	logger := NewSimpleLogger(buf, "debug")
+	logger.Output(1, "foobaz")
+	c.Check(buf.String(), Matches, ".* .* logger_test.go:[0-9]+: foobaz\n")
+
+	logger = NewSimpleLogger(buf, "error")
+	logger.Output(1, "foobaz")
+	c.Check(buf.String(), Matches, ".* .* logger_test.go:[0-9]+: foobaz\n"+".* .* foobaz\n")
+}