Add basic tests (#2)

Author: unknwon

Diff for: .gitignore

@@ -1 +1,2 @@
 /.idea
+/test

Diff for: .travis.yml

@@ -7,7 +7,7 @@ go:
   - 1.7.x
   - master
 
-# TODO: uncomment test commands
-#script:
-#  - go get -v github.com/smartystreets/goconvey
-#  - go test -v -cover -race
+script:
+ - go get -v github.com/smartystreets/goconvey
+ - make test
+ - make vet

Diff for: Makefile

@@ -0,0 +1,14 @@
+.PHONY: build test vet
+
+build: vet
+	go install -v
+
+test:
+	mkdir -p test
+	go test -v -cover -race -coverprofile=test/coverage.out
+
+vet:
+	go vet
+
+coverage:
+	go tool cover -html=test/coverage.out

Diff for: clog.go

@@ -24,7 +24,7 @@ import (
 )
 
 const (
-	_VERSION = "0.2.2"
+	_VERSION = "0.3.0"
 )
 
 // Version returns current version of the package.

Diff for: clog_test.go

@@ -0,0 +1,36 @@
+// Copyright 2017 Unknwon
+//
+// Licensed under the Apache License, Version 2.0 (the "License"): you may
+// not use this file except in compliance with the License. You may obtain
+// a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+// License for the specific language governing permissions and limitations
+// under the License.
+
+package clog
+
+import (
+	"testing"
+
+	. "github.com/smartystreets/goconvey/convey"
+)
+
+func Test_Version(t *testing.T) {
+	Convey("Get version", t, func() {
+		So(Version(), ShouldEqual, _VERSION)
+	})
+}
+
+func Test_isValidLevel(t *testing.T) {
+	Convey("Validate log level", t, func() {
+		So(isValidLevel(LEVEL(-1)), ShouldBeFalse)
+		So(isValidLevel(LEVEL(5)), ShouldBeFalse)
+		So(isValidLevel(TRACE), ShouldBeTrue)
+		So(isValidLevel(FATAL), ShouldBeTrue)
+	})
+}

Diff for: console_test.go

@@ -0,0 +1,45 @@
+// Copyright 2017 Unknwon
+//
+// Licensed under the Apache License, Version 2.0 (the "License"): you may
+// not use this file except in compliance with the License. You may obtain
+// a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+// License for the specific language governing permissions and limitations
+// under the License.
+
+package clog
+
+import (
+	"testing"
+
+	. "github.com/smartystreets/goconvey/convey"
+)
+
+func Test_console_Init(t *testing.T) {
+	Convey("Init console logger", t, func() {
+		Convey("Mismatched config object", func() {
+			err := NewLogger(CONSOLE, struct{}{})
+			So(err, ShouldNotBeNil)
+			_, ok := err.(ErrConfigObject)
+			So(ok, ShouldBeTrue)
+		})
+
+		Convey("Valid config object", func() {
+			So(NewLogger(CONSOLE, ConsoleConfig{}), ShouldBeNil)
+
+			Convey("Incorrect level", func() {
+				err := NewLogger(CONSOLE, ConsoleConfig{
+					Level: LEVEL(-1),
+				})
+				So(err, ShouldNotBeNil)
+				_, ok := err.(ErrInvalidLevel)
+				So(ok, ShouldBeTrue)
+			})
+		})
+	})
+}

Diff for: file.go

@@ -30,6 +30,7 @@ const (
 	LAST_WRITE_FILENAME           = ".clog-lastwrite"
 	LAST_WRITE_FORMAT             = "2006-01-02 MST"
 	LAST_WRITE_FORMAT_SIMPLE      = "2006-01-02"
+	LOG_PREFIX_LENGTH             = len("2017/02/06 21:20:08 ")
 )
 
 // FileRotationConfig represents rotation related configurations for file mode logger.
@@ -39,7 +40,7 @@ type FileRotationConfig struct {
 	Rotate bool
 	// Rotate on daily basis.
 	Daily bool
-	// Maximum size of file for a rotation.
+	// Maximum size in bytes of file for a rotation.
 	MaxSize int64
 	// Maximum number of lines for a rotation.
 	MaxLines int64
@@ -222,8 +223,8 @@ func (f *file) write(msg *Message) {
 	f.Logger.Print(msg.Body)
 
 	if f.rotate.Rotate {
-		f.currentSize += 20 + int64(len(msg.Body)) // 20 for "2017/02/06 21:20:08 "
-		f.currentLines++                           // TODO: should I care if log message itself contains new lines?
+		f.currentSize += int64(LOG_PREFIX_LENGTH + len(msg.Body))
+		f.currentLines++ // TODO: should I care if log message itself contains new lines?
 
 		var (
 			needsRotate = false
@@ -243,7 +244,6 @@ func (f *file) write(msg *Message) {
 
 		if needsRotate {
 			f.file.Close()
-
 			if err := os.Rename(f.filename, f.rotateFilename(rotateDate.Format(LAST_WRITE_FORMAT_SIMPLE))); err != nil {
 				f.errorChan <- fmt.Errorf("fail to rename rotate file '%s': %v", f.filename, err)
 			}

Diff for: file_test.go

@@ -0,0 +1,53 @@
+// Copyright 2017 Unknwon
+//
+// Licensed under the Apache License, Version 2.0 (the "License"): you may
+// not use this file except in compliance with the License. You may obtain
+// a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+// License for the specific language governing permissions and limitations
+// under the License.
+
+package clog
+
+import (
+	"testing"
+
+	. "github.com/smartystreets/goconvey/convey"
+)
+
+func Test_file_Init(t *testing.T) {
+	Convey("Init file logger", t, func() {
+		Convey("With mismatched config object", func() {
+			err := NewLogger(FILE, struct{}{})
+			So(err, ShouldNotBeNil)
+			_, ok := err.(ErrConfigObject)
+			So(ok, ShouldBeTrue)
+		})
+
+		Convey("With valid config object", func() {
+			So(NewLogger(FILE, FileConfig{
+				Filename: "test/test.log",
+			}), ShouldBeNil)
+
+			Convey("Incorrect level", func() {
+				err := NewLogger(FILE, FileConfig{
+					Level: LEVEL(-1),
+				})
+				So(err, ShouldNotBeNil)
+				_, ok := err.(ErrInvalidLevel)
+				So(ok, ShouldBeTrue)
+			})
+
+			Convey("Empty file name", func() {
+				err := NewLogger(FILE, FileConfig{})
+				So(err, ShouldNotBeNil)
+				So(err.Error(), ShouldEqual, "initFile: OpenFile '': open : no such file or directory")
+			})
+		})
+	})
+}

Diff for: logger.go

@@ -91,7 +91,7 @@ func NewLogger(mode MODE, cfg interface{}) error {
 
 	logger := factory()
 	if err := logger.Init(cfg); err != nil {
-		return fmt.Errorf("fail to initialize: %v", err)
+		return err
 	}
 	msgChan := logger.ExchangeChans(errorChan)
 

Diff for: logger_test.go

@@ -0,0 +1,42 @@
+// Copyright 2017 Unknwon
+//
+// Licensed under the Apache License, Version 2.0 (the "License"): you may
+// not use this file except in compliance with the License. You may obtain
+// a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+// License for the specific language governing permissions and limitations
+// under the License.
+
+package clog
+
+import (
+	"testing"
+
+	. "github.com/smartystreets/goconvey/convey"
+)
+
+func Test_Register(t *testing.T) {
+	Convey("Register with nil function", t, func() {
+		defer func() {
+			err := recover()
+			So(err, ShouldNotBeNil)
+			So(err, ShouldEqual, "clog: register function is nil")
+		}()
+		Register("test", nil)
+	})
+
+	Convey("Register duplicated mode", t, func() {
+		defer func() {
+			err := recover()
+			So(err, ShouldNotBeNil)
+			So(err, ShouldEqual, "clog: register duplicated mode 'test'")
+		}()
+		Register("test", newConsole)
+		Register("test", newConsole)
+	})
+}