async def test_add_command_failed(self):
ch = command_history.CommandHistory()
with taddons.context(ch) as tctx:
tctx.options.confdir = '/non/existent/path/foobar1234/'
ch.add_command('cmd1')
assert await tctx.master.await_log(
f"Failed writing to {ch.history_file}")
def default_addons():
return [
core.Core(),
browser.Browser(),
block.Block(),
anticache.AntiCache(),
anticomp.AntiComp(),
check_ca.CheckCA(),
clientplayback.ClientPlayback(),
command_history.CommandHistory(),
cut.Cut(),
disable_h2c.DisableH2C(),
export.Export(),
onboarding.Onboarding(),
proxyauth.ProxyAuth(),
script.ScriptLoader(),
serverplayback.ServerPlayback(),
mapremote.MapRemote(),
modifybody.ModifyBody(),
modifyheaders.ModifyHeaders(),
stickyauth.StickyAuth(),
stickycookie.StickyCookie(),
streambodies.StreamBodies(),
save.Save(),
upstream_auth.UpstreamAuth(),
]
def test_filter(self, tmpdir):
ch = command_history.CommandHistory()
with taddons.context(ch) as tctx:
tctx.options.confdir = str(tmpdir)
ch.add_command('cmd1')
ch.add_command('cmd2')
ch.add_command('abc')
ch.set_filter('c')
assert ch.get_next() == 'c'
assert ch.get_next() == 'c'
assert ch.get_prev() == 'cmd2'
assert ch.get_prev() == 'cmd1'
assert ch.get_prev() == 'cmd1'
assert ch.get_next() == 'cmd2'
assert ch.get_next() == 'c'
assert ch.get_next() == 'c'
ch.set_filter('')
assert ch.get_next() == ''
assert ch.get_next() == ''
assert ch.get_prev() == 'abc'
assert ch.get_prev() == 'cmd2'
assert ch.get_prev() == 'cmd1'
assert ch.get_prev() == 'cmd1'
assert ch.get_next() == 'cmd2'
assert ch.get_next() == 'abc'
assert ch.get_next() == ''
assert ch.get_next() == ''
ch.clear_history()
def default_addons():
return [
core.Core(),
browser.Browser(),
block.Block(),
blocklist.BlockList(),
anticache.AntiCache(),
anticomp.AntiComp(),
clientplayback.ClientPlayback(),
command_history.CommandHistory(),
comment.Comment(),
cut.Cut(),
disable_h2c.DisableH2C(),
export.Export(),
onboarding.Onboarding(),
proxyauth.ProxyAuth(),
proxyserver.Proxyserver(),
script.ScriptLoader(),
next_layer.NextLayer(),
serverplayback.ServerPlayback(),
mapremote.MapRemote(),
maplocal.MapLocal(),
modifybody.ModifyBody(),
modifyheaders.ModifyHeaders(),
stickyauth.StickyAuth(),
stickycookie.StickyCookie(),
save.Save(),
tlsconfig.TlsConfig(),
upstream_auth.UpstreamAuth(),
]
def test_add_command(self):
ch = command_history.CommandHistory()
ch.add_command('cmd1')
ch.add_command('cmd2')
assert ch.history == ['cmd1', 'cmd2']
ch.add_command('')
assert ch.history == ['cmd1', 'cmd2']
def test_add_command(self):
ch = command_history.CommandHistory()
with taddons.context(ch):
ch.add_command('cmd1')
ch.add_command('cmd2')
assert ch.history == ['cmd1', 'cmd2']
ch.add_command('')
assert ch.history == ['cmd1', 'cmd2']
def test_load_from_file(self, tmpdir):
commands = ['cmd1', 'cmd2', 'cmd3']
with open(tmpdir.join('command_history'), 'w') as f:
f.write("\n".join(commands))
ch = command_history.CommandHistory()
with taddons.context(ch) as tctx:
tctx.options.confdir = str(tmpdir)
assert ch.history == commands
async def test_done_writing_failed(self):
ch = command_history.CommandHistory()
ch.VACUUM_SIZE = 1
with taddons.context(ch) as tctx:
ch.history.append('cmd1')
ch.history.append('cmd2')
ch.history.append('cmd3')
tctx.options.confdir = '/non/existent/path/foobar1234/'
ch.done()
await tctx.master.await_log(f"Failed writing to {ch.history_file}")
def test_add_command(self):
history = command_history.CommandHistory()
history.add_command('cmd1')
history.add_command('cmd2')
assert history.history == ['cmd1', 'cmd2']
history.add_command('')
assert history.history == ['cmd1', 'cmd2']
async def test_clear_failed(self, monkeypatch):
ch = command_history.CommandHistory()
with taddons.context(ch) as tctx:
tctx.options.confdir = '/non/existent/path/foobar1234/'
with patch.object(Path, 'exists') as mock_exists:
mock_exists.return_value = True
with patch.object(Path, 'unlink') as mock_unlink:
mock_unlink.side_effect = IOError()
ch.clear_history()
await tctx.master.await_log(f"Failed deleting {ch.history_file}")
def test_load_and_save(self, tmpdir):
history_file = tmpdir.join('command_history')
commands = ["cmd1", "cmd2", "cmd3"]
with open(history_file, 'w') as f:
f.write("\n".join(commands))
ch = command_history.CommandHistory()
ch.VACUUM_SIZE = 4
with taddons.context(ch) as tctx:
tctx.options.confdir = str(tmpdir)
assert ch.history == commands
ch.add_command("cmd4")
ch.done()
with open(history_file) as f:
assert f.read() == "cmd3\ncmd4\n"
def commander_tctx(tmpdir):
# This runs before each test
dir_name = tmpdir.mkdir('mitmproxy').dirname
confdir = dir_name
opts = options.Options()
opts.set(*[f"confdir={confdir}"])
commander_tctx = taddons.context(options=opts)
ch = command_history.CommandHistory()
commander_tctx.master.addons.add(ch)
ch.configure('command_history')
yield commander_tctx
# This runs after each test
ch.clear_history()
def test_clear(self, tmpdir):
ch = command_history.CommandHistory()
with taddons.context(ch) as tctx:
tctx.options.confdir = str(tmpdir)
ch.add_command('cmd1')
ch.add_command('cmd2')
ch.clear_history()
saved_commands = ch.get_history()
assert saved_commands == []
assert ch.get_next() == ''
assert ch.get_next() == ''
assert ch.get_prev() == ''
assert ch.get_prev() == ''
ch.clear_history()
def test_get_next_and_prev(self, tmpdir):
ch = command_history.CommandHistory()
with taddons.context(ch) as tctx:
tctx.options.confdir = str(tmpdir)
ch.add_command('cmd1')
assert ch.get_next() == ''
assert ch.get_next() == ''
assert ch.get_prev() == 'cmd1'
assert ch.get_prev() == 'cmd1'
assert ch.get_prev() == 'cmd1'
assert ch.get_next() == ''
assert ch.get_next() == ''
ch.add_command('cmd2')
assert ch.get_next() == ''
assert ch.get_next() == ''
assert ch.get_prev() == 'cmd2'
assert ch.get_prev() == 'cmd1'
assert ch.get_prev() == 'cmd1'
assert ch.get_next() == 'cmd2'
assert ch.get_next() == ''
assert ch.get_next() == ''
ch.add_command('cmd3')
assert ch.get_next() == ''
assert ch.get_next() == ''
assert ch.get_prev() == 'cmd3'
assert ch.get_prev() == 'cmd2'
assert ch.get_prev() == 'cmd1'
assert ch.get_prev() == 'cmd1'
assert ch.get_next() == 'cmd2'
assert ch.get_next() == 'cmd3'
assert ch.get_next() == ''
assert ch.get_next() == ''
assert ch.get_prev() == 'cmd3'
assert ch.get_prev() == 'cmd2'
ch.add_command('cmd4')
assert ch.get_prev() == 'cmd4'
assert ch.get_prev() == 'cmd3'
assert ch.get_prev() == 'cmd2'
assert ch.get_prev() == 'cmd1'
assert ch.get_prev() == 'cmd1'
assert ch.get_next() == 'cmd2'
assert ch.get_next() == 'cmd3'
assert ch.get_next() == 'cmd4'
assert ch.get_next() == ''
assert ch.get_next() == ''
ch.add_command('cmd5')
ch.add_command('cmd6')
assert ch.get_next() == ''
assert ch.get_prev() == 'cmd6'
assert ch.get_prev() == 'cmd5'
assert ch.get_prev() == 'cmd4'
assert ch.get_next() == 'cmd5'
assert ch.get_prev() == 'cmd4'
assert ch.get_prev() == 'cmd3'
assert ch.get_prev() == 'cmd2'
assert ch.get_next() == 'cmd3'
assert ch.get_prev() == 'cmd2'
assert ch.get_prev() == 'cmd1'
assert ch.get_prev() == 'cmd1'
assert ch.get_prev() == 'cmd1'
assert ch.get_next() == 'cmd2'
assert ch.get_next() == 'cmd3'
assert ch.get_next() == 'cmd4'
assert ch.get_next() == 'cmd5'
assert ch.get_next() == 'cmd6'
assert ch.get_next() == ''
assert ch.get_next() == ''
ch.clear_history()
def test_multiple_instances(self, tmpdir):
ch = command_history.CommandHistory()
with taddons.context(ch) as tctx:
tctx.options.confdir = str(tmpdir)
instances = [
command_history.CommandHistory(),
command_history.CommandHistory(),
command_history.CommandHistory()
]
for i in instances:
i.configure('command_history')
saved_commands = i.get_history()
assert saved_commands == []
instances[0].add_command('cmd1')
saved_commands = instances[0].get_history()
assert saved_commands == ['cmd1']
# These instances haven't yet added a new command, so they haven't
# yet reloaded their commands from the command file.
# This is expected, because if the user is filtering a command on
# another window, we don't want to interfere with that
saved_commands = instances[1].get_history()
assert saved_commands == []
saved_commands = instances[2].get_history()
assert saved_commands == []
# Since the second instanced added a new command, its list of
# saved commands has been updated to have the commands from the
# first instance + its own commands
instances[1].add_command('cmd2')
saved_commands = instances[1].get_history()
assert saved_commands == ['cmd2']
saved_commands = instances[0].get_history()
assert saved_commands == ['cmd1']
# Third instance is still empty as it has not yet ran any command
saved_commands = instances[2].get_history()
assert saved_commands == []
instances[2].add_command('cmd3')
saved_commands = instances[2].get_history()
assert saved_commands == ['cmd3']
instances[0].add_command('cmd4')
saved_commands = instances[0].get_history()
assert saved_commands == ['cmd1', 'cmd4']
instances.append(command_history.CommandHistory())
instances[3].configure('command_history')
saved_commands = instances[3].get_history()
assert saved_commands == ['cmd1', 'cmd2', 'cmd3', 'cmd4']
instances[0].add_command('cmd_before_close')
instances.pop(0).done()
saved_commands = instances[0].get_history()
assert saved_commands == ['cmd2']
instances[0].add_command('new_cmd')
saved_commands = instances[0].get_history()
assert saved_commands == ['cmd2', 'new_cmd']
instances.pop(0).done()
instances.pop(0).done()
instances.pop(0).done()
_path = os.path.join(tctx.options.confdir, 'command_history')
lines = open(_path).readlines()
saved_commands = [cmd.strip() for cmd in lines]
assert saved_commands == [
'cmd1', 'cmd2', 'cmd3', 'cmd4', 'cmd_before_close', 'new_cmd'
]
instances = [
command_history.CommandHistory(),
command_history.CommandHistory()
]
for i in instances:
i.configure('command_history')
i.clear_history()
saved_commands = i.get_history()
assert saved_commands == []
instances[0].add_command('cmd1')
instances[0].add_command('cmd2')
instances[1].add_command('cmd3')
instances[1].add_command('cmd4')
instances[1].add_command('cmd5')
saved_commands = instances[1].get_history()
assert saved_commands == ['cmd3', 'cmd4', 'cmd5']
instances.pop().done()
instances.pop().done()
_path = os.path.join(tctx.options.confdir, 'command_history')
lines = open(_path).readlines()
saved_commands = [cmd.strip() for cmd in lines]
assert saved_commands == ['cmd1', 'cmd2', 'cmd3', 'cmd4', 'cmd5']
