refactor!(evaluate): #388 EvaluateResults now uses pointers

refactor!(component): change NewOscalComponentDefinitionFromBytes to return a pointer
defenseunicorns · May 10, 2024 · a09dffd · a09dffd
1 parent 1d74a87
commit a09dffd
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 12 deletions.
diff --git a/src/cmd/evaluate/evaluate.go b/src/cmd/evaluate/evaluate.go
@@ -68,7 +68,7 @@ func EvaluateAssessmentResults(files []string) error {
 		}
 		// We write results to the assessment-results report in newest -> oldest
 		// Older being our threshold here
-		status, findings, err = EvaluateResults(assessment.Results[1], assessment.Results[0])
+		status, findings, err = EvaluateResults(&assessment.Results[1], &assessment.Results[0])
 		if err != nil {
 			return err
 		}
@@ -94,7 +94,7 @@ func EvaluateAssessmentResults(files []string) error {
 		// Consider parsing the timestamps for comparison
 		// Older timestamp being the threshold
 
-		status, findings, err = EvaluateResults(assessmentOne.Results[0], assessmentTwo.Results[0])
+		status, findings, err = EvaluateResults(&assessmentOne.Results[0], &assessmentTwo.Results[0])
 		if err != nil {
 			return err
 		}
@@ -120,7 +120,7 @@ func EvaluateAssessmentResults(files []string) error {
 	}
 }
 
-func EvaluateResults(thresholdResult oscalTypes_1_1_2.Result, newResult oscalTypes_1_1_2.Result) (bool, map[string][]oscalTypes_1_1_2.Finding, error) {
+func EvaluateResults(thresholdResult *oscalTypes_1_1_2.Result, newResult *oscalTypes_1_1_2.Result) (bool, map[string][]oscalTypes_1_1_2.Finding, error) {
 	spinner := message.NewProgressSpinner("Evaluating Assessment Results %s against %s", newResult.UUID, thresholdResult.UUID)
 	defer spinner.Stop()
 

diff --git a/src/cmd/evaluate/evaluate_test.go b/src/cmd/evaluate/evaluate_test.go
@@ -37,7 +37,7 @@ func TestEvaluateResultsPassing(t *testing.T) {
 		},
 	}
 
-	status, _, err := EvaluateResults(mockThresholdResult, mockEvaluationResult)
+	status, _, err := EvaluateResults(&mockThresholdResult, &mockEvaluationResult)
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -77,7 +77,7 @@ func TestEvaluateResultsFailed(t *testing.T) {
 		},
 	}
 
-	status, findings, err := EvaluateResults(mockThresholdResult, mockEvaluationResult)
+	status, findings, err := EvaluateResults(&mockThresholdResult, &mockEvaluationResult)
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -103,7 +103,7 @@ func TestEvaluateResultsNoFindings(t *testing.T) {
 		Findings: &[]oscalTypes_1_1_2.Finding{},
 	}
 
-	status, _, err := EvaluateResults(mockThresholdResult, mockEvaluationResult)
+	status, _, err := EvaluateResults(&mockThresholdResult, &mockEvaluationResult)
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -132,7 +132,7 @@ func TestEvaluateResultsNoThreshold(t *testing.T) {
 		},
 	}
 
-	_, _, err := EvaluateResults(mockThresholdResult, mockEvaluationResult)
+	_, _, err := EvaluateResults(&mockThresholdResult, &mockEvaluationResult)
 	if err == nil {
 		t.Fatal("error - expected error, got nil")
 	}
@@ -182,7 +182,7 @@ func TestEvaluateResultsNewFindings(t *testing.T) {
 		},
 	}
 
-	status, findings, err := EvaluateResults(mockThresholdResult, mockEvaluationResult)
+	status, findings, err := EvaluateResults(&mockThresholdResult, &mockEvaluationResult)
 	if err != nil {
 		t.Fatal(err)
 	}

diff --git a/src/pkg/common/composition/composition.go b/src/pkg/common/composition/composition.go
@@ -64,13 +64,13 @@ func ComposeComponentDefinitions(compDef *oscalTypes_1_1_2.ComponentDefinition)
 				}
 
 				// Recurse and compose the component definition
-				err = ComposeComponentDefinitions(&importDef)
+				err = ComposeComponentDefinitions(importDef)
 				if err != nil {
 					return err
 				}
 
 				// Merge the component definitions
-				compDef, err = oscal.MergeComponentDefinitions(compDef, &importDef)
+				compDef, err = oscal.MergeComponentDefinitions(compDef, importDef)
 				if err != nil {
 					return err
 				}

diff --git a/src/pkg/common/oscal/component.go b/src/pkg/common/oscal/component.go
@@ -50,13 +50,13 @@ func NewOscalComponentDefinition(source string, data []byte) (componentDefinitio
 }
 
 // NewOscalComponentDefinitionFromBytes consumes a byte array and returns a new single OscalComponentDefinitionModel object
-func NewOscalComponentDefinitionFromBytes(data []byte) (componentDefinition oscalTypes_1_1_2.ComponentDefinition, err error) {
+func NewOscalComponentDefinitionFromBytes(data []byte) (componentDefinition *oscalTypes_1_1_2.ComponentDefinition, err error) {
 	var oscalModels oscalTypes_1_1_2.OscalModels
 	err = yaml.Unmarshal(data, &oscalModels)
 	if err != nil {
 		return componentDefinition, err
 	}
-	return *oscalModels.ComponentDefinition, nil
+	return oscalModels.ComponentDefinition, nil
 }
 
 // This function should perform a merge of two component-definitions where maintaining the original component-definition is the primary concern.