Tests: a lot of tests added for better coverage

BoboTiG · BoboTiG · commit 4bc23de13ae9 · 2017-08-05T13:14:41.000+02:00
diff --git a/.travis.yml b/.travis.yml
@@ -17,7 +17,7 @@ before_install:
   - xpra --xvfb="Xorg +extension RANDR -config `pwd`/tests/res/dummy.xorg.conf -logfile ${HOME}/.xpra/xorg.log" start :42
 
 install:
-  - pip install flake8 pylint
+  - pip install flake8 numpy pylint
   - python setup.py install
 
 script:
diff --git a/CHANGELOG b/CHANGELOG
@@ -5,6 +5,7 @@ History:
 dev     2017/xx/xx
       - add the 'Say Thanks' button
       - doc: several fixes (fix #22)
+      - tests: a lot of tests added for better coverage
       - MSS: possibility to use custom class to handle screen shot data
       - Mac: handle screenshot's width not divisible by 16 (fix #14, #19, #21)
 
diff --git a/mss/linux.py b/mss/linux.py
@@ -149,6 +149,7 @@ def __init__(self, display=None):
         self._set_argtypes()
         self._set_restypes()
 
+        # TODO: check if `display` is openable, else SEGFAULT
         self.display = self.xlib.XOpenDisplay(display)
         try:
             self.display.contents
diff --git a/tests/test_get_pixels.py b/tests/test_get_pixels.py
@@ -7,11 +7,11 @@
 
 
 def test_grab_monitor(sct):
-    mon1 = sct.monitors[1]
-    image = sct.grab(mon1)
-    assert isinstance(image, ScreenShot)
-    assert isinstance(image.raw, bytearray)
-    assert isinstance(image.rgb, bytes)
+    for mon in sct.monitors:
+        image = sct.grab(mon)
+        assert isinstance(image, ScreenShot)
+        assert isinstance(image.raw, bytearray)
+        assert isinstance(image.rgb, bytes)
 
 
 def test_grab_part_of_screen(sct):
diff --git a/tests/test_implementation.py b/tests/test_implementation.py
@@ -0,0 +1,190 @@
+# coding: utf-8
+
+import ctypes.util
+import os
+import os.path
+import platform
+import sys
+
+import pytest
+
+import mss
+from mss.base import MSSBase
+from mss.exception import ScreenShotError
+from mss.screenshot import ScreenShot
+
+try:
+    import numpy
+except ImportError:
+    numpy = None
+
+try:
+    from PIL import Image
+except ImportError:
+    Image = None
+
+
+class MSS0(MSSBase):
+    """ Nothing implemented. """
+    pass
+
+
+class MSS1(MSSBase):
+    """ Emulate no monitors. """
+    @property
+    def monitors(self):
+        return []
+
+
+class MSS2(MSSBase):
+    """ Emulate one monitor. """
+    @property
+    def monitors(self):
+        return [{'top': 0, 'left': 0, 'width': 10, 'height': 10}]
+
+
+def test_incomplete_class():
+    # `monitors` property not implemented
+    with pytest.raises(NotImplementedError):
+        for filename in MSS0().save():
+            assert os.path.isfile(filename)
+
+    # `monitors` property is empty
+    with pytest.raises(ScreenShotError):
+        for filename in MSS1().save():
+            assert os.path.isfile(filename)
+
+    # `grab()` not implemented
+    sct = MSS2()
+    with pytest.raises(NotImplementedError):
+        sct.grab(sct.monitors[0])
+
+    # Bad monitor
+    with pytest.raises(ScreenShotError):
+        sct.grab(sct.shot(mon=222))
+
+
+def test_repr(sct):
+    box = {'top': 0, 'left': 0, 'width': 10, 'height': 10}
+    img = sct.grab(box)
+    ref = ScreenShot(bytearray(b'42'), box)
+    assert repr(img) == repr(ref)
+
+
+@pytest.mark.skipif(
+    numpy is None,
+    reason='Numpy module not available.')
+def test_numpy(sct):
+    box = {'top': 0, 'left': 0, 'width': 10, 'height': 10}
+    img = numpy.array(sct.grab(box))
+    assert len(img) == 10
+
+
+@pytest.mark.skipif(
+    Image is None,
+    reason='PIL module not available.')
+def test_pil(sct):
+    box = {'top': 0, 'left': 0, 'width': 10, 'height': 10}
+    sct_img = sct.grab(box)
+
+    img = Image.frombytes('RGB', sct_img.size, sct_img.rgb)
+    assert img.mode == 'RGB'
+    assert img.size == sct_img.size
+
+    for x in range(10):
+        for y in range(10):
+            assert img.getpixel((x, y)) == sct_img.pixel(x, y)
+
+    img.save('box.png')
+    assert os.path.isfile('box.png')
+
+
+def test_factory_basics(monkeypatch):
+    # Current system
+    sct = mss.mss()
+    assert isinstance(sct, MSSBase)
+
+    # Unknown
+    monkeypatch.setattr(platform, 'system', lambda: 'Chuck Norris')
+    with pytest.raises(ScreenShotError) as exc:
+        mss.mss()
+    assert exc.value[0] == 'System not (yet?) implemented.'
+
+
+@pytest.mark.skipif(
+    platform.system().lower() != 'linux',
+    reason='To hard to maintain the test for all platforms.')
+def test_factory_systems(monkeypatch):
+    """ Here, we are testing all systems. """
+
+    # GNU/Linux
+    monkeypatch.setattr(platform, 'system', lambda: 'LINUX')
+    sct = mss.mss()
+    assert isinstance(sct, MSSBase)
+
+    # macOS
+    monkeypatch.setattr(platform, 'system', lambda: 'Darwin')
+    with pytest.raises(ScreenShotError) as exc:
+        mss.mss()
+    assert isinstance(exc.value[1]['self'], MSSBase)
+
+    # Windows
+    monkeypatch.setattr(platform, 'system', lambda: 'wInDoWs')
+    with pytest.raises(ValueError):
+        # wintypes.py:19: ValueError: _type_ 'v' not supported
+        mss.mss()
+
+
+def test_python_call():
+    # __import__('mss.__main__')
+    pytest.skip('Dunno how to test mss/__main__.py.')
+
+
+@pytest.mark.skipif(
+    platform.system().lower() != 'linux',
+    reason='GNU/Linux test only.')
+def test_gnu_linux(monkeypatch):
+    text = str if sys.version[0] > '2' else unicode
+
+    # Bad `display` type
+    mss.mss(display=text(':0'))
+
+    # TODO: SEGFAULT
+    #with pytest.raises(ScreenShotError):
+    #    mss.mss(display=text('0'))
+
+    # No `DISPLAY` in envars
+    monkeypatch.delenv('DISPLAY')
+    with pytest.raises(ScreenShotError):
+        mss.mss()
+    monkeypatch.undo()
+
+    # No `X11` library
+    x11 = ctypes.util.find_library('X11')
+    monkeypatch.setattr(ctypes.util, 'find_library', lambda x: None)
+    with pytest.raises(ScreenShotError):
+        mss.mss()
+    monkeypatch.undo()
+
+    def find_lib(lib):
+        """
+        Returns None to emulate no Xrandr library.
+        Returns the previous found X11 library else.
+
+        It is a naive approach, but works for now.
+        """
+
+        if lib == 'Xrandr':
+            return None
+        return x11
+
+    # No `Xrandr` library
+    monkeypatch.setattr(ctypes.util, 'find_library', find_lib)
+    with pytest.raises(ScreenShotError):
+        mss.mss()
+    monkeypatch.undo()
+
+    # Bad display data
+    import mss.linux
+    monkeypatch.setattr(mss.linux, 'Display', lambda: None)
+    mss.mss()
diff --git a/tests/test_save.py b/tests/test_save.py
@@ -1,6 +1,7 @@
 # coding: utf-8
 
-from os.path import isfile
+import os.path
+import mss
 
 
 def test_at_least_2_monitors(sct):
@@ -9,5 +10,25 @@ def test_at_least_2_monitors(sct):
 
 
 def test_files_exist(sct):
-    for filename in sct.save(mon=0):
-        assert isfile(filename)
+    for filename in sct.save():
+        assert os.path.isfile(filename)
+
+    assert os.path.isfile(sct.shot())
+
+    sct.shot(mon=-1, output='fullscreen.png')
+    assert os.path.isfile('fullscreen.png')
+
+
+def test_callback():
+
+    def on_exists(fname):
+        if os.path.isfile(fname):
+            new_file = fname + '.old'
+            os.rename(fname, new_file)
+
+    with mss.mss() as sct:
+        filename = sct.shot(mon=0, output='mon0.png', callback=on_exists)
+        assert os.path.isfile(filename)
+
+        filename = sct.shot(output='mon1.png', callback=on_exists)
+        assert os.path.isfile(filename)
