Files
coder/expect/expect_opt_test.go
Bryan c9c03123eb fix: Run expect tests on Windows with conpty pseudo-terminal (#276)
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
2022-02-14 17:05:40 -08:00

164 lines
2.8 KiB
Go

// Copyright 2018 Netflix, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package expect_test
import (
"bytes"
"testing"
"github.com/stretchr/testify/require"
. "github.com/coder/coder/expect"
)
func TestExpectOptString(t *testing.T) {
t.Parallel()
tests := []struct {
title string
opt Opt
data string
expected bool
}{
{
"No args",
String(),
"Hello world",
false,
},
{
"Single arg",
String("Hello"),
"Hello world",
true,
},
{
"Multiple arg",
String("other", "world"),
"Hello world",
true,
},
{
"No matches",
String("hello"),
"Hello world",
false,
},
}
for _, test := range tests {
test := test
t.Run(test.title, func(t *testing.T) {
t.Parallel()
var options Opts
err := test.opt(&options)
require.Nil(t, err)
buf := new(bytes.Buffer)
_, err = buf.WriteString(test.data)
require.Nil(t, err)
matcher := options.Match(buf)
if test.expected {
require.NotNil(t, matcher)
} else {
require.Nil(t, matcher)
}
})
}
}
func TestExpectOptAll(t *testing.T) {
t.Parallel()
tests := []struct {
title string
opt Opt
data string
expected bool
}{
{
"No opts",
All(),
"Hello world",
true,
},
{
"Single string match",
All(String("Hello")),
"Hello world",
true,
},
{
"Single string no match",
All(String("Hello")),
"No match",
false,
},
{
"Ordered strings match",
All(String("Hello"), String("world")),
"Hello world",
true,
},
{
"Ordered strings not all match",
All(String("Hello"), String("world")),
"Hello",
false,
},
{
"Unordered strings",
All(String("world"), String("Hello")),
"Hello world",
true,
},
{
"Unordered strings not all match",
All(String("world"), String("Hello")),
"Hello",
false,
},
{
"Repeated strings match",
All(String("Hello"), String("Hello")),
"Hello world",
true,
},
}
for _, test := range tests {
test := test
t.Run(test.title, func(t *testing.T) {
t.Parallel()
var options Opts
err := test.opt(&options)
require.Nil(t, err)
buf := new(bytes.Buffer)
_, err = buf.WriteString(test.data)
require.Nil(t, err)
matcher := options.Match(buf)
if test.expected {
require.NotNil(t, matcher)
} else {
require.Nil(t, matcher)
}
})
}
}