Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/main' into issue-226
Browse files Browse the repository at this point in the history
  • Loading branch information
@davidcollom
davidcollom committed Jul 9, 2024
2 parents 3c86afe + c2a0128 commit 39fa8e9
Show file tree
Hide file tree
Showing 2 changed files with 279 additions and 1 deletion.
5 changes: 4 additions & 1 deletion pkg/version/version.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,6 @@ func (v *Version) Fetch(ctx context.Context, imageURL string, _ *api.Options) (i
// latestSemver will return the latest ImageTag based on the given options
// restriction, using semver. This should not be used is UseSHA has been
// enabled.
// TODO: add tests..
func latestSemver(opts *api.Options, tags []api.ImageTag) (*api.ImageTag, error) {
var (
latestImageTag *api.ImageTag
Expand Down Expand Up @@ -153,6 +152,10 @@ func latestSemver(opts *api.Options, tags []api.ImageTag) (*api.ImageTag, error)
}
}

if latestImageTag == nil {
return nil, fmt.Errorf("no suitable version found")
}

return latestImageTag, nil
}

Expand Down
275 changes: 275 additions & 0 deletions pkg/version/version_test.go
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,275 @@
package version

import (
"regexp"
"testing"
"time"

"github.com/jetstack/version-checker/pkg/api"

"github.com/stretchr/testify/assert"
)

// Helper function to parse time
func parseTime(t string) time.Time {
parsedTime, _ := time.Parse(time.RFC3339, t)
return parsedTime
}

func TestLatestSemver(t *testing.T) {
// Ideal Set of Tags
tags := []api.ImageTag{
{Tag: "v1.0.0", Timestamp: parseTime("2023-06-01T00:00:00Z")},
{Tag: "v1.1.0", Timestamp: parseTime("2023-06-02T00:00:00Z")},
{Tag: "v1.1.1-alpha", Timestamp: parseTime("2023-06-03T00:00:00Z")},
{Tag: "v1.1.1", Timestamp: parseTime("2023-06-04T00:00:00Z")},
{Tag: "v2.0.0", Timestamp: parseTime("2023-06-05T00:00:00Z")},
}
tagsNoPrefix := []api.ImageTag{
{Tag: "1.0.0", Timestamp: parseTime("2023-06-01T00:00:00Z")},
{Tag: "1.1.0", Timestamp: parseTime("2023-06-02T00:00:00Z")},
{Tag: "1.1.1-alpha", Timestamp: parseTime("2023-06-03T00:00:00Z")},
{Tag: "1.1.1", Timestamp: parseTime("2023-06-04T00:00:00Z")},
{Tag: "2.0.0", Timestamp: parseTime("2023-06-05T00:00:00Z")},
}
// Include More Alpha/Beta/RC
alphaBetaTags := []api.ImageTag{
{Tag: "v1.0.0", Timestamp: parseTime("2023-06-01T00:00:00Z")},
{Tag: "v1.1.0", Timestamp: parseTime("2023-06-02T00:00:00Z")},
{Tag: "v1.1.1-alpha", Timestamp: parseTime("2023-06-03T00:00:00Z")},
{Tag: "v1.1.1", Timestamp: parseTime("2023-06-04T00:00:00Z")},
{Tag: "v2.0.0-alpha", Timestamp: parseTime("2023-06-05T00:00:00Z")},
{Tag: "v2.0.0-beta", Timestamp: parseTime("2023-06-05T00:00:00Z")},
{Tag: "v2.0.0-rc1", Timestamp: parseTime("2023-06-05T00:00:00Z")},
{Tag: "v2.0.0-rc2", Timestamp: parseTime("2023-06-05T00:00:00Z")},
}
// Images that are all numerical
nonSemVer := []api.ImageTag{
{Tag: "20230601", Timestamp: parseTime("2023-06-01T00:00:00Z")},
{Tag: "20230602", Timestamp: parseTime("2023-06-02T00:00:00Z")},
{Tag: "20230603", Timestamp: parseTime("2023-06-03T00:00:00Z")},
{Tag: "20230604", Timestamp: parseTime("2023-06-04T00:00:00Z")},
{Tag: "20230605", Timestamp: parseTime("2023-06-05T00:00:00Z")},
}
// This is to simulate an image that USED to SemVer but stopped
stoppedSemVer := []api.ImageTag{
{Tag: "v1.0.0", Timestamp: parseTime("2023-06-01T00:00:00Z")},
{Tag: "v1.1.0", Timestamp: parseTime("2023-06-02T00:00:00Z")},
{Tag: "202306030", Timestamp: parseTime("2023-06-03T00:00:00Z")},
{Tag: "202306031", Timestamp: parseTime("2023-06-03T00:00:00Z")},
{Tag: "202306040", Timestamp: parseTime("2023-06-04T00:00:00Z")},
{Tag: "202306050", Timestamp: parseTime("2023-06-05T00:00:00Z")},
{Tag: "202306060", Timestamp: parseTime("2023-06-06T00:00:00Z")},
}
// This is to simulate an image that USED to SemVer but stopped
startedSemVer := []api.ImageTag{
{Tag: "20230603", Timestamp: parseTime("2023-06-03T00:00:00Z")},
{Tag: "202306031", Timestamp: parseTime("2023-06-03T00:00:00Z")},
{Tag: "20230604", Timestamp: parseTime("2023-06-04T00:00:00Z")},
{Tag: "20230605", Timestamp: parseTime("2023-06-05T00:00:00Z")},
{Tag: "20230606", Timestamp: parseTime("2023-06-06T00:00:00Z")},
{Tag: "v1.0.0", Timestamp: parseTime("2023-06-09T00:00:00Z")},
{Tag: "v1.1.0", Timestamp: parseTime("2023-06-10T00:00:00Z")},
}
// Mixed Numerical and SemVer along with Older images pushed more recently
badTags := []api.ImageTag{
{Tag: "v1.0.0", Timestamp: parseTime("2023-06-01T00:00:00Z")},
{Tag: "v1.1.0", Timestamp: parseTime("2023-06-02T00:00:00Z")},
{Tag: "9999999", Timestamp: parseTime("2023-06-03T00:00:00Z")},
{Tag: "v1.1.1-alpha", Timestamp: parseTime("2023-06-03T00:00:00Z")},
{Tag: "v1.1.1", Timestamp: parseTime("2023-06-04T00:00:00Z")},
{Tag: "v2.0.0", Timestamp: parseTime("2023-06-05T00:00:00Z")},
{Tag: "v1.1.1", Timestamp: parseTime("2023-06-06T00:00:00Z")},
}

tests := []struct {
name string
opts *api.Options
expected string
tags []api.ImageTag
}{
{
name: "No constraints",
opts: &api.Options{},
expected: "v2.0.0",
},
{
name: "Regex match v1.*",
opts: &api.Options{
RegexMatcher: regexp.MustCompile("v1.*"),
},
expected: "v1.1.1",
},
{
name: "Pin major version 1",
opts: &api.Options{
PinMajor: intPtr(1),
},
expected: "v1.1.1",
},
{
name: "Pin minor version 1.1",
opts: &api.Options{
PinMajor: intPtr(1),
PinMinor: intPtr(1),
},
expected: "v1.1.1",
},
{
name: "Pin patch version 1.1.1",
opts: &api.Options{
PinMajor: intPtr(1),
PinMinor: intPtr(1),
PinPatch: intPtr(1),
},
expected: "v1.1.1",
},
{
name: "Exclude metadata",
opts: &api.Options{
UseMetaData: false,
},
expected: "v2.0.0",
},
{
name: "Include metadata",
opts: &api.Options{
UseMetaData: true,
},
expected: "v2.0.0",
},
{
name: "NoPrefixed Tags",
opts: &api.Options{},
tags: tagsNoPrefix,
expected: "2.0.0",
},
// Some Bad/Miss-behaving tags
{
name: "Bad Tags",
opts: &api.Options{
RegexMatcher: regexp.MustCompile(`^v(\d+)(\.\d+)?(\.\d+)?(.*)$`),
},
tags: badTags,
expected: "v2.0.0",
},
// None SemVer tags
{
name: "Non SemVer",
opts: &api.Options{
RegexMatcher: regexp.MustCompile(`^(\d+)`),
},
tags: nonSemVer,
expected: "20230605",
},
{
name: "Stopped SemVer",
opts: &api.Options{
RegexMatcher: regexp.MustCompile(`^(\d+)`),
},
tags: stoppedSemVer,
expected: "202306060",
},
{
name: "Started SemVer",
opts: &api.Options{
RegexMatcher: regexp.MustCompile(`^v(\d+)(\.\d+)?(\.\d+)?(.*)$`),
},
tags: startedSemVer,
expected: "v1.1.0",
},
{
name: "Alpha/Beta SemVer",
opts: &api.Options{
UseMetaData: true,
},
tags: alphaBetaTags,
expected: "v1.1.1",
},
}

for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
if len(tt.tags) > 0 {
tags = tt.tags
}
tag, err := latestSemver(tt.opts, tags)
assert.NoError(t, err)
assert.NotNil(t, tag)
assert.Equal(t, tt.expected, tag.Tag)
})
}
}

func TestLatestSHA(t *testing.T) {
tests := []struct {
name string
tags []api.ImageTag
expectedSHA *string
}{
{
name: "Single tag",
tags: []api.ImageTag{
{SHA: "sha1", Timestamp: time.Date(2022, time.January, 1, 0, 0, 0, 0, time.UTC)},
},
expectedSHA: strPtr("sha1"),
},
{
name: "Multiple tags, latest in the middle",
tags: []api.ImageTag{
{SHA: "sha1", Timestamp: time.Date(2022, time.January, 1, 0, 0, 0, 0, time.UTC)},
{SHA: "sha2", Timestamp: time.Date(2023, time.January, 1, 0, 0, 0, 0, time.UTC)},
{SHA: "sha3", Timestamp: time.Date(2021, time.January, 1, 0, 0, 0, 0, time.UTC)},
},
expectedSHA: strPtr("sha2"),
},
{
name: "Multiple tags, latest at the end",
tags: []api.ImageTag{
{SHA: "sha1", Timestamp: time.Date(2021, time.January, 1, 0, 0, 0, 0, time.UTC)},
{SHA: "sha2", Timestamp: time.Date(2022, time.January, 1, 0, 0, 0, 0, time.UTC)},
{SHA: "sha3", Timestamp: time.Date(2023, time.January, 1, 0, 0, 0, 0, time.UTC)},
},
expectedSHA: strPtr("sha3"),
},
{
name: "No tags",
tags: []api.ImageTag{},
expectedSHA: nil,
},
{
name: "All tags with the same timestamp",
tags: []api.ImageTag{
{SHA: "sha1", Timestamp: time.Date(2022, time.January, 1, 0, 0, 0, 0, time.UTC)},
{SHA: "sha2", Timestamp: time.Date(2022, time.January, 1, 0, 0, 0, 0, time.UTC)},
{SHA: "sha3", Timestamp: time.Date(2022, time.January, 1, 0, 0, 0, 0, time.UTC)},
},
expectedSHA: strPtr("sha1"),
},
}

for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got, err := latestSHA(tt.tags)
if err != nil {
t.Errorf("latestSHA() error = %v", err)
return
}
if (got == nil && tt.expectedSHA != nil) || (got != nil && tt.expectedSHA == nil) {
t.Errorf("latestSHA() = %v, want %v", got, tt.expectedSHA)
return
}
if got != nil && got.SHA != *tt.expectedSHA {
t.Errorf("latestSHA() = %v, want %v", got.SHA, *tt.expectedSHA)
}
})
}
}

func intPtr(i int64) *int64 {
return &i
}

func strPtr(s string) *string {
return &s
}

0 comments on commit 39fa8e9

Please sign in to comment.