cleanup and add a basic test case

Author: Kriechi

README.md

@@ -74,3 +74,9 @@ ignored_branches:
   - requires-io-master
   - some-other-branch-to-ignore
 ```
+
+## Development Testing
+
+```sh
+go test ./...
+```

cmd/check.go

@@ -128,7 +128,7 @@ func printCheckResults(resultList [][]string) {
 	if len(resultList) == 0 {
 		fmt.Println("Already up-to-date.")
 	} else {
-		table := tablewriter.NewWriter(os.Stdout)
+		table := tablewriter.NewWriter(outWriter)
 		table.SetHeader([]string{"Repository", "Changed Branch", "Remote URL"})
 		table.SetBorder(false)
 		table.AppendBulk(resultList)

cmd/list.go

@@ -2,7 +2,6 @@ package cmd
 
 import (
 	"fmt"
-	"io/ioutil"
 	"os"
 	"path/filepath"
 	"strings"
@@ -56,7 +55,7 @@ func parseMonitoredBranches(repo string) []string {
 	var branchList []string
 	branchFile := filepath.Join(repoDir, repo, ".git-monitor-branches")
 	if _, err := os.Stat(branchFile); err == nil {
-		byts, err := ioutil.ReadFile(branchFile)
+		byts, err := os.ReadFile(branchFile)
 		if err == nil {
 			content := strings.Replace(string(byts), "\r\n", "\n", -1)
 			for _, branch := range strings.Split(content, "\n") {
@@ -73,7 +72,7 @@ func parseMonitoredBranches(repo string) []string {
 }
 
 func printListResults(repoList [][]string) {
-	table := tablewriter.NewWriter(os.Stdout)
+	table := tablewriter.NewWriter(outWriter)
 	table.SetHeader([]string{"Repository", "Remote URL", "Monitored Branches"})
 	table.SetBorder(false)
 	table.AppendBulk(repoList)

cmd/list_test.go

@@ -0,0 +1,26 @@
+package cmd
+
+import (
+	"bytes"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestListCmd(t *testing.T) {
+	buf := new(bytes.Buffer)
+
+	root := newRootCmd(buf)
+	root.SetOut(buf)
+	root.SetErr(buf)
+	root.SetArgs([]string{"list", "-v", "--repo_dir", "/tmp"})
+
+	c, err := root.ExecuteC()
+	assert.NotNil(t, c)
+	assert.Nil(t, err)
+
+	result := buf.String()
+	assert.Contains(t, result, "REPOSITORY")
+	assert.Contains(t, result, "REMOTE URL")
+	assert.Contains(t, result, "MONITORED BRANCHES")
+}

cmd/root.go

@@ -2,6 +2,7 @@ package cmd
 
 import (
 	"fmt"
+	"io"
 	"os"
 	"path/filepath"
 	"strings"
@@ -14,10 +15,12 @@ import (
 
 var cfgFile string
 
+var outWriter io.Writer
+
 // rootCmd represents the base command when called without any subcommands
-var rootCmd *cobra.Command = newRootCmd()
+var rootCmd *cobra.Command = newRootCmd(os.Stdout)
 
-func newRootCmd() *cobra.Command {
+func newRootCmd(w io.Writer) *cobra.Command {
 	r := &cobra.Command{
 		Use:   "git-monitor",
 		Short: "git-monitor keeps track of changes in monitored git repositories",
@@ -31,11 +34,25 @@ you that repository X on branch Y has new commits.`,
 		Run: runRoot,
 	}
 
+	r.PersistentFlags().StringVar(&cfgFile, "config", "", "config file (default is $HOME/.git-monitor.yaml)")
+
+	r.PersistentFlags().BoolP("verbose", "v", false, "enable verbose output")
+	viper.BindPFlag("verbose", r.PersistentFlags().Lookup("verbose"))
+
+	r.PersistentFlags().BoolP("open_in_browser", "b", false, "open the URL of each repository change in your browser")
+	viper.BindPFlag("open_in_browser", r.PersistentFlags().Lookup("open_in_browser"))
+
+	r.PersistentFlags().String("repo_dir", "", "directory where to store local repositories")
+	viper.BindPFlag("repo_dir", r.PersistentFlags().Lookup("repo_dir"))
+	viper.SetDefault("repo_dir", "~/.git-monitor")
+
 	r.AddCommand(addCmd)
 	r.AddCommand(checkCmd)
 	r.AddCommand(listCmd)
 	r.AddCommand(removeCmd)
 
+	outWriter = w
+
 	return r
 }
 
@@ -50,18 +67,6 @@ func Execute(version string) {
 
 func init() {
 	cobra.OnInitialize(initConfig)
-
-	rootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "config file (default is $HOME/.git-monitor.yaml)")
-
-	rootCmd.PersistentFlags().BoolP("verbose", "v", false, "enable verbose output")
-	viper.BindPFlag("verbose", rootCmd.PersistentFlags().Lookup("verbose"))
-
-	rootCmd.PersistentFlags().BoolP("open_in_browser", "b", false, "open the URL of each repository change in your browser")
-	viper.BindPFlag("open_in_browser", rootCmd.PersistentFlags().Lookup("open_in_browser"))
-
-	rootCmd.PersistentFlags().String("repo_dir", "", "directory where to store local repositories")
-	viper.BindPFlag("repo_dir", rootCmd.PersistentFlags().Lookup("repo_dir"))
-	viper.SetDefault("repo_dir", "~/.git-monitor")
 }
 
 // initConfig reads in config file and ENV variables if set.

go.mod

@@ -1,6 +1,8 @@
 module github.com/kriechi/git-monitor
 
-go 1.17
+go 1.23.0
+
+toolchain go1.24.1
 
 require (
 	github.com/go-git/go-git/v5 v5.13.0
@@ -9,6 +11,7 @@ require (
 	github.com/pkg/browser v0.0.0-20210911075715-681adbf594b8
 	github.com/spf13/cobra v1.2.1
 	github.com/spf13/viper v1.9.0
+	github.com/stretchr/testify v1.10.0
 )
 
 require (
@@ -17,6 +20,7 @@ require (
 	github.com/ProtonMail/go-crypto v1.1.3 // indirect
 	github.com/cloudflare/circl v1.3.7 // indirect
 	github.com/cyphar/filepath-securejoin v0.2.5 // indirect
+	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/emirpasic/gods v1.18.1 // indirect
 	github.com/fsnotify/fsnotify v1.5.1 // indirect
 	github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376 // indirect
@@ -31,6 +35,7 @@ require (
 	github.com/mitchellh/mapstructure v1.4.2 // indirect
 	github.com/pelletier/go-toml v1.9.4 // indirect
 	github.com/pjbgf/sha1cd v0.3.0 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/sergi/go-diff v1.3.2-0.20230802210424-5b0b94c5c0d3 // indirect
 	github.com/skeema/knownhosts v1.3.0 // indirect
 	github.com/spf13/afero v1.6.0 // indirect
@@ -49,4 +54,5 @@ require (
 	gopkg.in/ini.v1 v1.63.2 // indirect
 	gopkg.in/warnings.v0 v0.1.2 // indirect
 	gopkg.in/yaml.v2 v2.4.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
 )