[TT-1792] fix sorting by semantic versioning in ecrimagefetcher (#1244)

Author: Tofel

tools/ecrimagefetcher/.changeset/1.0.2.md

@@ -0,0 +1 @@
+Fixes how tags are sorted so that semnatinc versioning is respected.

tools/ecrimagefetcher/main.go

@@ -10,9 +10,9 @@ import (
 	"sort"
 	"strconv"
 	"strings"
+	"unicode"
 
 	"github.com/Masterminds/semver/v3"
-
 	"github.com/itchyny/gojq"
 )
 
@@ -22,6 +22,15 @@ func fetchImageDetails(repositoryName string) ([]byte, error) {
 	return cmd.Output()
 }
 
+func trimToVersion(s string) string {
+	for i, r := range s {
+		if unicode.IsDigit(r) || r == 'v' {
+			return s[i:]
+		}
+	}
+	return s
+}
+
 func parseImageTags(output []byte, grepString string, constraints *semver.Constraints) ([]string, error) {
 	var imageDetails []interface{}
 	if err := json.Unmarshal(output, &imageDetails); err != nil {
@@ -33,21 +42,25 @@ func parseImageTags(output []byte, grepString string, constraints *semver.Constr
 		return nil, fmt.Errorf("failed to parse gojq query: %w", err)
 	}
 
-	var tags []string
+	var tags semver.Collection
 	iter := query.Run(imageDetails)
 	for {
 		tag, ok := iter.Next()
 		if !ok {
 			break
 		}
 		if tagStr, ok := tag.(string); ok {
-			tags = append(tags, tagStr)
+			asVersion, err := semver.NewVersion(trimToVersion(tagStr))
+			if err != nil {
+				return nil, fmt.Errorf("failed to parse version: %w", err)
+			}
+			tags = append(tags, asVersion)
 		} else if err, ok := tag.(error); ok {
 			return nil, fmt.Errorf("failed to run gojq query: %w", err)
 		}
 	}
 
-	sort.Sort(sort.Reverse(sort.StringSlice(tags)))
+	sort.Sort(sort.Reverse(tags))
 
 	re, err := regexp.Compile(grepString)
 	if err != nil {
@@ -56,20 +69,16 @@ func parseImageTags(output []byte, grepString string, constraints *semver.Constr
 
 	var filteredTags []string
 	for _, tag := range tags {
-		if re.MatchString(tag) {
+		if re.MatchString(tag.Original()) {
 			ignore := false
 			if constraints != nil {
-				version, err := semver.NewVersion(tag)
-				if err != nil {
-					return nil, fmt.Errorf("failed to parse version: %w", err)
-				}
-				if !constraints.Check(version) {
+				if !constraints.Check(tag) {
 					ignore = true
 				}
 			}
 
 			if !ignore {
-				filteredTags = append(filteredTags, tag)
+				filteredTags = append(filteredTags, tag.Original())
 			}
 		}
 	}

tools/ecrimagefetcher/main_test.go

@@ -7,7 +7,6 @@ import (
 	"testing"
 
 	"github.com/Masterminds/semver/v3"
-
 	"github.com/stretchr/testify/require"
 )
 
@@ -17,14 +16,55 @@ func mockFetchImageDetailsSuccess(_ string) ([]byte, error) {
 			"imageTags": ["v1.0.0"]
 		},
 		{
-			"imageTags": ["v1.1.0"]
+			"imageTags": ["v1.1.2"]
+		},
+		{
+			"imageTags": ["v1.1.11"]
 		},
 		{
 			"imageTags": ["v1.2.0"]
 		}
 	]`), nil
 }
 
+func mockFetchImageMixedDetailsSuccess(_ string) ([]byte, error) {
+	return []byte(`[
+		{
+			"imageTags": ["alltools-0.0.1"]
+		},
+		{
+			"imageTags": ["1.0.0"]
+		},
+		{
+			"imageTags": ["0.5.0-alpha1"]
+		},
+		{
+			"imageTags": ["0.5.0-alpha2"]
+		},
+		{
+			"imageTags": ["1.0.0-alpha"]
+		},
+		{
+			"imageTags": ["1.0.0-alpha.1"]
+		},
+		{
+			"imageTags": ["1.0.0-alpha.2"]
+		},
+		{
+			"imageTags": ["1.0.0-beta"]
+		},
+		{
+			"imageTags": ["1.0.0-rc2"]
+		},
+		{
+			"imageTags": ["1.0.0-rc1"]
+		},
+		{
+			"imageTags": ["v1.1.2-alpha"]
+		}
+	]`), nil
+}
+
 func mockFetchImageDetailsError(_ string) ([]byte, error) {
 	return nil, fmt.Errorf("failed to describe images")
 }
@@ -33,7 +73,19 @@ func TestGetLatestImages(t *testing.T) {
 	t.Run("Success", func(t *testing.T) {
 		images, err := getLatestImages(mockFetchImageDetailsSuccess, "test-repo", "v1.*", 2, nil)
 		require.NoError(t, err)
-		require.Equal(t, "test-repo:v1.2.0,test-repo:v1.1.0", images)
+		require.Equal(t, "test-repo:v1.2.0,test-repo:v1.1.11", images)
+	})
+
+	t.Run("SuccessWithMixedVersionsWithoutFilter", func(t *testing.T) {
+		images, err := getLatestImages(mockFetchImageMixedDetailsSuccess, "test-repo", "", 11, nil)
+		require.NoError(t, err)
+		require.Equal(t, "test-repo:v1.1.2-alpha,test-repo:1.0.0,test-repo:1.0.0-rc2,test-repo:1.0.0-rc1,test-repo:1.0.0-beta,test-repo:1.0.0-alpha.2,test-repo:1.0.0-alpha.1,test-repo:1.0.0-alpha,test-repo:0.5.0-alpha2,test-repo:0.5.0-alpha1,test-repo:0.0.1", images)
+	})
+
+	t.Run("SuccessWithMixedVersionsWithFilter", func(t *testing.T) {
+		images, err := getLatestImages(mockFetchImageMixedDetailsSuccess, "test-repo", "^1.*", 4, nil)
+		require.NoError(t, err)
+		require.Equal(t, "test-repo:1.0.0,test-repo:1.0.0-rc2,test-repo:1.0.0-rc1,test-repo:1.0.0-beta", images)
 	})
 
 	t.Run("ErrorFetchingDetails", func(t *testing.T) {
@@ -51,15 +103,15 @@ func TestGetLatestImages(t *testing.T) {
 	t.Run("InsufficientTags", func(t *testing.T) {
 		images, err := getLatestImages(mockFetchImageDetailsSuccess, "test-repo", "v1.*", 5, nil)
 		require.NoError(t, err)
-		require.Equal(t, "test-repo:v1.2.0,test-repo:v1.1.0,test-repo:v1.0.0", images)
+		require.Equal(t, "test-repo:v1.2.0,test-repo:v1.1.11,test-repo:v1.1.2,test-repo:v1.0.0", images)
 	})
 
 	t.Run("WithConstraint", func(t *testing.T) {
 		constraints, err := semver.NewConstraint("<v1.2.0")
 		require.NoError(t, err)
 		images, err := getLatestImages(mockFetchImageDetailsSuccess, "test-repo", "v1.*", 2, constraints)
 		require.NoError(t, err)
-		require.Equal(t, "test-repo:v1.1.0,test-repo:v1.0.0", images)
+		require.Equal(t, "test-repo:v1.1.11,test-repo:v1.1.2", images)
 	})
 }
 

tools/ecrimagefetcher/package.json

@@ -1,5 +1,5 @@
 {
   "name": "ecrimagefetcher",
   "description": "Tool that fetches latest ECR images for a given repository",
-  "version": "1.0.1"
+  "version": "1.0.2"
 }