mirror of
https://github.com/ddworken/hishtory.git
synced 2025-06-24 14:01:46 +02:00
Move a bunch of utility functions for tests to a testutils.go file to make client_test.go at least a little shorter
This commit is contained in:
David Dworken
parent
55a45fe8bd
commit
d613c22e50
@ -2,16 +2,12 @@ package main
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"bytes"
|
"bytes"
|
||||||
"encoding/json"
|
|
||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
|
||||||
"net/http"
|
|
||||||
"os"
|
"os"
|
||||||
"os/exec"
|
"os/exec"
|
||||||
"path"
|
"path"
|
||||||
"regexp"
|
"regexp"
|
||||||
"runtime"
|
"runtime"
|
||||||
"strconv"
|
|
||||||
"strings"
|
"strings"
|
||||||
"sync"
|
"sync"
|
||||||
"testing"
|
"testing"
|
||||||
@ -25,13 +21,10 @@ import (
|
|||||||
"github.com/ddworken/hishtory/client/data"
|
"github.com/ddworken/hishtory/client/data"
|
||||||
"github.com/ddworken/hishtory/client/hctx"
|
"github.com/ddworken/hishtory/client/hctx"
|
||||||
"github.com/ddworken/hishtory/client/lib"
|
"github.com/ddworken/hishtory/client/lib"
|
||||||
"github.com/ddworken/hishtory/shared"
|
|
||||||
"github.com/ddworken/hishtory/shared/testutils"
|
"github.com/ddworken/hishtory/shared/testutils"
|
||||||
"github.com/stretchr/testify/require"
|
"github.com/stretchr/testify/require"
|
||||||
)
|
)
|
||||||
|
|
||||||
var GLOBAL_STATSD *statsd.Client
|
|
||||||
|
|
||||||
func skipSlowTests() bool {
|
func skipSlowTests() bool {
|
||||||
return os.Getenv("FAST") != ""
|
return os.Getenv("FAST") != ""
|
||||||
}
|
}
|
||||||
@ -73,83 +66,8 @@ func TestMain(m *testing.M) {
|
|||||||
m.Run()
|
m.Run()
|
||||||
}
|
}
|
||||||
|
|
||||||
type shellTester interface {
|
|
||||||
RunInteractiveShell(t testing.TB, script string) string
|
|
||||||
RunInteractiveShellRelaxed(t testing.TB, script string) (string, error)
|
|
||||||
ShellName() string
|
|
||||||
}
|
|
||||||
type bashTester struct {
|
|
||||||
shellTester
|
|
||||||
}
|
|
||||||
|
|
||||||
func (b bashTester) RunInteractiveShell(t testing.TB, script string) string {
|
|
||||||
out, err := b.RunInteractiveShellRelaxed(t, "set -emo pipefail\n"+script)
|
|
||||||
if err != nil {
|
|
||||||
_, filename, line, _ := runtime.Caller(1)
|
|
||||||
t.Fatalf("error when running command at %s:%d: %v", filename, line, err)
|
|
||||||
}
|
|
||||||
return out
|
|
||||||
}
|
|
||||||
|
|
||||||
func (b bashTester) RunInteractiveShellRelaxed(t testing.TB, script string) (string, error) {
|
|
||||||
cmd := exec.Command("bash", "-i")
|
|
||||||
cmd.Stdin = strings.NewReader(script)
|
|
||||||
var stdout bytes.Buffer
|
|
||||||
cmd.Stdout = &stdout
|
|
||||||
var stderr bytes.Buffer
|
|
||||||
cmd.Stderr = &stderr
|
|
||||||
err := cmd.Run()
|
|
||||||
if err != nil {
|
|
||||||
return "", fmt.Errorf("unexpected error when running commands, out=%#v, err=%#v: %w", stdout.String(), stderr.String(), err)
|
|
||||||
}
|
|
||||||
outStr := stdout.String()
|
|
||||||
require.NotContains(t, outStr, "hishtory fatal error", "Ran command, but hishtory had a fatal error!")
|
|
||||||
return outStr, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (b bashTester) ShellName() string {
|
|
||||||
return "bash"
|
|
||||||
}
|
|
||||||
|
|
||||||
type zshTester struct {
|
|
||||||
shellTester
|
|
||||||
}
|
|
||||||
|
|
||||||
func (z zshTester) RunInteractiveShell(t testing.TB, script string) string {
|
|
||||||
res, err := z.RunInteractiveShellRelaxed(t, "set -eo pipefail\n"+script)
|
|
||||||
require.NoError(t, err)
|
|
||||||
return res
|
|
||||||
}
|
|
||||||
|
|
||||||
func (z zshTester) RunInteractiveShellRelaxed(t testing.TB, script string) (string, error) {
|
|
||||||
cmd := exec.Command("zsh", "-is")
|
|
||||||
cmd.Stdin = strings.NewReader(script)
|
|
||||||
var stdout bytes.Buffer
|
|
||||||
cmd.Stdout = &stdout
|
|
||||||
var stderr bytes.Buffer
|
|
||||||
cmd.Stderr = &stderr
|
|
||||||
err := cmd.Run()
|
|
||||||
if err != nil {
|
|
||||||
return stdout.String(), fmt.Errorf("unexpected error when running command=%#v, out=%#v, err=%#v: %w", script, stdout.String(), stderr.String(), err)
|
|
||||||
}
|
|
||||||
outStr := stdout.String()
|
|
||||||
require.NotContains(t, outStr, "hishtory fatal error")
|
|
||||||
return outStr, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (z zshTester) ShellName() string {
|
|
||||||
return "zsh"
|
|
||||||
}
|
|
||||||
|
|
||||||
var shellTesters []shellTester = []shellTester{bashTester{}, zshTester{}}
|
var shellTesters []shellTester = []shellTester{bashTester{}, zshTester{}}
|
||||||
|
|
||||||
type OnlineStatus int64
|
|
||||||
|
|
||||||
const (
|
|
||||||
Online OnlineStatus = iota
|
|
||||||
Offline
|
|
||||||
)
|
|
||||||
|
|
||||||
func TestParam(t *testing.T) {
|
func TestParam(t *testing.T) {
|
||||||
if skipSlowTests() {
|
if skipSlowTests() {
|
||||||
shellTesters = shellTesters[:1]
|
shellTesters = shellTesters[:1]
|
||||||
@ -198,89 +116,6 @@ func TestParam(t *testing.T) {
|
|||||||
assertNoLeakedConnections(t)
|
assertNoLeakedConnections(t)
|
||||||
}
|
}
|
||||||
|
|
||||||
func runTestsWithRetries(parentT *testing.T, testName string, testFunc func(t testing.TB)) {
|
|
||||||
numRetries := 3
|
|
||||||
if testutils.IsGithubAction() {
|
|
||||||
numRetries = 5
|
|
||||||
}
|
|
||||||
runTestsWithExtraRetries(parentT, testName, testFunc, numRetries)
|
|
||||||
}
|
|
||||||
|
|
||||||
func runTestsWithExtraRetries(parentT *testing.T, testName string, testFunc func(t testing.TB), numRetries int) {
|
|
||||||
for i := 1; i <= numRetries; i++ {
|
|
||||||
rt := &retryingTester{nil, i == numRetries, true, testName, numRetries}
|
|
||||||
parentT.Run(fmt.Sprintf("%s/%d", testName, i), func(t *testing.T) {
|
|
||||||
rt.T = t
|
|
||||||
testFunc(rt)
|
|
||||||
})
|
|
||||||
if rt.succeeded {
|
|
||||||
if GLOBAL_STATSD != nil {
|
|
||||||
GLOBAL_STATSD.Incr("test_status", []string{"result:passed", "test:" + testName, "os:" + runtime.GOOS}, 1.0)
|
|
||||||
GLOBAL_STATSD.Distribution("test_retry_count", float64(i), []string{"test:" + testName, "os:" + runtime.GOOS}, 1.0)
|
|
||||||
}
|
|
||||||
break
|
|
||||||
} else {
|
|
||||||
if GLOBAL_STATSD != nil {
|
|
||||||
GLOBAL_STATSD.Incr("test_status", []string{"result:failed", "test:" + testName, "os:" + runtime.GOOS}, 1.0)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
type retryingTester struct {
|
|
||||||
*testing.T
|
|
||||||
isFinalRun bool
|
|
||||||
succeeded bool
|
|
||||||
testName string
|
|
||||||
numRetries int
|
|
||||||
}
|
|
||||||
|
|
||||||
func (t *retryingTester) Fatalf(format string, args ...any) {
|
|
||||||
t.T.Helper()
|
|
||||||
t.succeeded = false
|
|
||||||
if t.isFinalRun {
|
|
||||||
if GLOBAL_STATSD != nil {
|
|
||||||
GLOBAL_STATSD.Incr("test_failure", []string{"test:" + t.testName, "os:" + runtime.GOOS}, 1.0)
|
|
||||||
GLOBAL_STATSD.Distribution("test_retry_count", float64(t.numRetries), []string{"test:" + t.testName, "os:" + runtime.GOOS}, 1.0)
|
|
||||||
}
|
|
||||||
t.T.Fatalf(format, args...)
|
|
||||||
} else {
|
|
||||||
testutils.TestLog(t.T, fmt.Sprintf("retryingTester: Ignoring fatalf for non-final run: %#v", fmt.Sprintf(format, args...)))
|
|
||||||
}
|
|
||||||
t.SkipNow()
|
|
||||||
}
|
|
||||||
|
|
||||||
func (t *retryingTester) Errorf(format string, args ...any) {
|
|
||||||
t.T.Helper()
|
|
||||||
t.succeeded = false
|
|
||||||
if t.isFinalRun {
|
|
||||||
t.T.Errorf(format, args...)
|
|
||||||
} else {
|
|
||||||
testutils.TestLog(t.T, fmt.Sprintf("retryingTester: Ignoring errorf for non-final run: %#v", fmt.Sprintf(format, args...)))
|
|
||||||
}
|
|
||||||
t.SkipNow()
|
|
||||||
}
|
|
||||||
|
|
||||||
func (t *retryingTester) FailNow() {
|
|
||||||
t.succeeded = false
|
|
||||||
if t.isFinalRun {
|
|
||||||
t.T.FailNow()
|
|
||||||
} else {
|
|
||||||
testutils.TestLog(t.T, "retryingTester: Ignoring FailNow for non-final run")
|
|
||||||
// Still terminate execution via SkipNow() since FailNow() means we should stop the current test
|
|
||||||
t.T.SkipNow()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func (t *retryingTester) Fail() {
|
|
||||||
t.succeeded = false
|
|
||||||
if t.isFinalRun {
|
|
||||||
t.T.Fail()
|
|
||||||
} else {
|
|
||||||
testutils.TestLog(t.T, "retryingTester: Ignoring Fail for non-final run")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func testIntegration(t *testing.T, tester shellTester, onlineStatus OnlineStatus) {
|
func testIntegration(t *testing.T, tester shellTester, onlineStatus OnlineStatus) {
|
||||||
// Set up
|
// Set up
|
||||||
defer testutils.BackupAndRestore(t)()
|
defer testutils.BackupAndRestore(t)()
|
||||||
@ -392,16 +227,6 @@ yes | hishtory init `+userSecret)
|
|||||||
assertNoLeakedConnections(t)
|
assertNoLeakedConnections(t)
|
||||||
}
|
}
|
||||||
|
|
||||||
func installHishtory(t testing.TB, tester shellTester, userSecret string) string {
|
|
||||||
out := tester.RunInteractiveShell(t, ` /tmp/client install `+userSecret)
|
|
||||||
r := regexp.MustCompile(`Setting secret hishtory key to (.*)`)
|
|
||||||
matches := r.FindStringSubmatch(out)
|
|
||||||
if len(matches) != 2 {
|
|
||||||
t.Fatalf("Failed to extract userSecret from output=%#v: matches=%#v", out, matches)
|
|
||||||
}
|
|
||||||
return matches[1]
|
|
||||||
}
|
|
||||||
|
|
||||||
func installWithOnlineStatus(t testing.TB, tester shellTester, onlineStatus OnlineStatus) string {
|
func installWithOnlineStatus(t testing.TB, tester shellTester, onlineStatus OnlineStatus) string {
|
||||||
if onlineStatus == Online {
|
if onlineStatus == Online {
|
||||||
return installHishtory(t, tester, "")
|
return installHishtory(t, tester, "")
|
||||||
@ -410,16 +235,6 @@ func installWithOnlineStatus(t testing.TB, tester shellTester, onlineStatus Onli
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func assertOnlineStatus(t testing.TB, onlineStatus OnlineStatus) {
|
|
||||||
config := hctx.GetConf(hctx.MakeContext())
|
|
||||||
if onlineStatus == Online && config.IsOffline == true {
|
|
||||||
t.Fatalf("We're supposed to be online, yet config.IsOffline=%#v (config=%#v)", config.IsOffline, config)
|
|
||||||
}
|
|
||||||
if onlineStatus == Offline && config.IsOffline == false {
|
|
||||||
t.Fatalf("We're supposed to be offline, yet config.IsOffline=%#v (config=%#v)", config.IsOffline, config)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func testBasicUserFlow(t *testing.T, tester shellTester, onlineStatus OnlineStatus) string {
|
func testBasicUserFlow(t *testing.T, tester shellTester, onlineStatus OnlineStatus) string {
|
||||||
// Test install
|
// Test install
|
||||||
userSecret := installWithOnlineStatus(t, tester, onlineStatus)
|
userSecret := installWithOnlineStatus(t, tester, onlineStatus)
|
||||||
@ -893,14 +708,6 @@ echo hello2
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func getPidofCommand() string {
|
|
||||||
if runtime.GOOS == "darwin" {
|
|
||||||
// MacOS doesn't have pidof by default
|
|
||||||
return "pgrep"
|
|
||||||
}
|
|
||||||
return "pidof"
|
|
||||||
}
|
|
||||||
|
|
||||||
func waitForBackgroundSavesToComplete(t testing.TB) {
|
func waitForBackgroundSavesToComplete(t testing.TB) {
|
||||||
lastOut := ""
|
lastOut := ""
|
||||||
lastErr := ""
|
lastErr := ""
|
||||||
@ -926,36 +733,6 @@ func waitForBackgroundSavesToComplete(t testing.TB) {
|
|||||||
t.Fatalf("failed to wait until hishtory wasn't running (lastOut=%#v, lastErr=%#v)", lastOut, lastErr)
|
t.Fatalf("failed to wait until hishtory wasn't running (lastOut=%#v, lastErr=%#v)", lastOut, lastErr)
|
||||||
}
|
}
|
||||||
|
|
||||||
func hishtoryQuery(t testing.TB, tester shellTester, query string) string {
|
|
||||||
return tester.RunInteractiveShell(t, "hishtory query "+query)
|
|
||||||
}
|
|
||||||
|
|
||||||
func manuallySubmitHistoryEntry(t testing.TB, userSecret string, entry data.HistoryEntry) {
|
|
||||||
encEntry, err := data.EncryptHistoryEntry(userSecret, entry)
|
|
||||||
testutils.Check(t, err)
|
|
||||||
if encEntry.Date != entry.EndTime {
|
|
||||||
t.Fatalf("encEntry.Date does not match the entry")
|
|
||||||
}
|
|
||||||
jsonValue, err := json.Marshal([]shared.EncHistoryEntry{encEntry})
|
|
||||||
testutils.Check(t, err)
|
|
||||||
require.NotEqual(t, "", entry.DeviceId)
|
|
||||||
resp, err := http.Post("http://localhost:8080/api/v1/submit?source_device_id="+entry.DeviceId, "application/json", bytes.NewBuffer(jsonValue))
|
|
||||||
testutils.Check(t, err)
|
|
||||||
if resp.StatusCode != 200 {
|
|
||||||
t.Fatalf("failed to submit result to backend, status_code=%d", resp.StatusCode)
|
|
||||||
}
|
|
||||||
defer resp.Body.Close()
|
|
||||||
respBody, err := io.ReadAll(resp.Body)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("failed to read resp.Body: %v", err)
|
|
||||||
}
|
|
||||||
submitResp := shared.SubmitResponse{}
|
|
||||||
err = json.Unmarshal(respBody, &submitResp)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("failed to deserialize SubmitResponse: %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func testTimestampsAreReasonablyCorrect(t *testing.T, tester shellTester) {
|
func testTimestampsAreReasonablyCorrect(t *testing.T, tester shellTester) {
|
||||||
// Setup
|
// Setup
|
||||||
defer testutils.BackupAndRestore(t)()
|
defer testutils.BackupAndRestore(t)()
|
||||||
@ -2032,73 +1809,6 @@ func testTui_general(t testing.TB) {
|
|||||||
assertNoLeakedConnections(t)
|
assertNoLeakedConnections(t)
|
||||||
}
|
}
|
||||||
|
|
||||||
func captureTerminalOutput(t testing.TB, tester shellTester, commands []string) string {
|
|
||||||
return captureTerminalOutputWithShellName(t, tester, tester.ShellName(), commands)
|
|
||||||
}
|
|
||||||
|
|
||||||
func captureTerminalOutputWithComplexCommands(t testing.TB, tester shellTester, commands []TmuxCommand) string {
|
|
||||||
return captureTerminalOutputWithShellNameAndDimensions(t, tester, tester.ShellName(), 200, 50, commands)
|
|
||||||
}
|
|
||||||
|
|
||||||
type TmuxCommand struct {
|
|
||||||
Keys string
|
|
||||||
ResizeX int
|
|
||||||
ResizeY int
|
|
||||||
ExtraDelay float64
|
|
||||||
}
|
|
||||||
|
|
||||||
func captureTerminalOutputWithShellName(t testing.TB, tester shellTester, overriddenShellName string, commands []string) string {
|
|
||||||
sCommands := make([]TmuxCommand, 0)
|
|
||||||
for _, command := range commands {
|
|
||||||
sCommands = append(sCommands, TmuxCommand{Keys: command})
|
|
||||||
}
|
|
||||||
return captureTerminalOutputWithShellNameAndDimensions(t, tester, overriddenShellName, 200, 50, sCommands)
|
|
||||||
}
|
|
||||||
|
|
||||||
func captureTerminalOutputWithShellNameAndDimensions(t testing.TB, tester shellTester, overriddenShellName string, width, height int, commands []TmuxCommand) string {
|
|
||||||
sleepAmount := "0.1"
|
|
||||||
if runtime.GOOS == "linux" {
|
|
||||||
sleepAmount = "0.2"
|
|
||||||
}
|
|
||||||
if overriddenShellName == "fish" {
|
|
||||||
// Fish is considerably slower so this is sadly necessary
|
|
||||||
sleepAmount = "0.5"
|
|
||||||
}
|
|
||||||
if testutils.IsGithubAction() {
|
|
||||||
sleepAmount = "0.5"
|
|
||||||
}
|
|
||||||
fullCommand := ""
|
|
||||||
fullCommand += " tmux kill-session -t foo || true\n"
|
|
||||||
fullCommand += fmt.Sprintf(" tmux -u new-session -d -x %d -y %d -s foo %s\n", width, height, overriddenShellName)
|
|
||||||
fullCommand += " sleep 1\n"
|
|
||||||
if overriddenShellName == "bash" {
|
|
||||||
fullCommand += " tmux send -t foo SPACE source SPACE ~/.bashrc ENTER\n"
|
|
||||||
}
|
|
||||||
fullCommand += " sleep " + sleepAmount + "\n"
|
|
||||||
for _, cmd := range commands {
|
|
||||||
if cmd.Keys != "" {
|
|
||||||
fullCommand += " tmux send -t foo -- "
|
|
||||||
fullCommand += cmd.Keys
|
|
||||||
fullCommand += "\n"
|
|
||||||
}
|
|
||||||
if cmd.ResizeX != 0 && cmd.ResizeY != 0 {
|
|
||||||
fullCommand += fmt.Sprintf(" tmux resize-window -t foo -x %d -y %d\n", cmd.ResizeX, cmd.ResizeY)
|
|
||||||
}
|
|
||||||
if cmd.ExtraDelay != 0 {
|
|
||||||
fullCommand += fmt.Sprintf(" sleep %f\n", cmd.ExtraDelay)
|
|
||||||
}
|
|
||||||
fullCommand += " sleep " + sleepAmount + "\n"
|
|
||||||
}
|
|
||||||
fullCommand += " sleep 2.5\n"
|
|
||||||
if testutils.IsGithubAction() {
|
|
||||||
fullCommand += " sleep 2.5\n"
|
|
||||||
}
|
|
||||||
fullCommand += " tmux capture-pane -t foo -p\n"
|
|
||||||
fullCommand += " tmux kill-session -t foo\n"
|
|
||||||
testutils.TestLog(t, "Running tmux command: "+fullCommand)
|
|
||||||
return strings.TrimSpace(tester.RunInteractiveShell(t, fullCommand))
|
|
||||||
}
|
|
||||||
|
|
||||||
func testControlR(t testing.TB, tester shellTester, shellName string, onlineStatus OnlineStatus) {
|
func testControlR(t testing.TB, tester shellTester, shellName string, onlineStatus OnlineStatus) {
|
||||||
// Setup
|
// Setup
|
||||||
defer testutils.BackupAndRestore(t)()
|
defer testutils.BackupAndRestore(t)()
|
||||||
@ -2594,45 +2304,6 @@ func TestSetConfigNoCorruption(t *testing.T) {
|
|||||||
doneWg.Wait()
|
doneWg.Wait()
|
||||||
}
|
}
|
||||||
|
|
||||||
type deviceSet struct {
|
|
||||||
deviceMap *map[device]deviceOp
|
|
||||||
currentDevice *device
|
|
||||||
}
|
|
||||||
|
|
||||||
type device struct {
|
|
||||||
key string
|
|
||||||
deviceId string
|
|
||||||
}
|
|
||||||
|
|
||||||
type deviceOp struct {
|
|
||||||
backup func()
|
|
||||||
restore func()
|
|
||||||
}
|
|
||||||
|
|
||||||
func createDevice(t testing.TB, tester shellTester, devices *deviceSet, key, deviceId string) {
|
|
||||||
d := device{key, deviceId}
|
|
||||||
_, ok := (*devices.deviceMap)[d]
|
|
||||||
if ok {
|
|
||||||
t.Fatalf("cannot create device twice for key=%s deviceId=%s", key, deviceId)
|
|
||||||
}
|
|
||||||
installHishtory(t, tester, key)
|
|
||||||
(*devices.deviceMap)[d] = deviceOp{
|
|
||||||
backup: func() { testutils.BackupAndRestoreWithId(t, key+deviceId) },
|
|
||||||
restore: testutils.BackupAndRestoreWithId(t, key+deviceId),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func switchToDevice(devices *deviceSet, d device) {
|
|
||||||
if devices.currentDevice != nil && d == *devices.currentDevice {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
if devices.currentDevice != nil {
|
|
||||||
(*devices.deviceMap)[*devices.currentDevice].backup()
|
|
||||||
}
|
|
||||||
devices.currentDevice = &d
|
|
||||||
(*devices.deviceMap)[d].restore()
|
|
||||||
}
|
|
||||||
|
|
||||||
func testMultipleUsers(t *testing.T, tester shellTester) {
|
func testMultipleUsers(t *testing.T, tester shellTester) {
|
||||||
defer testutils.BackupAndRestore(t)()
|
defer testutils.BackupAndRestore(t)()
|
||||||
|
|
||||||
@ -2705,14 +2376,4 @@ func testMultipleUsers(t *testing.T, tester shellTester) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func assertNoLeakedConnections(t testing.TB) {
|
|
||||||
resp, err := lib.ApiGet("/api/v1/get-num-connections")
|
|
||||||
testutils.Check(t, err)
|
|
||||||
numConnections, err := strconv.Atoi(string(resp))
|
|
||||||
testutils.Check(t, err)
|
|
||||||
if numConnections > 1 {
|
|
||||||
t.Fatalf("DB has %d open connections, expected to have 1 or less", numConnections)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TODO: somehow test/confirm that hishtory works even if only bash/only zsh is installed
|
// TODO: somehow test/confirm that hishtory works even if only bash/only zsh is installed
|
||||||
|
|||||||
357
client/testutils.go
Normal file
357
client/testutils.go
Normal file
@ -0,0 +1,357 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"net/http"
|
||||||
|
"os/exec"
|
||||||
|
"regexp"
|
||||||
|
"runtime"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/DataDog/datadog-go/statsd"
|
||||||
|
"github.com/ddworken/hishtory/client/data"
|
||||||
|
"github.com/ddworken/hishtory/client/hctx"
|
||||||
|
"github.com/ddworken/hishtory/client/lib"
|
||||||
|
"github.com/ddworken/hishtory/shared"
|
||||||
|
"github.com/ddworken/hishtory/shared/testutils"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
)
|
||||||
|
|
||||||
|
var GLOBAL_STATSD *statsd.Client
|
||||||
|
|
||||||
|
type shellTester interface {
|
||||||
|
RunInteractiveShell(t testing.TB, script string) string
|
||||||
|
RunInteractiveShellRelaxed(t testing.TB, script string) (string, error)
|
||||||
|
ShellName() string
|
||||||
|
}
|
||||||
|
type bashTester struct {
|
||||||
|
shellTester
|
||||||
|
}
|
||||||
|
|
||||||
|
func (b bashTester) RunInteractiveShell(t testing.TB, script string) string {
|
||||||
|
out, err := b.RunInteractiveShellRelaxed(t, "set -emo pipefail\n"+script)
|
||||||
|
if err != nil {
|
||||||
|
_, filename, line, _ := runtime.Caller(1)
|
||||||
|
t.Fatalf("error when running command at %s:%d: %v", filename, line, err)
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
func (b bashTester) RunInteractiveShellRelaxed(t testing.TB, script string) (string, error) {
|
||||||
|
cmd := exec.Command("bash", "-i")
|
||||||
|
cmd.Stdin = strings.NewReader(script)
|
||||||
|
var stdout bytes.Buffer
|
||||||
|
cmd.Stdout = &stdout
|
||||||
|
var stderr bytes.Buffer
|
||||||
|
cmd.Stderr = &stderr
|
||||||
|
err := cmd.Run()
|
||||||
|
if err != nil {
|
||||||
|
return "", fmt.Errorf("unexpected error when running commands, out=%#v, err=%#v: %w", stdout.String(), stderr.String(), err)
|
||||||
|
}
|
||||||
|
outStr := stdout.String()
|
||||||
|
require.NotContains(t, outStr, "hishtory fatal error", "Ran command, but hishtory had a fatal error!")
|
||||||
|
return outStr, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (b bashTester) ShellName() string {
|
||||||
|
return "bash"
|
||||||
|
}
|
||||||
|
|
||||||
|
type zshTester struct {
|
||||||
|
shellTester
|
||||||
|
}
|
||||||
|
|
||||||
|
func (z zshTester) RunInteractiveShell(t testing.TB, script string) string {
|
||||||
|
res, err := z.RunInteractiveShellRelaxed(t, "set -eo pipefail\n"+script)
|
||||||
|
require.NoError(t, err)
|
||||||
|
return res
|
||||||
|
}
|
||||||
|
|
||||||
|
func (z zshTester) RunInteractiveShellRelaxed(t testing.TB, script string) (string, error) {
|
||||||
|
cmd := exec.Command("zsh", "-is")
|
||||||
|
cmd.Stdin = strings.NewReader(script)
|
||||||
|
var stdout bytes.Buffer
|
||||||
|
cmd.Stdout = &stdout
|
||||||
|
var stderr bytes.Buffer
|
||||||
|
cmd.Stderr = &stderr
|
||||||
|
err := cmd.Run()
|
||||||
|
if err != nil {
|
||||||
|
return stdout.String(), fmt.Errorf("unexpected error when running command=%#v, out=%#v, err=%#v: %w", script, stdout.String(), stderr.String(), err)
|
||||||
|
}
|
||||||
|
outStr := stdout.String()
|
||||||
|
require.NotContains(t, outStr, "hishtory fatal error")
|
||||||
|
return outStr, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (z zshTester) ShellName() string {
|
||||||
|
return "zsh"
|
||||||
|
}
|
||||||
|
|
||||||
|
func runTestsWithRetries(parentT *testing.T, testName string, testFunc func(t testing.TB)) {
|
||||||
|
numRetries := 3
|
||||||
|
if testutils.IsGithubAction() {
|
||||||
|
numRetries = 5
|
||||||
|
}
|
||||||
|
runTestsWithExtraRetries(parentT, testName, testFunc, numRetries)
|
||||||
|
}
|
||||||
|
|
||||||
|
func runTestsWithExtraRetries(parentT *testing.T, testName string, testFunc func(t testing.TB), numRetries int) {
|
||||||
|
for i := 1; i <= numRetries; i++ {
|
||||||
|
rt := &retryingTester{nil, i == numRetries, true, testName, numRetries}
|
||||||
|
parentT.Run(fmt.Sprintf("%s/%d", testName, i), func(t *testing.T) {
|
||||||
|
rt.T = t
|
||||||
|
testFunc(rt)
|
||||||
|
})
|
||||||
|
if rt.succeeded {
|
||||||
|
if GLOBAL_STATSD != nil {
|
||||||
|
GLOBAL_STATSD.Incr("test_status", []string{"result:passed", "test:" + testName, "os:" + runtime.GOOS}, 1.0)
|
||||||
|
GLOBAL_STATSD.Distribution("test_retry_count", float64(i), []string{"test:" + testName, "os:" + runtime.GOOS}, 1.0)
|
||||||
|
}
|
||||||
|
break
|
||||||
|
} else {
|
||||||
|
if GLOBAL_STATSD != nil {
|
||||||
|
GLOBAL_STATSD.Incr("test_status", []string{"result:failed", "test:" + testName, "os:" + runtime.GOOS}, 1.0)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
type retryingTester struct {
|
||||||
|
*testing.T
|
||||||
|
isFinalRun bool
|
||||||
|
succeeded bool
|
||||||
|
testName string
|
||||||
|
numRetries int
|
||||||
|
}
|
||||||
|
|
||||||
|
func (t *retryingTester) Fatalf(format string, args ...any) {
|
||||||
|
t.T.Helper()
|
||||||
|
t.succeeded = false
|
||||||
|
if t.isFinalRun {
|
||||||
|
if GLOBAL_STATSD != nil {
|
||||||
|
GLOBAL_STATSD.Incr("test_failure", []string{"test:" + t.testName, "os:" + runtime.GOOS}, 1.0)
|
||||||
|
GLOBAL_STATSD.Distribution("test_retry_count", float64(t.numRetries), []string{"test:" + t.testName, "os:" + runtime.GOOS}, 1.0)
|
||||||
|
}
|
||||||
|
t.T.Fatalf(format, args...)
|
||||||
|
} else {
|
||||||
|
testutils.TestLog(t.T, fmt.Sprintf("retryingTester: Ignoring fatalf for non-final run: %#v", fmt.Sprintf(format, args...)))
|
||||||
|
}
|
||||||
|
t.SkipNow()
|
||||||
|
}
|
||||||
|
|
||||||
|
func (t *retryingTester) Errorf(format string, args ...any) {
|
||||||
|
t.T.Helper()
|
||||||
|
t.succeeded = false
|
||||||
|
if t.isFinalRun {
|
||||||
|
t.T.Errorf(format, args...)
|
||||||
|
} else {
|
||||||
|
testutils.TestLog(t.T, fmt.Sprintf("retryingTester: Ignoring errorf for non-final run: %#v", fmt.Sprintf(format, args...)))
|
||||||
|
}
|
||||||
|
t.SkipNow()
|
||||||
|
}
|
||||||
|
|
||||||
|
func (t *retryingTester) FailNow() {
|
||||||
|
t.succeeded = false
|
||||||
|
if t.isFinalRun {
|
||||||
|
t.T.FailNow()
|
||||||
|
} else {
|
||||||
|
testutils.TestLog(t.T, "retryingTester: Ignoring FailNow for non-final run")
|
||||||
|
// Still terminate execution via SkipNow() since FailNow() means we should stop the current test
|
||||||
|
t.T.SkipNow()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (t *retryingTester) Fail() {
|
||||||
|
t.succeeded = false
|
||||||
|
if t.isFinalRun {
|
||||||
|
t.T.Fail()
|
||||||
|
} else {
|
||||||
|
testutils.TestLog(t.T, "retryingTester: Ignoring Fail for non-final run")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
type OnlineStatus int64
|
||||||
|
|
||||||
|
const (
|
||||||
|
Online OnlineStatus = iota
|
||||||
|
Offline
|
||||||
|
)
|
||||||
|
|
||||||
|
func assertOnlineStatus(t testing.TB, onlineStatus OnlineStatus) {
|
||||||
|
config := hctx.GetConf(hctx.MakeContext())
|
||||||
|
if onlineStatus == Online && config.IsOffline {
|
||||||
|
t.Fatalf("We're supposed to be online, yet config.IsOffline=%#v (config=%#v)", config.IsOffline, config)
|
||||||
|
}
|
||||||
|
if onlineStatus == Offline && !config.IsOffline {
|
||||||
|
t.Fatalf("We're supposed to be offline, yet config.IsOffline=%#v (config=%#v)", config.IsOffline, config)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func hishtoryQuery(t testing.TB, tester shellTester, query string) string {
|
||||||
|
return tester.RunInteractiveShell(t, "hishtory query "+query)
|
||||||
|
}
|
||||||
|
|
||||||
|
func manuallySubmitHistoryEntry(t testing.TB, userSecret string, entry data.HistoryEntry) {
|
||||||
|
encEntry, err := data.EncryptHistoryEntry(userSecret, entry)
|
||||||
|
testutils.Check(t, err)
|
||||||
|
if encEntry.Date != entry.EndTime {
|
||||||
|
t.Fatalf("encEntry.Date does not match the entry")
|
||||||
|
}
|
||||||
|
jsonValue, err := json.Marshal([]shared.EncHistoryEntry{encEntry})
|
||||||
|
testutils.Check(t, err)
|
||||||
|
require.NotEqual(t, "", entry.DeviceId)
|
||||||
|
resp, err := http.Post("http://localhost:8080/api/v1/submit?source_device_id="+entry.DeviceId, "application/json", bytes.NewBuffer(jsonValue))
|
||||||
|
testutils.Check(t, err)
|
||||||
|
if resp.StatusCode != 200 {
|
||||||
|
t.Fatalf("failed to submit result to backend, status_code=%d", resp.StatusCode)
|
||||||
|
}
|
||||||
|
defer resp.Body.Close()
|
||||||
|
respBody, err := io.ReadAll(resp.Body)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to read resp.Body: %v", err)
|
||||||
|
}
|
||||||
|
submitResp := shared.SubmitResponse{}
|
||||||
|
err = json.Unmarshal(respBody, &submitResp)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to deserialize SubmitResponse: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func captureTerminalOutput(t testing.TB, tester shellTester, commands []string) string {
|
||||||
|
return captureTerminalOutputWithShellName(t, tester, tester.ShellName(), commands)
|
||||||
|
}
|
||||||
|
|
||||||
|
func captureTerminalOutputWithComplexCommands(t testing.TB, tester shellTester, commands []TmuxCommand) string {
|
||||||
|
return captureTerminalOutputWithShellNameAndDimensions(t, tester, tester.ShellName(), 200, 50, commands)
|
||||||
|
}
|
||||||
|
|
||||||
|
type TmuxCommand struct {
|
||||||
|
Keys string
|
||||||
|
ResizeX int
|
||||||
|
ResizeY int
|
||||||
|
ExtraDelay float64
|
||||||
|
}
|
||||||
|
|
||||||
|
func captureTerminalOutputWithShellName(t testing.TB, tester shellTester, overriddenShellName string, commands []string) string {
|
||||||
|
sCommands := make([]TmuxCommand, 0)
|
||||||
|
for _, command := range commands {
|
||||||
|
sCommands = append(sCommands, TmuxCommand{Keys: command})
|
||||||
|
}
|
||||||
|
return captureTerminalOutputWithShellNameAndDimensions(t, tester, overriddenShellName, 200, 50, sCommands)
|
||||||
|
}
|
||||||
|
|
||||||
|
func captureTerminalOutputWithShellNameAndDimensions(t testing.TB, tester shellTester, overriddenShellName string, width, height int, commands []TmuxCommand) string {
|
||||||
|
sleepAmount := "0.1"
|
||||||
|
if runtime.GOOS == "linux" {
|
||||||
|
sleepAmount = "0.2"
|
||||||
|
}
|
||||||
|
if overriddenShellName == "fish" {
|
||||||
|
// Fish is considerably slower so this is sadly necessary
|
||||||
|
sleepAmount = "0.5"
|
||||||
|
}
|
||||||
|
if testutils.IsGithubAction() {
|
||||||
|
sleepAmount = "0.5"
|
||||||
|
}
|
||||||
|
fullCommand := ""
|
||||||
|
fullCommand += " tmux kill-session -t foo || true\n"
|
||||||
|
fullCommand += fmt.Sprintf(" tmux -u new-session -d -x %d -y %d -s foo %s\n", width, height, overriddenShellName)
|
||||||
|
fullCommand += " sleep 1\n"
|
||||||
|
if overriddenShellName == "bash" {
|
||||||
|
fullCommand += " tmux send -t foo SPACE source SPACE ~/.bashrc ENTER\n"
|
||||||
|
}
|
||||||
|
fullCommand += " sleep " + sleepAmount + "\n"
|
||||||
|
for _, cmd := range commands {
|
||||||
|
if cmd.Keys != "" {
|
||||||
|
fullCommand += " tmux send -t foo -- "
|
||||||
|
fullCommand += cmd.Keys
|
||||||
|
fullCommand += "\n"
|
||||||
|
}
|
||||||
|
if cmd.ResizeX != 0 && cmd.ResizeY != 0 {
|
||||||
|
fullCommand += fmt.Sprintf(" tmux resize-window -t foo -x %d -y %d\n", cmd.ResizeX, cmd.ResizeY)
|
||||||
|
}
|
||||||
|
if cmd.ExtraDelay != 0 {
|
||||||
|
fullCommand += fmt.Sprintf(" sleep %f\n", cmd.ExtraDelay)
|
||||||
|
}
|
||||||
|
fullCommand += " sleep " + sleepAmount + "\n"
|
||||||
|
}
|
||||||
|
fullCommand += " sleep 2.5\n"
|
||||||
|
if testutils.IsGithubAction() {
|
||||||
|
fullCommand += " sleep 2.5\n"
|
||||||
|
}
|
||||||
|
fullCommand += " tmux capture-pane -t foo -p\n"
|
||||||
|
fullCommand += " tmux kill-session -t foo\n"
|
||||||
|
testutils.TestLog(t, "Running tmux command: "+fullCommand)
|
||||||
|
return strings.TrimSpace(tester.RunInteractiveShell(t, fullCommand))
|
||||||
|
}
|
||||||
|
|
||||||
|
func assertNoLeakedConnections(t testing.TB) {
|
||||||
|
resp, err := lib.ApiGet("/api/v1/get-num-connections")
|
||||||
|
testutils.Check(t, err)
|
||||||
|
numConnections, err := strconv.Atoi(string(resp))
|
||||||
|
testutils.Check(t, err)
|
||||||
|
if numConnections > 1 {
|
||||||
|
t.Fatalf("DB has %d open connections, expected to have 1 or less", numConnections)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func getPidofCommand() string {
|
||||||
|
if runtime.GOOS == "darwin" {
|
||||||
|
// MacOS doesn't have pidof by default
|
||||||
|
return "pgrep"
|
||||||
|
}
|
||||||
|
return "pidof"
|
||||||
|
}
|
||||||
|
|
||||||
|
type deviceSet struct {
|
||||||
|
deviceMap *map[device]deviceOp
|
||||||
|
currentDevice *device
|
||||||
|
}
|
||||||
|
|
||||||
|
type device struct {
|
||||||
|
key string
|
||||||
|
deviceId string
|
||||||
|
}
|
||||||
|
|
||||||
|
type deviceOp struct {
|
||||||
|
backup func()
|
||||||
|
restore func()
|
||||||
|
}
|
||||||
|
|
||||||
|
func createDevice(t testing.TB, tester shellTester, devices *deviceSet, key, deviceId string) {
|
||||||
|
d := device{key, deviceId}
|
||||||
|
_, ok := (*devices.deviceMap)[d]
|
||||||
|
if ok {
|
||||||
|
t.Fatalf("cannot create device twice for key=%s deviceId=%s", key, deviceId)
|
||||||
|
}
|
||||||
|
installHishtory(t, tester, key)
|
||||||
|
(*devices.deviceMap)[d] = deviceOp{
|
||||||
|
backup: func() { testutils.BackupAndRestoreWithId(t, key+deviceId) },
|
||||||
|
restore: testutils.BackupAndRestoreWithId(t, key+deviceId),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func switchToDevice(devices *deviceSet, d device) {
|
||||||
|
if devices.currentDevice != nil && d == *devices.currentDevice {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if devices.currentDevice != nil {
|
||||||
|
(*devices.deviceMap)[*devices.currentDevice].backup()
|
||||||
|
}
|
||||||
|
devices.currentDevice = &d
|
||||||
|
(*devices.deviceMap)[d].restore()
|
||||||
|
}
|
||||||
|
|
||||||
|
func installHishtory(t testing.TB, tester shellTester, userSecret string) string {
|
||||||
|
out := tester.RunInteractiveShell(t, ` /tmp/client install `+userSecret)
|
||||||
|
r := regexp.MustCompile(`Setting secret hishtory key to (.*)`)
|
||||||
|
matches := r.FindStringSubmatch(out)
|
||||||
|
if len(matches) != 2 {
|
||||||
|
t.Fatalf("Failed to extract userSecret from output=%#v: matches=%#v", out, matches)
|
||||||
|
}
|
||||||
|
return matches[1]
|
||||||
|
}
|
||||||
Loading…
x
Reference in New Issue
Block a user