Fix test flaky due to race in showing/hiding cursor

mislav · mislav · commit 1f4bd80c5698 · 2021-06-14T10:58:53.000+02:00
https://github.com/cli/cli/pull/3787/checks?check_run_id=2793254411
diff --git a/pkg/surveyext/editor_test.go b/pkg/surveyext/editor_test.go
@@ -74,15 +74,15 @@ func Test_GhEditor_Prompt_skip(t *testing.T) {
 	// wait until the prompt is rendered and send the Enter key
 	go func() {
 		pty.WaitForOutput("Body")
-		assert.Equal(t, "\x1b[0G\x1b[2K\x1b[0;1;92m? \x1b[0m\x1b[0;1;99mBody \x1b[0m\x1b[0;36m[(e) to launch vim, enter to skip] \x1b[0m\x1b[?25l", pty.Output())
+		assert.Equal(t, "\x1b[0G\x1b[2K\x1b[0;1;92m? \x1b[0m\x1b[0;1;99mBody \x1b[0m\x1b[0;36m[(e) to launch vim, enter to skip] \x1b[0m", normalizeANSI(pty.Output()))
 		pty.ResetOutput()
 		assert.NoError(t, pty.SendKey('\n'))
 	}()
 
 	res, err := e.Prompt(defaultPromptConfig())
 	assert.NoError(t, err)
 	assert.Equal(t, "initial value", res)
-	assert.Equal(t, "\x1b[?25h", pty.Output())
+	assert.Equal(t, "", normalizeANSI(pty.Output()))
 }
 
 func Test_GhEditor_Prompt_editorAppend(t *testing.T) {
@@ -105,15 +105,15 @@ func Test_GhEditor_Prompt_editorAppend(t *testing.T) {
 	// wait until the prompt is rendered and send the 'e' key
 	go func() {
 		pty.WaitForOutput("Body")
-		assert.Equal(t, "\x1b[0G\x1b[2K\x1b[0;1;92m? \x1b[0m\x1b[0;1;99mBody \x1b[0m\x1b[0;36m[(e) to launch vim, enter to skip] \x1b[0m\x1b[?25l", pty.Output())
+		assert.Equal(t, "\x1b[0G\x1b[2K\x1b[0;1;92m? \x1b[0m\x1b[0;1;99mBody \x1b[0m\x1b[0;36m[(e) to launch vim, enter to skip] \x1b[0m", normalizeANSI(pty.Output()))
 		pty.ResetOutput()
 		assert.NoError(t, pty.SendKey('e'))
 	}()
 
 	res, err := e.Prompt(defaultPromptConfig())
 	assert.NoError(t, err)
 	assert.Equal(t, "initial value - added by vim", res)
-	assert.Equal(t, "\x1b[?25h\x1b[?25h", pty.Output())
+	assert.Equal(t, "", normalizeANSI(pty.Output()))
 }
 
 func Test_GhEditor_Prompt_editorTruncate(t *testing.T) {
@@ -136,15 +136,15 @@ func Test_GhEditor_Prompt_editorTruncate(t *testing.T) {
 	// wait until the prompt is rendered and send the 'e' key
 	go func() {
 		pty.WaitForOutput("Body")
-		assert.Equal(t, "\x1b[0G\x1b[2K\x1b[0;1;92m? \x1b[0m\x1b[0;1;99mBody \x1b[0m\x1b[0;36m[(e) to launch nano, enter to skip] \x1b[0m\x1b[?25l", pty.Output())
+		assert.Equal(t, "\x1b[0G\x1b[2K\x1b[0;1;92m? \x1b[0m\x1b[0;1;99mBody \x1b[0m\x1b[0;36m[(e) to launch nano, enter to skip] \x1b[0m", normalizeANSI(pty.Output()))
 		pty.ResetOutput()
 		assert.NoError(t, pty.SendKey('e'))
 	}()
 
 	res, err := e.Prompt(defaultPromptConfig())
 	assert.NoError(t, err)
 	assert.Equal(t, "", res)
-	assert.Equal(t, "\x1b[?25h\x1b[?25h", pty.Output())
+	assert.Equal(t, "", normalizeANSI(pty.Output()))
 }
 
 // survey doesn't expose this
@@ -275,3 +275,10 @@ func (f *teeWriter) Reset() {
 	f.buf.Reset()
 	f.mu.Unlock()
 }
+
+// strips some ANSI escape sequences that we do not want tests to be concerned with
+func normalizeANSI(t string) string {
+	t = strings.ReplaceAll(t, "\x1b[?25h", "") // strip sequence that shows cursor
+	t = strings.ReplaceAll(t, "\x1b[?25l", "") // strip sequence that hides cursor
+	return t
+}
