Add validation with regex in the config.json inputs (#512)

* adding regex type config.json Signed-off-by: JoaoDanielRufino <[email protected]> * fixing textValidatorMock Signed-off-by: JoaoDanielRufino <[email protected]> * adding textValidatorMock to runner_test Signed-off-by: JoaoDanielRufino <[email protected]> * adding textValidatorMock to local/runner_test Signed-off-by: JoaoDanielRufino <[email protected]> * adding tests Signed-off-by: JoaoDanielRufino <[email protected]> * adding validation function to check if there is regex Signed-off-by: JoaoDanielRufino <[email protected]> * adding tests Signed-off-by: JoaoDanielRufino <[email protected]> * checking error on textRegexValidator Signed-off-by: JoaoDanielRufino <[email protected]> * simplifying code Signed-off-by: JoaoDanielRufino <[email protected]> * adding table test Signed-off-by: JoaoDanielRufino <[email protected]> * removing comments Signed-off-by: JoaoDanielRufino <[email protected]> * fixing regex when required is false Signed-off-by: JoaoDanielRufino <[email protected]> * simplifying the code Signed-off-by: JoaoDanielRufino <[email protected]> * simplifying the code Signed-off-by: JoaoDanielRufino <[email protected]> * fixing regex when there is default value Signed-off-by: JoaoDanielRufino <[email protected]> * dynamic parameter to inputValidatorMock Signed-off-by: JoaoDanielRufino <[email protected]>
ZupIT · Oct 5, 2020 · 48f1baa · 48f1baa
1 parent 5855b88
commit 48f1baa
Show file tree

Hide file tree

Showing 6 changed files with 289 additions and 110 deletions.
diff --git a/cmd/main.go b/cmd/main.go
@@ -141,7 +141,7 @@ func buildCommands() *cobra.Command {
 	formulaLocalBuilder := builder.NewBuildLocal(ritchieHomeDir, dirManager, fileManager, treeGen)
 
 	postRunner := runner.NewPostRunner(fileManager, dirManager)
-	inputManager := runner.NewInput(envResolvers, fileManager, inputList, inputText, inputBool, inputPassword)
+	inputManager := runner.NewInput(envResolvers, fileManager, inputList, inputText, inputTextValidator, inputBool, inputPassword)
 
 	formulaLocalPreRun := local.NewPreRun(ritchieHomeDir, formBuildMake, formBuildBat, formBuildSh, dirManager, fileManager)
 	formulaLocalRun := local.NewRunner(postRunner, inputManager, formulaLocalPreRun, fileManager, ctxFinder, userHomeDir)

diff --git a/pkg/formula/formula.go b/pkg/formula/formula.go
@@ -49,10 +49,15 @@ type (
 		Items     []string  `json:"items"`
 		Cache     Cache     `json:"cache"`
 		Condition Condition `json:"condition"`
+		Pattern   Pattern   `json:"pattern"`
 		Tutorial  string    `json:"tutorial"`
 		Required  *bool     `json:"required"`
 	}
 
+	Pattern struct {
+		Regex        string `json:"regex"`
+		MismatchText string `json:"mismatchText"`
+	}
 	Cache struct {
 		Active   bool   `json:"active"`
 		Qty      int    `json:"qty"`

diff --git a/pkg/formula/runner/docker/runner_test.go b/pkg/formula/runner/docker/runner_test.go
@@ -52,7 +52,7 @@ func TestRun(t *testing.T) {
 	ctxFinder := rcontext.NewFinder(ritHome, fileManager)
 	preRunner := NewPreRun(ritHome, dockerBuilder, dirManager, fileManager)
 	postRunner := runner.NewPostRunner(fileManager, dirManager)
-	inputRunner := runner.NewInput(env.Resolvers{"CREDENTIAL": envResolverMock{in: "test"}}, fileManager, inputMock{}, inputMock{}, inputMock{}, inputMock{})
+	inputRunner := runner.NewInput(env.Resolvers{"CREDENTIAL": envResolverMock{in: "test"}}, fileManager, inputMock{}, inputMock{}, inputTextValidatorMock{str: "test"}, inputMock{}, inputMock{})
 
 	type in struct {
 		def         formula.Definition
@@ -220,6 +220,14 @@ func (e envResolverMock) Resolve(string) (string, error) {
 	return e.in, e.err
 }
 
+type inputTextValidatorMock struct {
+	str string
+}
+
+func (i inputTextValidatorMock) Text(name string, validate func(interface{}) error, helper ...string) (string, error) {
+	return i.str, nil
+}
+
 type inputMock struct {
 	text    string
 	boolean bool

diff --git a/pkg/formula/runner/inputs.go b/pkg/formula/runner/inputs.go
@@ -18,8 +18,10 @@ package runner
 
 import (
 	"encoding/json"
+	"errors"
 	"fmt"
 	"os/exec"
+	"regexp"
 	"strconv"
 	"strings"
 
@@ -45,6 +47,7 @@ type InputManager struct {
 	file         stream.FileWriteReadExister
 	prompt.InputList
 	prompt.InputText
+	prompt.InputTextValidator
 	prompt.InputBool
 	prompt.InputPassword
 }
@@ -54,16 +57,18 @@ func NewInput(
 	file stream.FileWriteReadExister,
 	inList prompt.InputList,
 	inText prompt.InputText,
+	inTextValidator prompt.InputTextValidator,
 	inBool prompt.InputBool,
 	inPass prompt.InputPassword,
 ) formula.InputRunner {
 	return InputManager{
-		envResolvers:  env,
-		file:          file,
-		InputList:     inList,
-		InputText:     inText,
-		InputBool:     inBool,
-		InputPassword: inPass,
+		envResolvers:       env,
+		file:               file,
+		InputList:          inList,
+		InputText:          inText,
+		InputTextValidator: inTextValidator,
+		InputBool:          inBool,
+		InputPassword:      inPass,
 	}
 }
 
@@ -134,12 +139,7 @@ func (in InputManager) fromPrompt(cmd *exec.Cmd, setup formula.Setup) error {
 			if items != nil {
 				inputVal, err = in.loadInputValList(items, input)
 			} else {
-				validate := isRequired(input)
-				inputVal, err = in.Text(input.Label, validate, input.Tutorial)
-
-				if inputVal == "" {
-					inputVal = input.Default
-				}
+				inputVal, err = in.textValidator(input)
 			}
 		case "bool":
 			valBool, err = in.Bool(input.Label, items, input.Tutorial)
@@ -207,14 +207,12 @@ func (in InputManager) loadInputValList(items []string, input formula.Input) (st
 		}
 		items = append(items, newLabel)
 	}
+
 	inputVal, err := in.List(input.Label, items, input.Tutorial)
 	if inputVal == newLabel {
-		validate := isRequired(input)
-		inputVal, err = in.Text(input.Label, validate, input.Tutorial)
-		if len(inputVal) == 0 {
-			inputVal = input.Default
-		}
+		return in.textValidator(input)
 	}
+
 	return inputVal, err
 }
 
@@ -256,6 +254,24 @@ func (in InputManager) resolveIfReserved(input formula.Input) (string, error) {
 	return "", nil
 }
 
+func (in InputManager) textValidator(input formula.Input) (string, error) {
+	required := isRequired(input)
+	var inputVal string
+	var err error
+
+	if in.hasRegex(input) {
+		inputVal, err = in.textRegexValidator(input, required)
+	} else {
+		inputVal, err = in.InputText.Text(input.Label, required, input.Tutorial)
+	}
+
+	if inputVal == "" {
+		inputVal = input.Default
+	}
+
+	return inputVal, err
+}
+
 func isRequired(input formula.Input) bool {
 	if input.Required == nil {
 		return input.Default == ""
@@ -305,3 +321,18 @@ func (in InputManager) verifyConditional(cmd *exec.Cmd, input formula.Input) (bo
 		)
 	}
 }
+
+func (in InputManager) hasRegex(input formula.Input) bool {
+	return len(input.Pattern.Regex) > 0
+}
+
+func (in InputManager) textRegexValidator(input formula.Input, required bool) (string, error) {
+	return in.InputTextValidator.Text(input.Label, func(text interface{}) error {
+		re := regexp.MustCompile(input.Pattern.Regex)
+		if re.MatchString(text.(string)) || (!required && text.(string) == "") {
+			return nil
+		}
+
+		return errors.New(input.Pattern.MismatchText)
+	})
+}