Added test framework, and init command tests (#20)

* Added end-to-end test framework
* Added various unit tests
* Remove windows platform from build

Author: liamg

.gitignore

@@ -0,0 +1 @@
+/peridot

.goreleaser.yml

@@ -10,7 +10,6 @@ builds:
       - CGO_ENABLED=0
     goos:
       - linux
-      - windows
       - darwin
     goarch:
       - "386"

Makefile

@@ -1,5 +1,6 @@
 default: test
 
+.PHONY: test
 test:
 	go test -race ./...
 

_examples/basic/custom/config.yml

@@ -7,4 +7,4 @@ variables:
     default: 37
 files:
   - target: {{ .user_home_dir }}{{ .sep }}example.txt
-    template: ./custom.tpl
+    template: ./custom.tmpl

_examples/basic/custom/custom.tpl renamed to _examples/basic/custom/custom.tmpl

@@ -3,16 +3,38 @@ module github.com/liamg/peridot
 go 1.17
 
 require (
+	github.com/docker/docker v20.10.12+incompatible
 	github.com/hexops/gotextdiff v1.0.3
 	github.com/liamg/tml v0.4.0
 	github.com/spf13/cobra v1.3.0
 	github.com/stretchr/testify v1.7.0
 	gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b
+	gotest.tools v2.2.0+incompatible
 )
 
 require (
+	github.com/Microsoft/go-winio v0.4.17 // indirect
+	github.com/containerd/containerd v1.5.8 // indirect
 	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/docker/distribution v2.7.1+incompatible // indirect
+	github.com/docker/go-connections v0.4.0 // indirect
+	github.com/docker/go-units v0.4.0 // indirect
+	github.com/gogo/protobuf v1.3.2 // indirect
+	github.com/golang/protobuf v1.5.2 // indirect
+	github.com/google/go-cmp v0.5.6 // indirect
+	github.com/gorilla/mux v1.8.0 // indirect
 	github.com/inconshreveable/mousetrap v1.0.0 // indirect
+	github.com/moby/term v0.0.0-20210619224110-3f7ff695adc6 // indirect
+	github.com/morikuni/aec v1.0.0 // indirect
+	github.com/opencontainers/go-digest v1.0.0 // indirect
+	github.com/opencontainers/image-spec v1.0.2 // indirect
+	github.com/pkg/errors v0.9.1 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
+	github.com/sirupsen/logrus v1.8.1 // indirect
 	github.com/spf13/pflag v1.0.5 // indirect
+	golang.org/x/net v0.0.0-20210813160813-60bc85c4be6d // indirect
+	golang.org/x/sys v0.0.0-20211205182925-97ca703d548d // indirect
+	google.golang.org/genproto v0.0.0-20211208223120-3a66f561d7aa // indirect
+	google.golang.org/grpc v1.42.0 // indirect
+	google.golang.org/protobuf v1.27.1 // indirect
 )

go.mod

@@ -52,11 +52,10 @@ var (
 [commit]
 	gpgsign = true
 [core]
+	excludesfile = ~/.gitignore
 {{ if .editor }}	editor = {{ .editor }}
 {{ else }}	editor = vim
 {{ end }}
-[ignore]
-	file = ~/.gitignore
 [pull]
 	rebase = true
 [alias]

go.sum

@@ -1,10 +1,11 @@
 package cmd
 
 import (
+	"fmt"
 	"os"
+	"path/filepath"
 
 	"github.com/liamg/peridot/internal/pkg/config"
-	"github.com/liamg/peridot/internal/pkg/module"
 	"github.com/liamg/tml"
 	"github.com/spf13/cobra"
 )
@@ -15,10 +16,13 @@ func init() {
 		Use:   "init",
 		Short: "Initialises a new peridot config for the local user environment.",
 		Run: func(cmd *cobra.Command, args []string) {
-			root, err := module.LoadRoot()
-			if err == nil {
+			configPath, err := config.Path()
+			if err != nil {
+				fail(fmt.Sprintf("Cannot locate config path: %s", err))
+			}
+			if _, err := os.Stat(configPath); err == nil {
 				if force {
-					if err := os.RemoveAll(root.Path()); err != nil {
+					if err := os.RemoveAll(filepath.Dir(configPath)); err != nil {
 						fail(err)
 					}
 				} else {

internal/pkg/builtins/git.go

@@ -12,6 +12,17 @@ import (
 var rootCmd = &cobra.Command{
 	Use:   "peridot",
 	Short: "Manage dotfiles and user environments across machines, OSes, users and more.",
+	PersistentPreRun: func(_ *cobra.Command, args []string) {
+		if disableANSI {
+			tml.DisableFormatting()
+		}
+	},
+}
+
+var disableANSI bool
+
+func init() {
+	rootCmd.PersistentFlags().BoolVar(&disableANSI, "no-ansi", disableANSI, "Disable ANSI colour/formatting codes in output.")
 }
 
 func Execute() {

internal/pkg/cmd/init.go

@@ -0,0 +1,140 @@
+package config
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestModule_Validate(t *testing.T) {
+	tests := []struct {
+		name    string
+		module  Module
+		wantErr bool
+	}{
+		{
+			name:    "empty config",
+			module:  Module{},
+			wantErr: false,
+		},
+		{
+			name: "variable with no name",
+			module: Module{
+				Variables: []Variable{
+					{
+						Name: "",
+					},
+				},
+			},
+			wantErr: true,
+		},
+		{
+			name: "variable not required but no default",
+			module: Module{
+				Variables: []Variable{
+					{
+						Name:     "x",
+						Required: false,
+						Default:  nil,
+					},
+				},
+			},
+			wantErr: true,
+		},
+		{
+			name: "variable required but has default",
+			module: Module{
+				Variables: []Variable{
+					{
+						Name:     "x",
+						Required: true,
+						Default:  "blah",
+					},
+				},
+			},
+			wantErr: true,
+		},
+		{
+			name: "child module without name",
+			module: Module{
+				Modules: []InnerModule{
+					{
+						Name: "",
+					},
+				},
+			},
+			wantErr: true,
+		},
+		{
+			name: "child module without source",
+			module: Module{
+				Modules: []InnerModule{
+					{
+						Name:   "X",
+						Source: "",
+					},
+				},
+			},
+			wantErr: true,
+		},
+		{
+			name: "scripts: has install_required but no install",
+			module: Module{
+				Scripts: Scripts{
+					InstallRequired: "check",
+					Install:         "",
+				},
+			},
+			wantErr: true,
+		},
+		{
+			name: "scripts: has no install_required but has install",
+			module: Module{
+				Scripts: Scripts{
+					InstallRequired: "",
+					Install:         "check",
+				},
+			},
+			wantErr: true,
+		},
+		{
+			name: "scripts: has update_required but no update",
+			module: Module{
+				Scripts: Scripts{
+					UpdateRequired: "check",
+					Update:         "",
+				},
+			},
+			wantErr: true,
+		},
+		{
+			name: "scripts: has no update_required but has update",
+			module: Module{
+				Scripts: Scripts{
+					UpdateRequired: "",
+					Update:         "check",
+				},
+			},
+			wantErr: true,
+		},
+		{
+			name: "scripts: has after_file_change but no files",
+			module: Module{
+				Scripts: Scripts{
+					AfterFileChange: "check",
+				},
+			},
+			wantErr: true,
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			err := tt.module.Validate()
+			if tt.wantErr {
+				assert.Error(t, err)
+			} else {
+				assert.NoError(t, err)
+			}
+		})
+	}
+}

internal/pkg/cmd/root.go

@@ -0,0 +1,14 @@
+package system
+
+import (
+	"runtime"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestInfo(t *testing.T) {
+	info := Info()
+	assert.Equal(t, runtime.GOOS, info.OperatingSystem)
+	assert.Equal(t, runtime.GOARCH, info.Architecture)
+}

internal/pkg/config/module_test.go

@@ -22,7 +22,8 @@ type collection struct {
 }
 
 func (c *collection) Has(name string) bool {
-	return c.Get(name) != nil
+	_, ok := c.data[name]
+	return ok
 }
 
 func (c *collection) Get(name string) Variable {