Merge branch 'master' of github.com:smancke/guble into feature/add-mo…

…re-logging-for-handle-message

client/mocks_client_gen_test.go

@@ -4,9 +4,9 @@
 package client
 
 import (
-	gomock "github.com/golang/mock/gomock"
+	"github.com/golang/mock/gomock"
 
-	protocol "github.com/smancke/guble/protocol"
+	"github.com/smancke/guble/protocol"
 )
 
 // Mock of WSConnection interface

logformatter/logstash_formatter.go

@@ -9,6 +9,12 @@ import (
 	"time"
 )
 
+const (
+	defaultServiceName     = "guble"
+	defaultLogType         = "application"
+	defaultApplicationType = "service"
+)
+
 // LogstashFormatter generates json in logstash format.
 // Logstash site: http://logstash.net/
 type LogstashFormatter struct {
@@ -22,21 +28,34 @@ type LogstashFormatter struct {
 	//ServiceName will be by default guble
 	ServiceName string
 
-	//ApplicationType will be  by default "service".Other values could be "service", "system", "appserver", "webserver"
+	//ApplicationType will be  by default "service". Other values could be "service", "system", "appserver", "webserver"
 	ApplicationType string
 
-	//LogType will be by default  application.Other possible values "access", "error", "application", "system"
+	//LogType will be by default  application. Other possible values "access", "error", "application", "system"
 	LogType string
 
-	// TimestampFormat sets the format used for timestamps.
+	//TimestampFormat sets the format used for timestamps.
 	TimestampFormat string
 }
 
 // Format the logrus entry to a byte slice, or return an error.
 func (f *LogstashFormatter) Format(entry *logrus.Entry) ([]byte, error) {
 	fields := make(logrus.Fields)
+
 	for k, v := range entry.Data {
-		fields[k] = v
+		switch v := v.(type) {
+		case error:
+			// Otherwise errors are ignored by `encoding/json`
+			// https://github.com/Sirupsen/logrus/issues/137
+			// https://github.com/sirupsen/logrus/issues/377
+			fields[k] = v.Error()
+		default:
+			fields[k] = v
+		}
+	}
+
+	if f.Env != "" {
+		fields["environment"] = f.Env
 	}
 
 	timeStampFormat := f.TimestampFormat
@@ -49,54 +68,49 @@ func (f *LogstashFormatter) Format(entry *logrus.Entry) ([]byte, error) {
 	if f.ServiceName != "" {
 		fields["service"] = f.ServiceName
 	} else {
-		fields["service"] = "guble"
+		fields["service"] = defaultServiceName
 	}
 
 	if f.ApplicationType != "" {
 		fields["application_type"] = f.ServiceName
 	} else {
-		fields["application_type"] = "service"
+		fields["application_type"] = defaultApplicationType
 	}
 
 	if f.LogType != "" {
 		fields["log_type"] = f.LogType
 	} else {
-		fields["log_type"] = "application"
+		fields["log_type"] = defaultLogType
 	}
 
-	fields["environment"] = f.Env
-
-	// set message field
-	v, ok := entry.Data["message"]
-	if ok {
-		fields["fields.message"] = v
-	}
-	fields["message"] = entry.Message
-
-	// set level field
-	v, ok = entry.Data["level"]
-	if ok {
-		fields["fields.level"] = v
+	// set level field, prefixing fields clashes
+	if v, ok := entry.Data["loglevel"]; ok {
+		fields["fields.loglevel"] = v
 	}
 	fields["loglevel"] = entry.Level.String()
 
-	//set host field
-	hostname, err := os.Hostname()
-	if err == nil {
+	//set host field, prefixing fields clashes
+	if v, ok := entry.Data["host"]; ok {
+		fields["fields.host"] = v
+	}
+	if hostname, err := os.Hostname(); err == nil {
 		fields["host"] = hostname
-	} else {
-		fields["host"] = ""
 	}
 
 	// set type field
 	if f.Type != "" {
-		v, ok = entry.Data["type"]
-		if ok {
+		if v, ok := entry.Data["type"]; ok {
 			fields["fields.type"] = v
 		}
 		fields["type"] = f.Type
 	}
 
+	// set message field, prefixing fields clashes
+	if v, ok := entry.Data["msg"]; ok {
+		fields["fields.msg"] = v
+	}
+	fields["msg"] = entry.Message
+
 	serialized, err := json.Marshal(fields)
 	if err != nil {
 		return nil, fmt.Errorf("Failed to marshal fields to JSON, %v", err)

logformatter/logstash_formatter_test.go

@@ -15,12 +15,12 @@ func TestLogstashFormatter_Format(t *testing.T) {
 	lf := LogstashFormatter{Type: "abc", ServiceName: "guble", Env: "prod"}
 
 	fields := logrus.Fields{
-		"message": "def",
-		"level":   "ijk",
-		"type":    "lmn",
-		"one":     1,
-		"pi":      3.14,
-		"bool":    true,
+		"msg":   "def",
+		"level": "ijk",
+		"type":  "lmn",
+		"one":   1,
+		"pi":    3.14,
+		"bool":  true,
 	}
 
 	entry := logrus.WithFields(fields)
@@ -43,11 +43,11 @@ func TestLogstashFormatter_Format(t *testing.T) {
 	a.NotEmpty(data["@timestamp"])
 	a.NotEmpty(data["host"])
 	a.Equal("abc", data["type"])
-	a.Equal("msg", data["message"])
+	a.Equal("msg", data["msg"])
 	a.Equal("info", data["loglevel"])
 
 	// substituted fields
-	a.Equal("def", data["fields.message"])
+	a.Equal("def", data["fields.msg"])
 	a.Equal("lmn", data["fields.type"])
 
 	// formats

protocol/message.go

@@ -39,6 +39,7 @@ type Message struct {
 	// The message payload
 	Body []byte
 
+	// Used in cluster mode to identify a guble node
 	NodeID uint8
 }
 

scripts/generate_mocks.sh

@@ -8,7 +8,6 @@ if [ -z "$GOPATH" ]; then
       exit 1
 fi
 
-
 # replace in file if last operation was successful
 function replace {
       FILE=$1; shift;
@@ -25,15 +24,15 @@ MOCKGEN=$GOPATH/bin/mockgen
 $MOCKGEN  -self_package service -package service \
       -destination server/service/mocks_router_gen_test.go \
       github.com/smancke/guble/server/router \
-      Router
+      Router &
 
 $MOCKGEN -self_package service -package service \
       -destination server/service/mocks_checker_gen_test.go \
       github.com/docker/distribution/health \
-      Checker
+      Checker &
 
 # server/router mocks
-$MOCKGEN  -self_package router -package router \
+$MOCKGEN -self_package router -package router \
       -destination server/router/mocks_router_gen_test.go \
       github.com/smancke/guble/server/router \
       Router
@@ -42,22 +41,22 @@ replace "server/router/mocks_router_gen_test.go" "router \"github.com\/smancke\/
 $MOCKGEN -self_package router -package router \
       -destination server/router/mocks_store_gen_test.go \
       github.com/smancke/guble/server/store \
-      MessageStore
+      MessageStore &
 
 $MOCKGEN -self_package router -package router \
       -destination server/router/mocks_kvstore_gen_test.go \
       github.com/smancke/guble/server/kvstore \
-      KVStore
+      KVStore &
 
 $MOCKGEN -self_package router -package router \
       -destination server/router/mocks_auth_gen_test.go \
       github.com/smancke/guble/server/auth \
-      AccessManager
+      AccessManager &
 
 $MOCKGEN -self_package router -package router \
       -destination server/router/mocks_checker_gen_test.go \
       github.com/docker/distribution/health \
-      Checker
+      Checker &
 
 # client mocks
 $MOCKGEN  -self_package client -package client \
@@ -66,82 +65,68 @@ $MOCKGEN  -self_package client -package client \
       WSConnection,Client
 replace "client/mocks_client_gen_test.go" "client \"github.com\/smancke\/guble\/client\"" "client\."
 
-
 # server/apns mocks
 $MOCKGEN -package apns \
       -destination server/apns/mocks_router_gen_test.go \
       github.com/smancke/guble/server/router \
-      Router
+      Router &
+
 $MOCKGEN -package apns \
       -destination server/apns/mocks_kvstore_gen_test.go \
       github.com/smancke/guble/server/kvstore \
-      KVStore
-$MOCKGEN -package apns \
-      -destination server/apns/mocks_sender_gen_test.go \
-      github.com/smancke/guble/server/connector \
-      Sender
-$MOCKGEN -package apns \
-      -destination server/apns/mocks_request_gen_test.go \
-      github.com/smancke/guble/server/connector \
-      Request
-$MOCKGEN -package apns \
-      -destination server/apns/mocks_subscriber_gen_test.go \
-      github.com/smancke/guble/server/connector \
-      Subscriber
-$MOCKGEN -package apns \
-      -destination server/apns/mocks_sender_gen_test.go \
-      github.com/smancke/guble/server/connector \
-      Sender
+      KVStore &
+
 $MOCKGEN -package apns \
-      -destination server/apns/mocks_subscriber_gen_test.go \
+      -destination server/apns/mocks_connector_gen_test.go \
       github.com/smancke/guble/server/connector \
-      Subscriber
+      Sender,Request,Subscriber &
+
 $MOCKGEN -package apns \
       -destination server/apns/mocks_pusher_gen_test.go \
       github.com/smancke/guble/server/apns \
-      Pusher
+      Pusher &
 
 # server/fcm mocks
 $MOCKGEN -package fcm \
       -destination server/fcm/mocks_router_gen_test.go \
       github.com/smancke/guble/server/router \
-      Router
+      Router &
 
 $MOCKGEN -self_package fcm -package fcm \
       -destination server/fcm/mocks_kvstore_gen_test.go \
       github.com/smancke/guble/server/kvstore \
-      KVStore
+      KVStore &
 
 $MOCKGEN -self_package fcm -package fcm \
       -destination server/fcm/mocks_store_gen_test.go \
       github.com/smancke/guble/server/store \
-      MessageStore
+      MessageStore &
 
 $MOCKGEN -self_package fcm -package fcm \
       -destination server/fcm/mocks_gcm_gen_test.go \
       github.com/Bogh/gcm \
-      Sender
+      Sender &
 
 # server mocks
 $MOCKGEN -package server \
       -destination server/mocks_router_gen_test.go \
       github.com/smancke/guble/server/router \
-      Router
+      Router &
 
 $MOCKGEN -self_package server -package server \
       -destination server/mocks_auth_gen_test.go \
       github.com/smancke/guble/server/auth \
-      AccessManager
+      AccessManager &
 
 $MOCKGEN -self_package server -package server \
       -destination server/mocks_store_gen_test.go \
       github.com/smancke/guble/server/store \
-      MessageStore
+      MessageStore &
 
 $MOCKGEN -package server \
       -destination server/mocks_apns_pusher_gen_test.go \
       github.com/smancke/guble/server/apns \
-      Pusher
+      Pusher &
 
 # server/auth mocks
 $MOCKGEN -self_package auth -package auth \
@@ -164,12 +149,12 @@ replace "server/connector/mocks_connector_gen_test.go" \
 $MOCKGEN -self_package connector -package connector \
       -destination server/connector/mocks_router_gen_test.go \
       github.com/smancke/guble/server/router \
-      Router
+      Router &
 
 $MOCKGEN -self_package connector -package connector \
       -destination server/connector/mocks_kvstore_gen_test.go \
       github.com/smancke/guble/server/kvstore \
-      KVStore
+      KVStore &
 
 # server/websocket mocks
 $MOCKGEN  -self_package websocket -package websocket \
@@ -183,35 +168,38 @@ replace "server/websocket/mocks_websocket_gen_test.go" \
 $MOCKGEN -self_package websocket -package websocket \
       -destination server/websocket/mocks_router_gen_test.go \
       github.com/smancke/guble/server/router \
-      Router
+      Router &
 
 $MOCKGEN -self_package websocket -package websocket \
       -destination server/websocket/mocks_store_gen_test.go \
       github.com/smancke/guble/server/store \
-      MessageStore
+      MessageStore &
 
 $MOCKGEN -self_package websocket -package websocket \
       -destination server/websocket/mocks_auth_gen_test.go \
       github.com/smancke/guble/server/auth \
-      AccessManager
+      AccessManager &
 
 # server/rest Mocks
 $MOCKGEN -package rest \
       -destination server/rest/mocks_router_gen_test.go \
       github.com/smancke/guble/server/router \
-      Router
+      Router &
 
 # server/sms Mocks
 $MOCKGEN -package sms \
       -destination server/sms/mocks_sender_gen_test.go \
       github.com/smancke/guble/server/sms \
-      Sender
+      Sender &
 
 $MOCKGEN -package sms \
       -destination server/sms/mocks_router_gen_test.go \
       github.com/smancke/guble/server/router \
-      Router
+      Router &
+
 $MOCKGEN -self_package router -package sms \
       -destination server/sms/mocks_store_gen_test.go \
       github.com/smancke/guble/server/store \
-      MessageStore
+      MessageStore &
+
+wait