refactor!: #388 update types to use pointers

src/cmd/evaluate/evaluate.go

@@ -3,6 +3,7 @@ package evaluate
 import (
 	"fmt"
 
+	"github.com/defenseunicorns/go-oscal/src/pkg/utils"
 	oscalTypes_1_1_2 "github.com/defenseunicorns/go-oscal/src/types/oscal-1-1-2"
 	"github.com/defenseunicorns/lula/src/pkg/common"
 	"github.com/defenseunicorns/lula/src/pkg/common/oscal"
@@ -50,11 +51,21 @@ func EvaluateCommand() *cobra.Command {
 func EvaluateAssessmentResults(files []string) error {
 	var status bool
 	var findings map[string][]oscalTypes_1_1_2.Finding
+
 	// Read in files - establish the results to
 	if len(files) == 0 {
 		// TODO: Determine if we will handle a default location/name for assessment files
 		return fmt.Errorf("No files provided for evaluation")
-	} else if len(files) == 1 {
+	}
+
+	for _, f := range files {
+		err := utils.IsJsonOrYaml(f)
+		if err != nil {
+			return fmt.Errorf("invalid file extension: %s, requires .json or .yaml", f)
+		}
+	}
+
+	if len(files) == 1 {
 		data, err := common.ReadFileToBytes(files[0])
 		if err != nil {
 			return err
@@ -68,7 +79,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 +105,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 +131,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()
 

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)
 	}

src/cmd/generate/generate.go

@@ -4,7 +4,6 @@ import (
 	"fmt"
 
 	oscalTypes_1_1_2 "github.com/defenseunicorns/go-oscal/src/types/oscal-1-1-2"
-	"github.com/defenseunicorns/lula/src/pkg/common"
 	"github.com/defenseunicorns/lula/src/pkg/common/network"
 	"github.com/defenseunicorns/lula/src/pkg/common/oscal"
 	"github.com/defenseunicorns/lula/src/pkg/message"
@@ -90,7 +89,7 @@ var generateComponentCmd = &cobra.Command{
 		}
 
 		// Create new catalog object
-		catalog, err := oscal.NewCatalog(source, data)
+		catalog, err := oscal.NewCatalog(data)
 		if err != nil {
 			message.Fatalf(fmt.Errorf("error creating catalog"), "error creating catalog")
 		}
@@ -106,7 +105,7 @@ var generateComponentCmd = &cobra.Command{
 		}
 
 		// Write the component definition to file
-		err = common.WriteFile(componentOpts.OutputFile, &model)
+		err = oscal.WriteOscalModel(componentOpts.OutputFile, &model)
 		if err != nil {
 			message.Fatalf(err, "error writing component to file")
 		}

src/cmd/validate/validate.go

@@ -8,6 +8,7 @@ import (
 	"path/filepath"
 	"time"
 
+	"github.com/defenseunicorns/go-oscal/src/pkg/utils"
 	"github.com/defenseunicorns/go-oscal/src/pkg/uuid"
 	oscalTypes_1_1_2 "github.com/defenseunicorns/go-oscal/src/types/oscal-1-1-2"
 	"github.com/defenseunicorns/lula/src/pkg/common"
@@ -44,6 +45,11 @@ var validateCmd = &cobra.Command{
 			message.Fatal(errors.New("flag input-file is not set"),
 				"Please specify an input file with the -f flag")
 		}
+
+		if err := utils.IsJsonOrYaml(opts.InputFile); err != nil {
+			message.Fatalf(err, "Invalid file extension: %s, requires .json or .yaml", opts.InputFile)
+		}
+
 		// Primary expected path for validation of OSCAL documents
 		findings, observations, err := ValidateOnPath(opts.InputFile)
 		if err != nil {
@@ -60,7 +66,7 @@ var validateCmd = &cobra.Command{
 		}
 
 		// Write the component definition to file
-		err = common.WriteFile(opts.OutputFile, &model)
+		err = oscal.WriteOscalModel(opts.OutputFile, &model)
 		if err != nil {
 			message.Fatalf(err, "error writing component to file")
 		}
@@ -121,7 +127,7 @@ func ValidateOnPath(path string) (findingMap map[string]oscalTypes_1_1_2.Finding
 	}
 	defer resetCwd()
 
-	compDef, err := oscal.NewOscalComponentDefinition(path, data)
+	compDef, err := oscal.NewOscalComponentDefinition(data)
 	if err != nil {
 		return findingMap, observations, err
 	}
@@ -282,7 +288,7 @@ func ValidateOnCompDef(compDef *oscalTypes_1_1_2.ComponentDefinition) (map[strin
 func WriteReport(report oscalTypes_1_1_2.AssessmentResults, assessmentFilePath string) error {
 
 	var fileName string
-	var tempAssessment oscalTypes_1_1_2.AssessmentResults
+	var tempAssessment *oscalTypes_1_1_2.AssessmentResults
 
 	if assessmentFilePath != "" {
 
@@ -308,23 +314,23 @@ func WriteReport(report oscalTypes_1_1_2.AssessmentResults, assessmentFilePath s
 
 		} else if os.IsNotExist(err) {
 			// File does not exist
-			tempAssessment = report
+			tempAssessment = &report
 			fileName = assessmentFilePath
 		} else {
 			// Some other error occurred (permission issues, etc.)
 			return err
 		}
 
 	} else {
-		tempAssessment = report
+		tempAssessment = &report
 		currentTime := time.Now()
-		fileName = "assessment-results-" + currentTime.Format("01-02-2006-15:04:05") + ".yaml"
+		fileName = "assessment-results-" + currentTime.Format("01-02-206-15:04:05") + ".yaml"
 	}
 
 	var b bytes.Buffer
 
 	var sar = oscalTypes_1_1_2.OscalModels{
-		AssessmentResults: &tempAssessment,
+		AssessmentResults: tempAssessment,
 	}
 
 	yamlEncoder := yaml.NewEncoder(&b)

src/pkg/common/common.go

@@ -1,24 +1,20 @@
 package common
 
 import (
-	"bytes"
 	"context"
 	"fmt"
 	"os"
 	"path/filepath"
 	"strings"
 
-	"github.com/defenseunicorns/go-oscal/src/pkg/utils"
 	oscalTypes_1_1_2 "github.com/defenseunicorns/go-oscal/src/types/oscal-1-1-2"
-	"github.com/defenseunicorns/lula/src/pkg/common/oscal"
 	"github.com/defenseunicorns/lula/src/pkg/domains/api"
 	kube "github.com/defenseunicorns/lula/src/pkg/domains/kubernetes"
 	"github.com/defenseunicorns/lula/src/pkg/message"
 	"github.com/defenseunicorns/lula/src/pkg/providers/kyverno"
 	"github.com/defenseunicorns/lula/src/pkg/providers/opa"
 	"github.com/defenseunicorns/lula/src/types"
 	goversion "github.com/hashicorp/go-version"
-	"gopkg.in/yaml.v3"
 )
 
 const (
@@ -58,49 +54,6 @@ func ReadFileToBytes(path string) ([]byte, error) {
 	return data, nil
 }
 
-// WriteFile takes a path and writes content to a file while performing checks for existing content
-func WriteFile(filePath string, model *oscalTypes_1_1_2.OscalModels) error {
-
-	// if no path or directory add default filename
-	if filepath.Ext(filePath) == "" {
-		filePath = filepath.Join(filePath, "oscal.yaml")
-	}
-
-	if _, err := os.Stat(filePath); err == nil {
-		// If the file exists - read the data into the model
-		existingFileBytes, err := os.ReadFile(filePath)
-		if err != nil {
-			return err
-		}
-		existingModel, err := oscal.NewOscalModel(existingFileBytes)
-		if err != nil {
-			return err
-		}
-		// Merge the existing model with the new model
-		// re-assign to perform common operations below
-		model, err = oscal.MergeOscalModels(existingModel, model)
-		if err != nil {
-			return err
-		}
-	}
-
-	var b bytes.Buffer
-
-	yamlEncoder := yaml.NewEncoder(&b)
-	yamlEncoder.SetIndent(2)
-	yamlEncoder.Encode(model)
-
-	err := utils.WriteOutput(b.Bytes(), filePath)
-	if err != nil {
-		return err
-	}
-
-	message.Infof("OSCAL artifact written to: %s", filePath)
-
-	return nil
-
-}
-
 // Returns version validity
 func IsVersionValid(versionConstraint string, version string) (bool, error) {
 	if version == "unset" {
@@ -164,33 +117,39 @@ func SetCwdToFileDir(dirPath string) (resetFunc func(), err error) {
 }
 
 // Get the domain and providers
-func GetDomain(domain Domain, ctx context.Context) types.Domain {
+func GetDomain(domain *Domain, ctx context.Context) types.Domain {
+	if domain == nil {
+		return nil
+	}
 	switch domain.Type {
 	case "kubernetes":
 		return kube.KubernetesDomain{
 			Context: ctx,
-			Spec:    domain.KubernetesSpec,
+			Spec:    *domain.KubernetesSpec,
 		}
 	case "api":
 		return api.ApiDomain{
-			Spec: domain.ApiSpec,
+			Spec: *domain.ApiSpec,
 		}
 	default:
 		return nil
 	}
 }
 
-func GetProvider(provider Provider, ctx context.Context) types.Provider {
+func GetProvider(provider *Provider, ctx context.Context) types.Provider {
+	if provider == nil {
+		return nil
+	}
 	switch provider.Type {
 	case "opa":
 		return opa.OpaProvider{
 			Context: ctx,
-			Spec:    provider.OpaSpec,
+			Spec:    *provider.OpaSpec,
 		}
 	case "kyverno":
 		return kyverno.KyvernoProvider{
 			Context: ctx,
-			Spec:    provider.KyvernoSpec,
+			Spec:    *provider.KyvernoSpec,
 		}
 	default:
 		return nil