Add DryCLI status comparison

Ref: https://issues.redhat.com/browse/ACM-17517
Signed-off-by: yiraeChristineKim <[email protected]>

Author: yiraeChristineKim

go.mod

@@ -116,7 +116,7 @@ require (
 	google.golang.org/protobuf v1.34.2 // indirect
 	gopkg.in/evanphx/json-patch.v4 v4.12.0 // indirect
 	gopkg.in/inf.v0 v0.9.1 // indirect
-	gopkg.in/yaml.v2 v2.4.0 // indirect
+	gopkg.in/yaml.v2 v2.4.0
 	k8s.io/apiserver v0.31.0 // indirect
 	k8s.io/cli-runtime v0.28.10 // indirect
 	k8s.io/component-base v0.31.0 // indirect

pkg/dryrun/cmd.go

@@ -12,12 +12,13 @@ import (
 )
 
 type DryRunner struct {
-	policyPath   string
-	messagesPath string
-	printDiffs   bool
-	statusPath   string
-	mappingsPath string
-	logPath      string
+	policyPath    string
+	messagesPath  string
+	printDiffs    bool
+	statusPath    string
+	desiredStatus string
+	mappingsPath  string
+	logPath       string
 }
 
 var ErrNonCompliant = errors.New("policy is NonCompliant")
@@ -60,6 +61,14 @@ func (d *DryRunner) GetCmd() *cobra.Command {
 		"Set to false to omit any diffs generated by the policy.",
 	)
 
+	cmd.Flags().StringVarP(
+		&d.desiredStatus,
+		"desired-status",
+		"c",
+		"",
+		"The desired Configuration Policy status to compare with result of the dryrun",
+	)
+
 	cmd.Flags().StringVar(
 		&d.statusPath,
 		"status-path",

pkg/dryrun/dryrun.go

@@ -110,6 +110,14 @@ func (d *DryRunner) dryRun(cmd *cobra.Command, args []string) error {
 		return fmt.Errorf("unable to get the resulting policy state: %w", err)
 	}
 
+	if d.desiredStatus != "" {
+		if err := d.compareStatus(cmd, cfgPolicy.Status); err != nil {
+			return fmt.Errorf("unable to compare configuration policy status: %w", err)
+		}
+
+		cmd.Print("\n")
+	}
+
 	if d.statusPath != "" {
 		if err := d.saveStatus(cfgPolicy.Status); err != nil {
 			return fmt.Errorf("unable to save the resulting policy state: %w", err)
@@ -467,6 +475,33 @@ func (d *DryRunner) setupReconciler(
 	return &rec, nil
 }
 
+func (d *DryRunner) compareStatus(cmd *cobra.Command, status policyv1.ConfigurationPolicyStatus) error {
+	reader, err := os.Open(d.desiredStatus)
+	if err != nil {
+		return err
+	}
+
+	configBytes, err := io.ReadAll(reader)
+	if err != nil {
+		return err
+	}
+
+	inputMap := map[string]interface{}{}
+
+	if err := yaml.Unmarshal(configBytes, &inputMap); err != nil {
+		return err
+	}
+
+	resultMap := toMap(status)
+	if resultMap == nil {
+		return errors.New("unable to convert ConfigurationPolicyStatus to unstructured")
+	}
+
+	compareStatus(cmd, inputMap, resultMap)
+
+	return nil
+}
+
 func (d *DryRunner) saveStatus(status policyv1.ConfigurationPolicyStatus) error {
 	f, err := os.Create(d.statusPath)
 	if err != nil {

pkg/dryrun/dryrun_test.go

@@ -6,6 +6,7 @@ import (
 	"bytes"
 	"embed"
 	"errors"
+	"os"
 	"path"
 	"strings"
 	"testing"
@@ -83,6 +84,14 @@ func cliTest(scenarioPath string) func(t *testing.T) {
 			t.Fatal(err)
 		}
 
+		desiredStatusPath := path.Join(scenarioPath, "desired_status.yaml")
+		if pathExists(desiredStatusPath) {
+			err = cmd.Flags().Set("desired-status", desiredStatusPath)
+			if err != nil {
+				t.Fatal(err)
+			}
+		}
+
 		err = cmd.Execute()
 		if err != nil && !errors.Is(err, ErrNonCompliant) {
 			t.Fatal(err)
@@ -118,3 +127,14 @@ func cliTest(scenarioPath string) func(t *testing.T) {
 		}
 	}
 }
+
+func pathExists(path string) bool {
+	f, err := os.Open(path)
+	if err != nil {
+		return false
+	}
+
+	f.Close()
+
+	return true
+}