summaryrefslogtreecommitdiffstats
path: root/src/cmd/go/terminal_test.go
diff options
context:
space:
mode:
Diffstat (limited to 'src/cmd/go/terminal_test.go')
-rw-r--r--src/cmd/go/terminal_test.go130
1 files changed, 130 insertions, 0 deletions
diff --git a/src/cmd/go/terminal_test.go b/src/cmd/go/terminal_test.go
new file mode 100644
index 0000000..a5ad919
--- /dev/null
+++ b/src/cmd/go/terminal_test.go
@@ -0,0 +1,130 @@
+// Copyright 2016 The Go Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+package main_test
+
+import (
+ "errors"
+ "internal/testenv"
+ "internal/testpty"
+ "io"
+ "os"
+ "testing"
+
+ "golang.org/x/term"
+)
+
+func TestTerminalPassthrough(t *testing.T) {
+ // Check that if 'go test' is run with a terminal connected to stdin/stdout,
+ // then the go command passes that terminal down to the test binary
+ // invocation (rather than, e.g., putting a pipe in the way).
+ //
+ // See issue 18153.
+ testenv.MustHaveGoBuild(t)
+
+ // Start with a "self test" to make sure that if we *don't* pass in a
+ // terminal, the test can correctly detect that. (cmd/go doesn't guarantee
+ // that it won't add a terminal in the middle, but that would be pretty weird.)
+ t.Run("pipe", func(t *testing.T) {
+ r, w, err := os.Pipe()
+ if err != nil {
+ t.Fatalf("pipe failed: %s", err)
+ }
+ defer r.Close()
+ defer w.Close()
+ stdout, stderr := runTerminalPassthrough(t, r, w)
+ if stdout {
+ t.Errorf("stdout is unexpectedly a terminal")
+ }
+ if stderr {
+ t.Errorf("stderr is unexpectedly a terminal")
+ }
+ })
+
+ // Now test with a read PTY.
+ t.Run("pty", func(t *testing.T) {
+ r, processTTY, err := testpty.Open()
+ if errors.Is(err, testpty.ErrNotSupported) {
+ t.Skipf("%s", err)
+ } else if err != nil {
+ t.Fatalf("failed to open test PTY: %s", err)
+ }
+ defer r.Close()
+ w, err := os.OpenFile(processTTY, os.O_RDWR, 0)
+ if err != nil {
+ t.Fatal(err)
+ }
+ defer w.Close()
+ stdout, stderr := runTerminalPassthrough(t, r, w)
+ if !stdout {
+ t.Errorf("stdout is not a terminal")
+ }
+ if !stderr {
+ t.Errorf("stderr is not a terminal")
+ }
+ })
+}
+
+func runTerminalPassthrough(t *testing.T, r, w *os.File) (stdout, stderr bool) {
+ cmd := testenv.Command(t, testGo, "test", "-run=^$")
+ cmd.Env = append(cmd.Environ(), "GO_TEST_TERMINAL_PASSTHROUGH=1")
+ cmd.Stdout = w
+ cmd.Stderr = w
+
+ // The behavior of reading from a PTY after the child closes it is very
+ // strange: on Linux, Read returns EIO, and on at least some versions of
+ // macOS, unread output may be discarded (see https://go.dev/issue/57141).
+ //
+ // To avoid that situation, we keep the child process running until the
+ // parent has finished reading from the PTY, at which point we unblock the
+ // child by closing its stdin pipe.
+ stdin, err := cmd.StdinPipe()
+ if err != nil {
+ t.Fatal(err)
+ }
+
+ t.Logf("running %s", cmd)
+ err = cmd.Start()
+ if err != nil {
+ t.Fatalf("starting subprocess: %s", err)
+ }
+ w.Close()
+ t.Cleanup(func() {
+ stdin.Close()
+ if err := cmd.Wait(); err != nil {
+ t.Errorf("suprocess failed with: %s", err)
+ }
+ })
+
+ buf := make([]byte, 2)
+ n, err := io.ReadFull(r, buf)
+ if err != nil || !(buf[0] == '1' || buf[0] == 'X') || !(buf[1] == '2' || buf[1] == 'X') {
+ t.Logf("read error: %v", err)
+ t.Fatalf("expected 2 bytes matching `[1X][2X]`; got %q", buf[:n])
+ }
+ return buf[0] == '1', buf[1] == '2'
+}
+
+func init() {
+ if os.Getenv("GO_TEST_TERMINAL_PASSTHROUGH") == "" {
+ return
+ }
+
+ if term.IsTerminal(1) {
+ os.Stdout.WriteString("1")
+ } else {
+ os.Stdout.WriteString("X")
+ }
+ if term.IsTerminal(2) {
+ os.Stdout.WriteString("2")
+ } else {
+ os.Stdout.WriteString("X")
+ }
+
+ // Before exiting, wait for the parent process to read the PTY output,
+ // at which point it will close stdin.
+ io.Copy(io.Discard, os.Stdin)
+
+ os.Exit(0)
+}