mirror of https://github.com/coder/coder.git
227 lines
5.6 KiB
Go
227 lines
5.6 KiB
Go
package cliui_test
|
|
|
|
import (
|
|
"bytes"
|
|
"context"
|
|
"io"
|
|
"os"
|
|
"os/exec"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"github.com/coder/coder/cli/clibase"
|
|
"github.com/coder/coder/cli/cliui"
|
|
"github.com/coder/coder/pty"
|
|
"github.com/coder/coder/pty/ptytest"
|
|
"github.com/coder/coder/testutil"
|
|
)
|
|
|
|
func TestPrompt(t *testing.T) {
|
|
t.Parallel()
|
|
t.Run("Success", func(t *testing.T) {
|
|
t.Parallel()
|
|
ptty := ptytest.New(t)
|
|
msgChan := make(chan string)
|
|
go func() {
|
|
resp, err := newPrompt(ptty, cliui.PromptOptions{
|
|
Text: "Example",
|
|
}, nil)
|
|
assert.NoError(t, err)
|
|
msgChan <- resp
|
|
}()
|
|
ptty.ExpectMatch("Example")
|
|
ptty.WriteLine("hello")
|
|
require.Equal(t, "hello", <-msgChan)
|
|
})
|
|
|
|
t.Run("Confirm", func(t *testing.T) {
|
|
t.Parallel()
|
|
ptty := ptytest.New(t)
|
|
doneChan := make(chan string)
|
|
go func() {
|
|
resp, err := newPrompt(ptty, cliui.PromptOptions{
|
|
Text: "Example",
|
|
IsConfirm: true,
|
|
}, nil)
|
|
assert.NoError(t, err)
|
|
doneChan <- resp
|
|
}()
|
|
ptty.ExpectMatch("Example")
|
|
ptty.WriteLine("yes")
|
|
require.Equal(t, "yes", <-doneChan)
|
|
})
|
|
|
|
t.Run("Skip", func(t *testing.T) {
|
|
t.Parallel()
|
|
ptty := ptytest.New(t)
|
|
var buf bytes.Buffer
|
|
|
|
// Copy all data written out to a buffer. When we close the ptty, we can
|
|
// no longer read from the ptty.Output(), but we can read what was
|
|
// written to the buffer.
|
|
dataRead, doneReading := context.WithTimeout(context.Background(), testutil.WaitShort)
|
|
go func() {
|
|
// This will throw an error sometimes. The underlying ptty
|
|
// has its own cleanup routines in t.Cleanup. Instead of
|
|
// trying to control the close perfectly, just let the ptty
|
|
// double close. This error isn't important, we just
|
|
// want to know the ptty is done sending output.
|
|
_, _ = io.Copy(&buf, ptty.Output())
|
|
doneReading()
|
|
}()
|
|
|
|
doneChan := make(chan string)
|
|
go func() {
|
|
resp, err := newPrompt(ptty, cliui.PromptOptions{
|
|
Text: "ShouldNotSeeThis",
|
|
IsConfirm: true,
|
|
}, func(inv *clibase.Invocation) {
|
|
inv.Command.Options = append(inv.Command.Options, cliui.SkipPromptOption())
|
|
inv.Args = []string{"-y"}
|
|
})
|
|
assert.NoError(t, err)
|
|
doneChan <- resp
|
|
}()
|
|
|
|
require.Equal(t, "yes", <-doneChan)
|
|
// Close the reader to end the io.Copy
|
|
require.NoError(t, ptty.Close(), "close eof reader")
|
|
// Wait for the IO copy to finish
|
|
<-dataRead.Done()
|
|
// Timeout error means the output was hanging
|
|
require.ErrorIs(t, dataRead.Err(), context.Canceled, "should be canceled")
|
|
require.Len(t, buf.Bytes(), 0, "expect no output")
|
|
})
|
|
t.Run("JSON", func(t *testing.T) {
|
|
t.Parallel()
|
|
ptty := ptytest.New(t)
|
|
doneChan := make(chan string)
|
|
go func() {
|
|
resp, err := newPrompt(ptty, cliui.PromptOptions{
|
|
Text: "Example",
|
|
}, nil)
|
|
assert.NoError(t, err)
|
|
doneChan <- resp
|
|
}()
|
|
ptty.ExpectMatch("Example")
|
|
ptty.WriteLine("{}")
|
|
require.Equal(t, "{}", <-doneChan)
|
|
})
|
|
|
|
t.Run("BadJSON", func(t *testing.T) {
|
|
t.Parallel()
|
|
ptty := ptytest.New(t)
|
|
doneChan := make(chan string)
|
|
go func() {
|
|
resp, err := newPrompt(ptty, cliui.PromptOptions{
|
|
Text: "Example",
|
|
}, nil)
|
|
assert.NoError(t, err)
|
|
doneChan <- resp
|
|
}()
|
|
ptty.ExpectMatch("Example")
|
|
ptty.WriteLine("{a")
|
|
require.Equal(t, "{a", <-doneChan)
|
|
})
|
|
|
|
t.Run("MultilineJSON", func(t *testing.T) {
|
|
t.Parallel()
|
|
ptty := ptytest.New(t)
|
|
doneChan := make(chan string)
|
|
go func() {
|
|
resp, err := newPrompt(ptty, cliui.PromptOptions{
|
|
Text: "Example",
|
|
}, nil)
|
|
assert.NoError(t, err)
|
|
doneChan <- resp
|
|
}()
|
|
ptty.ExpectMatch("Example")
|
|
ptty.WriteLine(`{
|
|
"test": "wow"
|
|
}`)
|
|
require.Equal(t, `{"test":"wow"}`, <-doneChan)
|
|
})
|
|
}
|
|
|
|
func newPrompt(ptty *ptytest.PTY, opts cliui.PromptOptions, invOpt func(inv *clibase.Invocation)) (string, error) {
|
|
value := ""
|
|
cmd := &clibase.Cmd{
|
|
Handler: func(inv *clibase.Invocation) error {
|
|
var err error
|
|
value, err = cliui.Prompt(inv, opts)
|
|
return err
|
|
},
|
|
}
|
|
|
|
inv := cmd.Invoke()
|
|
// Optionally modify the cmd
|
|
if invOpt != nil {
|
|
invOpt(inv)
|
|
}
|
|
inv.Stdout = ptty.Output()
|
|
inv.Stderr = ptty.Output()
|
|
inv.Stdin = ptty.Input()
|
|
return value, inv.WithContext(context.Background()).Run()
|
|
}
|
|
|
|
func TestPasswordTerminalState(t *testing.T) {
|
|
if os.Getenv("TEST_SUBPROCESS") == "1" {
|
|
passwordHelper()
|
|
return
|
|
}
|
|
t.Parallel()
|
|
|
|
ptty := ptytest.New(t)
|
|
ptyWithFlags, ok := ptty.PTY.(pty.WithFlags)
|
|
if !ok {
|
|
t.Skip("unable to check PTY local echo on this platform")
|
|
}
|
|
|
|
cmd := exec.Command(os.Args[0], "-test.run=TestPasswordTerminalState") //nolint:gosec
|
|
cmd.Env = append(os.Environ(), "TEST_SUBPROCESS=1")
|
|
// connect the child process's stdio to the PTY directly, not via a pipe
|
|
cmd.Stdin = ptty.Input().Reader
|
|
cmd.Stdout = ptty.Output().Writer
|
|
cmd.Stderr = ptty.Output().Writer
|
|
err := cmd.Start()
|
|
require.NoError(t, err)
|
|
process := cmd.Process
|
|
defer process.Kill()
|
|
|
|
ptty.ExpectMatch("Password: ")
|
|
|
|
require.Eventually(t, func() bool {
|
|
echo, err := ptyWithFlags.EchoEnabled()
|
|
return err == nil && !echo
|
|
}, testutil.WaitShort, testutil.IntervalMedium, "echo is on while reading password")
|
|
|
|
err = process.Signal(os.Interrupt)
|
|
require.NoError(t, err)
|
|
_, err = process.Wait()
|
|
require.NoError(t, err)
|
|
|
|
require.Eventually(t, func() bool {
|
|
echo, err := ptyWithFlags.EchoEnabled()
|
|
return err == nil && echo
|
|
}, testutil.WaitShort, testutil.IntervalMedium, "echo is off after reading password")
|
|
}
|
|
|
|
// nolint:unused
|
|
func passwordHelper() {
|
|
cmd := &clibase.Cmd{
|
|
Handler: func(inv *clibase.Invocation) error {
|
|
cliui.Prompt(inv, cliui.PromptOptions{
|
|
Text: "Password:",
|
|
Secret: true,
|
|
})
|
|
return nil
|
|
},
|
|
}
|
|
err := cmd.Invoke().WithOS().Run()
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
}
|