Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add go vet #215

Closed
kadel opened this issue Oct 18, 2016 · 2 comments · Fixed by #259
Closed

Add go vet #215

kadel opened this issue Oct 18, 2016 · 2 comments · Fixed by #259

Comments

@kadel
Copy link
Member

kadel commented Oct 18, 2016

Tests that are run in travis-ci for every PR should include go vet to check for suspicious constructs and formatting errors.

we can create make test target that will run all tests (vet,unit,cmd)

current state:

$ for f in `find . -path ./vendor -prune -o -name '*.go' -print `; do go vet $f; done
cli/app/app_test.go:109: missing argument for Errorf("%s"): format reads arg 3, have only 2 args
cli/app/app_test.go:112: missing argument for Errorf("%s"): format reads arg 3, have only 2 args
cli/app/app_test.go:115: missing argument for Errorf("%s"): format reads arg 3, have only 2 args
cli/app/app_test.go:118: missing argument for Errorf("%s"): format reads arg 3, have only 2 args
pkg/loader/bundle/bundle.go:109: no formatting directive in Fatalf call
pkg/loader/bundle/bundle.go:114: no formatting directive in Fatalf call
@surajssd
Copy link
Member

We can also use tools like Go Meta Linter

@ericchiang
Copy link

We can also use tools like Go Meta Linter

The regular golint tool already finds a lot of issues. Might want to tackle that first.

$ for pkg in $( go list github.com/kubernetes-incubator/kompose/... | grep -v '/vendor/' ); do golint $pkg; done
/home/eric/src/github.com/kubernetes-incubator/kompose/cli/app/app.go:42:2: exported const DefaultComposeFile should have comment (or a comment on this block) or be unexported
/home/eric/src/github.com/kubernetes-incubator/kompose/cli/command/command.go:67:1: comment on exported function ConvertCommandDummy should be of the form "ConvertCommandDummy ..."
/home/eric/src/github.com/kubernetes-incubator/kompose/pkg/kobject/kobject.go:108:6: exported type ConvertOptions should have comment or be unexported
/home/eric/src/github.com/kubernetes-incubator/kompose/pkg/kobject/kobject.go:161:1: exported function CheckUnsupportedKey should have comment or be unexported
/home/eric/src/github.com/kubernetes-incubator/kompose/pkg/loader/loader.go:28:6: exported type Loader should have comment or be unexported
/home/eric/src/github.com/kubernetes-incubator/kompose/pkg/loader/loader.go:42:15: should replace errors.New(fmt.Sprintf(...)) with fmt.Errorf(...)
/home/eric/src/github.com/kubernetes-incubator/kompose/pkg/loader/bundle/bundle.go:32:6: exported type Bundle should have comment or be unexported
/home/eric/src/github.com/kubernetes-incubator/kompose/pkg/loader/bundle/bundle.go:128:1: comment on exported method Bundle.LoadFile should be of the form "LoadFile ..."
/home/eric/src/github.com/kubernetes-incubator/kompose/pkg/loader/compose/compose.go:35:6: exported type Compose should have comment or be unexported
/home/eric/src/github.com/kubernetes-incubator/kompose/pkg/loader/compose/compose.go:126:1: comment on exported method Compose.LoadFile should be of the form "LoadFile ..."
/home/eric/src/github.com/kubernetes-incubator/kompose/pkg/transformer/transformer.go:24:6: exported type Transformer should have comment or be unexported
/home/eric/src/github.com/kubernetes-incubator/kompose/pkg/transformer/utils.go:31:1: comment on exported function CreateOutFile should be of the form "CreateOutFile ..."
/home/eric/src/github.com/kubernetes-incubator/kompose/pkg/transformer/utils.go:44:1: comment on exported function ParseVolume should be of the form "ParseVolume ..."
/home/eric/src/github.com/kubernetes-incubator/kompose/pkg/transformer/utils.go:80:1: comment on exported function ConfigLabels should be of the form "ConfigLabels ..."
/home/eric/src/github.com/kubernetes-incubator/kompose/pkg/transformer/utils.go:85:1: comment on exported function ConfigAnnotations should be of the form "ConfigAnnotations ..."
/home/eric/src/github.com/kubernetes-incubator/kompose/pkg/transformer/utils.go:95:1: comment on exported function TransformData should be of the form "TransformData ..."
/home/eric/src/github.com/kubernetes-incubator/kompose/pkg/transformer/utils.go:117:1: comment on exported function Print should be of the form "Print ..."
/home/eric/src/github.com/kubernetes-incubator/kompose/pkg/transformer/kubernetes/k8sutils.go:230:1: exported method Kubernetes.PortsExist should have comment or be unexported
/home/eric/src/github.com/kubernetes-incubator/kompose/pkg/transformer/kubernetes/k8sutils.go:234:9: if block ends with a return statement, so drop this else and outdent its block
/home/eric/src/github.com/kubernetes-incubator/kompose/pkg/transformer/kubernetes/k8sutils.go:239:1: comment on exported method Kubernetes.CreateService should be of the form "CreateService ..."
/home/eric/src/github.com/kubernetes-incubator/kompose/pkg/transformer/kubernetes/k8sutils.go:269:1: comment on exported method Kubernetes.UpdateKubernetesObjects should be of the form "UpdateKubernetesObjects ..."
/home/eric/src/github.com/kubernetes-incubator/kompose/pkg/transformer/kubernetes/k8sutils.go:334:1: comment on exported method Kubernetes.SortServicesFirst should be of the form "SortServicesFirst ..."
/home/eric/src/github.com/kubernetes-incubator/kompose/pkg/transformer/kubernetes/k8sutils.go:366:1: exported method Kubernetes.VolumesFrom should have comment or be unexported
/home/eric/src/github.com/kubernetes-incubator/kompose/pkg/transformer/kubernetes/kubernetes.go:31:2: a blank import should be only in a main or test package, or have a comment justifying it
/home/eric/src/github.com/kubernetes-incubator/kompose/pkg/transformer/kubernetes/kubernetes.go:35:2: a blank import should be only in a main or test package, or have a comment justifying it
/home/eric/src/github.com/kubernetes-incubator/kompose/pkg/transformer/kubernetes/kubernetes.go:45:6: exported type Kubernetes should have comment or be unexported
/home/eric/src/github.com/kubernetes-incubator/kompose/pkg/transformer/kubernetes/kubernetes.go:50:1: comment on exported const TIMEOUT should be of the form "TIMEOUT ..."
/home/eric/src/github.com/kubernetes-incubator/kompose/pkg/transformer/kubernetes/kubernetes.go:54:1: comment on exported method Kubernetes.InitRC should be of the form "InitRC ..."
/home/eric/src/github.com/kubernetes-incubator/kompose/pkg/transformer/kubernetes/kubernetes.go:84:1: comment on exported method Kubernetes.InitSvc should be of the form "InitSvc ..."
/home/eric/src/github.com/kubernetes-incubator/kompose/pkg/transformer/kubernetes/kubernetes.go:102:1: comment on exported method Kubernetes.InitD should be of the form "InitD ..."
/home/eric/src/github.com/kubernetes-incubator/kompose/pkg/transformer/kubernetes/kubernetes.go:129:1: comment on exported method Kubernetes.InitDS should be of the form "InitDS ..."
/home/eric/src/github.com/kubernetes-incubator/kompose/pkg/transformer/kubernetes/kubernetes.go:155:1: comment on exported method Kubernetes.CreatePVC should be of the form "CreatePVC ..."
/home/eric/src/github.com/kubernetes-incubator/kompose/pkg/transformer/kubernetes/kubernetes.go:187:1: comment on exported method Kubernetes.ConfigPorts should be of the form "ConfigPorts ..."
/home/eric/src/github.com/kubernetes-incubator/kompose/pkg/transformer/kubernetes/kubernetes.go:200:1: comment on exported method Kubernetes.ConfigServicePorts should be of the form "ConfigServicePorts ..."
/home/eric/src/github.com/kubernetes-incubator/kompose/pkg/transformer/kubernetes/kubernetes.go:220:1: comment on exported method Kubernetes.ConfigVolumes should be of the form "ConfigVolumes ..."
/home/eric/src/github.com/kubernetes-incubator/kompose/pkg/transformer/kubernetes/kubernetes.go:282:1: comment on exported method Kubernetes.ConfigEmptyVolumeSource should be of the form "ConfigEmptyVolumeSource ..."
/home/eric/src/github.com/kubernetes-incubator/kompose/pkg/transformer/kubernetes/kubernetes.go:289:1: comment on exported method Kubernetes.ConfigPVCVolumeSource should be of the form "ConfigPVCVolumeSource ..."
/home/eric/src/github.com/kubernetes-incubator/kompose/pkg/transformer/kubernetes/kubernetes.go:299:1: comment on exported method Kubernetes.ConfigEnvs should be of the form "ConfigEnvs ..."
/home/eric/src/github.com/kubernetes-incubator/kompose/pkg/transformer/kubernetes/kubernetes.go:312:1: comment on exported method Kubernetes.CreateKubernetesObjects should be of the form "CreateKubernetesObjects ..."
/home/eric/src/github.com/kubernetes-incubator/kompose/pkg/transformer/kubernetes/kubernetes.go:355:1: comment on exported method Kubernetes.UpdateController should be of the form "UpdateController ..."
/home/eric/src/github.com/kubernetes-incubator/kompose/pkg/transformer/kubernetes/kubernetes.go:376:1: comment on exported method Kubernetes.Deploy should be of the form "Deploy ..."
/home/eric/src/github.com/kubernetes-incubator/kompose/pkg/transformer/kubernetes/kubernetes.go:422:1: exported method Kubernetes.Undeploy should have comment or be unexported
/home/eric/src/github.com/kubernetes-incubator/kompose/pkg/transformer/kubernetes/kubernetes.go:449:11: if block ends with a return statement, so drop this else and outdent its block
/home/eric/src/github.com/kubernetes-incubator/kompose/pkg/transformer/kubernetes/kubernetes.go:462:11: if block ends with a return statement, so drop this else and outdent its block
/home/eric/src/github.com/kubernetes-incubator/kompose/pkg/transformer/kubernetes/kubernetes.go:470:11: if block ends with a return statement, so drop this else and outdent its block
/home/eric/src/github.com/kubernetes-incubator/kompose/pkg/transformer/kubernetes/kubernetes_test.go:75:15: don't use leading k in Go names; func parameter kEnvs should be envs
/home/eric/src/github.com/kubernetes-incubator/kompose/pkg/transformer/kubernetes/kubernetes_test.go:79:9: don't use leading k in Go names; range var kEnv should be env
/home/eric/src/github.com/kubernetes-incubator/kompose/pkg/transformer/kubernetes/kubernetes_test.go:93:17: don't use leading k in Go names; func parameter kPorts should be ports
/home/eric/src/github.com/kubernetes-incubator/kompose/pkg/transformer/kubernetes/kubernetes_test.go:97:9: don't use leading k in Go names; range var kPort should be port
/home/eric/src/github.com/kubernetes-incubator/kompose/pkg/transformer/openshift/openshift.go:44:6: exported type OpenShift should have comment or be unexported
/home/eric/src/github.com/kubernetes-incubator/kompose/pkg/transformer/openshift/openshift.go:57:9: if block ends with a return statement, so drop this else and outdent its block
/home/eric/src/github.com/kubernetes-incubator/kompose/pkg/transformer/openshift/openshift.go:174:1: exported method OpenShift.Deploy should have comment or be unexported

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants