Merge lp:~jml/pkgme/logging into lp:pkgme

[Jonathan Lange]

This is what happens when you go down a rabbit hole on a distracted day.

Very basic logging support, with tests.

[James Westby (james-w)]

review: Approve

=== modified file 'pkgme/tests/__init__.py'
--- pkgme/tests/__init__.py	2011-07-14 13:42:04 +0000
+++ pkgme/tests/__init__.py	2011-07-19 15:07:04 +0000
@@ -17,6 +17,7 @@
         'pkgme.tests.test_script',
         'pkgme.tests.test_template_file',
         'pkgme.tests.test_testing',
+        'pkgme.tests.test_trace',
         'pkgme.tests.test_vala_backend',
         'pkgme.tests.test_write',
         'pkgme.tests.test_write_packaging',

=== added file 'pkgme/tests/test_trace.py'
--- pkgme/tests/test_trace.py	1970-01-01 00:00:00 +0000
+++ pkgme/tests/test_trace.py	2011-07-19 15:07:04 +0000
@@ -0,0 +1,52 @@
+import os
+
+from fixtures import EnvironmentVariableFixture
+from testtools import TestCase
+from testtools.matchers import MatchesRegex
+
+from pkgme.testing import TempdirFixture
+from pkgme import trace
+
+
+_date_time_re = r'\d\d\d\d-\d\d-\d\d \d\d:\d\d:\d\d,\d\d\d'
+
+class TestLogging(TestCase):
+
+    def with_temp_home(self):
+        temp_dir = self.useFixture(TempdirFixture())
+        self.useFixture(EnvironmentVariableFixture('HOME', temp_dir.path))
+        return temp_dir
+
+    def with_temp_log(self):
+        self.useFixture(trace.LoggingFixture.get_default())
+
+    def test_log_location(self):
+        # We log to the XDG cache home.
+        temp_home = self.with_temp_home()
+        log_location = trace.get_log_location()
+        self.assertEqual(
+            os.path.join(temp_home.path, '.cache', 'pkgme', 'pkgme.log'),
+            log_location)
+
+    def test_log_to_file(self):
+        self.with_temp_log()
+        trace.log("message")
+        log_location = trace.get_log_location()
+        with open(log_location) as f:
+            log_contents = f.read()
+        self.assertThat(
+            log_contents,
+            MatchesRegex(r'%s - INFO - message\n' % (_date_time_re,)))
+
+    def test_log_twice(self):
+        self.with_temp_log()
+        trace.log("first")
+        trace.log("second")
+        log_location = trace.get_log_location()
+        with open(log_location) as f:
+            log_contents = f.read()
+        self.assertThat(
+            log_contents,
+            MatchesRegex(
+                r'%s - INFO - first\n%s - INFO - second\n' % (
+                    _date_time_re, _date_time_re)))

=== added file 'pkgme/trace.py'
--- pkgme/trace.py	1970-01-01 00:00:00 +0000
+++ pkgme/trace.py	2011-07-19 15:07:04 +0000
@@ -0,0 +1,58 @@
+import logging
+import os
+
+from fixtures import Fixture
+
+from pkgme.write import write_file
+
+
+def get_log_location():
+    """Return the path that we're logging to."""
+    return os.path.expanduser(
+        os.path.join('~', '.cache', 'pkgme', 'pkgme.log'))
+
+
+class LoggingFixture(Fixture):
+
+    def __init__(self, name, filename, level):
+        super(LoggingFixture, self).__init__()
+        self._name = name
+        self._filename = filename
+        self._level = level
+        self._logger = logging.getLogger(self._name)
+
+    def _make_handler(self):
+        # Make sure that the log file exists.
+        write_file(self._filename, '')
+        handler = logging.FileHandler(self._filename)
+        handler.setLevel(self._level)
+        formatter = logging.Formatter("%(asctime)s - %(levelname)s - %(message)s")
+        handler.setFormatter(formatter)
+        return handler
+
+    def setUp(self):
+        super(LoggingFixture, self).setUp()
+        handler = self._make_handler()
+        loggers = [self._logger, logging.getLogger('debpython')]
+        for logger in loggers:
+            self.addCleanup(
+                setattr, logger, 'handlers', list(logger.handlers))
+            self.addCleanup(logger.setLevel, logger.level)
+            logger.handlers = []
+            logger.addHandler(handler)
+            logger.setLevel(self._level)
+        return self._logger
+
+    @classmethod
+    def get_default(cls, level=logging.INFO):
+        return cls('pkgme', get_log_location(), level)
+
+
+_logger = logging.getLogger('pkgme')
+
+_logging_fixture = LoggingFixture.get_default()
+_logging_fixture.setUp()
+
+
+def log(message):
+    _logger.info(message)