From fb0117e77845904e0b58251d72460b6c3e26d00e Mon Sep 17 00:00:00 2001
From: Laurence Jones <laurence.jones@live.co.uk>
Date: Tue, 3 Sep 2024 14:27:36 +0100
Subject: [PATCH] enhance: add additional explain options to hubtest (#3162)

* enhance: add additional explain options to hubtest

* Revert "enhance: add additional explain options to hubtest"

This reverts commit b24632f3eb473e3c42885f31827764d2b7eebe2d.

* enhance: add additional explain options to hubtest

---------

Co-authored-by: marco <marco@crowdsec.net>
---
 cmd/crowdsec-cli/clihubtest/explain.go | 77 +++++++++++++++++---------
 1 file changed, 51 insertions(+), 26 deletions(-)

diff --git a/cmd/crowdsec-cli/clihubtest/explain.go b/cmd/crowdsec-cli/clihubtest/explain.go
index ecaf520211e..4183b6a515d 100644
--- a/cmd/crowdsec-cli/clihubtest/explain.go
+++ b/cmd/crowdsec-cli/clihubtest/explain.go
@@ -8,7 +8,52 @@ import (
 	"github.com/crowdsecurity/crowdsec/pkg/dumps"
 )
 
+
+func (cli *cliHubTest) explain(testName string, details bool, skipOk bool) error {
+	test, err := HubTest.LoadTestItem(testName)
+	if err != nil {
+		return fmt.Errorf("can't load test: %+v", err)
+	}
+
+	err = test.ParserAssert.LoadTest(test.ParserResultFile)
+	if err != nil {
+		if err = test.Run(); err != nil {
+			return fmt.Errorf("running test '%s' failed: %+v", test.Name, err)
+		}
+
+		if err = test.ParserAssert.LoadTest(test.ParserResultFile); err != nil {
+			return fmt.Errorf("unable to load parser result after run: %w", err)
+		}
+	}
+
+	err = test.ScenarioAssert.LoadTest(test.ScenarioResultFile, test.BucketPourResultFile)
+	if err != nil {
+		if err = test.Run(); err != nil {
+			return fmt.Errorf("running test '%s' failed: %+v", test.Name, err)
+		}
+
+		if err = test.ScenarioAssert.LoadTest(test.ScenarioResultFile, test.BucketPourResultFile); err != nil {
+			return fmt.Errorf("unable to load scenario result after run: %w", err)
+		}
+	}
+
+	opts := dumps.DumpOpts{
+		Details: details,
+		SkipOk: skipOk,
+	}
+
+	dumps.DumpTree(*test.ParserAssert.TestData, *test.ScenarioAssert.PourData, opts)
+
+	return nil
+}
+
+
 func (cli *cliHubTest) NewExplainCmd() *cobra.Command {
+	var (
+		details bool
+		skipOk  bool
+	)
+
 	cmd := &cobra.Command{
 		Use:               "explain",
 		Short:             "explain [test_name]",
@@ -16,38 +61,18 @@ func (cli *cliHubTest) NewExplainCmd() *cobra.Command {
 		DisableAutoGenTag: true,
 		RunE: func(_ *cobra.Command, args []string) error {
 			for _, testName := range args {
-				test, err := HubTest.LoadTestItem(testName)
-				if err != nil {
-					return fmt.Errorf("can't load test: %+v", err)
+				if err := cli.explain(testName, details, skipOk); err != nil {
+					return err
 				}
-				err = test.ParserAssert.LoadTest(test.ParserResultFile)
-				if err != nil {
-					if err = test.Run(); err != nil {
-						return fmt.Errorf("running test '%s' failed: %+v", test.Name, err)
-					}
-
-					if err = test.ParserAssert.LoadTest(test.ParserResultFile); err != nil {
-						return fmt.Errorf("unable to load parser result after run: %w", err)
-					}
-				}
-
-				err = test.ScenarioAssert.LoadTest(test.ScenarioResultFile, test.BucketPourResultFile)
-				if err != nil {
-					if err = test.Run(); err != nil {
-						return fmt.Errorf("running test '%s' failed: %+v", test.Name, err)
-					}
-
-					if err = test.ScenarioAssert.LoadTest(test.ScenarioResultFile, test.BucketPourResultFile); err != nil {
-						return fmt.Errorf("unable to load scenario result after run: %w", err)
-					}
-				}
-				opts := dumps.DumpOpts{}
-				dumps.DumpTree(*test.ParserAssert.TestData, *test.ScenarioAssert.PourData, opts)
 			}
 
 			return nil
 		},
 	}
 
+	flags := cmd.Flags()
+	flags.BoolVarP(&details, "verbose", "v", false, "Display individual changes")
+	flags.BoolVar(&skipOk, "failures", false, "Only show failed lines")
+
 	return cmd
 }