Merge lp:~facundo/magicicada-gui/apport into lp:magicicada-gui

[Facundo Batista]

Apport hook file (LP: #590921).

Apport hook file.

Code to install this file in "/usr/share/apport/package-hooks/" is not included in this branch, as this should not be done in setup.py, but in the Debian/Ubuntu specific code (see https://lists.ubuntu.com/archives/bazaar/2010q4/070514.html).

Tests included.

[Natalia Bidart (nataliabidart)]

Please remove the following comments:

#FIXME: test
# - que el fname log que attachea sea el correcto
# - que llame a attach_file_if_exists correctamente
# - que llame a attach_related_packages correctamente

review: Needs Fixing

[Natalia Bidart (nataliabidart)]

Also, it would be great if we can define the log filename in only one place (magicicada/logger.py).

review: Needs Fixing

[Facundo Batista (facundo)]

Removed the comments, and moved the filename creation responsibility to logger.py.

[Natalia Bidart (nataliabidart)]

The comments are still there, maybe you forgot a push?

93 +#FIXME: test
94 +# - que el fname log que attachea sea el correcto
95 +# - que llame a attach_file_if_exists correctamente
96 +# - que llame a attach_related_packages correctamente

review: Needs Fixing

[lp:~facundo/magicicada-gui/apport]

97. By Facundo Batista on 2011-07-31

Removed comment and moved the log filename responsibility.

[Natalia Bidart (nataliabidart)]

Great work.

review: Approve

=== modified file 'magicicada/logger.py'
--- magicicada/logger.py	2011-06-17 01:14:31 +0000
+++ magicicada/logger.py	2011-07-31 16:11:16 +0000
@@ -65,16 +65,21 @@
     logger.error("Unhandled exception!\n%s", msg)
 
 
-def set_up(cache_dir=None):
-    """Set up the logging."""
+def get_filename(cache_dir=None):
+    """Return the log file name."""
     if cache_dir is None:
         # choose the folder to store the logs
         cache_dir = xdg.BaseDirectory.xdg_cache_home
 
-    logfolder = os.path.join(cache_dir, 'magicicada')
+    return os.path.join(cache_dir, 'magicicada', 'magicicada.log')
+
+
+def set_up(cache_dir=None):
+    """Set up the logging."""
+    logfile = get_filename(cache_dir)
+    logfolder = os.path.dirname(logfile)
     if not os.path.exists(logfolder):
         os.makedirs(logfolder)
-    logfile = os.path.join(logfolder, 'magicicada.log')
 
     logger = logging.getLogger('magicicada')
     handler = CustomRotatingFH(logfile, maxBytes=1e6, backupCount=10)

=== added file 'magicicada/tests/test_apport.py'
--- magicicada/tests/test_apport.py	1970-01-01 00:00:00 +0000
+++ magicicada/tests/test_apport.py	2011-07-31 16:11:16 +0000
@@ -0,0 +1,49 @@
+#
+# Author: Facundo Batista <[e-mail]>
+#
+# Copyright 2010-2011 Chicharreros
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 3, as published
+# by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranties of
+# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+# PURPOSE.  See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""Tests Apport integration."""
+
+from twisted.trial.unittest import TestCase
+
+import source_magicicada
+
+from magicicada import logger
+
+
+class ApportTestCase(TestCase):
+    """Test the Apport usage."""
+
+    def test_attach_log_file(self):
+        """Attach the log file."""
+        called = []
+        self.patch(source_magicicada, 'attach_file_if_exists',
+                   lambda *a: called.extend(a))
+        d = {}
+        source_magicicada.add_info(d)
+        self.assertIs(called[0], d)
+        self.assertEqual(called[1], logger.get_filename())
+        self.assertEqual(called[2], 'MagicicadaLog')
+
+    def test_attach_package_info_u1client(self):
+        """Attach the package information for ubuntuone-client."""
+        called = []
+        self.patch(source_magicicada, 'attach_related_packages',
+                   lambda *a: called.extend(a))
+        d = {}
+        source_magicicada.add_info(d)
+        self.assertIs(called[0], d)
+        self.assertEqual(called[1], ['ubuntuone-client'])

=== modified file 'magicicada/tests/test_logger.py'
--- magicicada/tests/test_logger.py	2011-06-17 01:14:31 +0000
+++ magicicada/tests/test_logger.py	2011-07-31 16:11:16 +0000
@@ -20,19 +20,35 @@
 
 import cStringIO
 import logging
+import os
 import sys
 import unittest
 
 from twisted.python import log, failure
 from ubuntuone.devtools.handlers import MementoHandler
+from xdg.BaseDirectory import xdg_cache_home
 
-from magicicada.logger import exception_handler, deferror_handler
+from magicicada.logger import exception_handler, deferror_handler, get_filename
 
 
 # It's ok to access private data in the test suite
 # pylint: disable=W0212
 
 
+class SimpleTestCase(unittest.TestCase):
+    """Several simple tests for the logger module."""
+
+    def test_log_fname_default(self):
+        """The log filename by default."""
+        fname = os.path.join(xdg_cache_home, 'magicicada', 'magicicada.log')
+        self.assertEqual(get_filename(), fname)
+
+    def test_log_fname_basedir(self):
+        """The log filename using other base dir."""
+        fname = os.path.join('tmp', 'magicicada', 'magicicada.log')
+        self.assertEqual(get_filename(cache_dir='tmp'), fname)
+
+
 class ExceptionTests(unittest.TestCase):
     """Test that we log on unhandled exceptions."""
 

=== added file 'source_magicicada.py'
--- source_magicicada.py	1970-01-01 00:00:00 +0000
+++ source_magicicada.py	2011-07-31 16:11:16 +0000
@@ -0,0 +1,33 @@
+# source_magicicada.py
+#
+# Author: Facundo Batista <[e-mail]>
+#
+# Copyright 2010-2011 Chicharreros
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 3, as published
+# by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranties of
+# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+# PURPOSE.  See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""Configuration file for Apport."""
+
+from apport.hookutils import attach_related_packages, attach_file_if_exists
+
+from magicicada import logger
+
+
+def add_info(report):
+    """Add info to the report."""
+    # attach the log
+    fname = logger.get_filename()
+    attach_file_if_exists(report, fname, "MagicicadaLog")
+
+    # which ubuntuone-client package version is installed
+    attach_related_packages(report, ["ubuntuone-client"])