From 8eee5def5d8ad4bcb5095a76fc9a17e0570c271e Mon Sep 17 00:00:00 2001
From: Ryan Roden-Corrent <ryan@rcorre.net>
Date: Sun, 15 May 2016 22:20:52 -0400
Subject: [PATCH] Add unit tests for the keyhint widget.

- validate keyhint text for a partial keychain
- ensure special keybindings are not suggested
- ensure it is not visible when disabled
- ensure changes to the suffix color are picked up
---
 tests/unit/misc/test_keyhints.py | 96 ++++++++++++++++++++++++++++++++
 1 file changed, 96 insertions(+)
 create mode 100644 tests/unit/misc/test_keyhints.py

diff --git a/tests/unit/misc/test_keyhints.py b/tests/unit/misc/test_keyhints.py
new file mode 100644
index 000000000..975ce88df
--- /dev/null
+++ b/tests/unit/misc/test_keyhints.py
@@ -0,0 +1,96 @@
+# vim: ft=python fileencoding=utf-8 sts=4 sw=4 et:
+
+# Copyright 2016 Ryan Roden-Corrent (rcorre) <ryan@rcorre.net>
+#
+# 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/>.
+
+"""Test the keyhint widget."""
+
+from collections import OrderedDict
+from unittest import mock
+from PyQt5.QtCore import Qt
+from PyQt5.QtWidgets import QApplication
+import pytest
+
+from qutebrowser.misc.keyhintwidget import KeyHintView
+
+
+class TestKeyHintView:
+    """Tests for KeyHintView widget."""
+
+    @pytest.fixture
+    def keyhint(self, qtbot, config_stub, key_config_stub):
+        """Fixture to initialize a KeyHintView."""
+        config_stub.data = {
+            'colors': {
+                'keyhint.fg': 'white',
+                'keyhint.fg.suffix': 'yellow',
+                'keyhint.bg': 'black'
+            },
+            'fonts': {'keyhint': 'Comic Sans'},
+            'ui': {'show-keyhints': True},
+        }
+        keyhint = KeyHintView(0, None)
+        #qtbot.add_widget(keyhint)
+        assert keyhint.text() == ''
+        return keyhint
+
+    def test_suggestions(self, qtbot, keyhint, key_config_stub):
+        """Test cursor position based on the prompt."""
+        # we want the dict to return sorted items() for reliable testing
+        key_config_stub.set_bindings_for('normal', OrderedDict([
+            ('aa', 'cmd-aa'),
+            ('ab', 'cmd-ab'),
+            ('aba', 'cmd-aba'),
+            ('abb', 'cmd-abb'),
+            ('xd', 'cmd-xd'),
+            ('xe', 'cmd-xe')]))
+
+        keyhint.update_keyhint('normal', 'a')
+        line = "a<font color='{}'>{}</font>\t<b>{}</b><br>"
+        assert keyhint.text() == (line.format('yellow', 'a', 'cmd-aa') +
+                                  line.format('yellow', 'b', 'cmd-ab') +
+                                  line.format('yellow', 'ba', 'cmd-aba') +
+                                  line.format('yellow', 'bb', 'cmd-abb'))
+
+    def test_special_bindings(self, qtbot, keyhint, key_config_stub):
+        """Ensure the a prefix of '<' doesn't suggest special keys"""
+        # we want the dict to return sorted items() for reliable testing
+        key_config_stub.set_bindings_for('normal', OrderedDict([
+            ('<a', 'cmd-aa'),
+            ('<b', 'cmd-ab'),
+            ('<ctrl-a>', 'cmd-aba')]))
+
+        keyhint.update_keyhint('normal', '<')
+        line = "&lt;<font color='{}'>{}</font>\t<b>{}</b><br>"
+        assert keyhint.text() == (line.format('yellow', 'a', 'cmd-aa') +
+                                  line.format('yellow', 'b', 'cmd-ab'))
+
+    def test_disable(self, qtbot, keyhint, config_stub):
+        """Ensure the a prefix of '<' doesn't suggest special keys"""
+        config_stub.set('ui', 'show-keyhints', False)
+        keyhint.update_keyhint('normal', 'a')
+        assert not keyhint.text()
+        assert not keyhint.isVisible()
+
+    def test_color_switch(self, qtbot, keyhint, config_stub, key_config_stub):
+        """Ensure the the keyhint suffix color can be updated at runtime."""
+        config_stub.set('colors', 'keyhint.fg.suffix', '#ABCDEF')
+        key_config_stub.set_bindings_for('normal', OrderedDict([
+            ('aa', 'cmd-aa')]))
+        keyhint.update_keyhint('normal', 'a')
+        expected = "a<font color='#ABCDEF'>a</font>\t<b>cmd-aa</b><br>"
+        assert keyhint.text() == expected