Added proof-of-concept testing of SocketCAN on Travis CI & Smaller changes (hardbyte#275)

* added many tests in listsner_test

* added platform checks and very basic SocketCanTest

* added subprocess dependency for testing

* testing CI builds

* test CI builds

* add correct version specifiers to setup.py

* call setup.py correctly

* better error messages in test/config.py

* fix stupid error in test/config.py

* fix test_timestamp unittest

* removed a bazillion log messages when testing

* make tests more forgiving & faster

* test socketcan on Travis CI

* added demo test for socketcan on Travis CI

* try to fix travis builds

* try to fix travis builds number 2

* fix bytes/bytearray bug in Python 2

* skip failing test and leave a note where to find the issue

* added missing '@'

* fix copy&paste mistake

* removed setUpClass() in test case

* add missing 'raise'

Author: felixdivo

.appveyor.yml

@@ -17,15 +17,13 @@ environment:
     - PYTHON: "C:\\Python36-x64"
 
 install:
-  # We need our usual libraries
-  - "%PYTHON%\\python.exe -m pip install -r requirements.txt"
   # We need to install the python-can library itself
-  - "%PYTHON%\\python.exe -m pip install ."
+  - "%PYTHON%\\python.exe -m pip install .[test]"
 
 build: off
 
 test_script:
   # Note that you must use the environment variable %PYTHON% to refer to
   # the interpreter you're using - Appveyor does not do anything special
   # to put the Python version you want to use on PATH.
-  - "%PYTHON%\\python.exe setup.py test"
+  - "%PYTHON%\\python.exe setup.py test -v"

.travis.yml

@@ -43,8 +43,8 @@ matrix:
     - python: "nightly"
 
 install:
-  - travis_retry pip install .
-  - travis_retry pip install -r requirements.txt
+  - if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then sudo bash test/open_vcan.sh ; fi
+  - travis_retry pip install .[test]
 
 script:
   - py.test -v

can/interfaces/virtual.py

@@ -46,7 +46,7 @@ def recv(self, timeout=None):
         except queue.Empty:
             return None
 
-        logger.log(9, 'Received message:\n%s', msg)
+        #logger.log(9, 'Received message:\n%s', msg)
         return msg
 
     def send(self, msg, timeout=None):
@@ -55,7 +55,7 @@ def send(self, msg, timeout=None):
         for bus_queue in self.channel:
             if bus_queue is not self.queue or self.receive_own_messages:
                 bus_queue.put(msg)
-        logger.log(9, 'Transmitted message:\n%s', msg)
+        #logger.log(9, 'Transmitted message:\n%s', msg)
 
     def shutdown(self):
         self.channel.remove(self.queue)

can/io/logger.py

@@ -5,13 +5,17 @@
 See the :class:`Logger` class.
 """
 
+import logging
+
 from .asc import ASCWriter
 from .blf import BLFWriter
 from .csv import CSVWriter
 from .log import CanutilsLogWriter
 from .sqlite import SqliteWriter
 from .stdout import Printer
 
+log = logging.getLogger("can.io.logger")
+
 
 class Logger(object):
     """
@@ -22,6 +26,7 @@ class Logger(object):
       * .blf :class:`can.BLFWriter`
       * .csv: :class:`can.CSVWriter`
       * .db: :class:`can.SqliteWriter`
+      * .log :class:`can.CanutilsLogWriter`
       * other: :class:`can.Printer`
 
     Note this class itself is just a dispatcher,
@@ -35,13 +40,14 @@ def __new__(cls, other, filename):
             return Printer()
         elif filename.endswith(".asc"):
             return ASCWriter(filename)
-        elif filename.endswith(".log"):
-            return CanutilsLogWriter(filename)
         elif filename.endswith(".blf"):
             return BLFWriter(filename)
         elif filename.endswith(".csv"):
             return CSVWriter(filename)
         elif filename.endswith(".db"):
             return SqliteWriter(filename)
+        elif filename.endswith(".log"):
+            return CanutilsLogWriter(filename)
         else:
+            log.info('unknown file type "%s", falling pack to can.Printer', filename)
             return Printer(filename)

can/io/player.py

@@ -44,7 +44,9 @@ class LogReader(object):
 
     @classmethod
     def __new__(cls, other, filename):
-        if filename.endswith(".asc"):
+        if not filename:
+            raise TypeError("a filename must be given")
+        elif filename.endswith(".asc"):
             return ASCReader(filename)
         elif filename.endswith(".blf"):
             return BLFReader(filename)

requirements.txt

@@ -5,21 +5,29 @@
 python-can requires the setuptools package to be installed.
 """
 
+from sys import version_info
 import re
 import logging
 from setuptools import setup, find_packages
 
+logging.basicConfig(level=logging.WARNING)
+
 with open('can/__init__.py', 'r') as fd:
     version = re.search(r'^__version__\s*=\s*[\'"]([^\'"]*)[\'"]',
                         fd.read(), re.MULTILINE).group(1)
 
 with open('README.rst', 'r') as f:
     long_description = f.read()
 
-logging.basicConfig(level=logging.WARNING)
+tests_require = [
+    'mock',
+    'nose',
+    'pyserial >= 3.0',
+]
+if version_info.major < 3:
+    tests_require += ['subprocess32 >= 3.2']
 
 setup(
-
     # Description
     name="python-can",
     url="https://github.com/hardbyte/python-can",
@@ -29,7 +37,9 @@
     # Code
     version=version,
     packages=find_packages(),
-    
+    # see https://www.python.org/dev/peps/pep-0345/#version-specifiers
+    python_requires='>=2.7,!=3.0,!=3.1,!=3.2',
+
     # Author
     author="Brian Thorne",
     author_email="brian@thorne.link",
@@ -45,18 +55,16 @@
 
     # Installation
     install_requires=[
+        'setuptools',
         #'Deprecated >= 1.1.0',
     ],
     extras_require={
         'serial': ['pyserial >= 3.0'],
-        'neovi': ['python-ics'],
+        'neovi': ['python-ics >= 2.8'],
+        'test': tests_require
     },
 
     # Testing
     test_suite="nose.collector",
-    tests_require=[
-        'mock',
-        'nose',
-        'pyserial >= 3.0'
-    ],
+    tests_require=tests_require,
 )

setup.py

@@ -5,14 +5,16 @@
 This module tests two virtual busses attached to each other.
 """
 
-from __future__ import absolute_import
+from __future__ import absolute_import, print_function
 
+import sys
 import unittest
-import time
+from time import sleep
 
 import can
 
 from .config import *
+from .data.example_data import generate_message
 
 BITRATE = 500000
 TIMEOUT = 0.1
@@ -80,12 +82,12 @@ def test_no_message(self):
     def test_timestamp(self):
         self.bus2.send(can.Message())
         recv_msg1 = self.bus1.recv(TIMEOUT)
-        time.sleep(5)
+        sleep(2.0)
         self.bus2.send(can.Message())
         recv_msg2 = self.bus1.recv(TIMEOUT)
         delta_time = recv_msg2.timestamp - recv_msg1.timestamp
-        self.assertTrue(4.8 < delta_time < 5.2,
-                        'Time difference should have been 5s +/- 200ms.' 
+        self.assertTrue(1.75 <= delta_time <= 2.25,
+                        'Time difference should have been 2s +/- 250ms.' 
                         'But measured {}'.format(delta_time))
 
     def test_standard_message(self):
@@ -130,6 +132,39 @@ def test_fd_message_with_brs(self):
                           data=[0xff] * 48)
         self._send_and_receive(msg)
 
+# FIXME
+@unittest.skip("skip until CAN FD support is fixed, see issue #274")
+#@unittest.skipUnless(TEST_INTERFACE_SOCKETCAN, "skip testing of socketcan")
+class BasicTestSocketCan(unittest.TestCase):
+
+    def setUp(self):
+        socketcan_version = can.util.choose_socketcan_implementation()
+        print("testing python-can's socketcan version:",
+              socketcan_version)
+
+        self.bus1 = can.interface.Bus(channel="vcan0",
+                                      bustype=socketcan_version,
+                                      bitrate=250000,
+                                      fd=TEST_CAN_FD)
+        self.bus2 = can.interface.Bus(channel="vcan0",
+                                      bustype=socketcan_version,
+                                      bitrate=250000,
+                                      fd=TEST_CAN_FD)
+
+    def tearDown(self):
+        self.bus1.shutdown()
+        self.bus2.shutdown()
+
+    def test_basics(self):
+        reader = can.BufferedReader()
+        notifier = can.Notifier(self.bus2, [reader])
+
+        message = can.Message(arbitration_id=0x4321, data=[1, 2, 3], extended_id=True)
+        self.bus1.send(message)
+
+        self.assertEqual(message, reader.get_message(timeout=2.0))
+        notifier.stop()
+
 
 if __name__ == '__main__':
     unittest.main()

test/back2back_test.py

@@ -2,14 +2,18 @@
 # coding: utf-8
 
 """
-This module contains some configuration for the tests.
+This module contains various configuration for the tests.
 
 Some tests are skipped when run on a CI server because they are not
 reproducible, see #243 (https://github.com/hardbyte/python-can/issues/243).
 """
 
+import platform
 from os import environ as environment
 
+
+# ############################## 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/
@@ -21,4 +25,27 @@
         environment.get('CI', '').lower() == 'true' or \
         environment.get('CONTINUOUS_INTEGRATION', '').lower() == 'true'
 
+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()
+IS_WINDOWS = "windows" in _sys or ("win" in _sys and "darwin" not in _sys)
+IS_LINUX = "linux" in _sys
+IS_OSX = "darwin" in _sys
+
+if (IS_WINDOWS and IS_LINUX) or (IS_LINUX and IS_OSX) or (IS_WINDOWS and IS_OSX):
+    raise EnvironmentError(
+        "only one of IS_WINDOWS ({}), IS_LINUX ({}) and IS_OSX ({}) ".format(IS_WINDOWS, IS_LINUX, IS_OSX) +
+        "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/config.py

@@ -124,5 +124,5 @@ def generate_message(arbitration_id):
     Generates a new message with the given ID, some random data
     and a non-extended ID.
     """
-    data = bytes([random.randrange(0, 2 ** 8 - 1) for _ in range(8)])
+    data = bytearray([random.randrange(0, 2 ** 8 - 1) for _ in range(8)])
     return Message(arbitration_id=arbitration_id, data=data, extended_id=False)