github.com/google/osv-scalibr@v0.4.1/annotator/osduplicate/dpkg/dpkg_test.go

// Copyright 2025 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package dpkg_test

import (
	"context"
	"runtime"
	"testing"

	"github.com/google/go-cmp/cmp"
	"github.com/google/go-cmp/cmp/cmpopts"
	"github.com/google/go-cpy/cpy"
	"github.com/google/osv-scalibr/annotator"
	"github.com/google/osv-scalibr/annotator/osduplicate/dpkg"
	"github.com/google/osv-scalibr/common/linux/dpkg/testing/dpkgutil"
	"github.com/google/osv-scalibr/extractor"
	scalibrfs "github.com/google/osv-scalibr/fs"
	"github.com/google/osv-scalibr/inventory"
	"github.com/google/osv-scalibr/inventory/vex"
	"google.golang.org/protobuf/proto"
)

func TestAnnotate(t *testing.T) {
	if runtime.GOOS != "linux" {
		t.Skipf("Test skipped, OS unsupported: %v", runtime.GOOS)
	}

	cancelledContext, cancel := context.WithCancel(t.Context())
	cancel()

	copier := cpy.New(
		cpy.Func(proto.Clone),
		cpy.IgnoreAllUnexported(),
	)

	tests := []struct {
		desc         string
		packages     []*extractor.Package
		infoContents map[string]string
		//nolint:containedctx
		ctx          context.Context
		wantErr      error
		wantPackages []*extractor.Package
	}{
		{
			desc:         "missing_info_dir",
			infoContents: nil,
		},
		{
			desc:         "empty_info_dir",
			infoContents: map[string]string{},
			packages: []*extractor.Package{
				{
					Name:      "file",
					Locations: []string{"path/to/file"},
				},
			},
			wantPackages: []*extractor.Package{
				{
					Name:      "file",
					Locations: []string{"path/to/file"},
				},
			},
		},
		{
			desc: "some_pkgs_found_in_info",
			infoContents: map[string]string{
				"some.list":       "/some/path\n/path/to/file-in-info\n/some/other/path",
				"some.other.list": "/some/other/path",
			},
			packages: []*extractor.Package{
				{
					Name:      "file-in-info",
					Locations: []string{"path/to/file-in-info"},
				},
				{
					Name:      "file-not-in-info",
					Locations: []string{"path/to/file-not-in-info"},
				},
			},
			wantPackages: []*extractor.Package{
				{
					Name:      "file-in-info",
					Locations: []string{"path/to/file-in-info"},
					ExploitabilitySignals: []*vex.PackageExploitabilitySignal{&vex.PackageExploitabilitySignal{
						Plugin:          dpkg.Name,
						Justification:   vex.ComponentNotPresent,
						MatchesAllVulns: true,
					}},
				},
				{
					Name:      "file-not-in-info",
					Locations: []string{"path/to/file-not-in-info"},
				},
			},
		},
		{
			desc: "pkg_found_in_file_with_wrong_extension",
			infoContents: map[string]string{
				"some.notlist": "/path/to/file",
			},
			packages: []*extractor.Package{
				{
					Name:      "file",
					Locations: []string{"path/to/file"},
				},
			},
			wantPackages: []*extractor.Package{
				{
					Name:      "file",
					Locations: []string{"path/to/file"},
					// No exploitability signals
				},
			},
		},
		{
			desc: "pkg_has_no_location",
			infoContents: map[string]string{
				"some.list": "/path/to/file",
			},
			packages:     []*extractor.Package{{Name: "file"}},
			wantPackages: []*extractor.Package{{Name: "file"}},
		},
		{
			desc: "ctx_cancelled",
			ctx:  cancelledContext,
			infoContents: map[string]string{
				"some.list": "/path/to/file",
			},
			packages: []*extractor.Package{
				{
					Name:      "file",
					Locations: []string{"path/to/file"},
				},
			},
			wantPackages: []*extractor.Package{
				{
					Name:      "file",
					Locations: []string{"path/to/file"},
					// No exploitability signals
				},
			},
			wantErr: cmpopts.AnyError,
		},
	}

	for _, tt := range tests {
		t.Run(tt.desc, func(t *testing.T) {
			var root string
			if tt.infoContents != nil {
				root = dpkgutil.SetupDPKGInfo(t, tt.infoContents, false)
			} else {
				root = t.TempDir()
			}
			if tt.ctx == nil {
				tt.ctx = t.Context()
			}
			input := &annotator.ScanInput{
				ScanRoot: scalibrfs.RealFSScanRoot(root),
			}
			// Deep copy the packages to avoid modifying the original inventory that is used in other tests.
			packages := copier.Copy(tt.packages).([]*extractor.Package)
			inv := &inventory.Inventory{Packages: packages}

			err := dpkg.New().Annotate(tt.ctx, input, inv)
			if !cmp.Equal(tt.wantErr, err, cmpopts.EquateErrors()) {
				t.Fatalf("Annotate(%v) error: %v, want %v", tt.packages, tt.wantErr, err)
			}

			want := &inventory.Inventory{Packages: tt.wantPackages}
			if diff := cmp.Diff(want, inv); diff != "" {
				t.Errorf("Annotate(%v): unexpected diff (-want +got): %v", tt.packages, diff)
			}
		})
	}
}