Merge branch 'feature-multipath'; Version 4.0.3

Author: pjkundert

.travis.yml

@@ -17,6 +17,6 @@ install:
   - pip install 'argparse; python_version < "2.7"'
   - pip install 'configparser; python_version < "3.0"'
 
-# command to run tests
+# command to run tests.  Must give a concrete location for time-related tests to pass
 script:
-  - python -m pytest -v
+  - TZ=Canada/Mountain python -m pytest -v

GNUmakefile

@@ -71,9 +71,11 @@ help:
 	@echo "  vmware-debian-up	Brings up Jessie VM w/ Docker capability" 
 	@echo "  vmware-debian-ssh	Log in to the VM" 
 
-test:
+test2:
 	$(PY2TEST) || true
+test3:
 	$(PY3TEST) || true
+test: test2 test3
 
 install:
 	$(PY2) setup.py install
@@ -164,6 +166,10 @@ test-%:
 	$(PY2TEST) *$*_test.py
 	$(PY3TEST) *$*_test.py
 
+unit2-%:
+	$(PY2TEST) -k $*
+unit3-%:
+	$(PY3TEST) -k $*
 unit-%:
 	$(PY2TEST) -k $*
 	$(PY3TEST) -k $*

README.org

@@ -14,8 +14,7 @@
 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
 #
 
-from __future__ import absolute_import
-from __future__ import print_function
+from __future__ import absolute_import, print_function, division
 
 __author__                      = "Perry Kundert"
 __email__                       = "[email protected]"

README.pdf

@@ -14,9 +14,11 @@
 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
 #
 
-from __future__ import absolute_import
-from __future__ import print_function
-from __future__ import division
+from __future__ import absolute_import, print_function, division
+try:
+    from future_builtins import zip, map # Use Python 3 "lazy" zip, map
+except ImportError:
+    pass
 
 import array
 import logging
@@ -232,7 +234,7 @@ def push( self, item ):
         if self.memory:
             assert self.memory.pop() == item
         super( remembering, self ).push( item )
-        
+
 
 class decide( object ):
     """A type of object that may be supplied as a state transition target, instead of a state.  It must
@@ -777,9 +779,9 @@ def transition( self, source, machine=None, path=None, data=None, ending=None ):
         # StopIteration after yielding a transition, or if self is a terminal state
 
     def delegate( self, source, machine=None, path=None, data=None, ending=None ):
-        """Base state class delegate generator does nothing."""
-        raise StopIteration
-        yield None 
+        """Base state class delegate generator does nothing; equivalent to `yield from ()` in Python 3.3+"""
+        return
+        yield
 
     def initialize( self, machine=None, path=None, data=None ):
         """Done once at state entry."""
@@ -1399,7 +1401,7 @@ def __init__( self,
 
 
 class string_base( object ):
-    """When combined with a regex class, collects a string matching the regular expression, and puts it
+    r"""When combined with a regex class, collects a string matching the regular expression, and puts it
     in the data artifact at path.context 'string' by default.
 
     The default initial=".*\n", greedy=False configuration scans input only until the regular
@@ -1463,7 +1465,7 @@ def terminate( self, exception, machine=None, path=None, data=None ):
         value			= data[subs]
         if isinstance( value, array.array ):
             if value.typecode == 'c':
-                value		= value.tostring()
+                value		= value.tostring() if sys.version_info[0] < 3 else value.tobytes()
             elif value.typecode == 'B':
                 value		= value.tobytes()
             elif value.typecode == 'u':
@@ -1487,7 +1489,7 @@ class integer_base( string_base ):
     def __init__( self, name, initial=None, context="integer", **kwds ):
         assert initial is None, "Cannot specify a sub-machine for %s.%s" % (
             __package__, self.__class__.__name__ )
-        super( integer_base, self ).__init__( name=name, initial="\d+", context=context,
+        super( integer_base, self ).__init__( name=name, initial=r"\d+", context=context,
                                               greedy=True, **kwds )
 
     def terminate( self, exception, machine=None, path=None, data=None ):

__init__.py

@@ -5,10 +5,12 @@
 # unicode_literals, we cannot have any literals at all with unicode characters under 2.x, while
 # maintaining 3.2 compatibilty.  This is unfortunate.
 
-from __future__ import absolute_import
-from __future__ import print_function
-from __future__ import unicode_literals
-from __future__ import division
+from __future__ import absolute_import, print_function, division, unicode_literals
+try:
+    from future_builtins import zip, map # Use Python 3 "lazy" zip, map
+except ImportError:
+    pass
+
 
 import binascii
 import logging

automata.py

@@ -15,9 +15,11 @@
 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
 # 
 
-from __future__ import absolute_import
-from __future__ import print_function
-from __future__ import division
+from __future__ import absolute_import, print_function, division
+try:
+    from future_builtins import zip, map # Use Python 3 "lazy" zip, map
+except ImportError:
+    pass
 
 __author__                      = "Perry Kundert"
 __email__                       = "[email protected]"

automata_test.py

@@ -0,0 +1,5 @@
+[UCMM]
+Route Path			= 1/0
+Route				= {
+        "1/1-15":	"localhost:44819"
+    }

bin/modbus_sim.py

@@ -52,3 +52,56 @@ Interface Configuration		= {
         "dns_secondary":	"8.8.4.4",
         "domain_name":		"example.com"
     }
+
+# 
+# UCMM -- Unconnected Message Manager
+# 
+[UCMM]
+
+# Route Path -- Device's default request route_path (if any) to respond to
+# 
+# o Only uses this configured Route Path if none is supplied on the command-line
+#   (eg. via -S|--simple|--route_path).
+# o null
+#   - Any Route Path; will ignore the request's provided route_path
+# o 0/False
+#   - no Route Path; only accept "Simple" (non-routing) CIP requests
+# o JSON List of Dict: [{"port": <int>, "link": <int>}]
+#   - Respond to a specific route_path
+#   - Default value is "port": 1 (Backplane), "link": 0 (First slot),
+#     which is typically the slot occupied by the *Logix CPU.
+# 
+# Route Path = <JSON>
+# ----------
+# Route Path			= null		# Any route_path allowed (the default)
+# Route Path			= false		# No route_path (Simple device) 
+# Route Path			= 0		#     ''
+# Route Path			= 1/0		# [{"port": 1, "link": 0}] allowed
+
+# Route -- Route requests w/ specified route_path "port/link" to an EtherNet/IP CIP server
+# 
+# o <port>/<link> --> <ip>[:<port>]
+# o If incoming request's 0'th route_path element matches the given route key, 
+#   then the request is forwarded to the specified EtherNet/IP CIP device, after the
+#   matching route_path element is removed.
+#   - If the resulting (trimmed) route_path is empty, a Simple (non-routing) request
+#     is used (eg. appropriate for a non-routing MicroLogix, A-B Powerflex, etc).
+# 
+# Route				= {
+# 	"1/1":		"localhost:11001",
+# 	"1/2":		"localhost:11002",
+# 	"1/3-7":	"localhost:11003",
+# 	"2/1.2.3.3":	"localhost:11003",
+# 	"2/1.2.3.4":	"192.168.0.4:44818",
+# 	"2/1.2.3.5":	"192.168.0.4:44818"
+#    }
+# 
+# If no Route table is configured, the traditional default behaviour looks only at the UCMM's configured route_path,
+# or the default route_path (see cpppo/server/enip/main.py, route_path_default); see above.
+# 
+# eg. route all Backplane (port 1) Slot (link) 1-15 to the same remote EtherNet/IP CIP device:
+#     All other port/links are invalid, and result in an error status being returned -- unless
+#     the configured Route Path is null -- then any port/link is accepted as a local request.
+# Route				= {
+# 	"1/1-15":	"localhost:44819"
+#    }