mirror of
https://github.com/coder/coder.git
synced 2025-07-12 00:14:10 +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
54 lines
1.2 KiB
Go
54 lines
1.2 KiB
Go
//go:build windows
|
|
// +build windows
|
|
|
|
// Copyright 2020 ActiveState Software. All rights reserved.
|
|
// Use of this source code is governed by a BSD-style
|
|
// license that can be found in the LICENSE file
|
|
|
|
package conpty
|
|
|
|
import (
|
|
"unsafe"
|
|
|
|
"golang.org/x/sys/windows"
|
|
)
|
|
|
|
var (
|
|
kernel32 = windows.NewLazySystemDLL("kernel32.dll")
|
|
procResizePseudoConsole = kernel32.NewProc("ResizePseudoConsole")
|
|
procCreatePseudoConsole = kernel32.NewProc("CreatePseudoConsole")
|
|
procClosePseudoConsole = kernel32.NewProc("ClosePseudoConsole")
|
|
)
|
|
|
|
func createPseudoConsole(consoleSize uintptr, ptyIn windows.Handle, ptyOut windows.Handle, hpCon *windows.Handle) (err error) {
|
|
r1, _, e1 := procCreatePseudoConsole.Call(
|
|
consoleSize,
|
|
uintptr(ptyIn),
|
|
uintptr(ptyOut),
|
|
0,
|
|
uintptr(unsafe.Pointer(hpCon)),
|
|
)
|
|
|
|
if r1 != 0 { // !S_OK
|
|
err = e1
|
|
}
|
|
return
|
|
}
|
|
|
|
func resizePseudoConsole(handle windows.Handle, consoleSize uintptr) (err error) {
|
|
r1, _, e1 := procResizePseudoConsole.Call(uintptr(handle), consoleSize)
|
|
if r1 != 0 { // !S_OK
|
|
err = e1
|
|
}
|
|
return
|
|
}
|
|
|
|
func closePseudoConsole(handle windows.Handle) (err error) {
|
|
r1, _, e1 := procClosePseudoConsole.Call(uintptr(handle))
|
|
if r1 == 0 {
|
|
err = e1
|
|
}
|
|
|
|
return
|
|
}
|