378 lines
14 KiB
Python
378 lines
14 KiB
Python
# vim: ft=python fileencoding=utf-8 sts=4 sw=4 et:
|
|
|
|
# Copyright 2014-2015 Florian Bruhin (The Compiler) <mail@qutebrowser.org>:
|
|
#
|
|
# This file is part of qutebrowser.
|
|
#
|
|
# qutebrowser is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# qutebrowser is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with qutebrowser. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
"""Tests for BaseKeyParser."""
|
|
|
|
import sys
|
|
import logging
|
|
from unittest import mock
|
|
|
|
from PyQt5.QtCore import Qt
|
|
import pytest
|
|
|
|
from qutebrowser.keyinput import basekeyparser
|
|
from qutebrowser.utils import utils
|
|
|
|
|
|
CONFIG = {'input': {'timeout': 100}}
|
|
CONFIG_NO_TIMEOUT = {'input': {'timeout': 0}}
|
|
|
|
|
|
@pytest.fixture
|
|
def mock_timer(monkeypatch, stubs):
|
|
"""Mock the Timer class used by the usertypes module with a stub."""
|
|
monkeypatch.setattr('qutebrowser.keyinput.basekeyparser.usertypes.Timer',
|
|
stubs.FakeTimer)
|
|
|
|
|
|
class TestDebugLog:
|
|
|
|
"""Make sure _debug_log only logs when do_log is set."""
|
|
|
|
def test_log(self, caplog):
|
|
kp = basekeyparser.BaseKeyParser(0)
|
|
kp._debug_log('foo')
|
|
assert len(caplog.records()) == 1
|
|
record = caplog.records()[0]
|
|
assert record.message == 'foo'
|
|
|
|
def test_no_log(self, caplog):
|
|
kp = basekeyparser.BaseKeyParser(0)
|
|
kp.do_log = False
|
|
kp._debug_log('foo')
|
|
assert not caplog.records()
|
|
|
|
|
|
class TestSplitCount:
|
|
|
|
"""Test the _split_count method.
|
|
|
|
Class Attributes:
|
|
TESTS: list of parameters for the tests, as tuples of
|
|
(input_key, supports_count, expected)
|
|
"""
|
|
|
|
TESTS = [
|
|
# (input_key, supports_count, expected)
|
|
('10', True, (10, '')),
|
|
('10foo', True, (10, 'foo')),
|
|
('-1foo', True, (None, '-1foo')),
|
|
('10e4foo', True, (10, 'e4foo')),
|
|
('foo', True, (None, 'foo')),
|
|
('10foo', False, (None, '10foo')),
|
|
]
|
|
|
|
@pytest.mark.parametrize('input_key, supports_count, expected', TESTS)
|
|
def test_splitcount(self, input_key, supports_count, expected):
|
|
"""Test split_count with only a count."""
|
|
kp = basekeyparser.BaseKeyParser(0, supports_count=supports_count)
|
|
kp._keystring = input_key
|
|
assert kp._split_count() == expected
|
|
|
|
|
|
@pytest.mark.usefixtures('fake_keyconfig', 'mock_timer')
|
|
class TestReadConfig:
|
|
|
|
"""Test reading the config."""
|
|
|
|
def test_read_config_invalid(self):
|
|
"""Test reading config without setting it before."""
|
|
kp = basekeyparser.BaseKeyParser(0)
|
|
with pytest.raises(ValueError):
|
|
kp.read_config()
|
|
|
|
def test_read_config_no_modename(self):
|
|
"""Test reading config with _modename set."""
|
|
kp = basekeyparser.BaseKeyParser(0, supports_chains=True)
|
|
kp._modename = "normal"
|
|
kp.read_config(modename=None)
|
|
assert 'a' in kp.bindings
|
|
|
|
def test_read_config_valid(self):
|
|
"""Test reading config."""
|
|
kp = basekeyparser.BaseKeyParser(0, supports_count=True,
|
|
supports_chains=True)
|
|
kp.read_config('test')
|
|
assert 'ccc' in kp.bindings
|
|
assert 'ctrl+a' in kp.special_bindings
|
|
kp.read_config('test2')
|
|
assert 'ccc' not in kp.bindings
|
|
assert 'ctrl+a' not in kp.special_bindings
|
|
assert 'foo' in kp.bindings
|
|
assert 'ctrl+x' in kp.special_bindings
|
|
|
|
def test_on_keyconfig_changed_mode_none(self):
|
|
"""Test the changes in config with _modename = None."""
|
|
kp = basekeyparser.BaseKeyParser(0, supports_count=False,
|
|
supports_chains=False)
|
|
assert kp._modename is None
|
|
|
|
# No config set so self._modename is None
|
|
with pytest.raises(AssertionError) as excinfo:
|
|
kp.on_keyconfig_changed('normal')
|
|
expected_text = "on_keyconfig_changed called but no section defined!"
|
|
assert str(excinfo.value) == expected_text
|
|
|
|
def test_on_keyconfig_changed_mode_normal(self):
|
|
"""Test the changes in config with _modename set."""
|
|
kp = basekeyparser.BaseKeyParser(0, supports_count=False,
|
|
supports_chains=False)
|
|
kp.read_config = mock.Mock()
|
|
|
|
kp._modename = 'normal'
|
|
kp.on_keyconfig_changed('normal2')
|
|
# Modenames are not equal so read_config() should not be called
|
|
assert not kp.read_config.called
|
|
|
|
kp.on_keyconfig_changed('normal')
|
|
# Both modenames equal so read_config() should be called
|
|
assert kp.read_config.called
|
|
|
|
def test_warn_on_keychains(self, fake_keyevent_factory, monkeypatch):
|
|
"""Test _warn_on_keychains."""
|
|
kp = basekeyparser.BaseKeyParser(0, supports_count=False,
|
|
supports_chains=False)
|
|
|
|
log_mock = mock.Mock()
|
|
monkeypatch.setattr('qutebrowser.utils.log.keyboard', log_mock)
|
|
|
|
kp._warn_on_keychains = False
|
|
kp.read_config('normal')
|
|
assert not log_mock.warning.called
|
|
|
|
kp._warn_on_keychains = True
|
|
kp.read_config('normal')
|
|
assert log_mock.warning.called
|
|
|
|
|
|
@pytest.mark.usefixtures('mock_timer')
|
|
class TestSpecialKeys:
|
|
|
|
"""Check execute() with special keys.
|
|
|
|
Attributes:
|
|
kp: The BaseKeyParser to be tested.
|
|
"""
|
|
|
|
@pytest.fixture(autouse=True)
|
|
def setup(self, caplog, fake_keyconfig):
|
|
self.kp = basekeyparser.BaseKeyParser(0)
|
|
self.kp.execute = mock.Mock()
|
|
with caplog.atLevel(logging.WARNING, 'keyboard'):
|
|
# Ignoring keychain 'ccc' in mode 'test' because keychains are not
|
|
# supported there.
|
|
self.kp.read_config('test')
|
|
|
|
def test_valid_key(self, fake_keyevent_factory):
|
|
"""Test a valid special keyevent."""
|
|
if sys.platform == 'darwin':
|
|
modifier = Qt.MetaModifier
|
|
else:
|
|
modifier = Qt.ControlModifier
|
|
self.kp.handle(fake_keyevent_factory(Qt.Key_A, modifier))
|
|
self.kp.handle(fake_keyevent_factory(Qt.Key_X, modifier))
|
|
self.kp.execute.assert_called_once_with('ctrla', self.kp.Type.special)
|
|
|
|
def test_invalid_key(self, fake_keyevent_factory):
|
|
"""Test an invalid special keyevent."""
|
|
self.kp.handle(fake_keyevent_factory(Qt.Key_A, (Qt.ControlModifier |
|
|
Qt.AltModifier)))
|
|
assert not self.kp.execute.called
|
|
|
|
def test_keychain(self, fake_keyevent_factory):
|
|
"""Test a keychain."""
|
|
self.kp.handle(fake_keyevent_factory(Qt.Key_B))
|
|
self.kp.handle(fake_keyevent_factory(Qt.Key_A))
|
|
assert not self.kp.execute.called
|
|
|
|
def test_no_binding(self, monkeypatch, fake_keyevent_factory):
|
|
"""Test special key with no binding."""
|
|
monkeypatch.setattr(utils, 'keyevent_to_string', lambda binding: None)
|
|
self.kp.handle(fake_keyevent_factory(Qt.Key_A, Qt.NoModifier))
|
|
assert not self.kp.execute.called
|
|
|
|
|
|
@pytest.mark.usefixtures('mock_timer')
|
|
class TestKeyChain:
|
|
|
|
"""Test execute() with keychain support.
|
|
|
|
Attributes:
|
|
kp: The BaseKeyParser to be tested.
|
|
"""
|
|
|
|
@pytest.fixture(autouse=True)
|
|
def setup(self, fake_keyconfig):
|
|
"""Set up mocks and read the test config."""
|
|
self.kp = basekeyparser.BaseKeyParser(0, supports_chains=True,
|
|
supports_count=False)
|
|
self.kp.execute = mock.Mock()
|
|
self.kp.read_config('test')
|
|
|
|
def test_valid_special_key(self, fake_keyevent_factory):
|
|
"""Test valid special key."""
|
|
if sys.platform == 'darwin':
|
|
modifier = Qt.MetaModifier
|
|
else:
|
|
modifier = Qt.ControlModifier
|
|
self.kp.handle(fake_keyevent_factory(Qt.Key_A, modifier))
|
|
self.kp.handle(fake_keyevent_factory(Qt.Key_X, modifier))
|
|
self.kp.execute.assert_called_once_with('ctrla', self.kp.Type.special)
|
|
assert self.kp._keystring == ''
|
|
|
|
def test_invalid_special_key(self, fake_keyevent_factory):
|
|
"""Test invalid special key."""
|
|
self.kp.handle(fake_keyevent_factory(Qt.Key_A, (Qt.ControlModifier |
|
|
Qt.AltModifier)))
|
|
assert not self.kp.execute.called
|
|
assert self.kp._keystring == ''
|
|
|
|
def test_keychain(self, fake_keyevent_factory):
|
|
"""Test valid keychain."""
|
|
# Press 'x' which is ignored because of no match
|
|
self.kp.handle(fake_keyevent_factory(Qt.Key_X, text='x'))
|
|
# Then start the real chain
|
|
self.kp.handle(fake_keyevent_factory(Qt.Key_B, text='b'))
|
|
self.kp.handle(fake_keyevent_factory(Qt.Key_A, text='a'))
|
|
self.kp.execute.assert_called_once_with('ba', self.kp.Type.chain, None)
|
|
assert self.kp._keystring == ''
|
|
|
|
def test_0(self, fake_keyevent_factory):
|
|
"""Test with 0 keypress."""
|
|
self.kp.handle(fake_keyevent_factory(Qt.Key_0, text='0'))
|
|
self.kp.execute.assert_called_once_with('0', self.kp.Type.chain, None)
|
|
assert self.kp._keystring == ''
|
|
|
|
def test_ambiguous_keychain(self, qapp, fake_keyevent_factory, config_stub,
|
|
monkeypatch):
|
|
"""Test ambiguous keychain."""
|
|
config_stub.data = CONFIG
|
|
monkeypatch.setattr('qutebrowser.keyinput.basekeyparser.config',
|
|
config_stub)
|
|
timer = self.kp._ambiguous_timer
|
|
assert not timer.isActive()
|
|
# We start with 'a' where the keychain gives us an ambiguous result.
|
|
# Then we check if the timer has been set up correctly
|
|
self.kp.handle(fake_keyevent_factory(Qt.Key_A, text='a'))
|
|
assert not self.kp.execute.called
|
|
assert timer.isSingleShot()
|
|
assert timer.interval() == 100
|
|
assert timer.isActive()
|
|
# Now we type an 'x' and check 'ax' has been executed and the timer
|
|
# stopped.
|
|
self.kp.handle(fake_keyevent_factory(Qt.Key_X, text='x'))
|
|
self.kp.execute.assert_called_once_with('ax', self.kp.Type.chain, None)
|
|
assert not timer.isActive()
|
|
assert self.kp._keystring == ''
|
|
|
|
def test_ambiguous_keychain_no_timeout(self, fake_keyevent_factory,
|
|
config_stub, monkeypatch):
|
|
"""Test ambiguous keychain with timeout equal to 0."""
|
|
config_stub.data = CONFIG_NO_TIMEOUT
|
|
self.kp.handle(fake_keyevent_factory(Qt.Key_A, text='a'))
|
|
assert self.kp.execute.called
|
|
assert not self.kp._ambiguous_timer.isActive()
|
|
|
|
def test_invalid_keychain(self, fake_keyevent_factory):
|
|
"""Test invalid keychain."""
|
|
self.kp.handle(fake_keyevent_factory(Qt.Key_B, text='b'))
|
|
self.kp.handle(fake_keyevent_factory(Qt.Key_C, text='c'))
|
|
assert self.kp._keystring == ''
|
|
|
|
def test_delayed_exec(self, fake_keyevent_factory, config_stub,
|
|
monkeypatch, qtbot):
|
|
"""Test delayec execute for ambiguous keychain."""
|
|
config_stub.data = CONFIG
|
|
|
|
# 'a' is an ambiguous result.
|
|
self.kp.handle(fake_keyevent_factory(Qt.Key_A, text='a'))
|
|
assert not self.kp.execute.called
|
|
assert self.kp._ambiguous_timer.isActive()
|
|
# We wait for the timeout to occur.
|
|
with qtbot.waitSignal(self.kp.keystring_updated, raising=True):
|
|
pass
|
|
assert self.kp.execute.called
|
|
|
|
|
|
@pytest.mark.usefixtures('mock_timer')
|
|
class TestCount:
|
|
|
|
"""Test execute() with counts."""
|
|
|
|
@pytest.fixture(autouse=True)
|
|
def setup(self, fake_keyconfig):
|
|
self.kp = basekeyparser.BaseKeyParser(0, supports_chains=True,
|
|
supports_count=True)
|
|
self.kp.execute = mock.Mock()
|
|
self.kp.read_config('test')
|
|
|
|
def test_no_count(self, fake_keyevent_factory):
|
|
"""Test with no count added."""
|
|
self.kp.handle(fake_keyevent_factory(Qt.Key_B, text='b'))
|
|
self.kp.handle(fake_keyevent_factory(Qt.Key_A, text='a'))
|
|
self.kp.execute.assert_called_once_with('ba', self.kp.Type.chain, None)
|
|
assert self.kp._keystring == ''
|
|
|
|
def test_count_0(self, fake_keyevent_factory):
|
|
"""Test with count=0."""
|
|
self.kp.handle(fake_keyevent_factory(Qt.Key_0, text='0'))
|
|
self.kp.handle(fake_keyevent_factory(Qt.Key_B, text='b'))
|
|
self.kp.handle(fake_keyevent_factory(Qt.Key_A, text='a'))
|
|
calls = [mock.call('0', self.kp.Type.chain, None),
|
|
mock.call('ba', self.kp.Type.chain, None)]
|
|
self.kp.execute.assert_has_calls(calls)
|
|
assert self.kp._keystring == ''
|
|
|
|
def test_count_42(self, fake_keyevent_factory):
|
|
"""Test with count=42."""
|
|
self.kp.handle(fake_keyevent_factory(Qt.Key_4, text='4'))
|
|
self.kp.handle(fake_keyevent_factory(Qt.Key_2, text='2'))
|
|
self.kp.handle(fake_keyevent_factory(Qt.Key_B, text='b'))
|
|
self.kp.handle(fake_keyevent_factory(Qt.Key_A, text='a'))
|
|
self.kp.execute.assert_called_once_with('ba', self.kp.Type.chain, 42)
|
|
assert self.kp._keystring == ''
|
|
|
|
def test_count_42_invalid(self, fake_keyevent_factory):
|
|
"""Test with count=42 and invalid command."""
|
|
# Invalid call with ccx gets ignored
|
|
self.kp.handle(fake_keyevent_factory(Qt.Key_4, text='4'))
|
|
self.kp.handle(fake_keyevent_factory(Qt.Key_2, text='2'))
|
|
self.kp.handle(fake_keyevent_factory(Qt.Key_B, text='c'))
|
|
self.kp.handle(fake_keyevent_factory(Qt.Key_A, text='c'))
|
|
self.kp.handle(fake_keyevent_factory(Qt.Key_A, text='x'))
|
|
assert not self.kp.execute.called
|
|
assert self.kp._keystring == ''
|
|
# Valid call with ccc gets the correct count
|
|
self.kp.handle(fake_keyevent_factory(Qt.Key_4, text='2'))
|
|
self.kp.handle(fake_keyevent_factory(Qt.Key_2, text='3'))
|
|
self.kp.handle(fake_keyevent_factory(Qt.Key_B, text='c'))
|
|
self.kp.handle(fake_keyevent_factory(Qt.Key_A, text='c'))
|
|
self.kp.handle(fake_keyevent_factory(Qt.Key_A, text='c'))
|
|
self.kp.execute.assert_called_once_with('ccc', self.kp.Type.chain, 23)
|
|
assert self.kp._keystring == ''
|
|
|
|
|
|
def test_clear_keystring(qtbot):
|
|
"""Test that the keystring is cleared and the signal is emitted"""
|
|
kp = basekeyparser.BaseKeyParser(0)
|
|
kp._keystring = 'test'
|
|
with qtbot.waitSignal(kp.keystring_updated):
|
|
kp.clear_keystring()
|
|
assert kp._keystring == ''
|