Merge lp:~michael.nelson/ubuntu-webcatalog/form-for-import-data into lp:ubuntu-webcatalog

[Michael Nelson]

Overview
========

This branch adds the remaining fields which the USC client parses from the desktop files.

Most of these fields are parsed from the desktop files in app-install-data-ubuntu so that they can override the package values where appropriate.

I've also added simplified the importer by included a form for data validation, and ensured the form class can create instances based on the desktop file.

[lp:~michael.nelson/ubuntu-webcatalog/form-for-import-data]

10. By Michael Nelson on 2011-04-12

MimeType is not required, more helpful error when certain desktop files are ignored.

11. By Michael Nelson on 2011-04-12

Fixed the --local-app-install-deb option.

12. By Michael Nelson on 2011-04-12

Unicode strings when writing to stdout..

[Anthony Lenton (elachuni)]

review: Approve

=== added file 'src/webcatalog/forms.py'
--- src/webcatalog/forms.py	1970-01-01 00:00:00 +0000
+++ src/webcatalog/forms.py	2011-04-12 15:56:34 +0000
@@ -0,0 +1,66 @@
+#   -*- coding: utf-8 -*-
+#   This file is part of the Ubuntu Web Catalog
+#   Copyright (C) 2011 Canonical Ltd.
+#
+#   This program is free software: you can redistribute it and/or modify
+#   it under the terms of the GNU Affero General Public License as
+#   published by the Free Software Foundation, either version 3 of the
+#   License, or (at your option) any later version.
+#
+#   This program is distributed in the hope that it will be useful,
+#   but WITHOUT ANY WARRANTY; without even the implied warranty of
+#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#   GNU Affero General Public License for more details.
+#
+#   You should have received a copy of the GNU Affero General Public License
+#   along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""Forms used by the web catalog."""
+
+from __future__ import (
+    absolute_import,
+    with_statement,
+    )
+
+from ConfigParser import ConfigParser
+from StringIO import StringIO
+
+from django import forms
+
+from webcatalog.models import Application
+
+__metaclass__ = type
+__all__ = [
+    'ApplicationForm',
+    'desktop_field_mappings',
+    ]
+
+desktop_field_mappings = {
+    'x-appinstall-package': 'package_name',
+    'x-appinstall-popcon': 'popcon',
+    'x-appinstall-channel': 'channel',
+    'x-appinstall-screenshot-url': 'screenshot_url',
+    'x-appinstall-architectures': 'architectures',
+    'x-appinstall-keywords': 'keywords',
+    'x-appinstall-description': 'description',
+    'x-appinstall-section': 'section',
+    'type': 'app_type',
+    }
+
+
+class ApplicationForm(forms.ModelForm):
+
+    class Meta:
+        model = Application
+
+    @classmethod
+    def get_form_from_desktop_data(cls, str_data):
+        parser = ConfigParser()
+        parser.readfp(StringIO(str_data))
+        data = dict(parser.items('Desktop Entry'))
+        for desktop_key, app_key in desktop_field_mappings.items():
+            if data.has_key(desktop_key):
+                data[app_key] = data[desktop_key]
+                del(data[desktop_key])
+
+        return cls(data=data)

=== modified file 'src/webcatalog/management/commands/import_app_install_data.py'
--- src/webcatalog/management/commands/import_app_install_data.py	2011-04-11 14:08:41 +0000
+++ src/webcatalog/management/commands/import_app_install_data.py	2011-04-12 15:56:34 +0000
@@ -25,13 +25,11 @@
 import tempfile
 import urllib
 from apt_inst import DebFile
-from ConfigParser import ConfigParser
 from optparse import make_option
-from StringIO import StringIO
 
 from django.core.management.base import BaseCommand
 
-from webcatalog.models import Application
+from webcatalog.forms import ApplicationForm
 
 __metaclass__ = type
 __all__ = [
@@ -43,7 +41,7 @@
     help = "Update Application data from app-install-data package."
     option_list = BaseCommand.option_list + (
         make_option('--local-app-install-deb',
-            action='store_true',
+            action='store',
             dest='local_app_install_deb',
             default='',
             help=('Use a local app-install-data deb package rather than '
@@ -52,7 +50,6 @@
 
     def handle(self, *args, **options):
         self.verbosity = int(options['verbosity'])
-
         # Download app install data when requested.
         if options['local_app_install_deb'] == '':
             install_data_url = ("http://archive.ubuntu.com/"
@@ -60,7 +57,7 @@
                                 "app-install-data_0.11.04.7.1_all.deb")
             if self.verbosity > 0:
                 self.stdout.write(
-                    "Downloading app-install-data-ubuntu from {0}...".format(
+                    u"Downloading app-install-data-ubuntu from {0}...".format(
                         install_data_url))
             tmp_file = tempfile.NamedTemporaryFile()
             urllib.urlretrieve(install_data_url, tmp_file.name)
@@ -85,14 +82,15 @@
 
     def process_archive_member(self, member, data):
         if member.name.endswith('desktop'):
-            parser = ConfigParser()
-            parser.readfp(StringIO(data))
-            data = dict(parser.items('Desktop Entry'))
-            # TODO: Add a form and validate.
-            Application.objects.create(
-                package_name=data['x-appinstall-package'],
-                name=data['name'],
-                comment=data.get('comment', ''))
-            if self.verbosity > 0:
-                self.stdout.write(
-                    "{0} created.\n".format(data['x-appinstall-package']))
+            form = ApplicationForm.get_form_from_desktop_data(data)
+
+            if form.is_valid():
+                app = form.save()
+                if self.verbosity > 0:
+                    self.stdout.write(
+                        u"{0} created.\n".format(app.name))
+            else:
+                if self.verbosity > 0:
+                    self.stdout.write(
+                        u"Skipping {0} as input failed validation: {1}.\n".format(
+                            member.name, form.errors))

=== modified file 'src/webcatalog/models.py'
--- src/webcatalog/models.py	2011-04-08 12:25:25 +0000
+++ src/webcatalog/models.py	2011-04-12 15:56:34 +0000
@@ -39,27 +39,28 @@
     # The following fields are extracted from app-install-data.
     package_name = models.SlugField(max_length=100)
     name = models.CharField(max_length=255)
-    comment = models.CharField(max_length=255)
+    comment = models.CharField(max_length=255, blank=True)
+    popcon = models.IntegerField()
+    channel = models.CharField(max_length=255, blank=True)
+    screenshot_url = models.URLField(blank=True,
+        help_text="Only use this if it is other than the normal screenshot url.")
+    mimetype = models.CharField(max_length=255, blank=True)
+    architectures = models.CharField(max_length=255, blank=True)
+    keywords = models.CharField(max_length=255, blank=True)
+    app_type = models.CharField(max_length=32)
+    section = models.CharField(max_length=32)
+    categories = models.CharField(max_length=255)
+
     # Other desktop fields used by s-c
+    gnome_full_name = models.CharField(max_length=255, blank=True)
     # x-gnome-fullname
     # X-AppInstall-Ignore
-    # X-AppInstall-Package
-    # X-AppInstall-Section
-    # X-AppInstall-Channel
-    # X-AppInstall-Screenshot-Url
     # Icon
-    # Type
-    # X-AppInstall-Architectures
-    # X-AppInstall-Description
-    # X-AppInstall-Popcon
-    # Comment
-    # X-AppInstall-Keywords
-    # mime and categories too
 
     # The following fields will need to be imported from the apt-cache
     # (using python-apt - as above we'll need access to info from different
     # series etc.)
-    description = models.TextField()
+    description = models.TextField(blank=True)
 
     def __unicode__(self):
         return u"{0} ({1})".format(self.name, self.package_name)

=== modified file 'src/webcatalog/tests/__init__.py'
--- src/webcatalog/tests/__init__.py	2011-04-08 15:48:54 +0000
+++ src/webcatalog/tests/__init__.py	2011-04-12 15:56:34 +0000
@@ -16,5 +16,6 @@
 #   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 """Import various view, model and other tests for django's default runner."""
+from .test_forms import *
+from .test_commands import *
 from .test_views import *
-from .test_commands import *

=== modified file 'src/webcatalog/tests/factory.py'
--- src/webcatalog/tests/factory.py	2011-04-11 13:51:17 +0000
+++ src/webcatalog/tests/factory.py	2011-04-12 15:56:34 +0000
@@ -82,7 +82,7 @@
 
         return Application.objects.create(
             package_name=package_name, name=name, comment=comment,
-            description=description)
+            description=description, popcon=999)
 
     def get_test_path(self, file_name):
         return os.path.join(

=== added file 'src/webcatalog/tests/test_forms.py'
--- src/webcatalog/tests/test_forms.py	1970-01-01 00:00:00 +0000
+++ src/webcatalog/tests/test_forms.py	2011-04-12 15:56:34 +0000
@@ -0,0 +1,114 @@
+#   -*- coding: utf-8 -*-
+#   This file is part of the Ubuntu Web Catalog
+#   Copyright (C) 2011 Canonical Ltd.
+#
+#   This program is free software: you can redistribute it and/or modify
+#   it under the terms of the GNU Affero General Public License as
+#   published by the Free Software Foundation, either version 3 of the
+#   License, or (at your option) any later version.
+#
+#   This program is distributed in the hope that it will be useful,
+#   but WITHOUT ANY WARRANTY; without even the implied warranty of
+#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#   GNU Affero General Public License for more details.
+#
+#   You should have received a copy of the GNU Affero General Public License
+#   along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""Test cases for the web catalog forms."""
+
+from __future__ import (
+    absolute_import,
+    with_statement,
+    )
+
+from textwrap import dedent
+
+from webcatalog.forms import (
+    ApplicationForm,
+    desktop_field_mappings,
+    )
+from webcatalog.models import Application
+from webcatalog.tests.factory import TestCaseWithFactory
+
+__metaclass__ = type
+__all__ = [
+    'ApplicationFormTestCase',
+    ]
+
+
+class ApplicationFormTestCase(TestCaseWithFactory):
+
+    def get_desktop_data(self, overrides):
+        data = {
+            'Name': self.factory.get_unique_string(
+                prefix='App Name'),
+            'X-AppInstall-Package': self.factory.get_unique_string(
+                prefix='pkg_name'),
+            'X-AppInstall-Popcon': self.factory.get_unique_integer(),
+            'X-AppInstall-Section': self.factory.get_unique_string(
+                prefix='section'),
+            'Type': 'Application',
+            'Categories': 'cat1;cat2',
+            }
+        data.update(overrides)
+        return data
+
+    def get_desktop_entry(self, data):
+        desktop_entry_template = dedent("""
+            [Desktop Entry]
+            GenericName=Page Layout (Stable)
+            Terminal=false
+            Icon=scribus
+            X-StandardInstall=false
+            StartupWMClass=scribus
+            X-KDE-SubstituteUID=false
+            X-KDE-Username=
+
+            X-Ubuntu-Gettext-Domain=app-install-data""")
+        for key, value in data.items():
+            desktop_entry_template += "\n{key}={value}".format(
+                key=key, value=value)
+
+        desktop_data = desktop_entry_template.format(**data)
+
+        return desktop_data
+
+    def test_get_form_from_desktop_data(self):
+        data = {
+            'Name': 'My Package',
+            'X-AppInstall-Package': 'mypkg',
+            }
+        desktop_entry = self.get_desktop_entry(self.get_desktop_data(data))
+
+        form = ApplicationForm.get_form_from_desktop_data(desktop_entry)
+
+        self.assertTrue(form.is_valid())
+        self.assertEqual('My Package', form.cleaned_data['name'])
+        self.assertEqual('mypkg', form.cleaned_data['package_name'])
+
+    def test_extra_fields(self):
+        # There are a bunch of extra fields which are also supported by
+        # the model form.
+        extra_desktop_info = {
+            'X-AppInstall-Channel': 'channel-name',
+            'X-AppInstall-Section': 'section-name',
+            'X-AppInstall-Screenshot-Url': 'http://example.com/screenshot',
+            'Type': 'Application',
+            'X-AppInstall-Description': 'A description',
+            'X-AppInstall-Architectures': 'i386r;amd64',
+            'X-AppInstall-Popcon': 9876,
+            'X-AppInstall-Keywords': 'jazz,rock,country',
+            'Categories': 'Graphics;Jazz;Publishing',
+            'MimeType': 'application/vnd.scribus;text/javascript;'
+            }
+        desktop_entry = self.get_desktop_entry(self.get_desktop_data(
+            extra_desktop_info))
+
+        form = ApplicationForm.get_form_from_desktop_data(desktop_entry)
+
+        self.assertTrue(form.is_valid())
+        for key, value in extra_desktop_info.items():
+            form_key = desktop_field_mappings.get(key.lower(), key.lower())
+            self.assertEqual(
+                extra_desktop_info[key], form.cleaned_data[form_key])