feat: print disabled rules (#124)

Author: dimabru

cmd/validate/main.go

@@ -3,6 +3,7 @@ package validate
 import (
 	"errors"
 	"fmt"
+	"path/filepath"
 
 	"github.com/allero-io/allero/pkg/configurationManager"
 	localConnector "github.com/allero-io/allero/pkg/connectors/local"
@@ -59,7 +60,15 @@ allero validate ~/my-repo-dir       Validate over local directory`,
 		Args:          cobra.MaximumNArgs(1),
 		PreRun: func(cmd *cobra.Command, cmdArgs []string) {
 			args := make(map[string]any)
+
+			if len(cmdArgs) > 0 {
+				absolutePath, err := filepath.Abs(cmdArgs[0])
+				if err == nil {
+					cmdArgs[0] = absolutePath
+				}
+			}
 			args["Args"] = cmdArgs
+
 			decodedToken, _ := deps.ConfigurationManager.ParseToken()
 			if decodedToken != nil {
 				args["User Email"] = decodedToken.Email
@@ -158,6 +167,7 @@ func execute(deps *ValidateCommandDependencies, option *validateCommandOptions)
 	}
 
 	ruleResultsById := map[int]*rulesConfig.RuleResult{}
+	disabledRules := map[string]bool{}
 
 	for scmPlatform, ruleNames := range ruleNamesByScmPlatform {
 		for _, ruleName := range ruleNames {
@@ -168,9 +178,8 @@ func execute(deps *ValidateCommandDependencies, option *validateCommandOptions)
 
 			isCustomRule := rule.UniqueId >= 1000
 
-			if hasToken && !selectedRuleIds[rule.UniqueId] && !isCustomRule {
-				continue
-			} else if !hasToken && !rule.EnabledByDefault {
+			if isRuleDisabled(hasToken, selectedRuleIds, rule, isCustomRule) {
+				disabledRules[ruleName] = true
 				continue
 			}
 
@@ -208,16 +217,13 @@ func execute(deps *ValidateCommandDependencies, option *validateCommandOptions)
 
 	summary.TotalRulesEvaluated = len(ruleResultsById)
 	summary.TotalFailedRules = totalRulesFailed
-
-	if !hasToken {
-		summary.URL = deps.ConfigurationManager.TokenGenerationUrl
-	}
+	summary.URL = deps.ConfigurationManager.TokenGenerationUrl
 
 	if isLocal {
 		ruleResultsById = reduceLocalRuleResults(ruleResultsById)
 	}
 
-	err = resultsPrinter.PrintResults(ruleResultsById, summary, option.output, isLocal)
+	err = resultsPrinter.PrintResults(ruleResultsById, summary, disabledRules, option.output, isLocal)
 	if err != nil {
 		return err
 	}
@@ -227,6 +233,16 @@ func execute(deps *ValidateCommandDependencies, option *validateCommandOptions)
 	return nil
 }
 
+func isRuleDisabled(hasToken bool, selectedRuleIds map[int]bool, rule *defaultRules.Rule, isCustomRule bool) bool {
+	if hasToken && !selectedRuleIds[rule.UniqueId] && !isCustomRule {
+		return true
+	} else if !hasToken && !rule.EnabledByDefault {
+		return true
+	}
+
+	return false
+}
+
 func reduceLocalRuleResults(ruleResultsById map[int]*rulesConfig.RuleResult) map[int]*rulesConfig.RuleResult {
 	reducedRuleResultsById := map[int]*rulesConfig.RuleResult{}
 	for uniqueId, ruleResult := range ruleResultsById {

pkg/resultsPrinter/resultsPrinter.go

@@ -27,13 +27,13 @@ const colorRed = "\033[31m"
 const colorReset = "\033[0m"
 const colorBlue = "\033[34m"
 
-func PrintResults(ruleResults map[int]*rulesConfig.RuleResult, summary rulesConfig.OutputSummary, outputFormat string, localValidation bool) error {
+func PrintResults(ruleResults map[int]*rulesConfig.RuleResult, summary rulesConfig.OutputSummary, disabledRules map[string]bool, outputFormat string, localValidation bool) error {
 	if localValidation {
 		PatchLocalErrors(ruleResults)
 	}
 	if outputFormat == "" {
 		printPretty(ruleResults, summary)
-		printSummary(ruleResults, summary)
+		printSummary(ruleResults, summary, disabledRules)
 	} else if outputFormat == "csv" {
 		return printCSV(ruleResults, summary)
 	}
@@ -99,7 +99,7 @@ func unescapeValue(value string) string {
 	return strings.ReplaceAll(value, "[ESCAPED_DOT]", ".")
 }
 
-func printSummary(ruleResults map[int]*rulesConfig.RuleResult, summary rulesConfig.OutputSummary) {
+func printSummary(ruleResults map[int]*rulesConfig.RuleResult, summary rulesConfig.OutputSummary, disabledRules map[string]bool) {
 	t := table.NewWriter()
 	t.SetOutputMirror(os.Stdout)
 	fmt.Println("Summary")
@@ -115,11 +115,18 @@ func printSummary(ruleResults map[int]*rulesConfig.RuleResult, summary rulesConf
 	t.AppendRow([]interface{}{"Failed rules", summary.TotalFailedRules})
 	t.Render()
 
-	if summary.URL != "" {
-		fmt.Println()
-		fmt.Println("Select your own rules:", string(colorBlue), summary.URL, string(colorReset))
+	fmt.Println()
+
+	if len(disabledRules) > 0 {
+		fmt.Println("The following rules are disabled:")
+		for ruleName := range disabledRules {
+			fmt.Println(string(colorBlue), "\r", ruleName, string(colorReset))
+		}
 	}
 
+	fmt.Println()
+	fmt.Println("Click on the link to activate/deactivate rules:", string(colorBlue), summary.URL, string(colorReset))
+
 	if summary.TotalFailedRules > 0 {
 		fmt.Println()
 		fmt.Println("Failed rules summary:")