syft/internal/task/set_test.go
Alex Goodman b0ab75fd89
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>
2024-01-12 17:39:13 -05:00

154 lines
3.4 KiB
Go

package task
import (
"context"
"testing"
"github.com/stretchr/testify/assert"
"github.com/anchore/syft/internal/sbomsync"
"github.com/anchore/syft/syft/file"
)
var _ Task = (*mockTask)(nil)
type mockTask struct {
name string
}
func (m mockTask) Execute(_ context.Context, _ file.Resolver, _ sbomsync.Builder) error {
panic("implement me")
}
func (m mockTask) Name() string {
return m.name
}
func Test_set_Add(t *testing.T) {
tests := []struct {
name string
initialTasks []Task
newTasks []Task
expected []string
}{
{
name: "add unique tasks",
initialTasks: []Task{mockTask{"task2"}, mockTask{"task1"}},
newTasks: []Task{mockTask{"task3"}},
expected: []string{
"task2", // note order is honored
"task1",
"task3",
},
},
{
name: "add duplicate tasks",
initialTasks: []Task{mockTask{"task1"}, mockTask{"task2"}},
newTasks: []Task{mockTask{"task1"}},
expected: []string{
"task1",
"task2",
},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
s := newSet(tt.initialTasks...)
s.Add(tt.newTasks...)
got := s.Tasks()
var gotNames []string
for _, tsk := range got {
gotNames = append(gotNames, tsk.Name())
}
assert.Equal(t, tt.expected, gotNames)
})
}
}
func Test_set_Remove(t *testing.T) {
tests := []struct {
name string
initialTasks []Task
tasksToRemove []Task
expectedOrder []string
}{
{
name: "remove existing tasks",
initialTasks: []Task{mockTask{"task1"}, mockTask{"task2"}, mockTask{"task3"}},
tasksToRemove: []Task{mockTask{"task2"}},
expectedOrder: []string{"task1", "task3"},
},
{
name: "remove non-existing tasks",
initialTasks: []Task{mockTask{"task1"}, mockTask{"task2"}},
tasksToRemove: []Task{mockTask{"task3"}},
expectedOrder: []string{"task1", "task2"},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
s := newSet(tt.initialTasks...)
s.Remove(tt.tasksToRemove...)
assert.Equal(t, tt.expectedOrder, s.order)
})
}
}
func Test_set_Intersect(t *testing.T) {
tests := []struct {
name string
initialTasks []Task
intersectTasks []Task
expectedOrder []string
}{
{
name: "intersect with overlapping tasks",
initialTasks: []Task{mockTask{"task1"}, mockTask{"task2"}},
intersectTasks: []Task{mockTask{"task2"}, mockTask{"task3"}},
expectedOrder: []string{"task2"},
},
{
name: "intersect with non-overlapping tasks",
initialTasks: []Task{mockTask{"task1"}, mockTask{"task4"}},
intersectTasks: []Task{mockTask{"task2"}, mockTask{"task3"}},
expectedOrder: []string{},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
s := newSet(tt.initialTasks...)
s.Intersect(tt.intersectTasks...)
assert.Equal(t, tt.expectedOrder, s.order)
})
}
}
func Test_set_Tasks(t *testing.T) {
tests := []struct {
name string
initialTasks []Task
expectedTasks tasks
}{
{
name: "empty set",
initialTasks: []Task{},
expectedTasks: nil,
},
{
name: "get tasks from set",
initialTasks: []Task{mockTask{"task1"}, mockTask{"task2"}},
expectedTasks: []Task{mockTask{"task1"}, mockTask{"task2"}},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
s := newSet(tt.initialTasks...)
resultTasks := s.Tasks()
assert.Equal(t, tt.expectedTasks, resultTasks)
})
}
}