Changeset 5973

Timestamp:

05/11/09 17:14:56 (10 years ago)

Author:

pjkersha

Message:

SQLAlchemyAttributeInterface class for Attribute Authority: added special attribute for mapping SAML attribute names to their respective SQL queries.

Location:

TI12-security/trunk/python

Files:

• ndg_security_server/ndg/security/server/attributeauthority.py (modified) (5 diffs)
• ndg_security_test/ndg/security/test/unit/attributeauthority/test_attributeauthority.py (modified) (1 diff)

TI12-security/trunk/python/ndg_security_server/ndg/security/server/attributeauthority.py

@@ -1948 +1948 @@
     SAML_VALID_REQUESTOR_DNS_OPTNAME = 'samlValidRequestorDNs'
     SAML_ASSERTION_LIFETIME_OPTNAME = 'samlAssertionLifetime'
+    SAML_ATTRIBUTE2SQLQUERY_MAP_OPTNAME = 'samlAttribute2SqlQueryMap'
     
     __slots__ = (
@@ -1957 +1958 @@
         SAML_VALID_REQUESTOR_DNS_OPTNAME,
         SAML_ASSERTION_LIFETIME_OPTNAME,
-        'samlAttributeMap'
+        SAML_ATTRIBUTE2SQLQUERY_MAP_OPTNAME,
     )
     __PRIVATE_ATTR_PREFIX = '_SQLAlchemyAttributeInterface__'
@@ -1977 +1978 @@
         self.__samlValidRequestorDNs = None
         self.__samlAssertionLifetime = None
-
+        self.__samlAttribute2SqlQueryMap = {}
+        
         self.setProperties(**properties)
+
+    def __setattr__(self, name, value):
+        """Provide a way to set the attribute map by dynamically handling
+        attribute names containing the SAML attribute name as a suffix e.g.
+        
+        attributeInterface.samlAttribute2SqlQueryMap_firstName = 'Philip'
+        
+        will update __samlAttribute2SqlQueryMap with the 'firstName', 'Philip'
+        key value pair.  Similarly,
+        
+        setattr('samlAttribute2SqlQueryMap.emailAddress', 'pjk@somewhere.ac.uk')
+        
+        sets __samlAttribute2SqlQueryMap with the 'emailAddress',
+        'pjk@somewhere.ac.uk' key value pair
+        """
+        if (name != 'samlAttribute2SqlQueryMap' and
+            name.startswith('samlAttribute2SqlQueryMap')):
+            
+            suffix = name.replace('samlAttribute2SqlQueryMap','')
+            if suffix[0] not in ('.', '_'):
+                raise AttributeError('Expecting "." or "_" separator for '
+                                     'special "samlAttribute2SqlQueryMap*" '
+                                     'attribute setting')
+                
+            samlAttributeName = suffix[1:]
+            self.__samlAttribute2SqlQueryMap[samlAttributeName] = value
+        else:
+            object.__setattr__(self, name, value)
 
     def setProperties(self, **properties):
@@ -2023 +2053 @@
                                    doc="SAML Subject SQL Query")
 
-    def _getSamlAttributeSqlQueries(self):
-        return self.__samlAttributeSqlQueries
-
-    def _setSamlAttributeSqlQueries(self, value):
-        if isinstance(value, basestring):
-            # Allow for multiple queries split by a newline.  Empty and
-            # commented lines are skipped
-            self.__samlAttributeSqlQueries = [q for q in value.split(os.linesep)
-                                              if q and not q.startswith('#')]
+    def _getSamlAttribute2SqlQueryMap(self):
+        return self.__samlAttribute2SqlQueryMap
+
+    def _setSamlAttribute2SqlQueryMap(self, value):
+        if isinstance(value, dict):
+            # Validate string type for keys and values
+            invalidItems = [(k, v) for k, v in value.items() 
+                            if (not isinstance(k, basestring) or 
+                                not isinstance(v, basestring))]
+            if invalidItems:
+                raise TypeError('Expecting string type for '
+                                '"samlAttribute2SqlQueryMap" dict items; '
+                                'got these/this invalid item(s) %r' % 
+                                invalidItems)
+                
+            self.__samlAttribute2SqlQueryMap = value
             
         elif isinstance(value, (tuple, list)):
@@ -2038 +2075 @@
                     raise TypeError('Expecting string type for "%s" '
                                     'attribute items; got %r' %
-                (SQLAlchemyAttributeInterface.SAML_ATTRIBUTE_SQLQUERIES_OPTNAME,
+                (SQLAlchemyAttributeInterface.SAML_ATTRIBUTE2SQLQUERY_MAP_OPTNAME,
                  type(value)))
                     
-            self.__samlAttributeSqlQueries = value                 
+            self.__samlAttribute2SqlQueryMap = value                 
         else:
-            raise TypeError('Expecting string, list or tuple type for "%s" '
-                'attribute; got %r' %
-                (SQLAlchemyAttributeInterface.SAML_ATTRIBUTE_SQLQUERIES_OPTNAME,
-                 type(value)))
-            
-
-    samlAttributeSqlQueries = property(_getSamlAttributeSqlQueries, 
-                                       _setSamlAttributeSqlQueries, 
-                                       doc="SQL Query or queries to obtain the "
+            raise TypeError('Expecting dict type for '
+                            '"samlAttribute2SqlQueryMap" attribute; got %r' %
+            (SQLAlchemyAttributeInterface.SAML_ATTRIBUTE2SQLQUERY_MAP_OPTNAME,
+             type(value)))
+            
+
+    samlAttribute2SqlQueryMap = property(_getSamlAttribute2SqlQueryMap, 
+                                         _setSamlAttribute2SqlQueryMap, 
+                                         doc="SQL Query or queries to obtain the "
                                            "attribute information to respond "
                                            "a SAML attribute query.  The "

TI12-security/trunk/python/ndg_security_test/ndg/security/test/unit/attributeauthority/test_attributeauthority.py

@@ -240 +240 @@
                      "Check the .msg files in this directory")
 
+
+from warnings import warn
     
 class SQLAlchemyAttributeInterfaceTestCase(BaseTestCase):
     def __init__(self, *arg, **kw):
         super(SQLAlchemyAttributeInterfaceTestCase, self).__init__(*arg, **kw)
+        self.skipTests = False
         try:
             self._createDb()
+
         except NotImplementedError:
-            pass
-            
-    def setUp(self):
-        pass
+            # Don't proceed with tests because SQLAlchemy is not installed
+            warn("Skipping SQLAlchemyAttributeInterfaceTestCase because "
+                 "SQLAlchemy is not installed")
+            self.skipTests = True
         
     def test01(self):
+        if self.skipTests:
+            return
+        
         attributeInterface = SQLAlchemyAttributeInterface()
+        attributeInterface.samlAttribute2SqlQueryMap_firstName = 'Philip'
+        setattr(attributeInterface, 'samlAttribute2SqlQueryMap.lastName',
+                'Kershaw')
+        attributeInterface.samlAttribute2SqlQueryMap['emailAddress'] = ('pjk'
+                                                            '@somewhere.ac.uk')
+
                                 
 if __name__ == "__main__":