<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[14091] twext/trunk/twext/who/ldap</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://trac.calendarserver.org//changeset/14091">14091</a></dd>
<dt>Author</dt> <dd>sagen@apple.com</dd>
<dt>Date</dt> <dd>2014-10-17 16:40:27 -0700 (Fri, 17 Oct 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Support mapping LDAP attribute values to NamedConstants; adds tests for boolean LDAP attributes</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#twexttrunktwextwholdap_servicepy">twext/trunk/twext/who/ldap/_service.py</a></li>
<li><a href="#twexttrunktwextwholdaptesttest_servicepy">twext/trunk/twext/who/ldap/test/test_service.py</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="twexttrunktwextwholdap_servicepy"></a>
<div class="modfile"><h4>Modified: twext/trunk/twext/who/ldap/_service.py (14090 => 14091)</h4>
<pre class="diff"><span>
<span class="info">--- twext/trunk/twext/who/ldap/_service.py 2014-10-17 19:49:34 UTC (rev 14090)
+++ twext/trunk/twext/who/ldap/_service.py 2014-10-17 23:40:27 UTC (rev 14091)
</span><span class="lines">@@ -296,14 +296,21 @@
</span><span class="cx"> raise DirectoryConfigurationError("Mapping for uid required")
</span><span class="cx">
</span><span class="cx"> self._fieldNameToAttributesMap = fieldNameToAttributesMap
</span><del>- self._attributeToFieldNameMap = reverseDict(
- fieldNameToAttributesMap
- )
</del><ins>+
+ self._attributeToFieldNameMap = {}
+ for name, attributes in fieldNameToAttributesMap.iteritems():
+ for attribute in attributes:
+ if ":" in attribute:
+ attribute, ignored = attribute.split(":", 1)
+ self._attributeToFieldNameMap[attribute] = name
+
</ins><span class="cx"> self._recordTypeSchemas = recordTypeSchemas
</span><span class="cx">
</span><span class="cx"> attributesToFetch = set()
</span><span class="cx"> for attributes in fieldNameToAttributesMap.values():
</span><span class="cx"> for attribute in attributes:
</span><ins>+ if ":" in attribute:
+ attribute, ignored = attribute.split(":", 1)
</ins><span class="cx"> attributesToFetch.add(attribute.encode("utf-8"))
</span><span class="cx"> self._attributesToFetch = list(attributesToFetch)
</span><span class="cx">
</span><span class="lines">@@ -751,9 +758,10 @@
</span><span class="cx"> fields = {}
</span><span class="cx">
</span><span class="cx"> for attribute, values in recordData.iteritems():
</span><del>- fieldNames = self._attributeToFieldNameMap.get(attribute)
</del><ins>+ fieldName = self._attributeToFieldNameMap.get(attribute)
+ attributeRules = self._fieldNameToAttributesMap[fieldName]
</ins><span class="cx">
</span><del>- if fieldNames is None:
</del><ins>+ if fieldName is None:
</ins><span class="cx"> # self.log.debug(
</span><span class="cx"> # "Unmapped LDAP attribute {attribute!r} in record "
</span><span class="cx"> # "data: {recordData!r}",
</span><span class="lines">@@ -761,52 +769,70 @@
</span><span class="cx"> # )
</span><span class="cx"> continue
</span><span class="cx">
</span><del>- for fieldName in fieldNames:
- valueType = self.fieldName.valueType(fieldName)
</del><ins>+ valueType = self.fieldName.valueType(fieldName)
</ins><span class="cx">
</span><del>- if valueType in (unicode, UUID):
- if not isinstance(values, list):
- values = [values]
</del><ins>+ if valueType in (unicode, UUID):
+ if not isinstance(values, list):
+ values = [values]
</ins><span class="cx">
</span><del>- if valueType is unicode:
- newValues = []
- for v in values:
- if isinstance(v, unicode):
- # because the ldap unit test produces
- # unicode values (?)
- newValues.append(v)
- else:
- newValues.append(unicode(v, "utf-8"))
- # newValues = [unicode(v, "utf-8") for v in values]
- else:
- newValues = [valueType(v) for v in values]
</del><ins>+ if valueType is unicode:
+ newValues = []
+ for v in values:
+ if isinstance(v, unicode):
+ # because the ldap unit test produces
+ # unicode values (?)
+ newValues.append(v)
+ else:
+ newValues.append(unicode(v, "utf-8"))
+ # newValues = [unicode(v, "utf-8") for v in values]
+ else:
+ newValues = [valueType(v) for v in values]
</ins><span class="cx">
</span><del>- if self.fieldName.isMultiValue(fieldName):
- fields[fieldName] = newValues
- else:
- fields[fieldName] = newValues[0]
</del><ins>+ if self.fieldName.isMultiValue(fieldName):
+ fields[fieldName] = newValues
+ else:
+ fields[fieldName] = newValues[0]
</ins><span class="cx">
</span><del>- elif valueType is bool:
- if not isinstance(values, list):
- values = [values]
- if "=" in attribute:
- attribute, trueValue = attribute.split("=")
- else:
- trueValue = "true"
</del><ins>+ elif valueType is bool:
+ if not isinstance(values, list):
+ values = [values]
</ins><span class="cx">
</span><ins>+ rule = attributeRules[0] # there is only one true value
+ if ":" in rule:
+ ignored, trueValue = rule.split(":")
+ else:
+ trueValue = "true"
+
+ for value in values:
+ if value == trueValue:
+ fields[fieldName] = True
+ break
+ else:
+ fields[fieldName] = False
+
+ elif issubclass(valueType, Names):
+ if not isinstance(values, list):
+ values = [values]
+
+ for rule in attributeRules:
+ attribute, attributeValue, fieldValue = rule.split(":")
+
</ins><span class="cx"> for value in values:
</span><del>- if value == trueValue:
- fields[fieldName] = True
</del><ins>+ if value == attributeValue:
+ # convert to a constant
+ try:
+ fieldValue = valueType.lookupByName(fieldValue)
+ fields[fieldName] = fieldValue
+ except ValueError:
+ pass
</ins><span class="cx"> break
</span><del>- else:
- fields[fieldName] = False
</del><span class="cx">
</span><del>- else:
- raise LDAPConfigurationError(
- "Unknown value type {0} for field {1}".format(
- valueType, fieldName
- )
</del><ins>+ else:
+ raise LDAPConfigurationError(
+ "Unknown value type {0} for field {1}".format(
+ valueType, fieldName
</ins><span class="cx"> )
</span><ins>+ )
</ins><span class="cx">
</span><span class="cx"> # Skip any results missing the uid, which is a required field
</span><span class="cx"> if self.fieldName.uid not in fields:
</span></span></pre></div>
<a id="twexttrunktwextwholdaptesttest_servicepy"></a>
<div class="modfile"><h4>Modified: twext/trunk/twext/who/ldap/test/test_service.py (14090 => 14091)</h4>
<pre class="diff"><span>
<span class="info">--- twext/trunk/twext/who/ldap/test/test_service.py 2014-10-17 19:49:34 UTC (rev 14090)
+++ twext/trunk/twext/who/ldap/test/test_service.py 2014-10-17 23:40:27 UTC (rev 14091)
</span><span class="lines">@@ -60,8 +60,9 @@
</span><span class="cx"> from twext.who.ldap import (
</span><span class="cx"> LDAPAttribute, RecordTypeSchema, LDAPObjectClass
</span><span class="cx"> )
</span><ins>+from twext.who.util import ConstantsContainer
</ins><span class="cx">
</span><del>-from twisted.python.constants import NamedConstant, ValueConstant
</del><ins>+from twisted.python.constants import Names, NamedConstant, ValueConstant
</ins><span class="cx"> from twisted.python.filepath import FilePath
</span><span class="cx"> from twisted.internet.defer import inlineCallbacks
</span><span class="cx"> from twisted.cred.credentials import UsernamePassword
</span><span class="lines">@@ -86,8 +87,41 @@
</span><span class="cx"> )
</span><span class="cx">
</span><span class="cx">
</span><ins>+class TestFieldWithChoices(Names):
</ins><span class="cx">
</span><ins>+ none = NamedConstant()
+ none.description = u"none"
+
+ one = NamedConstant()
+ one.description = u"one"
+
+ two = NamedConstant()
+ two.description = u"two"
+
+ three = NamedConstant()
+ three.description = u"three"
+
+
+class TestFieldName(Names):
+ multiChoice = NamedConstant()
+ multiChoice.description = u"Multiple Choice Test Field"
+ multiChoice.valueType = TestFieldWithChoices
+
+ trueFalse = NamedConstant()
+ trueFalse.description = u"Boolean Test Field"
+ trueFalse.valueType = bool
+
+
+
</ins><span class="cx"> TEST_FIELDNAME_MAP = dict(DEFAULT_FIELDNAME_ATTRIBUTE_MAP)
</span><ins>+TEST_FIELDNAME_MAP[TestFieldName.multiChoice] = (
+ u"testField:One:one",
+ u"testField:Two:two",
+ u"testField:Three:three",
+)
+TEST_FIELDNAME_MAP[TestFieldName.trueFalse] = (
+ u"foo:active",
+)
</ins><span class="cx"> TEST_FIELDNAME_MAP[BaseFieldName.uid] = (u"__who_uid__",)
</span><span class="cx">
</span><span class="cx">
</span><span class="lines">@@ -140,7 +174,7 @@
</span><span class="cx">
</span><span class="cx">
</span><span class="cx"> def service(self, **kwargs):
</span><del>- return TestService(
</del><ins>+ svc = TestService(
</ins><span class="cx"> url=self.url,
</span><span class="cx"> baseDN=self.baseDN,
</span><span class="cx"> fieldNameToAttributesMap=TEST_FIELDNAME_MAP,
</span><span class="lines">@@ -171,6 +205,10 @@
</span><span class="cx"> }),
</span><span class="cx"> **kwargs
</span><span class="cx"> )
</span><ins>+ svc.fieldName = ConstantsContainer(
+ (svc.fieldName, TestFieldName)
+ )
+ return svc
</ins><span class="cx">
</span><span class="cx">
</span><span class="cx">
</span><span class="lines">@@ -382,6 +420,56 @@
</span><span class="cx">
</span><span class="cx">
</span><span class="cx">
</span><ins>+class RecordsFromReplyTest(BaseTestCase, unittest.TestCase):
+
+ def test_boolean(self):
+ service = self.service()
+ reply = (
+ (
+ "dn",
+ {
+ "__who_uid__": u"active",
+ "foo": u"active",
+ }
+ ),
+ (
+ "dn",
+ {
+ "__who_uid__": u"inactive",
+ "foo": u"inactive",
+ }
+ ),
+ )
+ records = service._recordsFromReply(reply, recordType=RecordType.user)
+ self.assertTrue(records[0].trueFalse)
+ self.assertFalse(records[1].trueFalse)
+
+
+ def test_multipleChoice(self):
+ service = self.service()
+ reply = (
+ (
+ "dn",
+ {
+ "__who_uid__": u"two",
+ "testField": u"Two",
+ }
+ ),
+ (
+ "dn",
+ {
+ "__who_uid__": u"four",
+ "testField": u"Four",
+ }
+ ),
+ )
+ records = service._recordsFromReply(reply, recordType=RecordType.user)
+ self.assertEquals(records[0].multiChoice, TestFieldWithChoices.two)
+
+ # "Four" is not a valid value, so it won't get set
+ self.assertFalse(service.fieldName.multiChoice in records[1].fields)
+
+
</ins><span class="cx"> def mockDirectoryDataFromXMLService(service):
</span><span class="cx"> dc0 = u"org"
</span><span class="cx"> dc1 = u"calendarserver"
</span></span></pre>
</div>
</div>
</body>
</html>