extern/hishtory
1
0
Fork 0
mirror of https://github.com/ddworken/hishtory.git synced 2025-08-15 09:32:40 +02:00
Code Issues Packages Projects Releases Wiki Activity

Implement restrictions on default column searching for #268 (#274)

Browse Source 
* Implement restrictions on default column searching for #268

* Add better docs for config-set excluded-default-search-columns

* Enable debugging

* Clean up server binaries to avoid wasting disk space

* Add tests

* Swap from configuring excluded columns to configuring included columns, to prep for future changes where we may add support for other default columns

* Reduce gotestsum re-runs since tests are less flaky nowadays

* Fix bug in lib.where(...) function that failed to trim the args list and caused DB query correctness issues

* Disable tmate debugging

* Update goldens
This commit is contained in:
David Dworken
2025-01-18 12:25:07 -07:00
committed by GitHub
parent 23ed840aa3
commit 65d1ebfd07
15 changed files with 220 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

54
client/integration_test.go
View File

@ -3534,4 +3534,58 @@ func TestOfflineClient(t *testing.T) {
require.Contains(t, err.Error(), "panic: Cannot GetHttpClient() from a hishtory client compiled with the offline tag!")
}
func TestDefaultSearchColumns(t *testing.T) {
markTestForSharding(t, 21)
defer testutils.BackupAndRestore(t)()
tester := zshTester{}
installHishtory(t, tester, "")
// Disable recording so that all our testing commands don't get recorded
_, _ = tester.RunInteractiveShellRelaxed(t, ` hishtory disable`)
_, _ = tester.RunInteractiveShellRelaxed(t, ` hishtory config-set enable-control-r true`)
tester.RunInteractiveShell(t, ` HISHTORY_REDACT_FORCE=true hishtory redact pipefail`)
db := hctx.GetDb(hctx.MakeContext())
require.NoError(t, db.Where("true").Delete(&data.HistoryEntry{}).Error)
// Insert a few hishtory entries that we'll use for testing into an empty DB
e1 := testutils.MakeFakeHistoryEntry("echo hi")
e1.CurrentWorkingDirectory = "/cwd1/"
e1.Hostname = "h1"
require.NoError(t, db.Create(e1).Error)
e2 := testutils.MakeFakeHistoryEntry("ls")
e2.CurrentWorkingDirectory = "/echo/"
e2.Hostname = "hi"
require.NoError(t, db.Create(e2).Error)
// Check that by default all columns are included
out := tester.RunInteractiveShell(t, ` hishtory export echo | grep -v pipefail`)
testutils.CompareGoldens(t, out, "TestDefaultSearchColumns-Default-Echo")
out = tester.RunInteractiveShell(t, ` hishtory export hi | grep -v pipefail`)
testutils.CompareGoldens(t, out, "TestDefaultSearchColumns-Default-Hi")
// Update the config value to exclude CWD
out = tester.RunInteractiveShell(t, ` hishtory config-get default-search-columns`)
require.Equal(t, out, "command current_working_directory hostname \n")
tester.RunInteractiveShell(t, ` hishtory config-set default-search-columns 'hostname' 'command'`)
out = tester.RunInteractiveShell(t, ` hishtory config-get default-search-columns`)
require.Equal(t, out, "hostname command \n")
// Without CWD included
out = tester.RunInteractiveShell(t, ` hishtory export echo | grep -v pipefail`)
testutils.CompareGoldens(t, out, "TestDefaultSearchColumns-NoCWD-Echo")
out = tester.RunInteractiveShell(t, ` hishtory export hi | grep -v pipefail`)
testutils.CompareGoldens(t, out, "TestDefaultSearchColumns-NoCWD-Hi")
// Update the config value to exclude hostname
tester.RunInteractiveShell(t, ` hishtory config-set default-search-columns command`)
out = tester.RunInteractiveShell(t, ` hishtory config-get default-search-columns`)
require.Equal(t, out, "command \n")
// Without hostname included
out = tester.RunInteractiveShell(t, ` hishtory export echo | grep -v pipefail`)
testutils.CompareGoldens(t, out, "TestDefaultSearchColumns-NoCWDHostname-Echo")
out = tester.RunInteractiveShell(t, ` hishtory export hi | grep -v pipefail`)
testutils.CompareGoldens(t, out, "TestDefaultSearchColumns-NoCWDHostname-Hi")
}
// TODO: somehow test/confirm that hishtory works even if only bash/only zsh is installed