Thanks to visit codestin.com
Credit goes to github.com

Skip to content

chore: Add (skipped) ptytest test that hangs on Intel Mac (and Windows) #1629

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Jun 7, 2022
Merged

chore: Add (skipped) ptytest test that hangs on Intel Mac (and Windows) #1629

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
bf3a378
bug: Add test that breaks ptytest on Intel Mac
mafredri May 20, 2022
65f3304
Simplify test, no need to output more than one line
mafredri May 20, 2022
638acb6
Add test using cobra cmd
Emyrk May 20, 2022
7692c5d
Create proper test to fully reproduce the issue on macOS
mafredri Jun 7, 2022
034cfa6
Add large output
mafredri Jun 7, 2022
487f338
Skip failing tests on darwin and windows
mafredri Jun 7, 2022
75b6296
chore: Write better skip message
mafredri Jun 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Create proper test to fully reproduce the issue on macOS
  • Loading branch information
@mafredri
mafredri committed Jun 7, 2022
commit 7692c5d249acffa8ae46f41f28e72201d17207b0
54 changes: 29 additions & 25 deletions pty/ptytest/ptytest_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ package ptytest_test

import (
"fmt"
"os/exec"
"strings"
"testing"

"github.com/spf13/cobra"
Expand All @@ -21,32 +21,36 @@ func TestPtytest(t *testing.T) {
pty.WriteLine("read")
})

// nolint:paralleltest
t.Run("Do not hang on Intel macOS", func(t *testing.T) {
cmd := exec.Command("sh", "-c", "echo hi, I will cause a hang")
pty := ptytest.New(t)
cmd.Stdin = pty.Input()
cmd.Stdout = pty.Output()
err := cmd.Run()
require.NoError(t, err)
})
t.Run("Cobra ptytest should not hang when output is not consumed", func(t *testing.T) {
t.Parallel()

// nolint:paralleltest
t.Run("CobraCommandWorksLinux", func(t *testing.T) {
// Example with cobra command instead of exec. More abstractions, but
// for some reason works on linux.
cmd := cobra.Command{
Use: "test",
RunE: func(cmd *cobra.Command, args []string) error {
fmt.Println("Hello world")
return nil
},
tests := []struct {
name string
output string
}{
{name: "1024 is safe (does not exceed macOS buffer)", output: strings.Repeat(".", 1024)},
{name: "1025 exceeds macOS buffer (must not hang)", output: strings.Repeat(".", 1025)},
}
for _, tt := range tests {
tt := tt
// nolint:paralleltest // Avoid parallel test to more easily identify the issue.
t.Run(tt.name, func(t *testing.T) {
// Example with cobra command instead of exec. More abstractions, but
// for some reason works on linux.
cmd := cobra.Command{
Use: "test",
RunE: func(cmd *cobra.Command, args []string) error {
fmt.Fprint(cmd.OutOrStdout(), tt.output)
return nil
},
}

pty := ptytest.New(t)
cmd.SetIn(pty.Input())
cmd.SetOut(pty.Output())
err := cmd.Execute()
require.NoError(t, err)
pty := ptytest.New(t)
cmd.SetIn(pty.Input())
cmd.SetOut(pty.Output())
err := cmd.Execute()
require.NoError(t, err)
})
}
})
}