Merge branch 'main' into feat/better_logging

Author: everdrone

cmd/check_test.go

@@ -136,8 +136,8 @@ func TestCheckCmd(t *testing.T) {
 				t.Errorf("unexpected error: %v", err)
 			}
 
-			if c.Name() != "check" {
-				t.Errorf("got: '%s', want: 'check'", c.Name())
+			if c.Name() != CheckCmd.Name() {
+				t.Errorf("got: '%s', want: %s", c.Name(), CheckCmd.Name())
 			}
 			if !strings.Contains(got, tt.WantContains) {
 				t.Errorf("got: %s, does not contain: %s", got, tt.WantContains)

cmd/config_test.go

@@ -0,0 +1,26 @@
+package cmd
+
+import (
+	"strings"
+	"testing"
+
+	tu "github.com/everdrone/grab/testutils"
+)
+
+func TestConfigCmd(t *testing.T) {
+	t.Run("prints help message", func(tc *testing.T) {
+		c, got, err := tu.ExecuteCommand(RootCmd, "config")
+
+		if err != nil {
+			tc.Fatal(err)
+		}
+
+		if c.Name() != ConfigCmd.Name() {
+			tc.Fatalf("got: '%s', want: '%s'", c.Name(), ConfigCmd.Name())
+		}
+
+		if !strings.HasPrefix(got, ConfigCmd.Short) {
+			tc.Errorf("got: '%s', want: '%s'", got, ConfigCmd.Short)
+		}
+	})
+}

cmd/find_test.go

@@ -89,8 +89,8 @@ func TestFindCmd(t *testing.T) {
 				tc.Errorf("got: %v, want: %v", err, tt.HasErrors)
 			}
 
-			if c.Name() != "find" {
-				tc.Errorf("got: %s, want: 'find", c.Name())
+			if c.Name() != FindCmd.Name() {
+				tc.Errorf("got: %s, want: %s", c.Name(), FindCmd.Name())
 			}
 			if got != tt.Want {
 				tc.Errorf("got: %s, want: %s", got, tt.Want)

cmd/generate_test.go

@@ -58,8 +58,8 @@ func TestGenerate(t *testing.T) {
 				tc.Errorf("got: %v, want: %v", err, tt.HasErrors)
 			}
 
-			if c.Name() != "generate" {
-				tc.Errorf("got: %s, want: 'generate", c.Name())
+			if c.Name() != GenerateCmd.Name() {
+				tc.Errorf("got: %s, want: %s", c.Name(), GenerateCmd.Name())
 			}
 
 			if tt.CheckFile != "" {

cmd/get.go

@@ -1,8 +1,11 @@
 package cmd
 
 import (
+	"github.com/everdrone/grab/internal/config"
 	"github.com/everdrone/grab/internal/instance"
+	"github.com/everdrone/grab/internal/update"
 	"github.com/everdrone/grab/internal/utils"
+	"github.com/fatih/color"
 	"github.com/rs/zerolog/log"
 
 	"github.com/spf13/cobra"
@@ -15,6 +18,12 @@ var GetCmd = &cobra.Command{
 	RunE: func(cmd *cobra.Command, args []string) error {
 		log.Logger = instance.DefaultLogger(cmd.OutOrStderr())
 
+		updateMessageChan := make(chan string)
+		go func() {
+			newVersion, _ := update.CheckForUpdates()
+			updateMessageChan <- newVersion
+		}()
+
 		g := instance.New(cmd)
 
 		g.ParseFlags()
@@ -46,6 +55,19 @@ var GetCmd = &cobra.Command{
 			return utils.ErrSilent
 		}
 
+		newVersion := <-updateMessageChan
+		if newVersion != "" {
+			// TODO: take in account possible package managers
+			// if for example we installed with homebrew, we should display a different message
+			cmd.Printf("\n\n%s %s → %s\n",
+				color.New(color.FgMagenta).Sprintf("A new release of %s is available:", config.Name),
+				config.Version,
+				// color.New(color.FgHiBlack).Sprint(config.Version),
+				color.New(color.FgCyan).Sprint(newVersion),
+			)
+			cmd.Printf("%s\n\n", "https://github.com/everdrone/grab/releases/latest")
+		}
+
 		return nil
 	},
 }

cmd/get_test.go

@@ -4,8 +4,10 @@ import (
 	"net/http/httptest"
 	"os"
 	"path/filepath"
+	"strings"
 	"testing"
 
+	"github.com/everdrone/grab/internal/config"
 	"github.com/everdrone/grab/internal/utils"
 	tu "github.com/everdrone/grab/testutils"
 )
@@ -31,12 +33,14 @@ func TestGetCmd(t *testing.T) {
 	defer ts.Close()
 
 	tests := []struct {
-		Name       string
-		Args       []string
-		Config     string
-		ConfigPath string
-		CheckFiles map[string]string
-		WantErr    bool
+		Name              string
+		Args              []string
+		Config            string
+		ConfigPath        string
+		CheckFiles        map[string]string
+		WantErr           bool
+		UseBadReleaseURL  bool
+		WantUpdateMessage bool
 	}{
 		{
 			Name: "invalid config",
@@ -116,7 +120,7 @@ site "example" {
 			WantErr:    true,
 		},
 		{
-			Name: "can download",
+			Name: "can download and get updates",
 			Args: []string{ts.URL + "/gallery/123/test", "-s"},
 			Config: `
 global {
@@ -138,11 +142,42 @@ site "example" {
 				filepath.Join(globalLocation, "example", "b.jpg"): "imageb",
 				filepath.Join(globalLocation, "example", "c.jpg"): "imagec",
 			},
-			ConfigPath: filepath.Join(root, "grab.hcl"),
-			WantErr:    false,
+			ConfigPath:        filepath.Join(root, "grab.hcl"),
+			WantErr:           false,
+			WantUpdateMessage: true,
+		},
+		{
+			Name: "can download without updates",
+			Args: []string{ts.URL + "/gallery/123/test", "-s"},
+			Config: `
+global {
+	location = "` + escapedGlobalLocation + `"
+}
+
+site "example" {
+	test = "http:\\/\\/127\\.0\\.0\\.1:\\d+"
+
+	asset "image" {
+		pattern = "<img src=\"([^\"]+/img/[^\"]+)"
+		capture = 1
+		find_all = true
+	}
+}
+`,
+			CheckFiles: map[string]string{
+				filepath.Join(globalLocation, "example", "a.jpg"): "imagea",
+				filepath.Join(globalLocation, "example", "b.jpg"): "imageb",
+				filepath.Join(globalLocation, "example", "c.jpg"): "imagec",
+			},
+			ConfigPath:        filepath.Join(root, "grab.hcl"),
+			WantErr:           false,
+			UseBadReleaseURL:  true,
+			WantUpdateMessage: false,
 		},
 	}
 
+	updateMsg := "\n\nA new release of grab is available: " + config.Version + " → 987.654.321\nhttps://github.com/everdrone/grab/releases/latest\n\n"
+
 	for _, tt := range tests {
 		t.Run(tt.Name, func(tc *testing.T) {
 			// reset fs
@@ -152,10 +187,16 @@ site "example" {
 			utils.AFS.MkdirAll(globalLocation, os.ModePerm)
 			utils.AFS.WriteFile(tt.ConfigPath, []byte(tt.Config), os.ModePerm)
 
-			c, _, _, err := tu.ExecuteCommandErr(RootCmd, append([]string{"get"}, tt.Args...)...)
+			// set releases url
+			config.LatestReleaseURL = ts.URL + "/releases"
+			if tt.UseBadReleaseURL {
+				config.LatestReleaseURL = ts.URL + "/bad_releases"
+			}
+
+			c, out, _, err := tu.ExecuteCommandErr(RootCmd, append([]string{"get"}, tt.Args...)...)
 
-			if c.Name() != "get" {
-				tc.Fatalf("got: %s, want: 'find", c.Name())
+			if c.Name() != GetCmd.Name() {
+				tc.Fatalf("got: %s, want: %s", c.Name(), GetCmd.Name())
 			}
 
 			if tt.CheckFiles != nil {
@@ -166,6 +207,16 @@ site "example" {
 				}
 			}
 
+			if tt.WantUpdateMessage {
+				if !strings.Contains(out, updateMsg) {
+					tc.Errorf("got: %s, want: %s", out, updateMsg)
+				}
+			} else {
+				if strings.Contains(out, updateMsg) {
+					tc.Errorf("got: %s, want: %s", out, updateMsg)
+				}
+			}
+
 			if (err != nil) != tt.WantErr {
 				tc.Errorf("got: %v, want: %v", err, tt.WantErr)
 			}

cmd/root_test.go

@@ -0,0 +1,26 @@
+package cmd
+
+import (
+	"strings"
+	"testing"
+
+	tu "github.com/everdrone/grab/testutils"
+)
+
+func TestRootCmd(t *testing.T) {
+	t.Run("prints help message", func(tc *testing.T) {
+		c, got, err := tu.ExecuteCommand(RootCmd, "")
+
+		if err != nil {
+			tc.Fatal(err)
+		}
+
+		if c.Name() != RootCmd.Name() {
+			tc.Fatalf("got: '%s', want: '%s'", c.Name(), RootCmd.Name())
+		}
+
+		if !strings.HasPrefix(got, RootCmd.Short) {
+			tc.Errorf("got: '%s', want: '%s'", got, RootCmd.Short)
+		}
+	})
+}

cmd/version.go

@@ -2,20 +2,41 @@ package cmd
 
 import (
 	"github.com/everdrone/grab/internal/config"
+	"github.com/everdrone/grab/internal/update"
+	"github.com/fatih/color"
 
 	"github.com/spf13/cobra"
 )
 
 var VersionCmd = &cobra.Command{
 	Use:   "version",
-	Short: "Print the version number and exit",
+	Short: "Print the version number and check for updates",
 	Run: func(cmd *cobra.Command, args []string) {
+		updateMessageChan := make(chan string)
+		go func() {
+			newVersion, _ := update.CheckForUpdates()
+			updateMessageChan <- newVersion
+		}()
+
 		cmd.Printf("%s v%s %s/%s (%s)\n",
 			cmd.Root().Name(),
 			config.Version,
 			config.BuildOS,
 			config.BuildArch,
 			config.CommitHash[:7])
+
+		newVersion := <-updateMessageChan
+		if newVersion != "" {
+			// TODO: take in account possible package managers
+			// if for example we installed with homebrew, we should display a different message
+			cmd.Printf("\n\n%s %s → %s\n",
+				color.New(color.FgMagenta).Sprintf("A new release of %s is available:", config.Name),
+				config.Version,
+				// color.New(color.FgHiBlack).Sprint(config.Version),
+				color.New(color.FgCyan).Sprint(newVersion),
+			)
+			cmd.Printf("%s\n\n", "https://github.com/everdrone/grab/releases/latest")
+		}
 	},
 }
 

cmd/version_test.go

@@ -1,34 +1,62 @@
 package cmd
 
 import (
-	"fmt"
+	"net/http"
+	"net/http/httptest"
+	"runtime"
 	"testing"
 
 	"github.com/everdrone/grab/internal/config"
 	tu "github.com/everdrone/grab/testutils"
 )
 
 func TestVersionCmd(t *testing.T) {
-	t.Run("version", func(t *testing.T) {
-		cmdName := "version"
-
-		c, got, err := tu.ExecuteCommand(RootCmd, cmdName)
-		if err != nil {
-			t.Fatal(err)
-		}
-
-		want := fmt.Sprintf("%s v%s %s/%s (%s)\n",
-			"grab",
-			config.Version,
-			"unknown",
-			"unknown",
-			"unknown",
-		)
-		if c.Name() != cmdName {
-			t.Fatalf("got: '%s', want: '%s'", c.Name(), cmdName)
-		}
-		if got != want {
-			t.Errorf("got: %s, want: %s", got, want)
-		}
-	})
+	config.CommitHash = "abcdef0123456789"
+	config.BuildOS = runtime.GOOS
+	config.BuildArch = runtime.GOARCH
+
+	tests := []struct {
+		name    string
+		handler func(w http.ResponseWriter, r *http.Request)
+		want    string
+	}{
+		{
+			name: "no updates",
+			handler: func(w http.ResponseWriter, r *http.Request) {
+				w.Write([]byte(`{"tag_name": "v` + config.Version + `"}`))
+			},
+			want: "grab v" + config.Version + " " + config.BuildOS + "/" + config.BuildArch + " (" + config.CommitHash[:7] + ")\n",
+		},
+		{
+			name: "newer version",
+			handler: func(w http.ResponseWriter, r *http.Request) {
+				w.Write([]byte(`{"tag_name": "v987.654.321"}`))
+			},
+			want: "grab v" + config.Version + " " + config.BuildOS + "/" + config.BuildArch + " (" + config.CommitHash[:7] + ")\n\n\n" +
+				"A new release of grab is available: " + config.Version + " → 987.654.321\n" +
+				"https://github.com/everdrone/grab/releases/latest\n\n",
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(tc *testing.T) {
+			// start the test server
+			ts := httptest.NewServer(http.HandlerFunc(tt.handler))
+
+			config.LatestReleaseURL = ts.URL
+
+			c, got, err := tu.ExecuteCommand(RootCmd, "version")
+			if err != nil {
+				tc.Fatal(err)
+			}
+
+			if c.Name() != VersionCmd.Name() {
+				tc.Fatalf("got: %s, want: %s", c.Name(), VersionCmd.Name())
+			}
+
+			if got != tt.want {
+				tc.Errorf("got: %q, want: %q", got, tt.want)
+			}
+		})
+	}
 }

go.mod

@@ -27,6 +27,7 @@ require (
 	github.com/valyala/bytebufferpool v1.0.0 // indirect
 	github.com/valyala/fasttemplate v1.2.1 // indirect
 	golang.org/x/crypto v0.0.0-20220517005047-85d78b3ac167 // indirect
+	golang.org/x/mod v0.6.0-dev.0.20220106191415-9b9b3d81d5e3 // indirect
 	golang.org/x/net v0.0.0-20211112202133-69e39bad7dc2 // indirect
 	golang.org/x/sys v0.0.0-20220818161305-2296e01440c6 // indirect
 	golang.org/x/text v0.3.7 // indirect