Merge lp:~canonical-isd-hackers/ubuntu-webcatalog/extract_788199 into lp:ubuntu-webcatalog

[Danny Tamez]

Adding app description to the app install data command

Adding description to the import app data command by creating a local apt-cache and getting the app's description from the cache.

[lp:~canonical-isd-hackers/ubuntu-webcatalog/extract_788199]

17. By Danny Tamez on 2011-06-07

Small refactor so that the cache is only gotten once when the command is run.
Also added a bit of css for .description.

18. By Danny Tamez on 2011-06-07

Moving the white-space css to the <p> element instead of applying to all
of the description.

[Anthony Lenton (elachuni)]

review: Approve

=== modified file '.bzrignore'
--- .bzrignore	2011-04-13 09:28:55 +0000
+++ .bzrignore	2011-06-07 20:56:40 +0000
@@ -4,3 +4,5 @@
 django_project/local_settings.py
 django_project/static/
 django_project/media_root_dev/*
+.backup
+tags

=== modified file 'src/webcatalog/management/commands/import_app_install_data.py'
--- src/webcatalog/management/commands/import_app_install_data.py	2011-05-06 13:34:39 +0000
+++ src/webcatalog/management/commands/import_app_install_data.py	2011-06-07 20:56:40 +0000
@@ -28,9 +28,9 @@
 import urllib
 from glob import iglob
 from optparse import make_option
-from StringIO import StringIO
 
 import apt
+from apt.cache import FetchFailedException
 from apt_inst import DebFile
 from django.core.files.images import ImageFile
 from django.forms.models import construct_instance
@@ -47,6 +47,36 @@
     ]
 
 
+class Cache(object):
+
+    def __init__(self, distroseries):
+        self.distroseries = distroseries
+
+    def __enter__(self):
+        tmp_sources_dir = tempfile.mkdtemp()
+        self.tmp_sources_dir = tmp_sources_dir
+        os.makedirs(os.path.join(tmp_sources_dir, 'etc', 'apt'))
+        tmp_sources_list = os.path.join(
+            tmp_sources_dir, 'etc', 'apt', 'sources.list')
+        sources_list = open(tmp_sources_list, 'w+')
+        sources_list.write(
+            'deb http://archive.ubuntu.com/ubuntu {0} main\n'.format(
+                self.distroseries))
+        sources_list.close()
+
+        cache = apt.Cache(rootdir=tmp_sources_dir, memonly=True)
+        try:
+            cache.update(sources_list=tmp_sources_list)
+        except FetchFailedException:
+            # Make sure __exit__ still gets called
+            pass
+        cache.open()
+        return cache
+
+    def __exit__(self, exc_type, exc_value, exc_traceback):
+        shutil.rmtree(self.tmp_sources_dir)
+
+
 class Command(LabelCommand):
 
     help = "Update Application data from app-install-data package."
@@ -60,40 +90,43 @@
             )
     verbosity = 0
 
-    def handle_label(self, distroseries_name,  **options):
-        self.verbosity = int(options['verbosity'])
-        data_dir = tempfile.mkdtemp()
-        distroseries, created = DistroSeries.objects.get_or_create(
-            code_name=distroseries_name)
-        if created and self.verbosity > 0:
-            self.stdout.write(
-                "Created a DistroSeries record with codename '{0}'.".format(
-                    distroseries_name))
-
-        # Download app install data when requested.
-        if options['local_app_install_deb'] == '':
-            deb_location = self.get_latest_app_data_for_series(
-                distroseries_name, working_dir=data_dir)
-        else:
-            deb_location = options['local_app_install_deb']
-
-        # Extract and parse the deb archive.
-        deb_file = DebFile(deb_location)
-        if self.verbosity > 0:
-            self.stdout.write(
-                "Processing application data to update database...\n")
-        deb_file.data.extractall(data_dir)
-        matcher = data_dir + '/usr/share/app-install/desktop/*.desktop'
-        icon_dir = data_dir + '/usr/share/app-install/icons/'
-        for desktop_file in iglob(matcher):
-            self.process_desktop_file(desktop_file, icon_dir, distroseries)
-
-        shutil.rmtree(data_dir)
-
-    def get_latest_app_data_for_series(self, distroseries, working_dir):
+    def handle_label(self, distroseries_name, **options):
+        with Cache(distroseries_name) as cache:
+            self.verbosity = int(options['verbosity'])
+            data_dir = tempfile.mkdtemp()
+            distroseries, created = DistroSeries.objects.get_or_create(
+                code_name=distroseries_name)
+            if created and self.verbosity > 0:
+                self.stdout.write(
+                    "Created a DistroSeries record with codename '{0}'.".format(
+                        distroseries_name))
+
+            # Download app install data when requested.
+            if options['local_app_install_deb'] == '':
+                deb_location = self.get_latest_app_data_for_series(
+                    distroseries_name, data_dir, cache)
+            else:
+                deb_location = options['local_app_install_deb']
+
+            # Extract and parse the deb archive.
+            deb_file = DebFile(deb_location)
+            if self.verbosity > 0:
+                self.stdout.write(
+                    "Processing application data to update database...\n")
+            deb_file.data.extractall(data_dir)
+            matcher = data_dir + '/usr/share/app-install/desktop/*.desktop'
+            icon_dir = data_dir + '/usr/share/app-install/icons/'
+
+            for desktop_file in iglob(matcher):
+                self.process_desktop_file(desktop_file, icon_dir, distroseries,
+                                            cache)
+
+            shutil.rmtree(data_dir)
+
+    def get_latest_app_data_for_series(self, distroseries, working_dir, cache=None):
         # Write a temporary sources.list, update the cache and access:
         # cache['app-install-data-ubuntu'].candidate.uri
-        install_data_url = self.get_app_data_uri_for_series(distroseries)
+        install_data_url = self.get_app_data_uri_for_series(distroseries, cache)
         rest, sep, deb_filename = install_data_url.rpartition('/')
 
         if self.verbosity > 0:
@@ -106,34 +139,21 @@
             self.stdout.write("Done.\n")
         return deb_location
 
-    def get_app_data_uri_for_series(self, distroseries):
-        # Create a temporary apt cache to find the uri for the
-        # current version in the given series.
+    def get_app_data_uri_for_series(self, distroseries, cache=None):
         if self.verbosity > 0:
             self.stdout.write(
                 "Determining URI for current version of "
                 "app-install-data in {0}.\n".format(distroseries))
-
-        # First we create an appropriate temporary sources.list entry.
-        tmp_sources_dir = tempfile.mkdtemp()
-        os.makedirs(os.path.join(tmp_sources_dir, 'etc', 'apt'))
-        tmp_sources_list = os.path.join(
-            tmp_sources_dir, 'etc', 'apt', 'sources.list')
-        sources_list = open(tmp_sources_list, 'w+')
-        sources_list.write(
-            'deb http://archive.ubuntu.com/ubuntu {0} main\n'.format(
-                distroseries))
-        sources_list.close()
-
-        cache = apt.Cache(rootdir=tmp_sources_dir, memonly=True)
-        cache.update(sources_list=tmp_sources_list)
-        cache.open()
-        uri = cache['app-install-data'].candidate.uri
-
-        shutil.rmtree(tmp_sources_dir)
+        uri = None
+        if cache == None:
+            with Cache(distroseries) as cache:
+                uri = cache['app-install-data'].candidate.uri
+        else:
+            uri = cache['app-install-data'].candidate.uri
         return uri
 
-    def process_desktop_file(self, desktop_file_path, icon_dir, distroseries):
+    def process_desktop_file(self, desktop_file_path, icon_dir, distroseries,
+                             cache):
         with open(desktop_file_path, 'r') as desktop_file:
             data = desktop_file.read()
         form = ApplicationForm.get_form_from_desktop_data(data)
@@ -152,6 +172,14 @@
             else:
                 app = form.save(commit=False)
                 app.distroseries = distroseries
+            # we don't have the description - just the desktop data, so:
+            # use the package_name to lookup the app in the cache and get
+            # the descrption from there
+            try:
+                cached_app = cache[app.package_name]
+                app.description = cached_app.description
+            except KeyError:
+                pass
             app.save()
             app.update_departments()
             self.add_icon_to_app(app, icon_dir)
@@ -162,7 +190,8 @@
             if self.verbosity > 0:
                 self.stdout.write(
                     u"Skipping {0} as input failed validation: {1}.\n".format(
-                        member.name, form.errors).encode('utf-8'))
+                        form.cleaned_data['package_name'],
+                        form.errors).encode('utf-8'))
 
     def add_icon_to_app(self, app, icon_dir):
         # If the desktop file specifies an icon, we check for it in the

=== modified file 'src/webcatalog/static/css/webcatalog.css'
--- src/webcatalog/static/css/webcatalog.css	2011-05-06 15:03:41 +0000
+++ src/webcatalog/static/css/webcatalog.css	2011-06-07 20:56:40 +0000
@@ -38,7 +38,10 @@
     font-size: 14px;
     line-height: 1.3;
 }
-
+.description p {
+    white-space: pre-wrap;
+    font-size:14px;
+}
 .screenshot {
     float: right;
     margin-right: 16px;

=== modified file 'src/webcatalog/tests/test_commands.py'
--- src/webcatalog/tests/test_commands.py	2011-05-06 13:38:50 +0000
+++ src/webcatalog/tests/test_commands.py	2011-06-07 20:56:40 +0000
@@ -21,6 +21,7 @@
     absolute_import,
     with_statement,
     )
+from apt.cache import Cache
 import os
 import shutil
 import tempfile
@@ -54,7 +55,10 @@
             call_command('import_app_install_data', 'onion', verbosity=0)
 
         self.assertEqual(1, mock_get_data_fn.call_count)
-        self.assertEqual(('onion', ), mock_get_data_fn.call_args[0])
+        args = mock_get_data_fn.call_args[0]
+        self.assertEqual('onion', args[0])
+        self.assertTrue(args[1].startswith('/tmp/tmp'))
+        self.assertTrue(isinstance(args[2], Cache))
 
     def test_get_latest_app_data_for_series(self):
         # Requested and downloaded from the server.
@@ -72,7 +76,7 @@
             'http://example.com/my.deb', os.path.join(tmp_dir, 'my.deb'))
 
     def test_local_app_install_deb(self):
-        # We don't hit the network when provided a local app-install deb instead.
+        # We don't hit the network when provided a local app-install deb.
         with patch('urllib.urlretrieve') as mock_urlretrieve:
             call_command('import_app_install_data', 'natty',
                 local_app_install_deb=self.factory.get_test_path(
@@ -176,3 +180,37 @@
             uri = Command().get_app_data_uri_for_series('natty')
 
         self.assertEqual('http://example.com/my.deb', uri)
+
+    def test_description_added_to_app(self):
+        self.assertEqual(0, Application.objects.count())
+
+        call_command(
+            'import_app_install_data', 'natty',
+            local_app_install_deb=self.factory.get_test_path(
+                'app-install-data-test_all.deb'),
+            verbosity=0)
+
+        self.assertEqual(2, Application.objects.count())
+        firefox = Application.objects.get(package_name='firefox')
+        scribus = Application.objects.get(package_name='scribus')
+        firefox_description = 'Firefox delivers safe, easy web browsing.'
+        scribus_description = 'Scribus is an open source desktop page layout'
+        self.assertTrue(firefox.description.find(firefox_description) > -1)
+        self.assertTrue(scribus.description.find(scribus_description) > -1)
+
+    def test_descdription_updated_in_app(self):
+        app = self.factory.make_application(package_name='scribus',
+            distroseries=self.factory.make_distroseries(code_name='natty'))
+
+        call_command(
+            'import_app_install_data', 'natty',
+            local_app_install_deb=self.factory.get_test_path(
+                'app-install-data-test_all.deb'),
+            verbosity=0)
+
+        app_reloaded = Application.objects.get(id=app.id)
+        self.assertEqual(
+            'Graphic Page Layout and Publication (Stable)',
+            app_reloaded.comment)
+        scribus_description = 'Scribus is an open source desktop page layout'
+        self.assertTrue(app_reloaded.description.find(scribus_description) > -1)