tests: use tox, enable PyPy and PyPy3, add macOS and Windows CI

BoboTiG · BoboTiG · commit 8e6b752872e7 · 2019-01-02T00:47:53.000+01:00
diff --git a/.gitignore b/.gitignore
@@ -11,3 +11,5 @@ MANIFEST*
 *.png.old
 *.pyc
 .pytest_cache
+.tox
+.vscode
diff --git a/.travis.yml b/.travis.yml
@@ -1,38 +1,77 @@
 language: python
-python:
-  - 2.7
-  - 3.5
-  - 3.6
-  - nightly # currently points to 3.8-dev
 
-# Enable 3.7 without globally enabling sudo and dist: xenial for other build jobs
 matrix:
   include:
-    - python: 3.7
+    - os: linux
+      python: "2.7"
+      env:
+        - TOXENV=py27
+        - DISPLAY=":42"
       dist: xenial
       sudo: true
+    - os: linux
+      python: "3.5"
+      env:
+        - TOXENV=py35
+        - DISPLAY=":42"
+      dist: xenial
+      sudo: true
+    - os: linux
+      python: "3.6"
+      env:
+        - TOXENV=py36
+        - DISPLAY=":42"
+      dist: xenial
+      sudo: true
+    - os: linux
+      python: "3.7"
+      env:
+        - TOXENV=py37
+        - DISPLAY=":42"
+      dist: xenial
+      sudo: true
+    - os: linux
+      python: "pypy"
+      env:
+        - TOXENV=pypy
+        - DISPLAY=":42"
+      dist: xenial
+      sudo: true
+    - os: linux
+      python: "pypy3.5"
+      env:
+        - TOXENV=pypy3
+        - DISPLAY=":42"
+      dist: xenial
+      sudo: true
+    - os: osx
+      language: generic
+      env:
+        - PYTHON_VERSION=2.7
+        - TOXENV=py27
+    - os: osx
+      language: generic
+      env:
+        - PYTHON_VERSION=3.7
+        - TOXENV=py37
+  allow_failures:
+    - python: pypy
+    - python: pypy3.5
 
 addons:
   apt:
     packages:
-      - xpra
-      - xserver-xorg-video-dummy
+      - lsof
 
 before_install:
-  - xpra --xvfb="Xorg +extension RANDR -config `pwd`/tests/res/dummy.xorg.conf -logfile ${HOME}/.xpra/xorg.log" start :42
-
-env:
-  - DISPLAY=":42"
+  - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then bash .travis/install.sh; fi
+  - if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then /sbin/start-stop-daemon --start --quiet --pidfile /tmp/custom_xvfb_99.pid --make-pidfile --background --exec /usr/bin/Xvfb -- $DISPLAY -ac -screen 0 1280x1024x24; fi
 
 install:
-  - python -m pip install flake8 numpy pillow sphinx
-  - python -m pip install -e .
+  - python -m pip install --upgrade pip tox
 
-script:
-  - python -m pytest --display=":42.0" tests
-  - python -m flake8 .
-  - if [[ $TRAVIS_PYTHON_VERSION > '2.8' ]]; then cd docs && make clean html; fi
+before_script:
+  - if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then sh -e /etc/init.d/xvfb start; fi
 
-after_script:
-  - xpra stop :42
-  - cat ~/.xpra/*.log
+script:
+- tox
diff --git a/.travis/install.sh b/.travis/install.sh
@@ -0,0 +1,42 @@
+#!/bin/bash
+# Taken largely from https://stackoverflow.com/q/45257534
+if [[ "$PYTHON_VERSION" == "2.7" ]]; then
+    which virtualenv
+    # Create and activate a virtualenv for conda
+    virtualenv -p python condavenv
+    source condavenv/bin/activate
+    # Grab Miniconda 2
+    wget https://repo.continuum.io/miniconda/Miniconda2-latest-MacOSX-x86_64.sh -O miniconda.sh
+else
+    # Install or upgrade to Python 3
+    brew update 1>/dev/null
+    brew upgrade python
+    # Create and activate a virtualenv for conda
+    virtualenv -p python3 condavenv
+    source condavenv/bin/activate
+    # Grab Miniconda 3
+    wget https://repo.continuum.io/miniconda/Miniconda3-latest-MacOSX-x86_64.sh -O miniconda.sh
+fi
+
+# Install our version of miniconda
+bash miniconda.sh -b -p $HOME/miniconda
+# Modify the PATH, even though this doesn't seem to be effective later on
+export PATH="$HOME/miniconda/bin:$PATH"
+hash -r
+# Configure conda to act non-interactively
+conda config --set always_yes yes --set changeps1 no
+# Update conda to the latest and greatest
+conda update -q conda
+# Enable conda-forge for binary packages, if necessary
+conda config --add channels conda-forge
+# Useful for debugging any issues with conda
+conda info -a
+echo "Creating conda virtualenv with Python $PYTHON_VERSION"
+conda create -n venv python=$PYTHON_VERSION
+# For whatever reason, source is not finding the activate script unless we
+# specify the full path to it
+source $HOME/miniconda/bin/activate venv
+# This is the Python that will be used for running tests, so we dump its
+# version here to help with troubleshooting
+which python
+python --version
diff --git a/CHANGELOG b/CHANGELOG
@@ -2,7 +2,7 @@ History:
 
 <see Git checking messages for history>
 
-4.0.0   201x/xx/xx
+4.0.0   2019/xx/xx
       - MSS: remove use of setup.py for setup.cfg
       - MSS: renamed MSSBase to MSSMixin in base.py
       - MSS: refactor ctypes argtype, restype and errcheck setup (fixes #84)
@@ -13,6 +13,7 @@ History:
       - MSS: fix Flake8 I100: Import statements are in the wrong order
       - MSS: fix Flake8 I201: Missing newline before sections or imports
       - MSS: fix PyLint bad-super-call: Bad first argument 'Exception' given to super()
+      - tests: use tox, enable PyPy and PyPy3, add macOS and Windows CI
 
 3.3.2   2018/11/20
       - new contributors: hugovk, Andreas Buhr
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -1,4 +1,4 @@
-4.0.0 (201x-xx-xx)
+4.0.0 (2019-xx-xx)
 ==================
 
 base.py
diff --git a/appveyor.yml b/appveyor.yml
@@ -0,0 +1,41 @@
+build: off
+
+cache:
+  - '%LOCALAPPDATA%\pip\Cache'
+
+environment:
+  fast_finish: true
+  matrix:
+    - python: py27
+      tox_env: py27
+      python_path: c:\python27
+    - python: py27-x64
+      tox_env: py27
+      python_path: c:\python27-x64
+    - python: py35
+      tox_env: py35
+      python_path: c:\python35
+    - python: py35-x64
+      tox_env: py35
+      python_path: c:\python35-x64
+    - python: py36
+      tox_env: py36
+      python_path: c:\python36
+    - python: py36-x64
+      tox_env: py36
+      python_path: c:\python36-x64
+    - python: py37
+      tox_env: py37
+      python_path: c:\python37
+    - python: py37-x64
+      tox_env: py37
+      python_path: c:\python37-x64
+
+install:
+  - python -m pip install virtualenv
+  - python -m virtualenv env
+  - env\Scripts\activate.bat
+  - python -m pip install --upgrade pip tox
+
+test_script:
+  tox -e %tox_env%
diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -144,6 +144,12 @@ Methods
 
         As it is using the :py:func:`format()` function, you can specify formatting options like ``{date:%Y-%m-%s}``.
 
+        .. warning:: On Windows, the default date format may result with a filename containing ':' which is not allowed::
+
+                IOerror: [Errno 22] invalid mode ('wb') or filename: 'sct_1-2019-01-01 21:20:43.114194.png'
+
+            To fix this, you must provide a custom formatting.
+
     .. method:: shot()
 
         :return str: The created file.
diff --git a/docs/source/developers.rst b/docs/source/developers.rst
@@ -23,49 +23,20 @@ Testing
 Dependency
 ----------
 
-You will need `pytest <https://pypi.python.org/pypi/pytest>`_::
+You will need `tox <https://pypi.org/project/tox/>`_::
 
-    $ python -m pip install --upgrade --user pytest
+    $ python -m pip install --upgrade --user tox
 
 
 How to Test?
 ------------
 
-Enable the developer mode::
-
-    $ python -m pip install -e .
-
 Launch the test suit::
 
-    $ python -m pytest tests
-
-.. Note::
-
-    As he module is Python 2 and 3 compliant, do no forgot to test for both. If you cannot, just say it when sending the patch, someone else will validate for you.
-
-
-Validating the Code
-===================
-
-It is important to keep a clean base code. Use tools like `flake8 <https://pypi.python.org/pypi/flake8>`_.
-
-
-Dependencies
-------------
-
-Install required packages::
-
-    $ python -m pip install --upgrade --user flake8
+    $ tox
+    # TOXENV=py37 tox
 
-
-How to Validate?
-----------------
-
-::
-
-    $ python -m flake8 .
-
-If there is no output, you are good ;)
+This will test MSS and ensure a good code quality.
 
 
 Static Type Checking
@@ -94,18 +65,6 @@ Running Mypy
 Documentation
 =============
 
-Dependencies
-------------
-
-You will need `Sphinx <http://sphinx-doc.org/>`_::
-
-    $ python -m pip install --upgrade --user sphinx
-
-
-How to Build?
--------------
-
-::
+To build the documentation, simply type::
 
-    $ cd docs
-    $ make clean html
+    $ TOXENV=docs tox
diff --git a/mss/windows.py b/mss/windows.py
@@ -16,8 +16,8 @@
     HGDIOBJ,
     HWND,
     INT,
-    LPARAM,
     LONG,
+    LPARAM,
     RECT,
     UINT,
     WORD,
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -10,11 +10,6 @@
 import pytest
 
 
-def pytest_addoption(parser):
-    txt = 'Display to use (examples: ":0.1", ":0" [default])'
-    parser.addoption("--display", action="store", default=":0", help=txt)
-
-
 def purge_files():
     """ Remove all generated files from previous runs. """
 
@@ -32,16 +27,11 @@ def before_tests(request):
     request.addfinalizer(purge_files)
 
 
-@pytest.fixture(scope="session")
-def display(request):
-    return request.config.getoption("--display")
-
-
 @pytest.fixture(scope="module")
-def sct(display):
+def sct():
     try:
-        # `display` keyword is only for GNU/Linux
-        return mss.mss(display=display)
+        # `display` kwarg is only for GNU/Linux
+        return mss.mss(display=os.getenv("DISPLAY"))
     except TypeError:
         return mss.mss()
 
diff --git a/tests/test_find_monitors.py b/tests/test_find_monitors.py
@@ -23,9 +23,9 @@ def test_keys_monitor_1(sct):
 
 def test_dimensions(sct, is_travis):
     mon = sct.monitors[1]
-    if not is_travis:
+    if is_travis:
+        assert mon["width"] == 1280
+        assert mon["height"] == 1240
+    else:
         assert mon["width"] > 0
         assert mon["height"] > 0
-    else:
-        assert mon["width"] == 1920
-        assert mon["height"] == 1440
diff --git a/tests/test_gnu_linux.py b/tests/test_gnu_linux.py
diff --git a/tests/test_save.py b/tests/test_save.py
diff --git a/tox.ini b/tox.ini

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-4.0.0 (201x-xx-xx)`
	`1`	`+4.0.0 (2019-xx-xx)`
`2`	`2`	`==================`
`3`	`3`
`4`	`4`	`base.py`
-Original file line number
+Diff line change
     HGDIOBJ,
     HWND,
     INT,
 -    LPARAM,
     LONG,
 +    LPARAM,
     RECT,
     UINT,
     WORD,