github.com/google/osv-scalibr@v0.4.1/guidedremediation/internal/strategy/relax/relaxer/npm_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 relaxer_test

import (
	"testing"

	"deps.dev/util/resolve"
	"github.com/google/osv-scalibr/guidedremediation/internal/strategy/relax/relaxer"
	"github.com/google/osv-scalibr/guidedremediation/upgrade"
)

func TestRelaxNpm(t *testing.T) {
	type result struct {
		version string
		ok      bool
	}
	tests := []struct {
		name          string
		versions      []string
		from          string
		upgradeConfig upgrade.Config
		want          result
	}{
		{
			name:          "pinned-to-patch",
			versions:      []string{"1.2.3", "1.2.4", "1.2.5", "1.3.0", "2.0.0"},
			from:          "1.2.3",
			upgradeConfig: upgrade.Config{"": upgrade.Minor},
			want: result{
				version: "~1.2.5",
				ok:      true,
			},
		},
		{
			name:          "patch-to-minor",
			versions:      []string{"1.2.3", "1.2.4", "1.3.0", "1.3.1", "2.0.0"},
			from:          "~1.2.3",
			upgradeConfig: upgrade.Config{"": upgrade.Minor},
			want: result{
				version: "^1.3.1",
				ok:      true,
			},
		},
		{
			name:          "minor-to-next-major",
			versions:      []string{"1.2.3", "1.3.4", "2.3.4", "2.4.5", "3.0.0"},
			from:          "^1.2.3",
			upgradeConfig: upgrade.Config{"": upgrade.Major},
			want: result{
				version: "^2.4.5",
				ok:      true,
			},
		},
		{
			name:          "skip-missing-major",
			versions:      []string{"1.0.0", "3.0.0", "4.0.0"},
			from:          "^1.0.0",
			upgradeConfig: upgrade.Config{"": upgrade.Major},
			want: result{
				version: "^3.0.0",
				ok:      true,
			},
		},
		{
			name:          "no-more-versions",
			versions:      []string{"1.2.3", "1.3.4", "1.4.5"},
			from:          "^1.2.3",
			upgradeConfig: upgrade.Config{"": upgrade.Major},
			want: result{
				version: "^1.2.3",
				ok:      false,
			},
		},
		{
			name:          "avoid-prerelease-patch",
			versions:      []string{"1.2.3", "1.2.4", "1.2.5-alpha"},
			from:          "1.2.3",
			upgradeConfig: upgrade.Config{"": upgrade.Minor},
			want: result{
				version: "~1.2.4",
				ok:      true,
			},
		},
		{
			name:          "avoid-prerelease-minor",
			versions:      []string{"1.2.3", "1.3.4", "1.4.5-alpha"},
			from:          "~1.2.3",
			upgradeConfig: upgrade.Config{"": upgrade.Major},
			want: result{
				version: "^1.3.4",
				ok:      true,
			},
		},
		{
			name:          "skip-prerelease",
			versions:      []string{"1.2.3", "2.0.0-alpha", "2.0.0", "3.0.0"},
			from:          "^1.0.0",
			upgradeConfig: upgrade.Config{"": upgrade.Major},
			want: result{
				version: "^2.0.0",
				ok:      true,
			},
		},
		{
			name:          "choose-final-prerelease",
			versions:      []string{"1.2.3", "2.0.0-alpha.0", "2.0.0-alpha.1", "2.0.0-beta"},
			from:          "^1.0.0",
			upgradeConfig: upgrade.Config{"": upgrade.Major},
			want: result{
				version: "^2.0.0-beta",
				ok:      true,
			},
		},
		{
			name:          "from-prerelease",
			versions:      []string{"1.0.0-pre", "1.2.3", "2.0.0-pre", "2.3.4"},
			from:          "^1.0.0-pre",
			upgradeConfig: upgrade.Config{"": upgrade.Major},
			want: result{
				version: "^2.3.4",
				ok:      true,
			},
		},
		{
			name:          "disallow-major",
			versions:      []string{"1.2.3", "1.3.4", "2.3.4", "2.4.5", "3.0.0"},
			from:          "^1.2.3",
			upgradeConfig: upgrade.Config{"": upgrade.Minor},
			want: result{
				version: "^1.2.3",
				ok:      false,
			},
		},
		{
			name:          "disallow-major-pkg-only",
			versions:      []string{"1.2.3", "1.3.4", "2.3.4", "2.4.5", "3.0.0"},
			from:          "^1.2.3",
			upgradeConfig: upgrade.Config{"disallow-major-pkg-only": upgrade.Minor, "": upgrade.None},
			want: result{
				version: "^1.2.3",
				ok:      false,
			},
		},
		{
			name:          "disallow-pkg",
			versions:      []string{"1.2.3", "1.3.4", "2.3.4", "2.4.5", "3.0.0"},
			from:          "^1.2.3",
			upgradeConfig: upgrade.Config{"disallow-pkg": upgrade.None},
			want: result{
				version: "^1.2.3",
				ok:      false,
			},
		},
		{
			name:          "disallow-minor",
			versions:      []string{"1.2.3", "1.3.4", "2.3.4", "2.4.5", "3.0.0"},
			from:          "~1.2.3",
			upgradeConfig: upgrade.Config{"disallow-minor": upgrade.Patch},
			want: result{
				version: "~1.2.3",
				ok:      false,
			},
		},
	}

	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			cl := resolve.NewLocalClient()
			pk := resolve.PackageKey{
				Name:   tt.name,
				System: resolve.NPM,
			}
			for _, v := range tt.versions {
				cl.AddVersion(resolve.Version{
					VersionKey: resolve.VersionKey{
						PackageKey:  pk,
						Version:     v,
						VersionType: resolve.Concrete,
					},
				}, nil)
			}

			reqRelaxer := relaxer.NpmRelaxer{}
			got, ok := reqRelaxer.Relax(t.Context(), cl, resolve.RequirementVersion{
				VersionKey: resolve.VersionKey{
					PackageKey:  pk,
					VersionType: resolve.Requirement,
					Version:     tt.from,
				}}, tt.upgradeConfig)

			if got.Version != tt.want.version || ok != tt.want.ok {
				t.Errorf("Relax() = (%s, %v), want (%s, %v)", got.Version, ok, tt.want.version, tt.want.ok)
			}
		})
	}
}