Add linter check support (#679)

* add linter supports

* add only minor version

* use latest version

* Fix println with format issue

* Fix test

* Fix tests

* For slice with unknown length, preallocating the array

* fix code-coverage

* Removed linter rules

* Reverting linter fixes, adding TODO for later

* Ignore linter error for import

* Remove another err var.

* Ignore shadow error

* Fixes

* Fix issue

* Add back goimports local-prefixes

* Update local prefixes

* Removed extra spaces and merge the imports

* more refactoring

* Update photon.go

Co-authored-by: Teppei Fukuda <knqyf263@gmail.com>

internal/app.go

@@ -20,6 +20,7 @@ import (
 	"github.com/aquasecurity/trivy/pkg/vulnerability"
 )
 
+// VersionInfo holds the trivy DB version Info
 type VersionInfo struct {
 	Version         string       `json:",omitempty"`
 	VulnerabilityDB *db.Metadata `json:",omitempty"`
@@ -250,6 +251,7 @@ var (
 	}
 )
 
+// NewApp is the factory method to return Trivy CLI
 func NewApp(version string) *cli.App {
 	cli.VersionPrinter = func(c *cli.Context) {
 		showVersion(c.String("cache-dir"), c.String("format"), c.App.Version, c.App.Writer)
@@ -307,7 +309,7 @@ func setHidden(flags []cli.Flag, hidden bool) []cli.Flag {
 func showVersion(cacheDir, outputFormat, version string, outputWriter io.Writer) {
 	var dbMeta *db.Metadata
 
-	metadata, _ := tdb.NewMetadata(afero.NewOsFs(), cacheDir).Get()
+	metadata, _ := tdb.NewMetadata(afero.NewOsFs(), cacheDir).Get() // nolint: errcheck
 	if !metadata.UpdatedAt.IsZero() && !metadata.NextUpdate.IsZero() && metadata.Version != 0 {
 		dbMeta = &db.Metadata{
 			Version:    metadata.Version,
@@ -319,7 +321,7 @@ func showVersion(cacheDir, outputFormat, version string, outputWriter io.Writer)
 
 	switch outputFormat {
 	case "json":
-		b, _ := json.Marshal(VersionInfo{
+		b, _ := json.Marshal(VersionInfo{ // nolint: errcheck
 			Version:         version,
 			VulnerabilityDB: dbMeta,
 		})
@@ -345,6 +347,7 @@ func showVersion(cacheDir, outputFormat, version string, outputWriter io.Writer)
 	}
 }
 
+// NewImageCommand is the factory method to add image command
 func NewImageCommand() *cli.Command {
 	return &cli.Command{
 		Name:      "image",
@@ -356,6 +359,7 @@ func NewImageCommand() *cli.Command {
 	}
 }
 
+// NewFilesystemCommand is the factory method to add filesystem command
 func NewFilesystemCommand() *cli.Command {
 	return &cli.Command{
 		Name:      "filesystem",
@@ -389,6 +393,7 @@ func NewFilesystemCommand() *cli.Command {
 	}
 }
 
+// NewRepositoryCommand is the factory method to add repository command
 func NewRepositoryCommand() *cli.Command {
 	return &cli.Command{
 		Name:      "repository",
@@ -422,6 +427,7 @@ func NewRepositoryCommand() *cli.Command {
 	}
 }
 
+// NewClientCommand is the factory method to add client command
 func NewClientCommand() *cli.Command {
 	return &cli.Command{
 		Name:      "client",
@@ -465,6 +471,7 @@ func NewClientCommand() *cli.Command {
 	}
 }
 
+// NewServerCommand is the factory method to add server command
 func NewServerCommand() *cli.Command {
 	return &cli.Command{
 		Name:    "server",

internal/app_test.go

@@ -109,3 +109,12 @@ Vulnerability DB:
 		})
 	}
 }
+
+func TestNewCommands(t *testing.T) {
+	NewApp("test")
+	NewClientCommand()
+	NewFilesystemCommand()
+	NewImageCommand()
+	NewRepositoryCommand()
+	NewServerCommand()
+}

internal/artifact/config/config.go

@@ -7,6 +7,7 @@ import (
 	"github.com/aquasecurity/trivy/internal/config"
 )
 
+// Config holds the artifact config
 type Config struct {
 	config.GlobalConfig
 	config.ArtifactConfig
@@ -22,6 +23,7 @@ type Config struct {
 	autoRefresh bool
 }
 
+// New is the factory method to return config
 func New(c *cli.Context) (Config, error) {
 	gc, err := config.NewGlobalConfig(c)
 	if err != nil {
@@ -41,6 +43,7 @@ func New(c *cli.Context) (Config, error) {
 	}, nil
 }
 
+// Init initializes the artifact config
 func (c *Config) Init(image bool) error {
 	if err := c.ReportConfig.Init(c.Logger); err != nil {
 		return err
@@ -53,7 +56,7 @@ func (c *Config) Init(image bool) error {
 	}
 
 	// --clear-cache, --download-db-only and --reset don't conduct the scan
-	if c.ClearCache || c.DownloadDBOnly || c.Reset {
+	if c.skipScan() {
 		return nil
 	}
 
@@ -69,3 +72,10 @@ func (c *Config) Init(image bool) error {
 
 	return nil
 }
+
+func (c *Config) skipScan() bool {
+	if c.ClearCache || c.DownloadDBOnly || c.Reset {
+		return true
+	}
+	return false
+}

internal/artifact/fs.go

@@ -21,6 +21,7 @@ func filesystemScanner(ctx context.Context, dir string, ac cache.ArtifactCache,
 	return s, cleanup, nil
 }
 
+// FilesystemRun runs scan on filesystem
 func FilesystemRun(cliCtx *cli.Context) error {
 	c, err := config.New(cliCtx)
 	if err != nil {

internal/artifact/image.go

@@ -30,6 +30,7 @@ func dockerScanner(ctx context.Context, imageName string, ac cache.ArtifactCache
 	return s, cleanup, nil
 }
 
+// ImageRun runs scan on docker image
 func ImageRun(cliCtx *cli.Context) error {
 	c, err := config.New(cliCtx)
 	if err != nil {

internal/artifact/repository.go

@@ -21,6 +21,7 @@ func repositoryScanner(ctx context.Context, dir string, ac cache.ArtifactCache,
 	return s, cleanup, nil
 }
 
+// RepositoryRun runs scan on repository
 func RepositoryRun(cliCtx *cli.Context) error {
 	c, err := config.New(cliCtx)
 	if err != nil {

internal/artifact/run.go

@@ -19,9 +19,12 @@ import (
 	"github.com/aquasecurity/trivy/pkg/utils"
 )
 
+// InitializeScanner type to define initialize function signature
 type InitializeScanner func(context.Context, string, cache.ArtifactCache, cache.LocalArtifactCache, time.Duration) (
 	scanner.Scanner, func(), error)
 
+// nolint: gocyclo
+// TODO: refactror and fix cyclometic complexity
 func run(c config.Config, initializeScanner InitializeScanner) error {
 	if err := log.InitLogger(c.Debug, c.Quiet); err != nil {
 		l.Fatal(err)

internal/client/config/config.go

@@ -10,6 +10,7 @@ import (
 	"github.com/aquasecurity/trivy/internal/config"
 )
 
+// Config holds the Trivy client config
 type Config struct {
 	config.GlobalConfig
 	config.ArtifactConfig
@@ -25,6 +26,7 @@ type Config struct {
 	CustomHeaders http.Header
 }
 
+// New is the factory method for Config
 func New(c *cli.Context) (Config, error) {
 	gc, err := config.NewGlobalConfig(c)
 	if err != nil {
@@ -43,6 +45,7 @@ func New(c *cli.Context) (Config, error) {
 	}, nil
 }
 
+// Init initializes the config
 func (c *Config) Init() (err error) {
 	// --clear-cache doesn't conduct the scan
 	if c.ClearCache {

internal/client/run.go

@@ -17,6 +17,7 @@ import (
 	"github.com/aquasecurity/trivy/pkg/utils"
 )
 
+// Run runs the scan
 func Run(cliCtx *cli.Context) error {
 	c, err := config.New(cliCtx)
 	if err != nil {
@@ -25,6 +26,8 @@ func Run(cliCtx *cli.Context) error {
 	return run(c)
 }
 
+// nolint: gocyclo
+// TODO: refactror and fix cyclometic complexity
 func run(c config.Config) (err error) {
 	if err = log.InitLogger(c.Debug, c.Quiet); err != nil {
 		return xerrors.Errorf("failed to initialize a logger: %w", err)

internal/config/artifact.go

@@ -10,6 +10,7 @@ import (
 	"golang.org/x/xerrors"
 )
 
+// ArtifactConfig holds the config for a artifact scanning
 type ArtifactConfig struct {
 	Input      string
 	Timeout    time.Duration
@@ -24,6 +25,7 @@ type ArtifactConfig struct {
 	Target string
 }
 
+// NewArtifactConfig is the factory method to return artifact config
 func NewArtifactConfig(c *cli.Context) ArtifactConfig {
 	return ArtifactConfig{
 		Input:           c.String("input"),
@@ -34,10 +36,11 @@ func NewArtifactConfig(c *cli.Context) ArtifactConfig {
 	}
 }
 
+// Init initialize the CLI context for artifact scanning
 func (c *ArtifactConfig) Init(ctx *cli.Context, logger *zap.SugaredLogger) (err error) {
 	if c.Input == "" && ctx.Args().Len() == 0 {
 		logger.Debug(`trivy requires at least 1 argument or --input option`)
-		_ = cli.ShowSubcommandHelp(ctx)
+		_ = cli.ShowSubcommandHelp(ctx) // nolint: errcheck
 		os.Exit(0)
 	} else if ctx.Args().Len() > 1 {
 		logger.Error(`multiple targets cannot be specified`)

internal/config/db.go

@@ -5,6 +5,7 @@ import (
 	"golang.org/x/xerrors"
 )
 
+// DBConfig holds the config for trivy DB
 type DBConfig struct {
 	Reset          bool
 	DownloadDBOnly bool
@@ -13,6 +14,7 @@ type DBConfig struct {
 	NoProgress     bool
 }
 
+// NewDBConfig is the factory method to return the DBConfig
 func NewDBConfig(c *cli.Context) DBConfig {
 	return DBConfig{
 		Reset:          c.Bool("reset"),
@@ -23,6 +25,7 @@ func NewDBConfig(c *cli.Context) DBConfig {
 	}
 }
 
+// Init initialize the DBConfig
 func (c *DBConfig) Init() (err error) {
 	if c.SkipUpdate && c.DownloadDBOnly {
 		return xerrors.New("--skip-update and --download-db-only options can not be specified both")

internal/config/global.go

@@ -8,6 +8,7 @@ import (
 	"github.com/aquasecurity/trivy/pkg/log"
 )
 
+// GlobalConfig holds the global config for trivy
 type GlobalConfig struct {
 	Context *cli.Context
 	Logger  *zap.SugaredLogger
@@ -18,6 +19,7 @@ type GlobalConfig struct {
 	CacheDir   string
 }
 
+// NewGlobalConfig is the factory method to return GlobalConfig
 func NewGlobalConfig(c *cli.Context) (GlobalConfig, error) {
 	quiet := c.Bool("quiet")
 	debug := c.Bool("debug")

internal/config/image.go

@@ -7,11 +7,13 @@ import (
 	"golang.org/x/xerrors"
 )
 
+// ImageConfig holds the config for scanning images
 type ImageConfig struct {
 	ScanRemovedPkgs bool
 	ListAllPkgs     bool
 }
 
+// NewImageConfig is the factory method to return imageConfig
 func NewImageConfig(c *cli.Context) ImageConfig {
 	return ImageConfig{
 		ScanRemovedPkgs: c.Bool("removed-pkgs"),
@@ -19,6 +21,7 @@ func NewImageConfig(c *cli.Context) ImageConfig {
 	}
 }
 
+// Init initializes the imageConfig
 func (c *ImageConfig) Init(args cli.Args, logger *zap.SugaredLogger) (err error) {
 	imageName := args.First()
 

internal/config/report.go

@@ -11,6 +11,7 @@ import (
 	dbTypes "github.com/aquasecurity/trivy-db/pkg/types"
 )
 
+// ReportConfig holds the config for reporting scan results
 type ReportConfig struct {
 	Format   string
 	Template string
@@ -31,6 +32,7 @@ type ReportConfig struct {
 	Severities []dbTypes.Severity
 }
 
+// NewReportConfig is the factory method to return ReportConfig
 func NewReportConfig(c *cli.Context) ReportConfig {
 	return ReportConfig{
 		output:       c.String("output"),
@@ -46,6 +48,7 @@ func NewReportConfig(c *cli.Context) ReportConfig {
 	}
 }
 
+// Init initializes the ReportConfig
 func (c *ReportConfig) Init(logger *zap.SugaredLogger) (err error) {
 	if c.Template != "" {
 		if c.Format == "" {

internal/operation/operation.go

@@ -15,20 +15,24 @@ import (
 	"github.com/aquasecurity/trivy/pkg/utils"
 )
 
+// SuperSet binds cache dependencies
 var SuperSet = wire.NewSet(
 	cache.NewFSCache,
 	wire.Bind(new(cache.LocalArtifactCache), new(cache.FSCache)),
 	NewCache,
 )
 
+// Cache implements the local cache
 type Cache struct {
 	client cache.LocalArtifactCache
 }
 
+// NewCache is the factory method for Cache
 func NewCache(client cache.LocalArtifactCache) Cache {
 	return Cache{client: client}
 }
 
+// Reset resets the cache
 func (c Cache) Reset() (err error) {
 	if err := c.ClearDB(); err != nil {
 		return xerrors.Errorf("failed to clear the database: %w", err)
@@ -39,6 +43,7 @@ func (c Cache) Reset() (err error) {
 	return nil
 }
 
+// ClearDB clears the DB cache
 func (c Cache) ClearDB() (err error) {
 	log.Logger.Info("Removing DB file...")
 	if err = os.RemoveAll(utils.CacheDir()); err != nil {
@@ -47,6 +52,7 @@ func (c Cache) ClearDB() (err error) {
 	return nil
 }
 
+// ClearImages clears the cache images
 func (c Cache) ClearImages() error {
 	log.Logger.Info("Removing image caches...")
 	if err := c.client.Clear(); err != nil {
@@ -55,6 +61,7 @@ func (c Cache) ClearImages() error {
 	return nil
 }
 
+// DownloadDB downloads the DB
 func DownloadDB(appVersion, cacheDir string, quiet, light, skipUpdate bool) error {
 	client := initializeDBClient(cacheDir, quiet)
 	ctx := context.Background()
@@ -66,7 +73,7 @@ func DownloadDB(appVersion, cacheDir string, quiet, light, skipUpdate bool) erro
 	if needsUpdate {
 		log.Logger.Info("Need to update DB")
 		log.Logger.Info("Downloading DB...")
-		if err := client.Download(ctx, cacheDir, light); err != nil {
+		if err = client.Download(ctx, cacheDir, light); err != nil {
 			return xerrors.Errorf("failed to download vulnerability DB: %w", err)
 		}
 		if err = client.UpdateMetadata(cacheDir); err != nil {

internal/server/config/config.go

@@ -1,10 +1,12 @@
 package config
 
 import (
-	"github.com/aquasecurity/trivy/internal/config"
 	"github.com/urfave/cli/v2"
+
+	"github.com/aquasecurity/trivy/internal/config"
 )
 
+// Config holds the  Trivy config
 type Config struct {
 	config.GlobalConfig
 	config.DBConfig
@@ -14,10 +16,10 @@ type Config struct {
 	TokenHeader string
 }
 
+// New is the factory method to return cofig
 func New(c *cli.Context) Config {
 	// the error is ignored because logger is unnecessary
-	gc, _ := config.NewGlobalConfig(c)
-
+	gc, _ := config.NewGlobalConfig(c) // nolint: errcheck
 	return Config{
 		GlobalConfig: gc,
 		DBConfig:     config.NewDBConfig(c),
@@ -28,6 +30,7 @@ func New(c *cli.Context) Config {
 	}
 }
 
+// Init initializes the DB config
 func (c *Config) Init() (err error) {
 	if err := c.DBConfig.Init(); err != nil {
 		return err

internal/server/run.go

@@ -13,6 +13,7 @@ import (
 	"github.com/aquasecurity/trivy/pkg/utils"
 )
 
+// Run runs the scan
 func Run(ctx *cli.Context) error {
 	return run(config.New(ctx))
 }