Replace core SBOM-creation API with builder pattern (#1383)

* remove existing cataloging API Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * add file cataloging config Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * add package cataloging config Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * add configs for cross-cutting concerns Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * rename CLI option configs to not require import aliases later Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * update all nested structs for the Catalog struct Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * update Catalog cli options - add new cataloger selection options (selection and default) - remove the excludeBinaryOverlapByOwnership - deprecate "catalogers" flag - add new javascript configuration Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * migrate relationship capabilities to separate internal package Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * refactor golang cataloger to use configuration options when creating packages Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * create internal object to facilitate reading from and writing to an SBOM Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * create a command-like object (task) to facilitate partial SBOM creation Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * add cataloger selection capability - be able to parse string expressions into a set of resolved actions against sets - be able to use expressions to select/add/remove tasks to/from the final set of tasks to run Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * add package, file, and environment related tasks Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * update existing file catalogers to use nested UI elements Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * add CreateSBOMConfig that drives the SBOM creation process Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * capture SBOM creation info as a struct Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * add CreateSBOM() function Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * fix tests Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * update docs with SBOM selection help + breaking changes Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * fix multiple override default inputs Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * fix deprecation flag printing to stdout Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * refactor cataloger selection description to separate object Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * address review comments Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * keep expression errors and show specific suggestions only Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * address additional review feedback Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * address more review comments Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * addressed additional PR review feedback Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * fix file selection references Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * remove guess language data generation option Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * add tests for coordinatesForSelection Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * rename relationship attributes Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * add descriptions to relationships config fields Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * improve documentation around configuration options Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * add explicit errors around legacy config entries Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> --------- Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com>
2026-10-30 14:02:26 +01:00 · 2024-01-12 17:39:13 -05:00
parent 1bffc6ef0c
commit b0ab75fd89
126 changed files with 5740 additions and 1841 deletions
@@ -0,0 +1,242 @@
+package task
+
+import (
+	"sort"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+
+	"github.com/anchore/syft/syft/cataloging/pkgcataloging"
+)
+
+func Test_newExpressionsFromSelectionRequest(t *testing.T) {
+	ts := []Task{
+		dummyTask("1", "t1"),
+		dummyTask("2", "t2"),
+		dummyTask("3", "t3"),
+		dummyTask("4", "t4"),
+		dummyTask("5"),
+		dummyTask("6"),
+	}
+
+	nc := newExpressionContext(ts)
+
+	var tests = []struct {
+		name           string
+		basis          []string
+		expressions    []string
+		expected       Expressions
+		expectedErrors []error
+	}{
+		{
+			name:        "empty input",
+			basis:       []string{},
+			expressions: []string{},
+			expected:    nil,
+		},
+		{
+			name:        "valid single set operation",
+			basis:       []string{"1"},
+			expressions: []string{},
+			expected: []Expression{
+				{Operation: SetOperation, Operand: "1"},
+			},
+		},
+		{
+			name:        "add operation",
+			basis:       []string{},
+			expressions: []string{"+4"},
+			expected: []Expression{
+				{Operation: AddOperation, Operand: "4"},
+			},
+		},
+		{
+			name:        "remove operation",
+			basis:       []string{},
+			expressions: []string{"-3"},
+			expected: []Expression{
+				{Operation: RemoveOperation, Operand: "3"},
+			},
+		},
+		{
+			name:        "select operation",
+			basis:       []string{},
+			expressions: []string{"t2"},
+			expected: []Expression{
+				{Operation: SubSelectOperation, Operand: "t2"},
+			},
+		},
+		{
+			name:        "mixed operations order",
+			basis:       []string{"1"},
+			expressions: []string{"+4", "-3", "t2"},
+			expected: []Expression{
+				// note they are sorted by operation
+				{Operation: SetOperation, Operand: "1"},
+				{Operation: SubSelectOperation, Operand: "t2"},
+				{Operation: RemoveOperation, Operand: "3"},
+				{Operation: AddOperation, Operand: "4"},
+			},
+		},
+		{
+			name:           "invalid token",
+			basis:          []string{"!1"},
+			expressions:    []string{},
+			expected:       nil,
+			expectedErrors: []error{ErrInvalidToken},
+		},
+		{
+			name:           "use + operator in basis",
+			basis:          []string{"+1"},
+			expressions:    []string{},
+			expected:       nil,
+			expectedErrors: []error{ErrInvalidToken},
+		},
+		{
+			name:           "use - operator in basis",
+			basis:          []string{"-1"},
+			expressions:    []string{},
+			expected:       nil,
+			expectedErrors: []error{ErrInvalidToken},
+		},
+		{
+			name:           "invalid name",
+			basis:          []string{},
+			expressions:    []string{"+t1"},
+			expected:       nil,
+			expectedErrors: []error{ErrTagsNotAllowed},
+		},
+		{
+			name:           "invalid tag",
+			basis:          []string{},
+			expressions:    []string{"1"},
+			expected:       nil,
+			expectedErrors: []error{ErrNamesNotAllowed},
+		},
+		{
+			name:           "invalid use of all",
+			basis:          []string{},
+			expressions:    []string{"all"},
+			expected:       nil,
+			expectedErrors: []error{ErrAllNotAllowed},
+		},
+		{
+			name:        "allow all operand",
+			basis:       []string{"all"},
+			expressions: []string{},
+			expected: []Expression{
+				// note they are sorted by operation
+				{Operation: SetOperation, Operand: "all"},
+			},
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+
+			req := pkgcataloging.NewSelectionRequest().WithDefaults(tt.basis...).WithExpression(tt.expressions...)
+
+			result := newExpressionsFromSelectionRequest(nc, req)
+			if tt.expectedErrors != nil {
+				errs := result.Errors()
+				require.Len(t, errs, len(tt.expectedErrors))
+				for i, err := range tt.expectedErrors {
+					var target ErrInvalidExpression
+					require.ErrorAs(t, errs[i], &target)
+					assert.Equal(t, err, target.Err)
+				}
+			} else {
+				assert.Empty(t, result.Errors())
+				assert.Equal(t, tt.expected, result)
+			}
+		})
+	}
+}
+
+func Test_expressionNodes_sort(t *testing.T) {
+	tests := []struct {
+		name    string
+		subject Expressions
+		want    Expressions
+	}{
+		{
+			name: "sort operations but keep token order",
+			subject: []Expression{
+				{
+					Operation: AddOperation,
+					Operand:   "8",
+				},
+				{
+					Operation: AddOperation,
+					Operand:   "7",
+				},
+				{
+					Operation: RemoveOperation,
+					Operand:   "6",
+				},
+				{
+					Operation: RemoveOperation,
+					Operand:   "5",
+				},
+				{
+					Operation: SetOperation,
+					Operand:   "2",
+				},
+				{
+					Operation: SetOperation,
+					Operand:   "1",
+				},
+				{
+					Operation: SubSelectOperation,
+					Operand:   "4",
+				},
+				{
+					Operation: SubSelectOperation,
+					Operand:   "3",
+				},
+			},
+			want: []Expression{
+				{
+					Operation: SetOperation,
+					Operand:   "2",
+				},
+				{
+					Operation: SetOperation,
+					Operand:   "1",
+				},
+				{
+					Operation: SubSelectOperation,
+					Operand:   "4",
+				},
+				{
+					Operation: SubSelectOperation,
+					Operand:   "3",
+				},
+				{
+					Operation: RemoveOperation,
+					Operand:   "6",
+				},
+				{
+					Operation: RemoveOperation,
+					Operand:   "5",
+				},
+				{
+					Operation: AddOperation,
+					Operand:   "8",
+				},
+				{
+					Operation: AddOperation,
+					Operand:   "7",
+				},
+			},
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			s := tt.subject.Clone()
+			sort.Sort(s)
+			assert.Equal(t, tt.want, s)
+		})
+	}
+}