Add experimental cataloger capabilities command (#4317)

* add info command from generated capabilities Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * correct gentoo and arch ecosystems Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * rename os pkg types Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * better binary cataloger description Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * expose metadata and pacakge types in json Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * expose json schema types Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * add completeness tests for metadata types Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * latest generation Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * fix linting Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * improve testing a docs Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * fix tests and linting Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * restore goreleaser config Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * tweak diagram Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * fix pdm Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * chore: java binary data Signed-off-by: Keith Zantow <kzantow@gmail.com> * new capability descriptions for gguf and python Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * correct poetry lock integrity hash claim Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * fix compile error Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * fix: remove purl version from overrides Signed-off-by: Keith Zantow <kzantow@gmail.com> * fix lua deps ref Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * keep gguf as ai ecosystem Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * split packages.yaml to multiple files by go package Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * ensure tests do not use go test cache Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * sort json output for info command Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * docs: fix ocaml, php, and portage capabilities yaml Signed-off-by: Will Murphy <willmurphyscode@users.noreply.github.com> * chore: update erlang capabilities Signed-off-by: Keith Zantow <kzantow@gmail.com> * chore: update java capabilities Signed-off-by: Keith Zantow <kzantow@gmail.com> * chore: update javascript capabilities Signed-off-by: Keith Zantow <kzantow@gmail.com> * chore: update linux kernel capabilities Signed-off-by: Keith Zantow <kzantow@gmail.com> * remove missing tests Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * fix package.yaml references Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * revert license list change Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * check for drift in capability descriptions Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * regenerate capabilities Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * test cleanup Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * use fixture cache in static analysis Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * claim fixtures pre-req for cap generation Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * update documentation with correct regeneration procedure Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * chore: ruby-gemspec-cataloger finds no dependencies Signed-off-by: Will Murphy <willmurphyscode@users.noreply.github.com> * chore: fix python docs and config comment Signed-off-by: Will Murphy <willmurphyscode@users.noreply.github.com> * chore: commit re-generated java yaml Signed-off-by: Will Murphy <willmurphyscode@users.noreply.github.com> * add cataloger selection to caps command Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * re-generate cap yamls Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * fix tests for cataloger selection Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * fix cli test Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * add missing tests Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * fix linting Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * rename cmd to `cataloger info` Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * [wip] change capability description locations Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * [wip] continued Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * [wip] adjust for import cycles Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * correct docs Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * fix linting Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> --------- Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> Signed-off-by: Keith Zantow <kzantow@gmail.com> Signed-off-by: Will Murphy <willmurphyscode@users.noreply.github.com> Co-authored-by: Keith Zantow <kzantow@gmail.com> Co-authored-by: Will Murphy <willmurphyscode@users.noreply.github.com>
2026-11-01 23:16:30 +01:00 · 2025-12-22 19:34:10 +00:00
parent ae1a247f3d
commit b3c70da3ea
116 changed files with 17277 additions and 139 deletions
@@ -0,0 +1,148 @@
+package capabilities
+
+import (
+	"testing"
+
+	"github.com/google/go-cmp/cmp"
+	"github.com/stretchr/testify/require"
+	"gopkg.in/yaml.v3"
+)
+
+func TestConfigSchemaExtensions(t *testing.T) {
+	// create a document with configs and app-configs
+	doc := Document{
+		Configs: map[string]CatalogerConfigEntry{
+			"golang.CatalogerConfig": {
+				Fields: []CatalogerConfigFieldEntry{
+					{
+						Key:         "SearchLocalModCacheLicenses",
+						Description: "searchLocalModCacheLicenses enables searching for go package licenses in the local GOPATH mod cache.",
+						AppKey:      "golang.search-local-mod-cache-licenses",
+					},
+					{
+						Key:         "LocalModCacheDir",
+						Description: "localModCacheDir specifies the location of the local go module cache directory.",
+						AppKey:      "golang.local-mod-cache-dir",
+					},
+				},
+			},
+			"python.CatalogerConfig": {
+				Fields: []CatalogerConfigFieldEntry{
+					{
+						Key:         "GuessUnpinnedRequirements",
+						Description: "guessUnpinnedRequirements attempts to infer package versions from version constraints...",
+						AppKey:      "python.guess-unpinned-requirements",
+					},
+				},
+			},
+		},
+		ApplicationConfig: []ApplicationConfigField{
+			{
+				Key:          "golang.search-local-mod-cache-licenses",
+				Description:  "search for go package licences in the GOPATH of the system running Syft",
+				DefaultValue: false,
+			},
+			{
+				Key:          "python.guess-unpinned-requirements",
+				Description:  "attempt to guess what the version could be based on version requirements",
+				DefaultValue: false,
+			},
+		},
+		Catalogers: []CatalogerEntry{
+			{
+				Name:   "go-module-binary-cataloger",
+				Type:   "generic",
+				Config: "golang.CatalogerConfig",
+			},
+			{
+				Name:   "python-package-cataloger",
+				Type:   "generic",
+				Config: "python.CatalogerConfig",
+			},
+		},
+	}
+
+	// marshal to YAML
+	yamlData, err := yaml.Marshal(&doc)
+	require.NoError(t, err)
+
+	// verify YAML contains expected sections
+	yamlStr := string(yamlData)
+	require.Contains(t, yamlStr, "configs:")
+	require.Contains(t, yamlStr, "golang.CatalogerConfig:")
+	require.Contains(t, yamlStr, "SearchLocalModCacheLicenses")
+	require.Contains(t, yamlStr, "application:")
+	require.Contains(t, yamlStr, "golang.search-local-mod-cache-licenses")
+
+	// unmarshal back
+	var unmarshaled Document
+	err = yaml.Unmarshal(yamlData, &unmarshaled)
+	require.NoError(t, err)
+
+	// verify data integrity
+	if diff := cmp.Diff(doc, unmarshaled); diff != "" {
+		t.Errorf("document mismatch (-want +got):\n%s", diff)
+	}
+}
+
+func TestConfigSchemaOmitEmpty(t *testing.T) {
+	// create a document with no configs or app-configs
+	doc := Document{
+		Catalogers: []CatalogerEntry{
+			{
+				Name: "test-cataloger",
+				Type: "generic",
+			},
+		},
+	}
+
+	// marshal to YAML
+	yamlData, err := yaml.Marshal(&doc)
+	require.NoError(t, err)
+
+	// verify configs and application are omitted when empty
+	yamlStr := string(yamlData)
+	require.NotContains(t, yamlStr, "configs:")
+	require.NotContains(t, yamlStr, "application:")
+}
+
+func TestCatalogerConfigField(t *testing.T) {
+	// create a cataloger with config field
+	entry := CatalogerEntry{
+		Name:   "test-cataloger",
+		Type:   "generic",
+		Config: "test.CatalogerConfig",
+	}
+
+	// marshal to YAML
+	yamlData, err := yaml.Marshal(&entry)
+	require.NoError(t, err)
+
+	// verify config field is present
+	yamlStr := string(yamlData)
+	require.Contains(t, yamlStr, "config: test.CatalogerConfig")
+
+	// unmarshal back
+	var unmarshaled CatalogerEntry
+	err = yaml.Unmarshal(yamlData, &unmarshaled)
+	require.NoError(t, err)
+
+	// verify data integrity
+	require.Equal(t, entry.Config, unmarshaled.Config)
+}
+
+func TestCatalogerConfigFieldOmitEmpty(t *testing.T) {
+	// create a cataloger without config field
+	entry := CatalogerEntry{
+		Name: "test-cataloger",
+		Type: "generic",
+	}
+
+	// marshal to YAML
+	yamlData, err := yaml.Marshal(&entry)
+	require.NoError(t, err)
+
+	// verify config field is omitted when empty
+	yamlStr := string(yamlData)
+	require.NotContains(t, yamlStr, "config:")
+}