1
0
mirror of https://github.com/jesseduffield/lazygit.git synced 2024-12-12 11:15:00 +02:00
lazygit/pkg/gui/gui_test.go

83 lines
2.4 KiB
Go
Raw Normal View History

2021-09-16 15:38:43 +02:00
//go:build !windows
2021-04-08 13:24:49 +02:00
// +build !windows
2020-10-04 09:41:33 +02:00
package gui
import (
"fmt"
2021-04-05 05:07:25 +02:00
"io"
2020-10-04 09:41:33 +02:00
"io/ioutil"
"os"
2021-04-06 01:02:01 +02:00
"os/exec"
2020-10-04 09:41:33 +02:00
"testing"
2021-04-05 05:07:25 +02:00
"github.com/creack/pty"
2021-04-05 12:37:18 +02:00
"github.com/jesseduffield/lazygit/pkg/integration"
2020-10-04 09:41:33 +02:00
"github.com/stretchr/testify/assert"
)
2021-04-05 12:37:18 +02:00
// This file is quite similar to integration/main.go. The main difference is that this file is
// run via `go test` whereas the other is run via `test/lazyintegration/main.go` which provides
// a convenient gui wrapper around our integration tests. The `go test` approach is better
// for CI and for running locally in the background to ensure you haven't broken
// anything while making changes. If you want to visually see what's happening when a test is run,
// you'll need to take the other approach
2020-10-04 09:41:33 +02:00
//
2021-04-05 12:37:18 +02:00
// As for this file, to run an integration test, e.g. for test 'commit', go:
// go test pkg/gui/gui_test.go -run /commit
2020-10-04 09:41:33 +02:00
//
2020-10-05 12:00:31 +02:00
// To update a snapshot for an integration test, pass UPDATE_SNAPSHOTS=true
// UPDATE_SNAPSHOTS=true go test pkg/gui/gui_test.go -run /commit
2020-10-04 09:41:33 +02:00
//
2021-04-05 12:37:18 +02:00
// integration tests are run in test/integration/<test_name>/actual and the final test does
2020-10-04 09:41:33 +02:00
// not clean up that directory so you can cd into it to see for yourself what
2021-04-05 12:37:18 +02:00
// happened when a test fails.
2020-10-04 09:41:33 +02:00
//
2020-10-06 00:16:16 +02:00
// To override speed, pass e.g. `SPEED=1` as an env var. Otherwise we start each test
// at a high speed and then drop down to lower speeds upon each failure until finally
// trying at the original playback speed (speed 1). A speed of 2 represents twice the
// original playback speed. Speed may be a decimal.
2020-10-04 09:41:33 +02:00
func Test(t *testing.T) {
mode := integration.GetModeFromEnv()
2021-04-06 01:02:01 +02:00
speedEnv := os.Getenv("SPEED")
includeSkipped := os.Getenv("INCLUDE_SKIPPED") != ""
2021-04-06 01:02:01 +02:00
err := integration.RunTests(
t.Logf,
runCmdHeadless,
func(test *integration.Test, f func(*testing.T) error) {
2021-04-06 01:02:01 +02:00
t.Run(test.Name, func(t *testing.T) {
err := f(t)
assert.NoError(t, err)
2021-04-06 01:02:01 +02:00
})
},
mode,
2021-04-06 01:02:01 +02:00
speedEnv,
2021-10-22 11:18:40 +02:00
func(t *testing.T, expected string, actual string, prefix string) {
2022-03-19 00:38:49 +02:00
t.Helper()
2021-10-22 11:18:40 +02:00
assert.Equal(t, expected, actual, fmt.Sprintf("Unexpected %s. Expected:\n%s\nActual:\n%s\n", prefix, expected, actual))
2021-04-06 01:02:01 +02:00
},
includeSkipped,
2021-04-06 01:02:01 +02:00
)
2020-10-04 09:41:33 +02:00
2021-04-06 01:02:01 +02:00
assert.NoError(t, err)
}
2020-10-06 00:23:09 +02:00
2021-04-06 01:02:01 +02:00
func runCmdHeadless(cmd *exec.Cmd) error {
cmd.Env = append(
cmd.Env,
"HEADLESS=true",
"TERM=xterm",
)
2020-10-06 00:23:09 +02:00
2021-04-06 01:02:01 +02:00
f, err := pty.StartWithSize(cmd, &pty.Winsize{Rows: 100, Cols: 100})
if err != nil {
return err
}
2020-10-04 09:41:33 +02:00
2021-04-06 01:02:01 +02:00
_, _ = io.Copy(ioutil.Discard, f)
2020-10-04 09:41:33 +02:00
2021-04-06 01:02:01 +02:00
return f.Close()
2020-10-04 09:41:33 +02:00
}