Merge branch 'fix-tag-case' into master; Version 4.3.0

Author: pjkundert

server/enip/device.py

@@ -167,18 +167,18 @@ def redirect_tag( tag, address ):
     Make sure we stay with only str type tags (mostly for Python2, in case somehow we get a Unicode
     tag).  Multi-segment symbolic tags are expected to be looked up as: symbol["<symbol1>.<symbol2>"]
 
+    All Tag lookups are case-insensitive, so are stored lower-case.
     """
-    tag				= str( tag )
     assert isinstance( address, dict )
     assert all( k in symbol_keys for k in address )
     assert all( k in address     for k in symbol_keys )
-    symbol[tag]			= address
+    symbol[str( tag ).lower()]	= address
     return tuple( address[k] for k in symbol_keys )
 
 
 def resolve_tag( tag ):
     """Return the (class_id, instance_id, attribute_id) tuple corresponding to tag, or None if not specified"""
-    address			= symbol.get( str( tag ), None )
+    address			= symbol.get( str( tag ).lower(), None )
     if address:
         return tuple( address[k] for k in symbol_keys )
     return None
@@ -205,7 +205,7 @@ def resolve( path, attribute=False ):
         if ( result['class'] is not None and result['instance'] is not None
              and ( not attribute or result['attribute'] is not None )):
             break # All desired terms specified; done! (ie. ignore 'element')
-        working		= dict( term )
+        working			= dict( term )
         while working:
             # Each term is something like {'class':5}, {'instance':1}, or (from symbol table):
             # {'class':5,'instance':1}.  Pull each key (eg. 'class') from working into result,
@@ -216,17 +216,17 @@ def resolve( path, attribute=False ):
                     assert result[key] is None, \
                         "Failed to override %r==%r with %r from path segment %r in path %r" % (
                             key, result[key], working[key], term, path['segment'] )
-                    result[key] = working.pop( key ) # single 'class'/'instance'/'attribute' seg.
+                    result[key]	= working.pop( key ) # single 'class'/'instance'/'attribute' seg.
             if working:
                 assert 'symbolic' in working, \
                     ( "Unrecognized symbolic name %r found in path %r" % ( tag, path['segment'] )
                       if tag
                       else "Invalid term %r found in path %r" % ( working, path['segment'] ))
-                tag    += ( '.' if tag else '' ) + str( working['symbolic'] )
-                working = None
-                if tag in symbol:
-                    working = dict( symbol[tag] )
-                    tag	= ''
+                tag	       += ( '.' if tag else '' ) + str( working['symbolic'] )
+                working		= None
+                if tag.lower() in symbol:
+                    working	= dict( symbol[tag.lower()] )
+                    tag		= ''
 
     # Any tag not recognized will remain after all resolution complete
     assert not tag, \
@@ -237,7 +237,7 @@ def resolve( path, attribute=False ):
         "Failed to resolve required Class (%r), Instance (%r) %s Attribute(%r) from path: %r" % (
             result['class'], result['instance'], "and the" if attribute else "but not",
             result['attribute'], path['segment'] )
-    result		= result['class'], result['instance'], result['attribute'] if attribute else None
+    result			= result['class'], result['instance'], result['attribute'] if attribute else None
     log.detail( "Class %5d/0x%04x, Instance %3d, Attribute %5r <== %r",
                 result[0], result[0], result[1], result[2], path['segment'] )
 

server/enip_test.py

@@ -3146,13 +3146,17 @@ def test_enip_CIP( repeat=1 ):
 
 
 def test_enip_device_symbolic():
-    enip.device.symbol['SCADA'] = {'class':0x401, 'instance':1, 'attribute':2}
-    path={'segment':[{'symbolic':'SCADA'}, {'element':4}]}
+    enip.device.redirect_tag( 'SCADA', {'class':0x401, 'instance':1, 'attribute':2} )
+    path			= {
+        'segment':[{'symbolic':'SCADA'}, {'element':4}]
+    }
     assert enip.device.resolve( path, attribute=True ) == (0x401,1,2)
     assert enip.device.resolve( path ) == (0x401,1,None)
 
-    enip.device.symbol['Tag.Subtag'] = {'class':0x401, 'instance':1, 'attribute':3}
-    path={'segment':[{'symbolic':'Tag'}, {'symbolic':'Subtag'}, {'element':4}]}
+    enip.device.redirect_tag( 'Tag.Subtag', {'class':0x401, 'instance':1, 'attribute':3} )
+    path			= {
+        'segment':[{'symbolic':'Tag'}, {'symbolic':'Subtag'}, {'element':4}]
+    }
     assert enip.device.resolve( path, attribute=True ) == (0x401,1,3)
 
     try:
@@ -3235,7 +3239,7 @@ class Test_Device( enip.device.Object ):
     assert enip.device.lookup( *enip.device.resolve( {'segment':[{'class':class_num}, {'instance':1}]} )) is O
     assert enip.device.lookup( *enip.device.resolve( {'segment':[{'class':class_num}, {'instance':2}]} )) is O2
 
-    enip.device.symbol['BOO'] = {'class': class_num, 'instance': 1}
+    enip.device.redirect_tag( 'BOO', {'class': class_num, 'instance': 1, 'attribute': 2 } )
 
     path			= {'segment':[{'symbolic':'BOO', 'length':3}, {'attribute':2}, {'element':4}]}
     assert enip.device.lookup( *enip.device.resolve( path )) is O
@@ -3264,7 +3268,7 @@ def test_enip_logix():
     assert len( Obj_a1 ) == 100
 
     # Set up a symbolic tag referencing the Logix Object's Attribute
-    enip.device.symbol['SCADA']	= {'class': Obj.class_id, 'instance': Obj.instance_id, 'attribute':1 }
+    enip.device.redirect_tag( 'SCADA', {'class': Obj.class_id, 'instance': Obj.instance_id, 'attribute':1 } )
 
     # Lets get it to parse a request:
     #     'service': 			0x52,

server/logix_test.py

@@ -143,13 +143,18 @@ def test_logix_multiple():
     Obj_a4 = Obj.attribute['4']	= enip.device.Attribute( 'number',      enip.parser.REAL, default=0.0)
 
     # Set up a symbolic tag referencing the Logix Object's Attribute
-    enip.device.symbol['parts']	= {'class': Obj.class_id, 'instance': Obj.instance_id, 'attribute':1 }
-    enip.device.symbol['ControlWord'] \
-				= {'class': Obj.class_id, 'instance': Obj.instance_id, 'attribute':2 }
-    enip.device.symbol['SCADA_40001'] \
-				= {'class': Obj.class_id, 'instance': Obj.instance_id, 'attribute':3 }
-    enip.device.symbol['number'] \
-				= {'class': Obj.class_id, 'instance': Obj.instance_id, 'attribute':4 }
+    enip.device.redirect_tag( 'parts', {
+        'class': Obj.class_id, 'instance': Obj.instance_id, 'attribute':1
+    })
+    enip.device.redirect_tag( 'ControlWord', {
+        'class': Obj.class_id, 'instance': Obj.instance_id, 'attribute':2
+    })
+    enip.device.redirect_tag('SCADA_40001', {
+	'class': Obj.class_id, 'instance': Obj.instance_id, 'attribute':3
+    })
+    enip.device.redirect_tag( 'number', {
+	'class': Obj.class_id, 'instance': Obj.instance_id, 'attribute':4
+    })
 
 
     assert len( Obj_a1 ) == size
@@ -627,7 +632,9 @@ def logix_performance( repeat=1000 ):
     assert len( Obj_a1 ) == size
 
     # Set up a symbolic tag referencing the Logix Object's Attribute
-    enip.device.symbol['SCADA']	= {'class': Obj.class_id, 'instance': Obj.instance_id, 'attribute':1 }
+    enip.device.redirect_tag( 'SCADA', {
+        'class': Obj.class_id, 'instance': Obj.instance_id, 'attribute':1
+    })
 
     # Lets get it to parse a request, resulting in a 200 element response:
     #     'service': 			0x52,

version.py

@@ -1,2 +1,2 @@
-__version_info__		= ( 4, 2, 5 )
+__version_info__		= ( 4, 3, 0 )
 __version__			= '.'.join( map( str, __version_info__ ))