prompts_test.go

package strumt

import (
	"bufio"
	"bytes"
	"fmt"
	"io"
	"io/ioutil"
	"net"
	"os"
	"strconv"
	"strings"
	"testing"

	"github.com/stretchr/testify/assert"
)

type Datas struct {
	Db struct {
		Username string
		Password string
		Port     int
	}
	Hosts map[string]string
	Ips   []string
}

type StringPrompt struct {
	valuePtr          *string
	prompt            string
	currentID         string
	nextPrompt        string
	nextPromptOnError string
}

func (s *StringPrompt) ID() string {
	return s.currentID
}

func (s *StringPrompt) PromptString() string {
	return s.prompt
}

func (s *StringPrompt) Parse(value string) error {
	if value == "" {
		return fmt.Errorf("Empty value given")
	}

	*(s.valuePtr) = value
	return nil
}

func (s *StringPrompt) NextOnSuccess(value string) string {
	return s.nextPrompt
}

func (s *StringPrompt) NextOnError(err error) string {
	return s.nextPromptOnError
}

type IntPrompt struct {
	valuePtr          *int
	prompt            string
	currentID         string
	nextPrompt        string
	nextPromptOnError string
}

func (s *IntPrompt) ID() string {
	return s.currentID
}

func (s *IntPrompt) PromptString() string {
	return s.prompt
}

func (s *IntPrompt) Parse(value string) error {
	v, err := strconv.Atoi(value)

	if err != nil {
		return fmt.Errorf("Provide a numerical value")
	}

	*(s.valuePtr) = v

	return nil
}

func (s *IntPrompt) NextOnSuccess(value string) string {
	return s.nextPrompt
}

func (s *IntPrompt) NextOnError(err error) string {
	return s.nextPromptOnError
}

type IpsPrompt struct {
	valuePtr          *[]string
	prompt            string
	currentID         string
	nextPrompt        string
	nextPromptOnError string
}

func (s *IpsPrompt) ID() string {
	return s.currentID
}

func (s *IpsPrompt) PromptString() string {
	return s.prompt
}

func (s *IpsPrompt) Parse(values []string) error {
	for _, value := range values {
		if net.ParseIP(value) == nil {
			return fmt.Errorf("%s is not a valid IP", value)
		}
	}

	(*s.valuePtr) = values

	return nil
}

func (s *IpsPrompt) NextOnError(err error) string {
	return s.nextPromptOnError
}

func (s *IpsPrompt) NextOnSuccess(value []string) string {
	return s.nextPrompt
}

type MapPrompt struct {
	valuePtr          *map[string]string
	prompt            string
	currentID         string
	nextPrompt        string
	nextPromptOnError string
}

func (m *MapPrompt) ID() string {
	return m.currentID
}

func (m *MapPrompt) PromptString() string {
	return m.prompt
}

func (m *MapPrompt) Parse(values []string) error {
	for _, data := range values {
		keyValue := strings.Split(data, ":")

		if len(keyValue) != 2 {
			return fmt.Errorf("Check %s is a valid couple key:value", data)
		}

		(*m.valuePtr)[keyValue[0]] = keyValue[1]
	}

	return nil
}

func (m *MapPrompt) NextOnError(err error) string {
	return m.nextPromptOnError
}

func (m *MapPrompt) NextOnSuccess(value []string) string {
	return m.nextPrompt
}

func TestNewPrompts(t *testing.T) {
	p := NewPrompts()

	assert.Equal(t, bufio.NewReader(os.Stdin), p.reader)
	assert.Equal(t, os.Stdout, p.writer)
}

func TestPromptsRun(t *testing.T) {
	actual := &Datas{
		Hosts: map[string]string{},
		Ips:   []string{},
	}

	expected := &Datas{}
	expected.Db.Username = "user"
	expected.Db.Password = "password"
	expected.Db.Port = 10000
	expected.Hosts = map[string]string{
		"localhost": "127.0.0.1",
		"myIp":      "1.2.3.4",
	}
	expected.Ips = []string{
		"127.0.0.1",
		"1.2.3.4",
		"8.9.10.11",
	}

	buf := "\nuser\n\npassword\ntest\n10000\n127.0.0.1\ntest\n1.2.3.4\n8.9.10.11\n\n127.0.0.1\n1.2.3.4\n8.9.10.11\n\nlocalhost:127.0.0.1\ntest\nmyIp:1.2.3.4\n\nlocalhost:127.0.0.1\nmyIp:1.2.3.4\n\n"

	var actualStdout bytes.Buffer

	p := NewPromptsFromReaderAndWriter(bytes.NewBufferString(buf), &actualStdout)

	p.AddLinePrompter(&StringPrompt{&actual.Db.Username, "Give a username : ", "username", "password", "username"})
	p.AddLinePrompter(&StringPrompt{&actual.Db.Password, "Give a password : ", "password", "port", "password"})
	p.AddLinePrompter(&IntPrompt{&actual.Db.Port, "Give a port : ", "port", "ips", "port"})
	p.AddMultilinePrompter(&IpsPrompt{&actual.Ips, "Give some ips : ", "ips", "hosts", "ips"})
	p.AddMultilinePrompter(&MapPrompt{&actual.Hosts, "Give some host/ip couples : ", "hosts", "", "hosts"})

	p.SetFirst("username")
	p.Run()

	expectedStdout := "Give a username : \nEmpty value given\n\n" +
		"Give a username : \n\n" +
		"Give a password : \nEmpty value given\n\n" +
		"Give a password : \n\n" +
		"Give a port : \nProvide a numerical value\n\n" +
		"Give a port : \n\n" +
		"Give some ips : \ntest is not a valid IP\n\n" +
		"Give some ips : \n\n" +
		"Give some host/ip couples : \nCheck test is a valid couple key:value\n\n" +
		"Give some host/ip couples : \n"

	assert.Equal(t, expected, actual)
	assert.Equal(t, expectedStdout, actualStdout.String())
}

type StringWithCustomRendererPrompt struct {
	valuePtr          *string
	prompt            string
	currentID         string
	nextPrompt        string
	nextPromptOnError string
}

func (s *StringWithCustomRendererPrompt) ID() string {
	return s.currentID
}

func (s *StringWithCustomRendererPrompt) PromptString() string {
	return s.prompt
}

func (s *StringWithCustomRendererPrompt) Parse(value string) error {
	if value == "" {
		return fmt.Errorf("empty value given")
	}

	*(s.valuePtr) = value

	return nil
}

func (s *StringWithCustomRendererPrompt) NextOnSuccess(value string) string {
	return s.nextPrompt
}

func (s *StringWithCustomRendererPrompt) NextOnError(err error) string {
	return s.nextPromptOnError
}

func (s *StringWithCustomRendererPrompt) PrintPrompt(w io.Writer, prompt string) {
	fmt.Fprintf(w, "==> %s : \n", prompt)
}

func (s *StringWithCustomRendererPrompt) PrintError(w io.Writer, err error) {
	fmt.Fprintf(w, "==> Something went wrong : %s\n", err.Error())
}

func (s *StringWithCustomRendererPrompt) PrintSeparator(w io.Writer) {
	fmt.Fprintf(w, "\n+++\n")
}

func TestPromptRunWithCustomRenderer(t *testing.T) {
	var actualStdout bytes.Buffer

	p := NewPromptsFromReaderAndWriter(bytes.NewBufferString("\ntest\n"), &actualStdout)

	var value string

	p.AddLinePrompter(&StringWithCustomRendererPrompt{&value, "Give a value", "test", "", "test"})

	p.SetFirst("test")
	p.Run()

	assert.Equal(t, "test", value)
	assert.Equal(t, "==> Give a value : \n==> Something went wrong : empty value given\n\n+++\n==> Give a value : \n", actualStdout.String())

}

func TestPromptsScenario(t *testing.T) {
	buf := "\nuser\n\npassword\ntest\n10000\n127.0.0.1\ntest\n1.2.3.4\n8.9.10.11\n\n127.0.0.1\n1.2.3.4\n8.9.10.11\n\nlocalhost:127.0.0.1\ntest\nmyIp:1.2.3.4\n\nlocalhost:127.0.0.1\nmyIp:1.2.3.4\n\n"

	p := NewPromptsFromReaderAndWriter(bytes.NewBufferString(buf), ioutil.Discard)

	p.AddLinePrompter(&StringPrompt{new(string), "Give a username", "username", "password", "username"})
	p.AddLinePrompter(&StringPrompt{new(string), "Give a password", "password", "port", "password"})
	p.AddLinePrompter(&IntPrompt{new(int), "Give a port", "port", "ips", "port"})
	p.AddMultilinePrompter(&IpsPrompt{&[]string{}, "Give some ips", "ips", "hosts", "ips"})
	p.AddMultilinePrompter(&MapPrompt{&map[string]string{}, "Give some host/ip couples", "hosts", "", "hosts"})

	p.SetFirst("username")
	p.Run()

	expectedScenario := []Step{
		{
			"Give a username",
			[]string{""},
			fmt.Errorf("Empty value given"),
		},
		{
			"Give a username",
			[]string{"user"},
			nil,
		},
		{
			"Give a password",
			[]string{""},
			fmt.Errorf("Empty value given"),
		},
		{
			"Give a password",
			[]string{"password"},
			nil,
		},
		{
			"Give a port",
			[]string{"test"},
			fmt.Errorf("Provide a numerical value"),
		},
		{
			"Give a port",
			[]string{"10000"},
			nil,
		},
		{
			"Give some ips",
			[]string{
				"127.0.0.1",
				"test",
				"1.2.3.4",
				"8.9.10.11",
			},
			fmt.Errorf("test is not a valid IP"),
		},
		{
			"Give some ips",
			[]string{
				"127.0.0.1",
				"1.2.3.4",
				"8.9.10.11",
			},
			nil,
		},
		{
			"Give some host/ip couples",
			[]string{
				"localhost:127.0.0.1",
				"test",
				"myIp:1.2.3.4",
			},
			fmt.Errorf("Check test is a valid couple key:value"),
		},
		{
			"Give some host/ip couples",
			[]string{
				"localhost:127.0.0.1",
				"myIp:1.2.3.4",
			},
			nil,
		},
	}

	actualScenario := p.Scenario()

	for i, step := range expectedScenario {
		assert.Equal(t, step.PromptString(), actualScenario[i].prompt)
		assert.Equal(t, step.Inputs(), actualScenario[i].inputs)

		if step.Error() != nil {
			assert.EqualError(t, actualScenario[i].err, step.err.Error())
		} else {
			assert.NoError(t, actualScenario[i].err)
		}
	}
}