test(lockfile): add invariant — LocationRole must be set when BlockLocation is valid

pkg/lockfile/location_role_invariant_test.go

@@ -0,0 +1,67 @@
+package lockfile_test
+
+import (
+	"os"
+	"path/filepath"
+	"testing"
+
+	"github.com/DataDog/datadog-sbom-generator/internal/utility/fileposition"
+	"github.com/DataDog/datadog-sbom-generator/pkg/lockfile"
+	"github.com/DataDog/datadog-sbom-generator/pkg/lockfile/internal/testutil"
+	_ "github.com/DataDog/datadog-sbom-generator/pkg/lockfile/parsers" // Register all extractors
+)
+
+// TestLocationRoleSetWhenBlockLocationIsValid verifies that every extractor sets
+// LocationRole whenever it also sets a valid BlockLocation.
+//
+// This is an invariant that the reporter relies on: vulnerability_result.go uses
+// LocationRole to populate the "role" field in the emitted PackageLocation. If an
+// extractor populates BlockLocation but leaves LocationRole empty, the role will be
+// blank in the SBOM output even though the location is meaningful.
+//
+// The test walks pkg/lockfile/fixtures/, runs the registered extractor for each
+// fixture file, and fails if any returned PackageDetails has a valid BlockLocation
+// but an empty LocationRole.
+func TestLocationRoleSetWhenBlockLocationIsValid(t *testing.T) {
+	t.Parallel()
+
+	fixturesRoot := "fixtures"
+	context := testutil.GetTestContext()
+
+	err := filepath.WalkDir(fixturesRoot, func(path string, d os.DirEntry, err error) error {
+		if err != nil || d.IsDir() {
+			return err
+		}
+
+		extractor, _ := lockfile.FindExtractor(path, map[string]bool{})
+		if extractor == nil {
+			return nil
+		}
+
+		f, err := lockfile.OpenLocalDepFile(path)
+		if err != nil {
+			return nil // skip unreadable files
+		}
+		defer f.Close()
+
+		packages, err := extractor.Extract(f, context)
+		if err != nil {
+			return nil // skip files that fail to parse (invalid fixtures are intentional)
+		}
+
+		for _, pkg := range packages {
+			if fileposition.IsFilePositionExtractedSuccessfully(pkg.BlockLocation) && pkg.LocationRole == "" {
+				t.Errorf(
+					"extractor for %q returned package %s@%s with a valid BlockLocation but empty LocationRole",
+					path, pkg.Name, pkg.Version,
+				)
+			}
+		}
+
+		return nil
+	})
+
+	if err != nil {
+		t.Fatalf("error walking fixtures: %v", err)
+	}
+}