From 46ae774ce9fe98ab68c25d0910aa87436f2549e7 Mon Sep 17 00:00:00 2001 From: Christopher Phillips Date: Wed, 25 Oct 2023 11:08:24 -0400 Subject: [PATCH] fix: reorient name scheme around maven spec Signed-off-by: Christopher Phillips --- grype/version/constraint.go | 2 +- grype/version/format.go | 12 ++++----- grype/version/format_test.go | 6 ++--- ...java_constraint.go => maven_constraint.go} | 26 +++++++++---------- ...raint_test.go => maven_constraint_test.go} | 4 +-- .../{java_version.go => maven_version.go} | 16 ++++++------ ..._version_test.go => maven_version_test.go} | 6 ++--- grype/version/version.go | 8 +++--- 8 files changed, 40 insertions(+), 40 deletions(-) rename grype/version/{java_constraint.go => maven_constraint.go} (60%) rename grype/version/{java_constraint_test.go => maven_constraint_test.go} (97%) rename grype/version/{java_version.go => maven_version.go} (71%) rename grype/version/{java_version_test.go => maven_version_test.go} (80%) diff --git a/grype/version/constraint.go b/grype/version/constraint.go index d02406f50c6a..4e860730d47a 100644 --- a/grype/version/constraint.go +++ b/grype/version/constraint.go @@ -17,7 +17,7 @@ func GetConstraint(constStr string, format Format) (Constraint, error) { return newSemanticConstraint(constStr) case DebFormat: return newDebConstraint(constStr) - case JavaFormat: + case MavenFormat: return newJavaConstraint(constStr) case RpmFormat: return newRpmConstraint(constStr) diff --git a/grype/version/format.go b/grype/version/format.go index 16dce0d41fae..34506a55b365 100644 --- a/grype/version/format.go +++ b/grype/version/format.go @@ -11,7 +11,7 @@ const ( SemanticFormat ApkFormat DebFormat - JavaFormat + MavenFormat RpmFormat PythonFormat KBFormat @@ -26,7 +26,7 @@ var formatStr = []string{ "Semantic", "Apk", "Deb", - "Java", + "Maven", "RPM", "Python", "KB", @@ -38,7 +38,7 @@ var Formats = []Format{ SemanticFormat, ApkFormat, DebFormat, - JavaFormat, + MavenFormat, RpmFormat, PythonFormat, KBFormat, @@ -54,8 +54,8 @@ func ParseFormat(userStr string) Format { return ApkFormat case strings.ToLower(DebFormat.String()), "dpkg": return DebFormat - case strings.ToLower(JavaFormat.String()), "java": - return JavaFormat + case strings.ToLower(MavenFormat.String()), "maven": + return MavenFormat case strings.ToLower(RpmFormat.String()), "rpm": return RpmFormat case strings.ToLower(PythonFormat.String()), "python": @@ -78,7 +78,7 @@ func FormatFromPkgType(t pkg.Type) Format { case pkg.DebPkg: format = DebFormat case pkg.JavaPkg: - format = JavaFormat + format = MavenFormat case pkg.RpmPkg: format = RpmFormat case pkg.GemPkg: diff --git a/grype/version/format_test.go b/grype/version/format_test.go index bfa0b923a6f8..ecc5647ba643 100644 --- a/grype/version/format_test.go +++ b/grype/version/format_test.go @@ -17,8 +17,8 @@ func TestParseFormat(t *testing.T) { format: DebFormat, }, { - input: "java", - format: JavaFormat, + input: "maven", + format: MavenFormat, }, { input: "gem", @@ -60,7 +60,7 @@ func TestFormatFromPkgType(t *testing.T) { }, { pkgType: pkg.JavaPkg, - format: JavaFormat, + format: MavenFormat, }, { pkgType: pkg.GemPkg, diff --git a/grype/version/java_constraint.go b/grype/version/maven_constraint.go similarity index 60% rename from grype/version/java_constraint.go rename to grype/version/maven_constraint.go index b3e4a0dd4e09..4a1141b05b4e 100644 --- a/grype/version/java_constraint.go +++ b/grype/version/maven_constraint.go @@ -2,30 +2,30 @@ package version import "fmt" -type javaConstraint struct { +type mavenConstraint struct { raw string expression constraintExpression } -func newJavaConstraint(raw string) (javaConstraint, error) { +func newJavaConstraint(raw string) (mavenConstraint, error) { if raw == "" { // empty constraints are always satisfied - return javaConstraint{}, nil + return mavenConstraint{}, nil } constraints, err := newConstraintExpression(raw, newJavaComparator) if err != nil { - return javaConstraint{}, fmt.Errorf("unable to parse java constraint phrase: %w", err) + return mavenConstraint{}, fmt.Errorf("unable to parse java constraint phrase: %w", err) } - return javaConstraint{ + return mavenConstraint{ raw: raw, expression: constraints, }, nil } func newJavaComparator(unit constraintUnit) (Comparator, error) { - ver, err := newJavaVersion(unit.version) + ver, err := newMavenVersion(unit.version) if err != nil { return nil, fmt.Errorf("unable to parse constraint version (%s): %w", unit.version, err) } @@ -33,11 +33,11 @@ func newJavaComparator(unit constraintUnit) (Comparator, error) { return ver, nil } -func (c javaConstraint) supported(format Format) bool { - return format == JavaFormat +func (c mavenConstraint) supported(format Format) bool { + return format == MavenFormat } -func (c javaConstraint) Satisfied(version *Version) (satisfied bool, err error) { +func (c mavenConstraint) Satisfied(version *Version) (satisfied bool, err error) { if c.raw == "" && version != nil { // empty constraints are always satisfied return true, nil @@ -53,19 +53,19 @@ func (c javaConstraint) Satisfied(version *Version) (satisfied bool, err error) } if !c.supported(version.Format) { - return false, fmt.Errorf("(java) unsupported format: %s", version.Format) + return false, fmt.Errorf("(maven) unsupported format: %s", version.Format) } - if version.rich.javaVer == nil { + if version.rich.mavenVer == nil { return false, fmt.Errorf("no rich apk version given: %+v", version) } return c.expression.satisfied(version) } -func (c javaConstraint) String() string { +func (c mavenConstraint) String() string { if c.raw == "" { - return "none (java)" + return "none (maven)" } return fmt.Sprintf("%s (java)", c.raw) diff --git a/grype/version/java_constraint_test.go b/grype/version/maven_constraint_test.go similarity index 97% rename from grype/version/java_constraint_test.go rename to grype/version/maven_constraint_test.go index 0bfa61436f2b..98edb9de7494 100644 --- a/grype/version/java_constraint_test.go +++ b/grype/version/maven_constraint_test.go @@ -36,7 +36,7 @@ func TestVersionConstraintJava(t *testing.T) { constraint, err := newJavaConstraint(test.constraint) assert.NoError(t, err, "unexpected error from newJavaConstraint %s: %v", test.version, err) - test.assertVersionConstraint(t, JavaFormat, constraint) + test.assertVersionConstraint(t, MavenFormat, constraint) }) } @@ -98,7 +98,7 @@ func TestVersionEqualityJava(t *testing.T) { constraint, err := newJavaConstraint(test.constraint) assert.NoError(t, err, "unexpected error from newJavaConstraint %s: %v", test.version, err) - test.assertVersionConstraint(t, JavaFormat, constraint) + test.assertVersionConstraint(t, MavenFormat, constraint) }) } } diff --git a/grype/version/java_version.go b/grype/version/maven_version.go similarity index 71% rename from grype/version/java_version.go rename to grype/version/maven_version.go index 86f1382c6e31..29f1eb0759fc 100644 --- a/grype/version/java_version.go +++ b/grype/version/maven_version.go @@ -6,18 +6,18 @@ import ( mvnv "github.com/masahiro331/go-mvn-version" ) -type javaVersion struct { +type mavenVersion struct { raw string version mvnv.Version } -func newJavaVersion(raw string) (*javaVersion, error) { +func newMavenVersion(raw string) (*mavenVersion, error) { ver, err := mvnv.NewVersion(raw) if err != nil { return nil, fmt.Errorf("could not generate new java version from: %s; %w", raw, err) } - return &javaVersion{ + return &mavenVersion{ raw: raw, version: ver, }, nil @@ -25,15 +25,15 @@ func newJavaVersion(raw string) (*javaVersion, error) { // Compare returns 0 if j2 == j, 1 if j2 > j, and -1 if j2 < j. // If an error returns the int value is -1 -func (j *javaVersion) Compare(j2 *Version) (int, error) { - if j2.Format != JavaFormat { +func (j *mavenVersion) Compare(j2 *Version) (int, error) { + if j2.Format != MavenFormat { return -1, fmt.Errorf("unable to compare java to given format: %s", j2.Format) } - if j2.rich.javaVer == nil { - return -1, fmt.Errorf("given empty javaVersion object") + if j2.rich.mavenVer == nil { + return -1, fmt.Errorf("given empty mavenVersion object") } - submittedVersion := j2.rich.javaVer.version + submittedVersion := j2.rich.mavenVer.version if submittedVersion.Equal(j.version) { return 0, nil } diff --git a/grype/version/java_version_test.go b/grype/version/maven_version_test.go similarity index 80% rename from grype/version/java_version_test.go rename to grype/version/maven_version_test.go index c5a07ff15abc..4b5143d74983 100644 --- a/grype/version/java_version_test.go +++ b/grype/version/maven_version_test.go @@ -35,13 +35,13 @@ func Test_javaVersion_Compare(t *testing.T) { } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { - j, err := NewVersion(tt.name, JavaFormat) + j, err := NewVersion(tt.name, MavenFormat) assert.NoError(t, err) - j2, err := NewVersion(tt.compare, JavaFormat) + j2, err := NewVersion(tt.compare, MavenFormat) assert.NoError(t, err) - if got, _ := j2.rich.javaVer.Compare(j); got != tt.want { + if got, _ := j2.rich.mavenVer.Compare(j); got != tt.want { t.Errorf("Compare() = %v, want %v", got, tt.want) } }) diff --git a/grype/version/version.go b/grype/version/version.go index 2ecbf59ebd9c..4f9f7cf394cf 100644 --- a/grype/version/version.go +++ b/grype/version/version.go @@ -18,7 +18,7 @@ type rich struct { semVer *semanticVersion apkVer *apkVersion debVer *debVersion - javaVer *javaVersion + mavenVer *mavenVersion rpmVer *rpmVersion kbVer *kbVersion portVer *portageVersion @@ -63,9 +63,9 @@ func (v *Version) populate() error { ver, err := newDebVersion(v.Raw) v.rich.debVer = ver return err - case JavaFormat: - ver, err := newJavaVersion(v.Raw) - v.rich.javaVer = ver + case MavenFormat: + ver, err := newMavenVersion(v.Raw) + v.rich.mavenVer = ver return err case RpmFormat: ver, err := newRpmVersion(v.Raw)