Merge branch 'develop'

Author: jeevatkm

README.md

@@ -1,40 +1,8 @@
 # log - aah framework
 [![Build Status](https://travis-ci.org/go-aah/log.svg?branch=master)](https://travis-ci.org/go-aah/log)  [![Go Report Card](https://goreportcard.com/badge/github.com/go-aah/log)](https://goreportcard.com/report/github.com/go-aah/log) [![GoDoc](https://godoc.org/github.com/go-aah/log?status.svg)](https://godoc.org/github.com/go-aah/log)  [![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
 
-Package `log` is used across **aah framework**. It's independent library, can be used separately with any `Go` language project. Feel free to use it.
+Simple, flexible & powerful `Go` logger. aah framework utilizes `log` library across.
 
-`log` supports following receivers:
-* Console
-  * Log level is colored (for windows it's plain)
-* File
-  * Log Rotation
-    * Daily
-    * Size
-    * No. of lines
-  * No. of Backups (upcoming)
-* Remote - TCP & UDP (upcoming)
+*It's independent library, can be used separately with any `Go` language project. Feel free to use it.*
 
-## Quick Start
-
-```
-go get -u github.com/go-aah/log
-```
-
-## Sample
-```go
-log.Info("Welcome ", "to ", "aah ", "logger")
-log.Infof("%v, %v, & %v", "simple", "flexible", "powerful logger")
-
-// Output:
-2016-07-03 19:22:11.504 INFO  - Welcome to aah logger
-2016-07-03 19:22:11.504 INFO  - simple, flexible, & powerful logger
-```
-
-## Author
-Jeevanandam M. - [email protected]
-
-## Contributors
-Have a look on [Contributors](https://github.com/go-aah/log/graphs/contributors) page.
-
-## License
-Released under MIT license, refer [LICENSE](LICENSE) file.
+See official page [TODO]

formatter.go

@@ -5,66 +5,11 @@
 package log
 
 import (
-	"errors"
 	"fmt"
-	"os"
 	"strconv"
 	"strings"
-)
-
-// FmtFlag type definition
-type FmtFlag uint8
-
-// Format flags used to define log message format for each log entry
-const (
-	FmtFlagLevel FmtFlag = iota
-	FmtFlagTime
-	FmtFlagUTCTime
-	FmtFlagLongfile
-	FmtFlagShortfile
-	FmtFlagLine
-	FmtFlagMessage
-	FmtFlagCustom
-	FmtFlagUnknown
-)
-
-var (
-	// FmtFlags is the list of log format flags supported by aah/log library
-	// Usage of flag order is up to format composition.
-	//    level     - outputs INFO, DEBUG, ERROR, so on
-	//    time      - outputs local time as per format supplied
-	//    utctime   - outputs UTC time as per format supplied
-	//    longfile  - outputs full file name: /a/b/c/d.go
-	//    shortfile - outputs final file name element: d.go
-	//    line      - outputs file line number: L23
-	//    message   - outputs given message along supplied arguments if they present
-	//    custom    - outputs string as-is into log entry
-	FmtFlags = map[string]FmtFlag{
-		"level":     FmtFlagLevel,
-		"time":      FmtFlagTime,
-		"utctime":   FmtFlagUTCTime,
-		"longfile":  FmtFlagLongfile,
-		"shortfile": FmtFlagShortfile,
-		"line":      FmtFlagLine,
-		"message":   FmtFlagMessage,
-		"custom":    FmtFlagCustom,
-	}
-
-	// DefaultPattern is default log entry pattern in aah/log
-	// For e.g:
-	//    2006-01-02 15:04:05.000 INFO  - This is my message
-	DefaultPattern = "%time:2006-01-02 15:04:05.000 %level:-5 %custom:- %message"
-
-	// BackupTimeFormat is used for timestamp with filename on rotation
-	BackupTimeFormat = "2006-01-02-15-04-05.000"
-
-	// ErrFormatStringEmpty returned when log format parameter is empty
-	ErrFormatStringEmpty = errors.New("log format string is empty")
 
-	flagSeparator      = "%"
-	flagValueSeparator = ":"
-	defaultFormat      = "%v"
-	filePermission     = os.FileMode(0755)
+	"github.com/go-aah/essentials"
 )
 
 // FormatterFunc is the handler function to implement log entry
@@ -88,7 +33,7 @@ type FlagPart struct {
 //  For e.g.:
 //    %time:2006-01-02 15:04:05.000 %level %custom:- %msg
 func parseFlag(format string) (*[]FlagPart, error) {
-	if strIsEmpty(format) {
+	if ess.StrIsEmpty(format) {
 		return nil, ErrFormatStringEmpty
 	}
 
@@ -149,7 +94,7 @@ func DefaultFormatter(flags *[]FlagPart, entry *Entry, isColor bool) (*[]byte, e
 		case FmtFlagLine:
 			buf = append(buf, fmt.Sprintf(part.Format, "L"+strconv.Itoa(entry.Line))...)
 		case FmtFlagMessage:
-			if strIsEmpty(entry.Format) {
+			if ess.StrIsEmpty(entry.Format) {
 				buf = append(buf, fmt.Sprint(entry.Values...)...)
 			} else {
 				buf = append(buf, fmt.Sprintf(entry.Format, entry.Values...)...)

log.go

@@ -24,12 +24,16 @@ import (
 	"strings"
 	"time"
 
-	"github.com/go-aah/forge"
+	"github.com/go-aah/config"
+	"github.com/go-aah/essentials"
 )
 
 // Level type definition
 type Level uint8
 
+// FmtFlag type definition
+type FmtFlag uint8
+
 // Log Level definition
 const (
 	LevelError Level = iota
@@ -40,10 +44,60 @@ const (
 	LevelUnknown
 )
 
+// Format flags used to define log message format for each log entry
+const (
+	FmtFlagLevel FmtFlag = iota
+	FmtFlagTime
+	FmtFlagUTCTime
+	FmtFlagLongfile
+	FmtFlagShortfile
+	FmtFlagLine
+	FmtFlagMessage
+	FmtFlagCustom
+	FmtFlagUnknown
+)
+
 var (
+	// FmtFlags is the list of log format flags supported by aah/log library
+	// Usage of flag order is up to format composition.
+	//    level     - outputs INFO, DEBUG, ERROR, so on
+	//    time      - outputs local time as per format supplied
+	//    utctime   - outputs UTC time as per format supplied
+	//    longfile  - outputs full file name: /a/b/c/d.go
+	//    shortfile - outputs final file name element: d.go
+	//    line      - outputs file line number: L23
+	//    message   - outputs given message along supplied arguments if they present
+	//    custom    - outputs string as-is into log entry
+	FmtFlags = map[string]FmtFlag{
+		"level":     FmtFlagLevel,
+		"time":      FmtFlagTime,
+		"utctime":   FmtFlagUTCTime,
+		"longfile":  FmtFlagLongfile,
+		"shortfile": FmtFlagShortfile,
+		"line":      FmtFlagLine,
+		"message":   FmtFlagMessage,
+		"custom":    FmtFlagCustom,
+	}
+
+	// DefaultPattern is default log entry pattern in aah/log
+	// For e.g:
+	//    2006-01-02 15:04:05.000 INFO  - This is my message
+	DefaultPattern = "%time:2006-01-02 15:04:05.000 %level:-5 %custom:- %message"
+
+	// BackupTimeFormat is used for timestamp with filename on rotation
+	BackupTimeFormat = "2006-01-02-15-04-05.000"
+
+	// ErrFormatStringEmpty returned when log format parameter is empty
+	ErrFormatStringEmpty = errors.New("log format string is empty")
+
 	// ErrWriterIsClosed returned when log writer is closed
 	ErrWriterIsClosed = errors.New("log writer is closed")
 
+	flagSeparator      = "%"
+	flagValueSeparator = ":"
+	defaultFormat      = "%v"
+	filePermission     = os.FileMode(0755)
+
 	levelNameToLevel = map[string]Level{
 		"ERROR": LevelError,
 		"WARN":  LevelWarn,
@@ -114,37 +168,29 @@ type Logger interface {
 }
 
 // New creates the logger based config supplied
-func New(config string) (Logger, error) {
-	if strIsEmpty(config) {
+func New(configStr string) (Logger, error) {
+	if ess.StrIsEmpty(configStr) {
 		return nil, errors.New("logger config is empty")
 	}
 
-	cfg, err := forge.ParseString(config)
+	cfg, err := config.ParseString(configStr)
 	if err != nil {
 		return nil, err
 	}
 
-	receiverType, err := cfg.GetString("receiver")
-	if err != nil {
-		return nil, err
+	receiverType, found := cfg.String("receiver")
+	if !found {
+		return nil, errors.New("receiver configuration is required")
 	}
 	receiverType = strings.ToUpper(receiverType)
 
-	levelName, err := cfg.GetString("level")
-	if err != nil {
-		levelName = "DEBUG"
-	}
-
+	levelName := cfg.StringDefault("level", "DEBUG")
 	level := levelByName(levelName)
 	if level == LevelUnknown {
 		return nil, fmt.Errorf("unrecognized log level: %v", levelName)
 	}
 
-	pattern, err := cfg.GetString("pattern")
-	if err != nil {
-		pattern = DefaultPattern
-	}
-
+	pattern := cfg.StringDefault("pattern", DefaultPattern)
 	flags, err := parseFlag(pattern)
 	if err != nil {
 		return nil, err
@@ -197,7 +243,7 @@ func fetchCallerInfo(calldepth int) (string, int) {
 	return file, line
 }
 
-func newConsoleReceiver(cfg *forge.Section, receiverType string, level Level, flags *[]FlagPart) (*Receiver, error) {
+func newConsoleReceiver(cfg *config.Config, receiverType string, level Level, flags *[]FlagPart) (*Receiver, error) {
 	receiver := Receiver{
 		Config:     cfg,
 		Type:       receiverType,
@@ -214,7 +260,12 @@ func newConsoleReceiver(cfg *forge.Section, receiverType string, level Level, fl
 	return &receiver, nil
 }
 
-func newFileReceiver(cfg *forge.Section, receiverType string, level Level, flags *[]FlagPart) (*Receiver, error) {
+func newFileReceiver(cfg *config.Config, receiverType string, level Level, flags *[]FlagPart) (*Receiver, error) {
+	maxSize := cfg.IntDefault("rotate.size", 100)
+	if maxSize > 2048 { // maximum 2GB file size
+		return nil, errors.New("maximum 2GB file size supported for rotation")
+	}
+
 	receiver := Receiver{
 		Config:     cfg,
 		Type:       receiverType,
@@ -232,16 +283,16 @@ func newFileReceiver(cfg *forge.Section, receiverType string, level Level, flags
 		return nil, err
 	}
 
-	rotate, _ := cfg.GetSection("rotate")
-	receiver.rotate, _ = rotate.GetString("mode")
+	receiver.rotate = cfg.StringDefault("rotate.mode", "daily")
+	// rotate, _ := cfg.GetSection("rotate")
+	// receiver.rotate, _ = rotate.GetString("mode")
 	switch receiver.rotate {
 	case "daily":
 		receiver.setOpenDay()
 	case "lines":
-		receiver.maxLines, _ = rotate.GetInteger("lines")
+		receiver.maxLines = int64(cfg.IntDefault("rotate.lines", 0))
 	case "size":
-		receiver.maxSize, _ = rotate.GetInteger("size")
-		receiver.maxSize = receiver.maxSize * 1024 * 1024
+		receiver.maxSize = int64(maxSize * 1024 * 1024)
 	}
 
 	return &receiver, nil

log_test.go

@@ -6,6 +6,7 @@ package log
 
 import (
 	"fmt"
+	"strings"
 	"testing"
 )
 
@@ -132,7 +133,7 @@ func TestNewCustomFileReceiverLinesRotation(t *testing.T) {
 receiver = "file"
 
 # "debug" lowercase works too and if not supplied then defaults to DEBUG
-level = "info"
+level = "trace"
 
 # if not suppiled then default pattern is used
 pattern = "%time:2006-01-02 15:04:05.000 %level:-5 %shortfile %line %custom:- %message"
@@ -178,7 +179,7 @@ func TestNewCustomFileReceiverSizeRotation(t *testing.T) {
 receiver = "file"
 
 # if not suppiled then default pattern is used
-pattern = "%time:2006-01-02 15:04:05.000 %level:-5 %longfile %line %custom:- %message"
+pattern = "%utctime:2006-01-02 15:04:05.000 %level:-5 %longfile %line %custom:- %message"
 rotate {
 	mode = "size"
 
@@ -208,3 +209,61 @@ rotate {
 		logger.Errorf("Yes, yes, yes - finally an error: %v, finally an error: %v, finally an error: %v", 0, 000, 0000)
 	}
 }
+
+func TestUnknownFormatFlag(t *testing.T) {
+	_, err := parseFlag("")
+	if err != ErrFormatStringEmpty {
+		t.Errorf("Unexpected error: %v", err)
+		t.FailNow()
+	}
+
+	_, err = parseFlag("%time:2006-01-02 15:04:05.000 %level:-5 %longfile %unknown %custom:- %message")
+	if !strings.Contains(err.Error(), "unrecognized log format flag") {
+		t.Errorf("Unexpected error: %v", err)
+		t.FailNow()
+	}
+}
+
+func TestNewMisc(t *testing.T) {
+	_, err := New("")
+	if err.Error() != "logger config is empty" {
+		t.Errorf("Unexpected error: %v", err)
+		t.FailNow()
+	}
+
+	_, err = New(`receiver = "file" level="info"`)
+	if !strings.HasPrefix(err.Error(), "syntax error") {
+		t.Errorf("Unexpected error: %v", err)
+		t.FailNow()
+	}
+
+	_, err = New(`level="info";`)
+	if !strings.HasPrefix(err.Error(), "receiver configuration") {
+		t.Errorf("Unexpected error: %v", err)
+		t.FailNow()
+	}
+
+	_, err = New(`receiver = "file"; level="unknown";`)
+	if !strings.HasPrefix(err.Error(), "unrecognized log level") {
+		t.Errorf("Unexpected error: %v", err)
+		t.FailNow()
+	}
+
+	_, err = New(`receiver = "remote"; level="debug";`)
+	if !strings.HasPrefix(err.Error(), "unsupported receiver") {
+		t.Errorf("Unexpected error: %v", err)
+		t.FailNow()
+	}
+
+	_, err = New(`receiver = "file"; level="debug"; rotate { mode="size"; size=2500; }`)
+	if !strings.HasPrefix(err.Error(), "maximum 2GB file size") {
+		t.Errorf("Unexpected error: %v", err)
+		t.FailNow()
+	}
+
+	_, err = New(`receiver = "console"; level="debug"; pattern="%time:2006-01-02 15:04:05.000 %level:-5 %unknown %message";`)
+	if !strings.HasPrefix(err.Error(), "unrecognized log format flag") {
+		t.Errorf("Unexpected error: %v", err)
+		t.FailNow()
+	}
+}