Added functionality to resolve SHA back to valid tags

Signed-off-by: Jahan Syed <[email protected]>

Author: jahan

pkg/api/types.go

@@ -19,6 +19,9 @@ const (
 	// as its tag.
 	UseSHAAnnotationKey = "use-sha.version-checker.io"
 
+	//ResolveSHAToTagsKey = "resolve-sha-to-tags.version-checker.io"
+	ResolveSHAToTagsKey = "resolve-sha-to-tags.version-checker.io"
+
 	// MatchRegexAnnotationKey will enforce that tags that are looked up must
 	// match this regex. UseMetaDataAnnotationKey is not required when this is
 	// set. All other options are ignored when this is set.
@@ -47,7 +50,8 @@ type Options struct {
 	// UseSHA cannot be used with any other options
 	UseSHA bool `json:"use-sha,omitempty"`
 
-	MatchRegex *string `json:"match-regex,omitempty"`
+	ResolveSHAToTags bool    `json:"resolve-sha-to-tags,omitempty"`
+	MatchRegex       *string `json:"match-regex,omitempty"`
 
 	// UseMetaData defines whether tags with '-alpha', '-debian.0' etc. is
 	// permissible.

pkg/controller/checker/checker.go

@@ -45,6 +45,18 @@ func (c *Checker) Container(ctx context.Context, log *logrus.Entry,
 	usingSHA := len(currentSHA) > 0
 	usingTag := len(currentTag) > 0
 
+	if opts.ResolveSHAToTags {
+		fmt.Println("Resolving SHA to Tags is required")
+		resolvedTag, err := c.search.ResolveSHAToTag(ctx, imageURL, currentSHA)
+
+		if len(resolvedTag) > 0 && err != nil {
+			fmt.Println("Successfully resolved tag")
+			currentTag = resolvedTag
+			usingSHA = false
+			usingTag = true	
+		}
+	}
+
 	// If using latest or no tag, then compare on SHA
 	if c.isLatestOrEmptyTag(currentTag) {
 		// Override options to use SHA
@@ -168,6 +180,11 @@ func (c *Checker) Search() search.Searcher {
 	return c.search
 }
 
+func (c *Checker) resolveTagFromSHA(url, sha string) (tag string) {
+
+	return "0.31.0"
+}
+
 // urlTagSHAFromImage from will return the image URL, and the semver version
 // and or SHA tag.
 func urlTagSHAFromImage(image string) (url, version, sha string) {

pkg/controller/options/options.go

@@ -35,6 +35,10 @@ func (b *Builder) Options(name string) (*api.Options, error) {
 		opts.UseSHA = true
 	}
 
+	if ResolveSHAToTags, ok := b.ans[b.index(name, api.ResolveSHAToTagsKey)]; ok && ResolveSHAToTags == "true" {
+		opts.ResolveSHAToTags = true
+	}
+
 	if useMetaData, ok := b.ans[b.index(name, api.UseMetaDataAnnotationKey)]; ok && useMetaData == "true" {
 		setNonSha = true
 		opts.UseMetaData = true
@@ -108,7 +112,7 @@ func (b *Builder) Options(name string) (*api.Options, error) {
 	}
 
 	if opts.UseSHA && setNonSha {
-		errs = append(errs, fmt.Sprintf("cannot define %q with any semver otions",
+		errs = append(errs, fmt.Sprintf("cannot define %q with any semver options",
 			b.index(name, api.UseSHAAnnotationKey)))
 	}
 

pkg/controller/options/options_test.go

@@ -60,7 +60,7 @@ func TestBuild(t *testing.T) {
 				api.UseSHAAnnotationKey + "/test-name":     "true",
 			},
 			expOptions: nil,
-			expErr:     `cannot define "use-sha.version-checker.io/test-name" with any semver otions`,
+			expErr:     `cannot define "use-sha.version-checker.io/test-name" with any semver options`,
 		},
 		"cannot use sha with non sha options (pins)": {
 			containerName: "test-name",
@@ -70,7 +70,7 @@ func TestBuild(t *testing.T) {
 				api.UseSHAAnnotationKey + "/test-name":   "true",
 			},
 			expOptions: nil,
-			expErr:     `cannot define "use-sha.version-checker.io/test-name" with any semver otions`,
+			expErr:     `cannot define "use-sha.version-checker.io/test-name" with any semver options`,
 		},
 		"output options for pins and add metadata": {
 			containerName: "test-name",
@@ -111,6 +111,16 @@ func TestBuild(t *testing.T) {
 			},
 			expErr: "",
 		},
+		"output options for resolve sha": {
+			containerName: "test-name",
+			annotations: map[string]string{
+				api.ResolveSHAToTagsKey + "/test-name": "true",
+			},
+			expOptions: &api.Options{
+				ResolveSHAToTags: true,
+			},
+			expErr: "",
+		},
 		"bool options that don't have 'true' and nothing": {
 			containerName: "test-name",
 			annotations: map[string]string{

pkg/controller/search/search.go

@@ -18,6 +18,7 @@ import (
 type Searcher interface {
 	Run(time.Duration)
 	LatestImage(context.Context, string, *api.Options) (*api.ImageTag, error)
+	ResolveSHAToTag(ctx context.Context, imageURL string, imageSHA string) (string, error)
 }
 
 // Search is the implementation for the searching and caching of image URLs.
@@ -66,6 +67,17 @@ func (s *Search) LatestImage(ctx context.Context, imageURL string, opts *api.Opt
 	return lastestImage.(*api.ImageTag), nil
 }
 
+func (s *Search) ResolveSHAToTag(ctx context.Context, imageURL string, imageSHA string) (string, error) {
+
+	tag, err := s.versionGetter.ResolveSHAToTag(ctx, imageURL, imageSHA)
+	if err != nil {
+		fmt.Println("failed to resolve the sha" + err.Error())
+		return "", fmt.Errorf("failed to resolve sha to tag")
+	}
+
+	return tag, err
+}
+
 // Run will run the search and image cache garbage collectors.
 func (s *Search) Run(refreshRate time.Duration) {
 	go s.versionGetter.Run(refreshRate)

pkg/version/version.go

@@ -84,6 +84,24 @@ func (v *Version) LatestTagFromImage(ctx context.Context, imageURL string, opts
 	return tag, err
 }
 
+//ResolveSHAToTag Resolve a SHA to a tag if possible
+func (v *Version) ResolveSHAToTag(ctx context.Context, imageURL string, imageSHA string) (string, error) {
+
+	tagsI, err := v.imageCache.Get(ctx, imageURL, imageURL, nil)
+	if err != nil {
+		return "", err
+	}
+	tags := tagsI.([]api.ImageTag)
+
+	for i := range tags {
+		if tags[i].SHA == imageSHA {
+			return tags[i].Tag, nil
+		}
+	}
+
+	return "", nil
+}
+
 // Fetch returns the given image tags for a given image URL.
 func (v *Version) Fetch(ctx context.Context, imageURL string, _ *api.Options) (interface{}, error) {
 	// fetch tags from image URL