Merge pull request #28 from beatlabs/check-refactoring

module version check refactored for the path and error

Author: ormanli

README.md

@@ -164,6 +164,10 @@ Result:
 Apache-2.0
 ```
 
+## How to configure for private modules
+
+Since check and update rely on go toolchain, if you have any private module that isn't publicly accessible, don't forget to set up your environment variables. For more information and how to configure, please check [Module configuration for non-public modules](https://golang.org/cmd/go/#hdr-Module_configuration_for_non_public_modules).
+
 ## Code of conduct
 
 Please note that this project is released with a [Contributor Code of Conduct](https://github.com/beatlabs/gomodctl/blob/master/CODE_OF_CONDUCT.md). By participating in this project and its community you agree to abide by those terms.

cmd/gomodctl/gomodctl.go

@@ -5,6 +5,7 @@ import (
 	"fmt"
 	"os"
 	"os/signal"
+	"syscall"
 
 	"github.com/beatlabs/gomodctl/internal/cmd/check"
 	"github.com/beatlabs/gomodctl/internal/cmd/info"
@@ -44,18 +45,13 @@ type RootOptions struct {
 func Execute() {
 	ctx, cancel := context.WithCancel(context.Background())
 
-	c := make(chan os.Signal, 1)
+	signals := make(chan os.Signal, 1)
 
-	signal.Notify(c, os.Interrupt)
-
-	defer func() {
-		signal.Stop(c)
-		cancel()
-	}()
+	signal.Notify(signals, syscall.SIGINT, syscall.SIGTERM)
 
 	go func() {
 		select {
-		case <-c:
+		case <-signals:
 			cancel()
 		case <-ctx.Done():
 		}

internal/cmd/check/check.go

@@ -56,11 +56,18 @@ func (o *Options) Execute(checker Checker) {
 	var data [][]string
 
 	for name, result := range checkResults {
-		data = append(data, []string{
+		r := []string{
 			name,
 			result.LocalVersion.Original(),
-			result.LatestVersion.Original(),
-		})
+		}
+
+		if result.Error != nil {
+			r = append(r, fmt.Sprintf("failed because of: %s", result.Error.Error()))
+		} else {
+			r = append(r, result.LatestVersion.Original())
+		}
+
+		data = append(data, r)
 	}
 
 	table := tablewriter.NewWriter(os.Stdout)

internal/module/check_test.go

@@ -2,6 +2,9 @@ package module
 
 import (
 	"context"
+	"io/ioutil"
+	"os"
+	"path/filepath"
 	"testing"
 
 	"github.com/stretchr/testify/suite"
@@ -41,3 +44,60 @@ func (s *CheckTestSuite) Test_SelfCheck_CancelContextBefore() {
 	s.EqualError(err, "context canceled")
 	s.Empty(result)
 }
+func (s *CheckTestSuite) Test_CustomModFile() {
+	gomodContent := []byte(`module test-project
+
+go 1.13
+
+require (
+	github.com/afex/hystrix-go v0.0.0-20180502004556-fa1af6a1f4f5
+	github.com/cespare/xxhash/v2 v2.1.1 // indirect
+	github.com/fsnotify/fsnotify v1.4.7
+	github.com/gin-gonic/gin v1.5.0 // indirect
+	github.com/go-openapi/jsonreference v0.19.3 // indirect
+	github.com/go-openapi/spec v0.19.4 // indirect
+	github.com/go-playground/universal-translator v0.17.0 // indirect
+	github.com/json-iterator/go v1.1.8 // indirect
+	github.com/klauspost/compress v1.9.3 // indirect
+	github.com/konsorten/go-windows-terminal-sequences v1.0.2 // indirect
+	github.com/labstack/echo/v4 v4.1.11
+	github.com/leodido/go-urn v1.2.0 // indirect
+	github.com/mailru/easyjson v0.7.0 // indirect
+	github.com/mattn/go-colorable v0.1.4 // indirect
+	github.com/mattn/go-isatty v0.0.10 // indirect
+	github.com/newrelic/go-agent v2.16.0+incompatible // indirect
+	github.com/prometheus/client_golang v1.2.1 // indirect
+	github.com/prometheus/procfs v0.0.8 // indirect
+	github.com/sirupsen/logrus v1.4.2
+	github.com/spf13/viper v1.4.0
+	github.com/stretchr/testify v1.4.0
+	github.com/swaggo/echo-swagger v0.0.0-20190329130007-1219b460a043
+	github.com/swaggo/swag v1.6.3 // indirect
+	github.com/valyala/fasthttp v1.6.0 // indirect
+	github.com/valyala/fasttemplate v1.1.0 // indirect
+	golang.org/x/crypto v0.0.0-20191128160524-b544559bb6d1 // indirect
+	golang.org/x/net v0.0.0-20191126235420-ef20fe5d7933
+	golang.org/x/sys v0.0.0-20191128015809-6d18c012aee9 // indirect
+	golang.org/x/tools v0.0.0-20191130070609-6e064ea0cf2d // indirect
+	gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 // indirect
+	gopkg.in/go-playground/validator.v9 v9.30.2 // indirect
+	gopkg.in/yaml.v2 v2.2.7 // indirect
+)`)
+
+	tempDir, err := ioutil.TempDir("", "test")
+	s.NoError(err)
+
+	tempFile := filepath.Join(tempDir, "go.mod")
+
+	err = ioutil.WriteFile(tempFile, gomodContent, 0666)
+	s.NoError(err)
+
+	checker := Checker{Ctx: s.ctx}
+
+	result, err := checker.Check(tempDir)
+	s.NoError(err)
+	s.NotEmpty(result)
+
+	s.NoError(os.Remove(tempFile))
+	s.NoError(os.RemoveAll(tempDir))
+}

internal/module/parser.go

@@ -3,9 +3,10 @@ package module
 import (
 	"context"
 	"encoding/json"
+	"fmt"
 	"os/exec"
+	"path/filepath"
 	"regexp"
-	"strings"
 
 	"github.com/Masterminds/semver"
 	"github.com/spf13/viper"
@@ -38,19 +39,17 @@ type packageResult struct {
 func (v *versionParser) Parse(path string) ([]packageResult, error) {
 	cmd := exec.CommandContext(v.ctx, "go", "list", "-m", "-versions", "-json", "all")
 
-	home := viper.GetString("home")
 	if path != "" {
-		if home != "" && strings.Contains(path, "~") {
-			path = home + strings.Replace(path, "~", "", 1) + "/"
-		} else {
-			path = path + "/"
-		}
-
-		cmd.Dir = path
+		home := viper.GetString("home")
+		cmd.Dir = filepath.Join(home, path)
 	}
 
 	out, err := cmd.CombinedOutput()
 	if err != nil {
+		if len(out) > 0 {
+			return nil, fmt.Errorf("with output [%s] %w", out, err)
+		}
+
 		return nil, err
 	}