Skip to content

Commit

Permalink
refactor(cmd/update): pass clio.Id to func that check for version update
Browse files Browse the repository at this point in the history
  • Loading branch information
@hainenber
hainenber committed Sep 6, 2023
1 parent 2d1f75a commit 74a7ffd
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 17 deletions.
14 changes: 7 additions & 7 deletions cmd/syft/cli/commands/update.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ func applicationUpdateCheck(id clio.Identification, check *options.UpdateCheck)

func checkForApplicationUpdate(id clio.Identification) {
log.Debugf("checking if a new version of %s is available", id.Name)
isAvailable, newVersion, err := isUpdateAvailable(id.Version)
isAvailable, newVersion, err := isUpdateAvailable(id)
if err != nil {
// this should never stop the application
log.Errorf(err.Error())
Expand All @@ -59,18 +59,18 @@ func checkForApplicationUpdate(id clio.Identification) {
}

// isUpdateAvailable indicates if there is a newer application version available, and if so, what the new version is.
func isUpdateAvailable(version string) (bool, string, error) {
if !isProductionBuild(version) {
func isUpdateAvailable(id clio.Identification) (bool, string, error) {
if !isProductionBuild(id.Version) {
// don't allow for non-production builds to check for a version.
return false, "", nil
}

currentVersion, err := hashiVersion.NewVersion(version)
currentVersion, err := hashiVersion.NewVersion(id.Version)
if err != nil {
return false, "", fmt.Errorf("failed to parse current application version: %w", err)
}

latestVersion, err := fetchLatestApplicationVersion(currentVersion.String())
latestVersion, err := fetchLatestApplicationVersion(id)
if err != nil {
return false, "", err
}
Expand All @@ -89,12 +89,12 @@ func isProductionBuild(version string) bool {
return true
}

func fetchLatestApplicationVersion(currentVersion string) (*hashiVersion.Version, error) {
func fetchLatestApplicationVersion(id clio.Identification) (*hashiVersion.Version, error) {
req, err := http.NewRequest(http.MethodGet, latestAppVersionURL.host+latestAppVersionURL.path, nil)
if err != nil {
return nil, fmt.Errorf("failed to create request for latest version: %w", err)
}
req.Header.Add("User-Agent", fmt.Sprintf("%v %v", "Syft", currentVersion))
req.Header.Add("User-Agent", fmt.Sprintf("%v %v", id.Name, id.Version))

client := http.Client{}
resp, err := client.Do(req)
Expand Down
21 changes: 11 additions & 10 deletions cmd/syft/cli/commands/update_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import (
"net/http/httptest"
"testing"

"github.com/anchore/clio"
hashiVersion "github.com/anchore/go-version"
"github.com/anchore/syft/cmd/syft/internal"
)
Expand Down Expand Up @@ -106,7 +107,7 @@ func TestIsUpdateAvailable(t *testing.T) {
t.Run(test.name, func(t *testing.T) {
// setup mocks
// local...
version := test.buildVersion
id := clio.Identification{Name: "Syft", Version: test.buildVersion}
// remote...
handler := http.NewServeMux()
handler.HandleFunc(latestAppVersionURL.path, func(w http.ResponseWriter, r *http.Request) {
Expand All @@ -117,7 +118,7 @@ func TestIsUpdateAvailable(t *testing.T) {
latestAppVersionURL.host = mockSrv.URL
defer mockSrv.Close()

isAvailable, newVersion, err := isUpdateAvailable(version)
isAvailable, newVersion, err := isUpdateAvailable(id)
if err != nil && !test.err {
t.Fatalf("got error but expected none: %+v", err)
} else if err == nil && test.err {
Expand All @@ -142,15 +143,15 @@ func TestFetchLatestApplicationVersion(t *testing.T) {
response string
code int
err bool
currentVersion string
id clio.Identification
expected *hashiVersion.Version
expectedHeaders map[string]string
}{
{
name: "gocase",
response: "1.0.0",
code: 200,
currentVersion: "0.0.0",
id: clio.Identification{Name: "Syft", Version: "0.0.0"},
expected: hashiVersion.Must(hashiVersion.NewVersion("1.0.0")),
expectedHeaders: map[string]string{"User-Agent": "Syft 0.0.0"},
err: false,
Expand All @@ -159,7 +160,7 @@ func TestFetchLatestApplicationVersion(t *testing.T) {
name: "garbage",
response: "garbage",
code: 200,
currentVersion: "0.0.0",
id: clio.Identification{Name: "Syft", Version: "0.0.0"},
expected: nil,
expectedHeaders: nil,
err: true,
Expand All @@ -168,7 +169,7 @@ func TestFetchLatestApplicationVersion(t *testing.T) {
name: "http 500",
response: "1.0.0",
code: 500,
currentVersion: "0.0.0",
id: clio.Identification{Name: "Syft", Version: "0.0.0"},
expected: nil,
expectedHeaders: nil,
err: true,
Expand All @@ -177,7 +178,7 @@ func TestFetchLatestApplicationVersion(t *testing.T) {
name: "http 404",
response: "1.0.0",
code: 404,
currentVersion: "0.0.0",
id: clio.Identification{Name: "Syft", Version: "0.0.0"},
expected: nil,
expectedHeaders: nil,
err: true,
Expand All @@ -186,7 +187,7 @@ func TestFetchLatestApplicationVersion(t *testing.T) {
name: "empty",
response: "",
code: 200,
currentVersion: "0.0.0",
id: clio.Identification{Name: "Syft", Version: "0.0.0"},
expected: nil,
expectedHeaders: nil,
err: true,
Expand All @@ -195,7 +196,7 @@ func TestFetchLatestApplicationVersion(t *testing.T) {
name: "too long",
response: "this is really long this is really long this is really long this is really long this is really long this is really long this is really long this is really long ",
code: 200,
currentVersion: "0.0.0",
id: clio.Identification{Name: "Syft", Version: "0.0.0"},
expected: nil,
expectedHeaders: nil,
err: true,
Expand Down Expand Up @@ -223,7 +224,7 @@ func TestFetchLatestApplicationVersion(t *testing.T) {
latestAppVersionURL.host = mockSrv.URL
defer mockSrv.Close()

actual, err := fetchLatestApplicationVersion(test.currentVersion)
actual, err := fetchLatestApplicationVersion(test.id)
if err != nil && !test.err {
t.Fatalf("got error but expected none: %+v", err)
} else if err == nil && test.err {
Expand Down

0 comments on commit 74a7ffd

Please sign in to comment.