Merge pull request #146 from commitdev/reorganize-config-code

Reorganize config code by moving different config types into better-n…

cmd/apply.go

@@ -4,7 +4,7 @@ import (
 	"fmt"
 	"log"
 
-	"github.com/commitdev/zero/configs"
+	"github.com/commitdev/zero/internal/constants"
 	"github.com/commitdev/zero/pkg/util/exit"
 	"github.com/manifoldco/promptui"
 	"github.com/spf13/cobra"
@@ -14,7 +14,7 @@ var applyConfigPath string
 var applyEnvironments []string
 
 func init() {
-	applyCmd.PersistentFlags().StringVarP(&applyConfigPath, "config", "c", configs.ZeroProjectYml, "config path")
+	applyCmd.PersistentFlags().StringVarP(&applyConfigPath, "config", "c", constants.ZeroProjectYml, "config path")
 	applyCmd.PersistentFlags().StringSliceVarP(&applyEnvironments, "env", "e", []string{}, "environments to set up (staging, production) - specify multiple times for multiple")
 
 	rootCmd.AddCommand(applyCmd)

cmd/init.go

@@ -1,7 +1,7 @@
 package cmd
 
 import (
-	"github.com/commitdev/zero/internal/config"
+	"github.com/commitdev/zero/internal/config/projectconfig"
 	"github.com/commitdev/zero/internal/context"
 	"github.com/commitdev/zero/pkg/util/exit"
 	"github.com/spf13/cobra"
@@ -20,7 +20,7 @@ var initCmd = &cobra.Command{
 		}
 
 		projectName := args[0]
-		projectContext := context.Init(projectName, config.RootDir)
-		config.Init(config.RootDir, projectName, projectContext)
+		projectContext := context.Init(projectName, projectconfig.RootDir)
+		projectconfig.Init(projectconfig.RootDir, projectName, projectContext)
 	},
 }

internal/api/generate_api.go

@@ -5,7 +5,7 @@ import (
 	"log"
 	"net/http"
 
-	"github.com/commitdev/zero/internal/config"
+	"github.com/commitdev/zero/internal/config/projectconfig"
 	"github.com/gorilla/handlers"
 	"github.com/gorilla/mux"
 )
@@ -15,13 +15,13 @@ func generateProject(w http.ResponseWriter, req *http.Request) {
 	switch req.Method {
 	case "POST":
 		decoder := json.NewDecoder(req.Body)
-		var projectConfig config.ZeroProjectConfig
-		err := decoder.Decode(&projectConfig)
+		var config projectconfig.ZeroProjectConfig
+		err := decoder.Decode(&config)
 		if err != nil {
 			panic(err)
 		}
-		log.Println(projectConfig.Name)
-		// createProject(projectConfig)
+		log.Println(config.Name)
+		// createProject(config)
 		w.WriteHeader(http.StatusCreated)
 		w.Write([]byte(`{"message": "Post successful"}`))
 

internal/config/global_config.go → internal/config/globalconfig/global_config.go

@@ -1,4 +1,4 @@
-package config
+package globalconfig
 
 import (
 	"bytes"
@@ -8,7 +8,7 @@ import (
 	"os/user"
 	"path"
 
-	"github.com/commitdev/zero/configs"
+	"github.com/commitdev/zero/internal/constants"
 	"github.com/commitdev/zero/pkg/util/exit"
 	yaml "gopkg.in/yaml.v2"
 )
@@ -69,9 +69,9 @@ func getCredentialsPath() string {
 		exit.Fatal("Failed to get user directory path: %v", err)
 	}
 
-	rootDir := path.Join(usr.HomeDir, configs.ZeroHomeDirectory)
+	rootDir := path.Join(usr.HomeDir, constants.ZeroHomeDirectory)
 	os.MkdirAll(rootDir, os.ModePerm)
-	filePath := path.Join(rootDir, configs.UserCredentials)
+	filePath := path.Join(rootDir, constants.UserCredentialsYml)
 	return filePath
 }
 

internal/config/global_config_test.go → internal/config/globalconfig/global_config_test.go

@@ -1,4 +1,4 @@
-package config_test
+package globalconfig_test
 
 import (
 	"fmt"
@@ -8,11 +8,11 @@ import (
 	"path"
 	"testing"
 
-	"github.com/commitdev/zero/internal/config"
+	"github.com/commitdev/zero/internal/config/globalconfig"
 	"github.com/stretchr/testify/assert"
 )
 
-const baseTestFixturesDir = "../../tests/test_data/configs/"
+const baseTestFixturesDir = "../../../tests/test_data/configs/"
 
 var testCredentialFile = func() (func() string, func()) {
 	tmpConfigPath := getTmpConfig()
@@ -40,16 +40,16 @@ func copyFile(from string, to string) {
 	}
 }
 func TestReadOrCreateUserCredentialsFile(t *testing.T) {
-	config.GetCredentialsPath = func() string {
+	globalconfig.GetCredentialsPath = func() string {
 		return path.Join(baseTestFixturesDir, "does-not-exist.yml")
 	}
-	credPath := config.GetCredentialsPath()
+	credPath := globalconfig.GetCredentialsPath()
 
 	defer os.RemoveAll(credPath)
 	_, fileStateErr := os.Stat(credPath)
 	assert.True(t, os.IsNotExist(fileStateErr), "File should not exist")
 	// attempting to read the file should create the file
-	config.GetUserCredentials("any-project")
+	globalconfig.GetUserCredentials("any-project")
 
 	stats, err := os.Stat(credPath)
 	assert.False(t, os.IsNotExist(err), "File should be created")
@@ -58,12 +58,12 @@ func TestReadOrCreateUserCredentialsFile(t *testing.T) {
 
 func TestGetUserCredentials(t *testing.T) {
 	var teardownFn func()
-	config.GetCredentialsPath, teardownFn = testCredentialFile()
+	globalconfig.GetCredentialsPath, teardownFn = testCredentialFile()
 	defer teardownFn()
 
 	t.Run("Fixture file should have existing project with creds", func(t *testing.T) {
 		projectName := "my-project"
-		project := config.GetUserCredentials(projectName)
+		project := globalconfig.GetUserCredentials(projectName)
 
 		// Reading from fixtures: tests/test_data/configs/credentials.yml
 		assert.Equal(t, "AKIAABCD", project.AWSResourceConfig.AccessKeyId)
@@ -74,30 +74,30 @@ func TestGetUserCredentials(t *testing.T) {
 
 	t.Run("Fixture file should support multiple projects", func(t *testing.T) {
 		projectName := "another-project"
-		project := config.GetUserCredentials(projectName)
+		project := globalconfig.GetUserCredentials(projectName)
 		assert.Equal(t, "654", project.GithubResourceConfig.AccessToken)
 	})
 }
 
 func TestEditUserCredentials(t *testing.T) {
 	var teardownFn func()
-	config.GetCredentialsPath, teardownFn = testCredentialFile()
+	globalconfig.GetCredentialsPath, teardownFn = testCredentialFile()
 	defer teardownFn()
 
 	t.Run("Should create new project if not exist", func(t *testing.T) {
 		projectName := "test-project3"
-		project := config.GetUserCredentials(projectName)
+		project := globalconfig.GetUserCredentials(projectName)
 		project.AWSResourceConfig.AccessKeyId = "TEST_KEY_ID_1"
-		config.Save(project)
-		newKeyID := config.GetUserCredentials(projectName).AWSResourceConfig.AccessKeyId
+		globalconfig.Save(project)
+		newKeyID := globalconfig.GetUserCredentials(projectName).AWSResourceConfig.AccessKeyId
 		assert.Equal(t, "TEST_KEY_ID_1", newKeyID)
 	})
 	t.Run("Should edit old project if already exist", func(t *testing.T) {
 		projectName := "my-project"
-		project := config.GetUserCredentials(projectName)
+		project := globalconfig.GetUserCredentials(projectName)
 		project.AWSResourceConfig.AccessKeyId = "EDITED_ACCESS_KEY_ID"
-		config.Save(project)
-		newKeyID := config.GetUserCredentials(projectName).AWSResourceConfig.AccessKeyId
+		globalconfig.Save(project)
+		newKeyID := globalconfig.GetUserCredentials(projectName).AWSResourceConfig.AccessKeyId
 		assert.Equal(t, "EDITED_ACCESS_KEY_ID", newKeyID)
 	})
 }

internal/config/module_config.go → internal/config/moduleconfig/module_config.go

@@ -1,4 +1,4 @@
-package config
+package moduleconfig
 
 import (
 	"io/ioutil"

internal/config/init.go → internal/config/projectconfig/init.go

@@ -1,11 +1,11 @@
-package config
+package projectconfig
 
 import (
 	"fmt"
 	"io/ioutil"
 	"path"
 
-	"github.com/commitdev/zero/configs"
+	"github.com/commitdev/zero/internal/constants"
 	"github.com/commitdev/zero/pkg/util/exit"
 )
 
@@ -36,8 +36,8 @@ func Init(dir string, projectName string, projectContext *ZeroProjectConfig) {
 	// TODO: template the zero-project.yml with projectContext
 	content := []byte(fmt.Sprintf(exampleConfig, projectName))
 
-	err := ioutil.WriteFile(path.Join(dir, projectName, configs.ZeroProjectYml), content, 0644)
+	err := ioutil.WriteFile(path.Join(dir, projectName, constants.ZeroProjectYml), content, 0644)
 	if err != nil {
-		exit.Fatal(fmt.Sprintf("Failed to create example %s", configs.ZeroProjectYml))
+		exit.Fatal(fmt.Sprintf("Failed to create example %s", constants.ZeroProjectYml))
 	}
 }

internal/config/projectconfig/init_test.go

@@ -0,0 +1,32 @@
+package projectconfig_test
+
+import (
+	"os"
+	"path"
+	"testing"
+
+	"github.com/commitdev/zero/internal/config/projectconfig"
+	"github.com/commitdev/zero/internal/constants"
+)
+
+func TestInit(t *testing.T) {
+	const testDir = "../../test-sandbox"
+	projectName := "test-project"
+
+	projectconfig.SetRootDir(testDir)
+	defer os.RemoveAll(testDir)
+
+	testDirPath := path.Join(projectconfig.RootDir, projectName)
+	// create sandbox dir
+	err := os.MkdirAll(testDirPath, os.ModePerm)
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	config := projectconfig.ZeroProjectConfig{}
+	projectconfig.Init(projectconfig.RootDir, projectName, &config)
+
+	if _, err := os.Stat(path.Join(testDirPath, constants.ZeroProjectYml)); err != nil {
+		t.Fatal(err)
+	}
+}

internal/config/context_config.go → internal/config/projectconfig/project_config.go

@@ -1,4 +1,4 @@
-package config
+package projectconfig
 
 import (
 	"io/ioutil"

internal/constants/constants.go

@@ -0,0 +1,11 @@
+package constants
+
+const (
+	TemplatesDir       = "tmp/templates"
+	ZeroProjectYml     = "zero-project.yml"
+	ZeroModuleYml      = "zero-module.yml"
+	UserCredentialsYml = "credentials.yml"
+	ZeroHomeDirectory  = ".zero"
+	IgnoredPaths       = "(?i)zero.module.yml|.git/"
+	TemplateExtn       = ".tmpl"
+)

internal/context/init.go

@@ -10,6 +10,8 @@ import (
 	"github.com/aws/aws-sdk-go/aws/session"
 	"github.com/aws/aws-sdk-go/service/sts"
 	"github.com/commitdev/zero/internal/config"
+	"github.com/commitdev/zero/internal/config/globalconfig"
+	"github.com/commitdev/zero/internal/config/projectconfig"
 	"github.com/commitdev/zero/internal/module"
 	project "github.com/commitdev/zero/pkg/credentials"
 	"github.com/commitdev/zero/pkg/util/exit"
@@ -20,7 +22,7 @@ import (
 type Registry map[string][]string
 
 // Create cloud provider context
-func Init(projectName string, outDir string) *config.ZeroProjectConfig {
+func Init(projectName string, outDir string) *projectconfig.ZeroProjectConfig {
 	rootDir := path.Join(outDir, projectName)
 	flog.Infof(":tada: Creating project %s.", projectName)
 
@@ -51,7 +53,7 @@ func Init(projectName string, outDir string) *config.ZeroProjectConfig {
 	return &projectConfig
 }
 
-func promptAllModules(projectConfig *config.ZeroProjectConfig) {
+func promptAllModules(projectConfig *projectconfig.ZeroProjectConfig) {
 	// TODO: do we need to run through the modules and extract first
 	// or we need to run through twice, potentially still need to pre-process for global auths
 	for _, moduleSource := range projectConfig.Modules {
@@ -93,7 +95,7 @@ func promptGithubRootOrg() string {
 func promptGithubPersonalToken(projectName string) string {
 	defaultToken := ""
 
-	project := config.GetUserCredentials(projectName)
+	project := globalconfig.GetUserCredentials(projectName)
 	if project.GithubResourceConfig.AccessToken != "" {
 		defaultToken = project.GithubResourceConfig.AccessToken
 	}
@@ -110,7 +112,7 @@ func promptGithubPersonalToken(projectName string) string {
 	// If its different from saved token, update it
 	if project.GithubResourceConfig.AccessToken != result {
 		project.GithubResourceConfig.AccessToken = result
-		config.Save(project)
+		globalconfig.Save(project)
 	}
 	return result
 }
@@ -128,7 +130,7 @@ func promptProjectName(projectName string) string {
 	return result
 }
 
-func chooseCloudProvider(projectConfig *config.ZeroProjectConfig) {
+func chooseCloudProvider(projectConfig *projectconfig.ZeroProjectConfig) {
 	// @TODO move options into configs
 	providerPrompt := promptui.Select{
 		Label: "Select Cloud Provider",
@@ -180,7 +182,7 @@ func chooseStack(registry Registry) []string {
 
 }
 
-func fillProviderDetails(projectConfig *config.ZeroProjectConfig, s project.Secrets) {
+func fillProviderDetails(projectConfig *projectconfig.ZeroProjectConfig, s project.Secrets) {
 	if projectConfig.Infrastructure.AWS != nil {
 		sess, err := session.NewSession(&aws.Config{
 			Region:      aws.String(projectConfig.Infrastructure.AWS.Region),
@@ -208,10 +210,10 @@ func fillProviderDetails(projectConfig *config.ZeroProjectConfig, s project.Secr
 	}
 }
 
-func defaultProjConfig(projectName string) config.ZeroProjectConfig {
-	return config.ZeroProjectConfig{
+func defaultProjConfig(projectName string) projectconfig.ZeroProjectConfig {
+	return projectconfig.ZeroProjectConfig{
 		Name: projectName,
-		Infrastructure: config.Infrastructure{
+		Infrastructure: projectconfig.Infrastructure{
 			AWS: nil,
 		},
 		Context: map[string]string{},