Refactor Project Structure (#325)

* added logger & git pkg

* tests pass

* migrated everything to internal

* fix logger

* update go version

* fix clone calls

* clean up git.Clone

* fix docs

* add build docs

README.md

@@ -23,6 +23,18 @@ generation of Kubernetes resource manifests that an in-cluster GitOps pod like
 [Weaveworks' Flux](https://github.com/weaveworks/flux) watches and reconciles
 with the current set of applied resource manifests in your Kubernetes cluster.
 
+## Installation
+
+You can grab the latest releases from the
+[releases page](https://github.com/microsoft/fabrikate/releases) or build the
+bleeding edge from source with:
+
+```bash
+git clone https://github.com/microsoft/fabrikate
+cd fabrikate
+go build -o fab cmd/cli/main.go
+```
+
 ## Getting Started
 
 First, install the latest `fab` cli on your local machine from

main.go → cmd/cli/main.go

@@ -3,7 +3,7 @@ package main
 import (
 	"reflect"
 
-	"github.com/microsoft/fabrikate/cmd"
+	"github.com/microsoft/fabrikate/internal/cmd"
 	"github.com/timfpark/yaml"
 )
 

go.mod

@@ -1,18 +1,30 @@
 module github.com/microsoft/fabrikate
 
-go 1.12
+go 1.15
 
 require (
+	github.com/golang/protobuf v1.3.2 // indirect
 	github.com/google/go-github/v28 v28.0.1
 	github.com/google/uuid v1.1.1
+	github.com/konsorten/go-windows-terminal-sequences v1.0.2 // indirect
 	github.com/kyokomi/emoji v2.1.0+incompatible
+	github.com/onsi/ginkgo v1.11.0 // indirect
+	github.com/onsi/gomega v1.7.0 // indirect
 	github.com/otiai10/copy v1.0.1
 	github.com/otiai10/curr v0.0.0-20190513014714-f5a3d24e5776 // indirect
 	github.com/sirupsen/logrus v1.4.2
+	github.com/spf13/afero v1.2.2 // indirect
+	github.com/spf13/cast v1.3.1 // indirect
 	github.com/spf13/cobra v1.0.0
+	github.com/spf13/pflag v1.0.5 // indirect
 	github.com/spf13/viper v1.4.0
 	github.com/stretchr/testify v1.5.1
 	github.com/timfpark/conjungo v1.0.1
 	github.com/timfpark/yaml v0.0.0-20190612232118-2e9e29c9df01
-	helm.sh/helm/v3 v3.2.0
+	golang.org/x/crypto v0.0.0-20200414173820-0848c9571904 // indirect
+	golang.org/x/net v0.0.0-20191004110552-13f9640d40b9 // indirect
+	golang.org/x/sys v0.0.0-20191022100944-742c48ecaeb7 // indirect
+	golang.org/x/text v0.3.2 // indirect
+	gopkg.in/yaml.v2 v2.2.8 // indirect
+	gopkg.in/yaml.v3 v3.0.0-20200615113413-eeeca48fe776
 )

cmd/add.go → internal/cmd/add.go

@@ -6,8 +6,8 @@ import (
 	"strings"
 
 	"github.com/kyokomi/emoji"
-	"github.com/microsoft/fabrikate/core"
-	"github.com/microsoft/fabrikate/logger"
+	"github.com/microsoft/fabrikate/internal/core"
+	"github.com/microsoft/fabrikate/internal/logger"
 	"github.com/spf13/cobra"
 )
 

cmd/add_test.go → internal/cmd/add_test.go

@@ -4,7 +4,7 @@ import (
 	"os"
 	"testing"
 
-	"github.com/microsoft/fabrikate/core"
+	"github.com/microsoft/fabrikate/internal/core"
 	"github.com/stretchr/testify/assert"
 )
 
@@ -17,7 +17,7 @@ func TestAdd(t *testing.T) {
 		_ = os.Chdir(cwd)
 	}()
 
-	err = os.Chdir("../testdata/add")
+	err = os.Chdir("../../testdata/add")
 	assert.Nil(t, err)
 
 	_ = os.Remove("./component.yaml")

cmd/generate.go → internal/cmd/generate.go

@@ -9,9 +9,9 @@ import (
 	"strings"
 
 	"github.com/kyokomi/emoji"
-	"github.com/microsoft/fabrikate/core"
-	"github.com/microsoft/fabrikate/generators"
-	"github.com/microsoft/fabrikate/logger"
+	"github.com/microsoft/fabrikate/internal/core"
+	"github.com/microsoft/fabrikate/internal/generators"
+	"github.com/microsoft/fabrikate/internal/logger"
 	"github.com/spf13/cobra"
 )
 

cmd/generate_test.go → internal/cmd/generate_test.go

@@ -3,7 +3,7 @@ package cmd
 import (
 	"testing"
 
-	"github.com/microsoft/fabrikate/core"
+	"github.com/microsoft/fabrikate/internal/core"
 )
 
 func TestGenerate(t *testing.T) {
@@ -21,23 +21,23 @@ func TestGenerate(t *testing.T) {
 		{
 			"json",
 			args{
-				"../testdata/generate",
+				"../../testdata/generate",
 				[]string{"prod-east", "prod"},
 				false,
 			},
 			map[string]int{
 				"microservices-workload": 0,
 				"infra":                  0,
 				"fabrikate-jaeger":       409,
-				"jaeger":                 26877,
+				"jaeger":                 26916,
 			},
 			false,
 		},
 
 		{
 			"yaml",
 			args{
-				"../testdata/generate-yaml",
+				"../../testdata/generate-yaml",
 				[]string{"prod"},
 				false,
 			},
@@ -52,7 +52,7 @@ func TestGenerate(t *testing.T) {
 		{
 			"remote static",
 			args{
-				"../testdata/generate-remote-static",
+				"../../testdata/generate-remote-static",
 				[]string{"common"},
 				false,
 			},
@@ -66,7 +66,7 @@ func TestGenerate(t *testing.T) {
 		{
 			"hooks",
 			args{
-				"../testdata/generate-hooks",
+				"../../testdata/generate-hooks",
 				[]string{"prod"},
 				false,
 			},
@@ -79,7 +79,7 @@ func TestGenerate(t *testing.T) {
 		{
 			"disabled subcomponent",
 			args{
-				"../testdata/generate-disabled",
+				"../../testdata/generate-disabled",
 				[]string{"disabled"},
 				false,
 			},

cmd/install.go → internal/cmd/install.go

@@ -5,9 +5,10 @@ import (
 	"os/exec"
 
 	"github.com/kyokomi/emoji"
-	"github.com/microsoft/fabrikate/core"
-	"github.com/microsoft/fabrikate/generators"
-	"github.com/microsoft/fabrikate/logger"
+	"github.com/microsoft/fabrikate/internal/core"
+	"github.com/microsoft/fabrikate/internal/generators"
+	"github.com/microsoft/fabrikate/internal/git"
+	"github.com/microsoft/fabrikate/internal/logger"
 	"github.com/spf13/cobra"
 )
 
@@ -45,8 +46,8 @@ func Install(path string) (err error) {
 			return err
 		} else if len(accessTokens) > 0 {
 			for repo, token := range accessTokens {
-				if _, exists := core.GitAccessTokens.Get(repo); !exists {
-					core.GitAccessTokens.Set(repo, token)
+				if _, exists := git.AccessTokens.Get(repo); !exists {
+					git.AccessTokens.Set(repo, token)
 				}
 			}
 		}

cmd/install_test.go → internal/cmd/install_test.go

@@ -2,8 +2,6 @@ package cmd
 
 import (
 	"testing"
-
-	"github.com/microsoft/fabrikate/util"
 )
 
 func TestInstall(t *testing.T) {
@@ -17,44 +15,44 @@ func TestInstall(t *testing.T) {
 	}{
 		{
 			"json",
-			args{"../testdata/install"},
+			args{"../../testdata/install"},
 			false,
 		},
 
 		{
 			"yaml",
-			args{"../testdata/install-yaml"},
+			args{"../../testdata/install-yaml"},
 			false,
 		},
 
 		{
 			"hooks",
-			args{"../testdata/install-hooks"},
+			args{"../../testdata/install-hooks"},
 			false,
 		},
 
 		{
 			"private git",
-			args{"../testdata/install-private"},
+			args{"../../testdata/install-private"},
 			true,
 		},
 
 		{
 			"helm",
-			args{"../testdata/install-helm"},
+			args{"../../testdata/install-helm"},
 			false,
 		},
 
 		{
 			"repo-alias",
-			args{"../testdata/repo-alias"},
+			args{"../../testdata/repo-alias"},
 			false,
 		},
 	}
 
 	for _, tt := range tests {
 		defer func() {
-			_ = util.UninstallComponents(tt.args.path)
+			// 	_ = util.UninstallComponents(tt.args.path)
 		}()
 
 		t.Run(tt.name, func(t *testing.T) {

cmd/remove.go → internal/cmd/remove.go

@@ -5,7 +5,7 @@ import (
 	"os"
 	"strings"
 
-	"github.com/microsoft/fabrikate/core"
+	"github.com/microsoft/fabrikate/internal/core"
 	"github.com/spf13/cobra"
 )
 

cmd/remove_test.go → internal/cmd/remove_test.go

@@ -3,7 +3,7 @@ package cmd
 import (
 	"testing"
 
-	"github.com/microsoft/fabrikate/core"
+	"github.com/microsoft/fabrikate/internal/core"
 	"github.com/stretchr/testify/assert"
 )
 

cmd/root.go → internal/cmd/root.go

@@ -4,7 +4,7 @@ import (
 	"fmt"
 	"os"
 
-	"github.com/microsoft/fabrikate/logger"
+	"github.com/microsoft/fabrikate/internal/logger"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 )

cmd/set.go → internal/cmd/set.go

@@ -7,7 +7,7 @@ import (
 	"io/ioutil"
 	"strings"
 
-	"github.com/microsoft/fabrikate/core"
+	"github.com/microsoft/fabrikate/internal/core"
 	"github.com/microsoft/fabrikate/util"
 	"github.com/spf13/cobra"
 	"github.com/timfpark/yaml"
@@ -152,11 +152,11 @@ $ fab set --environment prod data.replicas=4 username="ops"
 
 Sets the value of 'data.replicas' equal to 4 and 'username' equal to 'ops' in the 'prod' config for the current component.
 
-$ fab set --subcomponent "myapp" endpoint="east-db" 
+$ fab set --subcomponent "myapp" endpoint="east-db"
 
 Sets the value of 'endpoint' equal to 'east-db' in the 'common' config (the default) for subcomponent 'myapp'.
 
-$ fab set --subcomponent "myapp.mysubcomponent" data.replicas=5 
+$ fab set --subcomponent "myapp.mysubcomponent" data.replicas=5
 
 Sets the subkey "replicas" in the key 'data' equal to 5 in the 'common' config (the default) for the subcomponent 'mysubcomponent' of the subcomponent 'myapp'.
 

cmd/set_test.go → internal/cmd/set_test.go

@@ -17,7 +17,7 @@ func TestSetValue(t *testing.T) {
 		_ = os.Chdir(cwd)
 	}()
 
-	err = os.Chdir("../testdata/set")
+	err = os.Chdir("../../testdata/set")
 	assert.Nil(t, err)
 	noNewConfigKeys := false
 

cmd/version.go → internal/cmd/version.go

@@ -15,7 +15,7 @@
 package cmd
 
 import (
-	"github.com/microsoft/fabrikate/logger"
+	"github.com/microsoft/fabrikate/internal/logger"
 	"github.com/spf13/cobra"
 )
 

core/component.go → internal/core/component.go

@@ -14,7 +14,8 @@ import (
 	"sync"
 
 	"github.com/kyokomi/emoji"
-	"github.com/microsoft/fabrikate/logger"
+	"github.com/microsoft/fabrikate/internal/git"
+	"github.com/microsoft/fabrikate/internal/logger"
 	"github.com/timfpark/yaml"
 )
 
@@ -215,7 +216,12 @@ func (c *Component) InstallComponent(componentPath string) (err error) {
 			}
 
 			logger.Info(emoji.Sprintf(":helicopter: Installing component '%s' with git from '%s'", c.Name, c.Source))
-			if err = Git.CloneRepo(c.Source, c.Version, subcomponentPath, c.Branch); err != nil {
+			cloneOpts := &git.CloneOpts{
+				URL:    c.Source,
+				SHA:    c.Version,
+				Branch: c.Branch,
+				Into:   subcomponentPath}
+			if err = git.Clone(cloneOpts); err != nil {
 				return err
 			}
 			return nil