from inspect import isclass from itertools import chain from exchangelib import Folder, HTMLBody, Body, Mailbox, DLMailbox, UID, ItemId, Version from exchangelib.fields import TextField from exchangelib.folders import RootOfHierarchy from exchangelib.indexed_properties import PhysicalAddress from exchangelib.items import Item, BulkCreateResult from exchangelib.properties import InvalidField, InvalidFieldForVersion, EWSElement, MessageHeader from exchangelib.util import to_xml, TNS from exchangelib.version import EXCHANGE_2010, EXCHANGE_2013 from .common import TimedTestCase class PropertiesTest(TimedTestCase): def test_unique_field_names(self): from exchangelib import attachments, properties, items, folders, indexed_properties, recurrence, settings for module in (attachments, properties, items, folders, indexed_properties, recurrence, settings): for cls in vars(module).values(): with self.subTest(cls=cls): if not isclass(cls) or not issubclass(cls, EWSElement): continue # Assert that all FIELDS names are unique on the model. Also assert that the class defines __slots__, # that all fields are mentioned in __slots__ and that __slots__ is unique. field_names = set() all_slots = tuple(chain(*(getattr(c, '__slots__', ()) for c in cls.__mro__))) self.assertEqual(len(all_slots), len(set(all_slots)), '__slots__ contains duplicates: %s' % sorted(all_slots)) for f in cls.FIELDS: with self.subTest(f=f): self.assertNotIn(f.name, field_names, 'Field name %r is not unique on model %r' % (f.name, cls.__name__)) self.assertIn(f.name, all_slots, 'Field name %s is not in __slots__ on model %s' % (f.name, cls.__name__)) field_names.add(f.name) # Finally, test that all models have a link to MSDN documentation if issubclass(cls, Folder): # We have a long list of folders subclasses. Don't require a docstring for each continue self.assertIsNotNone(cls.__doc__, '%s is missing a docstring' % cls) if cls in (DLMailbox, BulkCreateResult): # Some classes are just workarounds for other classes continue if cls.__doc__.startswith('Base class '): # Base classes don't have an MSDN link continue if issubclass(cls, RootOfHierarchy): # Root folders don't have an MSDN link continue # collapse multiline docstrings docstring = ' '.join(l.strip() for l in cls.__doc__.split('\n')) self.assertIn('MSDN: https://docs.microsoft.com', docstring, '%s is missing an MSDN link in the docstring' % cls) def test_uid(self): # Test translation of calendar UIDs. See #453 self.assertEqual( UID('261cbc18-1f65-5a0a-bd11-23b1e224cc2f'), b'\x04\x00\x00\x00\x82\x00\xe0\x00t\xc5\xb7\x10\x1a\x82\xe0\x08\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00' b'\x00\x00\x00\x00\x00\x00\x00\x00\x00\x001\x00\x00\x00vCal-Uid\x01\x00\x00\x00' b'261cbc18-1f65-5a0a-bd11-23b1e224cc2f\x00' ) def test_internet_message_headers(self): # Message headers are read-only, and an integration test is difficult because we can't reliably AND quickly # generate emails that pass through some relay server that adds headers. Create a unit test instead. payload = b'''\ from foo by bar Hello from DKIM 1.0 Contoso Mail foo@example.com ''' headers_elem = to_xml(payload).find('{%s}InternetMessageHeaders' % TNS) headers = {} for elem in headers_elem.findall('{%s}InternetMessageHeader' % TNS): header = MessageHeader.from_xml(elem=elem, account=None) headers[header.name] = header.value self.assertDictEqual( headers, { 'Received': 'from foo by bar', 'DKIM-Signature': 'Hello from DKIM', 'MIME-Version': '1.0', 'X-Mailer': 'Contoso Mail', 'Return-Path': 'foo@example.com', } ) def test_physical_address(self): # Test that we can enter an integer zipcode and that it's converted to a string by clean() zipcode = 98765 addr = PhysicalAddress(zipcode=zipcode) addr.clean() self.assertEqual(addr.zipcode, str(zipcode)) def test_invalid_kwargs(self): with self.assertRaises(AttributeError): Mailbox(foo='XXX') def test_invalid_field(self): test_field = Item.get_field_by_fieldname(fieldname='text_body') self.assertIsInstance(test_field, TextField) self.assertEqual(test_field.name, 'text_body') with self.assertRaises(InvalidField): Item.get_field_by_fieldname(fieldname='xxx') Item.validate_field(field=test_field, version=Version(build=EXCHANGE_2013)) with self.assertRaises(InvalidFieldForVersion) as e: Item.validate_field(field=test_field, version=Version(build=EXCHANGE_2010)) self.assertEqual( e.exception.args[0], "Field 'text_body' is not supported on server version Build=14.0.0.0, API=Exchange2010, Fullname=Microsoft " "Exchange Server 2010 (supported from: 15.0.0.0, deprecated from: None)" ) def test_add_field(self): field = TextField('foo', field_uri='bar') Item.add_field(field, insert_after='subject') try: self.assertEqual(Item.get_field_by_fieldname('foo'), field) finally: Item.remove_field(field) def test_itemid_equality(self): self.assertEqual(ItemId('X', 'Y'), ItemId('X', 'Y')) self.assertNotEqual(ItemId('X', 'Y'), ItemId('X', 'Z')) self.assertNotEqual(ItemId('Z', 'Y'), ItemId('X', 'Y')) self.assertNotEqual(ItemId('X', 'Y'), ItemId('Z', 'Z')) self.assertNotEqual(ItemId('X', 'Y'), None) def test_mailbox(self): mbx = Mailbox(name='XXX') with self.assertRaises(ValueError): mbx.clean() # Must have either item_id or email_address set mbx = Mailbox(email_address='XXX') self.assertEqual(hash(mbx), hash('xxx')) mbx.item_id = 'YYY' self.assertEqual(hash(mbx), hash('YYY')) # If we have an item_id, use that for uniqueness def test_body(self): # Test that string formatting a Body and HTMLBody instance works and keeps the type self.assertEqual(str(Body('foo')), 'foo') self.assertEqual(str(Body('%s') % 'foo'), 'foo') self.assertEqual(str(Body('{}').format('foo')), 'foo') self.assertIsInstance(Body('foo'), Body) self.assertIsInstance(Body('') + 'foo', Body) foo = Body('') foo += 'foo' self.assertIsInstance(foo, Body) self.assertIsInstance(Body('%s') % 'foo', Body) self.assertIsInstance(Body('{}').format('foo'), Body) self.assertEqual(str(HTMLBody('foo')), 'foo') self.assertEqual(str(HTMLBody('%s') % 'foo'), 'foo') self.assertEqual(str(HTMLBody('{}').format('foo')), 'foo') self.assertIsInstance(HTMLBody('foo'), HTMLBody) self.assertIsInstance(HTMLBody('') + 'foo', HTMLBody) foo = HTMLBody('') foo += 'foo' self.assertIsInstance(foo, HTMLBody) self.assertIsInstance(HTMLBody('%s') % 'foo', HTMLBody) self.assertIsInstance(HTMLBody('{}').format('foo'), HTMLBody) def test_invalid_attribute(self): # For a random EWSElement subclass, test that we cannot assign an unsupported attribute item = ItemId(id='xxx', changekey='yyy') with self.assertRaises(AttributeError) as e: item.invalid_attr = 123 self.assertEqual( e.exception.args[0], "'invalid_attr' is not a valid attribute. See ItemId.FIELDS for valid field names" )