go fmt and go lint error fixes to improve goreportcard (#126)

* go fmt on some files

* go fmt

* added comments on exported types

Author: Guy Baron

gbus/invocation.go

@@ -32,6 +32,7 @@ func (dfi *defaultInvocationContext) Log() logrus.FieldLogger {
 	return dfi.Glogged.Log().WithFields(logrus.Fields{"routing_key": dfi.routingKey, "message_id": dfi.inboundMsg.ID})
 }
 
+//Reply implements the Invocation.Reply signature
 func (dfi *defaultInvocationContext) Reply(ctx context.Context, replyMessage *BusMessage) error {
 	if dfi.inboundMsg != nil {
 		replyMessage.CorrelationID = dfi.inboundMsg.ID
@@ -51,13 +52,15 @@ func (dfi *defaultInvocationContext) Reply(ctx context.Context, replyMessage *Bu
 	return err
 }
 
+//Send implements the Invocation.Send signature
 func (dfi *defaultInvocationContext) Send(ctx context.Context, toService string, command *BusMessage, policies ...MessagePolicy) error {
 	if dfi.tx != nil {
 		return dfi.bus.sendWithTx(ctx, dfi.tx, toService, command, policies...)
 	}
 	return dfi.bus.Send(ctx, toService, command, policies...)
 }
 
+//Publish implements the Invocation.Publish signature
 func (dfi *defaultInvocationContext) Publish(ctx context.Context, exchange, topic string, event *BusMessage, policies ...MessagePolicy) error {
 
 	if dfi.tx != nil {
@@ -66,26 +69,32 @@ func (dfi *defaultInvocationContext) Publish(ctx context.Context, exchange, topi
 	return dfi.bus.Publish(ctx, exchange, topic, event, policies...)
 }
 
+//RPC implements the Invocation.RPC signature
 func (dfi *defaultInvocationContext) RPC(ctx context.Context, service string, request, reply *BusMessage, timeout time.Duration) (*BusMessage, error) {
 	return dfi.bus.RPC(ctx, service, request, reply, timeout)
 }
 
+//Bus implements the Invocation.Bus signature
 func (dfi *defaultInvocationContext) Bus() Messaging {
 	return dfi
 }
 
+//Tx implements the Invocation.Tx signature
 func (dfi *defaultInvocationContext) Tx() *sql.Tx {
 	return dfi.tx
 }
 
+//Ctx implements the Invocation.Ctx signature
 func (dfi *defaultInvocationContext) Ctx() context.Context {
 	return dfi.ctx
 }
 
+//Routing implements the Invocation.Routing signature
 func (dfi *defaultInvocationContext) Routing() (exchange, routingKey string) {
 	return dfi.exchange, dfi.routingKey
 }
 
+//DeliveryInfo implements the Invocation.DeliveryInfo signature
 func (dfi *defaultInvocationContext) DeliveryInfo() DeliveryInfo {
 	return dfi.deliveryInfo
 }

gbus/message_handler.go

@@ -9,6 +9,7 @@ import (
 //MessageHandler signature for all command handlers
 type MessageHandler func(invocation Invocation, message *BusMessage) error
 
+//Name is a helper function returning the runtime name of the function bound to an instance of the MessageHandler type
 func (mg MessageHandler) Name() string {
 	funName := runtime.FuncForPC(reflect.ValueOf(mg).Pointer()).Name()
 	splits := strings.Split(funName, ".")

gbus/metrics/handler_metrics.go

@@ -2,10 +2,11 @@ package metrics
 
 import (
 	"fmt"
+	"sync"
+
 	"github.com/prometheus/client_golang/prometheus"
-	"github.com/prometheus/client_model/go"
+	io_prometheus_client "github.com/prometheus/client_model/go"
 	"github.com/sirupsen/logrus"
-	"sync"
 )
 
 var (
@@ -20,7 +21,7 @@ const (
 	grabbitPrefix = "grabbit"
 )
 
-type HandlerMetrics struct {
+type handlerMetrics struct {
 	result  *prometheus.CounterVec
 	latency prometheus.Summary
 }
@@ -62,17 +63,17 @@ func RunHandlerWithMetric(handleMessage func() error, handlerName string, logger
 	return err
 }
 
-func GetHandlerMetrics(handlerName string) *HandlerMetrics {
+func GetHandlerMetrics(handlerName string) *handlerMetrics {
 	entry, ok := handlerMetricsByHandlerName.Load(handlerName)
 	if ok {
-		return entry.(*HandlerMetrics)
+		return entry.(*handlerMetrics)
 	}
 
 	return nil
 }
 
-func newHandlerMetrics(handlerName string) *HandlerMetrics {
-	return &HandlerMetrics{
+func newHandlerMetrics(handlerName string) *handlerMetrics {
+	return &handlerMetrics{
 		result: prometheus.NewCounterVec(
 			prometheus.CounterOpts{
 				Namespace: grabbitPrefix,
@@ -98,15 +99,15 @@ func trackTime(functionToTrack func() error, observer prometheus.Observer) error
 	return functionToTrack()
 }
 
-func (hm *HandlerMetrics) GetSuccessCount() (float64, error) {
+func (hm *handlerMetrics) GetSuccessCount() (float64, error) {
 	return hm.getLabeledCounterValue(success)
 }
 
-func (hm *HandlerMetrics) GetFailureCount() (float64, error) {
+func (hm *handlerMetrics) GetFailureCount() (float64, error) {
 	return hm.getLabeledCounterValue(failure)
 }
 
-func (hm *HandlerMetrics) GetLatencySampleCount() (*uint64, error) {
+func (hm *handlerMetrics) GetLatencySampleCount() (*uint64, error) {
 	m := &io_prometheus_client.Metric{}
 	err := hm.latency.Write(m)
 	if err != nil {
@@ -116,7 +117,7 @@ func (hm *HandlerMetrics) GetLatencySampleCount() (*uint64, error) {
 	return m.GetSummary().SampleCount, nil
 }
 
-func (hm *HandlerMetrics) getLabeledCounterValue(label string) (float64, error) {
+func (hm *handlerMetrics) getLabeledCounterValue(label string) (float64, error) {
 	m := &io_prometheus_client.Metric{}
 	err := hm.result.WithLabelValues(label).Write(m)
 

gbus/metrics/message_metrics.go

@@ -32,4 +32,4 @@ func newRejectedMessagesCounter() prometheus.Counter {
 		Name:      "rejected_messages",
 		Help:      "counting the rejected messages",
 	})
-}
+}

gbus/metrics/saga_metrics.go

@@ -6,8 +6,10 @@ import (
 	io_prometheus_client "github.com/prometheus/client_model/go"
 )
 
+//SagaTimeoutCounter is the prometheus counter counting timed out saga instances
 var SagaTimeoutCounter = newSagaTimeoutCounter()
 
+//GetSagaTimeoutCounterValue gets the counter value of timed out sagas reported to prometheus
 func GetSagaTimeoutCounterValue() (float64, error) {
 	m := &io_prometheus_client.Metric{}
 	err := SagaTimeoutCounter.Write(m)

gbus/outbox.go

@@ -50,6 +50,7 @@ func (out *AMQPOutbox) init(amqp *amqp.Channel, confirm, resendOnNack bool) erro
 	return nil
 }
 
+//Shutdown stops the outbox
 func (out *AMQPOutbox) Shutdown() {
 	close(out.stop)
 

tests/metrics_test.go

@@ -8,7 +8,7 @@ import (
 )
 
 var (
-	logger  logrus.FieldLogger
+	logger       logrus.FieldLogger
 	runningTries = 5
 )