fix: improve pty and ptytest (coder#5327)

mtojek · web-flow · commit 2f3ff6ced824 · 2022-12-07T14:18:09.000+01:00
* Fix: improve ptytest

* Disable skip

* WIP

* WIP

* WIP

* WIP

* WIP

* WIP

* WIP

* WIP

* Fix

* WIP

* Fix

* fix: pty close on Windows

* Revert changes around workflow

* fix
diff --git a/pty/pty_windows.go b/pty/pty_windows.go
@@ -130,16 +130,16 @@ func (p *ptyWindows) Close() error {
 		return nil
 	}
 	p.closed = true
-	_ = p.outputWrite.Close()
-	_ = p.outputRead.Close()
-	_ = p.inputWrite.Close()
-	_ = p.inputRead.Close()
 
 	ret, _, err := procClosePseudoConsole.Call(uintptr(p.console))
 	if ret < 0 {
 		return xerrors.Errorf("close pseudo console: %w", err)
 	}
 
+	_ = p.outputWrite.Close()
+	_ = p.outputRead.Close()
+	_ = p.inputWrite.Close()
+	_ = p.inputRead.Close()
 	return nil
 }
 
diff --git a/pty/ptytest/ptytest.go b/pty/ptytest/ptytest.go
@@ -50,8 +50,14 @@ func create(t *testing.T, ptty pty.PTY, name string) *PTY {
 		ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitShort)
 		defer cancel()
 
+		logf(t, name, "close logw on cleanup")
 		_ = logw.Close()
+
+		logf(t, name, "close logr on cleanup")
 		_ = logr.Close()
+
+		logf(t, name, "logr and logw closed")
+
 		select {
 		case <-ctx.Done():
 			fatalf(t, name, "cleanup", "log pipe did not close in time")
@@ -74,6 +80,7 @@ func create(t *testing.T, ptty pty.PTY, name string) *PTY {
 
 		// Close pty only so that the copy goroutine can consume the
 		// remainder of it's buffer and then exit.
+		logf(t, name, "close pty on cleanup")
 		err := ptty.Close()
 		// Pty may already be closed, so don't fail the test, but log
 		// the error in case it's significant.
@@ -152,7 +159,7 @@ func (p *PTY) ExpectMatch(str string) string {
 		p.logf("matched %q = %q", str, buffer.String())
 		return buffer.String()
 	case <-timeout.Done():
-		// Ensure gorouine is cleaned up before test exit.
+		// Ensure goroutine is cleaned up before test exit.
 		_ = p.out.closeErr(p.Close())
 		<-match
 

Original file line number	Diff line number	Diff line change
`@@ -130,16 +130,16 @@ func (p *ptyWindows) Close() error {`
`130`	`130`	`return nil`
`131`	`131`	`}`
`132`	`132`	`p.closed = true`
`133`		`- _ = p.outputWrite.Close()`
`134`		`- _ = p.outputRead.Close()`
`135`		`- _ = p.inputWrite.Close()`
`136`		`- _ = p.inputRead.Close()`
`137`	`133`
`138`	`134`	`ret, _, err := procClosePseudoConsole.Call(uintptr(p.console))`
`139`	`135`	`if ret < 0 {`
`140`	`136`	`return xerrors.Errorf("close pseudo console: %w", err)`
`141`	`137`	`}`
`142`	`138`
	`139`	`+ _ = p.outputWrite.Close()`
	`140`	`+ _ = p.outputRead.Close()`
	`141`	`+ _ = p.inputWrite.Close()`
	`142`	`+ _ = p.inputRead.Close()`
`143`	`143`	`return nil`
`144`	`144`	`}`
`145`	`145`