# Copyright (c) 2007-2010 Simplistix Ltd
#
# This Software is released under the MIT License:
# http://www.opensource.org/licenses/mit-license.html
# See license.txt for more details.
# base stuff for all zconfig-based (ZConfig, Zope 2, Zope 3) based tests
import atexit
import logging
import os
import shutil
import unittest
from mailinglogger.common import RegexConversion
from mailinglogger.MailingLogger import MailingLogger
from mailinglogger.SummarisingLogger import SummarisingLogger
from testfixtures import TempDirectory
from shared import setUp as shared_setUp
from shared import tearDown as shared_tearDown
from tempfile import mkdtemp
try:
from ZConfig import loadSchema,loadConfig
except ImportError:
# we don't have a hard dependency on ZConfig
pass
from doctest import DocFileSuite, REPORT_NDIFF,ELLIPSIS
def setUp(test):
shared_setUp(test)
tempdir = test.globs['tempdir'] = TempDirectory()
tempdir.makedir('etc')
test.globs['os'] = os
test.globs['INSTANCE_HOME'] = tempdir.path
test.globs['startdir'] = os.getcwd()
os.chdir(tempdir.path)
def tearDown(test):
os.chdir(test.globs['startdir'])
shared_tearDown(test)
test.globs['tempdir'].cleanup()
class Tests(unittest.TestCase):
def setUp(self):
self.globs = {}
setUp(self)
self.schema = loadSchema(self.getSchemaPath())
def tearDown(self):
tearDown(self)
def _loadConfig(self,text):
f = open('test.conf','w')
f.write(self.getConfigPrefix())
f.write(text)
f.write(self.getConfigPostfix())
f.close()
config, handlers = loadConfig(self.schema, 'test.conf')
return config
def _checkHandler(self,h,
klass,
normal_format,
date_format,
**expected):
# class
self.failUnless(isinstance(h,klass))
# formatter
f = h.formatter
self.assertEqual(f._fmt,normal_format)
self.assertEqual(f.datefmt,date_format)
self.assertEqual(f.datefmt,date_format)
# ignore
ignore = expected.get('ignore')
if ignore:
self.assertEqual(len(h.ignore),len(ignore))
for i,regex in enumerate(h.ignore):
self.failUnless(isinstance(regex, RegexConversion))
self.assertEqual(regex._rx.pattern,ignore[i])
del expected['ignore']
else:
self.assertEqual(len(h.ignore),0)
# the rest
for name,value in expected.items():
self.assertEqual(getattr(h,name),value)
def _check(self,c,
logger_level,
handler_level,
klass,
normal_format,
date_format,
**expected):
logger = c.eventlog()
# logger
self.assertEqual(logger.level,logger_level)
self.assertEqual(len(logger.handlers),1)
self._checkHandler(
logger.handlers[0],
klass,
normal_format,
date_format,
level=handler_level,
**expected)
return logger
def test_all_keys_mailinglogger(self):
# load config
c = self._loadConfig('''
level info
dateformat %H:%M:%S on %Y-%m-%d
level warning
from logging@example.com
to receiver@example.com
to support@example.com
smtp-server mail.example.com
subject [MyApp] %(line)s
format %(levelname)s - %(message)s
send-empty-entries yes
flood-level 13
username username
password password
ignore ^MyError(.*)
ignore Foobar
foo bar
Baz bob
template %s
charset latin-1
content_type text/html
''')
# check resulting logger
self._check(c,
logger_level=logging.INFO,
handler_level=logging.WARNING,
klass=MailingLogger,
normal_format='%(levelname)s - %(message)s',
date_format='%H:%M:%S on %Y-%m-%d',
mailhost='mail.example.com',
mailport=25,
fromaddr='logging@example.com',
toaddrs=['receiver@example.com','support@example.com'],
subject='[MyApp] %(line)s',
send_empty_entries=True,
flood_level=13,
username='username',
password='password',
ignore=('^MyError(.*)','Foobar'),
headers={'foo':'bar','baz':'bob'},
template='%s',
charset='latin-1',
content_type='text/html'
)
def test_minimal_config_mailinglogger(self):
# load config
c = self._loadConfig('''
from logging@example.com
to support@example.com
''')
# check resulting logger
self._check(c,
logger_level=logging.INFO,
handler_level=0,
klass=MailingLogger,
normal_format='%(message)s',
date_format='%Y-%m-%dT%H:%M:%S',
mailhost='localhost',
mailport=25,
fromaddr='logging@example.com',
toaddrs=['support@example.com'],
subject='[%(hostname)s] %(levelname)s - %(line)s',
send_empty_entries=False,
flood_level=10,
username=None,
password=None,
ignore=[],
headers={},
template=None,
charset='utf-8',
content_type='text/plain'
)
def test_all_keys_summarisinglogger(self):
# load config
c = self._loadConfig('''
level info
dateformat %H:%M:%S on %Y-%m-%d
level warning
from logging@example.com
to receiver@example.com
to support@example.com
smtp-server mail.example.com
subject [MyApp] %(line)s
format %(levelname)s - %(message)s
send-empty-entries no
atexit no
username username
password password
ignore ^MyError(.*)
ignore Foobar
send_level error
foo bar
Baz bob
template %s
charset latin-1
content_type text/html
''')
# check resulting logger
l = self._check(c,
logger_level=logging.INFO,
handler_level=logging.WARNING,
klass=SummarisingLogger,
normal_format='%(levelname)s - %(message)s',
date_format='%H:%M:%S on %Y-%m-%d',
ignore=('^MyError(.*)','Foobar'),
send_level=logging.ERROR,
charset='latin-1'
)
# check mailer stored as attribure of summariser
self._checkHandler(l.handlers[0].mailer,
klass=MailingLogger,
# This format is hardcoded and means we send
# the whole of the summary
normal_format='%(message)s',
# We leave this as is, since it's never
# actuallly used.
date_format=None,
mailhost='mail.example.com',
mailport=25,
fromaddr='logging@example.com',
toaddrs=['receiver@example.com','support@example.com'],
subject='[MyApp] %(line)s',
send_empty_entries=False,
# flood level doesn't matter so is left as default.
# This mailer will only send one message.
flood_level=10,
username='username',
password='password',
ignore=[],
headers={'foo':'bar','baz':'bob'},
template='%s',
charset='latin-1',
content_type='text/html',
)
# Test the ignore setting, which should never be passed to the mailer
mailinglogger = l.handlers[0].mailer
self.assertEqual(len(mailinglogger.ignore), 0)
# check atexit
self.assertEqual(atexit._exithandlers,[])
def test_minimal_config_summarisinglogger(self):
# load config
c = self._loadConfig('''
from logging@example.com
to receiver@example.com
''')
# check resulting logger
l = self._check(c,
logger_level=logging.INFO,
handler_level=0,
klass=SummarisingLogger,
normal_format='%(asctime)s - %(levelname)s - %(message)s',
date_format='%Y-%m-%dT%H:%M:%S',
ignore=[],
send_level=logging.INFO,
charset='utf-8',
)
# check mailer stored as attribure of summariser
self._checkHandler(l.handlers[0].mailer,
klass=MailingLogger,
normal_format='%(message)s',
date_format=None,
mailhost='localhost',
mailport=25,
fromaddr='logging@example.com',
toaddrs=['receiver@example.com'],
subject='Summary of Log Messages',
send_empty_entries=True,
flood_level=10,
username=None,
password=None,
ignore=[],
headers={},
template=None,
charset='utf-8',
content_type='text/plain'
)
# check atexit
self.assertEqual(atexit._exithandlers,[(l.handlers[0].close,(),{})])
def test_port_in_mailhost(self):
# test for mailinglogger only as summarisinglogger uses the same code
# load config
c = self._loadConfig('''
from logging@example.com
to support@example.com
smtp-server localhost:2525
''')
# check resulting logger
self._check(c,
logger_level=logging.INFO,
handler_level=0,
klass=MailingLogger,
normal_format='%(message)s',
date_format='%Y-%m-%dT%H:%M:%S',
mailhost='localhost',
mailport=2525,
)