add golint check and fix all golints

.travis.yml

@@ -36,6 +36,7 @@ install:
   - go get -u honnef.co/go/tools/cmd/gosimple
   - go get -u github.com/mdempsky/unconvert
   - go get -u github.com/gordonklaus/ineffassign
+  - go get -u github.com/golang/lint/golint
 before_script:
   - psql --version
   - sh -c "if [ '$ORM_DRIVER' = 'postgres' ]; then psql -c 'create database orm_test;' -U postgres; fi"
@@ -54,5 +55,6 @@ script:
   - unconvert $(go list ./... | grep -v /vendor/)
   - ineffassign .
   - find . ! \( -path './vendor' -prune \) -type f -name '*.go' -print0 | xargs -0 gofmt -l -s
+  - golint ./...
 addons:
   postgresql: "9.4"

config/env/env.go

@@ -12,6 +12,8 @@
 // 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 env is used to parse environment.
 package env
 
 import (

context/acceptencoder.go

@@ -39,6 +39,7 @@ var (
 	getMethodOnly   bool
 )
 
+// InitGzip init the gzipcompress
 func InitGzip(minLength, compressLevel int, methods []string) {
 	if minLength >= 0 {
 		gzipMinLength = minLength

grace/server.go

@@ -291,7 +291,7 @@ func (srv *Server) fork() (err error) {
 // RegisterSignalHook registers a function to be run PreSignal or PostSignal for a given signal.
 func (srv *Server) RegisterSignalHook(ppFlag int, sig os.Signal, f func()) (err error) {
 	if ppFlag != PreSignal && ppFlag != PostSignal {
-		err = fmt.Errorf("Invalid ppFlag argument. Must be either grace.PreSignal or grace.PostSignal.")
+		err = fmt.Errorf("Invalid ppFlag argument. Must be either grace.PreSignal or grace.PostSignal")
 		return
 	}
 	for _, s := range hookableSignals {
@@ -300,6 +300,6 @@ func (srv *Server) RegisterSignalHook(ppFlag int, sig os.Signal, f func()) (err
 			return
 		}
 	}
-	err = fmt.Errorf("Signal '%v' is not supported.", sig)
+	err = fmt.Errorf("Signal '%v' is not supported", sig)
 	return
 }

hooks.go

@@ -55,9 +55,9 @@ func registerSession() error {
 			conf.ProviderConfig = filepath.ToSlash(BConfig.WebConfig.Session.SessionProviderConfig)
 			conf.DisableHTTPOnly = BConfig.WebConfig.Session.SessionDisableHTTPOnly
 			conf.Domain = BConfig.WebConfig.Session.SessionDomain
-			conf.EnableSidInHttpHeader = BConfig.WebConfig.Session.SessionEnableSidInHTTPHeader
+			conf.EnableSidInHTTPHeader = BConfig.WebConfig.Session.SessionEnableSidInHTTPHeader
-			conf.SessionNameInHttpHeader = BConfig.WebConfig.Session.SessionNameInHTTPHeader
+			conf.SessionNameInHTTPHeader = BConfig.WebConfig.Session.SessionNameInHTTPHeader
-			conf.EnableSidInUrlQuery = BConfig.WebConfig.Session.SessionEnableSidInURLQuery
+			conf.EnableSidInURLQuery = BConfig.WebConfig.Session.SessionEnableSidInURLQuery
 		} else {
 			if err = json.Unmarshal([]byte(sessionConfig), conf); err != nil {
 				return err

logs/alils/alils.go

@@ -11,11 +11,14 @@ import (
 )
 
 const (
+	// CacheSize set the flush size
 	CacheSize int = 64
+	// Delimiter define the topic delimiter
 	Delimiter string = "##"
 )
 
-type AliLSConfig struct {
+// Config is the Config for Ali Log
+type Config struct {
 	Project   string   `json:"project"`
 	Endpoint  string   `json:"endpoint"`
 	KeyID     string   `json:"key_id"`
@@ -35,18 +38,17 @@ type aliLSWriter struct {
 	withMap  bool
 	groupMap map[string]*LogGroup
 	lock     *sync.Mutex
-	AliLSConfig
+	Config
 }
 
-// 创建提供Logger接口的日志服务
+// NewAliLS create a new Logger
 func NewAliLS() logs.Logger {
 	alils := new(aliLSWriter)
 	alils.Level = logs.LevelTrace
 	return alils
 }
 
-// 读取配置
+// Init parse config and init struct
-// 初始化必要的数据结构
 func (c *aliLSWriter) Init(jsonConfig string) (err error) {
 
 	json.Unmarshal([]byte(jsonConfig), c)
@@ -55,28 +57,26 @@ func (c *aliLSWriter) Init(jsonConfig string) (err error) {
 		c.FlushWhen = CacheSize
 	}
 
-	// 初始化Project
 	prj := &LogProject{
 		Name:            c.Project,
 		Endpoint:        c.Endpoint,
-		AccessKeyId:     c.KeyID,
+		AccessKeyID:     c.KeyID,
 		AccessKeySecret: c.KeySecret,
 	}
 
-	// 获取logstore
 	c.store, err = prj.GetLogStore(c.LogStore)
 	if err != nil {
 		return err
 	}
 
-	// 创建默认Log Group
+	// Create default Log Group
 	c.group = append(c.group, &LogGroup{
 		Topic:  proto.String(""),
 		Source: proto.String(c.Source),
 		Logs:   make([]*Log, 0, c.FlushWhen),
 	})
 
-	// 创建其它Log Group
+	// Create other Log Group
 	c.groupMap = make(map[string]*LogGroup)
 	for _, topic := range c.Topics {
 
@@ -114,7 +114,7 @@ func (c *aliLSWriter) WriteMsg(when time.Time, msg string, level int) (err error
 	var lg *LogGroup
 	if c.withMap {
 
-		// 解析出Topic，并匹配LogGroup
+		// Topic，LogGroup
 		strs := strings.SplitN(msg, Delimiter, 2)
 		if len(strs) == 2 {
 			pos := strings.LastIndex(strs[0], " ")
@@ -123,7 +123,7 @@ func (c *aliLSWriter) WriteMsg(when time.Time, msg string, level int) (err error
 			lg = c.groupMap[topic]
 		}
 
-		// 默认发到空Topic
+		// send to empty Topic
 		if lg == nil {
 			content = msg
 			lg = c.group[0]
@@ -133,15 +133,14 @@ func (c *aliLSWriter) WriteMsg(when time.Time, msg string, level int) (err error
 		lg = c.group[0]
 	}
 
-	// 生成日志
+	c1 := &LogContent{
-	c1 := &Log_Content{
 		Key:   proto.String("msg"),
 		Value: proto.String(content),
 	}
 
 	l := &Log{
-		Time: proto.Uint32(uint32(when.Unix())), // 填写日志时间
+		Time: proto.Uint32(uint32(when.Unix())),
-		Contents: []*Log_Content{
+		Contents: []*LogContent{
 			c1,
 		},
 	}
@@ -150,7 +149,6 @@ func (c *aliLSWriter) WriteMsg(when time.Time, msg string, level int) (err error
 	lg.Logs = append(lg.Logs, l)
 	c.lock.Unlock()
 
-	// 满足条件则Flush
 	if len(lg.Logs) >= c.FlushWhen {
 		c.flush(lg)
 	}
@@ -161,7 +159,7 @@ func (c *aliLSWriter) WriteMsg(when time.Time, msg string, level int) (err error
 // Flush implementing method. empty.
 func (c *aliLSWriter) Flush() {
 
-	// flush所有group
+	// flush all group
 	for _, lg := range c.group {
 		c.flush(lg)
 	}
@@ -175,9 +173,6 @@ func (c *aliLSWriter) flush(lg *LogGroup) {
 
 	c.lock.Lock()
 	defer c.lock.Unlock()
-
-	// 把以上的LogGroup推送到SLS服务器，
-	// SLS服务器会根据该logstore的shard个数自动进行负载均衡。
 	err := c.store.PutLogs(lg)
 	if err != nil {
 		return

logs/alils/log.pb.go

@@ -1,30 +1,43 @@
 package alils
 
-import "github.com/gogo/protobuf/proto"
+import (
-import "fmt"
+	"fmt"
-import "math"
+	"io"
+	"math"
 
-// discarding unused import gogoproto "."
+	"github.com/gogo/protobuf/proto"
-
+	github_com_gogo_protobuf_proto "github.com/gogo/protobuf/proto"
-import github_com_gogo_protobuf_proto "github.com/gogo/protobuf/proto"
+)
-
-import "io"
 
 // Reference imports to suppress errors if they are not otherwise used.
 var _ = proto.Marshal
 var _ = fmt.Errorf
 var _ = math.Inf
 
+var (
+	// ErrInvalidLengthLog invalid proto
+	ErrInvalidLengthLog = fmt.Errorf("proto: negative length found during unmarshaling")
+	// ErrIntOverflowLog overflow
+	ErrIntOverflowLog = fmt.Errorf("proto: integer overflow")
+)
+
+// Log define the proto Log
 type Log struct {
 	Time            *uint32       `protobuf:"varint,1,req,name=Time" json:"Time,omitempty"`
-	Contents         []*Log_Content `protobuf:"bytes,2,rep,name=Contents" json:"Contents,omitempty"`
+	Contents        []*LogContent `protobuf:"bytes,2,rep,name=Contents" json:"Contents,omitempty"`
-	XXX_unrecognized []byte         `json:"-"`
+	XXXUnrecognized []byte        `json:"-"`
 }
 
+// Reset the Log
 func (m *Log) Reset() { *m = Log{} }
+
+// String return the Compact Log
 func (m *Log) String() string { return proto.CompactTextString(m) }
+
+// ProtoMessage not implemented
 func (*Log) ProtoMessage() {}
 
+// GetTime return the Log's Time
 func (m *Log) GetTime() uint32 {
 	if m != nil && m.Time != nil {
 		return *m.Time
@@ -32,49 +45,65 @@ func (m *Log) GetTime() uint32 {
 	return 0
 }
 
-func (m *Log) GetContents() []*Log_Content {
+// GetContents return the Log's Contents
+func (m *Log) GetContents() []*LogContent {
 	if m != nil {
 		return m.Contents
 	}
 	return nil
 }
 
-type Log_Content struct {
+// LogContent define the Log content struct
+type LogContent struct {
 	Key             *string `protobuf:"bytes,1,req,name=Key" json:"Key,omitempty"`
 	Value           *string `protobuf:"bytes,2,req,name=Value" json:"Value,omitempty"`
-	XXX_unrecognized []byte  `json:"-"`
+	XXXUnrecognized []byte  `json:"-"`
 }
 
-func (m *Log_Content) Reset()         { *m = Log_Content{} }
+// Reset LogContent
-func (m *Log_Content) String() string { return proto.CompactTextString(m) }
+func (m *LogContent) Reset() { *m = LogContent{} }
-func (*Log_Content) ProtoMessage()    {}
 
-func (m *Log_Content) GetKey() string {
+// String return the compact text
+func (m *LogContent) String() string { return proto.CompactTextString(m) }
+
+// ProtoMessage not implemented
+func (*LogContent) ProtoMessage() {}
+
+// GetKey return the Key
+func (m *LogContent) GetKey() string {
 	if m != nil && m.Key != nil {
 		return *m.Key
 	}
 	return ""
 }
 
-func (m *Log_Content) GetValue() string {
+// GetValue return the Value
+func (m *LogContent) GetValue() string {
 	if m != nil && m.Value != nil {
 		return *m.Value
 	}
 	return ""
 }
 
+// LogGroup define the logs struct
 type LogGroup struct {
 	Logs            []*Log  `protobuf:"bytes,1,rep,name=Logs" json:"Logs,omitempty"`
 	Reserved        *string `protobuf:"bytes,2,opt,name=Reserved" json:"Reserved,omitempty"`
 	Topic           *string `protobuf:"bytes,3,opt,name=Topic" json:"Topic,omitempty"`
 	Source          *string `protobuf:"bytes,4,opt,name=Source" json:"Source,omitempty"`
-	XXX_unrecognized []byte  `json:"-"`
+	XXXUnrecognized []byte  `json:"-"`
 }
 
+// Reset LogGroup
 func (m *LogGroup) Reset() { *m = LogGroup{} }
+
+// String return the compact text
 func (m *LogGroup) String() string { return proto.CompactTextString(m) }
+
+// ProtoMessage not implemented
 func (*LogGroup) ProtoMessage() {}
 
+// GetLogs return the loggroup logs
 func (m *LogGroup) GetLogs() []*Log {
 	if m != nil {
 		return m.Logs
@@ -82,6 +111,7 @@ func (m *LogGroup) GetLogs() []*Log {
 	return nil
 }
 
+// GetReserved return Reserved
 func (m *LogGroup) GetReserved() string {
 	if m != nil && m.Reserved != nil {
 		return *m.Reserved
@@ -89,6 +119,7 @@ func (m *LogGroup) GetReserved() string {
 	return ""
 }
 
+// GetTopic return Topic
 func (m *LogGroup) GetTopic() string {
 	if m != nil && m.Topic != nil {
 		return *m.Topic
@@ -96,6 +127,7 @@ func (m *LogGroup) GetTopic() string {
 	return ""
 }
 
+// GetSource return Source
 func (m *LogGroup) GetSource() string {
 	if m != nil && m.Source != nil {
 		return *m.Source
@@ -103,15 +135,22 @@ func (m *LogGroup) GetSource() string {
 	return ""
 }
 
+// LogGroupList define the LogGroups
 type LogGroupList struct {
 	LogGroups       []*LogGroup `protobuf:"bytes,1,rep,name=logGroups" json:"logGroups,omitempty"`
-	XXX_unrecognized []byte      `json:"-"`
+	XXXUnrecognized []byte      `json:"-"`
 }
 
+// Reset LogGroupList
 func (m *LogGroupList) Reset() { *m = LogGroupList{} }
+
+// String return compact text
 func (m *LogGroupList) String() string { return proto.CompactTextString(m) }
+
+// ProtoMessage not implemented
 func (*LogGroupList) ProtoMessage() {}
 
+// GetLogGroups return the LogGroups
 func (m *LogGroupList) GetLogGroups() []*LogGroup {
 	if m != nil {
 		return m.LogGroups
@@ -119,6 +158,7 @@ func (m *LogGroupList) GetLogGroups() []*LogGroup {
 	return nil
 }
 
+// Marshal the logs to byte slice
 func (m *Log) Marshal() (data []byte, err error) {
 	size := m.Size()
 	data = make([]byte, size)
@@ -129,6 +169,7 @@ func (m *Log) Marshal() (data []byte, err error) {
 	return data[:n], nil
 }
 
+// MarshalTo data
 func (m *Log) MarshalTo(data []byte) (int, error) {
 	var i int
 	_ = i
@@ -136,11 +177,10 @@ func (m *Log) MarshalTo(data []byte) (int, error) {
 	_ = l
 	if m.Time == nil {
 		return 0, github_com_gogo_protobuf_proto.NewRequiredNotSetError("Time")
-	} else {
+	}
 	data[i] = 0x8
 	i++
 	i = encodeVarintLog(data, i, uint64(*m.Time))
-	}
 	if len(m.Contents) > 0 {
 		for _, msg := range m.Contents {
 			data[i] = 0x12
@@ -153,13 +193,14 @@ func (m *Log) MarshalTo(data []byte) (int, error) {
 			i += n
 		}
 	}
-	if m.XXX_unrecognized != nil {
+	if m.XXXUnrecognized != nil {
-		i += copy(data[i:], m.XXX_unrecognized)
+		i += copy(data[i:], m.XXXUnrecognized)
 	}
 	return i, nil
 }
 
-func (m *Log_Content) Marshal() (data []byte, err error) {
+// Marshal LogContent
+func (m *LogContent) Marshal() (data []byte, err error) {
 	size := m.Size()
 	data = make([]byte, size)
 	n, err := m.MarshalTo(data)
@@ -169,33 +210,34 @@ func (m *Log_Content) Marshal() (data []byte, err error) {
 	return data[:n], nil
 }
 
-func (m *Log_Content) MarshalTo(data []byte) (int, error) {
+// MarshalTo logcontent to data
+func (m *LogContent) MarshalTo(data []byte) (int, error) {
 	var i int
 	_ = i
 	var l int
 	_ = l
 	if m.Key == nil {
 		return 0, github_com_gogo_protobuf_proto.NewRequiredNotSetError("Key")
-	} else {
+	}
 	data[i] = 0xa
 	i++
 	i = encodeVarintLog(data, i, uint64(len(*m.Key)))
 	i += copy(data[i:], *m.Key)
-	}
+
 	if m.Value == nil {
 		return 0, github_com_gogo_protobuf_proto.NewRequiredNotSetError("Value")
-	} else {
+	}
 	data[i] = 0x12
 	i++
 	i = encodeVarintLog(data, i, uint64(len(*m.Value)))
 	i += copy(data[i:], *m.Value)
-	}
+	if m.XXXUnrecognized != nil {
-	if m.XXX_unrecognized != nil {
+		i += copy(data[i:], m.XXXUnrecognized)
-		i += copy(data[i:], m.XXX_unrecognized)
 	}
 	return i, nil
 }
 
+// Marshal LogGroup
 func (m *LogGroup) Marshal() (data []byte, err error) {
 	size := m.Size()
 	data = make([]byte, size)
@@ -206,6 +248,7 @@ func (m *LogGroup) Marshal() (data []byte, err error) {
 	return data[:n], nil
 }
 
+// MarshalTo LogGroup to data
 func (m *LogGroup) MarshalTo(data []byte) (int, error) {
 	var i int
 	_ = i
@@ -241,12 +284,13 @@ func (m *LogGroup) MarshalTo(data []byte) (int, error) {
 		i = encodeVarintLog(data, i, uint64(len(*m.Source)))
 		i += copy(data[i:], *m.Source)
 	}
-	if m.XXX_unrecognized != nil {
+	if m.XXXUnrecognized != nil {
-		i += copy(data[i:], m.XXX_unrecognized)
+		i += copy(data[i:], m.XXXUnrecognized)
 	}
 	return i, nil
 }
 
+// Marshal LogGroupList
 func (m *LogGroupList) Marshal() (data []byte, err error) {
 	size := m.Size()
 	data = make([]byte, size)
@@ -257,6 +301,7 @@ func (m *LogGroupList) Marshal() (data []byte, err error) {
 	return data[:n], nil
 }
 
+// MarshalTo LogGroupList to data
 func (m *LogGroupList) MarshalTo(data []byte) (int, error) {
 	var i int
 	_ = i
@@ -274,8 +319,8 @@ func (m *LogGroupList) MarshalTo(data []byte) (int, error) {
 			i += n
 		}
 	}
-	if m.XXX_unrecognized != nil {
+	if m.XXXUnrecognized != nil {
-		i += copy(data[i:], m.XXX_unrecognized)
+		i += copy(data[i:], m.XXXUnrecognized)
 	}
 	return i, nil
 }
@@ -307,6 +352,8 @@ func encodeVarintLog(data []byte, offset int, v uint64) int {
 	data[offset] = uint8(v)
 	return offset + 1
 }
+
+// Size return the log's size
 func (m *Log) Size() (n int) {
 	var l int
 	_ = l
@@ -319,13 +366,14 @@ func (m *Log) Size() (n int) {
 			n += 1 + l + sovLog(uint64(l))
 		}
 	}
-	if m.XXX_unrecognized != nil {
+	if m.XXXUnrecognized != nil {
-		n += len(m.XXX_unrecognized)
+		n += len(m.XXXUnrecognized)
 	}
 	return n
 }
 
-func (m *Log_Content) Size() (n int) {
+// Size return LogContent size based on Key and Value
+func (m *LogContent) Size() (n int) {
 	var l int
 	_ = l
 	if m.Key != nil {
@@ -336,12 +384,13 @@ func (m *Log_Content) Size() (n int) {
 		l = len(*m.Value)
 		n += 1 + l + sovLog(uint64(l))
 	}
-	if m.XXX_unrecognized != nil {
+	if m.XXXUnrecognized != nil {
-		n += len(m.XXX_unrecognized)
+		n += len(m.XXXUnrecognized)
 	}
 	return n
 }
 
+// Size return LogGroup size based on Logs
 func (m *LogGroup) Size() (n int) {
 	var l int
 	_ = l
@@ -363,12 +412,13 @@ func (m *LogGroup) Size() (n int) {
 		l = len(*m.Source)
 		n += 1 + l + sovLog(uint64(l))
 	}
-	if m.XXX_unrecognized != nil {
+	if m.XXXUnrecognized != nil {
-		n += len(m.XXX_unrecognized)
+		n += len(m.XXXUnrecognized)
 	}
 	return n
 }
 
+// Size return LogGroupList size
 func (m *LogGroupList) Size() (n int) {
 	var l int
 	_ = l
@@ -378,8 +428,8 @@ func (m *LogGroupList) Size() (n int) {
 			n += 1 + l + sovLog(uint64(l))
 		}
 	}
-	if m.XXX_unrecognized != nil {
+	if m.XXXUnrecognized != nil {
-		n += len(m.XXX_unrecognized)
+		n += len(m.XXXUnrecognized)
 	}
 	return n
 }
@@ -397,6 +447,8 @@ func sovLog(x uint64) (n int) {
 func sozLog(x uint64) (n int) {
 	return sovLog((x << 1) ^ (x >> 63))
 }
+
+// Unmarshal data to log
 func (m *Log) Unmarshal(data []byte) error {
 	var hasFields [1]uint64
 	l := len(data)
@@ -474,7 +526,7 @@ func (m *Log) Unmarshal(data []byte) error {
 			if postIndex > l {
 				return io.ErrUnexpectedEOF
 			}
-			m.Contents = append(m.Contents, &Log_Content{})
+			m.Contents = append(m.Contents, &LogContent{})
 			if err := m.Contents[len(m.Contents)-1].Unmarshal(data[iNdEx:postIndex]); err != nil {
 				return err
 			}
@@ -491,7 +543,7 @@ func (m *Log) Unmarshal(data []byte) error {
 			if (iNdEx + skippy) > l {
 				return io.ErrUnexpectedEOF
 			}
-			m.XXX_unrecognized = append(m.XXX_unrecognized, data[iNdEx:iNdEx+skippy]...)
+			m.XXXUnrecognized = append(m.XXXUnrecognized, data[iNdEx:iNdEx+skippy]...)
 			iNdEx += skippy
 		}
 	}
@@ -504,7 +556,9 @@ func (m *Log) Unmarshal(data []byte) error {
 	}
 	return nil
 }
-func (m *Log_Content) Unmarshal(data []byte) error {
+
+// Unmarshal data to LogContent
+func (m *LogContent) Unmarshal(data []byte) error {
 	var hasFields [1]uint64
 	l := len(data)
 	iNdEx := 0
@@ -608,7 +662,7 @@ func (m *Log_Content) Unmarshal(data []byte) error {
 			if (iNdEx + skippy) > l {
 				return io.ErrUnexpectedEOF
 			}
-			m.XXX_unrecognized = append(m.XXX_unrecognized, data[iNdEx:iNdEx+skippy]...)
+			m.XXXUnrecognized = append(m.XXXUnrecognized, data[iNdEx:iNdEx+skippy]...)
 			iNdEx += skippy
 		}
 	}
@@ -624,6 +678,8 @@ func (m *Log_Content) Unmarshal(data []byte) error {
 	}
 	return nil
 }
+
+// Unmarshal data to LogGroup
 func (m *LogGroup) Unmarshal(data []byte) error {
 	l := len(data)
 	iNdEx := 0
@@ -786,7 +842,7 @@ func (m *LogGroup) Unmarshal(data []byte) error {
 			if (iNdEx + skippy) > l {
 				return io.ErrUnexpectedEOF
 			}
-			m.XXX_unrecognized = append(m.XXX_unrecognized, data[iNdEx:iNdEx+skippy]...)
+			m.XXXUnrecognized = append(m.XXXUnrecognized, data[iNdEx:iNdEx+skippy]...)
 			iNdEx += skippy
 		}
 	}
@@ -796,6 +852,8 @@ func (m *LogGroup) Unmarshal(data []byte) error {
 	}
 	return nil
 }
+
+// Unmarshal data to LogGroupList
 func (m *LogGroupList) Unmarshal(data []byte) error {
 	l := len(data)
 	iNdEx := 0
@@ -868,7 +926,7 @@ func (m *LogGroupList) Unmarshal(data []byte) error {
 			if (iNdEx + skippy) > l {
 				return io.ErrUnexpectedEOF
 			}
-			m.XXX_unrecognized = append(m.XXX_unrecognized, data[iNdEx:iNdEx+skippy]...)
+			m.XXXUnrecognized = append(m.XXXUnrecognized, data[iNdEx:iNdEx+skippy]...)
 			iNdEx += skippy
 		}
 	}
@@ -878,6 +936,7 @@ func (m *LogGroupList) Unmarshal(data []byte) error {
 	}
 	return nil
 }
+
 func skipLog(data []byte) (n int, err error) {
 	l := len(data)
 	iNdEx := 0
@@ -940,7 +999,7 @@ func skipLog(data []byte) (n int, err error) {
 		case 3:
 			for {
 				var innerWire uint64
-				var start int = iNdEx
+				var start = iNdEx
 				for shift := uint(0); ; shift += 7 {
 					if shift >= 64 {
 						return 0, ErrIntOverflowLog
@@ -977,8 +1036,3 @@ func skipLog(data []byte) (n int, err error) {
 	}
 	panic("unreachable")
 }
-
-var (
-	ErrInvalidLengthLog = fmt.Errorf("proto: negative length found during unmarshaling")
-	ErrIntOverflowLog   = fmt.Errorf("proto: integer overflow")
-)

logs/alils/log_config.go

@@ -1,5 +1,6 @@
 package alils
 
+// InputDetail define log detail
 type InputDetail struct {
 	LogType       string   `json:"logType"`
 	LogPath       string   `json:"logPath"`
@@ -14,11 +15,13 @@ type InputDetail struct {
 	TopicFormat   string   `json:"topicFormat"`
 }
 
+// OutputDetail define the output detail
 type OutputDetail struct {
 	Endpoint     string `json:"endpoint"`
 	LogStoreName string `json:"logstoreName"`
 }
 
+// LogConfig define Log Config
 type LogConfig struct {
 	Name         string       `json:"configName"`
 	InputType    string       `json:"inputType"`

logs/alils/log_project.go

@@ -1,5 +1,5 @@
 /*
-Package sls implements the SDK(v0.5.0) of Simple Log Service(abbr. SLS).
+Package alils implements the SDK(v0.5.0) of Simple Log Service(abbr. SLS).
 
 For more description about SLS, please read this article:
 http://gitlab.alibaba-inc.com/sls/doc.
@@ -20,19 +20,20 @@ type errorMessage struct {
 	Message string `json:"errorMessage"`
 }
 
+// LogProject Define the Ali Project detail
 type LogProject struct {
 	Name            string // Project name
 	Endpoint        string // IP or hostname of SLS endpoint
-	AccessKeyId     string
+	AccessKeyID     string
 	AccessKeySecret string
 }
 
 // NewLogProject creates a new SLS project.
-func NewLogProject(name, endpoint, accessKeyId, accessKeySecret string) (p *LogProject, err error) {
+func NewLogProject(name, endpoint, AccessKeyID, accessKeySecret string) (p *LogProject, err error) {
 	p = &LogProject{
 		Name:            name,
 		Endpoint:        endpoint,
-		AccessKeyId:     accessKeyId,
+		AccessKeyID:     AccessKeyID,
 		AccessKeySecret: accessKeySecret,
 	}
 	return p, nil

logs/alils/log_store.go

@@ -12,6 +12,7 @@ import (
 	"github.com/gogo/protobuf/proto"
 )
 
+// LogStore Store the logs
 type LogStore struct {
 	Name       string `json:"logstoreName"`
 	TTL        int
@@ -23,6 +24,7 @@ type LogStore struct {
 	project *LogProject
 }
 
+// Shard define the Log Shard
 type Shard struct {
 	ShardID int `json:"shardID"`
 }
@@ -116,16 +118,16 @@ func (s *LogStore) PutLogs(lg *LogGroup) (err error) {
 	return
 }
 
-// GetCursor gets log cursor of one shard specified by shardId.
+// GetCursor gets log cursor of one shard specified by shardID.
 // The from can be in three form: a) unix timestamp in seccond, b) "begin", c) "end".
 // For more detail please read: http://gitlab.alibaba-inc.com/sls/doc/blob/master/api/shard.md#logstore
-func (s *LogStore) GetCursor(shardId int, from string) (cursor string, err error) {
+func (s *LogStore) GetCursor(shardID int, from string) (cursor string, err error) {
 	h := map[string]string{
 		"x-sls-bodyrawsize": "0",
 	}
 
 	uri := fmt.Sprintf("/logstores/%v/shards/%v?type=cursor&from=%v",
-		s.Name, shardId, from)
+		s.Name, shardID, from)
 
 	r, err := request(s.project, "GET", uri, h, nil)
 	if err != nil {
@@ -163,10 +165,10 @@ func (s *LogStore) GetCursor(shardId int, from string) (cursor string, err error
 	return
 }
 
-// GetLogsBytes gets logs binary data from shard specified by shardId according cursor.
+// GetLogsBytes gets logs binary data from shard specified by shardID according cursor.
 // The logGroupMaxCount is the max number of logGroup could be returned.
 // The nextCursor is the next curosr can be used to read logs at next time.
-func (s *LogStore) GetLogsBytes(shardId int, cursor string,
+func (s *LogStore) GetLogsBytes(shardID int, cursor string,
 	logGroupMaxCount int) (out []byte, nextCursor string, err error) {
 
 	h := map[string]string{
@@ -176,7 +178,7 @@ func (s *LogStore) GetLogsBytes(shardId int, cursor string,
 	}
 
 	uri := fmt.Sprintf("/logstores/%v/shards/%v?type=logs&cursor=%v&count=%v",
-		s.Name, shardId, cursor, logGroupMaxCount)
+		s.Name, shardID, cursor, logGroupMaxCount)
 
 	r, err := request(s.project, "GET", uri, h, nil)
 	if err != nil {
@@ -249,13 +251,13 @@ func LogsBytesDecode(data []byte) (gl *LogGroupList, err error) {
 	return
 }
 
-// GetLogs gets logs from shard specified by shardId according cursor.
+// GetLogs gets logs from shard specified by shardID according cursor.
 // The logGroupMaxCount is the max number of logGroup could be returned.
 // The nextCursor is the next curosr can be used to read logs at next time.
-func (s *LogStore) GetLogs(shardId int, cursor string,
+func (s *LogStore) GetLogs(shardID int, cursor string,
 	logGroupMaxCount int) (gl *LogGroupList, nextCursor string, err error) {
 
-	out, nextCursor, err := s.GetLogsBytes(shardId, cursor, logGroupMaxCount)
+	out, nextCursor, err := s.GetLogsBytes(shardID, cursor, logGroupMaxCount)
 	if err != nil {
 		return
 	}

logs/alils/machine_group.go

@@ -8,18 +8,20 @@ import (
 	"net/http/httputil"
 )
 
-type MachinGroupAttribute struct {
+// MachineGroupAttribute define the Attribute
+type MachineGroupAttribute struct {
 	ExternalName string `json:"externalName"`
 	TopicName    string `json:"groupTopic"`
 }
 
+// MachineGroup define the machine Group
 type MachineGroup struct {
 	Name          string   `json:"groupName"`
 	Type          string   `json:"groupType"`
-	MachineIdType string   `json:"machineIdentifyType"`
+	MachineIDType string   `json:"machineIdentifyType"`
-	MachineIdList []string `json:"machineList"`
+	MachineIDList []string `json:"machineList"`
 
-	Attribute MachinGroupAttribute `json:"groupAttribute"`
+	Attribute MachineGroupAttribute `json:"groupAttribute"`
 
 	CreateTime     uint32
 	LastModifyTime uint32
@@ -27,12 +29,14 @@ type MachineGroup struct {
 	project *LogProject
 }
 
+// Machine define the Machine
 type Machine struct {
 	IP            string
-	UniqueId      string `json:"machine-uniqueid"`
+	UniqueID      string `json:"machine-uniqueid"`
-	UserdefinedId string `json:"userdefined-id"`
+	UserdefinedID string `json:"userdefined-id"`
 }
 
+// MachineList define the Machine List
 type MachineList struct {
 	Total    int
 	Machines []*Machine

logs/alils/request.go

@@ -33,12 +33,12 @@ func request(project *LogProject, method, uri string, headers map[string]string,
 	}
 
 	// Calc Authorization
-	// Authorization = "SLS <AccessKeyId>:<Signature>"
+	// Authorization = "SLS <AccessKeyID>:<Signature>"
 	digest, err := signature(project, method, uri, headers)
 	if err != nil {
 		return
 	}
-	auth := fmt.Sprintf("SLS %v:%v", project.AccessKeyId, digest)
+	auth := fmt.Sprintf("SLS %v:%v", project.AccessKeyID, digest)
 	headers["Authorization"] = auth
 
 	// Initialize http request

logs/file.go

@@ -170,7 +170,7 @@ func (w *fileLogWriter) initFd() error {
 	fd := w.fileWriter
 	fInfo, err := fd.Stat()
 	if err != nil {
-		return fmt.Errorf("get stat err: %s\n", err)
+		return fmt.Errorf("get stat err: %s", err)
 	}
 	w.maxSizeCurSize = int(fInfo.Size())
 	w.dailyOpenTime = time.Now()

logs/log.go

@@ -492,9 +492,9 @@ func (bl *BeeLogger) flush() {
 }
 
 // beeLogger references the used application logger.
-var beeLogger *BeeLogger = NewLogger()
+var beeLogger = NewLogger()
 
-// GetLogger returns the default BeeLogger
+// GetBeeLogger returns the default BeeLogger
 func GetBeeLogger() *BeeLogger {
 	return beeLogger
 }
@@ -534,6 +534,7 @@ func Reset() {
 	beeLogger.Reset()
 }
 
+// Async set the beelogger with Async mode and hold msglen messages
 func Async(msgLen ...int64) *BeeLogger {
 	return beeLogger.Async(msgLen...)
 }

logs/logger.go

@@ -139,6 +139,11 @@ var (
 	reset = string([]byte{27, 91, 48, 109})
 )
 
+// ColorByStatus return color by http code
+// 2xx return Green
+// 3xx return White
+// 4xx return Yellow
+// 5xx return Red
 func ColorByStatus(cond bool, code int) string {
 	switch {
 	case code >= 200 && code < 300:
@@ -152,6 +157,14 @@ func ColorByStatus(cond bool, code int) string {
 	}
 }
 
+// ColorByMethod return color by http code
+// GET return Blue
+// POST return Cyan
+// PUT return Yellow
+// DELETE return Red
+// PATCH return Green
+// HEAD return Magenta
+// OPTIONS return WHITE
 func ColorByMethod(cond bool, method string) string {
 	switch method {
 	case "GET":
@@ -173,10 +186,10 @@ func ColorByMethod(cond bool, method string) string {
 	}
 }
 
-// Guard Mutex to guarantee atomicity of W32Debug(string) function
+// Guard Mutex to guarantee atomic of W32Debug(string) function
 var mu sync.Mutex
 
-// Helper method to output colored logs in Windows terminals
+// W32Debug Helper method to output colored logs in Windows terminals
 func W32Debug(msg string) {
 	mu.Lock()
 	defer mu.Unlock()

orm/db.go

@@ -507,10 +507,9 @@ func (d *dbBase) InsertOrUpdate(q dbQuerier, mi *modelInfo, ind reflect.Value, a
 	case DRPostgres:
 		if len(args) == 0 {
 			return 0, fmt.Errorf("`%s` use InsertOrUpdate must have a conflict column", a.DriverName)
-		} else {
+		}
 		args0 = strings.ToLower(args[0])
 		iouStr = fmt.Sprintf("ON CONFLICT (%s) DO UPDATE SET", args0)
-		}
 	default:
 		return 0, fmt.Errorf("`%s` nonsupport InsertOrUpdate in beego", a.DriverName)
 	}

orm/db_alias.go

@@ -250,7 +250,7 @@ func RegisterDriver(driverName string, typ DriverType) error {
 		drivers[driverName] = typ
 	} else {
 		if t != typ {
-			return fmt.Errorf("driverName `%s` db driver already registered and is other type\n", driverName)
+			return fmt.Errorf("driverName `%s` db driver already registered and is other type", driverName)
 		}
 	}
 	return nil
@@ -261,7 +261,7 @@ func SetDataBaseTZ(aliasName string, tz *time.Location) error {
 	if al, ok := dataBaseCache.get(aliasName); ok {
 		al.TZ = tz
 	} else {
-		return fmt.Errorf("DataBase alias name `%s` not registered\n", aliasName)
+		return fmt.Errorf("DataBase alias name `%s` not registered", aliasName)
 	}
 	return nil
 }
@@ -296,5 +296,5 @@ func GetDB(aliasNames ...string) (*sql.DB, error) {
 	if ok {
 		return al.DB, nil
 	}
-	return nil, fmt.Errorf("DataBase of alias name `%s` not found\n", name)
+	return nil, fmt.Errorf("DataBase of alias name `%s` not found", name)
 }

session/session.go

@@ -81,6 +81,7 @@ func Register(name string, provide Provider) {
 	provides[name] = provide
 }
 
+// ManagerConfig define the session config
 type ManagerConfig struct {
 	CookieName              string `json:"cookieName"`
 	EnableSetCookie         bool   `json:"enableSetCookie,omitempty"`
@@ -92,9 +93,9 @@ type ManagerConfig struct {
 	ProviderConfig          string `json:"providerConfig"`
 	Domain                  string `json:"domain"`
 	SessionIDLength         int64  `json:"sessionIDLength"`
-	EnableSidInHttpHeader   bool   `json:"enableSidInHttpHeader"`
+	EnableSidInHTTPHeader   bool   `json:"EnableSidInHTTPHeader"`
-	SessionNameInHttpHeader string `json:"sessionNameInHttpHeader"`
+	SessionNameInHTTPHeader string `json:"SessionNameInHTTPHeader"`
-	EnableSidInUrlQuery     bool   `json:"enableSidInUrlQuery"`
+	EnableSidInURLQuery     bool   `json:"EnableSidInURLQuery"`
 }
 
 // Manager contains Provider and its configuration.
@@ -125,14 +126,14 @@ func NewManager(provideName string, cf *ManagerConfig) (*Manager, error) {
 		cf.Maxlifetime = cf.Gclifetime
 	}
 
-	if cf.EnableSidInHttpHeader {
+	if cf.EnableSidInHTTPHeader {
-		if cf.SessionNameInHttpHeader == "" {
+		if cf.SessionNameInHTTPHeader == "" {
-			panic(errors.New("SessionNameInHttpHeader is empty"))
+			panic(errors.New("SessionNameInHTTPHeader is empty"))
 		}
 
-		strMimeHeader := textproto.CanonicalMIMEHeaderKey(cf.SessionNameInHttpHeader)
+		strMimeHeader := textproto.CanonicalMIMEHeaderKey(cf.SessionNameInHTTPHeader)
-		if cf.SessionNameInHttpHeader != strMimeHeader {
+		if cf.SessionNameInHTTPHeader != strMimeHeader {
-			strErrMsg := "SessionNameInHttpHeader (" + cf.SessionNameInHttpHeader + ") has the wrong format, it should be like this : " + strMimeHeader
+			strErrMsg := "SessionNameInHTTPHeader (" + cf.SessionNameInHTTPHeader + ") has the wrong format, it should be like this : " + strMimeHeader
 			panic(errors.New(strErrMsg))
 		}
 	}
@@ -163,7 +164,7 @@ func (manager *Manager) getSid(r *http.Request) (string, error) {
 	cookie, errs := r.Cookie(manager.config.CookieName)
 	if errs != nil || cookie.Value == "" {
 		var sid string
-		if manager.config.EnableSidInUrlQuery {
+		if manager.config.EnableSidInURLQuery {
 			errs := r.ParseForm()
 			if errs != nil {
 				return "", errs
@@ -173,8 +174,8 @@ func (manager *Manager) getSid(r *http.Request) (string, error) {
 		}
 
 		// if not found in Cookie / param, then read it from request headers
-		if manager.config.EnableSidInHttpHeader && sid == "" {
+		if manager.config.EnableSidInHTTPHeader && sid == "" {
-			sids, isFound := r.Header[manager.config.SessionNameInHttpHeader]
+			sids, isFound := r.Header[manager.config.SessionNameInHTTPHeader]
 			if isFound && len(sids) != 0 {
 				return sids[0], nil
 			}
@@ -226,9 +227,9 @@ func (manager *Manager) SessionStart(w http.ResponseWriter, r *http.Request) (se
 	}
 	r.AddCookie(cookie)
 
-	if manager.config.EnableSidInHttpHeader {
+	if manager.config.EnableSidInHTTPHeader {
-		r.Header.Set(manager.config.SessionNameInHttpHeader, sid)
+		r.Header.Set(manager.config.SessionNameInHTTPHeader, sid)
-		w.Header().Set(manager.config.SessionNameInHttpHeader, sid)
+		w.Header().Set(manager.config.SessionNameInHTTPHeader, sid)
 	}
 
 	return
@@ -236,9 +237,9 @@ func (manager *Manager) SessionStart(w http.ResponseWriter, r *http.Request) (se
 
 // SessionDestroy Destroy session by its id in http request cookie.
 func (manager *Manager) SessionDestroy(w http.ResponseWriter, r *http.Request) {
-	if manager.config.EnableSidInHttpHeader {
+	if manager.config.EnableSidInHTTPHeader {
-		r.Header.Del(manager.config.SessionNameInHttpHeader)
+		r.Header.Del(manager.config.SessionNameInHTTPHeader)
-		w.Header().Del(manager.config.SessionNameInHttpHeader)
+		w.Header().Del(manager.config.SessionNameInHTTPHeader)
 	}
 
 	cookie, err := r.Cookie(manager.config.CookieName)
@@ -306,9 +307,9 @@ func (manager *Manager) SessionRegenerateID(w http.ResponseWriter, r *http.Reque
 	}
 	r.AddCookie(cookie)
 
-	if manager.config.EnableSidInHttpHeader {
+	if manager.config.EnableSidInHTTPHeader {
-		r.Header.Set(manager.config.SessionNameInHttpHeader, sid)
+		r.Header.Set(manager.config.SessionNameInHTTPHeader, sid)
-		w.Header().Set(manager.config.SessionNameInHttpHeader, sid)
+		w.Header().Set(manager.config.SessionNameInHTTPHeader, sid)
 	}
 
 	return
@@ -328,7 +329,7 @@ func (manager *Manager) sessionID() (string, error) {
 	b := make([]byte, manager.config.SessionIDLength)
 	n, err := rand.Read(b)
 	if n != len(b) || err != nil {
-		return "", fmt.Errorf("Could not successfully read from the system CSPRNG.")
+		return "", fmt.Errorf("Could not successfully read from the system CSPRNG")
 	}
 	return hex.EncodeToString(b), nil
 }

session/ssdb/sess_ssdb.go

@@ -11,16 +11,17 @@ import (
 	"github.com/ssdb/gossdb/ssdb"
 )
 
-var ssdbProvider = &SsdbProvider{}
+var ssdbProvider = &Provider{}
 
-type SsdbProvider struct {
+// Provider holds ssdb client and configs
+type Provider struct {
 	client      *ssdb.Client
 	host        string
 	port        int
 	maxLifetime int64
 }
 
-func (p *SsdbProvider) connectInit() error {
+func (p *Provider) connectInit() error {
 	var err error
 	if p.host == "" || p.port == 0 {
 		return errors.New("SessionInit First")
@@ -29,7 +30,8 @@ func (p *SsdbProvider) connectInit() error {
 	return err
 }
 
-func (p *SsdbProvider) SessionInit(maxLifetime int64, savePath string) error {
+// SessionInit init the ssdb with the config
+func (p *Provider) SessionInit(maxLifetime int64, savePath string) error {
 	p.maxLifetime = maxLifetime
 	address := strings.Split(savePath, ":")
 	p.host = address[0]
@@ -41,7 +43,8 @@ func (p *SsdbProvider) SessionInit(maxLifetime int64, savePath string) error {
 	return p.connectInit()
 }
 
-func (p *SsdbProvider) SessionRead(sid string) (session.Store, error) {
+// SessionRead return a ssdb client session Store
+func (p *Provider) SessionRead(sid string) (session.Store, error) {
 	if p.client == nil {
 		if err := p.connectInit(); err != nil {
 			return nil, err
@@ -64,7 +67,8 @@ func (p *SsdbProvider) SessionRead(sid string) (session.Store, error) {
 	return rs, nil
 }
 
-func (p *SsdbProvider) SessionExist(sid string) bool {
+// SessionExist judged whether sid is exist in session
+func (p *Provider) SessionExist(sid string) bool {
 	if p.client == nil {
 		if err := p.connectInit(); err != nil {
 			panic(err)
@@ -80,7 +84,8 @@ func (p *SsdbProvider) SessionExist(sid string) bool {
 	return true
 }
 
-func (p *SsdbProvider) SessionRegenerate(oldsid, sid string) (session.Store, error) {
+// SessionRegenerate regenerate session with new sid and delete oldsid
+func (p *Provider) SessionRegenerate(oldsid, sid string) (session.Store, error) {
 	//conn.Do("setx", key, v, ttl)
 	if p.client == nil {
 		if err := p.connectInit(); err != nil {
@@ -112,7 +117,8 @@ func (p *SsdbProvider) SessionRegenerate(oldsid, sid string) (session.Store, err
 	return rs, nil
 }
 
-func (p *SsdbProvider) SessionDestroy(sid string) error {
+// SessionDestroy destroy the sid
+func (p *Provider) SessionDestroy(sid string) error {
 	if p.client == nil {
 		if err := p.connectInit(); err != nil {
 			return err
@@ -122,13 +128,16 @@ func (p *SsdbProvider) SessionDestroy(sid string) error {
 	return err
 }
 
-func (p *SsdbProvider) SessionGC() {
+// SessionGC not implemented
+func (p *Provider) SessionGC() {
 }
 
-func (p *SsdbProvider) SessionAll() int {
+// SessionAll not implemented
+func (p *Provider) SessionAll() int {
 	return 0
 }
 
+// SessionStore holds the session information which stored in ssdb
 type SessionStore struct {
 	sid         string
 	lock        sync.RWMutex
@@ -137,12 +146,15 @@ type SessionStore struct {
 	client      *ssdb.Client
 }
 
+// Set the key and value
 func (s *SessionStore) Set(key, value interface{}) error {
 	s.lock.Lock()
 	defer s.lock.Unlock()
 	s.values[key] = value
 	return nil
 }
+
+// Get return the value by the key
 func (s *SessionStore) Get(key interface{}) interface{} {
 	s.lock.Lock()
 	defer s.lock.Unlock()
@@ -152,30 +164,36 @@ func (s *SessionStore) Get(key interface{}) interface{} {
 	return nil
 }
 
+// Delete the key in session store
 func (s *SessionStore) Delete(key interface{}) error {
 	s.lock.Lock()
 	defer s.lock.Unlock()
 	delete(s.values, key)
 	return nil
 }
+
+// Flush delete all keys and values
 func (s *SessionStore) Flush() error {
 	s.lock.Lock()
 	defer s.lock.Unlock()
 	s.values = make(map[interface{}]interface{})
 	return nil
 }
+
+// SessionID return the sessionID
 func (s *SessionStore) SessionID() string {
 	return s.sid
 }
 
+// SessionRelease Store the keyvalues into ssdb
 func (s *SessionStore) SessionRelease(w http.ResponseWriter) {
 	b, err := session.EncodeGob(s.values)
 	if err != nil {
 		return
 	}
 	s.client.Do("setx", s.sid, string(b), s.maxLifetime)
-
 }
+
 func init() {
 	session.Register("ssdb", ssdbProvider)
 }

swagger/swagger.go

@@ -100,7 +100,7 @@ type Parameter struct {
 	Default     interface{}     `json:"default,omitempty" yaml:"default,omitempty"`
 }
 
-// A limited subset of JSON-Schema's items object. It is used by parameter definitions that are not located in "body".
+// ParameterItems A limited subset of JSON-Schema's items object. It is used by parameter definitions that are not located in "body".
 // http://swagger.io/specification/#itemsObject
 type ParameterItems struct {
 	Type             string            `json:"type,omitempty" yaml:"type,omitempty"`