Merge pull request #9 from happypork/non-zero-exit-code

Non zero exit code on outdated dependencies

Author: psampaz

CHANGELOG.md

@@ -5,7 +5,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 
 ## [0.3.0] unreleased
 ### Added
-- osx in travis 
+- osx in travis
+- Flag '-ci' to exit with non-zero exit code when an outdated dependency is found
 ### Removed
 - tip version in travis
 

README.md

@@ -74,6 +74,23 @@ If you want to see only the direct depedencies that have updates run
 go list -u -m -json all | go-mod-outdated -update -direct 
 ```
 
+If you want to make your CI pipeline fail
+
+```
+go list -u -m -json all | go-mod-outdated -direct -ci
+```
+### CI pipelines
+
+Using the -ci flag will the make the command exit with none zero code, breaking this way your ci pipelines.
+
+If you want to make your CI pipeline fail if any direct or indirect dependency is outdated use the following:
+```
+go list -u -m -json all | go-mod-outdated -ci
+```
+If you want to make your CI pipeline fail only if a direct dependency is outdated use the following:
+```
+go list -u -m -json all | go-mod-outdated -direct -ci
+```
 ### Help
 
 In order to see details about the usage of the command use the **-h** or **-help** flag
@@ -86,6 +103,8 @@ Usage of go-mod-outdated:
         List only direct modules
   -update
         List only modules with updates
+  -ci
+        Exit with non-zero exit code when outdated dependencies are found
 ```
 
 ### Shortcut
@@ -390,3 +409,19 @@ $ go list -u -m -json all | go-mod-outdated -update -direct
 | golang.org/x/sync                  | v0.0.0-20180314180146-1d60e4601c6f   | v0.0.0-20190412183630-56d357773e84 | true   | true             |
 +------------------------------------+--------------------------------------+------------------------------------+--------+------------------+
 ```
+### Table view of go list -u -m -json all command using go-mod-outdated (with -ci flag, only direct dependencies with updates)
+
+```
+$ go list -u -m -json all | go-mod-outdated -update -direct -ci
++------------------------------------+--------------------------------------+------------------------------------+--------+------------------+
+|               MODULE               |               VERSION                |            NEW VERSION             | DIRECT | VALID TIMESTAMPS |
++------------------------------------+--------------------------------------+------------------------------------+--------+------------------+
+| github.com/BurntSushi/toml         | v0.0.0-20170626110600-a368813c5e64   | v0.3.1                             | true   | true             |
+| github.com/PuerkitoBio/purell      | v1.1.0                               | v1.1.1                             | true   | true             |
+| github.com/alecthomas/chroma       | v0.6.0                               | v0.6.3                             | true   | true             |
+...
+| golang.org/x/sync                  | v0.0.0-20180314180146-1d60e4601c6f   | v0.0.0-20190412183630-56d357773e84 | true   | true             |
++------------------------------------+--------------------------------------+------------------------------------+--------+------------------+
+$ echo $?
+1
+```

internal/runner/runner.go

@@ -3,15 +3,18 @@ package runner
 import (
 	"encoding/json"
 	"io"
+	"os"
 	"strconv"
 
 	"github.com/psampaz/go-mod-outdated/internal/mod"
 
 	"github.com/olekukonko/tablewriter"
 )
 
+var OsExit = os.Exit
+
 // Run converts the the json output of go list -u -m -json all to table format
-func Run(in io.Reader, out io.Writer, update, direct bool) error {
+func Run(in io.Reader, out io.Writer, update, direct, exitWithNonZero bool) error {
 	var modules []mod.Module
 	dec := json.NewDecoder(in)
 
@@ -21,7 +24,11 @@ func Run(in io.Reader, out io.Writer, update, direct bool) error {
 
 		if err != nil {
 			if err == io.EOF {
-				renderTable(out, mod.FilterModules(modules, update, direct))
+				filteredModules := mod.FilterModules(modules, update, direct)
+				renderTable(out, filteredModules)
+				if hasOutdated(filteredModules) && exitWithNonZero {
+					OsExit(1)
+				}
 				return nil
 			}
 			return err
@@ -30,6 +37,15 @@ func Run(in io.Reader, out io.Writer, update, direct bool) error {
 	}
 }
 
+func hasOutdated(filteredModules []mod.Module) bool {
+	for m := range filteredModules {
+		if filteredModules[m].HasUpdate() {
+			return true
+		}
+	}
+	return false
+}
+
 func renderTable(writer io.Writer, modules []mod.Module) {
 	table := tablewriter.NewWriter(writer)
 	table.SetHeader([]string{"Module", "Version", "New Version", "Direct", "Valid Timestamps"})

internal/runner/runner_test.go

@@ -19,7 +19,7 @@ func TestRun(t *testing.T) {
 	outBytes, _ := ioutil.ReadFile("testdata/out.txt")
 	wantOut := bytes.NewBuffer(outBytes)
 
-	err := runner.Run(in, &gotOut, false, false)
+	err := runner.Run(in, &gotOut, false, false, false)
 
 	if err != nil {
 		t.Errorf("Error should be nil, got %s", err.Error())
@@ -38,11 +38,59 @@ func TestRunWithError(t *testing.T) {
 	inBytes, _ := ioutil.ReadFile("testdata/err.txt")
 	in := bytes.NewBuffer(inBytes)
 
-	gotErr := runner.Run(in, &out, false, false)
+	gotErr := runner.Run(in, &out, false, false, false)
 	wantErr := errors.New("unexpected EOF")
 
 	if gotErr.Error() != wantErr.Error() {
 		t.Errorf("Wanted %s, got %s", wantErr, gotErr)
 	}
 
 }
+
+func TestRunExitWithNonZero(t *testing.T) {
+	var out bytes.Buffer
+
+	inBytes, _ := ioutil.ReadFile("testdata/in.txt")
+	in := bytes.NewBuffer(inBytes)
+
+	oldOsExit := runner.OsExit
+	defer func() { runner.OsExit = oldOsExit }()
+
+	var got int
+	testExit := func(code int) {
+		got = code
+	}
+
+	runner.OsExit = testExit
+	err := runner.Run(in, &out, false, false, true)
+	if err != nil {
+		t.Errorf("Error should be nil, got %s", err.Error())
+	}
+	if exp := 1; got != exp {
+		t.Errorf("Expected exit code: %d, got: %d", exp, got)
+	}
+}
+
+func TestRunExitWithNonZeroIndirectsOnly(t *testing.T) {
+
+	inBytes, _ := ioutil.ReadFile("testdata/update_indirect.txt")
+	in := bytes.NewBuffer(inBytes)
+
+	oldOsExit := runner.OsExit
+	defer func() { runner.OsExit = oldOsExit }()
+
+	var got int
+	testExit := func(code int) {
+		got = code
+	}
+
+	runner.OsExit = testExit
+	var out bytes.Buffer
+	err := runner.Run(in, &out, false, true, true)
+	if err != nil {
+		t.Errorf("Error should be nil, got %s", err.Error())
+	}
+	if exp := 0; got != exp {
+		t.Errorf("Expected exit code: %d, got: %d", exp, got)
+	}
+}

internal/runner/testdata/update_indirect.txt

@@ -0,0 +1,18 @@
+{
+	"Path": "github.com/gohugoio/hugo",
+	"Main": true,
+	"Dir": "/home/mojo/Code/go/hugo",
+	"GoMod": "/home/mojo/Code/go/hugo/go.mod"
+}
+{
+	"Path": "github.com/muesli/smartcrop",
+	"Version": "v0.0.0-20180228075044-f6ebaa786a12",
+	"Time": "2018-02-28T07:50:44Z",
+	"Indirect": true,
+	"Update": {
+		"Path": "github.com/muesli/smartcrop",
+		"Version": "v0.2.0",
+		"Time": "2017-08-09T19:13:04Z"
+	},
+	"GoMod": "/home/user/go/pkg/mod/cache/download/github.com/muesli/smartcrop/@v/v0.0.0-20180228075044-f6ebaa786a12.mod"
+}

main.go

@@ -12,9 +12,10 @@ func main() {
 
 	withUpdate := flag.Bool("update", false, "List only modules with updates")
 	onlyDirect := flag.Bool("direct", false, "List only direct modules")
+	exitNonZero := flag.Bool("ci", false, "Non-zero exit code when at least one outdated dependency was found")
 	flag.Parse()
 
-	err := runner.Run(os.Stdin, os.Stdout, *withUpdate, *onlyDirect)
+	err := runner.Run(os.Stdin, os.Stdout, *withUpdate, *onlyDirect, *exitNonZero)
 
 	if err != nil {
 		log.Print(err)