Merge branch 'develop' into test-message-sync

felixdivo · web-flow · commit ffa8bea4e6b1 · 2019-05-02T12:08:07.000+02:00
diff --git a/.travis.yml b/.travis.yml
@@ -1,14 +1,15 @@
 language: python
 
 python:
-  # CPython; versions pre-2.7 and 3.0-3.4 have reached EOL
+  # CPython; versions pre-2.7 and 3.0-3.5 have reached EOL
   - "2.7"
   - "3.6"
-  - "3.7-dev" # TODO: change to "3.7" once it is supported by travis-ci
-  - "nightly"
+  - "3.7"
+  - 3.8-dev
+  - nightly
   # PyPy:
-  - "pypy" # Python 2.7
-  - "pypy3.5" # Python 3.5
+  - pypy # Python 2.7
+  - pypy3.5 # Python 3.5
 
 os:
   - linux   # Linux is officially supported and we test the library under
@@ -25,39 +26,58 @@ os:
 # - windows # Windows is not supported at all by Travis CI as of Feb. 2018
 
 # Linux setup
-dist: trusty
-sudo: required
+dist: xenial
 
 matrix:
-  # see "os: ..." above
   include:
+    # building the docs
+    - python: "3.7"
+      env: BUILD_ONLY_DOCS=TRUE
+    # testing socketcan on Trusty & Python 3.6, since it is not available on Xenial
+    - os: linux
+      dist: trusty
+      python: "3.6"
+      sudo: required
+      env: TEST_SOCKETCAN=TRUE
+    # testing on macOS; see "os: ..." above
     - os: osx
       osx_image: xcode8.3
-      python: "3.6-dev"
+      python: 3.6-dev
     - os: osx
       osx_image: xcode8.3
-      python: "3.7-dev"
+      python: 3.7-dev
     - os: osx
       osx_image: xcode8.3
-      python: "nightly"
+      python: nightly
 
   allow_failures:
-    # allow all nighly builds to fail, since these python versions might be unstable
-    - python: "nightly"
-    # we do not allow dev builds to fail, since these builds are considered stable enough
+    # we allow all dev & nighly builds to fail, since these python versions might
+    # still be very unstable
+    - python: 3.8-dev
+    - python: nightly
 
 install:
-  - if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then sudo bash test/open_vcan.sh ; fi
-  - if [[ "$TRAVIS_PYTHON_VERSION" == "3.6" ]]; then travis_retry pip install -r doc/doc-requirements.txt; fi
+  - if [[ "$TEST_SOCKETCAN" ]]; then sudo bash test/open_vcan.sh ; fi
+  - if [[ "$BUILD_ONLY_DOCS" ]]; then travis_retry pip install -r doc/doc-requirements.txt; fi
   - travis_retry pip install .[test]
 
 script:
-  - pytest
-  - codecov
-  # Build Docs with Sphinx
-  # -a Write all files
-  # -n nitpicky
-  - if [[ "$TRAVIS_PYTHON_VERSION" == "3.6" ]]; then python -m sphinx -an doc build; fi
+  - |
+    if [[ "$BUILD_ONLY_DOCS" ]]; then
+      # Build the docs with Sphinx
+      #   -a Write all files
+      #   -n nitpicky
+      python -m sphinx -an doc build
+    else
+      # Run the tests
+      python setup.py test
+      # preserve the error code
+      RETURN_CODE=$?
+      # Upload the coverage to codecov.io
+      codecov
+      # set error code
+      (exit $RETURN_CODE);
+    fi
 
 # Have travis deploy tagged commits to PyPi
 deploy:
diff --git a/doc/internal-api.rst b/doc/internal-api.rst
@@ -90,14 +90,15 @@ Ideally add both reading and writing support for the new file format, although t
    Besides from a constructor, only ``__iter__(self)`` needs to be implemented.
 3. Implement a writer ``CanstoreWriter`` (which often extends :class:`can.io.generic.BaseIOHandler` and :class:`can.Listener`, but does not have to).
    Besides from a constructor, only ``on_message_received(self, msg)`` needs to be implemented.
-4. Document the two new classes (and possibly additional helpers) with docstrings and comments.
+4. Add a case to ``can.io.player.LogReader``'s ``__new__()``.
+5. Document the two new classes (and possibly additional helpers) with docstrings and comments.
    Please mention features and limitations of the implementation.
-5. Add a short section to the bottom of *doc/listeners.rst*.
-6. Add tests where appropriate, for example by simply adding a test case called
+6. Add a short section to the bottom of *doc/listeners.rst*.
+7. Add tests where appropriate, for example by simply adding a test case called
    `class TestCanstoreFileFormat(ReaderWriterTest)` to *test/logformats_test.py*.
    That should already handle all of the general testing.
    Just follow the way the other tests in there do it.
-7. Add imports to *can/__init__py* and *can/io/__init__py* so that the
+8. Add imports to *can/__init__py* and *can/io/__init__py* so that the
    new classes can be simply imported as *from can import CanstoreReader, CanstoreWriter*.
 
 
diff --git a/setup.py b/setup.py
@@ -48,7 +48,7 @@
     url="https://github.com/hardbyte/python-can",
     description="Controller Area Network interface module for Python",
     long_description=long_description,
-    classifiers=(
+    classifiers=[
         # a list of all available ones: https://pypi.org/classifiers/
         "Programming Language :: Python",
         "Programming Language :: Python :: 2.7",
@@ -74,7 +74,7 @@
         "Topic :: System :: Networking",
         "Topic :: System :: Hardware :: Hardware Drivers",
         "Topic :: Utilities"
-    ),
+    ],
 
     # Code
     version=version,
diff --git a/test/config.py b/test/config.py
@@ -12,22 +12,25 @@
 from os import environ as environment
 
 
+def env(name): # type: bool
+    return environment.get(name, '').lower() in ("yes", "true", "t", "1")
+
+
 # ############################## Continuos integration
 
 # see here for the environment variables that are set on the CI servers:
 #   - https://docs.travis-ci.com/user/environment-variables/
 #   - https://www.appveyor.com/docs/environment-variables/
 
-IS_TRAVIS = environment.get('TRAVIS', '').lower() == 'true'
-IS_APPVEYOR = environment.get('APPVEYOR', '').lower() == 'true'
+IS_TRAVIS = env('TRAVIS')
+IS_APPVEYOR = env('APPVEYOR')
 
-IS_CI = IS_TRAVIS or IS_APPVEYOR or \
-        environment.get('CI', '').lower() == 'true' or \
-        environment.get('CONTINUOUS_INTEGRATION', '').lower() == 'true'
+IS_CI = IS_TRAVIS or IS_APPVEYOR or env('CI') or env('CONTINUOUS_INTEGRATION')
 
 if IS_APPVEYOR and IS_TRAVIS:
     raise EnvironmentError("IS_APPVEYOR and IS_TRAVIS cannot be both True at the same time")
 
+
 # ############################## Platforms
 
 _sys = platform.system().lower()
@@ -42,11 +45,10 @@
         "can be True at the same time " +
         '(platform.system() == "{}")'.format(platform.system())
     )
-elif not IS_WINDOWS and not IS_LINUX and not IS_OSX:
-    raise EnvironmentError("one of IS_WINDOWS, IS_LINUX, IS_OSX has to be True")
+
 
 # ############################## What tests to run
 
 TEST_CAN_FD = True
 
-TEST_INTERFACE_SOCKETCAN = IS_CI and IS_LINUX
+TEST_INTERFACE_SOCKETCAN = IS_LINUX and env('TEST_SOCKETCAN')
diff --git a/test/test_detect_available_configs.py b/test/test_detect_available_configs.py
@@ -15,7 +15,7 @@
 
 from can import detect_available_configs
 
-from .config import IS_LINUX, IS_CI
+from .config import IS_LINUX, IS_CI, TEST_INTERFACE_SOCKETCAN
 
 
 class TestDetectAvailableConfigs(unittest.TestCase):
@@ -45,13 +45,13 @@ def test_content_socketcan(self):
         for config in configs:
             self.assertEqual(config['interface'], 'socketcan')
 
-    @unittest.skipUnless(IS_LINUX and IS_CI, "socketcan is only available on Linux")
+    @unittest.skipUnless(TEST_INTERFACE_SOCKETCAN, "socketcan is not tested")
     def test_socketcan_on_ci_server(self):
         configs = detect_available_configs(interfaces='socketcan')
         self.assertGreaterEqual(len(configs), 1)
         self.assertIn('vcan0', [config['channel'] for config in configs])
 
-    # see TestSocketCanHelpers.test_find_available_interfaces()
+    # see TestSocketCanHelpers.test_find_available_interfaces() too
 
 
 if __name__ == '__main__':
diff --git a/test/test_socketcan_helpers.py b/test/test_socketcan_helpers.py
@@ -37,7 +37,7 @@ def test_find_available_interfaces(self):
         self.assertGreaterEqual(len(result), 0)
         for entry in result:
             self.assertRegexpMatches(entry, r"v?can\d+")
-        if IS_CI:
+        if TEST_INTERFACE_SOCKETCAN:
             self.assertGreaterEqual(len(result), 1)
             self.assertIn("vcan0", result)
 
