github.com/google/osv-scalibr@v0.4.1/guidedremediation/internal/manifest/python/requirements_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 python

import (
	"os"
	"path/filepath"
	"testing"

	"deps.dev/util/resolve"
	"github.com/google/go-cmp/cmp"
	"github.com/google/osv-scalibr/fs"
	"github.com/google/osv-scalibr/guidedremediation/internal/manifest"
	"github.com/google/osv-scalibr/guidedremediation/result"
)

func TestReadRequirements(t *testing.T) {
	fsys := fs.DirFS("./testdata/requirements")
	pypiRW, _ := GetRequirementsReadWriter()
	got, err := pypiRW.Read("requirements.txt", fsys)
	if err != nil {
		t.Fatalf("error reading manifest: %v", err)
	}
	want := testManifest{
		FilePath: "requirements.txt",
		Root: resolve.Version{
			VersionKey: resolve.VersionKey{
				PackageKey: resolve.PackageKey{
					System: resolve.PyPI,
					Name:   "myproject",
				},
				VersionType: resolve.Concrete,
				Version:     "1.0.0",
			},
		},
		System: resolve.PyPI,
		Requirements: []resolve.RequirementVersion{
			{
				VersionKey: resolve.VersionKey{
					PackageKey: resolve.PackageKey{
						System: resolve.PyPI,
						Name:   "pytest",
					},
					VersionType: resolve.Requirement,
				},
			},
			{
				VersionKey: resolve.VersionKey{
					PackageKey: resolve.PackageKey{
						System: resolve.PyPI,
						Name:   "pytest-cov",
					},
					VersionType: resolve.Requirement,
				},
			},
			{
				VersionKey: resolve.VersionKey{
					PackageKey: resolve.PackageKey{
						System: resolve.PyPI,
						Name:   "beautifulsoup4",
					},
					VersionType: resolve.Requirement,
				},
			},

			{
				VersionKey: resolve.VersionKey{
					PackageKey: resolve.PackageKey{
						System: resolve.PyPI,
						Name:   "docopt",
					},
					VersionType: resolve.Requirement,
					Version:     "== 0.6.1",
				},
			},
			{
				VersionKey: resolve.VersionKey{
					PackageKey: resolve.PackageKey{
						System: resolve.PyPI,
						Name:   "requests",
					},
					VersionType: resolve.Requirement,
					Version:     ">= 2.8.1, == 2.8.*",
				},
			},

			{
				VersionKey: resolve.VersionKey{
					PackageKey: resolve.PackageKey{
						System: resolve.PyPI,
						Name:   "keyring",
					},
					VersionType: resolve.Requirement,
					Version:     ">= 4.1.1",
				},
			},
			{
				VersionKey: resolve.VersionKey{
					PackageKey: resolve.PackageKey{
						System: resolve.PyPI,
						Name:   "coverage",
					},
					VersionType: resolve.Requirement,
					Version:     "!= 3.5",
				},
			},

			{
				VersionKey: resolve.VersionKey{
					PackageKey: resolve.PackageKey{
						System: resolve.PyPI,
						Name:   "Mopidy-Dirble",
					},
					VersionType: resolve.Requirement,
					Version:     "~=1.1",
				},
			},
		},
		Groups: map[manifest.RequirementKey][]string{},
	}
	checkManifest(t, "Manifest", got, want)
}

func TestWriteRequirements(t *testing.T) {
	rw, _ := GetRequirementsReadWriter()
	fsys := fs.DirFS("./testdata/requirements")
	manif, err := rw.Read("requirements.txt", fsys)
	if err != nil {
		t.Fatalf("error reading manifest: %v", err)
	}

	patches := []result.Patch{
		{
			PackageUpdates: []result.PackageUpdate{
				{
					Name:        "docopt",
					VersionFrom: "==0.6.1",
					VersionTo:   "==0.6.2",
				},
			},
		},
		{
			PackageUpdates: []result.PackageUpdate{
				{
					Name:        "requests",
					VersionFrom: ">=2.8.1,==2.8.*",
					VersionTo:   ">=2.32.4,<3.0.0",
				},
			},
		},
		{
			PackageUpdates: []result.PackageUpdate{
				{
					Name:        "mopidy-dirble",
					VersionFrom: "~=1.1",
					VersionTo:   ">=1.3.0,<2.0.0",
				},
			},
		},
	}
	outDir := t.TempDir()
	outFile := filepath.Join(outDir, "requirements.txt")

	if err := rw.Write(manif, fsys, patches, outFile); err != nil {
		t.Fatalf("failed to write requirements.txt: %v", err)
	}

	got, err := os.ReadFile(outFile)
	if err != nil {
		t.Fatalf("failed to read got requirements.txt: %v", err)
	}
	want, err := os.ReadFile(filepath.Join("./testdata/requirements", "want.requirements.txt"))
	if err != nil {
		t.Fatalf("failed to read want requirements.txt: %v", err)
	}
	if diff := cmp.Diff(want, got); diff != "" {
		t.Errorf("requirements.txt (-want +got):\n%s", diff)
	}
}