2022-01-09 20:00:53 +01:00
package main
import (
"bytes"
2022-04-07 08:17:58 +02:00
"encoding/json"
2022-04-07 07:44:10 +02:00
"fmt"
2022-04-07 08:17:58 +02:00
"net/http"
2022-04-07 07:43:07 +02:00
"os"
2022-04-07 07:44:10 +02:00
"os/exec"
2022-04-16 09:56:08 +02:00
"path"
2022-01-09 23:34:59 +01:00
"regexp"
2022-04-12 07:36:52 +02:00
"runtime"
2022-09-17 20:49:31 +02:00
"strconv"
2022-01-09 23:34:59 +01:00
"strings"
2022-01-09 20:00:53 +01:00
"testing"
2022-04-15 05:18:49 +02:00
"time"
"github.com/google/go-cmp/cmp"
2022-09-17 20:49:31 +02:00
"github.com/google/uuid"
2022-01-09 20:00:53 +01:00
2022-04-08 05:59:40 +02:00
"github.com/ddworken/hishtory/client/data"
2022-09-21 07:28:40 +02:00
"github.com/ddworken/hishtory/client/hctx"
2022-05-02 04:37:26 +02:00
"github.com/ddworken/hishtory/client/lib"
2022-01-09 20:00:53 +01:00
"github.com/ddworken/hishtory/shared"
)
2022-09-28 07:03:37 +02:00
func skipSlowTests ( ) bool {
return os . Getenv ( "FAST" ) != ""
}
2022-04-15 20:20:23 +02:00
func TestMain ( m * testing . M ) {
defer shared . RunTestServer ( ) ( )
2022-04-16 03:12:26 +02:00
cmd := exec . Command ( "go" , "build" , "-o" , "/tmp/client" )
2022-09-22 04:58:10 +02:00
cmd . Env = os . Environ ( )
cmd . Env = append ( cmd . Env , "CGO_ENABLED=0" )
2022-04-16 03:12:26 +02:00
err := cmd . Run ( )
if err != nil {
panic ( fmt . Sprintf ( "failed to build client: %v" , err ) )
}
2022-04-15 20:20:23 +02:00
m . Run ( )
}
2022-04-18 04:54:17 +02:00
type shellTester interface {
RunInteractiveShell ( t * testing . T , script string ) string
RunInteractiveShellRelaxed ( t * testing . T , script string ) ( string , error )
ShellName ( ) string
}
type bashTester struct {
shellTester
}
func ( b bashTester ) RunInteractiveShell ( t * testing . T , script string ) string {
out , err := b . RunInteractiveShellRelaxed ( t , "set -emo pipefail\n" + script )
2022-04-08 08:25:13 +02:00
if err != nil {
2022-04-12 07:36:52 +02:00
_ , filename , line , _ := runtime . Caller ( 1 )
t . Fatalf ( "error when running command at %s:%d: %v" , filename , line , err )
2022-04-08 08:25:13 +02:00
}
return out
}
2022-04-18 04:54:17 +02:00
func ( b bashTester ) RunInteractiveShellRelaxed ( t * testing . T , script string ) ( string , error ) {
2022-01-09 23:34:59 +01:00
cmd := exec . Command ( "bash" , "-i" )
cmd . Stdin = strings . NewReader ( script )
2022-04-08 08:25:13 +02:00
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: %v" , stdout . String ( ) , stderr . String ( ) , err )
}
outStr := stdout . String ( )
2022-04-15 05:18:49 +02:00
if strings . Contains ( outStr , "hishtory fatal error" ) {
2022-04-07 08:05:30 +02:00
t . Fatalf ( "Ran command, but hishtory had a fatal error! out=%#v" , outStr )
}
2022-04-08 08:25:13 +02:00
return outStr , nil
2022-01-09 23:34:59 +01:00
}
2022-04-18 04:54:17 +02:00
func ( b bashTester ) ShellName ( ) string {
return "bash"
}
type zshTester struct {
shellTester
}
func ( z zshTester ) RunInteractiveShell ( t * testing . T , script string ) string {
2022-06-05 08:11:26 +02:00
res , err := z . RunInteractiveShellRelaxed ( t , "set -eo pipefail\n" + script )
2022-04-18 04:54:17 +02:00
if err != nil {
t . Fatal ( err )
}
return res
}
func ( z zshTester ) RunInteractiveShellRelaxed ( t * testing . T , 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 {
2022-09-18 06:56:39 +02:00
return stdout . String ( ) , fmt . Errorf ( "unexpected error when running command=%#v, out=%#v, err=%#v: %v" , script , stdout . String ( ) , stderr . String ( ) , err )
2022-04-18 04:54:17 +02:00
}
outStr := stdout . String ( )
if strings . Contains ( outStr , "hishtory fatal error" ) {
t . Fatalf ( "Ran command, but hishtory had a fatal error! out=%#v" , outStr )
}
return outStr , nil
}
func ( z zshTester ) ShellName ( ) string {
return "zsh"
}
var shellTesters [ ] shellTester = [ ] shellTester { bashTester { } , zshTester { } }
func TestParameterized ( t * testing . T ) {
2022-09-28 07:03:37 +02:00
if skipSlowTests ( ) {
shellTesters = shellTesters [ : 1 ]
}
2022-04-18 04:54:17 +02:00
for _ , tester := range shellTesters {
t . Run ( "testRepeatedCommandThenQuery/" + tester . ShellName ( ) , func ( t * testing . T ) { testRepeatedCommandThenQuery ( t , tester ) } )
t . Run ( "testRepeatedCommandAndQuery/" + tester . ShellName ( ) , func ( t * testing . T ) { testRepeatedCommandAndQuery ( t , tester ) } )
t . Run ( "testRepeatedEnableDisable/" + tester . ShellName ( ) , func ( t * testing . T ) { testRepeatedEnableDisable ( t , tester ) } )
t . Run ( "testExcludeHiddenCommand/" + tester . ShellName ( ) , func ( t * testing . T ) { testExcludeHiddenCommand ( t , tester ) } )
t . Run ( "testUpdate/" + tester . ShellName ( ) , func ( t * testing . T ) { testUpdate ( t , tester ) } )
t . Run ( "testAdvancedQuery/" + tester . ShellName ( ) , func ( t * testing . T ) { testAdvancedQuery ( t , tester ) } )
t . Run ( "testIntegration/" + tester . ShellName ( ) , func ( t * testing . T ) { testIntegration ( t , tester ) } )
t . Run ( "testIntegrationWithNewDevice/" + tester . ShellName ( ) , func ( t * testing . T ) { testIntegrationWithNewDevice ( t , tester ) } )
t . Run ( "testHishtoryBackgroundSaving/" + tester . ShellName ( ) , func ( t * testing . T ) { testHishtoryBackgroundSaving ( t , tester ) } )
t . Run ( "testDisplayTable/" + tester . ShellName ( ) , func ( t * testing . T ) { testDisplayTable ( t , tester ) } )
2022-04-19 08:07:39 +02:00
t . Run ( "testTableDisplayCwd/" + tester . ShellName ( ) , func ( t * testing . T ) { testTableDisplayCwd ( t , tester ) } )
2022-04-19 07:07:10 +02:00
t . Run ( "testTimestampsAreReasonablyCorrect/" + tester . ShellName ( ) , func ( t * testing . T ) { testTimestampsAreReasonablyCorrect ( t , tester ) } )
2022-05-02 04:37:26 +02:00
t . Run ( "testRequestAndReceiveDbDump/" + tester . ShellName ( ) , func ( t * testing . T ) { testRequestAndReceiveDbDump ( t , tester ) } )
2022-06-05 07:27:04 +02:00
t . Run ( "testInstallViaPythonScript/" + tester . ShellName ( ) , func ( t * testing . T ) { testInstallViaPythonScript ( t , tester ) } )
2022-06-06 03:05:06 +02:00
t . Run ( "testExportWithQuery/" + tester . ShellName ( ) , func ( t * testing . T ) { testExportWithQuery ( t , tester ) } )
2022-06-06 03:26:02 +02:00
t . Run ( "testHelpCommand/" + tester . ShellName ( ) , func ( t * testing . T ) { testHelpCommand ( t , tester ) } )
2022-06-13 06:28:19 +02:00
t . Run ( "testStripBashTimePrefix/" + tester . ShellName ( ) , func ( t * testing . T ) { testStripBashTimePrefix ( t , tester ) } )
2022-09-05 03:37:46 +02:00
t . Run ( "testReuploadHistoryEntries/" + tester . ShellName ( ) , func ( t * testing . T ) { testReuploadHistoryEntries ( t , tester ) } )
2022-09-22 05:09:49 +02:00
t . Run ( "testHishtoryOffline/" + tester . ShellName ( ) , func ( t * testing . T ) { testHishtoryOffline ( t , tester ) } )
2022-09-17 20:49:31 +02:00
t . Run ( "testInitialHistoryImport/" + tester . ShellName ( ) , func ( t * testing . T ) { testInitialHistoryImport ( t , tester ) } )
2022-09-20 07:49:48 +02:00
t . Run ( "testLocalRedaction/" + tester . ShellName ( ) , func ( t * testing . T ) { testLocalRedaction ( t , tester ) } )
t . Run ( "testRemoteRedaction/" + tester . ShellName ( ) , func ( t * testing . T ) { testRemoteRedaction ( t , tester ) } )
2022-09-23 06:45:20 +02:00
t . Run ( "testMultipleUsers/" + tester . ShellName ( ) , func ( t * testing . T ) { testMultipleUsers ( t , tester ) } )
2022-10-16 21:43:16 +02:00
t . Run ( "testConfigGetSet/" + tester . ShellName ( ) , func ( t * testing . T ) { testConfigGetSet ( t , tester ) } )
2022-10-18 06:58:56 +02:00
t . Run ( "testTui/" + tester . ShellName ( ) , func ( t * testing . T ) { testTui ( t , tester ) } )
2022-10-15 18:29:47 +02:00
// TODO: Add a test for multi-line history entries
2022-04-18 04:54:17 +02:00
}
}
func testIntegration ( t * testing . T , tester shellTester ) {
2022-01-09 20:00:53 +01:00
// Set up
2022-03-30 06:56:28 +02:00
defer shared . BackupAndRestore ( t ) ( )
2022-04-07 03:18:46 +02:00
// Run the test
2022-04-18 04:54:17 +02:00
testBasicUserFlow ( t , tester )
2022-04-06 08:31:24 +02:00
}
2022-01-09 20:00:53 +01:00
2022-04-18 04:54:17 +02:00
func testIntegrationWithNewDevice ( t * testing . T , tester shellTester ) {
2022-04-06 08:31:24 +02:00
// Set up
defer shared . BackupAndRestore ( t ) ( )
2022-04-07 03:18:46 +02:00
// Run the test
2022-04-18 04:54:17 +02:00
userSecret := testBasicUserFlow ( t , tester )
2022-04-06 08:31:24 +02:00
// Clear all local state
shared . ResetLocalState ( t )
// Install it again
2022-04-18 04:54:17 +02:00
installHishtory ( t , tester , userSecret )
2022-01-09 23:34:59 +01:00
2022-04-07 03:18:46 +02:00
// Querying should show the history from the previous run
2022-04-18 04:54:17 +02:00
out := hishtoryQuery ( t , tester , "" )
2022-04-06 08:31:24 +02:00
expected := [ ] string { "echo thisisrecorded" , "hishtory enable" , "echo bar" , "echo foo" , "ls /foo" , "ls /bar" , "ls /a" }
for _ , item := range expected {
if ! strings . Contains ( out , item ) {
t . Fatalf ( "output is missing expected item %#v: %#v" , item , out )
}
if strings . Count ( out , item ) != 1 {
t . Fatalf ( "output has %#v in it multiple times! out=%#v" , item , out )
}
}
2022-04-18 04:54:17 +02:00
tester . RunInteractiveShell ( t , "echo mynewcommand" )
out = hishtoryQuery ( t , tester , "" )
2022-04-06 08:31:24 +02:00
if ! strings . Contains ( out , "echo mynewcommand" ) {
t . Fatalf ( "output is missing `echo mynewcommand`" )
}
if strings . Count ( out , "echo mynewcommand" ) != 1 {
t . Fatalf ( "output has `echo mynewcommand` the wrong number of times" )
}
2022-04-07 03:18:46 +02:00
// Clear local state again
2022-04-07 02:47:21 +02:00
shared . ResetLocalState ( t )
// Install it a 3rd time
2022-04-18 04:54:17 +02:00
installHishtory ( t , tester , "adifferentsecret" )
2022-04-07 02:47:21 +02:00
2022-04-07 07:43:07 +02:00
// Run a command that shouldn't be in the hishtory later on
2022-04-18 04:54:17 +02:00
tester . RunInteractiveShell ( t , ` echo notinthehistory ` )
out = hishtoryQuery ( t , tester , "" )
2022-04-07 07:43:07 +02:00
if ! strings . Contains ( out , "echo notinthehistory" ) {
t . Fatalf ( "output is missing `echo notinthehistory`" )
}
2022-04-07 03:18:46 +02:00
// Set the secret key to the previous secret key
2022-10-01 18:50:06 +02:00
out , err := tester . RunInteractiveShellRelaxed ( t , ` yes | hishtory init ` + userSecret )
shared . Check ( t , err )
2022-04-07 03:18:46 +02:00
if ! strings . Contains ( out , "Setting secret hishtory key to " + userSecret ) {
2022-04-07 02:47:21 +02:00
t . Fatalf ( "Failed to re-init with the user secret: %v" , out )
}
2022-04-07 03:18:46 +02:00
// Querying should show the history from the previous run
2022-04-18 04:54:17 +02:00
out = hishtoryQuery ( t , tester , "" )
2022-04-07 02:47:21 +02:00
expected = [ ] string { "echo thisisrecorded" , "echo mynewcommand" , "hishtory enable" , "echo bar" , "echo foo" , "ls /foo" , "ls /bar" , "ls /a" }
for _ , item := range expected {
if ! strings . Contains ( out , item ) {
t . Fatalf ( "output is missing expected item %#v: %#v" , item , out )
}
if strings . Count ( out , item ) != 1 {
t . Fatalf ( "output has %#v in it multiple times! out=%#v" , item , out )
}
}
2022-04-07 07:43:07 +02:00
// But not from the previous account
if strings . Contains ( out , "notinthehistory" ) {
t . Fatalf ( "output contains the unexpected item: notinthehistory" )
}
2022-04-07 02:47:21 +02:00
2022-04-18 04:54:17 +02:00
tester . RunInteractiveShell ( t , "echo mynewercommand" )
out = hishtoryQuery ( t , tester , "" )
2022-04-07 02:47:21 +02:00
if ! strings . Contains ( out , "echo mynewercommand" ) {
t . Fatalf ( "output is missing `echo mynewercommand`" )
}
if strings . Count ( out , "echo mynewercommand" ) != 1 {
t . Fatalf ( "output has `echo mynewercommand` the wrong number of times" )
}
2022-04-06 08:31:24 +02:00
2022-04-07 07:49:45 +02:00
// Manually submit an event that isn't in the local DB, and then we'll
2022-04-07 08:17:58 +02:00
// check if we see it when we do a query without ever having done an init
2022-04-08 05:59:40 +02:00
newEntry := data . MakeFakeHistoryEntry ( "othercomputer" )
2022-04-11 02:38:20 +02:00
manuallySubmitHistoryEntry ( t , userSecret , newEntry )
2022-04-07 08:17:58 +02:00
// Now check if that is in there when we do hishtory query
2022-04-18 04:54:17 +02:00
out = hishtoryQuery ( t , tester , "" )
2022-04-07 07:49:45 +02:00
if ! strings . Contains ( out , "othercomputer" ) {
t . Fatalf ( "hishtory query doesn't contain cmd run on another machine! out=%#v" , out )
}
2022-04-07 08:05:30 +02:00
2022-10-09 21:13:05 +02:00
// Run a reupload just to test that flow
tester . RunInteractiveShell ( t , "hishtory reupload" )
2022-04-07 08:05:30 +02:00
// Finally, test the export command
2022-04-18 04:54:17 +02:00
out = tester . RunInteractiveShell ( t , ` hishtory export | grep -v pipefail | grep -v '/tmp/client install' ` )
2022-04-15 05:18:49 +02:00
if strings . Contains ( out , "thisisnotrecorded" ) {
t . Fatalf ( "hishtory export contains a command that should not have been recorded, out=%#v" , out )
}
2022-10-09 21:13:05 +02:00
expectedOutputWithoutKey := "hishtory status\nhishtory query\nls /a\nls /bar\nls /foo\necho foo\necho bar\nhishtory enable\necho thisisrecorded\nhishtory query\nhishtory query foo\necho hello | grep complex | sed s/h/i/g; echo baz && echo \"fo 'o\"\nhishtory query complex\nhishtory query\necho mynewcommand\nhishtory query\nyes | hishtory init %s\nhishtory query\necho mynewercommand\nhishtory query\nothercomputer\nhishtory query\nhishtory reupload\n"
2022-04-15 05:18:49 +02:00
expectedOutput := fmt . Sprintf ( expectedOutputWithoutKey , userSecret )
if diff := cmp . Diff ( expectedOutput , out ) ; diff != "" {
2022-04-16 07:54:38 +02:00
t . Fatalf ( "hishtory export mismatch (-expected +got):\n%s\nout=%#v" , diff , out )
2022-04-07 08:05:30 +02:00
}
2022-04-06 08:31:24 +02:00
}
2022-04-18 04:54:17 +02:00
func installHishtory ( t * testing . T , tester shellTester , userSecret string ) string {
out := tester . RunInteractiveShell ( t , ` /tmp/client install ` + userSecret )
2022-04-06 08:31:24 +02:00
r := regexp . MustCompile ( ` Setting secret hishtory key to (.*) ` )
matches := r . FindStringSubmatch ( out )
if len ( matches ) != 2 {
2022-09-21 08:30:57 +02:00
t . Fatalf ( "Failed to extract userSecret from output=%#v: matches=%#v" , out , matches )
2022-04-06 08:31:24 +02:00
}
2022-04-08 07:53:39 +02:00
return matches [ 1 ]
}
2022-04-18 04:54:17 +02:00
func testBasicUserFlow ( t * testing . T , tester shellTester ) string {
2022-04-08 07:53:39 +02:00
// Test install
2022-04-18 04:54:17 +02:00
userSecret := installHishtory ( t , tester , "" )
2022-04-06 08:31:24 +02:00
2022-04-07 07:43:07 +02:00
// Test the status subcommand
2022-04-18 04:54:17 +02:00
out := tester . RunInteractiveShell ( t , ` hishtory status ` )
2022-09-27 07:55:59 +02:00
if out != fmt . Sprintf ( "hiSHtory: v0.Unknown\nEnabled: true\nSecret Key: %s\nCommit Hash: Unknown\n" , userSecret ) {
2022-04-07 02:47:21 +02:00
t . Fatalf ( "status command has unexpected output: %#v" , out )
}
2022-04-16 09:56:08 +02:00
// Assert that hishtory is correctly using the dev config.sh
homedir , err := os . UserHomeDir ( )
if err != nil {
t . Fatalf ( "failed to get homedir: %v" , err )
}
dat , err := os . ReadFile ( path . Join ( homedir , shared . HISHTORY_PATH , "config.sh" ) )
if err != nil {
t . Fatalf ( "failed to read config.sh: %v" , err )
}
if ! strings . Contains ( string ( dat ) , "except it doesn't run the save process in the background" ) {
t . Fatalf ( "config.sh is the prod version when it shouldn't be, config.sh=%#v" , dat )
}
2022-04-07 07:44:10 +02:00
// Test the banner
2022-04-07 07:43:07 +02:00
os . Setenv ( "FORCED_BANNER" , "HELLO_FROM_SERVER" )
2022-04-18 04:54:17 +02:00
out = hishtoryQuery ( t , tester , "" )
2022-04-16 09:44:47 +02:00
if ! strings . Contains ( out , "HELLO_FROM_SERVER\nHostname" ) {
2022-04-07 07:43:07 +02:00
t . Fatalf ( "hishtory query didn't show the banner message! out=%#v" , out )
}
os . Setenv ( "FORCED_BANNER" , "" )
2022-01-09 23:34:59 +01:00
// Test recording commands
2022-04-20 06:05:54 +02:00
out , err = tester . RunInteractiveShellRelaxed ( t , ` ls / a
2022-04-14 06:48:52 +02:00
ls / bar
ls / foo
echo foo
echo bar
hishtory disable
echo thisisnotrecorded
2022-04-15 05:18:49 +02:00
sleep 0.5
2022-04-14 06:48:52 +02:00
hishtory enable
echo thisisrecorded ` )
2022-04-08 08:25:13 +02:00
if err != nil {
t . Fatal ( err )
}
2022-01-09 23:34:59 +01:00
if out != "foo\nbar\nthisisnotrecorded\nthisisrecorded\n" {
t . Fatalf ( "unexpected output from running commands: %#v" , out )
}
// Test querying for all commands
2022-04-18 04:54:17 +02:00
out = hishtoryQuery ( t , tester , "" )
2022-01-10 00:48:20 +01:00
expected := [ ] string { "echo thisisrecorded" , "hishtory enable" , "echo bar" , "echo foo" , "ls /foo" , "ls /bar" , "ls /a" }
for _ , item := range expected {
if ! strings . Contains ( out , item ) {
t . Fatalf ( "output is missing expected item %#v: %#v" , item , out )
}
}
2022-09-17 21:19:29 +02:00
// Test the actual table output
hostnameMatcher := ` \S+ `
tableDividerMatcher := ` \s+ `
2022-09-18 06:56:39 +02:00
pathMatcher := ` ~?/[a-zA-Z_0-9/-]+ `
2022-10-01 08:56:04 +02:00
datetimeMatcher := ` [a-zA-Z] { 3}\s\d { 1,2}\s\d { 4}\s[0-9:]+\s([A-Z] { 3}|[+-]\d { 4}) `
2022-09-17 21:37:02 +02:00
runtimeMatcher := ` [0-9.ms]+ `
2022-09-17 21:19:29 +02:00
exitCodeMatcher := ` 0 `
2022-09-17 21:49:27 +02:00
pipefailMatcher := ` set -em?o pipefail `
2022-09-21 08:46:17 +02:00
line1Matcher := ` Hostname ` + tableDividerMatcher + ` CWD ` + tableDividerMatcher + ` Timestamp ` + tableDividerMatcher + ` Runtime ` + tableDividerMatcher + ` Exit Code ` + tableDividerMatcher + ` Command\s*\n `
line2Matcher := hostnameMatcher + tableDividerMatcher + pathMatcher + tableDividerMatcher + datetimeMatcher + tableDividerMatcher + runtimeMatcher + tableDividerMatcher + exitCodeMatcher + tableDividerMatcher + pipefailMatcher + tableDividerMatcher + ` \n `
line3Matcher := hostnameMatcher + tableDividerMatcher + pathMatcher + tableDividerMatcher + datetimeMatcher + tableDividerMatcher + runtimeMatcher + tableDividerMatcher + exitCodeMatcher + tableDividerMatcher + ` echo thisisrecorded ` + tableDividerMatcher + ` \n `
2022-09-17 21:49:27 +02:00
match , err := regexp . MatchString ( line3Matcher , out )
2022-09-17 21:19:29 +02:00
shared . Check ( t , err )
if ! match {
t . Fatalf ( "output is missing the row for `echo thisisrecorded`: %v" , out )
}
2022-09-21 08:46:17 +02:00
match , err = regexp . MatchString ( line1Matcher , out )
shared . Check ( t , err )
if ! match {
t . Fatalf ( "output is missing the headings: %v" , out )
}
match , err = regexp . MatchString ( line2Matcher , out )
shared . Check ( t , err )
if ! match {
t . Fatalf ( "output is missing the pipefail: %v" , out )
}
2022-09-17 21:49:27 +02:00
match , err = regexp . MatchString ( line1Matcher + line2Matcher + line3Matcher , out )
shared . Check ( t , err )
if ! match {
t . Fatalf ( "output doesn't match the expected table: %v" , out )
}
2022-01-10 00:48:20 +01:00
// Test querying for a specific command
2022-04-18 04:54:17 +02:00
out = hishtoryQuery ( t , tester , "foo" )
2022-01-10 00:48:20 +01:00
expected = [ ] string { "echo foo" , "ls /foo" }
unexpected := [ ] string { "echo thisisrecorded" , "hishtory enable" , "echo bar" , "ls /bar" , "ls /a" }
2022-01-09 23:34:59 +01:00
for _ , item := range expected {
if ! strings . Contains ( out , item ) {
t . Fatalf ( "output is missing expected item %#v: %#v" , item , out )
}
2022-04-06 08:31:24 +02:00
if strings . Count ( out , item ) != 1 {
t . Fatalf ( "output has %#v in it multiple times! out=%#v" , item , out )
}
2022-01-09 20:00:53 +01:00
}
2022-01-10 00:48:20 +01:00
for _ , item := range unexpected {
if strings . Contains ( out , item ) {
t . Fatalf ( "output is containing unexpected item %#v: %#v" , item , out )
}
}
2022-04-06 08:31:24 +02:00
2022-04-16 03:24:58 +02:00
// Add a complex command
2022-04-16 07:54:38 +02:00
complexCommand := "echo hello | grep complex | sed s/h/i/g; echo baz && echo \"fo 'o\""
2022-04-18 04:54:17 +02:00
_ , _ = tester . RunInteractiveShellRelaxed ( t , complexCommand )
2022-04-16 03:24:58 +02:00
// Query for it
2022-04-18 04:54:17 +02:00
out = hishtoryQuery ( t , tester , "complex" )
2022-04-16 03:24:58 +02:00
if strings . Count ( out , "\n" ) != 2 {
t . Fatalf ( "hishtory query has the wrong number of lines=%d, out=%#v" , strings . Count ( out , "\n" ) , out )
}
if ! strings . Contains ( out , complexCommand ) {
t . Fatalf ( "hishtory query doesn't contain the expected complex command, out=%#v" , out )
}
2022-04-06 08:31:24 +02:00
return userSecret
2022-01-09 20:00:53 +01:00
}
2022-04-08 07:53:39 +02:00
2022-04-18 04:54:17 +02:00
func testAdvancedQuery ( t * testing . T , tester shellTester ) {
2022-04-08 07:53:39 +02:00
// Set up
defer shared . BackupAndRestore ( t ) ( )
// Install hishtory
2022-04-18 04:54:17 +02:00
userSecret := installHishtory ( t , tester , "" )
2022-04-08 07:53:39 +02:00
// Run some commands we can query for
2022-04-18 08:31:08 +02:00
_ , err := tester . RunInteractiveShellRelaxed ( t , ` echo nevershouldappear
2022-04-15 05:18:49 +02:00
notacommand
cd / tmp /
echo querybydir
hishtory disable ` )
2022-04-12 08:48:51 +02:00
if err != nil {
t . Fatal ( err )
}
2022-04-08 07:53:39 +02:00
2022-04-13 06:24:25 +02:00
// A super basic query just to ensure the basics are working
2022-04-18 04:54:17 +02:00
out := hishtoryQuery ( t , tester , ` echo ` )
2022-04-13 06:24:25 +02:00
if ! strings . Contains ( out , "echo querybydir" ) {
2022-04-15 05:18:49 +02:00
t . Fatalf ( "hishtory query doesn't contain result matching echo querybydir, out=%#v" , out )
2022-04-13 06:24:25 +02:00
}
if strings . Count ( out , "\n" ) != 3 {
t . Fatalf ( "hishtory query has the wrong number of lines=%d, out=%#v" , strings . Count ( out , "\n" ) , out )
}
2022-04-08 07:53:39 +02:00
// Query based on cwd
2022-04-18 04:54:17 +02:00
out = hishtoryQuery ( t , tester , ` cwd:/tmp ` )
2022-04-08 07:53:39 +02:00
if ! strings . Contains ( out , "echo querybydir" ) {
t . Fatalf ( "hishtory query doesn't contain result matching cwd:/tmp, out=%#v" , out )
}
if strings . Contains ( out , "nevershouldappear" ) {
t . Fatalf ( "hishtory query contains unexpected entry, out=%#v" , out )
}
if strings . Count ( out , "\n" ) != 3 {
t . Fatalf ( "hishtory query has the wrong number of lines=%d, out=%#v" , strings . Count ( out , "\n" ) , out )
}
2022-06-06 03:05:06 +02:00
// And again, but with a strailing slash
out = hishtoryQuery ( t , tester , ` cwd:/tmp/ ` )
if ! strings . Contains ( out , "echo querybydir" ) {
t . Fatalf ( "hishtory query doesn't contain result matching cwd:/tmp, out=%#v" , out )
}
if strings . Contains ( out , "nevershouldappear" ) {
t . Fatalf ( "hishtory query contains unexpected entry, out=%#v" , out )
}
if strings . Count ( out , "\n" ) != 3 {
t . Fatalf ( "hishtory query has the wrong number of lines=%d, out=%#v" , strings . Count ( out , "\n" ) , out )
}
2022-04-08 07:53:39 +02:00
2022-04-09 03:23:17 +02:00
// Query based on cwd without the slash
2022-04-18 04:54:17 +02:00
out = hishtoryQuery ( t , tester , ` cwd:tmp ` )
2022-04-09 03:23:17 +02:00
if ! strings . Contains ( out , "echo querybydir" ) {
t . Fatalf ( "hishtory query doesn't contain result matching cwd:tmp, out=%#v" , out )
}
if strings . Count ( out , "\n" ) != 3 {
t . Fatalf ( "hishtory query has the wrong number of lines=%d, out=%#v" , strings . Count ( out , "\n" ) , out )
}
2022-04-08 07:53:39 +02:00
// Query based on cwd and another term
2022-04-18 04:54:17 +02:00
out = hishtoryQuery ( t , tester , ` cwd:/tmp querybydir ` )
2022-04-08 07:53:39 +02:00
if ! strings . Contains ( out , "echo querybydir" ) {
t . Fatalf ( "hishtory query doesn't contain result matching cwd:/tmp, out=%#v" , out )
}
if strings . Contains ( out , "nevershouldappear" ) {
t . Fatalf ( "hishtory query contains unexpected entry, out=%#v" , out )
}
if strings . Count ( out , "\n" ) != 2 {
t . Fatalf ( "hishtory query has the wrong number of lines=%d, out=%#v" , strings . Count ( out , "\n" ) , out )
}
2022-04-08 08:25:13 +02:00
// Query based on exit_code
2022-04-18 04:54:17 +02:00
out = hishtoryQuery ( t , tester , ` exit_code:127 ` )
2022-04-08 08:25:13 +02:00
if ! strings . Contains ( out , "notacommand" ) {
t . Fatalf ( "hishtory query doesn't contain expected result, out=%#v" , out )
}
if strings . Count ( out , "\n" ) != 2 {
t . Fatalf ( "hishtory query has the wrong number of lines=%d, out=%#v" , strings . Count ( out , "\n" ) , out )
}
2022-04-08 08:30:31 +02:00
// Query based on exit_code and something else that matches nothing
2022-04-18 04:54:17 +02:00
out = hishtoryQuery ( t , tester , ` exit_code:127 foo ` )
2022-04-08 08:30:31 +02:00
if strings . Count ( out , "\n" ) != 1 {
t . Fatalf ( "hishtory query has the wrong number of lines=%d, out=%#v" , strings . Count ( out , "\n" ) , out )
}
2022-04-09 03:23:17 +02:00
// Query based on before: and cwd:
2022-04-18 04:54:17 +02:00
out = hishtoryQuery ( t , tester , ` before:2125-07-02 cwd:/tmp ` )
2022-04-09 03:23:17 +02:00
if strings . Count ( out , "\n" ) != 3 {
t . Fatalf ( "hishtory query has the wrong number of lines=%d, out=%#v" , strings . Count ( out , "\n" ) , out )
}
2022-04-18 04:54:17 +02:00
out = hishtoryQuery ( t , tester , ` before:2125-07-02 cwd:tmp ` )
2022-04-09 03:23:17 +02:00
if strings . Count ( out , "\n" ) != 3 {
t . Fatalf ( "hishtory query has the wrong number of lines=%d, out=%#v" , strings . Count ( out , "\n" ) , out )
}
2022-04-18 04:54:17 +02:00
out = hishtoryQuery ( t , tester , ` before:2125-07-02 cwd:mp ` )
2022-04-09 03:23:17 +02:00
if strings . Count ( out , "\n" ) != 3 {
t . Fatalf ( "hishtory query has the wrong number of lines=%d, out=%#v" , strings . Count ( out , "\n" ) , out )
}
// Query based on after: and cwd:
2022-04-19 08:07:39 +02:00
out = hishtoryQuery ( t , tester , ` after:1980-07-02 cwd:/tmp ` )
if strings . Count ( out , "\n" ) != 3 {
t . Fatalf ( "hishtory query has the wrong number of lines=%d, out=%#v" , strings . Count ( out , "\n" ) , out )
2022-04-09 03:23:17 +02:00
}
// Query based on after: that returns no results
2022-04-18 04:54:17 +02:00
out = hishtoryQuery ( t , tester , ` after:2120-07-02 cwd:/tmp ` )
2022-04-09 03:23:17 +02:00
if strings . Count ( out , "\n" ) != 1 {
t . Fatalf ( "hishtory query has the wrong number of lines=%d, out=%#v" , strings . Count ( out , "\n" ) , out )
}
2022-04-11 02:38:20 +02:00
// Manually submit an entry with a different hostname and username so we can test those atoms
entry := data . MakeFakeHistoryEntry ( "cmd_with_diff_hostname_and_username" )
entry . LocalUsername = "otheruser"
entry . Hostname = "otherhostname"
manuallySubmitHistoryEntry ( t , userSecret , entry )
// Query based on the username that exists
2022-04-18 04:54:17 +02:00
out = hishtoryQuery ( t , tester , ` user:otheruser ` )
2022-04-11 02:38:20 +02:00
if ! strings . Contains ( out , "cmd_with_diff_hostname_and_username" ) {
t . Fatalf ( "hishtory query doesn't contain expected result, out=%#v" , out )
}
if strings . Count ( out , "\n" ) != 2 {
t . Fatalf ( "hishtory query has the wrong number of lines=%d, out=%#v" , strings . Count ( out , "\n" ) , out )
}
// Query based on the username that doesn't exist
2022-04-18 04:54:17 +02:00
out = hishtoryQuery ( t , tester , ` user:noexist ` )
2022-04-11 02:38:20 +02:00
if strings . Count ( out , "\n" ) != 1 {
t . Fatalf ( "hishtory query has the wrong number of lines=%d, out=%#v" , strings . Count ( out , "\n" ) , out )
}
// Query based on the hostname
2022-04-18 04:54:17 +02:00
out = hishtoryQuery ( t , tester , ` hostname:otherhostname ` )
2022-04-11 02:38:20 +02:00
if ! strings . Contains ( out , "cmd_with_diff_hostname_and_username" ) {
t . Fatalf ( "hishtory query doesn't contain expected result, out=%#v" , out )
}
if strings . Count ( out , "\n" ) != 2 {
t . Fatalf ( "hishtory query has the wrong number of lines=%d, out=%#v" , strings . Count ( out , "\n" ) , out )
}
2022-04-12 07:36:52 +02:00
// Test filtering out a search item
2022-04-18 04:54:17 +02:00
out = hishtoryQuery ( t , tester , "" )
2022-04-12 07:36:52 +02:00
if ! strings . Contains ( out , "cmd_with_diff_hostname_and_username" ) {
t . Fatalf ( "hishtory query doesn't contain expected result, out=%#v" , out )
}
2022-04-18 04:54:17 +02:00
out = hishtoryQuery ( t , tester , ` -cmd_with_diff_hostname_and_username ` )
2022-04-12 07:36:52 +02:00
if strings . Contains ( out , "cmd_with_diff_hostname_and_username" ) {
t . Fatalf ( "hishtory query contains unexpected result, out=%#v" , out )
}
2022-04-18 04:54:17 +02:00
out = hishtoryQuery ( t , tester , ` -echo ` )
2022-04-12 07:36:52 +02:00
if strings . Contains ( out , "echo" ) {
t . Fatalf ( "hishtory query contains unexpected result, out=%#v" , out )
}
2022-04-18 08:31:08 +02:00
if strings . Count ( out , "\n" ) != 4 {
t . Fatalf ( "hishtory query has the wrong number of lines=%d, out=%#v" , strings . Count ( out , "\n" ) , out )
2022-04-12 07:36:52 +02:00
}
// Test filtering out with an atom
2022-04-18 04:54:17 +02:00
out = hishtoryQuery ( t , tester , ` -hostname:otherhostname ` )
2022-04-12 07:36:52 +02:00
if strings . Contains ( out , "cmd_with_diff_hostname_and_username" ) {
t . Fatalf ( "hishtory query contains unexpected result, out=%#v" , out )
}
2022-04-18 04:54:17 +02:00
out = hishtoryQuery ( t , tester , ` -user:otheruser ` )
2022-04-12 07:36:52 +02:00
if strings . Contains ( out , "cmd_with_diff_hostname_and_username" ) {
t . Fatalf ( "hishtory query contains unexpected result, out=%#v" , out )
}
2022-04-18 04:54:17 +02:00
out = hishtoryQuery ( t , tester , ` -exit_code:0 ` )
2022-04-12 07:36:52 +02:00
if strings . Count ( out , "\n" ) != 3 {
t . Fatalf ( "hishtory query has the wrong number of lines=%d, out=%#v" , strings . Count ( out , "\n" ) , out )
}
// Test filtering out a search item that also looks like it could be a search for a flag
entry = data . MakeFakeHistoryEntry ( "foo -echo" )
manuallySubmitHistoryEntry ( t , userSecret , entry )
2022-04-18 04:54:17 +02:00
out = hishtoryQuery ( t , tester , ` -echo -install ` )
2022-04-12 07:36:52 +02:00
if strings . Contains ( out , "echo" ) {
t . Fatalf ( "hishtory query contains unexpected result, out=%#v" , out )
}
2022-04-18 08:31:08 +02:00
if strings . Count ( out , "\n" ) != 4 {
2022-04-12 07:36:52 +02:00
t . Fatalf ( "hishtory query has the wrong number of lines=%d, out=%#v" , strings . Count ( out , "\n" ) , out )
}
2022-09-08 08:20:31 +02:00
// Search for a cwd based on the home directory
entry = data . MakeFakeHistoryEntry ( "foobar" )
entry . HomeDirectory = "/home/david/"
entry . CurrentWorkingDirectory = "~/dir/"
manuallySubmitHistoryEntry ( t , userSecret , entry )
out = tester . RunInteractiveShell ( t , ` hishtory export cwd:~/dir ` )
expectedOutput := "foobar\n"
if diff := cmp . Diff ( expectedOutput , out ) ; diff != "" {
t . Fatalf ( "hishtory export mismatch (-expected +got):\n%s\nout=%#v" , diff , out )
}
// And search with the fully expanded path
out = tester . RunInteractiveShell ( t , ` hishtory export cwd:/home/david/dir ` )
expectedOutput = "foobar\n"
if diff := cmp . Diff ( expectedOutput , out ) ; diff != "" {
t . Fatalf ( "hishtory export mismatch (-expected +got):\n%s\nout=%#v" , diff , out )
}
2022-04-08 07:53:39 +02:00
}
2022-04-09 08:47:13 +02:00
2022-04-18 04:54:17 +02:00
func testUpdate ( t * testing . T , tester shellTester ) {
2022-04-28 20:26:55 +02:00
if ! shared . IsOnline ( ) {
t . Skip ( "skipping because we're currently offline" )
}
2022-04-21 05:56:01 +02:00
if runtime . GOOS == "linux" && runtime . GOARCH == "arm64" {
t . Skip ( "skipping on linux/arm64 which is unsupported" )
}
2022-09-28 07:03:37 +02:00
if skipSlowTests ( ) {
t . Skip ( "skipping slow tests" )
}
2022-04-09 21:50:01 +02:00
// Set up
defer shared . BackupAndRestore ( t ) ( )
2022-04-18 04:54:17 +02:00
userSecret := installHishtory ( t , tester , "" )
2022-04-09 21:50:01 +02:00
2022-04-17 08:00:04 +02:00
// Record a command before the update
2022-04-18 04:54:17 +02:00
tester . RunInteractiveShell ( t , "echo hello" )
2022-04-17 08:00:04 +02:00
2022-04-09 21:50:01 +02:00
// Check the status command
2022-04-18 04:54:17 +02:00
out := tester . RunInteractiveShell ( t , ` hishtory status ` )
2022-09-27 07:55:59 +02:00
if out != fmt . Sprintf ( "hiSHtory: v0.Unknown\nEnabled: true\nSecret Key: %s\nCommit Hash: Unknown\n" , userSecret ) {
2022-04-09 21:50:01 +02:00
t . Fatalf ( "status command has unexpected output: %#v" , out )
}
// Update
2022-04-18 04:54:17 +02:00
out = tester . RunInteractiveShell ( t , ` hishtory update ` )
2022-06-05 06:42:40 +02:00
isExpected , err := regexp . MatchString ( ` Successfully updated hishtory from v0[.]Unknown to v0.\d+ ` , out )
2022-04-17 08:00:04 +02:00
if err != nil {
t . Fatalf ( "regex failure: %v" , err )
}
if ! isExpected {
t . Fatalf ( "hishtory update returned unexpected out=%#v" , out )
}
// Update again and assert that it skipped the update
2022-04-18 04:54:17 +02:00
out = tester . RunInteractiveShell ( t , ` hishtory update ` )
2022-04-17 08:00:04 +02:00
if strings . Count ( out , "\n" ) != 1 || ! strings . Contains ( out , "is already installed" ) {
t . Fatalf ( "repeated hishtory update didn't skip the update, out=%#v" , out )
}
2022-04-09 21:50:01 +02:00
// Then check the status command again to confirm the update worked
2022-04-18 04:54:17 +02:00
out = tester . RunInteractiveShell ( t , ` hishtory status ` )
2022-04-09 23:48:17 +02:00
if ! strings . Contains ( out , fmt . Sprintf ( "\nEnabled: true\nSecret Key: %s\nCommit Hash: " , userSecret ) ) {
2022-04-09 21:50:01 +02:00
t . Fatalf ( "status command has unexpected output: %#v" , out )
}
if strings . Contains ( out , "\nCommit Hash: Unknown\n" ) {
t . Fatalf ( "status command has unexpected output: %#v" , out )
}
2022-04-17 08:00:04 +02:00
// Check that the history was preserved after the update
2022-04-19 08:07:39 +02:00
out = tester . RunInteractiveShell ( t , "hishtory export | grep -v pipefail | grep -v '/tmp/client install'" )
expectedOutput := "echo hello\nhishtory status\nhishtory update\nhishtory update\nhishtory status\n"
if diff := cmp . Diff ( expectedOutput , out ) ; diff != "" {
t . Fatalf ( "hishtory export mismatch (-expected +got):\n%s\nout=%#v" , diff , out )
2022-04-17 08:00:04 +02:00
}
2022-04-09 21:50:01 +02:00
}
2022-04-18 04:54:17 +02:00
func testRepeatedCommandThenQuery ( t * testing . T , tester shellTester ) {
2022-04-15 05:18:49 +02:00
// Set up
defer shared . BackupAndRestore ( t ) ( )
2022-04-18 04:54:17 +02:00
userSecret := installHishtory ( t , tester , "" )
2022-04-15 05:18:49 +02:00
// Check the status command
2022-04-18 04:54:17 +02:00
out := tester . RunInteractiveShell ( t , ` hishtory status ` )
2022-09-27 07:55:59 +02:00
if out != fmt . Sprintf ( "hiSHtory: v0.Unknown\nEnabled: true\nSecret Key: %s\nCommit Hash: Unknown\n" , userSecret ) {
2022-04-15 05:18:49 +02:00
t . Fatalf ( "status command has unexpected output: %#v" , out )
}
// Run a command many times
for i := 0 ; i < 25 ; i ++ {
2022-04-18 04:54:17 +02:00
tester . RunInteractiveShell ( t , fmt . Sprintf ( "echo mycommand-%d" , i ) )
2022-04-15 05:18:49 +02:00
}
// Check that it shows up correctly
2022-04-18 04:54:17 +02:00
out = hishtoryQuery ( t , tester , ` mycommand ` )
2022-04-15 05:18:49 +02:00
if strings . Count ( out , "\n" ) != 26 {
t . Fatalf ( "hishtory query has the wrong number of lines=%d, out=%#v" , strings . Count ( out , "\n" ) , out )
}
if strings . Count ( out , "echo mycommand" ) != 25 {
t . Fatalf ( "hishtory query has the wrong number of commands=%d, out=%#v" , strings . Count ( out , "echo mycommand" ) , out )
}
2022-04-18 04:54:17 +02:00
// Run a few more commands
tester . RunInteractiveShell ( t , ` echo mycommand - 30
2022-04-15 05:18:49 +02:00
echo mycommand - 31
echo mycommand - 3 ` )
2022-04-18 04:54:17 +02:00
out = tester . RunInteractiveShell ( t , "hishtory export | grep -v pipefail | grep -v '/tmp/client install'" )
expectedOutput := "hishtory status\necho mycommand-0\necho mycommand-1\necho mycommand-2\necho mycommand-3\necho mycommand-4\necho mycommand-5\necho mycommand-6\necho mycommand-7\necho mycommand-8\necho mycommand-9\necho mycommand-10\necho mycommand-11\necho mycommand-12\necho mycommand-13\necho mycommand-14\necho mycommand-15\necho mycommand-16\necho mycommand-17\necho mycommand-18\necho mycommand-19\necho mycommand-20\necho mycommand-21\necho mycommand-22\necho mycommand-23\necho mycommand-24\nhishtory query mycommand\necho mycommand-30\necho mycommand-31\necho mycommand-3\n"
2022-04-15 05:18:49 +02:00
if diff := cmp . Diff ( expectedOutput , out ) ; diff != "" {
t . Fatalf ( "hishtory export mismatch (-expected +got):\n%s\nout=%#v" , diff , out )
}
}
2022-04-18 04:54:17 +02:00
func testRepeatedCommandAndQuery ( t * testing . T , tester shellTester ) {
2022-04-15 05:18:49 +02:00
// Set up
defer shared . BackupAndRestore ( t ) ( )
2022-04-18 04:54:17 +02:00
userSecret := installHishtory ( t , tester , "" )
2022-04-15 05:18:49 +02:00
// Check the status command
2022-04-18 04:54:17 +02:00
out := tester . RunInteractiveShell ( t , ` hishtory status ` )
2022-09-27 07:55:59 +02:00
if out != fmt . Sprintf ( "hiSHtory: v0.Unknown\nEnabled: true\nSecret Key: %s\nCommit Hash: Unknown\n" , userSecret ) {
2022-04-15 05:18:49 +02:00
t . Fatalf ( "status command has unexpected output: %#v" , out )
}
// Run a command many times
for i := 0 ; i < 25 ; i ++ {
2022-04-18 04:54:17 +02:00
tester . RunInteractiveShell ( t , fmt . Sprintf ( "echo mycommand-%d" , i ) )
out = hishtoryQuery ( t , tester , fmt . Sprintf ( "mycommand-%d" , i ) )
2022-04-15 05:18:49 +02:00
if strings . Count ( out , "\n" ) != 2 {
t . Fatalf ( "hishtory query #%d has the wrong number of lines=%d, out=%#v" , i , strings . Count ( out , "\n" ) , out )
}
if strings . Count ( out , "echo mycommand" ) != 1 {
t . Fatalf ( "hishtory query #%d has the wrong number of commands=%d, out=%#v" , i , strings . Count ( out , "echo mycommand" ) , out )
}
}
}
2022-04-18 04:54:17 +02:00
func testRepeatedEnableDisable ( t * testing . T , tester shellTester ) {
2022-04-15 05:18:49 +02:00
// Set up
defer shared . BackupAndRestore ( t ) ( )
2022-04-18 04:54:17 +02:00
installHishtory ( t , tester , "" )
2022-04-15 05:18:49 +02:00
// Run a command many times
for i := 0 ; i < 25 ; i ++ {
2022-04-18 04:54:17 +02:00
tester . RunInteractiveShell ( t , fmt . Sprintf ( ` echo mycommand - % d
2022-04-15 05:18:49 +02:00
hishtory disable
echo shouldnotshowup
sleep 0.5
hishtory enable ` , i ) )
2022-04-18 04:54:17 +02:00
out := hishtoryQuery ( t , tester , fmt . Sprintf ( "mycommand-%d" , i ) )
2022-04-15 05:18:49 +02:00
if strings . Count ( out , "\n" ) != 2 {
t . Fatalf ( "hishtory query #%d has the wrong number of lines=%d, out=%#v" , i , strings . Count ( out , "\n" ) , out )
}
if strings . Count ( out , "echo mycommand" ) != 1 {
t . Fatalf ( "hishtory query #%d has the wrong number of commands=%d, out=%#v" , i , strings . Count ( out , "echo mycommand" ) , out )
}
2022-04-18 04:54:17 +02:00
out = hishtoryQuery ( t , tester , "" )
2022-04-15 05:18:49 +02:00
if strings . Contains ( out , "shouldnotshowup" ) {
t . Fatalf ( "hishtory query contains a result that should not have been recorded, out=%#v" , out )
}
}
2022-04-18 04:54:17 +02:00
out := tester . RunInteractiveShell ( t , "hishtory export | grep -v pipefail | grep -v '/tmp/client install'" )
expectedOutput := "echo mycommand-0\nhishtory enable\nhishtory query mycommand-0\nhishtory query\necho mycommand-1\nhishtory enable\nhishtory query mycommand-1\nhishtory query\necho mycommand-2\nhishtory enable\nhishtory query mycommand-2\nhishtory query\necho mycommand-3\nhishtory enable\nhishtory query mycommand-3\nhishtory query\necho mycommand-4\nhishtory enable\nhishtory query mycommand-4\nhishtory query\necho mycommand-5\nhishtory enable\nhishtory query mycommand-5\nhishtory query\necho mycommand-6\nhishtory enable\nhishtory query mycommand-6\nhishtory query\necho mycommand-7\nhishtory enable\nhishtory query mycommand-7\nhishtory query\necho mycommand-8\nhishtory enable\nhishtory query mycommand-8\nhishtory query\necho mycommand-9\nhishtory enable\nhishtory query mycommand-9\nhishtory query\necho mycommand-10\nhishtory enable\nhishtory query mycommand-10\nhishtory query\necho mycommand-11\nhishtory enable\nhishtory query mycommand-11\nhishtory query\necho mycommand-12\nhishtory enable\nhishtory query mycommand-12\nhishtory query\necho mycommand-13\nhishtory enable\nhishtory query mycommand-13\nhishtory query\necho mycommand-14\nhishtory enable\nhishtory query mycommand-14\nhishtory query\necho mycommand-15\nhishtory enable\nhishtory query mycommand-15\nhishtory query\necho mycommand-16\nhishtory enable\nhishtory query mycommand-16\nhishtory query\necho mycommand-17\nhishtory enable\nhishtory query mycommand-17\nhishtory query\necho mycommand-18\nhishtory enable\nhishtory query mycommand-18\nhishtory query\necho mycommand-19\nhishtory enable\nhishtory query mycommand-19\nhishtory query\necho mycommand-20\nhishtory enable\nhishtory query mycommand-20\nhishtory query\necho mycommand-21\nhishtory enable\nhishtory query mycommand-21\nhishtory query\necho mycommand-22\nhishtory enable\nhishtory query mycommand-22\nhishtory query\necho mycommand-23\nhishtory enable\nhishtory query mycommand-23\nhishtory query\necho mycommand-24\nhishtory enable\nhishtory query mycommand-24\nhishtory query\n"
2022-04-16 09:44:47 +02:00
if diff := cmp . Diff ( expectedOutput , out ) ; diff != "" {
t . Fatalf ( "hishtory export mismatch (-expected +got):\n%s\nout=%#v" , diff , out )
2022-04-15 05:18:49 +02:00
}
}
2022-04-18 04:54:17 +02:00
func testExcludeHiddenCommand ( t * testing . T , tester shellTester ) {
2022-04-15 09:04:49 +02:00
// Set up
defer shared . BackupAndRestore ( t ) ( )
2022-04-18 04:54:17 +02:00
installHishtory ( t , tester , "" )
2022-04-15 09:04:49 +02:00
2022-04-18 04:54:17 +02:00
tester . RunInteractiveShell ( t , ` echo hello1
2022-04-15 09:04:49 +02:00
echo hidden
echo hello2
echo hidden ` )
2022-04-18 04:54:17 +02:00
tester . RunInteractiveShell ( t , " echo hidden" )
2022-04-18 06:04:44 +02:00
out := hishtoryQuery ( t , tester , "-pipefail" )
if strings . Count ( out , "\n" ) != 3 {
2022-04-19 06:28:41 +02:00
t . Fatalf ( "hishtory query has the wrong number of lines=%d, out=%#v, bash hishtory file=%#v" , strings . Count ( out , "\n" ) , out , tester . RunInteractiveShell ( t , "cat ~/.bash_history" ) )
2022-04-15 09:04:49 +02:00
}
if strings . Count ( out , "echo hello" ) != 2 {
t . Fatalf ( "hishtory query has the wrong number of commands=%d, out=%#v" , strings . Count ( out , "echo mycommand" ) , out )
}
if strings . Count ( out , "echo hello1" ) != 1 {
t . Fatalf ( "hishtory query has the wrong number of commands=%d, out=%#v" , strings . Count ( out , "echo mycommand" ) , out )
}
if strings . Count ( out , "echo hello2" ) != 1 {
t . Fatalf ( "hishtory query has the wrong number of commands=%d, out=%#v" , strings . Count ( out , "echo mycommand" ) , out )
}
if strings . Contains ( out , "hidden" ) {
t . Fatalf ( "hishtory query contains a result that should not have been recorded, out=%#v" , out )
}
2022-04-18 04:54:17 +02:00
out = tester . RunInteractiveShell ( t , "hishtory export | grep -v pipefail | grep -v '/tmp/client install'" )
2022-04-18 06:04:44 +02:00
expectedOutput := "echo hello1\necho hello2\n"
2022-04-15 09:04:49 +02:00
if out != expectedOutput {
t . Fatalf ( "hishtory export has unexpected output=%#v" , out )
}
}
2022-04-17 20:24:55 +02:00
func getPidofCommand ( ) string {
if runtime . GOOS == "darwin" {
// MacOS doesn't have pidof by default
return "pgrep"
}
return "pidof"
}
2022-04-15 05:18:49 +02:00
func waitForBackgroundSavesToComplete ( t * testing . T ) {
for i := 0 ; i < 20 ; i ++ {
2022-04-17 20:24:55 +02:00
cmd := exec . Command ( getPidofCommand ( ) , "hishtory" )
2022-04-15 05:18:49 +02:00
var stdout bytes . Buffer
var stderr bytes . Buffer
cmd . Stdout = & stdout
cmd . Stderr = & stderr
err := cmd . Run ( )
if err != nil && err . Error ( ) != "exit status 1" {
t . Fatalf ( "failed to check if hishtory was running: %v, stdout=%#v, stderr=%#v" , err , stdout . String ( ) , stderr . String ( ) )
}
if ! strings . Contains ( stdout . String ( ) , "\n" ) {
2022-04-21 05:56:01 +02:00
// pidof had no output, so hishtory isn't running and we're done waiting
time . Sleep ( 1000 * time . Millisecond )
2022-04-15 05:18:49 +02:00
return
}
time . Sleep ( 50 * time . Millisecond )
}
t . Fatalf ( "failed to wait until hishtory wasn't running" )
}
2022-04-18 04:54:17 +02:00
func hishtoryQuery ( t * testing . T , tester shellTester , query string ) string {
return tester . RunInteractiveShell ( t , "hishtory query " + query )
2022-04-15 05:18:49 +02:00
}
2022-04-11 02:38:20 +02:00
func manuallySubmitHistoryEntry ( t * testing . T , userSecret string , entry data . HistoryEntry ) {
encEntry , err := data . EncryptHistoryEntry ( userSecret , entry )
2022-04-09 08:47:13 +02:00
shared . Check ( t , err )
2022-09-20 07:49:48 +02:00
if encEntry . Date != entry . EndTime {
t . Fatalf ( "encEntry.Date does not match the entry" )
}
2022-04-11 02:38:20 +02:00
jsonValue , err := json . Marshal ( [ ] shared . EncHistoryEntry { encEntry } )
2022-04-09 08:47:13 +02:00
shared . Check ( t , err )
2022-04-28 20:26:55 +02:00
resp , err := http . Post ( "http://localhost:8080/api/v1/submit" , "application/json" , bytes . NewBuffer ( jsonValue ) )
2022-04-09 08:47:13 +02:00
shared . Check ( t , err )
2022-04-11 02:38:20 +02:00
if resp . StatusCode != 200 {
t . Fatalf ( "failed to submit result to backend, status_code=%d" , resp . StatusCode )
2022-04-09 08:47:13 +02:00
}
}
2022-04-15 05:18:49 +02:00
2022-04-19 07:07:10 +02:00
func testTimestampsAreReasonablyCorrect ( t * testing . T , tester shellTester ) {
// Setup
defer shared . BackupAndRestore ( t ) ( )
installHishtory ( t , tester , "" )
// Record a command
out := tester . RunInteractiveShell ( t , "echo hello" )
if out != "hello\n" {
t . Fatalf ( "running echo hello had unexpected out=%#v" , out )
}
// Query for it and check that the timestamp that gets recorded looks reasonable
out = hishtoryQuery ( t , tester , "echo hello" )
if strings . Count ( out , "\n" ) != 2 {
t . Fatalf ( "hishtory query has unexpected number of lines: out=%#v" , out )
}
expectedDate := time . Now ( ) . Format ( "Jan 2 2006" )
if ! strings . Contains ( out , expectedDate ) {
t . Fatalf ( "hishtory query has an incorrect date: out=%#v" , out )
}
}
2022-04-19 07:45:07 +02:00
func testTableDisplayCwd ( t * testing . T , tester shellTester ) {
// Setup
defer shared . BackupAndRestore ( t ) ( )
installHishtory ( t , tester , "" )
// Record a command
out := tester . RunInteractiveShell ( t , ` cd ~ / . hishtory /
echo hello
cd / tmp /
echo other ` )
if out != "hello\nother\n" {
t . Fatalf ( "running echo hello had unexpected out=%#v" , out )
}
// Query for it and check that the directory gets recorded correctly
out = hishtoryQuery ( t , tester , "echo hello" )
if strings . Count ( out , "\n" ) != 2 {
t . Fatalf ( "hishtory query has unexpected number of lines: out=%#v" , out )
}
2022-04-20 04:21:39 +02:00
if ! strings . Contains ( out , "~/.hishtory" ) {
2022-04-19 07:45:07 +02:00
t . Fatalf ( "hishtory query has an incorrect CWD: out=%#v" , out )
}
out = hishtoryQuery ( t , tester , "echo other" )
if strings . Count ( out , "\n" ) != 2 {
t . Fatalf ( "hishtory query has unexpected number of lines: out=%#v" , out )
}
2022-04-20 04:21:39 +02:00
if ! strings . Contains ( out , "/tmp" ) {
2022-04-19 07:45:07 +02:00
t . Fatalf ( "hishtory query has an incorrect CWD: out=%#v" , out )
}
}
2022-04-18 04:54:17 +02:00
func testHishtoryBackgroundSaving ( t * testing . T , tester shellTester ) {
2022-09-23 03:09:51 +02:00
if runtime . GOOS == "darwin" {
t . Skip ( "skip testing background saving since it is flakey on MacOs" )
2022-04-28 20:26:55 +02:00
}
2022-04-15 05:18:49 +02:00
// Setup
defer shared . BackupAndRestore ( t ) ( )
2022-09-23 03:09:51 +02:00
// Check that we can find the go binary
_ , err := exec . LookPath ( "go" )
2022-09-22 06:49:08 +02:00
shared . Check ( t , err )
2022-04-15 05:18:49 +02:00
// Test install with an unset HISHTORY_TEST var so that we save in the background (this is likely to be flakey!)
2022-04-18 04:54:17 +02:00
out := tester . RunInteractiveShell ( t , ` unset HISHTORY_TEST
2022-09-22 05:30:50 +02:00
CGO_ENABLED = 0 go build - o / tmp / client
2022-04-15 05:18:49 +02:00
/ tmp / client install ` )
r := regexp . MustCompile ( ` Setting secret hishtory key to (.*) ` )
matches := r . FindStringSubmatch ( out )
if len ( matches ) != 2 {
2022-09-21 08:30:57 +02:00
t . Fatalf ( "Failed to extract userSecret from output=%#v: matches=%#v" , out , matches )
2022-04-15 05:18:49 +02:00
}
userSecret := matches [ 1 ]
// Assert that config.sh isn't the dev version
2022-04-16 09:56:08 +02:00
homedir , err := os . UserHomeDir ( )
if err != nil {
t . Fatalf ( "failed to get homedir: %v" , err )
}
dat , err := os . ReadFile ( path . Join ( homedir , shared . HISHTORY_PATH , "config.sh" ) )
if err != nil {
t . Fatalf ( "failed to read config.sh: %v" , err )
}
if strings . Contains ( string ( dat ) , "except it doesn't run the save process in the background" ) {
t . Fatalf ( "config.sh is the testing version when it shouldn't be, config.sh=%#v" , dat )
}
2022-04-15 05:18:49 +02:00
// Test the status subcommand
2022-04-18 04:54:17 +02:00
out = tester . RunInteractiveShell ( t , ` hishtory status ` )
2022-09-27 07:55:59 +02:00
if out != fmt . Sprintf ( "hiSHtory: v0.Unknown\nEnabled: true\nSecret Key: %s\nCommit Hash: Unknown\n" , userSecret ) {
2022-04-15 05:18:49 +02:00
t . Fatalf ( "status command has unexpected output: %#v" , out )
}
// Test recording commands
2022-04-20 06:05:54 +02:00
out , err = tester . RunInteractiveShellRelaxed ( t , ` ls / a
2022-04-15 05:18:49 +02:00
echo foo ` )
if err != nil {
t . Fatal ( err )
}
if out != "foo\n" {
t . Fatalf ( "unexpected output from running commands: %#v" , out )
}
// Test querying for all commands
2022-04-15 20:20:23 +02:00
waitForBackgroundSavesToComplete ( t )
2022-04-22 07:25:24 +02:00
time . Sleep ( time . Second )
2022-04-18 04:54:17 +02:00
out = hishtoryQuery ( t , tester , "" )
2022-04-15 05:18:49 +02:00
expected := [ ] string { "echo foo" , "ls /a" }
for _ , item := range expected {
if ! strings . Contains ( out , item ) {
t . Fatalf ( "output is missing expected item %#v: %#v" , item , out )
}
}
// Test querying for a specific command
2022-04-15 20:20:23 +02:00
waitForBackgroundSavesToComplete ( t )
2022-04-18 04:54:17 +02:00
out = hishtoryQuery ( t , tester , "foo" )
2022-04-15 05:18:49 +02:00
if ! strings . Contains ( out , "echo foo" ) {
t . Fatalf ( "output doesn't contain the expected item, out=%#v" , out )
}
if strings . Contains ( out , "ls /a" ) {
t . Fatalf ( "output contains unexpected item, out=%#v" , out )
}
}
2022-04-16 10:09:25 +02:00
2022-04-18 04:54:17 +02:00
func testDisplayTable ( t * testing . T , tester shellTester ) {
2022-04-16 10:09:25 +02:00
// Setup
defer shared . BackupAndRestore ( t ) ( )
2022-04-18 04:54:17 +02:00
userSecret := installHishtory ( t , tester , "" )
2022-04-16 10:09:25 +02:00
// Submit two fake entries
2022-04-16 19:46:57 +02:00
tmz , err := time . LoadLocation ( "America/Los_Angeles" )
if err != nil {
t . Fatalf ( "failed to load timezone: %v" , err )
}
2022-04-16 10:09:25 +02:00
entry1 := data . MakeFakeHistoryEntry ( "table_cmd1" )
2022-04-16 19:46:57 +02:00
entry1 . StartTime = time . Unix ( 1650096186 , 0 ) . In ( tmz )
entry1 . EndTime = time . Unix ( 1650096190 , 0 ) . In ( tmz )
2022-04-16 10:09:25 +02:00
manuallySubmitHistoryEntry ( t , userSecret , entry1 )
entry2 := data . MakeFakeHistoryEntry ( "table_cmd2" )
2022-04-16 19:46:57 +02:00
entry2 . StartTime = time . Unix ( 1650096196 , 0 ) . In ( tmz )
entry2 . EndTime = time . Unix ( 1650096220 , 0 ) . In ( tmz )
2022-04-16 10:09:25 +02:00
entry2 . CurrentWorkingDirectory = "~/foo/"
entry2 . ExitCode = 3
manuallySubmitHistoryEntry ( t , userSecret , entry2 )
// Query and check the table
2022-04-18 04:54:17 +02:00
out := hishtoryQuery ( t , tester , "table" )
2022-04-21 07:13:10 +02:00
expectedOutput1 := "Hostname CWD Timestamp Runtime Exit Code Command \nlocalhost ~/foo/ Apr 16 2022 01:03:16 -0700 24s 3 table_cmd2 \nlocalhost /tmp/ Apr 16 2022 01:03:06 -0700 4s 2 table_cmd1 \n"
expectedOutput2 := "Hostname CWD Timestamp Runtime Exit Code Command \nlocalhost ~/foo/ Apr 16 2022 01:03:16 PDT 24s 3 table_cmd2 \nlocalhost /tmp/ Apr 16 2022 01:03:06 PDT 4s 2 table_cmd1 \n"
if out != expectedOutput1 && out != expectedOutput2 {
t . Fatalf ( "hishtory query table test mismatch out=%#v" , out )
2022-04-16 10:09:25 +02:00
}
}
2022-05-02 04:37:26 +02:00
func testRequestAndReceiveDbDump ( t * testing . T , tester shellTester ) {
// Set up
defer shared . BackupAndRestore ( t ) ( )
secretKey := installHishtory ( t , tester , "" )
2022-05-23 04:45:46 +02:00
// Confirm there are no pending dump requests
2022-09-21 07:28:40 +02:00
config := hctx . GetConf ( hctx . MakeContext ( ) )
2022-06-05 08:03:05 +02:00
deviceId1 := config . DeviceId
resp , err := lib . ApiGet ( "/api/v1/get-dump-requests?user_id=" + data . UserId ( secretKey ) + "&device_id=" + deviceId1 )
2022-05-23 04:45:46 +02:00
if err != nil {
t . Fatalf ( "failed to get pending dump requests: %v" , err )
}
if string ( resp ) != "[]" {
t . Fatalf ( "There are pending dump requests! user_id=%#v, resp=%#v" , data . UserId ( secretKey ) , string ( resp ) )
}
2022-05-02 04:37:26 +02:00
// Record two commands and then query for them
out := tester . RunInteractiveShell ( t , ` echo hello
2022-05-23 04:45:46 +02:00
echo other ` )
if out != "hello\nother\n" {
t . Fatalf ( "running echo had unexpected out=%#v" , out )
}
2022-05-02 04:37:26 +02:00
// Query for it and check that the directory gets recorded correctly
out = hishtoryQuery ( t , tester , "echo" )
if strings . Count ( out , "\n" ) != 3 {
t . Fatalf ( "hishtory query has unexpected number of lines: out=%#v" , out )
}
if ! strings . Contains ( out , "echo hello" ) {
t . Fatalf ( "hishtory query doesn't contain expected command, out=%#v" , out )
}
if ! strings . Contains ( out , "echo other" ) {
t . Fatalf ( "hishtory query doesn't contain expected command, out=%#v" , out )
}
// Back up this copy
restoreFirstInstallation := shared . BackupAndRestoreWithId ( t , "-install1" )
// Wipe the DB to simulate entries getting deleted because they've already been read and expired
2022-05-23 04:45:46 +02:00
_ , err = lib . ApiGet ( "/api/v1/wipe-db" )
2022-05-02 04:37:26 +02:00
if err != nil {
t . Fatalf ( "failed to wipe the DB: %v" , err )
}
// Install a new one (with the same secret key but a diff device id)
installHishtory ( t , tester , secretKey )
2022-06-05 08:03:05 +02:00
// Confirm there is now a pending dump requests that the first device should respond to
resp , err = lib . ApiGet ( "/api/v1/get-dump-requests?user_id=" + data . UserId ( secretKey ) + "&device_id=" + deviceId1 )
2022-05-23 04:45:46 +02:00
if err != nil {
t . Fatalf ( "failed to get pending dump requests: %v" , err )
}
if string ( resp ) == "[]" {
t . Fatalf ( "There are no pending dump requests! user_id=%#v, resp=%#v" , data . UserId ( secretKey ) , string ( resp ) )
}
2022-05-02 04:37:26 +02:00
// Check that the new one doesn't have the commands yet
out = hishtoryQuery ( t , tester , "echo" )
if strings . Count ( out , "\n" ) != 1 {
t . Fatalf ( "hishtory query has unexpected number of lines, should contain no entries: out=%#v" , out )
}
if strings . Contains ( out , "echo hello" ) || strings . Contains ( "echo other" , out ) {
t . Fatalf ( "hishtory query contains unexpected command, out=%#v" , out )
}
out = tester . RunInteractiveShell ( t , ` hishtory export | grep -v pipefail ` )
if out != "hishtory query echo\n" {
t . Fatalf ( "hishtory export has unexpected out=%#v" , out )
}
// Restore the first copy
restoreSecondInstallation := shared . BackupAndRestoreWithId ( t , "-install2" )
restoreFirstInstallation ( )
// Confirm it still has the correct entries via hishtory export (and this runs a command to trigger it to dump the DB)
out = tester . RunInteractiveShell ( t , ` hishtory export | grep -v pipefail ` )
2022-05-23 04:45:46 +02:00
expectedOutput := "echo hello\necho other\nhishtory query echo\nhishtory query echo\n"
if diff := cmp . Diff ( expectedOutput , out ) ; diff != "" {
t . Fatalf ( "hishtory export mismatch (-expected +got):\n%s\nout=%#v" , diff , out )
}
2022-06-05 08:03:05 +02:00
// Confirm there are no pending dump requests for the first device
resp , err = lib . ApiGet ( "/api/v1/get-dump-requests?user_id=" + data . UserId ( secretKey ) + "&device_id=" + deviceId1 )
2022-05-23 04:45:46 +02:00
if err != nil {
t . Fatalf ( "failed to get pending dump requests: %v" , err )
}
if string ( resp ) != "[]" {
t . Fatalf ( "There are pending dump requests! user_id=%#v, resp=%#v" , data . UserId ( secretKey ) , string ( resp ) )
2022-05-02 04:37:26 +02:00
}
// Restore the second copy and confirm it has the commands
restoreSecondInstallation ( )
out = hishtoryQuery ( t , tester , "ech" )
if strings . Count ( out , "\n" ) != 5 {
t . Fatalf ( "hishtory query has unexpected number of lines=%d: out=%#v" , strings . Count ( out , "\n" ) , out )
}
expected := [ ] string { "echo hello" , "echo other" }
for _ , item := range expected {
if ! strings . Contains ( out , item ) {
t . Fatalf ( "output is missing expected item %#v: %#v" , item , out )
}
if strings . Count ( out , item ) != 1 {
t . Fatalf ( "output has %#v in it multiple times! out=%#v" , item , out )
}
}
// And check hishtory export too for good measure
out = tester . RunInteractiveShell ( t , ` hishtory export | grep -v pipefail ` )
2022-05-23 04:45:46 +02:00
expectedOutput = "echo hello\necho other\nhishtory query echo\nhishtory query echo\nhishtory query ech\n"
if diff := cmp . Diff ( expectedOutput , out ) ; diff != "" {
t . Fatalf ( "hishtory export mismatch (-expected +got):\n%s\nout=%#v" , diff , out )
2022-05-02 04:37:26 +02:00
}
}
2022-06-05 07:27:04 +02:00
func testInstallViaPythonScript ( t * testing . T , tester shellTester ) {
// Set up
defer shared . BackupAndRestore ( t ) ( )
2022-10-16 18:56:14 +02:00
defer shared . BackupAndRestoreEnv ( "HISHTORY_TEST" ) ( )
2022-06-05 07:27:04 +02:00
// Install via the python script
out := tester . RunInteractiveShell ( t , ` curl https://hishtory.dev/install.py | python3 - ` )
if ! strings . Contains ( out , "Succesfully installed hishtory" ) {
t . Fatalf ( "unexpected output when installing hishtory, out=%#v" , out )
}
r := regexp . MustCompile ( ` Setting secret hishtory key to (.*) ` )
matches := r . FindStringSubmatch ( out )
if len ( matches ) != 2 {
2022-09-21 08:30:57 +02:00
t . Fatalf ( "Failed to extract userSecret from output=%#v: matches=%#v" , out , matches )
2022-06-05 07:27:04 +02:00
}
userSecret := matches [ 1 ]
// Test the status subcommand
downloadData , err := lib . GetDownloadData ( )
if err != nil {
t . Fatal ( err )
}
out = tester . RunInteractiveShell ( t , ` hishtory status ` )
2022-09-27 07:55:59 +02:00
expectedOut := fmt . Sprintf ( "hiSHtory: %s\nEnabled: true\nSecret Key: %s\nCommit Hash: " , downloadData . Version , userSecret )
2022-06-05 07:27:04 +02:00
if ! strings . Contains ( out , expectedOut ) {
t . Fatalf ( "status command has unexpected output: actual=%#v, expected=%#v" , out , expectedOut )
}
// And test that it recorded that command
2022-10-16 18:56:14 +02:00
time . Sleep ( time . Second )
2022-06-05 07:27:04 +02:00
out = tester . RunInteractiveShell ( t , ` hishtory export | grep -v pipefail ` )
if out != "hishtory status\n" {
t . Fatalf ( "unexpected output from hishtory export=%#v" , out )
}
}
2022-06-06 03:05:06 +02:00
func testExportWithQuery ( t * testing . T , tester shellTester ) {
// Setup
defer shared . BackupAndRestore ( t ) ( )
installHishtory ( t , tester , "" )
// Test recording commands
out , err := tester . RunInteractiveShellRelaxed ( t , ` ls / a
ls / bar
ls / foo
echo foo
echo bar
hishtory disable
echo thisisnotrecorded
sleep 0.5
cd / tmp /
hishtory enable
echo thisisrecorded ` )
if err != nil {
t . Fatal ( err )
}
if out != "foo\nbar\nthisisnotrecorded\nthisisrecorded\n" {
t . Fatalf ( "unexpected output from running commands: %#v" , out )
}
// Test querying for all commands
out = hishtoryQuery ( t , tester , "" )
expected := [ ] string { "echo thisisrecorded" , "hishtory enable" , "echo bar" , "echo foo" , "ls /foo" , "ls /bar" , "ls /a" }
for _ , item := range expected {
if ! strings . Contains ( out , item ) {
t . Fatalf ( "output is missing expected item %#v: %#v" , item , out )
}
}
// Test querying for a specific command
out = hishtoryQuery ( t , tester , "foo" )
expected = [ ] string { "echo foo" , "ls /foo" }
unexpected := [ ] string { "echo thisisrecorded" , "hishtory enable" , "echo bar" , "ls /bar" , "ls /a" }
for _ , item := range expected {
if ! strings . Contains ( out , item ) {
t . Fatalf ( "output is missing expected item %#v: %#v" , item , out )
}
if strings . Count ( out , item ) != 1 {
t . Fatalf ( "output has %#v in it multiple times! out=%#v" , item , out )
}
}
for _ , item := range unexpected {
if strings . Contains ( out , item ) {
t . Fatalf ( "output is containing unexpected item %#v: %#v" , item , out )
}
}
// Test using export with a query
out = tester . RunInteractiveShell ( t , ` hishtory export foo ` )
if out != "ls /foo\necho foo\nhishtory query foo\n" {
t . Fatalf ( "expected hishtory export to equal out=%#v" , out )
}
// Test a more complex query with export
out = tester . RunInteractiveShell ( t , ` hishtory export cwd:/tmp/ ` )
if out != "hishtory enable\necho thisisrecorded\n" {
t . Fatalf ( "expected hishtory export to equal out=%#v" , out )
}
}
2022-06-06 03:26:02 +02:00
func testHelpCommand ( t * testing . T , tester shellTester ) {
// Setup
defer shared . BackupAndRestore ( t ) ( )
installHishtory ( t , tester , "" )
// Test the help command
out := tester . RunInteractiveShell ( t , ` hishtory help ` )
2022-09-25 01:18:24 +02:00
if ! strings . HasPrefix ( out , "hiSHtory: Better shell history\n\nSupported commands:\n" ) {
2022-06-06 03:26:02 +02:00
t . Fatalf ( "expected hishtory help to contain intro, actual=%#v" , out )
}
out2 := tester . RunInteractiveShell ( t , ` hishtory -h ` )
if out != out2 {
t . Fatalf ( "expected hishtory -h to equal help" )
}
}
2022-06-13 06:28:19 +02:00
func testStripBashTimePrefix ( t * testing . T , tester shellTester ) {
if tester . ShellName ( ) != "bash" {
t . Skip ( )
}
// Setup
defer shared . BackupAndRestore ( t ) ( )
installHishtory ( t , tester , "" )
// Add a HISTTIMEFORMAT to the bashrc
homedir , err := os . UserHomeDir ( )
if err != nil {
t . Fatal ( err )
}
f , err := os . OpenFile ( path . Join ( homedir , ".hishtory" , "config.sh" ) ,
os . O_APPEND | os . O_WRONLY , 0644 )
if err != nil {
t . Fatal ( err )
}
defer f . Close ( )
_ , err = f . WriteString ( "\nexport HISTTIMEFORMAT='%F %T '\n" )
if err != nil {
t . Fatal ( err )
}
// Record a command
tester . RunInteractiveShell ( t , ` ls -Slah ` )
// Check it shows up correctly
out := tester . RunInteractiveShell ( t , "hishtory export ls" )
if out != "ls -Slah\n" {
t . Fatalf ( "hishtory had unexpected output=%#v" , out )
}
// Update it to another complex one
homedir , err = os . UserHomeDir ( )
if err != nil {
t . Fatal ( err )
}
f , err = os . OpenFile ( path . Join ( homedir , ".hishtory" , "config.sh" ) ,
os . O_APPEND | os . O_WRONLY , 0644 )
if err != nil {
t . Fatal ( err )
}
defer f . Close ( )
_ , err = f . WriteString ( "\nexport HISTTIMEFORMAT='[%c] '\n" )
if err != nil {
t . Fatal ( err )
}
// Record a command
tester . RunInteractiveShell ( t , ` echo foo ` )
// Check it shows up correctly
out = tester . RunInteractiveShell ( t , "hishtory export echo" )
if out != "echo foo\n" {
t . Fatalf ( "hishtory had unexpected output=%#v" , out )
}
}
2022-09-05 03:37:46 +02:00
func testReuploadHistoryEntries ( t * testing . T , tester shellTester ) {
// Setup
defer shared . BackupAndRestore ( t ) ( )
// Init an initial device
userSecret := installHishtory ( t , tester , "" )
// Set up a second device
restoreFirstProfile := shared . BackupAndRestoreWithId ( t , "-install1" )
installHishtory ( t , tester , userSecret )
// Device 2: Record a command
tester . RunInteractiveShell ( t , ` echo 1 ` )
// Device 2: Record a command with a simulated network error
tester . RunInteractiveShell ( t , ` echo 2; export HISHTORY_SIMULATE_NETWORK_ERROR=1; echo 3 ` )
// Device 1: Run an export and confirm that the network only contains the first command
restoreSecondProfile := shared . BackupAndRestoreWithId ( t , "-install2" )
restoreFirstProfile ( )
out := tester . RunInteractiveShell ( t , "hishtory export | grep -v pipefail" )
expectedOutput := "echo 1\n"
if diff := cmp . Diff ( expectedOutput , out ) ; diff != "" {
t . Fatalf ( "hishtory export mismatch (-expected +got):\n%s\nout=%#v" , diff , out )
}
// Device 2: Run another command but with the network re-enabled
restoreFirstProfile = shared . BackupAndRestoreWithId ( t , "-install1" )
restoreSecondProfile ( )
tester . RunInteractiveShell ( t , ` unset HISHTORY_SIMULATE_NETWORK_ERROR; echo 4 ` )
// Device 2: Run export which contains all results (as it did all along since it is stored offline)
out = tester . RunInteractiveShell ( t , "hishtory export | grep -v pipefail" )
expectedOutput = "echo 1\necho 2; export HISHTORY_SIMULATE_NETWORK_ERROR=1; echo 3\nunset HISHTORY_SIMULATE_NETWORK_ERROR; echo 4\n"
if diff := cmp . Diff ( expectedOutput , out ) ; diff != "" {
t . Fatalf ( "hishtory export mismatch (-expected +got):\n%s\nout=%#v" , diff , out )
}
// Device 1: Now it too sees all the results
restoreFirstProfile ( )
out = tester . RunInteractiveShell ( t , "hishtory export | grep -v pipefail" )
expectedOutput = "echo 1\necho 2; export HISHTORY_SIMULATE_NETWORK_ERROR=1; echo 3\nunset HISHTORY_SIMULATE_NETWORK_ERROR; echo 4\n"
if diff := cmp . Diff ( expectedOutput , out ) ; diff != "" {
t . Fatalf ( "hishtory export mismatch (-expected +got):\n%s\nout=%#v" , diff , out )
}
}
2022-09-22 05:09:49 +02:00
func testHishtoryOffline ( t * testing . T , tester shellTester ) {
// Setup
defer shared . BackupAndRestore ( t ) ( )
// Init an initial device
userSecret := installHishtory ( t , tester , "" )
// Set up a second device
restoreFirstProfile := shared . BackupAndRestoreWithId ( t , "-install1" )
installHishtory ( t , tester , userSecret )
// Device 2: Record a command
tester . RunInteractiveShell ( t , ` echo dev2 ` )
// Device 1: Run a command
restoreSecondProfile := shared . BackupAndRestoreWithId ( t , "-install2" )
restoreFirstProfile ( )
tester . RunInteractiveShell ( t , ` echo dev1-a ` )
// Device 1: Query while offline
out := tester . RunInteractiveShell ( t , ` export HISHTORY_SIMULATE_NETWORK_ERROR=1; hishtory export | grep -v pipefail ` )
expectedOutput := "echo dev2\necho dev1-a\n"
if diff := cmp . Diff ( expectedOutput , out ) ; diff != "" {
t . Fatalf ( "hishtory export mismatch (-expected +got):\n%s\nout=%#v" , diff , out )
}
// Device 2: Record another command
restoreFirstProfile = shared . BackupAndRestoreWithId ( t , "-install1" )
restoreSecondProfile ( )
tester . RunInteractiveShell ( t , ` echo dev2-b ` )
// Device 1: Query while offline before ever retrieving the command
restoreFirstProfile ( )
out = tester . RunInteractiveShell ( t , ` export HISHTORY_SIMULATE_NETWORK_ERROR=1; hishtory export | grep -v pipefail ` )
expectedOutput = "echo dev2\necho dev1-a\n"
if diff := cmp . Diff ( expectedOutput , out ) ; diff != "" {
t . Fatalf ( "hishtory export mismatch (-expected +got):\n%s\nout=%#v" , diff , out )
}
// Device 1: Query while online and get the command
out = tester . RunInteractiveShell ( t , ` hishtory export | grep -v pipefail ` )
expectedOutput = "echo dev2\necho dev1-a\necho dev2-b\n"
if diff := cmp . Diff ( expectedOutput , out ) ; diff != "" {
t . Fatalf ( "hishtory export mismatch (-expected +got):\n%s\nout=%#v" , diff , out )
}
}
2022-09-17 20:49:31 +02:00
func testInitialHistoryImport ( t * testing . T , tester shellTester ) {
// Setup
defer shared . BackupAndRestore ( t ) ( )
// Record some commands before installing hishtory
randomCmdUuid := uuid . Must ( uuid . NewRandom ( ) ) . String ( )
randomCmd := fmt . Sprintf ( ` echo % v - foo
echo % v - bar ` , randomCmdUuid , randomCmdUuid )
tester . RunInteractiveShell ( t , randomCmd )
// Install hishtory
installHishtory ( t , tester , "" )
// Check that hishtory export doesn't have the commands yet
out := tester . RunInteractiveShell ( t , ` hishtory export ` + randomCmdUuid )
expectedOutput := ""
if diff := cmp . Diff ( expectedOutput , out ) ; diff != "" {
t . Fatalf ( "hishtory export mismatch (-expected +got):\n%s\nout=%#v" , diff , out )
}
// Trigger an import
2022-10-01 08:50:25 +02:00
out = tester . RunInteractiveShell ( t , "echo stdincommand | hishtory import" )
2022-09-17 20:49:31 +02:00
r := regexp . MustCompile ( ` Imported (.+) history entries from your existing shell history ` )
matches := r . FindStringSubmatch ( out )
if len ( matches ) != 2 {
t . Fatalf ( "Failed to extract history entries count from output: matches=%#v, out=%#v" , matches , out )
}
num , err := strconv . Atoi ( matches [ 1 ] )
if err != nil {
t . Fatal ( err )
}
if num <= 2 {
t . Fatalf ( "hishtory didn't import enough entries, only found %v entries" , num )
}
// Check that the previously recorded commands are in hishtory
2022-09-23 03:09:51 +02:00
out = tester . RunInteractiveShell ( t , ` hishtory export | grep -v pipefail ` )
2022-10-01 08:50:25 +02:00
expectedOutput = fmt . Sprintf ( "hishtory export %s\necho %s-foo\necho %s-bar\n/tmp/client install \nhishtory export %s\nstdincommand\necho stdincommand | hishtory import\n" , randomCmdUuid , randomCmdUuid , randomCmdUuid , randomCmdUuid )
2022-09-23 03:09:51 +02:00
if diff := cmp . Diff ( expectedOutput , out ) ; diff != "" {
t . Fatalf ( "hishtory export mismatch (-expected +got):\n%s\nout=%#v" , diff , out )
}
// And check a different way
2022-09-17 20:49:31 +02:00
out = tester . RunInteractiveShell ( t , ` hishtory export ` + randomCmdUuid )
expectedOutput = fmt . Sprintf ( "hishtory export %s\necho %s-foo\necho %s-bar\nhishtory export %s\n" , randomCmdUuid , randomCmdUuid , randomCmdUuid , randomCmdUuid )
if diff := cmp . Diff ( expectedOutput , out ) ; diff != "" {
t . Fatalf ( "hishtory export mismatch (-expected +got):\n%s\nout=%#v" , diff , out )
}
}
2022-09-20 07:49:48 +02:00
func testLocalRedaction ( t * testing . T , tester shellTester ) {
// Setup
defer shared . BackupAndRestore ( t ) ( )
// Install hishtory
installHishtory ( t , tester , "" )
// Record some commands
randomCmdUuid := uuid . Must ( uuid . NewRandom ( ) ) . String ( )
randomCmd := fmt . Sprintf ( ` echo % v - foo
echo % v - bas
echo foo
ls / tmp ` , randomCmdUuid , randomCmdUuid )
tester . RunInteractiveShell ( t , randomCmd )
// Check that the previously recorded commands are in hishtory
out := tester . RunInteractiveShell ( t , ` hishtory export | grep -v pipefail ` )
expectedOutput := fmt . Sprintf ( "echo %s-foo\necho %s-bas\necho foo\nls /tmp\n" , randomCmdUuid , randomCmdUuid )
if diff := cmp . Diff ( expectedOutput , out ) ; diff != "" {
t . Fatalf ( "hishtory export mismatch (-expected +got):\n%s\nout=%#v" , diff , out )
}
// Redact foo
out = tester . RunInteractiveShell ( t , ` hishtory redact --force foo ` )
2022-09-22 04:58:10 +02:00
if out != "Permanently deleting 2 entries\n" {
2022-09-20 07:49:48 +02:00
t . Fatalf ( "hishtory redact gave unexpected output=%#v" , out )
}
// Check that the commands are redacted
out = tester . RunInteractiveShell ( t , ` hishtory export | grep -v pipefail ` )
expectedOutput = fmt . Sprintf ( "echo %s-bas\nls /tmp\nhishtory redact --force foo\n" , randomCmdUuid )
if diff := cmp . Diff ( expectedOutput , out ) ; diff != "" {
t . Fatalf ( "hishtory export mismatch (-expected +got):\n%s\nout=%#v" , diff , out )
}
// Redact s
out = tester . RunInteractiveShell ( t , ` hishtory redact --force s ` )
2022-09-22 04:58:10 +02:00
if out != "Permanently deleting 10 entries\n" {
2022-09-20 07:49:48 +02:00
t . Fatalf ( "hishtory redact gave unexpected output=%#v" , out )
}
// Check that the commands are redacted
out = tester . RunInteractiveShell ( t , ` hishtory export | grep -v pipefail ` )
expectedOutput = "hishtory redact --force s\n"
if diff := cmp . Diff ( expectedOutput , out ) ; diff != "" {
t . Fatalf ( "hishtory export mismatch (-expected +got):\n%s\nout=%#v" , diff , out )
}
2022-09-23 03:22:06 +02:00
// Record another command
tester . RunInteractiveShell ( t , ` echo hello ` )
out = tester . RunInteractiveShell ( t , ` hishtory export | grep -v pipefail ` )
expectedOutput = "hishtory redact --force s\necho hello\n"
if diff := cmp . Diff ( expectedOutput , out ) ; diff != "" {
t . Fatalf ( "hishtory export mismatch (-expected +got):\n%s\nout=%#v" , diff , out )
}
// Redact it without --force
out , err := tester . RunInteractiveShellRelaxed ( t , ` yes | hishtory redact hello ` )
shared . Check ( t , err )
if out != "This will permanently delete 1 entries, are you sure? [y/N]" {
t . Fatalf ( "hishtory redact gave unexpected output=%#v" , out )
}
// And check it was redacted
out = tester . RunInteractiveShell ( t , ` hishtory export | grep -v pipefail ` )
expectedOutput = "hishtory redact --force s\nyes | hishtory redact hello\n"
if diff := cmp . Diff ( expectedOutput , out ) ; diff != "" {
t . Fatalf ( "hishtory export mismatch (-expected +got):\n%s\nout=%#v" , diff , out )
}
2022-09-20 07:49:48 +02:00
}
func testRemoteRedaction ( t * testing . T , tester shellTester ) {
// Setup
defer shared . BackupAndRestore ( t ) ( )
// Install hishtory client 1
userSecret := installHishtory ( t , tester , "" )
// Record some commands
randomCmdUuid := uuid . Must ( uuid . NewRandom ( ) ) . String ( )
randomCmd := fmt . Sprintf ( ` echo % v - foo
2022-09-21 06:38:04 +02:00
echo % v - bas
echo foo
ls / tmp ` , randomCmdUuid , randomCmdUuid )
2022-09-20 07:49:48 +02:00
tester . RunInteractiveShell ( t , randomCmd )
// Check that the previously recorded commands are in hishtory
out := tester . RunInteractiveShell ( t , ` hishtory export | grep -v pipefail ` )
expectedOutput := fmt . Sprintf ( "echo %s-foo\necho %s-bas\necho foo\nls /tmp\n" , randomCmdUuid , randomCmdUuid )
if diff := cmp . Diff ( expectedOutput , out ) ; diff != "" {
t . Fatalf ( "hishtory export mismatch (-expected +got):\n%s\nout=%#v" , diff , out )
}
// Install hishtory client 2
restoreInstall1 := shared . BackupAndRestoreWithId ( t , "-1" )
installHishtory ( t , tester , userSecret )
// And confirm that it has the commands too
out = tester . RunInteractiveShell ( t , ` hishtory export | grep -v pipefail ` )
if diff := cmp . Diff ( expectedOutput , out ) ; diff != "" {
t . Fatalf ( "hishtory export mismatch (-expected +got):\n%s\nout=%#v" , diff , out )
}
// Restore the first client, and redact some commands
restoreInstall2 := shared . BackupAndRestoreWithId ( t , "-2" )
restoreInstall1 ( )
out = tester . RunInteractiveShell ( t , ` hishtory redact --force ` + randomCmdUuid )
2022-09-22 04:58:10 +02:00
if out != "Permanently deleting 2 entries\n" {
2022-09-20 07:49:48 +02:00
t . Fatalf ( "hishtory redact gave unexpected output=%#v" , out )
}
// Confirm that client1 doesn't have the commands
out = tester . RunInteractiveShell ( t , ` hishtory export | grep -v pipefail ` )
expectedOutput = fmt . Sprintf ( "echo foo\nls /tmp\nhishtory redact --force %s\n" , randomCmdUuid )
if diff := cmp . Diff ( expectedOutput , out ) ; diff != "" {
t . Fatalf ( "hishtory export mismatch (-expected +got):\n%s\nout=%#v" , diff , out )
}
// Swap back to the second client and then confirm it processed the deletion request
restoreInstall2 ( )
out = tester . RunInteractiveShell ( t , ` hishtory export | grep -v pipefail ` )
if diff := cmp . Diff ( expectedOutput , out ) ; diff != "" {
t . Fatalf ( "hishtory export mismatch (-expected +got):\n%s\nout=%#v" , diff , out )
}
}
2022-09-22 05:30:50 +02:00
2022-10-16 21:43:16 +02:00
func testConfigGetSet ( t * testing . T , tester shellTester ) {
// Setup
defer shared . BackupAndRestore ( t ) ( )
installHishtory ( t , tester , "" )
// Initially is false
out := tester . RunInteractiveShell ( t , ` hishtory config-get enable-control-r ` )
if out != "false" {
t . Fatalf ( "unexpected config-get output: %#v" , out )
}
// Set to true and check
tester . RunInteractiveShell ( t , ` hishtory config-set enable-control-r true ` )
out = tester . RunInteractiveShell ( t , ` hishtory config-get enable-control-r ` )
if out != "true" {
t . Fatalf ( "unexpected config-get output: %#v" , out )
}
// Set to false and check
tester . RunInteractiveShell ( t , ` hishtory config-set enable-control-r false ` )
out = tester . RunInteractiveShell ( t , ` hishtory config-get enable-control-r ` )
if out != "false" {
t . Fatalf ( "unexpected config-get output: %#v" , out )
}
}
2022-10-18 06:58:56 +02:00
func testTui ( t * testing . T , tester shellTester ) {
2022-10-19 00:07:56 +02:00
if os . Getenv ( "GITHUB_ACTION" ) != "" {
t . Skip ( )
// TODO: run this on actions. Need to fix the timezone bug, see https://github.com/ddworken/hishtory/actions/runs/3277144800/jobs/5394045156
}
2022-10-18 06:58:56 +02:00
// Setup
defer shared . BackupAndRestore ( t ) ( )
installHishtory ( t , tester , "" )
// Disable recording so that all our testing commands don't get recorded
_ , _ = tester . RunInteractiveShellRelaxed ( t , ` hishtory disable ` )
// Insert a couple hishtory entries
db := hctx . GetDb ( hctx . MakeContext ( ) )
db . Create ( data . MakeFakeHistoryEntry ( "ls ~/" ) )
db . Create ( data . MakeFakeHistoryEntry ( "echo 'aaaaaa bbbb'" ) )
2022-10-19 00:07:56 +02:00
// Check the initial output when there is no search
out := strings . TrimSpace ( tester . RunInteractiveShell ( t , ` tmux kill - session - t foo || true
tmux - u new - session - d - x 200 - y 50 - s foo
2022-10-18 06:58:56 +02:00
tmux send - t foo hishtory SPACE tquery ENTER
sleep 1
tmux capture - pane - p
tmux kill - session - t foo ` ) )
out = strings . TrimSpace ( strings . Split ( out , "hishtory tquery" ) [ 2 ] )
expected := ` Search Query : > ls
┌ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ┐
│ Hostname CWD Timestamp Exit Code Command │
│ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ │
│ localhost / tmp / Oct 17 2022 21 : 43 : 11 PDT 2 echo ' aaaaaa bbbb ' │
│ localhost / tmp / Oct 17 2022 21 : 43 : 11 PDT 2 ls ~ / │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
└ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ┘ `
2022-10-19 00:07:56 +02:00
if diff := cmp . Diff ( expected , out ) ; diff != "" {
t . Fatalf ( "hishtory export mismatch (-expected +got):\n%s" , diff )
}
// Check the output when there is a search
out = strings . TrimSpace ( tester . RunInteractiveShell ( t , ` tmux kill - session - t foo || true
tmux - u new - session - d - x 200 - y 50 - s foo
tmux send - t foo hishtory SPACE tquery ENTER
sleep 1
tmux send - t foo ls
sleep 1
tmux capture - pane - p
tmux kill - session - t foo ` ) )
out = strings . TrimSpace ( strings . Split ( out , "hishtory tquery" ) [ 2 ] )
expected = ` Search Query : > ls
2022-10-18 06:58:56 +02:00
2022-10-19 00:07:56 +02:00
┌ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ┐
│ Hostname CWD Timestamp Exit Code Command │
│ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ │
│ localhost / tmp / Oct 17 2022 21 : 43 : 11 PDT 2 ls ~ / │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
└ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ┘ `
if diff := cmp . Diff ( expected , out ) ; diff != "" {
t . Fatalf ( "hishtory export mismatch (-expected +got):\n%s" , diff )
}
// Check the output when there is a selected result
out = strings . TrimSpace ( tester . RunInteractiveShell ( t , ` tmux kill - session - t foo || true
tmux - u new - session - d - x 200 - y 50 - s foo
tmux send - t foo hishtory SPACE tquery ENTER
sleep 1
tmux send - t foo ls ENTER
sleep 1
tmux capture - pane - p
tmux kill - session - t foo ` ) )
out = strings . Split ( strings . TrimSpace ( strings . Split ( out , "hishtory tquery" ) [ 2 ] ) , "\n" ) [ 0 ]
expected = ` ls ~/ `
2022-10-18 06:58:56 +02:00
if diff := cmp . Diff ( expected , out ) ; diff != "" {
t . Fatalf ( "hishtory export mismatch (-expected +got):\n%s" , diff )
}
2022-10-19 00:07:56 +02:00
// TODO: test arrow keys
// TODO: test control-r
2022-10-18 06:58:56 +02:00
}
2022-09-23 06:45:20 +02:00
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 . T , tester shellTester , devices * deviceSet , key , deviceId string ) {
hctx . GetLogger ( ) . Printf ( "devices=%#v\n" , devices )
d := device { key , deviceId }
_ , ok := ( * devices . deviceMap ) [ d ]
if ok {
t . Fatal ( fmt . Errorf ( "cannot create device twice for key=%s deviceId=%s" , key , deviceId ) )
}
installHishtory ( t , tester , key )
( * devices . deviceMap ) [ d ] = deviceOp {
backup : func ( ) { shared . BackupAndRestoreWithId ( t , key + deviceId ) } ,
restore : shared . BackupAndRestoreWithId ( t , key + deviceId ) ,
}
}
func switchToDevice ( devices * deviceSet , d device ) {
2022-09-27 07:55:59 +02:00
if devices . currentDevice != nil && d == * devices . currentDevice {
return
}
2022-09-23 06:45:20 +02:00
if devices . currentDevice != nil {
( * devices . deviceMap ) [ * devices . currentDevice ] . backup ( )
}
devices . currentDevice = & d
( * devices . deviceMap ) [ d ] . restore ( )
}
func testMultipleUsers ( t * testing . T , tester shellTester ) {
defer shared . BackupAndRestore ( t ) ( )
// Create all our devices
var deviceMap map [ device ] deviceOp = make ( map [ device ] deviceOp )
var devices deviceSet = deviceSet { }
devices . deviceMap = & deviceMap
devices . currentDevice = nil
u1d1 := device { key : "user1" , deviceId : "1" }
createDevice ( t , tester , & devices , u1d1 . key , u1d1 . deviceId )
u1d2 := device { key : "user1" , deviceId : "2" }
createDevice ( t , tester , & devices , u1d2 . key , u1d2 . deviceId )
u2d1 := device { key : "user2" , deviceId : "1" }
createDevice ( t , tester , & devices , u2d1 . key , u2d1 . deviceId )
u2d2 := device { key : "user2" , deviceId : "2" }
createDevice ( t , tester , & devices , u2d2 . key , u2d2 . deviceId )
u2d3 := device { key : "user2" , deviceId : "3" }
createDevice ( t , tester , & devices , u2d3 . key , u2d3 . deviceId )
// Run commands on user1
switchToDevice ( & devices , u1d1 )
_ , _ = tester . RunInteractiveShellRelaxed ( t , ` echo u1d1 ` )
switchToDevice ( & devices , u1d2 )
_ , _ = tester . RunInteractiveShellRelaxed ( t , ` echo u1d2 ` )
// Run commands on user2
switchToDevice ( & devices , u2d1 )
_ , _ = tester . RunInteractiveShellRelaxed ( t , ` echo u2d1 ` )
switchToDevice ( & devices , u2d2 )
_ , _ = tester . RunInteractiveShellRelaxed ( t , ` echo u2d2 ` )
switchToDevice ( & devices , u2d3 )
_ , _ = tester . RunInteractiveShellRelaxed ( t , ` echo u2d3 ` )
// Run more commands on user1
switchToDevice ( & devices , u1d1 )
_ , _ = tester . RunInteractiveShellRelaxed ( t , ` echo u1d1-b ` )
_ , _ = tester . RunInteractiveShellRelaxed ( t , ` echo u1d1-c ` )
switchToDevice ( & devices , u1d2 )
_ , _ = tester . RunInteractiveShellRelaxed ( t , ` echo u1d2-b ` )
_ , _ = tester . RunInteractiveShellRelaxed ( t , ` echo u1d2-c ` )
// Check that the right commands were recorded for user1
for i , d := range [ ] device { u1d1 , u1d2 } {
switchToDevice ( & devices , d )
out , err := tester . RunInteractiveShellRelaxed ( t , ` hishtory export ` )
shared . Check ( t , err )
expectedOutput := "echo u1d1\necho u1d2\necho u1d1-b\necho u1d1-c\necho u1d2-b\necho u1d2-c\n"
for j := 0 ; j < i ; j ++ {
expectedOutput += "hishtory export\n"
}
if diff := cmp . Diff ( expectedOutput , out ) ; diff != "" {
t . Fatalf ( "hishtory export mismatch (-expected +got):\n%s\nout=%#v" , diff , out )
}
}
// Run more commands on user2
switchToDevice ( & devices , u2d1 )
_ , _ = tester . RunInteractiveShellRelaxed ( t , ` echo u1d1-b ` )
_ , _ = tester . RunInteractiveShellRelaxed ( t , ` echo u1d1-c ` )
switchToDevice ( & devices , u2d3 )
_ , _ = tester . RunInteractiveShellRelaxed ( t , ` echo u2d3-b ` )
_ , _ = tester . RunInteractiveShellRelaxed ( t , ` echo u2d3-c ` )
// Check that the right commands were recorded for user2
for i , d := range [ ] device { u2d1 , u2d2 , u2d3 } {
switchToDevice ( & devices , d )
out , err := tester . RunInteractiveShellRelaxed ( t , ` hishtory export ` )
shared . Check ( t , err )
expectedOutput := "echo u2d1\necho u2d2\necho u2d3\necho u1d1-b\necho u1d1-c\necho u2d3-b\necho u2d3-c\n"
for j := 0 ; j < i ; j ++ {
expectedOutput += "hishtory export\n"
}
if diff := cmp . Diff ( expectedOutput , out ) ; diff != "" {
t . Fatalf ( "hishtory export mismatch (-expected +got):\n%s\nout=%#v" , diff , out )
}
}
}
2022-09-23 08:06:28 +02:00
type operation struct {
2022-09-25 01:00:03 +02:00
device device
cmd string
redactQuery string
2022-09-23 08:06:28 +02:00
}
2022-09-23 08:12:41 +02:00
var tmp int = 0
var runCounter * int = & tmp
func fuzzTest ( t * testing . T , tester shellTester , input string ) {
* runCounter += 1
// Parse the input
if len ( input ) > 1_000 {
return
}
input = strings . TrimSpace ( input )
ops := make ( [ ] operation , 0 )
for _ , line := range strings . Split ( input , "\n" ) {
split1 := strings . SplitN ( line , "|" , 2 )
if len ( split1 ) != 2 {
2022-09-25 01:00:03 +02:00
panic ( "malformed: split1" )
2022-09-23 08:12:41 +02:00
}
split2 := strings . SplitN ( split1 [ 0 ] , ";" , 2 )
if len ( split2 ) != 2 {
2022-09-25 01:00:03 +02:00
panic ( "malformed: split2" )
}
thingToDo := split1 [ 1 ]
cmd := ""
redactQuery := ""
if strings . HasPrefix ( thingToDo , "!" ) {
redactQuery = thingToDo [ 1 : ]
} else {
cmd = "echo " + thingToDo
2022-09-23 08:12:41 +02:00
}
re := regexp . MustCompile ( ` [a-zA-Z]+ ` )
2022-09-25 01:00:03 +02:00
if ! re . MatchString ( cmd ) && cmd != "" {
panic ( "malformed: re" )
2022-09-23 08:12:41 +02:00
}
key := split2 [ 0 ]
if strings . Contains ( key , "-" ) {
2022-09-25 01:00:03 +02:00
panic ( "malformed: key-" )
2022-09-23 08:12:41 +02:00
}
2022-09-25 01:00:03 +02:00
op := operation { device : device { key : key + "-" + strconv . Itoa ( * runCounter ) , deviceId : split2 [ 1 ] } , cmd : cmd , redactQuery : redactQuery }
2022-09-23 08:12:41 +02:00
ops = append ( ops , op )
}
// Set up and create the devices
defer shared . BackupAndRestore ( t ) ( )
var deviceMap map [ device ] deviceOp = make ( map [ device ] deviceOp )
var devices deviceSet = deviceSet { }
devices . deviceMap = & deviceMap
devices . currentDevice = nil
for _ , op := range ops {
_ , ok := ( * devices . deviceMap ) [ op . device ]
if ok {
continue
}
createDevice ( t , tester , & devices , op . device . key , op . device . deviceId )
}
// Persist our basic in-memory copy of expected shell commands
keyToCommands := make ( map [ string ] string )
// Run the commands
for _ , op := range ops {
// Run the command
switchToDevice ( & devices , op . device )
2022-09-25 01:00:03 +02:00
if op . cmd != "" {
_ , err := tester . RunInteractiveShellRelaxed ( t , op . cmd )
shared . Check ( t , err )
}
if op . redactQuery != "" {
_ , err := tester . RunInteractiveShellRelaxed ( t , ` hishtory redact --force ` + op . redactQuery )
shared . Check ( t , err )
}
2022-09-23 08:12:41 +02:00
// Calculate the expected output of hishtory export
val , ok := keyToCommands [ op . device . key ]
if ! ok {
val = ""
}
2022-09-25 01:00:03 +02:00
if op . cmd != "" {
val += op . cmd
val += "\n"
}
if op . redactQuery != "" {
lines := strings . Split ( val , "\n" )
filteredLines := make ( [ ] string , 0 )
for _ , line := range lines {
if strings . Contains ( line , op . redactQuery ) {
continue
}
filteredLines = append ( filteredLines , line )
}
val = strings . Join ( filteredLines , "\n" )
val += ` hishtory redact --force ` + op . redactQuery + "\n"
}
2022-09-23 08:12:41 +02:00
keyToCommands [ op . device . key ] = val
// Run hishtory export and check the output
out , err := tester . RunInteractiveShellRelaxed ( t , ` hishtory export | grep -v export ` )
shared . Check ( t , err )
expectedOutput := keyToCommands [ op . device . key ]
if diff := cmp . Diff ( expectedOutput , out ) ; diff != "" {
t . Fatalf ( "hishtory export mismatch for input=%#v key=%s (-expected +got):\n%s\nout=%#v" , input , op . device . key , diff , out )
}
}
// Check that hishtory export has the expected results
for _ , op := range ops {
switchToDevice ( & devices , op . device )
out , err := tester . RunInteractiveShellRelaxed ( t , ` hishtory export | grep -v export ` )
shared . Check ( t , err )
expectedOutput := keyToCommands [ op . device . key ]
if diff := cmp . Diff ( expectedOutput , out ) ; diff != "" {
t . Fatalf ( "hishtory export mismatch for key=%s (-expected +got):\n%s\nout=%#v" , op . device . key , diff , out )
}
}
}
2022-09-23 08:06:28 +02:00
func FuzzTestMultipleUsers ( f * testing . F ) {
2022-09-28 07:03:37 +02:00
if skipSlowTests ( ) {
f . Skip ( "skipping slow tests" )
}
2022-09-25 01:00:03 +02:00
// Format:
// $Op = $Key;$Device|$Command\n
// $Key;$Device|$Command\n$Op
// $Command = !$ThingToRedact
// $CommandToRun
//
// Running repeated commands
2022-09-23 08:06:28 +02:00
f . Add ( "a;b|2\n" )
f . Add ( "a;b|aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" )
f . Add ( "a;b|aaaBBcccDD\n" )
f . Add ( "a;a|hello\na;a|world" )
f . Add ( "a;a|hello\na;a|world\na;b|3" )
f . Add ( "a;a|1\na;a|2\na;b|3\nb;a|4\na;b|5" )
f . Add ( "a;a|1\na;a|2\na;b|1\n" )
f . Add ( "a;a|1\na;a|2\na;b|1\nz;z|1\na;a|1\n" )
f . Add ( "a;a|hello\na;a|wobld" )
2022-09-23 08:12:41 +02:00
f . Add ( "a;a|hello\na;a|hello" )
2022-09-23 08:06:28 +02:00
f . Add ( "a;a|1\nb;a|2\nc;a|2\nd;a|2\na;b|2\na;b|3\na;b|4\na;b|8\na;d|2\nb;a|1" )
f . Add ( "a;a|1\na;b|1\na;c|1\na;d|1\na;e|1\na;f|1\na;g|1\na;b|1\na;b|1\na;b|1\na;b|1" )
2022-09-23 08:25:06 +02:00
f . Add ( "a;a|1\nb;b|1\na;c|1\na;d|1\na;e|1\na;f|1\na;g|1\na;b|1\na;b|1\na;b|1\na;b|1" )
f . Add ( "a;a|1\na;a|1\na;c|1\na;d|1\na;e|1\na;f|1\na;g|1\na;b|1\na;b|1\na;b|1\na;b|1" )
2022-09-25 01:00:03 +02:00
// Running repeated commands with redaction
f . Add ( "a;b|!hello\n" )
f . Add ( "a;b|hello\na;b|world\na;b|!hello\n" )
f . Add ( "a;b|hello\na;b|world\na;a|hello2\na;b|!hello\na;b|hello3\na;b|hello4\n" )
f . Add ( "a;b|hello\na;b|world\na;a|hello2\na;b|!h\na;b|!h\na;b|hello3\na;b|hello4\n" )
2022-09-23 08:06:28 +02:00
f . Fuzz ( func ( t * testing . T , input string ) {
2022-09-23 08:12:41 +02:00
fuzzTest ( t , bashTester { } , input )
fuzzTest ( t , zshTester { } , input )
2022-09-23 08:06:28 +02:00
} )
}