Adding linter to circle CI. (#176)

* Adding linter to circle CI.

* Force linting with exit status.

* Appeased the new linter checker.

* Ups.

Author: Skarlso

.circleci/config.yml

@@ -1,6 +1,22 @@
 version: 2
 
 jobs:
+  linter:
+    working_directory: /go/src/github.com/gaia-pipeline/gaia
+    docker:
+      - image: circleci/golang:1.11.4
+        environment:
+          GO111MODULE: "on"
+    steps:
+      - checkout
+      - run:
+          name: Install linter
+          command: |
+            go get -u golang.org/x/lint/golint
+      - run:
+          name: Run linter
+          command: |
+            make lint
   test_and_coverage:
     working_directory: /go/src/github.com/gaia-pipeline/gaia
     docker:
@@ -76,6 +92,7 @@ workflows:
   version: 2
   test_and_compile:
     jobs:
+      - linter
       - test_and_coverage
       - acceptance_tests
       - compile

Makefile

@@ -49,3 +49,6 @@ deploy-kube:
 
 kube-ingress-lb:
 	kubectl apply -R -f ${HELM_DIR}/_system
+
+lint:
+	golint -set_exit_status ./...

gaia.go

@@ -249,6 +249,7 @@ type Config struct {
 	}
 }
 
+// StoreConfig defines config settings to be stored in DB.
 type StoreConfig struct {
 	ID   int
 	Poll bool

plugin/grpc.go

@@ -3,50 +3,50 @@ package plugin
 import (
 	"context"
 
-	"github.com/gaia-pipeline/protobuf"
+	proto "github.com/gaia-pipeline/protobuf"
 	plugin "github.com/hashicorp/go-plugin"
 	"google.golang.org/grpc"
 )
 
-// PluginGRPC is the Gaia plugin interface used for communication
+// GaiaPlugin is the Gaia plugin interface used for communication
 // with the plugin.
-type PluginGRPC interface {
+type GaiaPlugin interface {
 	GetJobs() (proto.Plugin_GetJobsClient, error)
 	ExecuteJob(job *proto.Job) (*proto.JobResult, error)
 }
 
-// GRPCClient represents gRPC client
-type GRPCClient struct {
+// GaiaPluginClient represents gRPC client
+type GaiaPluginClient struct {
 	client proto.PluginClient
 }
 
-// PluginGRPCImpl represents the plugin implementation on client side.
-type PluginGRPCImpl struct {
-	Impl PluginGRPC
+// GaiaPluginImpl represents the plugin implementation on client side.
+type GaiaPluginImpl struct {
+	Impl GaiaPlugin
 
 	plugin.NetRPCUnsupportedPlugin
 }
 
 // GRPCServer is needed here to implement hashicorp
 // plugin.Plugin interface. Real implementation is
 // in the plugin(s).
-func (p *PluginGRPCImpl) GRPCServer(b *plugin.GRPCBroker, s *grpc.Server) error {
+func (p *GaiaPluginImpl) GRPCServer(b *plugin.GRPCBroker, s *grpc.Server) error {
 	// Real implementation defined in plugin
 	return nil
 }
 
 // GRPCClient is the passing method for the gRPC client.
-func (p *PluginGRPCImpl) GRPCClient(context context.Context, b *plugin.GRPCBroker, c *grpc.ClientConn) (interface{}, error) {
-	return &GRPCClient{client: proto.NewPluginClient(c)}, nil
+func (p *GaiaPluginImpl) GRPCClient(context context.Context, b *plugin.GRPCBroker, c *grpc.ClientConn) (interface{}, error) {
+	return &GaiaPluginClient{client: proto.NewPluginClient(c)}, nil
 }
 
 // GetJobs requests all jobs from the plugin.
 // We get a stream of proto.Job back.
-func (m *GRPCClient) GetJobs() (proto.Plugin_GetJobsClient, error) {
+func (m *GaiaPluginClient) GetJobs() (proto.Plugin_GetJobsClient, error) {
 	return m.client.GetJobs(context.Background(), &proto.Empty{})
 }
 
 // ExecuteJob triggers the execution of the given job in the plugin.
-func (m *GRPCClient) ExecuteJob(job *proto.Job) (*proto.JobResult, error) {
+func (m *GaiaPluginClient) ExecuteJob(job *proto.Job) (*proto.JobResult, error) {
 	return m.client.ExecuteJob(context.Background(), job)
 }

plugin/plugin.go

@@ -34,7 +34,7 @@ var handshake = plugin.HandshakeConfig{
 }
 
 var pluginMap = map[string]plugin.Plugin{
-	pluginMapKey: &PluginGRPCImpl{},
+	pluginMapKey: &GaiaPluginImpl{},
 }
 
 // timeFormat is the logging time format.
@@ -50,7 +50,7 @@ type Plugin struct {
 	clientProtocol plugin.ClientProtocol
 
 	// Interface to the connected plugin.
-	pluginConn PluginGRPC
+	pluginConn GaiaPlugin
 
 	// Log file where all output is stored.
 	logFile *os.File
@@ -160,7 +160,7 @@ func (p *Plugin) Validate() error {
 	}
 
 	// Convert plugin to interface
-	if pC, ok := raw.(PluginGRPC); ok {
+	if pC, ok := raw.(GaiaPlugin); ok {
 		p.pluginConn = pC
 		return nil
 	}

plugin/plugin_test.go

@@ -29,16 +29,16 @@ func (c *fakeCAAPI) GetCACertPath() (string, string)    { return "", "" }
 
 type fakeClientProtocol struct{}
 
-func (cp *fakeClientProtocol) Dispense(s string) (interface{}, error) { return &fakePluginGRPC{}, nil }
+func (cp *fakeClientProtocol) Dispense(s string) (interface{}, error) { return &fakeGaiaPlugin{}, nil }
 func (cp *fakeClientProtocol) Ping() error                            { return nil }
 func (cp *fakeClientProtocol) Close() error                           { return nil }
 
-type fakePluginGRPC struct{}
+type fakeGaiaPlugin struct{}
 
-func (p *fakePluginGRPC) GetJobs() (proto.Plugin_GetJobsClient, error) {
+func (p *fakeGaiaPlugin) GetJobs() (proto.Plugin_GetJobsClient, error) {
 	return &fakeJobsClient{}, nil
 }
-func (p *fakePluginGRPC) ExecuteJob(job *proto.Job) (*proto.JobResult, error) {
+func (p *fakeGaiaPlugin) ExecuteJob(job *proto.Job) (*proto.JobResult, error) {
 	return &proto.JobResult{}, nil
 }
 
@@ -106,7 +106,7 @@ func TestExecute(t *testing.T) {
 		Output: hclog.DefaultOutput,
 		Name:   "Gaia",
 	})
-	p := &Plugin{pluginConn: new(fakePluginGRPC)}
+	p := &Plugin{pluginConn: new(fakeGaiaPlugin)}
 	buf := new(bytes.Buffer)
 	p.writer = bufio.NewWriter(buf)
 	err := p.Execute(&gaia.Job{})
@@ -122,7 +122,7 @@ func TestGetJobs(t *testing.T) {
 		Output: hclog.DefaultOutput,
 		Name:   "Gaia",
 	})
-	p := &Plugin{pluginConn: new(fakePluginGRPC)}
+	p := &Plugin{pluginConn: new(fakeGaiaPlugin)}
 	buf := new(bytes.Buffer)
 	p.writer = bufio.NewWriter(buf)
 	_, err := p.GetJobs()