fix: Improve debuggability of ptytest failures
#3367
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Since we were not failing tests with `require` the error output was somewhat hidden in the stream of log messages. This change standardizes ptytest logging and failing to improve visibility.
johnstcn
approved these changes
Aug 3, 2022
There was a problem hiding this comment.
For posterity, here's what it looks like with a failing test:
$ go test . -test.run='^TestLogin$'
--- FAIL: TestLogin (0.00s)
--- FAIL: TestLogin/InitialUserTTYConfirmPasswordFailAndReprompt (10.03s)
t.go:81: 2022-08-03 10:11:46.774 [DEBUG] <github.com/coder/coder/coderd/coderd.go:417> debugLogRequest.func1.1 GET /api/v2/buildinfo
t.go:81: 2022-08-03 10:11:46.775 [DEBUG] <github.com/coder/coder/coderd/coderd.go:417> debugLogRequest.func1.1 GET /api/v2/users/first
ptytest.go:80: 2022-08-03 10:11:46.776: cmd: stdout: "> Your Coder deployment hasn't been set up!"
login_test.go:109: 2022-08-03 10:11:56.771: cmd: match exceeded deadline: wanted "first user?"; got "> Your Coder deployment hasn't been set up!\r\n> What's your \x1b[;memail\x1b[0m ? "
login_test.go:96:
Error Trace: /home/coder/src/cdr/coder/cli/login_test.go:96
/home/coder/src/cdr/coder/cli/asm_amd64.s:1571
Error: Received unexpected error:
specify email prompt:
github.com/coder/coder/cli.login.func1
/home/coder/src/cdr/coder/cli/login.go:131
- read /dev/pts/9: file already closed
Test: TestLogin/InitialUserTTYConfirmPasswordFailAndReprompt
login_test.go:109:
Error Trace: /home/coder/src/cdr/coder/cli/ptytest.go:176
/home/coder/src/cdr/coder/cli/ptytest.go:136
/home/coder/src/cdr/coder/cli/login_test.go:109
Error: match exceeded deadline
Test: TestLogin/InitialUserTTYConfirmPasswordFailAndReprompt
Messages: wanted "first user?"; got "> Your Coder deployment hasn't been set up!\r\n> What's your \x1b[;memail\x1b[0m ? "
ptytest.go:80: 2022-08-03 10:11:56.772: cmd: stdout: "> What's your \x1b[;memail\x1b[0m ? "
--- FAIL: TestLogin/InitialUserTTY (10.04s)
t.go:81: 2022-08-03 10:11:46.777 [DEBUG] <github.com/coder/coder/coderd/coderd.go:417> debugLogRequest.func1.1 GET /api/v2/buildinfo
t.go:81: 2022-08-03 10:11:46.778 [DEBUG] <github.com/coder/coder/coderd/coderd.go:417> debugLogRequest.func1.1 GET /api/v2/users/first
ptytest.go:80: 2022-08-03 10:11:46.779: cmd: stdout: "> Your Coder deployment hasn't been set up!"
login_test.go:53: 2022-08-03 10:11:56.777: cmd: match exceeded deadline: wanted "firrst user?"; got "> Your Coder deployment hasn't been set up!\r\n> What's your \x1b[;memail\x1b[0m ? "
login_test.go:53:
Error Trace: /home/coder/src/cdr/coder/cli/ptytest.go:176
/home/coder/src/cdr/coder/cli/ptytest.go:136
/home/coder/src/cdr/coder/cli/login_test.go:53
Error: match exceeded deadline
Test: TestLogin/InitialUserTTY
Messages: wanted "firrst user?"; got "> Your Coder deployment hasn't been set up!\r\n> What's your \x1b[;memail\x1b[0m ? "
ptytest.go:80: 2022-08-03 10:11:56.777: cmd: stdout: "> What's your \x1b[;memail\x1b[0m ? "
FAIL
FAIL github.com/coder/coder/cli 10.459s
FAIL
This is a big improvement over what we had before.
ptytest failures
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Since we were not failing tests with
requirethe error output wassomewhat hidden in the stream of log messages. This change standardizes
ptytest logging and failing to improve visibility.