Preparing report...

Report for github.com/goodwithtech/dockle

A    Great!    Found 22 issues across 27 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!


gocyclo96%

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.


golint18%

Golint is a linter for Go source code.

    • dockle/pkg/assessor/credential/credential.go
    • Line 15: warning: exported type CredentialAssessor should have comment or be unexported (golint)
    • Line 17: warning: exported method CredentialAssessor.Assess should have comment or be unexported (golint)
    • Line 40: warning: exported method CredentialAssessor.RequiredFiles should have comment or be unexported (golint)
    • Line 44: warning: exported method CredentialAssessor.RequiredPermissions should have comment or be unexported (golint)
    • dockle/pkg/assessor/assessor.go
    • Line 26: warning: exported type Assessor should have comment or be unexported (golint)
    • Line 44: warning: exported function GetAssessments should have comment or be unexported (golint)
    • Line 55: warning: exported function RegisterAssessor should have comment or be unexported (golint)
    • Line 59: warning: exported function LoadRequiredFiles should have comment or be unexported (golint)
    • Line 66: warning: exported function LoadRequiredPermissions should have comment or be unexported (golint)
    • dockle/pkg/types/assessment.go
    • Line 3: warning: exported type Assessment should have comment or be unexported (golint)
    • Line 9: warning: exported type AssessmentSlice should have comment or be unexported (golint)
    • Line 10: warning: exported type CodeInfo should have comment or be unexported (golint)
    • Line 15: warning: exported type AssessmentMap should have comment or be unexported (golint)
    • Line 17: warning: exported function CreateAssessmentMap should have comment or be unexported (golint)
    • Line 44: warning: exported type ByLevel should have comment or be unexported (golint)
    • dockle/pkg/assessor/manifest/manifest.go
    • Line 18: warning: exported type ManifestAssessor should have comment or be unexported (golint)
    • Line 20: warning: exported var ConfigFileName should have comment or be unexported (golint)
    • Line 27: warning: exported method ManifestAssessor.Assess should have comment or be unexported (golint)
    • Line 262: warning: comment on exported method ManifestAssessor.RequiredFiles should be of the form "RequiredFiles ..." (golint)
    • Line 267: warning: exported method ManifestAssessor.RequiredPermissions should have comment or be unexported (golint)
    • dockle/pkg/types/checkpoint.go
    • Line 4: warning: comment on exported const AvoidRootDefault should be of the form "AvoidRootDefault ..." (golint)
    • Line 6: warning: exported const UseContentTrust should have comment (or a comment on this block) or be unexported (golint)
    • Line 13: warning: comment on exported const AvoidSudo should be of the form "AvoidSudo ..." (golint)
    • Line 21: warning: comment on exported const AvoidEmptyPassword should be of the form "AvoidEmptyPassword ..." (golint)
    • Line 28: warning: exported const PassLevel should have comment (or a comment on this block) or be unexported (golint)
    • dockle/config/config.go
    • Line 27: warning: exported type Config should have comment or be unexported (golint)
    • Line 33: warning: exported var Conf should have comment or be unexported (golint)
    • Line 35: warning: exported function CreateFromCli should have comment or be unexported (golint)
    • dockle/pkg/assessor/contentTrust/contentTrust.go
    • Line 1: warning: don't use MixedCaps in package name; contentTrust should be contenttrust (golint)
    • Line 12: warning: exported var HostEnvironmentFileName should have comment or be unexported (golint)
    • Line 14: warning: exported type ContentTrustAssessor should have comment or be unexported (golint)
    • Line 16: warning: exported method ContentTrustAssessor.Assess should have comment or be unexported (golint)
    • Line 31: warning: exported method ContentTrustAssessor.RequiredFiles should have comment or be unexported (golint)
    • Line 35: warning: exported method ContentTrustAssessor.RequiredPermissions should have comment or be unexported (golint)
    • dockle/pkg/assessor/passwd/passwd.go
    • Line 17: warning: exported type PasswdAssessor should have comment or be unexported (golint)
    • Line 19: warning: exported method PasswdAssessor.Assess should have comment or be unexported (golint)
    • Line 58: warning: exported method PasswdAssessor.RequiredFiles should have comment or be unexported (golint)
    • Line 62: warning: exported method PasswdAssessor.RequiredPermissions should have comment or be unexported (golint)
    • dockle/pkg/assessor/cache/cache.go
    • Line 24: warning: exported type CacheAssessor should have comment or be unexported (golint)
    • Line 26: warning: exported method CacheAssessor.Assess should have comment or be unexported (golint)
    • Line 80: warning: exported method CacheAssessor.RequiredFiles should have comment or be unexported (golint)
    • Line 84: warning: exported method CacheAssessor.RequiredPermissions should have comment or be unexported (golint)
    • dockle/pkg/assessor/hosts/hosts.go
    • Line 12: warning: exported type HostsAssessor should have comment or be unexported (golint)
    • Line 14: warning: exported method HostsAssessor.Assess should have comment or be unexported (golint)
    • Line 22: warning: exported method HostsAssessor.RequiredFiles should have comment or be unexported (golint)
    • Line 26: warning: exported method HostsAssessor.RequiredPermissions should have comment or be unexported (golint)
    • dockle/pkg/assessor/group/group.go
    • Line 17: warning: exported type GroupAssessor should have comment or be unexported (golint)
    • Line 19: warning: exported method GroupAssessor.Assess should have comment or be unexported (golint)
    • Line 64: warning: exported method GroupAssessor.RequiredFiles should have comment or be unexported (golint)
    • Line 68: warning: exported method GroupAssessor.RequiredPermissions should have comment or be unexported (golint)
    • dockle/pkg/assessor/user/user.go
    • Line 16: warning: exported type UserAssessor should have comment or be unexported (golint)
    • Line 18: warning: exported method UserAssessor.Assess should have comment or be unexported (golint)
    • Line 61: warning: exported method UserAssessor.RequiredFiles should have comment or be unexported (golint)
    • Line 65: warning: exported method UserAssessor.RequiredPermissions should have comment or be unexported (golint)
    • dockle/pkg/log/logger.go
    • Line 11: warning: exported var Logger should have comment or be unexported (golint)
    • Line 15: warning: exported function InitLogger should have comment or be unexported (golint)
    • Line 62: warning: exported function Fatal should have comment or be unexported (golint)
    • dockle/pkg/report/json.go
    • Line 13: warning: exported type JsonWriter should have comment or be unexported (golint)
    • Line 17: warning: exported type JsonOutputFormat should have comment or be unexported (golint)
    • Line 21: warning: exported type JsonSummary should have comment or be unexported (golint)
    • Line 28: warning: exported type JsonDetail should have comment or be unexported (golint)
    • dockle/pkg/report/list.go
    • Line 14: warning: exported const LISTMARK should have comment (or a comment on this block) or be unexported (golint)
    • Line 21: warning: exported var AlertLevelColors should have comment or be unexported (golint)
    • Line 30: warning: exported type ListWriter should have comment or be unexported (golint)
    • dockle/pkg/assessor/privilege/suid.go
    • Line 12: warning: exported type PrivilegeAssessor should have comment or be unexported (golint)
    • Line 14: warning: exported method PrivilegeAssessor.Assess should have comment or be unexported (golint)
    • Line 41: warning: exported method PrivilegeAssessor.RequiredFiles should have comment or be unexported (golint)
    • Line 45: warning: comment on exported method PrivilegeAssessor.RequiredPermissions should be of the form "RequiredPermissions ..." (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!


misspell100%

Misspell Finds commonly misspelled English words

No problems detected. Good job!