enhancement: add Revive Linter, Resolve Linting Concerns, and Add Com…

…ments to Exported Methods, Types, and Constants

.golangci.yml

@@ -4,8 +4,6 @@ run:
   skip-files:
   - pkg/nodeagent/ebpf/exec.go
 
-concurrency: 4
-
 linters:
   disable-all: true
   enable:
@@ -18,15 +16,45 @@ linters:
     - misspell
     - dupl
     - stylecheck
+    - revive
 
 linters-settings:
   gofmt:
     simplify: true
   dupl:
     threshold: 400
+  revive:
+    ignoreGeneratedHeader: false
+    severity: "warning"
+    confidence: 0.8
+    errorCode: 1
+    warningCode: 1
+    rules:
+      - name: blank-imports
+      - name: context-as-argument
+      - name: context-keys-type
+      - name: dot-imports
+      - name: error-return
+      - name: error-strings
+      - name: error-naming
+      - name: if-return
+      - name: increment-decrement
+      - name: var-naming
+      - name: var-declaration
+      - name: package-comments
+      - name: range
+      - name: receiver-naming
+      - name: time-naming
+      - name: unexported-return
+      - name: indent-error-flow
+      - name: errorf
+      - name: exported
 
 issues:
   # Maximum issues count per one linter. Set to 0 to disable. Default is 50.
   max-issues-per-linter: 0
   # Maximum count of issues with the same text. Set to 0 to disable. Default is 3.
-  max-same-issues: 0
+  max-same-issues: 0
+  include:
+    - EXC0012  # EXC0012 revive: issue about not having a comment.
+    - EXC0014  # EXC0014 revive: issue about not having a comment.

cmd/tarian-cluster-agent/cmd/root.go

@@ -56,6 +56,7 @@ func buildRootCommand(logger *logrus.Logger) *cobra.Command {
 	return rootCmd
 }
 
+// Execute executes the root command.
 func Execute() {
 	logger := log.GetLogger()
 	rootCmd := buildRootCommand(logger)

cmd/tarian-cluster-agent/cmd/run.go

@@ -70,7 +70,7 @@ func newRunCommand(globalFlags *flags.GlobalFlags) *cobra.Command {
 	return runCmd
 }
 
-func (c *runCommand) run(cmd *cobra.Command, args []string) error {
+func (c *runCommand) run(_ *cobra.Command, args []string) error {
 	addr := c.host + ":" + c.port
 	listener, err := net.Listen("tcp", addr)
 	if err != nil {
@@ -112,7 +112,7 @@ func (c *runCommand) run(cmd *cobra.Command, args []string) error {
 	return nil
 }
 
-func (c *runCommand) newClusterAgentConfigFromCliContext() (*clusteragent.ClusterAgentConfig, error) {
+func (c *runCommand) newClusterAgentConfigFromCliContext() (*clusteragent.Config, error) {
 	dialOpts := []grpc.DialOption{}
 
 	if c.serverTLSEnabled {
@@ -143,7 +143,7 @@ func (c *runCommand) newClusterAgentConfigFromCliContext() (*clusteragent.Cluste
 		dialOpts = append(dialOpts, grpc.WithTransportCredentials(insecure.NewCredentials()))
 	}
 
-	config := &clusteragent.ClusterAgentConfig{
+	config := &clusteragent.Config{
 		ServerAddress:         c.serverAddress,
 		ServerGrpcDialOptions: dialOpts,
 		EnableAddConstraint:   c.enableAddConstraint,

cmd/tarian-cluster-agent/cmd/runWebhookServer.go

@@ -61,7 +61,7 @@ func newWebhookServerCommand(globalFlags *flags.GlobalFlags) *cobra.Command {
 	return runWebhookServerCmd
 }
 
-func (c *runWebhookServerCommand) run(cmd *cobra.Command, args []string) error {
+func (c *runWebhookServerCommand) run(_ *cobra.Command, args []string) error {
 	podAgentContainerConfig := webhookserver.PodAgentContainerConfig{
 		Name:        c.podAgentContainerName,
 		Image:       c.podAgentContainerImage,

cmd/tarian-node-agent/cmd/root.go

@@ -53,6 +53,7 @@ func buildRootCommand(logger *logrus.Logger) *cobra.Command {
 	return rootCmd
 }
 
+// Execute executes the root command.
 func Execute() {
 	logger := log.GetLogger()
 	rootCmd := buildRootCommand(logger)

cmd/tarian-node-agent/cmd/run.go

@@ -43,7 +43,7 @@ func newRunCommand(globalFlags *flags.GlobalFlags) *cobra.Command {
 	return runCmd
 }
 
-func (c *runCommand) run(cmd *cobra.Command, args []string) error {
+func (c *runCommand) run(_ *cobra.Command, args []string) error {
 	if !isDebugFsMounted() {
 		c.logger.Info("debugfs is not mounted, will try to mount")
 

cmd/tarian-pod-agent/cmd/root.go

@@ -54,6 +54,7 @@ func buildRootCommand(logger *logrus.Logger) *cobra.Command {
 	return rootCmd
 }
 
+// Execute executes the root command.
 func Execute() {
 	logger := log.GetLogger()
 	rootCmd := buildRootCommand(logger)

cmd/tarian-pod-agent/cmd/threat_scan.go

@@ -57,7 +57,7 @@ func newThreatScanCommand(globalFlag *flags.GlobalFlags) *cobra.Command {
 	return threatScanCmd
 }
 
-func (c *threatScanCommand) run(cmd *cobra.Command, args []string) error {
+func (c *threatScanCommand) run(_ *cobra.Command, args []string) error {
 	c.logger.Info("tarian-pod-agent is running in threat-scan mode")
 	addr := c.host + ":" + c.port
 	agent := podagent.NewPodAgent(c.logger, addr)

cmd/tarian-server/cmd/dgraph/applySchema.go

@@ -44,7 +44,7 @@ func newApplySchemaCommand(globalFlags *flags.GlobalFlags) *cobra.Command {
 	return applySchemaCmd
 }
 
-func (o *applySchemaCommand) run(cmd *cobra.Command, args []string) error {
+func (o *applySchemaCommand) run(_ *cobra.Command, args []string) error {
 	var cfg dgraphstore.DgraphConfig
 	err := envconfig.Process("Dgraph", &cfg)
 	if err != nil {
@@ -69,13 +69,13 @@ func (o *applySchemaCommand) run(cmd *cobra.Command, args []string) error {
 
 	if err != nil {
 		return fmt.Errorf("apply-schema: failed to apply schema: %w", err)
-	} else {
-		o.logger.Info("successfully applied schema")
 	}
 
+	o.logger.Info("successfully applied schema")
 	return nil
 }
 
+// BuildDgraphDialOpts builds the dial options for Dgraph client
 func BuildDgraphDialOpts(dgraphCfg dgraphstore.DgraphConfig, logger *logrus.Logger) ([]grpc.DialOption, error) {
 	dialOpts := []grpc.DialOption{}
 	if dgraphCfg.TLSCertFile == "" {

cmd/tarian-server/cmd/dgraph/dgraph.go

@@ -5,6 +5,7 @@ import (
 	"github.com/spf13/cobra"
 )
 
+// NewDgraphCommand creates a new `dgraph` command
 func NewDgraphCommand(globalFlags *flags.GlobalFlags) *cobra.Command {
 	dgraphCmd := &cobra.Command{
 		Use:   "dgraph",

cmd/tarian-server/cmd/root.go

@@ -55,6 +55,7 @@ func buildRootCommand(logger *logrus.Logger) *cobra.Command {
 	return rootCmd
 }
 
+// Execute executes the root command.
 func Execute() {
 	logger := log.GetLogger()
 	rootCmd := buildRootCommand(logger)

cmd/tarian-server/cmd/run.go

@@ -88,13 +88,13 @@ func (o *runCommand) addFlags(cmd *cobra.Command) {
 	cmd.Flags().DurationVar(&o.natsStreamConfigDuplicates, "nats-stream-config-duplicates", 1*time.Minute, "")
 }
 
-func (o *runCommand) run(cmd *cobra.Command, args []string) error {
+func (o *runCommand) run(_ *cobra.Command, args []string) error {
 	// Create server
 	host := o.host
 	port := o.port
 
 	dgraphAddress := os.Getenv("DGRAPH_ADDRESS")
-	storeSet := store.StoreSet{}
+	storeSet := store.Set{}
 	cfg := dgraphstore.DgraphConfig{Address: dgraphAddress}
 
 	err := envconfig.Process("Dgraph", &cfg)

cmd/tarianctl/cmd/add/actions.go

@@ -57,7 +57,7 @@ func newAddActionCommand(globalFlags *flags.GlobalFlags) *cobra.Command {
 	return actionsCmd
 }
 
-func (c *actionCommand) run(cmd *cobra.Command, args []string) error {
+func (c *actionCommand) run(_ *cobra.Command, args []string) error {
 	opts, err := util.ClientOptionsFromCliContext(c.logger, c.globalFlags)
 	if err != nil {
 		return fmt.Errorf("add action: %w", err)

cmd/tarianctl/cmd/add/add.go

@@ -8,7 +8,7 @@ import (
 	"github.com/spf13/cobra"
 )
 
-// addCmd represents the add command
+// NewAddCommand creates a new `add` command
 func NewAddCommand(globalFlags *flags.GlobalFlags) *cobra.Command {
 	addCmd := &cobra.Command{
 		Use:     "add",

cmd/tarianctl/cmd/flags/flag.go

@@ -85,6 +85,7 @@ func (globalFlags *GlobalFlags) ValidateGlobalFlags() error {
 	return nil
 }
 
+// GetFlagValuesFromEnvVar reads the environment variables for the global flags.
 func (globalFlags *GlobalFlags) GetFlagValuesFromEnvVar() {
 	// Read environment variable for "server-address" flag
 	if serverAddressEnv := os.Getenv("TARIAN_SERVER_ADDRESS"); serverAddressEnv != "" {

cmd/tarianctl/cmd/get/actions.go

@@ -49,7 +49,7 @@ tctl get a -o yaml
 	return actionsCmd
 }
 
-func (c *actionCommand) run(cmd *cobra.Command, args []string) error {
+func (c *actionCommand) run(_ *cobra.Command, args []string) error {
 	opts, err := util.ClientOptionsFromCliContext(c.logger, c.globalFlags)
 	if err != nil {
 		return fmt.Errorf("get actions: %w", err)

cmd/tarianctl/cmd/get/events.go

@@ -45,7 +45,7 @@ func newGetEventsCommand(globalFlags *flags.GlobalFlags) *cobra.Command {
 	return eventsCmd
 }
 
-func (c *eventsCommand) run(cmd *cobra.Command, args []string) error {
+func (c *eventsCommand) run(_ *cobra.Command, args []string) error {
 	opts, err := util.ClientOptionsFromCliContext(c.logger, c.globalFlags)
 	if err != nil {
 		return fmt.Errorf("get events: %w", err)

cmd/tarianctl/cmd/get/get.go

@@ -8,6 +8,7 @@ import (
 	"github.com/spf13/cobra"
 )
 
+// NewGetCommand creates a new `get` command
 func NewGetCommand(globalFlags *flags.GlobalFlags) *cobra.Command {
 	getCmd := &cobra.Command{
 		Use:   "get",

cmd/tarianctl/cmd/import/import.go

@@ -22,7 +22,7 @@ type importCommand struct {
 	logger      *logrus.Logger
 }
 
-// importCmd represents the import command
+// NewImportCommand creates a new `import` command
 func NewImportCommand(globalFlags *flags.GlobalFlags) *cobra.Command {
 	cmd := &importCommand{
 		globalFlags: globalFlags,
@@ -39,7 +39,7 @@ func NewImportCommand(globalFlags *flags.GlobalFlags) *cobra.Command {
 	return importCmd
 }
 
-func (c *importCommand) run(cmd *cobra.Command, args []string) error {
+func (c *importCommand) run(_ *cobra.Command, args []string) error {
 	if len(args) == 0 {
 		err := errors.New("specify file paths to import")
 		return fmt.Errorf("import: %w", err)

cmd/tarianctl/cmd/remove/actions.go

@@ -41,7 +41,7 @@ func newRemoveActionsCommand(globalFlags *flags.GlobalFlags) *cobra.Command {
 	return actionsCmd
 }
 
-func (c *removeActionsCmd) run(cmd *cobra.Command, args []string) error {
+func (c *removeActionsCmd) run(_ *cobra.Command, args []string) error {
 	if len(args) == 0 {
 		err := errors.New("please specify the name of the action to be removed")
 		return fmt.Errorf("remove action: %w", err)

cmd/tarianctl/cmd/remove/constraints.go

@@ -41,7 +41,7 @@ func newRemoveConstraintsCommand(globalFlags *flags.GlobalFlags) *cobra.Command
 	return constraintsCmd
 }
 
-func (c *removeConstraintsCmd) run(cmd *cobra.Command, args []string) error {
+func (c *removeConstraintsCmd) run(_ *cobra.Command, args []string) error {
 	if len(args) == 0 {
 		err := errors.New("please specify the names of the constraint to be removed")
 		return fmt.Errorf("remove constraint: %w", err)

cmd/tarianctl/cmd/remove/remove.go

@@ -8,7 +8,7 @@ import (
 	"github.com/spf13/cobra"
 )
 
-// removeCmd represents the remove command
+// NewRemoveCommand creates a new `remove` command
 func NewRemoveCommand(globalFlags *flags.GlobalFlags) *cobra.Command {
 	removeCmd := &cobra.Command{
 		Use:     "remove",

cmd/tarianctl/cmd/root.go

@@ -70,6 +70,7 @@ func buildRootCommand(logger *logrus.Logger) *cobra.Command {
 	return rootCmd
 }
 
+// Execute executes the root command
 func Execute() {
 	logger := log.GetLogger()
 	rootCmd := buildRootCommand(logger)

cmd/tarianctl/util/client_option.go

@@ -14,6 +14,7 @@ import (
 	"google.golang.org/grpc/credentials/insecure"
 )
 
+// ClientOptionsFromCliContext returns grpc dial options from cli context
 func ClientOptionsFromCliContext(logger *logrus.Logger, globalFlags *flags.GlobalFlags) ([]grpc.DialOption, error) {
 	o := []grpc.DialOption{}
 

cmd/version.go

@@ -2,10 +2,12 @@ package version
 
 var versionStr string
 
+// SetVersion sets the version string
 func SetVersion(ver string) {
 	versionStr = ver
 }
 
+// GetVersion returns the version string
 func GetVersion() string {
 	return versionStr
 }