Preparing report...

Report for github.com/3scale/marin3r

A+    Excellent!    Found 50 issues across 183 files

Tweet

gofmt100%

Gofmt formats Go programs. We run gofmt -s on your code, where -s is for the "simplify" command

No problems detected. Good job!


go_vet100%

go vet examines Go source code and reports suspicious constructs, such as Printf calls whose arguments do not align with the format string.

No problems detected. Good job!


gocyclo97%

Gocyclo calculates cyclomatic complexities of functions in Go source code. The cyclomatic complexity of a function is calculated according to the following rules: 1 is the base complexity of a function +1 for each 'if', 'for', 'case', '&&' or '||' Go Report Card warns on functions with cyclomatic complexity > 15.


golint75%

Golint is a linter for Go source code.

    • marin3r/pkg/envoy/serializer/v3/serializer.go
    • Line 135: warning: exported type JSON should have comment or be unexported (golint)
    • Line 137: warning: exported method JSON.Marshal should have comment or be unexported (golint)
    • Line 148: warning: exported method JSON.Unmarshal should have comment or be unexported (golint)
    • Line 181: warning: exported type B64JSON should have comment or be unexported (golint)
    • Line 183: warning: exported method B64JSON.Unmarshal should have comment or be unexported (golint)
    • Line 198: warning: exported type YAML should have comment or be unexported (golint)
    • Line 200: warning: exported method YAML.Unmarshal should have comment or be unexported (golint)
    • marin3r/apis/operator.marin3r/v1alpha1/envoydeployment_types.go
    • Line 32: warning: comment on exported const EnvoyDeploymentBootstrapConfigHashLabelKey should be of the form "EnvoyDeploymentBootstrapConfigHashLabelKey ..." (golint)
    • Line 35: warning: comment on exported const ClientCertificateDefaultDuration should be of the form "ClientCertificateDefaultDuration ..." (golint)
    • Line 153: warning: comment on exported method EnvoyDeployment.ClientCertificateDuration should be of the form "ClientCertificateDuration ..." (golint)
    • Line 162: warning: exported method EnvoyDeployment.AdminPort should have comment or be unexported (golint)
    • Line 169: warning: exported method EnvoyDeployment.AdminAccessLogPath should have comment or be unexported (golint)
    • Line 176: warning: exported method EnvoyDeployment.Replicas should have comment or be unexported (golint)
    • Line 186: warning: exported method EnvoyDeployment.LivenessProbe should have comment or be unexported (golint)
    • Line 193: warning: exported method EnvoyDeployment.ReadinessProbe should have comment or be unexported (golint)
    • Line 200: warning: exported method EnvoyDeployment.PodAffinity should have comment or be unexported (golint)
    • Line 204: warning: exported method EnvoyDeployment.PodDisruptionBudget should have comment or be unexported (golint)
    • Line 231: warning: exported type DynamicReplicasSpec should have comment or be unexported (golint)
    • Line 334: warning: exported method ShutdownManager.GetImage should have comment or be unexported (golint)
    • Line 341: warning: exported method ShutdownManager.GetServer should have comment or be unexported (golint)
    • Line 357: warning: exported method InitManager.GetImage should have comment or be unexported (golint)
    • marin3r/controllers/marin3r/secrets_controller.go
    • Line 36: warning: exported type SecretReconciler should have comment or be unexported (golint)
    • Line 45: warning: exported method SecretReconciler.Reconcile should have comment or be unexported (golint)
    • Line 134: warning: exported method SecretReconciler.SetupWithManager should have comment or be unexported (golint)
    • marin3r/test/e2e/util/generators.go
    • Line 38: warning: exported const DeploymentLabelKey should have comment (or a comment on this block) or be unexported (golint)
    • Line 44: warning: exported function GeneratePod should have comment or be unexported (golint)
    • Line 112: warning: exported function GenerateDeployment should have comment or be unexported (golint)
    • Line 141: warning: exported function GenerateHeadlessService should have comment or be unexported (golint)
    • Line 158: warning: exported function GenerateDeploymentWithInjection should have comment or be unexported (golint)
    • Line 171: warning: exported function GenerateTLSSecret should have comment or be unexported (golint)
    • Line 190: warning: exported function GenerateEnvoyConfig should have comment or be unexported (golint)
    • Line 266: warning: exported function GetAddressV2 should have comment or be unexported (golint)
    • Line 276: warning: exported function GetAddressV3 should have comment or be unexported (golint)
    • Line 286: warning: exported function TransportSocketV2 should have comment or be unexported (golint)
    • Line 315: warning: exported function TransportSocketV3 should have comment or be unexported (golint)
    • Line 344: warning: exported function HTTPListenerWithRdsV2 should have comment or be unexported (golint)
    • Line 386: warning: exported function HTTPListenerWithRdsV3 should have comment or be unexported (golint)
    • Line 428: warning: exported function ProxyPassRouteV2 should have comment or be unexported (golint)
    • Line 447: warning: exported function ProxyPassRouteV3 should have comment or be unexported (golint)
    • Line 466: warning: exported function DirectResponseRouteV2 should have comment or be unexported (golint)
    • Line 487: warning: exported function DirectResponseRouteV3 should have comment or be unexported (golint)
    • Line 508: warning: exported function EndpointV2 should have comment or be unexported (golint)
    • Line 527: warning: exported function EndpointV3 should have comment or be unexported (golint)
    • Line 546: warning: exported function ClusterWithEdsV2 should have comment or be unexported (golint)
    • Line 564: warning: exported function ClusterWithEdsV3 should have comment or be unexported (golint)
    • Line 582: warning: exported function ClusterWithStrictDNSV2 should have comment or be unexported (golint)
    • Line 609: warning: exported function ClusterWithStrictDNSV3 should have comment or be unexported (golint)
    • marin3r/pkg/envoy/container/defaults/defaults.go
    • Line 11: warning: comment on exported const Image should be of the form "Image ..." (golint)
    • Line 13: warning: exported const EnvoyConfigBasePath should have comment (or a comment on this block) or be unexported (golint)
    • Line 36: warning: comment on exported const SidecarContainerName should be of the form "SidecarContainerName ..." (golint)
    • Line 42: warning: comment on exported const DeploymentContainerName should be of the form "DeploymentContainerName ..." (golint)
    • Line 48: warning: comment on exported const InitMgrDefaultImageRegistry should be of the form "InitMgrDefaultImageRegistry ..." (golint)
    • Line 52: warning: comment on exported const ShtdnMgrDefaultImageRegistry should be of the form "ShtdnMgrDefaultImageRegistry ..." (golint)
    • Line 67: warning: exported function ShtdnMgrImage should have comment or be unexported (golint)
    • Line 71: warning: exported function InitMgrImage should have comment or be unexported (golint)
    • marin3r/pkg/envoy/container/shutdownmanager/manager.go
    • Line 19: warning: exported const ShutdownEndpoint should have comment (or a comment on this block) or be unexported (golint)
    • Line 63: warning: comment on exported method Manager.Start should be of the form "Start ..." (golint)
    • Line 98: warning: receiver name s should be consistent with previous receiver name mgr for Manager (golint)
    • marin3r/pkg/reconcilers/marin3r/envoyconfigrevision/cache.go
    • Line 26: warning: exported type CacheReconciler should have comment or be unexported (golint)
    • Line 35: warning: exported function NewCacheReconciler should have comment or be unexported (golint)
    • Line 41: warning: exported method CacheReconciler.Reconcile should have comment or be unexported (golint)
    • Line 71: warning: exported method CacheReconciler.GenerateSnapshot should have comment or be unexported (golint)
    • marin3r/pkg/util/test/certificates.go
    • Line 3: warning: exported function TestIssuerCertificate should have comment or be unexported (golint)
    • Line 23: warning: exported function TestIssuerKey should have comment or be unexported (golint)
    • Line 36: warning: exported function TestValidCertificate should have comment or be unexported (golint)
    • Line 58: warning: exported function TestExpiredCertificate should have comment or be unexported (golint)
    • marin3r/pkg/envoy/container/generator.go
    • Line 14: warning: exported type ContainerConfig should have comment or be unexported (golint)
    • Line 47: warning: exported method ContainerConfig.Containers should have comment or be unexported (golint)
    • Line 172: warning: exported method ContainerConfig.InitContainers should have comment or be unexported (golint)
    • Line 227: warning: exported method ContainerConfig.Volumes should have comment or be unexported (golint)
    • marin3r/pkg/util/kubernetes.go
    • Line 11: warning: exported type KubernetesObject should have comment or be unexported (golint)
    • Line 16: warning: exported function ObjectInfo should have comment or be unexported (golint)
    • Line 20: warning: exported function ObjectKey should have comment or be unexported (golint)
    • marin3r/apis/marin3r/v1alpha1/error.go
    • Line 8: warning: comment on exported type ValidationError should be of the form "ValidationError ..." (with optional leading article) (golint)
    • Line 18: warning: comment on exported type ErrorList should be of the form "ErrorList ..." (with optional leading article) (golint)
    • Line 21: warning: exported method ErrorList.MarshalJSON should have comment or be unexported (golint)
    • Line 33: warning: exported function NewValidationError should have comment or be unexported (golint)
    • marin3r/pkg/envoy/serializer/v2/serializer.go
    • Line 90: warning: exported type JSON should have comment or be unexported (golint)
    • Line 92: warning: exported method JSON.Marshal should have comment or be unexported (golint)
    • Line 103: warning: exported method JSON.Unmarshal should have comment or be unexported (golint)
    • Line 136: warning: exported type B64JSON should have comment or be unexported (golint)
    • Line 138: warning: exported method B64JSON.Unmarshal should have comment or be unexported (golint)
    • Line 153: warning: exported type YAML should have comment or be unexported (golint)
    • Line 155: warning: exported method YAML.Unmarshal should have comment or be unexported (golint)

license100%

Checks whether your project has a LICENSE file.

No problems detected. Good job!


ineffassign100%

IneffAssign detects ineffectual assignments in Go code.

No problems detected. Good job!


misspell98%

Misspell Finds commonly misspelled English words