mirror of
https://github.com/coder/coder.git
synced 2025-07-10 23:53:15 +00:00
c9c03123eb
This brings together a bunch of random, partially implemented packages for support of the new(ish) Windows [`conpty`](https://devblogs.microsoft.com/commandline/windows-command-line-introducing-the-windows-pseudo-console-conpty/) API - such that we can leverage the `expect` style of CLI tests, but in a way that works in Linux/OSX `pty`s and Windows `conpty`. These include: - Vendoring the `go-expect` library from Netflix w/ some tweaks to work cross-platform - Vendoring the `pty` cross-platform implementation from [waypoint-plugin-sdk](b55c787a65/internal/pkg/pty) - Vendoring the `conpty` Windows-specific implementation from [waypoint-plugin-sdk](b55c787a65/internal/pkg/conpty) - Adjusting the `pty` interface to work with `go-expect` + the cross-plat version There were several limitations with the current packages: - `go-expect` requires the same `os.File` (TTY) for input / output, but `conhost` requires separate file handles - `conpty` does not handle input, only output - The cross-platform `pty` didn't expose the full set of primitives needed for `console` Therefore, the following changes were made: - Handling of `stdin` was added to the `conpty` interface - We weren't using the full extent of the `go-expect` interface, so some portions were removed (ie, exec'ing a process) to simplify our implementation and make it easier to extend cross-platform - Instead of `console` exposing just a `Tty`, it exposes an `InTty` and `OutTty`, to help encapsulate the difference on Windows (on Linux, these point to the same pipe) Future improvements: - The `isatty` implementation doesn't support accurate detection of `conhost` pty's without an associated process. In lieu of a more robust check, I've added a `--force-tty` flag intended for test case use - that forces the CLI to run in tty mode. - It seems the windows implementation doesn't support setting a deadline. This is needed for the expect.Timeout API, but isn't used by us yet. Fixes #241
102 lines
2.7 KiB
Go
102 lines
2.7 KiB
Go
package cli_test
|
|
|
|
import (
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"github.com/coder/coder/cli/clitest"
|
|
"github.com/coder/coder/coderd/coderdtest"
|
|
"github.com/coder/coder/database"
|
|
"github.com/coder/coder/expect"
|
|
"github.com/coder/coder/provisioner/echo"
|
|
"github.com/coder/coder/provisionersdk/proto"
|
|
)
|
|
|
|
func TestProjectCreate(t *testing.T) {
|
|
t.Parallel()
|
|
t.Run("NoParameters", func(t *testing.T) {
|
|
t.Parallel()
|
|
client := coderdtest.New(t)
|
|
coderdtest.CreateInitialUser(t, client)
|
|
source := clitest.CreateProjectVersionSource(t, &echo.Responses{
|
|
Parse: echo.ParseComplete,
|
|
Provision: echo.ProvisionComplete,
|
|
})
|
|
cmd, root := clitest.New(t, "projects", "create", "--directory", source, "--provisioner", string(database.ProvisionerTypeEcho))
|
|
clitest.SetupConfig(t, client, root)
|
|
_ = coderdtest.NewProvisionerDaemon(t, client)
|
|
console := expect.NewTestConsole(t, cmd)
|
|
closeChan := make(chan struct{})
|
|
go func() {
|
|
err := cmd.Execute()
|
|
require.NoError(t, err)
|
|
close(closeChan)
|
|
}()
|
|
|
|
matches := []string{
|
|
"organization?", "y",
|
|
"name?", "test-project",
|
|
"project?", "y",
|
|
"created!", "n",
|
|
}
|
|
for i := 0; i < len(matches); i += 2 {
|
|
match := matches[i]
|
|
value := matches[i+1]
|
|
_, err := console.ExpectString(match)
|
|
require.NoError(t, err)
|
|
_, err = console.SendLine(value)
|
|
require.NoError(t, err)
|
|
}
|
|
<-closeChan
|
|
})
|
|
|
|
t.Run("Parameter", func(t *testing.T) {
|
|
t.Parallel()
|
|
client := coderdtest.New(t)
|
|
coderdtest.CreateInitialUser(t, client)
|
|
source := clitest.CreateProjectVersionSource(t, &echo.Responses{
|
|
Parse: []*proto.Parse_Response{{
|
|
Type: &proto.Parse_Response_Complete{
|
|
Complete: &proto.Parse_Complete{
|
|
ParameterSchemas: []*proto.ParameterSchema{{
|
|
Name: "somevar",
|
|
DefaultDestination: &proto.ParameterDestination{
|
|
Scheme: proto.ParameterDestination_PROVISIONER_VARIABLE,
|
|
},
|
|
}},
|
|
},
|
|
},
|
|
}},
|
|
Provision: echo.ProvisionComplete,
|
|
})
|
|
cmd, root := clitest.New(t, "projects", "create", "--directory", source, "--provisioner", string(database.ProvisionerTypeEcho))
|
|
clitest.SetupConfig(t, client, root)
|
|
coderdtest.NewProvisionerDaemon(t, client)
|
|
console := expect.NewTestConsole(t, cmd)
|
|
closeChan := make(chan struct{})
|
|
go func() {
|
|
err := cmd.Execute()
|
|
require.NoError(t, err)
|
|
close(closeChan)
|
|
}()
|
|
|
|
matches := []string{
|
|
"organization?", "y",
|
|
"name?", "test-project",
|
|
"somevar:", "value",
|
|
"project?", "y",
|
|
"created!", "n",
|
|
}
|
|
for i := 0; i < len(matches); i += 2 {
|
|
match := matches[i]
|
|
value := matches[i+1]
|
|
_, err := console.ExpectString(match)
|
|
require.NoError(t, err)
|
|
_, err = console.SendLine(value)
|
|
require.NoError(t, err)
|
|
}
|
|
<-closeChan
|
|
})
|
|
}
|