add gofmt, golint and go vet checks (contiv#13)

Author: shaleman

Makefile

@@ -19,6 +19,7 @@ test: start build
 	vagrant ssh node1 -c 'cd /opt/gopath/src/github.com/contiv/objdb && make host-test'
 
 host-build:
+	./checks "./*.go ./modeldb"
 	go get github.com/tools/godep
 	godep go install ./ ./modeldb
 

checks

@@ -0,0 +1,60 @@
+#!/bin/bash
+
+#performs basic dev and build environment checks
+
+USAGE="Usage: $0 <build packages>"
+
+if [ $# -ne 1 ]; then
+    echo $USAGE
+    exit 1
+fi
+
+BUILD_PKGS=$1
+
+if ! go get github.com/golang/lint/golint
+then
+  echo "!!! Could not install golint"
+  exit 1
+fi
+
+echo "+++ Checking gofmt..."
+fmtRes=$(gofmt -l $BUILD_PKGS)
+if [ -n "${fmtRes}" ]; then
+    echo -e "!!! gofmt checking failed:\n${fmtRes}\n"
+    exit 1
+fi
+
+echo "+++ golint tree..."
+for i in ${BUILD_PKGS}
+do
+    tmp="$(golint ${i})"
+    if [ -n "$tmp" ]
+    then
+      lintOutput="${lintOutput}\n${tmp}" # golint has no exit codes
+    fi
+done
+
+if [ -n "${lintOutput}" ]
+then
+    echo -e "!!! golint checking failed:\n${lintOutput}\n"
+    exit 1
+fi
+
+echo "+++ go vet tree..."
+for i in ${BUILD_PKGS}
+do
+    tmp="$(go vet ${i} 2>&1)"
+    if [ -n "$tmp" ]
+    then
+      vetOutput="${vetOutput}\n${tmp}"
+    fi
+done
+
+if [ -n "${vetOutput}" ]
+then
+    echo -e "!!! go vet checking failed:\n${vetOutput}\n"
+    exit 1
+fi
+
+echo "+++ All checks passed!!"
+exit 0

etcdClient.go

@@ -33,6 +33,7 @@ type etcdPlugin struct {
 	mutex *sync.Mutex
 }
 
+// EtcdClient has etcd client state
 type EtcdClient struct {
 	client client.Client // etcd client
 	kapi   client.KeysAPI
@@ -94,7 +95,7 @@ func (ep *etcdPlugin) NewClient(endpoints []string) (API, error) {
 	return ec, nil
 }
 
-// Get an object
+// GetObj Get an object
 func (ep *EtcdClient) GetObj(key string, retVal interface{}) error {
 	keyName := "/contiv.io/obj/" + key
 
@@ -128,7 +129,7 @@ func recursAddNode(node *client.Node, list []string) []string {
 	return list
 }
 
-// Get a list of objects in a directory
+// ListDir Get a list of objects in a directory
 func (ep *EtcdClient) ListDir(key string) ([]string, error) {
 	keyName := "/contiv.io/obj/" + key
 
@@ -159,7 +160,7 @@ func (ep *EtcdClient) ListDir(key string) ([]string, error) {
 	return retList, nil
 }
 
-// Save an object, create if it doesnt exist
+// SetObj Save an object, create if it doesnt exist
 func (ep *EtcdClient) SetObj(key string, value interface{}) error {
 	keyName := "/contiv.io/obj/" + key
 
@@ -179,7 +180,7 @@ func (ep *EtcdClient) SetObj(key string, value interface{}) error {
 	return nil
 }
 
-// Remove an object
+// DelObj Remove an object
 func (ep *EtcdClient) DelObj(key string) error {
 	keyName := "/contiv.io/obj/" + key
 
@@ -215,7 +216,7 @@ func httpGetJSON(url string, data interface{}) (interface{}, error) {
 	return data, nil
 }
 
-// Return the local address where etcd is listening
+// GetLocalAddr Return the local address where etcd is listening
 func (ep *EtcdClient) GetLocalAddr() (string, error) {
 	var epData struct {
 		Name string `json:"name"`