feature: Add SBOM support as a possible result [TAROT-2832]

go.mod

@@ -3,6 +3,7 @@ module github.com/codacy/codacy-engine-golang-seed/v6
 go 1.21
 
 require (
+	github.com/CycloneDX/cyclonedx-go v0.9.1
 	github.com/samber/lo v1.47.0
 	github.com/sirupsen/logrus v1.9.3
 	github.com/stretchr/testify v1.9.0

result.go

@@ -3,6 +3,7 @@ package codacytool
 import (
 	"encoding/json"
 
+	"github.com/CycloneDX/cyclonedx-go"
 	"github.com/sirupsen/logrus"
 )
 
@@ -44,6 +45,20 @@ func (i FileError) GetFile() string {
 	return i.File
 }
 
+// SBOM represents a Software Bill of Materials in the CycloneDX format.
+type SBOM struct {
+	cyclonedx.BOM
+}
+
+func (s SBOM) ToJSON() ([]byte, error) {
+	return json.Marshal(s)
+}
+
+// GetFile always returns an empty value since SBOM is for the whole project, not a single file.
+func (s SBOM) GetFile() string {
+	return ""
+}
+
 type Results []Result
 
 func (r Results) ToJSON() []string {

result_test.go

@@ -19,15 +19,17 @@ func TestResultsToJSON(t *testing.T) {
 		File:    "file-error",
 		Message: "file-error",
 	}
+	sbom := SBOM{}
 	badResult := BadResult{}
 
 	expectedJSONResults := []string{
 		`{"filename":"file","line":5,"message":"message","patternId":"pattern ID"}`,
 		`{"filename":"file-error","message":"file-error"}`,
+		`{"bomFormat":"","specVersion":"SpecVersion(0)","version":0}`,
 	}
 
 	// Act
-	jsonResults := Results{issue, fileError, badResult}.ToJSON()
+	jsonResults := Results{issue, fileError, sbom, badResult}.ToJSON()
 
 	// Assert
 	// Since a JSON object does not have order, we can't simply assert by doing `assert.ElementsMatch`.
@@ -44,14 +46,17 @@ func TestResultsGetFile(t *testing.T) {
 	// Arrange
 	issue := Issue{File: "issue-file"}
 	fileError := FileError{File: "file-error"}
+	sbom := SBOM{}
 
 	// Act
 	issueFile := issue.GetFile()
 	fileErrorFile := fileError.GetFile()
+	sbomFile := sbom.GetFile()
 
 	// Assert
 	assert.Equal(t, "issue-file", issueFile)
 	assert.Equal(t, "file-error", fileErrorFile)
+	assert.Empty(t, sbomFile)
 }
 
 type BadResult struct{}