Merge branch 'hackebrot-master'

https://github.com/The-Compiler/qutebrowser/pull/604

This PR splits test_debug.py into several modules located in a new sub
directory.

Most importantly it changes the according tests to py.test syntax and
introduces a plugin to examine log messages, namely pytest-capturelog.

README.asciidoc

@@ -134,6 +134,7 @@ Contributors, sorted by the number of commits in descending order:
 // QUTE_AUTHORS_START
 * Florian Bruhin
 * Joel Torstensson
+* Raphael Pierzina
 * Claude
 * ZDarian
 * Peter Vilim

qutebrowser/test/utils/debug/test_log_time.py

@@ -0,0 +1,45 @@
+# Copyright 2014-2015 Florian Bruhin (The Compiler) <mail@qutebrowser.org>
+# vim: ft=python fileencoding=utf-8 sts=4 sw=4 et:
+
+#
+# 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 qutebrowser.utils.debug.log_time."""
+
+import logging
+import re
+import time
+
+from qutebrowser.utils import debug
+
+
+def test_log_time(caplog):
+    """Test if log_time logs properly."""
+    logger_name = 'qt-tests'
+
+    with caplog.atLevel(logging.DEBUG, logger=logger_name):
+        with debug.log_time(logging.getLogger(logger_name), action='foobar'):
+            time.sleep(0.1)
+
+        records = caplog.records()
+        assert len(records) == 1
+
+        pattern = re.compile(r'^Foobar took ([\d.]*) seconds\.$')
+        match = pattern.match(records[0].msg)
+        assert match
+
+        duration = float(match.group(1))
+        assert 0.09 <= duration <= 0.11

qutebrowser/test/utils/debug/test_qenum_key.py

@@ -0,0 +1,65 @@
+# Copyright 2014-2015 Florian Bruhin (The Compiler) <mail@qutebrowser.org>
+# vim: ft=python fileencoding=utf-8 sts=4 sw=4 et:
+
+#
+# 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 qutebrowser.utils.debug.qenum_key."""
+
+import pytest
+
+from PyQt5.QtCore import Qt
+from PyQt5.QtWidgets import QStyle, QFrame
+
+from qutebrowser.utils import debug
+
+
+def test_no_metaobj():
+    """Test with an enum with no meta-object."""
+    assert not hasattr(QStyle.PrimitiveElement, 'staticMetaObject')
+    key = debug.qenum_key(QStyle, QStyle.PE_PanelButtonCommand)
+    assert key == 'PE_PanelButtonCommand'
+
+
+def test_metaobj():
+    """Test with an enum with meta-object."""
+    assert hasattr(QFrame, 'staticMetaObject')
+    key = debug.qenum_key(QFrame, QFrame.Sunken)
+    assert key == 'Sunken'
+
+
+def test_add_base():
+    """Test with add_base=True."""
+    key = debug.qenum_key(QFrame, QFrame.Sunken, add_base=True)
+    assert key == 'QFrame.Sunken'
+
+
+def test_int_noklass():
+    """Test passing an int without explicit klass given."""
+    with pytest.raises(TypeError):
+        debug.qenum_key(QFrame, 42)
+
+
+def test_int():
+    """Test passing an int with explicit klass given."""
+    key = debug.qenum_key(QFrame, 0x0030, klass=QFrame.Shadow)
+    assert key == 'Sunken'
+
+
+def test_unknown():
+    """Test passing an unknown value."""
+    key = debug.qenum_key(QFrame, 0x1337, klass=QFrame.Shadow)
+    assert key == '0x1337'

qutebrowser/test/utils/debug/test_qflags_key.py

@@ -0,0 +1,77 @@
+# Copyright 2014-2015 Florian Bruhin (The Compiler) <mail@qutebrowser.org>
+# vim: ft=python fileencoding=utf-8 sts=4 sw=4 et:
+
+#
+# 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 qutebrowser.utils.debug.qflags_key.
+
+https://github.com/The-Compiler/qutebrowser/issues/42
+"""
+
+import pytest
+
+from PyQt5.QtCore import Qt
+from qutebrowser.utils import debug
+
+
+fixme = pytest.mark.xfail(reason="See issue #42", raises=AssertionError)
+
+
+@fixme
+def test_single():
+    """Test with single value."""
+    flags = debug.qflags_key(Qt, Qt.AlignTop)
+    assert flags == 'AlignTop'
+
+
+@fixme
+def test_multiple():
+    """Test with multiple values."""
+    flags = debug.qflags_key(Qt, Qt.AlignLeft | Qt.AlignTop)
+    assert flags == 'AlignLeft|AlignTop'
+
+
+def test_combined():
+    """Test with a combined value."""
+    flags = debug.qflags_key(Qt, Qt.AlignCenter)
+    assert flags == 'AlignHCenter|AlignVCenter'
+
+
+@fixme
+def test_add_base():
+    """Test with add_base=True."""
+    flags = debug.qflags_key(Qt, Qt.AlignTop, add_base=True)
+    assert flags == 'Qt.AlignTop'
+
+
+def test_int_noklass():
+    """Test passing an int without explicit klass given."""
+    with pytest.raises(TypeError):
+        debug.qflags_key(Qt, 42)
+
+
+@fixme
+def test_int():
+    """Test passing an int with explicit klass given."""
+    flags = debug.qflags_key(Qt, 0x0021, klass=Qt.Alignment)
+    assert flags == 'AlignLeft|AlignTop'
+
+
+def test_unknown():
+    """Test passing an unknown value."""
+    flags = debug.qflags_key(Qt, 0x1100, klass=Qt.Alignment)
+    assert flags == '0x0100|0x1000'

qutebrowser/test/utils/debug/test_signal.py

@@ -0,0 +1,53 @@
+# Copyright 2014-2015 Florian Bruhin (The Compiler) <mail@qutebrowser.org>
+# vim: ft=python fileencoding=utf-8 sts=4 sw=4 et:
+
+#
+# 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 signal debug output functions."""
+
+import pytest
+
+from qutebrowser.test import stubs
+from qutebrowser.utils import debug
+
+
+@pytest.fixture
+def signal():
+    """Fixture to provide a faked pyqtSignal."""
+    return stubs.FakeSignal()
+
+
+def test_signal_name(signal):
+    """Test signal_name()."""
+    assert debug.signal_name(signal) == 'fake'
+
+
+def test_dbg_signal(signal):
+    """Test dbg_signal()."""
+    assert debug.dbg_signal(signal, [23, 42]) == 'fake(23, 42)'
+
+
+def test_dbg_signal_eliding(signal):
+    """Test eliding in dbg_signal()."""
+    dbg_signal = debug.dbg_signal(signal, ['x' * 201])
+    assert dbg_signal == "fake('{}\u2026)".format('x' * 198)
+
+
+def test_dbg_signal_newline(signal):
+    """Test dbg_signal() with a newline."""
+    dbg_signal = debug.dbg_signal(signal, ['foo\nbar'])
+    assert dbg_signal == r"fake('foo\nbar')"

qutebrowser/test/utils/test_debug.py

@@ -1,172 +0,0 @@
-# Copyright 2014-2015 Florian Bruhin (The Compiler) <mail@qutebrowser.org>
-# vim: ft=python fileencoding=utf-8 sts=4 sw=4 et:
-
-#
-# 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 qutebrowser.utils.debug."""
-
-import re
-import time
-import unittest
-import logging
-
-from PyQt5.QtCore import Qt
-from PyQt5.QtWidgets import QStyle, QFrame
-
-from qutebrowser.utils import debug
-from qutebrowser.test import stubs
-
-
-class QEnumKeyTests(unittest.TestCase):
-
-    """Tests for qenum_key."""
-
-    def test_no_metaobj(self):
-        """Test with an enum with no meta-object."""
-        with self.assertRaises(AttributeError):
-            # Make sure it doesn't have a meta object
-            # pylint: disable=pointless-statement,no-member
-            QStyle.PrimitiveElement.staticMetaObject
-        key = debug.qenum_key(QStyle, QStyle.PE_PanelButtonCommand)
-        self.assertEqual(key, 'PE_PanelButtonCommand')
-
-    def test_metaobj(self):
-        """Test with an enum with meta-object."""
-        # pylint: disable=pointless-statement
-        QFrame.staticMetaObject  # make sure it has a meta-object
-        key = debug.qenum_key(QFrame, QFrame.Sunken)
-        self.assertEqual(key, 'Sunken')
-
-    def test_add_base(self):
-        """Test with add_base=True."""
-        key = debug.qenum_key(QFrame, QFrame.Sunken, add_base=True)
-        self.assertEqual(key, 'QFrame.Sunken')
-
-    def test_int_noklass(self):
-        """Test passing an int without explicit klass given."""
-        with self.assertRaises(TypeError):
-            debug.qenum_key(QFrame, 42)
-
-    def test_int(self):
-        """Test passing an int with explicit klass given."""
-        key = debug.qenum_key(QFrame, 0x0030, klass=QFrame.Shadow)
-        self.assertEqual(key, 'Sunken')
-
-    def test_unknown(self):
-        """Test passing an unknown value."""
-        key = debug.qenum_key(QFrame, 0x1337, klass=QFrame.Shadow)
-        self.assertEqual(key, '0x1337')
-
-    def test_reconverted(self):
-        """Test passing a flag value which was re-converted to an enum."""
-        # FIXME maybe this should return the right thing anyways?
-        debug.qenum_key(Qt, Qt.Alignment(int(Qt.AlignLeft)))
-
-
-class QFlagsKeyTests(unittest.TestCase):
-
-    """Tests for qflags_key()."""
-
-    # https://github.com/The-Compiler/qutebrowser/issues/42
-
-    @unittest.skip('FIXME')
-    def test_single(self):
-        """Test with single value."""
-        flags = debug.qflags_key(Qt, Qt.AlignTop)
-        self.assertEqual(flags, 'AlignTop')
-
-    @unittest.skip('FIXME')
-    def test_multiple(self):
-        """Test with multiple values."""
-        flags = debug.qflags_key(Qt, Qt.AlignLeft | Qt.AlignTop)
-        self.assertEqual(flags, 'AlignLeft|AlignTop')
-
-    def test_combined(self):
-        """Test with a combined value."""
-        flags = debug.qflags_key(Qt, Qt.AlignCenter)
-        self.assertEqual(flags, 'AlignHCenter|AlignVCenter')
-
-    @unittest.skip('FIXME')
-    def test_add_base(self):
-        """Test with add_base=True."""
-        flags = debug.qflags_key(Qt, Qt.AlignTop, add_base=True)
-        self.assertEqual(flags, 'Qt.AlignTop')
-
-    def test_int_noklass(self):
-        """Test passing an int without explicit klass given."""
-        with self.assertRaises(TypeError):
-            debug.qflags_key(Qt, 42)
-
-    @unittest.skip('FIXME')
-    def test_int(self):
-        """Test passing an int with explicit klass given."""
-        flags = debug.qflags_key(Qt, 0x0021, klass=Qt.Alignment)
-        self.assertEqual(flags, 'AlignLeft|AlignTop')
-
-    def test_unknown(self):
-        """Test passing an unknown value."""
-        flags = debug.qflags_key(Qt, 0x1100, klass=Qt.Alignment)
-        self.assertEqual(flags, '0x0100|0x1000')
-
-
-class TestDebug(unittest.TestCase):
-
-    """Test signal debug output functions."""
-
-    def setUp(self):
-        self.signal = stubs.FakeSignal()
-
-    def test_signal_name(self):
-        """Test signal_name()."""
-        self.assertEqual(debug.signal_name(self.signal), 'fake')
-
-    def test_dbg_signal(self):
-        """Test dbg_signal()."""
-        self.assertEqual(debug.dbg_signal(self.signal, [23, 42]),
-                         'fake(23, 42)')
-
-    def test_dbg_signal_eliding(self):
-        """Test eliding in dbg_signal()."""
-        self.assertEqual(debug.dbg_signal(self.signal,
-                                          ['x' * 201]),
-                         "fake('{}\u2026)".format('x' * 198))
-
-    def test_dbg_signal_newline(self):
-        """Test dbg_signal() with a newline."""
-        self.assertEqual(debug.dbg_signal(self.signal, ['foo\nbar']),
-                         r"fake('foo\nbar')")
-
-
-class TestLogTime(unittest.TestCase):
-
-    """Test log_time."""
-
-    def test_log_time(self):
-        """Test if log_time logs properly."""
-        logger = logging.getLogger('qt-tests')
-        with self.assertLogs(logger, logging.DEBUG) as logged:
-            with debug.log_time(logger, action='foobar'):
-                time.sleep(0.1)
-            self.assertEqual(len(logged.records), 1)
-            pattern = re.compile(r'^Foobar took ([\d.]*) seconds\.$')
-            match = pattern.match(logged.records[0].msg)
-            self.assertTrue(match)
-            duration = float(match.group(1))
-            self.assertAlmostEqual(duration, 0.1, delta=0.01)
-
-if __name__ == '__main__':
-    unittest.main()

tox.ini

@@ -19,6 +19,7 @@ setenv = QT_QPA_PLATFORM_PLUGIN_PATH={envsitepackagesdir}/PyQt5/plugins/platform
 deps =
     py==1.4.26
     pytest==2.7.0
+    pytest-capturelog==0.7
 # We don't use {[testenv:mkvenv]commands} here because that seems to be broken
 # on Ubuntu Trusty.
 commands =