fixup! info: guide to obtain credentials

commitdev · Jul 8, 2020 · 8d25ccb · 8d25ccb
1 parent 4f038f2
commit 8d25ccb
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 14 deletions.
diff --git a/internal/config/moduleconfig/module_config.go b/internal/config/moduleconfig/module_config.go
@@ -23,6 +23,7 @@ type Parameter struct {
 	Execute string   `yaml:"execute,omitempty"`
 	Value   string   `yaml:"value,omitempty"`
 	Default string   `yaml:"default,omitempty"`
+	Info    string   `yaml:"info,omitempty"`
 }
 
 type TemplateConfig struct {

diff --git a/internal/init/init.go b/internal/init/init.go
@@ -237,11 +237,11 @@ func mapVendorToPrompts(projectCred globalconfig.ProjectCredential, vendor strin
 					Field:   "accessKeyId",
 					Label:   "AWS Access Key ID",
 					Default: projectCred.AWSResourceConfig.AccessKeyID,
+					Info: `AWS Access Key ID/Secret: used for provisioning infrastructure in AWS
+The token can be generated at https://console.aws.amazon.com/iam/home?#/security_credentials`,
 				},
 				Condition: CustomCondition(customAwsMustInputCondition),
 				Validate:  ValidateAKID,
-				Info: `AWS Access Key ID/Secret: used for provisioning infrastructure in AWS
-The token can be generated at https://console.aws.amazon.com/iam/home?#/security_credentials`,
 			},
 			{
 				Parameter: moduleconfig.Parameter{
@@ -260,12 +260,12 @@ The token can be generated at https://console.aws.amazon.com/iam/home?#/security
 				Field:   "accessToken",
 				Label:   "Github Personal Access Token with access to the above organization",
 				Default: projectCred.GithubResourceConfig.AccessToken,
+				Info: `Github personal access token: used for creating repositories for your project
+Requires the following permissions: [repo::public_repo, admin::orgread:org]
+The token can be created at https://github.com/settings/tokens`,
 			},
 			Condition: NoCondition,
 			Validate:  NoValidation,
-			Info: `Github personal access token: used for creating repositories for your project
-Requires the following permissions: [repo::public_repo, admin::orgread:org]
-The token can be created at https://github.com/settings/tokens`,
 		}
 		prompts = append(prompts, githubPrompt)
 	case "circleci":
@@ -274,11 +274,11 @@ The token can be created at https://github.com/settings/tokens`,
 				Field:   "apiKey",
 				Label:   "Circleci api key for CI/CD",
 				Default: projectCred.CircleCiResourceConfig.ApiKey,
+				Info: `CircleCI api token: used for setting up CI/CD for your project
+The token can be created at https://app.circleci.com/settings/user/tokens`,
 			},
 			Condition: NoCondition,
 			Validate:  NoValidation,
-			Info: `CircleCI api token: used for setting up CI/CD for your project
-The token can be created at https://app.circleci.com/settings/user/tokens`,
 		}
 		prompts = append(prompts, circleCiPrompt)
 	}

diff --git a/internal/init/prompts.go b/internal/init/prompts.go
@@ -30,7 +30,6 @@ type PromptHandler struct {
 	moduleconfig.Parameter
 	Condition CustomConditionSignature
 	Validate  func(string) error
-	Info      string
 }
 
 type CredentialPrompts struct {
@@ -95,8 +94,8 @@ func (p PromptHandler) GetParam(projectParams map[string]string) string {
 	var result string
 
 	if p.Condition(projectParams) {
-		if p.Info != "" {
-			flog.Guidef(p.Info)
+		if p.Parameter.Info != "" {
+			flog.Guidef(p.Parameter.Info)
 		}
 		// TODO: figure out scope of projectParams per project
 		// potentially dangerous to have cross module env leaking

diff --git a/internal/init/prompts_test.go b/internal/init/prompts_test.go
@@ -12,7 +12,6 @@ import (
 
 func TestGetParam(t *testing.T) {
 
-	promptInfo := ""
 	projectParams := map[string]string{}
 	t.Run("Should execute params without prompt", func(t *testing.T) {
 		param := moduleconfig.Parameter{
@@ -24,7 +23,6 @@ func TestGetParam(t *testing.T) {
 			param,
 			initPrompts.NoCondition,
 			initPrompts.NoValidation,
-			promptInfo,
 		}
 
 		result := prompt.GetParam(projectParams)
@@ -41,7 +39,6 @@ func TestGetParam(t *testing.T) {
 			param,
 			initPrompts.NoCondition,
 			initPrompts.NoValidation,
-			promptInfo,
 		}
 
 		result := prompt.GetParam(map[string]string{
@@ -60,7 +57,6 @@ func TestGetParam(t *testing.T) {
 			param,
 			initPrompts.NoCondition,
 			initPrompts.NoValidation,
-			promptInfo,
 		}
 
 		result := prompt.GetParam(projectParams)