Merge pull request #6 for v0.3.2 Release

Author: jeevatkm

README.md

@@ -1,19 +1,19 @@
 # log - aah framework
 [![Build Status](https://travis-ci.org/go-aah/log.svg?branch=master)](https://travis-ci.org/go-aah/log) [![codecov](https://codecov.io/gh/go-aah/log/branch/master/graph/badge.svg)](https://codecov.io/gh/go-aah/log/branch/master) [![Go Report Card](https://goreportcard.com/badge/aahframework.org/log.v0)](https://goreportcard.com/report/aahframework.org/log.v0)
-[![Version](https://img.shields.io/badge/version-0.3.1-blue.svg)](https://github.com/go-aah/log/releases/latest) [![GoDoc](https://godoc.org/aahframework.org/log.v0?status.svg)](https://godoc.org/aahframework.org/log.v0)
+[![Version](https://img.shields.io/badge/version-0.3.2-blue.svg)](https://github.com/go-aah/log/releases/latest) [![GoDoc](https://godoc.org/aahframework.org/log.v0?status.svg)](https://godoc.org/aahframework.org/log.v0)
 [![License](https://img.shields.io/github/license/go-aah/log.svg)](LICENSE)
 
-***v0.3.1 [released](https://github.com/go-aah/log/releases/latest) and tagged on May 16, 2017***
+***v0.3.2 [released](https://github.com/go-aah/log/releases/latest) and tagged on May 17, 2017***
 
 Simple, flexible & powerful `Go` logger inspired by standard logger & Google glog. aah framework utilizes `log` library across.
 
 *`log` developed for aah framework. However, it's an independent library, can be used separately with any `Go` language project. Feel free to use it.*
 
 # Installation
-#### Stable - Version
+#### Stable Version - Production Ready
 ```sh
 # install the library
 go get -u aahframework.org/log.v0
 ```
 
-See official page [TODO]
+Visit official website https://aahframework.org to learn more.

console_receiver.go

@@ -9,7 +9,6 @@ import (
 	"io"
 	"os"
 	"runtime"
-	"sync"
 
 	"aahframework.org/config.v0"
 )
@@ -33,7 +32,6 @@ var (
 // ConsoleReceiver writes the log entry into os.Stderr.
 // For non-windows it  writes with color.
 type ConsoleReceiver struct {
-	rw           *sync.RWMutex
 	out          io.Writer
 	formatter    string
 	flags        *[]FlagPart
@@ -60,8 +58,6 @@ func (c *ConsoleReceiver) Init(cfg *config.Config) error {
 
 // SetPattern method initializes the logger format pattern.
 func (c *ConsoleReceiver) SetPattern(pattern string) error {
-	c.rw.Lock()
-	defer c.rw.Unlock()
 	flags, err := parseFlag(pattern)
 	if err != nil {
 		return err
@@ -81,8 +77,6 @@ func (c *ConsoleReceiver) IsCallerInfo() bool {
 
 // Log method writes the log entry into os.Stderr.
 func (c *ConsoleReceiver) Log(entry *Entry) {
-	c.rw.RLock()
-	defer c.rw.RUnlock()
 	if c.isColor {
 		_, _ = c.out.Write(levelToColor[entry.Level])
 	}

console_receiver_test.go

@@ -121,5 +121,4 @@ func testConsoleLogger(t *testing.T, cfgStr string) {
 	logger.Error("Yes, yes, yes - finally an error")
 	logger.Errorf("Yes, yes, yes - %v", "finally an error")
 
-	waitToDrain(logger)
 }

default.go

@@ -138,12 +138,6 @@ func SetPattern(pattern string) error {
 	return std.SetPattern(pattern)
 }
 
-// IsBufferEmpty returns true if logger buffer is empty otherwise false.
-// This method can be used to ensure all the log entry is written successfully.
-func IsBufferEmpty() bool {
-	return std.IsBufferEmpty()
-}
-
 func init() {
 	cfg, _ := config.ParseString("log { }")
 	std, _ = New(cfg)

default_test.go

@@ -42,7 +42,6 @@ func TestDefaultLogger(t *testing.T) {
 	testStdPanic("panicf", "this is panicf")
 	testStdPanic("panicln", "this is panicln")
 
-	waitToDrain(std)
 }
 
 func TestDefaultLoggerMisc(t *testing.T) {
@@ -55,7 +54,6 @@ func TestDefaultLoggerMisc(t *testing.T) {
 
 	assert.Nil(t, SetLevel("trace"))
 	assert.Nil(t, SetPattern("%level:-5 %message"))
-	waitToDrain(std)
 }
 
 func testStdPanic(method, msg string) {

file_receiver.go

@@ -5,12 +5,10 @@
 package log
 
 import (
-	"errors"
 	"fmt"
 	"io"
 	"os"
 	"path/filepath"
-	"sync"
 	"time"
 
 	"aahframework.org/config.v0"
@@ -21,7 +19,6 @@ var _ Receiver = &FileReceiver{}
 
 // FileReceiver writes the log entry into file.
 type FileReceiver struct {
-	rw           *sync.RWMutex
 	filename     string
 	out          io.Writer
 	formatter    string
@@ -44,10 +41,6 @@ type FileReceiver struct {
 func (f *FileReceiver) Init(cfg *config.Config) error {
 	// File
 	f.filename = cfg.StringDefault("log.file", "")
-	if ess.IsStrEmpty(f.filename) {
-		return errors.New("log: file value is required")
-	}
-
 	if err := f.openFile(); err != nil {
 		return err
 	}
@@ -76,8 +69,6 @@ func (f *FileReceiver) Init(cfg *config.Config) error {
 
 // SetPattern method initializes the logger format pattern.
 func (f *FileReceiver) SetPattern(pattern string) error {
-	f.rw.Lock()
-	defer f.rw.Unlock()
 	flags, err := parseFlag(pattern)
 	if err != nil {
 		return err
@@ -101,8 +92,6 @@ func (f *FileReceiver) IsCallerInfo() bool {
 
 // Log method logs the given entry values into file.
 func (f *FileReceiver) Log(entry *Entry) {
-	f.rw.RLock()
-	defer f.rw.RUnlock()
 	if f.isRotate() {
 		_ = f.rotateFile()
 	}
@@ -180,11 +169,10 @@ func (f *FileReceiver) openFile() error {
 }
 
 func (f *FileReceiver) close() {
-	if f.isClosed {
-		return
+	if !f.isClosed {
+		ess.CloseQuietly(f.out)
+		f.isClosed = true
 	}
-	ess.CloseQuietly(f.out)
-	f.isClosed = true
 }
 
 func (f *FileReceiver) backupFileName() string {

file_receiver_test.go

@@ -71,21 +71,17 @@ func TestFileLoggerRotation(t *testing.T) {
 	cleaupFiles("*.log")
 }
 
-func TestFileLoggerFileRequired(t *testing.T) {
+func TestFileLoggerFileOpenError(t *testing.T) {
 	fileConfigStr := `
   log {
     receiver = "file"
-    level = "debug"
-    pattern = "%utctime:2006-01-02 15:04:05.000 %level:-5 %longfile %line %custom:- %message"
-    rotate {
-      policy = "daily"
-    }
+		file = ""
   }
   `
 	cfg, _ := config.ParseString(fileConfigStr)
 	logger, err := New(cfg)
 	assert.Nil(t, logger)
-	assert.Equal(t, "log: file value is required", err.Error())
+	assert.Equal(t, "open : no such file or directory", err.Error())
 }
 
 func TestFileLoggerUnsupportedFormat(t *testing.T) {
@@ -160,5 +156,4 @@ func testFileLogger(t *testing.T, cfgStr string, loop int) {
 		logger.Errorf("Yes, yes, yes - %v", "finally an error")
 	}
 
-	waitToDrain(logger)
 }

log.go

@@ -65,7 +65,7 @@ const (
 
 var (
 	// Version no. of aahframework.org/log library
-	Version = "0.3.1"
+	Version = "0.3.2"
 
 	// FmtFlags is the list of log format flags supported by aah/log library
 	// Usage of flag order is up to format composition.
@@ -124,7 +124,6 @@ type (
 		m        *sync.Mutex
 		level    Level
 		receiver Receiver
-		ec       chan *Entry
 	}
 )
 
@@ -156,9 +155,6 @@ func New(cfg *config.Config) (*Logger, error) {
 		return nil, err
 	}
 
-	logger.ec = make(chan *Entry, 1000) // TODO make it configurable
-	go logger.listenToEntry()
-
 	return logger, nil
 }
 
@@ -186,6 +182,8 @@ func (l *Logger) SetLevel(level string) error {
 
 // SetPattern methods sets the log format pattern.
 func (l *Logger) SetPattern(pattern string) error {
+	l.m.Lock()
+	defer l.m.Unlock()
 	if l.receiver == nil {
 		return ErrLogReceiverIsNil
 	}
@@ -205,12 +203,6 @@ func (l *Logger) SetReceiver(receiver Receiver) error {
 	return l.receiver.Init(l.cfg)
 }
 
-// IsBufferEmpty returns true if logger buffer is empty otherwise false.
-// This method can be used to ensure all the log entry is written successfully.
-func (l *Logger) IsBufferEmpty() bool {
-	return len(l.ec) == 0
-}
-
 //‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾
 // Logger logging methods
 //_______________________________________
@@ -333,6 +325,7 @@ func (l *Logger) output(level Level, calldepth int, format *string, v ...interfa
 	}
 
 	entry := getEntry()
+	defer putEntry(entry)
 	entry.Time = time.Now()
 	entry.Level = level
 	if format == nil {
@@ -345,14 +338,5 @@ func (l *Logger) output(level Level, calldepth int, format *string, v ...interfa
 		entry.File, entry.Line = fetchCallerInfo(calldepth)
 	}
 
-	l.ec <- entry
-}
-
-// listenToEntry method listens to entry channel and log the entry into receiver.
-func (l Logger) listenToEntry() {
-	for {
-		entry := <-l.ec
-		l.receiver.Log(entry)
-		putEntry(entry)
-	}
+	l.receiver.Log(entry)
 }

log_test.go

@@ -33,7 +33,6 @@ func TestLogDefault(t *testing.T) {
 	testPanic(logger, "panic", "this is panic")
 	testPanic(logger, "panicf", "this is panicf")
 	testPanic(logger, "panicln", "this is panicln")
-	waitToDrain(logger)
 }
 
 func TestMisc(t *testing.T) {
@@ -120,11 +119,3 @@ func cleaupFiles(match string) {
 		}
 	}
 }
-
-func waitToDrain(l *Logger) {
-	for {
-		if l.IsBufferEmpty() {
-			break
-		}
-	}
-}

util.go

@@ -7,7 +7,6 @@ package log
 import (
 	"runtime"
 	"strings"
-	"sync"
 	"time"
 )
 
@@ -80,9 +79,9 @@ func isCallerInfo(flags *[]FlagPart) bool {
 
 func getReceiverByName(name string) Receiver {
 	if name == "FILE" {
-		return &FileReceiver{rw: &sync.RWMutex{}}
+		return &FileReceiver{}
 	} else if name == "CONSOLE" {
-		return &ConsoleReceiver{rw: &sync.RWMutex{}}
+		return &ConsoleReceiver{}
 	}
 	return nil
 }