Merge pull request #8 from dreamteam-gg/modules-refector

alexandrst88 · web-flow · commit 781fb35aaec2 · 2019-04-03T11:54:57.000+03:00
Add go modules and refactor packages
diff --git a/.gitignore b/.gitignore
@@ -7,3 +7,4 @@
 !.vscode/tasks.json
 !.vscode/launch.json
 !.vscode/extensions.json
+terraform-variables-generator
diff --git a/.travis.yml b/.travis.yml
@@ -1,13 +1,17 @@
 language: go
 go:
-  - 1.9
+  - 1.12
+env:
+  - GO111MODULE=on
 # Don't email me the results of the test runs.
 notifications:
   email: false
 before_script:
-  - go get github.com/golang/lint/golint                        # Linter
+  - go get -u golang.org/x/lint/golint                        # Linter
+  - go get -u github.com/golangci/golangci-lint/cmd/golangci-lint
 
 script:
   - go test -v -race ./...                   # Run all the tests with the race detector enabled
   - go vet ./...                             # go vet is the official Go static analyzer
-  - golint -set_exit_status $(go list ./...) # one last linter
+  - golint -set_exit_status $(go list ./...) # one last linter
+  - golangci-lint run                        # some more linters
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,4 @@
+## (Unreleased)
+
+ENHANCEMENTS:
+* Optimize project structure, split to separate packages and add cobra for cli
diff --git a/cmd/cmd.go b/cmd/cmd.go
@@ -0,0 +1,63 @@
+package cmd
+
+import (
+	"fmt"
+	"os"
+
+	"github.com/spf13/cobra"
+
+	log "github.com/sirupsen/logrus"
+
+	"github.com/alexandrst88/terraform-variables-generator/pkg/generator"
+	"github.com/alexandrst88/terraform-variables-generator/pkg/utils"
+)
+
+const (
+	tfFileExt = "*.tf"
+)
+
+var (
+	generatorVersion string
+
+	vars     bool
+	varsFile string
+)
+
+// Execute will run main logic
+func Execute(version string) {
+	generatorVersion = version
+
+	cmd := &cobra.Command{
+		Use:     "generator",
+		Short:   "CLI for generating terraform variables",
+		Example: "  terraform-variable-generator",
+		Version: generatorVersion,
+		Run:     runGenerator,
+	}
+
+	cmd.PersistentFlags().BoolVar(&vars, "vars", true, "generate variables")
+	cmd.PersistentFlags().StringVar(&varsFile, "vars-file", "./variables.tf", "path to generated variables file")
+
+	if err := cmd.Execute(); err != nil {
+		fmt.Println(err)
+		os.Exit(1)
+	}
+	os.Exit(0)
+}
+
+func runGenerator(cmd *cobra.Command, args []string) {
+	if vars {
+		if utils.FileExists(varsFile) {
+			utils.UserPromt(varsFile)
+		}
+
+		tfFiles, err := utils.GetAllFiles(tfFileExt)
+		utils.CheckError(err)
+		if len(tfFiles) == 0 {
+			log.Warn("No terraform files to proceed, exiting")
+			return
+		}
+
+		generator.GenerateVars(tfFiles, varsFile)
+	}
+}
diff --git a/go.mod b/go.mod
@@ -0,0 +1,9 @@
+module github.com/alexandrst88/terraform-variables-generator
+
+go 1.12
+
+require (
+	github.com/sirupsen/logrus v1.4.1
+	github.com/spf13/cobra v0.0.3
+	github.com/spf13/pflag v1.0.3 // indirect
+)
diff --git a/go.sum b/go.sum
@@ -0,0 +1,13 @@
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/konsorten/go-windows-terminal-sequences v1.0.1/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/sirupsen/logrus v1.4.1 h1:GL2rEmy6nsikmW0r8opw9JIRScdMF5hA8cOYLH7In1k=
+github.com/sirupsen/logrus v1.4.1/go.mod h1:ni0Sbl8bgC9z8RoU9G6nDWqqs/fq4eDPysMBDgk/93Q=
+github.com/spf13/cobra v0.0.3 h1:ZlrZ4XsMRm04Fr5pSFxBgfND2EBVa1nLpiy1stUsX/8=
+github.com/spf13/cobra v0.0.3/go.mod h1:1l0Ry5zgKvJasoi3XT1TypsSe7PqH0Sj9dhYf7v3XqQ=
+github.com/spf13/pflag v1.0.3 h1:zPAT6CGy6wXeQ7NtTnaTerfKOsV6V6F8agHXFiazDkg=
+github.com/spf13/pflag v1.0.3/go.mod h1:DYY7MBk1bdzusC3SYhjObp+wFpr4gzcvqqNjLnInEg4=
+github.com/stretchr/objx v0.1.1/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
+golang.org/x/sys v0.0.0-20180905080454-ebe1bf3edb33 h1:I6FyU15t786LL7oL/hn43zqTuEGr4PN7F4XJ1p4E3Y8=
+golang.org/x/sys v0.0.0-20180905080454-ebe1bf3edb33/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
diff --git a/helpers.go b/helpers.go
diff --git a/main.go b/main.go
@@ -0,0 +1,10 @@
+package main
+
+import "github.com/alexandrst88/terraform-variables-generator/cmd"
+
+// Version is updated by linker flags during build time
+var Version = "dev"
+
+func main() {
+	cmd.Execute(Version)
+}
diff --git a/pkg/generator/configuration.mock b/pkg/generator/configuration.mock
diff --git a/pkg/generator/terraform.go b/pkg/generator/terraform.go
@@ -1,9 +1,11 @@
-package main
+package generator
 
 import (
 	"regexp"
 	"sort"
 	"strings"
+
+	"github.com/alexandrst88/terraform-variables-generator/pkg/utils"
 )
 
 type terraformVars struct {
@@ -16,13 +18,13 @@ func (t *terraformVars) matchVarPref(row, varPrefix string) {
 		match := pattern.FindAllStringSubmatch(row, -1)
 		for _, m := range match {
 			res := replacer.Replace(m[0])
-			if !containsElement(t.Variables, res) {
+			if !utils.ContainsElement(t.Variables, res) {
 				t.Variables = append(t.Variables, res)
 			}
 		}
 	}
 }
 
 func (t *terraformVars) sortVars() {
-	sort.Sort(sort.StringSlice(t.Variables))
+	sort.Strings(t.Variables)
 }
diff --git a/pkg/generator/vars.go b/pkg/generator/vars.go
@@ -1,4 +1,4 @@
-package main
+package generator
 
 import (
 	"bufio"
@@ -8,13 +8,13 @@ import (
 	"sync"
 
 	log "github.com/sirupsen/logrus"
+
+	"github.com/alexandrst88/terraform-variables-generator/pkg/utils"
 )
 
 var replacer *strings.Replacer
 var varPrefix = "var."
-var tfFileExt = "*.tf"
 
-var dstFile = "./variables.tf"
 var varTemplate = template.Must(template.New("var_file").Parse(`{{range .}}
 variable "{{ . }}" {
   description = ""
@@ -35,17 +35,9 @@ func init() {
 		" ", "",
 	)
 }
-func main() {
-	if fileExists(dstFile) {
-		userPromt()
-	}
 
-	tfFiles, err := getAllFiles(tfFileExt)
-	if len(tfFiles) == 0 {
-		log.Warn("No terraform files to proceed, exiting")
-		os.Exit(0)
-	}
-	checkError(err)
+// GenerateVars will write generated vars to file
+func GenerateVars(tfFiles []string, dstFile string) {
 	var wg sync.WaitGroup
 	messages := make(chan string)
 	wg.Add(len(tfFiles))
@@ -69,11 +61,10 @@ func main() {
 	}()
 	wg.Wait()
 	f, err := os.Create(dstFile)
-	checkError(err)
+	utils.CheckError(err)
 
 	t.sortVars()
 	err = varTemplate.Execute(f, t.Variables)
-	checkError(err)
+	utils.CheckError(err)
 	log.Infof("Variables are generated to %q file", dstFile)
-
 }
diff --git a/pkg/generator/vars_test.go b/pkg/generator/vars_test.go
@@ -1,24 +1,25 @@
-package main
+package generator
 
 import (
 	"bufio"
 	"os"
 	"testing"
+
+	"github.com/alexandrst88/terraform-variables-generator/pkg/utils"
 )
 
-var mockFile = "tf_configuration.mock"
 var testExtFile = "*.mock"
 
 func TestContainsElement(t *testing.T) {
 	testSlice := []string{"Terraform", "Puppet", "Ansible"}
-	if containsElement(testSlice, "Chef") {
+	if utils.ContainsElement(testSlice, "Chef") {
 		t.Error("Should return false, but return true")
 	}
 }
 
 func TestGetAllFiles(t *testing.T) {
-	files, err := getAllFiles(testExtFile)
-	checkError(err)
+	files, err := utils.GetAllFiles(testExtFile)
+	utils.CheckError(err)
 	if len(files) == 0 {
 		t.Error("Should found at least one file")
 	}
@@ -28,8 +29,8 @@ func TestMatchVariable(t *testing.T) {
 	ter := &terraformVars{}
 	var messages []string
 
-	file, err := getAllFiles(testExtFile)
-	checkError(err)
+	file, err := utils.GetAllFiles(testExtFile)
+	utils.CheckError(err)
 
 	fileHandle, _ := os.Open(file[0])
 	defer fileHandle.Close()
diff --git a/pkg/utils/file_utils.go b/pkg/utils/file_utils.go
@@ -1,4 +1,4 @@
-package main
+package utils
 
 import (
 	"os"
@@ -7,21 +7,24 @@ import (
 	log "github.com/sirupsen/logrus"
 )
 
-func getAllFiles(ext string) ([]string, error) {
+// GetAllFiles will get all files in current directory
+func GetAllFiles(ext string) ([]string, error) {
 	dir, err := os.Getwd()
-	checkError(err)
+	CheckError(err)
+
 	var files []string
 	log.Infof("Finding files in %q directory", dir)
 	files, err = filepath.Glob(ext)
-	checkError(err)
+	CheckError(err)
 
 	if len(files) == 0 {
 		log.Infof("No files with %q extensions found in %q", ext, dir)
 	}
 	return files, nil
 }
 
-func fileExists(name string) bool {
+// FileExists checks if file exists
+func FileExists(name string) bool {
 	if _, err := os.Stat(name); err == nil {
 		return true
 	}
diff --git a/pkg/utils/helpers.go b/pkg/utils/helpers.go
@@ -0,0 +1,40 @@
+package utils
+
+import (
+	"fmt"
+	"os"
+
+	log "github.com/sirupsen/logrus"
+)
+
+// CheckError is a convenient wrapper for error check
+func CheckError(e error) {
+	if e != nil {
+		log.Fatal(e)
+	}
+}
+
+// ContainsElement check if slice of strings contains provided string
+func ContainsElement(slice []string, value string) bool {
+	if len(slice) == 0 {
+		return false
+	}
+	for _, s := range slice {
+		if value == s {
+			return true
+		}
+	}
+	return false
+}
+
+// UserPromt will ask user if file needs to be overridden
+func UserPromt(dstFile string) {
+	var response string
+	log.Warnf("File %q already exists, type 'yes' if you want replace it", dstFile)
+	fmt.Print("-> ")
+	_, err := fmt.Scanln(&response)
+	CheckError(err)
+	if response != "yes" {
+		os.Exit(0)
+	}
+}

Original file line number	Diff line number	Diff line change
`@@ -1,9 +1,11 @@`
`1`		`-package main`
	`1`	`+package generator`
`2`	`2`
`3`	`3`	`import (`
`4`	`4`	`"regexp"`
`5`	`5`	`"sort"`
`6`	`6`	`"strings"`
	`7`	`+`
	`8`	`+ "github.com/alexandrst88/terraform-variables-generator/pkg/utils"`
`7`	`9`	`)`
`8`	`10`
`9`	`11`	`type terraformVars struct {`
`@@ -16,13 +18,13 @@ func (t *terraformVars) matchVarPref(row, varPrefix string) {`
`16`	`18`	`match := pattern.FindAllStringSubmatch(row, -1)`
`17`	`19`	`for _, m := range match {`
`18`	`20`	`res := replacer.Replace(m[0])`
`19`		`- if !containsElement(t.Variables, res) {`
	`21`	`+ if !utils.ContainsElement(t.Variables, res) {`
`20`	`22`	`t.Variables = append(t.Variables, res)`
`21`	`23`	`}`
`22`	`24`	`}`
`23`	`25`	`}`
`24`	`26`	`}`
`25`	`27`
`26`	`28`	`func (t *terraformVars) sortVars() {`
`27`		`- sort.Sort(sort.StringSlice(t.Variables))`
	`29`	`+ sort.Strings(t.Variables)`
`28`	`30`	`}`