feat(zfspv) Add golint check to travis (#175)

Signed-off-by: vaniisgh <[email protected]>

.travis.yml

@@ -30,6 +30,7 @@ install:
     fi
   - make bootstrap
   - make format
+  - make golint
   - curl -Lo kubectl https://storage.googleapis.com/kubernetes-release/release/v1.16.0/bin/linux/amd64/kubectl
     && chmod +x kubectl && sudo mv kubectl /usr/local/bin/
   - curl -Lo minikube https://storage.googleapis.com/minikube/releases/v1.4.0/minikube-linux-amd64

Makefile

@@ -25,7 +25,7 @@ VETARGS?=-asmdecl -atomic -bool -buildtags -copylocks -methods \
 # targets or for development purposes
 EXTERNAL_TOOLS=\
 	golang.org/x/tools/cmd/cover \
-	github.com/golang/lint/golint \
+	golang.org/x/lint/golint \
 	github.com/axw/gocov/gocov \
 	gopkg.in/matm/v1/gocov-html \
 	github.com/onsi/ginkgo/ginkgo \
@@ -242,7 +242,7 @@ deploy-images:
 .PHONY: golint
 golint:
 	@echo "--> Running golint"
-	@echo "Consider these linter recommendations:"
-	@golint $(PACKAGES)
+	@golint -set_exit_status $(PACKAGES)
+	@echo "Completed golint no recommendations !!"
 	@echo "--------------------------------"
 	@echo ""

changelogs/unreleased/175-vaniisgh

@@ -0,0 +1 @@
+add golint to travis & fix linting

deploy/operators/centos7/zfs-operator.yaml

@@ -244,6 +244,8 @@ spec:
             - volumeType
             type: object
           status:
+            description: VolStatus string that specifies the current state of the
+              volume provisioning request.
             properties:
               state:
                 description: State specifies the current state of the volume provisioning
@@ -417,6 +419,8 @@ spec:
             - volumeType
             type: object
           status:
+            description: VolStatus string that specifies the current state of the
+              volume provisioning request.
             properties:
               state:
                 description: State specifies the current state of the volume provisioning
@@ -637,6 +641,8 @@ spec:
             - volumeType
             type: object
           status:
+            description: SnapStatus string that reflects if the snapshot was cretaed
+              successfully
             properties:
               state:
                 type: string
@@ -804,6 +810,8 @@ spec:
             - volumeType
             type: object
           status:
+            description: SnapStatus string that reflects if the snapshot was cretaed
+              successfully
             properties:
               state:
                 type: string

deploy/operators/centos8/zfs-operator.yaml

@@ -244,6 +244,8 @@ spec:
             - volumeType
             type: object
           status:
+            description: VolStatus string that specifies the current state of the
+              volume provisioning request.
             properties:
               state:
                 description: State specifies the current state of the volume provisioning
@@ -417,6 +419,8 @@ spec:
             - volumeType
             type: object
           status:
+            description: VolStatus string that specifies the current state of the
+              volume provisioning request.
             properties:
               state:
                 description: State specifies the current state of the volume provisioning
@@ -637,6 +641,8 @@ spec:
             - volumeType
             type: object
           status:
+            description: SnapStatus string that reflects if the snapshot was cretaed
+              successfully
             properties:
               state:
                 type: string
@@ -804,6 +810,8 @@ spec:
             - volumeType
             type: object
           status:
+            description: SnapStatus string that reflects if the snapshot was cretaed
+              successfully
             properties:
               state:
                 type: string

deploy/yamls/zfssnapshot-crd.yaml

@@ -196,6 +196,8 @@ spec:
             - volumeType
             type: object
           status:
+            description: SnapStatus string that reflects if the snapshot was cretaed
+              successfully
             properties:
               state:
                 type: string
@@ -363,6 +365,8 @@ spec:
             - volumeType
             type: object
           status:
+            description: SnapStatus string that reflects if the snapshot was cretaed
+              successfully
             properties:
               state:
                 type: string

deploy/yamls/zfsvolume-crd.yaml

@@ -223,6 +223,8 @@ spec:
             - volumeType
             type: object
           status:
+            description: VolStatus string that specifies the current state of the
+              volume provisioning request.
             properties:
               state:
                 description: State specifies the current state of the volume provisioning
@@ -396,6 +398,8 @@ spec:
             - volumeType
             type: object
           status:
+            description: VolStatus string that specifies the current state of the
+              volume provisioning request.
             properties:
               state:
                 description: State specifies the current state of the volume provisioning

deploy/zfs-operator.yaml

@@ -244,6 +244,8 @@ spec:
             - volumeType
             type: object
           status:
+            description: VolStatus string that specifies the current state of the
+              volume provisioning request.
             properties:
               state:
                 description: State specifies the current state of the volume provisioning
@@ -417,6 +419,8 @@ spec:
             - volumeType
             type: object
           status:
+            description: VolStatus string that specifies the current state of the
+              volume provisioning request.
             properties:
               state:
                 description: State specifies the current state of the volume provisioning
@@ -637,6 +641,8 @@ spec:
             - volumeType
             type: object
           status:
+            description: SnapStatus string that reflects if the snapshot was cretaed
+              successfully
             properties:
               state:
                 type: string
@@ -804,6 +810,8 @@ spec:
             - volumeType
             type: object
           status:
+            description: SnapStatus string that reflects if the snapshot was cretaed
+              successfully
             properties:
               state:
                 type: string

pkg/apis/openebs.io/zfs/v1/zfssnapshot.go

@@ -36,17 +36,17 @@ type ZFSSnapshot struct {
 	Status SnapStatus `json:"status"`
 }
 
+// ZFSSnapshotList is a list of ZFSSnapshot resources
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
 // +resource:path=zfssnapshots
-
-// ZFSSnapshotList is a list of ZFSSnapshot resources
 type ZFSSnapshotList struct {
 	metav1.TypeMeta `json:",inline"`
 	metav1.ListMeta `json:"metadata"`
 
 	Items []ZFSSnapshot `json:"items"`
 }
 
+// SnapStatus string that reflects if the snapshot was cretaed successfully
 type SnapStatus struct {
 	State string `json:"state,omitempty"`
 }

pkg/apis/openebs.io/zfs/v1/zfsvolume.go

@@ -63,10 +63,9 @@ type MountInfo struct {
 	MountOptions []string `json:"mountOptions"`
 }
 
+// ZFSVolumeList is a list of ZFSVolume resources
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
 // +resource:path=zfsvolumes
-
-// ZFSVolumeList is a list of ZFSVolume resources
 type ZFSVolumeList struct {
 	metav1.TypeMeta `json:",inline"`
 	metav1.ListMeta `json:"metadata"`
@@ -202,6 +201,7 @@ type VolumeInfo struct {
 	Shared string `json:"shared,omitempty"`
 }
 
+// VolStatus string that specifies the current state of the volume provisioning request.
 type VolStatus struct {
 	// State specifies the current state of the volume provisioning request.
 	// The state "Pending" means that the volume creation request has not

pkg/apis/openebs.io/zfs/v1alpha1/zfssnapshot.go

@@ -35,17 +35,17 @@ type ZFSSnapshot struct {
 	Status SnapStatus `json:"status"`
 }
 
+// ZFSSnapshotList is a list of ZFSSnapshot resources
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
 // +resource:path=zfssnapshots
-
-// ZFSSnapshotList is a list of ZFSSnapshot resources
 type ZFSSnapshotList struct {
 	metav1.TypeMeta `json:",inline"`
 	metav1.ListMeta `json:"metadata"`
 
 	Items []ZFSSnapshot `json:"items"`
 }
 
+// SnapStatus string that reflects if the snapshot was cretaed successfully
 type SnapStatus struct {
 	State string `json:"state,omitempty"`
 }

pkg/apis/openebs.io/zfs/v1alpha1/zfsvolume.go

@@ -62,10 +62,9 @@ type MountInfo struct {
 	MountOptions []string `json:"mountOptions"`
 }
 
+// ZFSVolumeList is a list of ZFSVolume resources
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
 // +resource:path=zfsvolumes
-
-// ZFSVolumeList is a list of ZFSVolume resources
 type ZFSVolumeList struct {
 	metav1.TypeMeta `json:",inline"`
 	metav1.ListMeta `json:"metadata"`
@@ -194,6 +193,7 @@ type VolumeInfo struct {
 	FsType string `json:"fsType,omitempty"`
 }
 
+// VolStatus string that specifies the current state of the volume provisioning request.
 type VolStatus struct {
 	// State specifies the current state of the volume provisioning request.
 	// The state "Pending" means that the volume creation request has not

pkg/client/k8s/v1alpha1/clientset.go

@@ -26,15 +26,16 @@ type ClientsetGetter interface {
 	Get() (*kubernetes.Clientset, error)
 }
 
-type clientset struct{}
+// ClientsetStruct is used to export a kuberneter Clientset
+type ClientsetStruct struct{}
 
 // Clientset returns a pointer to clientset struct
-func Clientset() *clientset {
-	return &clientset{}
+func Clientset() *ClientsetStruct {
+	return &ClientsetStruct{}
 }
 
 // Get returns a new instance of kubernetes clientset
-func (c *clientset) Get() (*kubernetes.Clientset, error) {
+func (c *ClientsetStruct) Get() (*kubernetes.Clientset, error) {
 	config, err := Config().Get()
 	if err != nil {
 		return nil, errors.Wrap(err, "failed to get kubernetes clientset")

pkg/client/k8s/v1alpha1/configmap.go

@@ -17,10 +17,11 @@ limitations under the License.
 package v1alpha1
 
 import (
+	"strings"
+
 	"github.com/pkg/errors"
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
-	"strings"
 )
 
 // ConfigMapGetter abstracts fetching of ConfigMap instance from kubernetes
@@ -29,18 +30,19 @@ type ConfigMapGetter interface {
 	Get(options metav1.GetOptions) (*corev1.ConfigMap, error)
 }
 
-type configmap struct {
+// Configmap is used to initialise a kubernetes Configmap struct
+type Configmap struct {
 	namespace string // namespace where this configmap exists
 	name      string // name of this configmap
 }
 
 // ConfigMap returns a new instance of configmap
-func ConfigMap(namespace, name string) *configmap {
-	return &configmap{namespace: namespace, name: name}
+func ConfigMap(namespace, name string) *Configmap {
+	return &Configmap{namespace: namespace, name: name}
 }
 
 // Get returns configmap instance from kubernetes cluster
-func (c *configmap) Get(options metav1.GetOptions) (cm *corev1.ConfigMap, err error) {
+func (c *Configmap) Get(options metav1.GetOptions) (cm *corev1.ConfigMap, err error) {
 	if len(strings.TrimSpace(c.name)) == 0 {
 		return nil, errors.Errorf("missing config map name: failed to get config map from namespace %s", c.namespace)
 	}

pkg/client/k8s/v1alpha1/configmap_test.go

@@ -17,12 +17,13 @@ limitations under the License.
 package v1alpha1
 
 import (
-	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"testing"
+
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
 // test if configmap implements ConfigMapGetter interface
-var _ ConfigMapGetter = &configmap{}
+var _ ConfigMapGetter = &Configmap{}
 
 func TestConfigMapGet(t *testing.T) {
 	tests := map[string]struct {

pkg/client/k8s/v1alpha1/dynamic.go

@@ -26,16 +26,17 @@ type DynamicProvider interface {
 	Provide() (k8sdynamic.Interface, error)
 }
 
-type dynamic struct{}
+//DynamicStruct is used to initialise a kuberenets dynamic interface
+type DynamicStruct struct{}
 
 // Dynamic returns a new instance of dynamic
-func Dynamic() *dynamic {
-	return &dynamic{}
+func Dynamic() *DynamicStruct {
+	return &DynamicStruct{}
 }
 
 // Provide provides a kubernetes dynamic client capable of invoking operations
 // against kubernetes resources
-func (d *dynamic) Provide() (k8sdynamic.Interface, error) {
+func (d *DynamicStruct) Provide() (k8sdynamic.Interface, error) {
 	config, err := Config().Get()
 	if err != nil {
 		return nil, errors.Wrap(err, "failed to provide dynamic client")

pkg/client/k8s/v1alpha1/dynamic_test.go

@@ -21,7 +21,7 @@ import (
 )
 
 // test if dynamic implements DynamicProvider interface
-var _ DynamicProvider = &dynamic{}
+var _ DynamicProvider = &DynamicStruct{}
 
 func TestDynamicProvider(t *testing.T) {
 	tests := map[string]struct {

pkg/client/k8s/v1alpha1/namespace.go

@@ -31,15 +31,17 @@ type NamespaceGetter interface {
 type NamespaceLister interface {
 	List(options metav1.ListOptions) (*corev1.NamespaceList, error)
 }
-type namespace struct{}
+
+// NamespaceStruct is used to initialise kubernetes namespace instnaces
+type NamespaceStruct struct{}
 
 // Namespace returns a pointer to the namespace struct
-func Namespace() *namespace {
-	return &namespace{}
+func Namespace() *NamespaceStruct {
+	return &NamespaceStruct{}
 }
 
 // Get returns a namespace instance from kubernetes cluster
-func (ns *namespace) Get(name string, options metav1.GetOptions) (*corev1.Namespace, error) {
+func (ns *NamespaceStruct) Get(name string, options metav1.GetOptions) (*corev1.Namespace, error) {
 	cs, err := Clientset().Get()
 	if err != nil {
 		return nil, errors.Wrapf(err, "failed to get namespace: %s", name)
@@ -48,7 +50,7 @@ func (ns *namespace) Get(name string, options metav1.GetOptions) (*corev1.Namesp
 }
 
 // List returns a slice of namespaces defined in a Kubernetes cluster
-func (ns *namespace) List(options metav1.ListOptions) (*corev1.NamespaceList, error) {
+func (ns *NamespaceStruct) List(options metav1.ListOptions) (*corev1.NamespaceList, error) {
 	cs, err := Clientset().Get()
 	if err != nil {
 		return nil, errors.Wrapf(err, "failed to get namespaces")