feat: have Version#CompareStr return (int, error)

Author: G-Rath

pkg/database/osv.go

@@ -100,19 +100,25 @@ func (ar AffectsRange) containsVersion(pkg internal.PackageDetails) bool {
 			return false
 		}
 
-		return semantic.MustParse(a.version(), pkg.CompareAs).CompareStr(b.version()) < 0
+		// Ignore errors as we assume the version is correct
+		order, _ := semantic.MustParse(a.version(), pkg.CompareAs).CompareStr(b.version())
+
+		return order < 0
 	})
 
 	var affected bool
 	for _, e := range ar.Events {
 		if affected {
 			if e.Fixed != "" {
-				affected = vp.CompareStr(e.Fixed) < 0
+				order, _ := vp.CompareStr(e.Fixed)
+				affected = order < 0
 			} else if e.LastAffected != "" {
-				affected = e.LastAffected == pkg.Version || vp.CompareStr(e.LastAffected) <= 0
+				order, _ := vp.CompareStr(e.LastAffected)
+				affected = e.LastAffected == pkg.Version || order <= 0
 			}
 		} else if e.Introduced != "" {
-			affected = e.Introduced == "0" || vp.CompareStr(e.Introduced) >= 0
+			order, _ := vp.CompareStr(e.Introduced)
+			affected = e.Introduced == "0" || order >= 0
 		}
 	}
 

pkg/semantic/compare_test.go

@@ -116,7 +116,15 @@ func expectCompareResult(
 
 	v := parseAsVersion(t, a, ecosystem)
 
-	if actualResult := v.CompareStr(b); actualResult != expectedResult {
+	actualResult, err := v.CompareStr(b)
+
+	if err != nil {
+		t.Errorf("failed to compare '%s' to '%s': %v", a, b, err)
+
+		return false
+	}
+
+	if actualResult != expectedResult {
 		t.Errorf(
 			"Expected %s to be %s %s, but it was %s",
 			a,

pkg/semantic/version-alpine.go

@@ -209,8 +209,8 @@ func (v AlpineVersion) Compare(w AlpineVersion) int {
 	return 0
 }
 
-func (v AlpineVersion) CompareStr(str string) int {
-	return v.Compare(parseAlpineVersion(str))
+func (v AlpineVersion) CompareStr(str string) (int, error) {
+	return v.Compare(parseAlpineVersion(str)), nil
 }
 
 // parseAlpineNumberComponents parses the given string into AlpineVersion.components

pkg/semantic/version-cran.go

@@ -34,8 +34,8 @@ func (v CRANVersion) Compare(w CRANVersion) int {
 	return -1
 }
 
-func (v CRANVersion) CompareStr(str string) int {
-	return v.Compare(parseCRANVersion(str))
+func (v CRANVersion) CompareStr(str string) (int, error) {
+	return v.Compare(parseCRANVersion(str)), nil
 }
 
 func parseCRANVersion(str string) CRANVersion {

pkg/semantic/version-debian.go

@@ -133,8 +133,8 @@ func (v DebianVersion) Compare(w DebianVersion) int {
 	return 0
 }
 
-func (v DebianVersion) CompareStr(str string) int {
-	return v.Compare(parseDebianVersion(str))
+func (v DebianVersion) CompareStr(str string) (int, error) {
+	return v.Compare(parseDebianVersion(str)), nil
 }
 
 func parseDebianVersion(str string) DebianVersion {

pkg/semantic/version-maven.go

@@ -313,8 +313,8 @@ func (mv MavenVersion) Compare(w MavenVersion) int {
 	return +1
 }
 
-func (mv MavenVersion) CompareStr(str string) int {
-	return mv.Compare(parseMavenVersion(str))
+func (mv MavenVersion) CompareStr(str string) (int, error) {
+	return mv.Compare(parseMavenVersion(str)), nil
 }
 
 func parseMavenVersion(str string) MavenVersion {

pkg/semantic/version-nuget.go

@@ -14,8 +14,8 @@ func (v NuGetVersion) Compare(w NuGetVersion) int {
 	return compareBuildComponents(strings.ToLower(v.Build), strings.ToLower(w.Build))
 }
 
-func (v NuGetVersion) CompareStr(str string) int {
-	return v.Compare(parseNuGetVersion(str))
+func (v NuGetVersion) CompareStr(str string) (int, error) {
+	return v.Compare(parseNuGetVersion(str)), nil
 }
 
 func parseNuGetVersion(str string) NuGetVersion {

pkg/semantic/version-packagist.go

@@ -120,6 +120,6 @@ func (v PackagistVersion) Compare(w PackagistVersion) int {
 	return comparePackagistComponents(v.Components, w.Components)
 }
 
-func (v PackagistVersion) CompareStr(str string) int {
-	return v.Compare(parsePackagistVersion(str))
+func (v PackagistVersion) CompareStr(str string) (int, error) {
+	return v.Compare(parsePackagistVersion(str)), nil
 }

pkg/semantic/version-pypi.go

@@ -366,6 +366,6 @@ func (pv PyPIVersion) Compare(pw PyPIVersion) int {
 	return pypiCompareVersion(pv, pw)
 }
 
-func (pv PyPIVersion) CompareStr(str string) int {
-	return pv.Compare(parsePyPIVersion(str))
+func (pv PyPIVersion) CompareStr(str string) (int, error) {
+	return pv.Compare(parsePyPIVersion(str)), nil
 }

pkg/semantic/version-redhat.go

@@ -174,20 +174,20 @@ func compareRedHatComponents(a, b string) int {
 	return 0
 }
 
-func (v RedHatVersion) CompareStr(str string) int {
+func (v RedHatVersion) CompareStr(str string) (int, error) {
 	w := parseRedHatVersion(str)
 
 	if diff := compareRedHatComponents(v.epoch, w.epoch); diff != 0 {
-		return diff
+		return diff, nil
 	}
 	if diff := compareRedHatComponents(v.version, w.version); diff != 0 {
-		return diff
+		return diff, nil
 	}
 	if diff := compareRedHatComponents(v.release, w.release); diff != 0 {
-		return diff
+		return diff, nil
 	}
 
-	return 0
+	return 0, nil
 }
 
 // parseRedHatVersion parses a Red Hat version into a RedHatVersion struct.