add check for latest available version

Signed-off-by: Sid Kattoju <[email protected]>

Makefile

@@ -47,12 +47,12 @@ image-push:
 .PHONY: test
 test:
 	go test -v $$(go list ./... | grep -v e2e) \
-	-ldflags "-X github.com/redhat-openshift-ecosystem/openshift-preflight/version.commit=bar -X github.com/redhat-openshift-ecosystem/openshift-preflight/version.version=foo"
+	-ldflags "-X github.com/redhat-openshift-ecosystem/openshift-preflight/version.commit=foobar -X github.com/redhat-openshift-ecosystem/openshift-preflight/version.version=0.0.1"
 
 .PHONY: cover
 cover:
 	go test -v \
-	 -ldflags "-X github.com/redhat-openshift-ecosystem/openshift-preflight/version.commit=bar -X github.com/redhat-openshift-ecosystem/openshift-preflight/version.version=foo" \
+	 -ldflags "-X github.com/redhat-openshift-ecosystem/openshift-preflight/version.commit=foobar -X github.com/redhat-openshift-ecosystem/openshift-preflight/version.version=0.0.1" \
 	 $$(go list ./... | grep -v e2e) \
 	 -race \
 	 -cover -coverprofile=coverage.out

cmd/preflight/cmd/check_container.go

@@ -6,10 +6,20 @@ import (
 	"context"
 	"fmt"
 	"io"
+	"net/http"
 	"os"
 	"path/filepath"
 	rt "runtime"
 	"strings"
+	"time"
+
+	"github.com/go-logr/logr"
+	"github.com/google/go-containerregistry/pkg/crane"
+	"github.com/google/go-containerregistry/pkg/name"
+	"github.com/google/go-containerregistry/pkg/v1/remote"
+	"github.com/google/go-github/v57/github"
+	"github.com/spf13/cobra"
+	"github.com/spf13/pflag"
 
 	"github.com/redhat-openshift-ecosystem/openshift-preflight/artifacts"
 	"github.com/redhat-openshift-ecosystem/openshift-preflight/certification"
@@ -23,13 +33,6 @@ import (
 	"github.com/redhat-openshift-ecosystem/openshift-preflight/internal/runtime"
 	"github.com/redhat-openshift-ecosystem/openshift-preflight/internal/viper"
 	"github.com/redhat-openshift-ecosystem/openshift-preflight/version"
-
-	"github.com/go-logr/logr"
-	"github.com/google/go-containerregistry/pkg/crane"
-	"github.com/google/go-containerregistry/pkg/name"
-	"github.com/google/go-containerregistry/pkg/v1/remote"
-	"github.com/spf13/cobra"
-	"github.com/spf13/pflag"
 )
 
 var submit bool
@@ -45,7 +48,7 @@ func checkContainerCmd(runpreflight runPreflight) *cobra.Command {
 		Args:  checkContainerPositionalArgs,
 		// this fmt.Sprintf is in place to keep spacing consistent with cobras two spaces that's used in: Usage, Flags, etc
 		Example: fmt.Sprintf("  %s", "preflight check container quay.io/repo-name/container-name:version"),
-		PreRunE: validateCertificationProjectID,
+		PreRunE: validateConditions,
 		RunE: func(cmd *cobra.Command, args []string) error {
 			return checkContainerRunE(cmd, args, runpreflight)
 		},
@@ -88,6 +91,9 @@ func checkContainerCmd(runpreflight runPreflight) *cobra.Command {
 	flags.String("platform", rt.GOARCH, "Architecture of image to pull. Defaults to runtime platform.")
 	_ = viper.BindPFlag("platform", flags.Lookup("platform"))
 
+	flags.String("gh-auth-token", "", "A Github auth token can be specified to work around rate limits")
+	_ = viper.BindPFlag("gh-auth-token", flags.Lookup("gh-auth-token"))
+
 	return checkContainerCmd
 }
 
@@ -237,9 +243,16 @@ func checkContainerPositionalArgs(cmd *cobra.Command, args []string) error {
 	return nil
 }
 
+// validateConditions run all pre-run functions
+func validateConditions(cmd *cobra.Command, args []string) error {
+	err := validateCertificationProjectID()
+	checkForNewerReleaseVersion(cmd)
+	return err
+}
+
 // validateCertificationProjectID validates that the certification project id is in the proper format
 // and throws an error if the value provided is in a legacy format that is not usable to query pyxis
-func validateCertificationProjectID(cmd *cobra.Command, args []string) error {
+func validateCertificationProjectID() error {
 	viper := viper.Instance()
 	certificationProjectID := viper.GetString("certification_project_id")
 	// splitting the certification project id into parts. if there are more than 2 elements in the array,
@@ -257,6 +270,41 @@ func validateCertificationProjectID(cmd *cobra.Command, args []string) error {
 	return nil
 }
 
+// checkForNewerReleaseVersion checks if there is a newer release available
+func checkForNewerReleaseVersion(cmd *cobra.Command) {
+	logger, err := logr.FromContext(cmd.Context())
+	if err != nil {
+		fmt.Println("Unable to get logger from context", err)
+	}
+
+	// use an authenticated client of a token is provided
+	var client *github.Client
+	if cmd.Flag("gh-auth-token").Changed {
+		ghToken, err := cmd.Flags().GetString("gh-auth-token")
+		if err == nil && len(ghToken) > 0 {
+			client = github.NewClient(&http.Client{
+				// Timeout in 1s in case Github is slow to respond
+				Timeout: time.Second * 1,
+			}).WithAuthToken(ghToken)
+		} else {
+			logger.Error(err, "Unable use Github auth token", "got token", ghToken, "with length", len(ghToken))
+		}
+	} else {
+		client = github.NewClient(&http.Client{
+			// timeout in 1s in case Github is slow to respond
+			Timeout: time.Second * 1,
+		})
+	}
+	// check if a newer release is available
+	latestRelease, err := version.Version.LatestReleasedVersion(cmd, client.Repositories)
+	if err != nil {
+		logger.Info("Unable to determine if running the latest release", err)
+	}
+	if latestRelease != nil {
+		logger.Info("Found newer release", "New version", *latestRelease.TagName, "available at", *latestRelease.HTMLURL)
+	}
+}
+
 // generateContainerCheckOptions returns appropriate container.Options based on cfg.
 func generateContainerCheckOptions(cfg *runtime.Config) []container.Option {
 	o := []container.Option{

cmd/preflight/cmd/check_container_test.go

@@ -225,7 +225,7 @@ certification_project_id: mycertid`
 				DeferCleanup(viper.Instance().Set, "certification_project_id", "")
 			})
 			It("should not change the flag value", func() {
-				err := validateCertificationProjectID(checkContainerCmd(mockRunPreflightReturnNil), []string{"foo"})
+				err := validateCertificationProjectID()
 				Expect(err).ToNot(HaveOccurred())
 				Expect(viper.Instance().GetString("certification_project_id")).To(Equal("123456789"))
 			})
@@ -236,7 +236,7 @@ certification_project_id: mycertid`
 				DeferCleanup(viper.Instance().Set, "certification_project_id", "")
 			})
 			It("should strip ospid- from the flag value", func() {
-				err := validateCertificationProjectID(checkContainerCmd(mockRunPreflightReturnNil), []string{"foo"})
+				err := validateCertificationProjectID()
 				Expect(err).ToNot(HaveOccurred())
 				Expect(viper.Instance().GetString("certification_project_id")).To(Equal("123456789"))
 			})
@@ -247,7 +247,7 @@ certification_project_id: mycertid`
 				DeferCleanup(viper.Instance().Set, "certification_project_id", "")
 			})
 			It("should throw an error", func() {
-				err := validateCertificationProjectID(checkContainerCmd(mockRunPreflightReturnNil), []string{"foo"})
+				err := validateCertificationProjectID()
 				Expect(err).To(HaveOccurred())
 			})
 		})
@@ -257,7 +257,7 @@ certification_project_id: mycertid`
 				DeferCleanup(viper.Instance().Set, "certification_project_id", "")
 			})
 			It("should throw an error", func() {
-				err := validateCertificationProjectID(checkContainerCmd(mockRunPreflightReturnNil), []string{"foo"})
+				err := validateCertificationProjectID()
 				Expect(err).To(HaveOccurred())
 			})
 		})

go.mod

@@ -9,6 +9,8 @@ require (
 	github.com/glebarez/go-sqlite v1.21.2
 	github.com/go-logr/logr v1.2.4
 	github.com/google/go-containerregistry v0.15.2
+	github.com/google/go-github/v57 v57.0.0
+	github.com/hashicorp/go-version v1.2.1
 	github.com/knqyf263/go-rpmdb v0.0.0-20230517124904-b97c85e63254
 	github.com/onsi/ginkgo/v2 v2.12.1
 	github.com/onsi/gomega v1.28.0
@@ -81,7 +83,8 @@ require (
 	github.com/google/btree v1.0.1 // indirect
 	github.com/google/cel-go v0.15.3 // indirect
 	github.com/google/gnostic v0.5.7-v3refs // indirect
-	github.com/google/go-cmp v0.5.9 // indirect
+	github.com/google/go-cmp v0.6.0 // indirect
+	github.com/google/go-querystring v1.1.0 // indirect
 	github.com/google/gofuzz v1.2.0 // indirect
 	github.com/google/pprof v0.0.0-20221118152302-e6195bd50e26 // indirect
 	github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510 // indirect

go.sum

@@ -440,12 +440,16 @@ github.com/google/go-cmp v0.5.3/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/
 github.com/google/go-cmp v0.5.4/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
 github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
 github.com/google/go-cmp v0.5.6/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
-github.com/google/go-cmp v0.5.9 h1:O2Tfq5qg4qc4AmwVlvv0oLiVAGB7enBSJ2x2DqQFi38=
-github.com/google/go-cmp v0.5.9/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
+github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
+github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
 github.com/google/go-containerregistry v0.15.2 h1:MMkSh+tjSdnmJZO7ljvEqV1DjfekB6VUEAZgy3a+TQE=
 github.com/google/go-containerregistry v0.15.2/go.mod h1:wWK+LnOv4jXMM23IT/F1wdYftGWGr47Is8CG+pmHK1Q=
 github.com/google/go-github/v35 v35.0.1-0.20210421135231-b235769d1606/go.mod h1:s0515YVTI+IMrDoy9Y4pHt9ShGpzHvHO8rZ7L7acgvs=
+github.com/google/go-github/v57 v57.0.0 h1:L+Y3UPTY8ALM8x+TV0lg+IEBI+upibemtBD8Q9u7zHs=
+github.com/google/go-github/v57 v57.0.0/go.mod h1:s0omdnye0hvK/ecLvpsGfJMiRt85PimQh4oygmLIxHw=
 github.com/google/go-querystring v1.0.0/go.mod h1:odCYkC5MyYFN7vkCjXpyrEuKhc/BUO6wN/zVPAxq5ck=
+github.com/google/go-querystring v1.1.0 h1:AnCroh3fv4ZBgVIf1Iwtovgjaw/GiKJo8M8yD/fhyJ8=
+github.com/google/go-querystring v1.1.0/go.mod h1:Kcdr2DB4koayq7X8pmAG4sNG59So17icRSOU623lUBU=
 github.com/google/go-replayers/grpcreplay v1.0.0/go.mod h1:8Ig2Idjpr6gifRd6pNVggX6TC1Zw6Jx74AKp7QNH2QE=
 github.com/google/go-replayers/httpreplay v0.1.2/go.mod h1:YKZViNhiGgqdBlUbI2MwGpq4pXxNmhJLPHQ7cv2b5no=
 github.com/google/gofuzz v1.0.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg=
@@ -530,6 +534,7 @@ github.com/hashicorp/go-sockaddr v1.0.0/go.mod h1:7Xibr9yA9JjQq1JpNB2Vw7kxv8xerX
 github.com/hashicorp/go-syslog v1.0.0/go.mod h1:qPfqrKkXGihmCqbJM2mZgkZGvKG1dFdvsLplgctolz4=
 github.com/hashicorp/go-uuid v1.0.0/go.mod h1:6SBZvOh/SIDV7/2o3Jml5SYk/TvGqwFJ/bN7x4byOro=
 github.com/hashicorp/go-uuid v1.0.1/go.mod h1:6SBZvOh/SIDV7/2o3Jml5SYk/TvGqwFJ/bN7x4byOro=
+github.com/hashicorp/go-version v1.2.1 h1:zEfKbn2+PDgroKdiOzqiE8rsmLqU2uwi5PB5pBJ3TkI=
 github.com/hashicorp/go-version v1.2.1/go.mod h1:fltr4n8CU8Ke44wwGCBoEymUuxUHl09ZGVZPK5anwXA=
 github.com/hashicorp/go.net v0.0.1/go.mod h1:hjKkEWcCURg++eb33jQU7oqQcI9XDCnUzHA0oac0k90=
 github.com/hashicorp/golang-lru v0.5.0/go.mod h1:/m3WP610KZHVQ1SGc6re/UDhFvYD7pJ4Ao+sR/qLZy8=

version/version.go

@@ -2,7 +2,16 @@
 // describing the preflight project.
 package version
 
-import "fmt"
+import (
+	"context"
+	"fmt"
+	"strings"
+
+	"github.com/go-logr/logr"
+	"github.com/google/go-github/v57/github"
+	semvc "github.com/hashicorp/go-version"
+	"github.com/spf13/cobra"
+)
 
 var (
 	projectName = "github.com/redhat-openshift-ecosystem/openshift-preflight"
@@ -16,6 +25,10 @@ var Version = VersionContext{
 	Commit:  commit,
 }
 
+type VersionClient interface {
+	GetLatestRelease(ctx context.Context, owner string, repo string) (*github.RepositoryRelease, *github.Response, error)
+}
+
 type VersionContext struct {
 	Name    string `json:"name"`
 	Version string `json:"version"`
@@ -25,3 +38,33 @@ type VersionContext struct {
 func (vc *VersionContext) String() string {
 	return fmt.Sprintf("%s <commit: %s>", vc.Version, vc.Commit)
 }
+
+func (vc *VersionContext) LatestReleasedVersion(cmd *cobra.Command, svc VersionClient) (*github.RepositoryRelease, error) {
+	ctx := cmd.Context()
+	logger, err := logr.FromContext(ctx)
+	if err != nil {
+		fmt.Println("Unable to create logger from context", err)
+		return nil, err
+	}
+	projectTokens := strings.Split(vc.Name, "/")
+	owner := projectTokens[1]
+	repo := projectTokens[2]
+	// Fetch latest release from Github
+	latestRelease, resp, err := svc.GetLatestRelease(ctx, owner, repo)
+	if err != nil {
+		return nil, err
+	}
+	logger.Info("Github responded with", "rate limit", resp.Rate.String())
+	currentVersion, err := semvc.NewVersion(vc.Version)
+	if err != nil {
+		logger.Error(err, "Unable to determine current semver")
+	}
+	latestVersion, err := semvc.NewVersion(*latestRelease.TagName)
+	if err != nil {
+		logger.Error(err, "Unable to determine latest semver")
+	}
+	if !currentVersion.Equal(latestVersion) {
+		return latestRelease, nil
+	}
+	return nil, nil
+}

version/version_test.go

@@ -1,17 +1,26 @@
 package version
 
 import (
+	"context"
+	"errors"
 	"reflect"
 	"strings"
 
+	"github.com/bombsimon/logrusr/v4"
+	"github.com/go-logr/logr"
+	"github.com/google/go-github/v57/github"
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
+	"github.com/sirupsen/logrus"
+	"github.com/spf13/viper"
+
+	"github.com/spf13/cobra"
 )
 
 var _ = Describe("version package utility", func() {
 	// Values assumed to be passed when calling make test.
-	ldflagVersionOverride := "foo"
-	ldflagCommitOverride := "bar"
+	ldflagVersionOverride := "0.0.1"
+	ldflagCommitOverride := "foobar"
 
 	// These tests validate that we can override the version and commit information successfully,
 	// and that our string representation includes that information.
@@ -51,4 +60,90 @@ var _ = Describe("version package utility", func() {
 			Expect(keys).To(Equal(3))
 		})
 	})
+
+	// These tests validate that GetLatestReleasedVersion fetches the latest available github release
+	Context("When retrieving latest available release from Github", func() {
+		Context("When current version is older than the latest version", func() {
+			It("should return a version", func() {
+				client := &MockGhVersionClientNewer{}
+				release, err := Version.LatestReleasedVersion(mockCheckContainerCmd(), client)
+				Expect(err).To(BeNil())
+				Expect(release.TagName)
+				Expect(release.HTMLURL)
+			})
+		})
+		Context("When current version is newer than the latest version", func() {
+			It("should return nil", func() {
+				client := &MockGhVersionClientOlder{}
+				release, err := Version.LatestReleasedVersion(mockCheckContainerCmd(), client)
+				Expect(err).To(BeNil())
+				Expect(release).To(BeNil())
+			})
+		})
+		Context("When there is an error fetching the latest release from github", func() {
+			It("should return nil", func() {
+				client := &MockGhVersionClientError{}
+				release, err := Version.LatestReleasedVersion(mockCheckContainerCmd(), client)
+				Expect(err).To(Not(BeNil()))
+				Expect(release).To(BeNil())
+			})
+		})
+	})
 })
+
+func mockCheckContainerCmd() *cobra.Command {
+	mockCheckContainerCmd := cobra.Command{}
+	mockCheckContainerCmd.SetContext(context.Background())
+	logger := logrusr.New(logrus.New())
+	ctx := logr.NewContext(mockCheckContainerCmd.Context(), logger)
+	mockCheckContainerCmd.SetContext(ctx)
+	flags := mockCheckContainerCmd.Flags()
+	flags.String("gh-auth-token", "", "A Github auth token can be specified to work around rate limits")
+	_ = viper.BindPFlag("gh-auth-token", flags.Lookup("gh-auth-token"))
+	return &mockCheckContainerCmd
+}
+
+type MockGhVersionClientNewer struct{}
+
+type MockGhVersionClientOlder struct{}
+
+type MockGhVersionClientError struct{}
+
+func (mc *MockGhVersionClientNewer) GetLatestRelease(ctx context.Context, owner string, repo string) (*github.RepositoryRelease, *github.Response, error) {
+	tag := "0.0.2"
+	url := "test.com/release/0.0.2"
+
+	release := github.RepositoryRelease{
+		TagName: &tag,
+		HTMLURL: &url,
+	}
+	response := github.Response{
+		Rate: github.Rate{
+			Limit:     60,
+			Remaining: 59,
+		},
+	}
+
+	return &release, &response, nil
+}
+
+func (mc *MockGhVersionClientOlder) GetLatestRelease(ctx context.Context, owner string, repo string) (*github.RepositoryRelease, *github.Response, error) {
+	tag := "0.0.1"
+	url := "test.com/release/0.0.1"
+	release := github.RepositoryRelease{
+		TagName: &tag,
+		HTMLURL: &url,
+	}
+	response := github.Response{
+		Rate: github.Rate{
+			Limit:     60,
+			Remaining: 59,
+		},
+	}
+
+	return &release, &response, nil
+}
+
+func (mc *MockGhVersionClientError) GetLatestRelease(ctx context.Context, owner string, repo string) (*github.RepositoryRelease, *github.Response, error) {
+	return nil, nil, errors.New("unspecified Error")
+}