Merge lp:~jml/pkgme-devportal/use-description into lp:pkgme-devportal

[Jonathan Lange]

Actually use the 'description' field from metadata to set the package description.

Simple branch to use the description field from the metadata.

Factors out a matcher to help with tests.

[James Westby (james-w)]

Hi,

Here's the things we spoke about on the phone:

17 + with open(METADATA_FILE) as f:
18 + metadata = json.load(f)
19 + print metadata[DESCRIPTION]

There should be a helper method to do that in devportalbinary.binary as it's repeated a lot.

Also, this should be the same for the pdf backend, which you added a card for.

The description needs specific formatting, but that should be done in pkgme.

135 -from sqlite3 import IntegrityError
136 +from pysqlite2.dbapi2 import IntegrityError

That doesn't work on my oneiric install, so I think we'll need at least try_import or similar.
However, sqlite3 is shipped in the python2.7 package here, so I'm not sure why you don't
have it on precise.

I think that only the last is a blocker.

Thanks,

James

review: Needs Fixing

[Jonathan Lange (jml)]

On Mon, Dec 19, 2011 at 7:51 PM, James Westby <email address hidden> wrote:
> Review: Needs Fixing
>
> Hi,
>
> Here's the things we spoke about on the phone:
>
> 17      + with open(METADATA_FILE) as f:
> 18      + metadata = json.load(f)
> 19      + print metadata[DESCRIPTION]
>
> There should be a helper method to do that in devportalbinary.binary as it's repeated a lot.
>
> Also, this should be the same for the pdf backend, which you added a card for.
>

I've added the helper method and made both backends use it. The card
can be for reducing the amount of shared code between the backends
now.

> The description needs specific formatting, but that should be done in pkgme.
>

Check.

> 135     -from sqlite3 import IntegrityError
> 136     +from pysqlite2.dbapi2 import IntegrityError
>
> That doesn't work on my oneiric install, so I think we'll need at least try_import or similar.
> However, sqlite3 is shipped in the python2.7 package here, so I'm not sure why you don't
> have it on precise.
>

It's not an import problem on precise. I have sqlite3. The problem is
that the IntegrityError raised by Storm is a different integrity error
on precise. Will find some sort of compatibility work-around.

> I think that only the last is a blocker.
>

Thanks,
jml

[James Westby (james-w)]

Looks great, thanks for the bonus clean-ups.

review: Approve

[Canonical CA Tarmac (ca-tarmac)]

The attempt to merge lp:~jml/pkgme-binary/use-description into lp:pkgme-binary failed. Below is the output from the failed tests.

Tests running...

Ran 68 tests in 10.906s
OK
Tests running...
======================================================================
ERROR: acceptance.tests.AcceptanceTests.test_gtk
----------------------------------------------------------------------
Traceback (most recent call last):
  File "acceptance/tests/__init__.py", line 57, in test_gtk
    self.run_pkgme(test_data)
  File "acceptance/tests/__init__.py", line 39, in run_pkgme
    test_data.path, allowed_backend_names=["binary"])
  File "/tmp/tmp4KAwG0/pkgme/pkgme/__init__.py", line 45, in write_packaging
    files = default_package_file_group.get_files(info)
  File "/tmp/tmp4KAwG0/pkgme/pkgme/package_files.py", line 93, in get_files
    values = project_info.get_all(keys)
  File "/tmp/tmp4KAwG0/pkgme/pkgme/project_info.py", line 90, in get_all
    values[key] = self._get(key)
  File "/tmp/tmp4KAwG0/pkgme/pkgme/project_info.py", line 79, in _get
    out = run_script(self.basepath, key, self.cwd)
  File "/tmp/tmp4KAwG0/pkgme/pkgme/run_script.py", line 100, in run_script
    output = run_subprocess([script_path], cwd=cwd, env=env, to_write=to_write)
  File "/tmp/tmp4KAwG0/pkgme/pkgme/run_script.py", line 84, in run_subprocess
    raise ScriptFailed(cmd, retcode, output)
ScriptFailed: /tmp/tmp4KAwG0/devportalbinary/backends/binary/description failed with returncode 1. Output:
 | Traceback (most recent call last):
 | File "/tmp/tmp4KAwG0/devportalbinary/backends/binary/description", line 17, in <module>
 | main()
 | File "/tmp/tmp4KAwG0/devportalbinary/backends/binary/description", line 13, in main
 | print get_metadata(DESCRIPTION)
 | File "/tmp/tmp4KAwG0/devportalbinary/binary.py", line 141, in get_metadata
 | return metadata[field_name]
 | KeyError: 'description'

Ran 3 tests in 3.053s
FAILED (failures=1)

Branched 93 revision(s).
/tmp/tmp4KAwG0/virtualenv/lib/python2.6/site-packages/distribute-0.6.10-py2.6.egg/setuptools/command/bdist_egg.py:422: UnicodeWarning: Unicode equal comparison failed to convert both arguments to Unicode - interpreting them as being unequal
  symbols = dict.fromkeys(iter_symbols(code))
bzrlib/_readdir_pyx.c: In function '__pyx_f_6bzrlib_12_readdir_pyx__read_dir':
bzrlib/_readdir_pyx.c:992: warning: '__pyx_exc_lineno' may be used uninitialized in this function
bzrlib/_readdir_pyx.c:1035: warning: '__pyx_exc_lineno' may be used uninitialized in this function
bzrlib/_chk_map_pyx.c: In function '__pyx_f_6bzrlib_12_chk_map_pyx_safe_interned_string_from_size':
bzrlib/_chk_map_pyx.c:282: warning: cast from pointer to integer of different size
In file included from /usr/include/python2.6/Python.h:8,
                 from bzrlib/_patiencediff_c.c:28:
/usr/include/python2.6/pyconfig.h:1031:1: warning: "_POSIX_C_SOURCE" redefined
In file included from /usr/include/stdlib.h:25,
                 from bzrlib/_patiencediff_c.c:26:
/usr/include/features.h:210:1: warning: this is the location of the previous definition
bzrlib/_btree_serializer_pyx.c: In function '__pyx_f_6bzrlib_21_btree_serializer_pyx_safe_string_from_size':
bzr...

[Canonical CA Tarmac (ca-tarmac)]

The attempt to merge lp:~jml/pkgme-binary/use-description into lp:pkgme-binary failed. Below is the output from the failed tests.

Tests running...

Ran 68 tests in 6.038s
OK
Tests running...
======================================================================
ERROR: acceptance.tests.AcceptanceTests.test_gtk
----------------------------------------------------------------------
Traceback (most recent call last):
  File "acceptance/tests/__init__.py", line 57, in test_gtk
    self.run_pkgme(test_data)
  File "acceptance/tests/__init__.py", line 39, in run_pkgme
    test_data.path, allowed_backend_names=["binary"])
  File "/tmp/tmp9jChdC/pkgme/pkgme/__init__.py", line 45, in write_packaging
    files = default_package_file_group.get_files(info)
  File "/tmp/tmp9jChdC/pkgme/pkgme/package_files.py", line 93, in get_files
    values = project_info.get_all(keys)
  File "/tmp/tmp9jChdC/pkgme/pkgme/project_info.py", line 90, in get_all
    values[key] = self._get(key)
  File "/tmp/tmp9jChdC/pkgme/pkgme/project_info.py", line 79, in _get
    out = run_script(self.basepath, key, self.cwd)
  File "/tmp/tmp9jChdC/pkgme/pkgme/run_script.py", line 100, in run_script
    output = run_subprocess([script_path], cwd=cwd, env=env, to_write=to_write)
  File "/tmp/tmp9jChdC/pkgme/pkgme/run_script.py", line 84, in run_subprocess
    raise ScriptFailed(cmd, retcode, output)
ScriptFailed: /tmp/tmp9jChdC/devportalbinary/backends/binary/description failed with returncode 1. Output:
 | Traceback (most recent call last):
 | File "/tmp/tmp9jChdC/devportalbinary/backends/binary/description", line 17, in <module>
 | main()
 | File "/tmp/tmp9jChdC/devportalbinary/backends/binary/description", line 13, in main
 | print get_metadata(DESCRIPTION)
 | File "/tmp/tmp9jChdC/devportalbinary/binary.py", line 141, in get_metadata
 | return metadata[field_name]
 | KeyError: 'description'

Ran 3 tests in 3.862s
FAILED (failures=1)

Branched 93 revision(s).
/tmp/tmp9jChdC/virtualenv/lib/python2.6/site-packages/distribute-0.6.10-py2.6.egg/setuptools/command/bdist_egg.py:422: UnicodeWarning: Unicode equal comparison failed to convert both arguments to Unicode - interpreting them as being unequal
  symbols = dict.fromkeys(iter_symbols(code))
bzrlib/_readdir_pyx.c: In function '__pyx_f_6bzrlib_12_readdir_pyx__read_dir':
bzrlib/_readdir_pyx.c:992: warning: '__pyx_exc_lineno' may be used uninitialized in this function
bzrlib/_readdir_pyx.c:1035: warning: '__pyx_exc_lineno' may be used uninitialized in this function
bzrlib/_chk_map_pyx.c: In function '__pyx_f_6bzrlib_12_chk_map_pyx_safe_interned_string_from_size':
bzrlib/_chk_map_pyx.c:282: warning: cast from pointer to integer of different size
In file included from /usr/include/python2.6/Python.h:8,
                 from bzrlib/_patiencediff_c.c:28:
/usr/include/python2.6/pyconfig.h:1031:1: warning: "_POSIX_C_SOURCE" redefined
In file included from /usr/include/stdlib.h:25,
                 from bzrlib/_patiencediff_c.c:26:
/usr/include/features.h:210:1: warning: this is the location of the previous definition
bzrlib/_btree_serializer_pyx.c: In function '__pyx_f_6bzrlib_21_btree_serializer_pyx_safe_string_from_size':
bzrl...

[Canonical CA Tarmac (ca-tarmac)]

The attempt to merge lp:~jml/pkgme-binary/use-description into lp:pkgme-binary failed. Below is the output from the failed tests.

Tests running...

Ran 71 tests in 6.028s
OK
Tests running...
======================================================================
ERROR: acceptance.tests.AcceptanceTests.test_gtk
----------------------------------------------------------------------
Traceback (most recent call last):
  File "acceptance/tests/__init__.py", line 57, in test_gtk
    self.run_pkgme(test_data)
  File "acceptance/tests/__init__.py", line 39, in run_pkgme
    test_data.path, allowed_backend_names=["binary"])
  File "/tmp/tmp7fjXSx/pkgme/pkgme/__init__.py", line 45, in write_packaging
    files = default_package_file_group.get_files(info)
  File "/tmp/tmp7fjXSx/pkgme/pkgme/package_files.py", line 93, in get_files
    values = project_info.get_all(keys)
  File "/tmp/tmp7fjXSx/pkgme/pkgme/project_info.py", line 90, in get_all
    values[key] = self._get(key)
  File "/tmp/tmp7fjXSx/pkgme/pkgme/project_info.py", line 79, in _get
    out = run_script(self.basepath, key, self.cwd)
  File "/tmp/tmp7fjXSx/pkgme/pkgme/run_script.py", line 100, in run_script
    output = run_subprocess([script_path], cwd=cwd, env=env, to_write=to_write)
  File "/tmp/tmp7fjXSx/pkgme/pkgme/run_script.py", line 84, in run_subprocess
    raise ScriptFailed(cmd, retcode, output)
ScriptFailed: /tmp/tmp7fjXSx/devportalbinary/backends/binary/extra_files failed with returncode 1. Output:
 | Traceback (most recent call last):
 | File "/tmp/tmp7fjXSx/devportalbinary/backends/binary/extra_files", line 37, in <module>
 | main()
 | File "/tmp/tmp7fjXSx/devportalbinary/backends/binary/extra_files", line 20, in main
 | metadata = get_metadata()
 | File "/tmp/tmp7fjXSx/devportalbinary/binary.py", line 141, in get_metadata
 | metadata = json.load(f)
 | File "/usr/lib/python2.6/json/__init__.py", line 267, in load
 | parse_constant=parse_constant, **kw)
 | File "/usr/lib/python2.6/json/__init__.py", line 307, in loads
 | return _default_decoder.decode(s)
 | File "/usr/lib/python2.6/json/decoder.py", line 319, in decode
 | obj, end = self.raw_decode(s, idx=_w(s, 0).end())
 | File "/usr/lib/python2.6/json/decoder.py", line 336, in raw_decode
 | obj, end = self._scanner.iterscan(s, **kw).next()
 | File "/usr/lib/python2.6/json/scanner.py", line 55, in iterscan
 | rval, next_pos = action(m, context)
 | File "/usr/lib/python2.6/json/decoder.py", line 193, in JSONObject
 | raise ValueError(errmsg("Expecting , delimiter", s, end - 1))
 | ValueError: Expecting , delimiter: line 3 column 5 (char 32)

Ran 3 tests in 3.777s
FAILED (failures=1)

Branched 93 revision(s).
/tmp/tmp7fjXSx/virtualenv/lib/python2.6/site-packages/distribute-0.6.10-py2.6.egg/setuptools/command/bdist_egg.py:422: UnicodeWarning: Unicode equal comparison failed to convert both arguments to Unicode - interpreting them as being unequal
  symbols = dict.fromkeys(iter_symbols(code))
bzrlib/_readdir_pyx.c: In function '__pyx_f_6bzrlib_12_readdir_pyx__read_dir':
bzrlib/_readdir_pyx.c:992: warning: '__pyx_exc_lineno' may be used uninitialized in this function
bzrlib/_readdir...

[Canonical CA Tarmac (ca-tarmac)]

There are additional revisions which have not been approved in review. Please seek review and approval of these new revisions.

=== modified file 'acceptance/data/gtk/devportal-metadata.json'
--- acceptance/data/gtk/devportal-metadata.json	2011-11-15 17:27:30 +0000
+++ acceptance/data/gtk/devportal-metadata.json	2011-12-20 19:38:24 +0000
@@ -1,3 +1,4 @@
 {
-    "package_name": "gtk"
+    "package_name": "gtk",
+    "description": "A trivial GTK+ program"
 }

=== added file 'devportalbinary/backends/binary/description'
--- devportalbinary/backends/binary/description	1970-01-01 00:00:00 +0000
+++ devportalbinary/backends/binary/description	2011-12-20 19:38:24 +0000
@@ -0,0 +1,19 @@
+#!/usr/bin/env python
+# Copyright 2011 Canonical Ltd.  This software is licensed under the
+# GNU Affero General Public License version 3 (see the file LICENSE).
+
+import json
+from devportalbinary.binary import (
+    DESCRIPTION,
+    get_metadata,
+    )
+
+
+def main():
+    description = get_metadata(DESCRIPTION, None)
+    if description:
+        print description
+
+
+if __name__ == '__main__':
+    main()

=== modified file 'devportalbinary/backends/binary/extra_files'
--- devportalbinary/backends/binary/extra_files	2011-12-05 22:20:24 +0000
+++ devportalbinary/backends/binary/extra_files	2011-12-20 19:38:24 +0000
@@ -10,15 +10,14 @@
     CATEGORIES,
     get_binary_desktop_file,
     get_install_file,
-    METADATA_FILE,
+    get_metadata,
     PACKAGE_NAME,
     TAGLINE,
     )
 
 
 def main():
-    with open(METADATA_FILE) as f:
-        metadata = json.load(f)
+    metadata = get_metadata()
     package_name = metadata[PACKAGE_NAME]
     path = os.getcwd()
     install_file = get_install_file(package_name, path, True)

=== modified file 'devportalbinary/backends/binary/package_name'
--- devportalbinary/backends/binary/package_name	2011-11-21 16:16:36 +0000
+++ devportalbinary/backends/binary/package_name	2011-12-20 19:38:24 +0000
@@ -4,15 +4,13 @@
 
 import json
 from devportalbinary.binary import (
-    METADATA_FILE,
+    get_metadata,
     PACKAGE_NAME,
     )
 
 
 def main():
-    with open(METADATA_FILE) as f:
-        metadata = json.load(f)
-    print metadata[PACKAGE_NAME]
+    print get_metadata(PACKAGE_NAME)
 
 
 if __name__ == '__main__':

=== modified file 'devportalbinary/backends/pdf/depends'
--- devportalbinary/backends/pdf/depends	2011-12-05 22:20:24 +0000
+++ devportalbinary/backends/pdf/depends	2011-12-20 19:38:24 +0000
@@ -2,8 +2,6 @@
 # Copyright 2011 Canonical Ltd.  This software is licensed under the
 # GNU Affero General Public License version 3 (see the file LICENSE).
 
-from devportalbinary.binary import DEPENDS
-
 
 def main():
     print 'xdg-utils, ${misc:Depends}'

=== modified file 'devportalbinary/backends/pdf/description'
--- devportalbinary/backends/pdf/description	2011-12-13 04:23:22 +0000
+++ devportalbinary/backends/pdf/description	2011-12-20 19:38:24 +0000
@@ -4,16 +4,13 @@
 
 import json
 from devportalbinary.binary import (
-    METADATA_FILE,
+    get_metadata,
     TAGLINE
     )
 
 
 def main():
-    with open(METADATA_FILE) as f:
-        metadata = json.load(f)
-    description = metadata[TAGLINE]
-    print description
+    print get_metadata(TAGLINE)
     # Not included in metadata yet.
     #long_description = metadata["description"]
     #lines = long_description.split("\n")

=== modified file 'devportalbinary/backends/pdf/extra_files'
--- devportalbinary/backends/pdf/extra_files	2011-12-13 04:23:22 +0000
+++ devportalbinary/backends/pdf/extra_files	2011-12-20 19:38:24 +0000
@@ -10,15 +10,14 @@
     CATEGORIES,
     get_pdf_desktop_file,
     get_install_file,
-    METADATA_FILE,
+    get_metadata,
     PACKAGE_NAME,
     TAGLINE,
     )
 
 
 def main():
-    with open(METADATA_FILE) as f:
-        metadata = json.load(f)
+    metadata = get_metadata()
     package_name = metadata[PACKAGE_NAME]
     path = os.getcwd()
     install_file = get_install_file(package_name, path, True)

=== modified file 'devportalbinary/backends/pdf/package_name'
--- devportalbinary/backends/pdf/package_name	2011-12-05 22:20:24 +0000
+++ devportalbinary/backends/pdf/package_name	2011-12-20 19:38:24 +0000
@@ -4,15 +4,13 @@
 
 import json
 from devportalbinary.binary import (
-    METADATA_FILE,
+    get_metadata,
     PACKAGE_NAME,
     )
 
 
 def main():
-    with open(METADATA_FILE) as f:
-        metadata = json.load(f)
-    print metadata[PACKAGE_NAME]
+    print get_metadata(PACKAGE_NAME)
 
 
 if __name__ == '__main__':

=== modified file 'devportalbinary/binary.py'
--- devportalbinary/binary.py	2011-12-13 12:53:41 +0000
+++ devportalbinary/binary.py	2011-12-20 19:38:24 +0000
@@ -38,6 +38,7 @@
    ]
 
 
+import json
 import os
 import subprocess
 
@@ -61,8 +62,10 @@
 
 METADATA_FILE = 'devportal-metadata.json'
 
+# XXX: These duplicate the schema found in pkgme-service.
 # Keys found in the metadata file.
 CATEGORIES = 'categories'
+DESCRIPTION = 'description'
 # It's called package_name in the database, so this probably makes sense.
 PACKAGE_NAME = 'package_name'
 TAGLINE = 'tagline'
@@ -122,6 +125,28 @@
                 yield os.path.relpath(file_path, path)
 
 
+_no_field = object()
+def get_metadata(field_name=None, default=_no_field, path=METADATA_FILE):
+    """Return the value of ``field_name`` in metadata.
+
+    :param field_name: The field to look up.  If None, then return all the
+        metadata as a dict.
+    :param default: If provided, then this value will be returned if
+        'field_name' is not present in the metadata.
+    :param path: The path to the metadata file, if unspecified, look for
+        METADATA_FILE in the current working directory.
+    :return: The value of the field.
+    """
+    with open(path) as f:
+        metadata = json.load(f)
+    if field_name is None:
+        return metadata
+    value = metadata.get(field_name, default)
+    if value is _no_field:
+        raise KeyError(field_name)
+    return value
+
+
 def get_install_file(package_name, path, include_desktop=False):
     """Generate the install file for 'package_name'."""
     lines = []

=== modified file 'devportalbinary/testing.py'
--- devportalbinary/testing.py	2011-12-05 20:53:13 +0000
+++ devportalbinary/testing.py	2011-12-20 19:38:24 +0000
@@ -1,3 +1,4 @@
+import json
 import os
 
 from fixtures import (
@@ -6,6 +7,9 @@
     TempDir,
     )
 
+from pkgme.testing import TempdirFixture
+
+from devportalbinary.binary import METADATA_FILE
 from devportalbinary.database import PackageDatabase
 
 
@@ -42,3 +46,27 @@
         tempdir = self.useFixture(TempDir())
         self.path = tempdir.path
         self.useFixture(EnvironmentVariableFixture("HOME", self.path))
+
+
+class MetadataFixture(Fixture):
+    """Create a metadata file to use.
+
+    :ivar tempdir: The ``TempdirFixture`` used to create the temporary
+        directory.
+    :ivar path: The path to the directory containing the metadata file.
+    """
+
+    def __init__(self, metadata):
+        """Create a ``MetadataFixture``.
+
+        :param metadata: A dict of metadata.
+        """
+        self._metadata = metadata
+
+    def setUp(self):
+        super(MetadataFixture, self).setUp()
+        self.tempdir = self.useFixture(TempdirFixture())
+        self.path = self.tempdir.path
+        self.metadata_path = os.path.join(self.path, METADATA_FILE)
+        with open(self.metadata_path, 'w') as fp:
+            json.dump(self._metadata, fp)

=== modified file 'devportalbinary/tests/test_binary.py'
--- devportalbinary/tests/test_binary.py	2011-12-13 12:53:41 +0000
+++ devportalbinary/tests/test_binary.py	2011-12-20 19:38:24 +0000
@@ -17,6 +17,7 @@
     get_file_type,
     get_file_types,
     get_install_file,
+    get_metadata,
     get_pdf_desktop_file,
     get_shared_library_dependencies,
     guess_dependencies,
@@ -27,14 +28,68 @@
     needed_libraries_from_objdump,
     NoBinariesFound,
     )
-from devportalbinary.testing import DatabaseFixture
-
-
-class BinaryTests(TestCase):
+from devportalbinary.testing import (
+    DatabaseFixture,
+    MetadataFixture,
+    )
+
+
+class MetadataTests(TestCase):
 
     def test_metadata_file(self):
         self.assertEqual('devportal-metadata.json', METADATA_FILE)
 
+    def test_get_metadata_field_present(self):
+        # get_metadata returns the metadata value of the requested field.
+        metadata = {
+            'foo': self.getUniqueString(),
+            'bar': self.getUniqueInteger(),
+            }
+        path = self.useFixture(MetadataFixture(metadata)).metadata_path
+        foo = get_metadata('foo', path=path)
+        self.assertEqual(metadata['foo'], foo)
+
+    def test_get_metadata_default_file(self):
+        # By default, get_metadata looks for the METADATA_FILE in the current
+        # working directory.
+        metadata = {
+            'foo': self.getUniqueString(),
+            'bar': self.getUniqueInteger(),
+            }
+        path = self.useFixture(MetadataFixture(metadata)).path
+        self.addCleanup(os.chdir, os.getcwd())
+        os.chdir(path)
+        foo = get_metadata('foo')
+        self.assertEqual(metadata['foo'], foo)
+
+    def test_get_metadata_field_not_present_default_provided(self):
+        # get_metadata returns the provided default value if the field is not
+        # present in the metadata.
+        metadata = {}
+        path = self.useFixture(MetadataFixture(metadata)).metadata_path
+        default = object()
+        foo = get_metadata('foo', default, path=path)
+        self.assertIs(default, foo)
+
+    def test_get_metadata_field_not_present_no_default(self):
+        # get_metadata raises an exception if the field isn't there and no
+        # default was provided.
+        metadata = {}
+        field = self.getUniqueString()
+        path = self.useFixture(MetadataFixture(metadata)).metadata_path
+        e = self.assertRaises(KeyError, get_metadata, field, path=path)
+        self.assertEqual(repr(field), str(e))
+
+    def test_get_metadata_all_fields(self):
+        # get_metadata returns the metadata value of the requested field.
+        metadata = {
+            'foo': self.getUniqueString(),
+            'bar': self.getUniqueInteger(),
+            }
+        path = self.useFixture(MetadataFixture(metadata)).metadata_path
+        found_metadata = get_metadata(path=path)
+        self.assertEqual(metadata, found_metadata)
+
 
 class TestObjDump(TestCase):
 

=== modified file 'devportalbinary/tests/test_binary_backend.py'
--- devportalbinary/tests/test_binary_backend.py	2011-12-13 01:52:36 +0000
+++ devportalbinary/tests/test_binary_backend.py	2011-12-20 19:38:24 +0000
@@ -5,29 +5,36 @@
 import os
 import shutil
 
-from fixtures import TestWithFixtures
+from fixtures import TempDir
 from testtools import TestCase
+from testtools.matchers import (
+    Equals,
+    Matcher,
+    )
 
 from pkgme.backend import ExternalHelpersBackend, get_backend_dir
 from pkgme.info_elements import (
     BuildDepends,
+    Description,
     Depends,
     ExtraFiles,
     PackageName,
     )
-from pkgme.testing import TempdirFixture
 
 from devportalbinary.binary import (
     CATEGORIES,
+    DESCRIPTION,
     DEPENDS,
     get_binary_desktop_file,
     get_install_file,
     guess_dependencies,
-    METADATA_FILE,
     PACKAGE_NAME,
     TAGLINE,
     )
-from devportalbinary.testing import DatabaseFixture
+from devportalbinary.testing import (
+    DatabaseFixture,
+    MetadataFixture,
+    )
 
 
 BACKEND_NAME = 'binary'
@@ -35,72 +42,98 @@
 backend_dir = get_backend_dir(__file__, BACKEND_NAME)
 
 
-class BinaryBackendTests(TestCase, TestWithFixtures):
+class HasField(Matcher):
+    """Matches if 'info' has a field with the given value."""
+
+    def __init__(self, field, field_value):
+        super(HasField, self).__init__()
+        self.field = field
+        self.field_value = field_value
+
+    def match(self, info):
+        return Equals(
+            {self.field.name: self.field_value}).match(
+            info.get_all([self.field.name]))
+
+
+class BinaryBackendTests(TestCase):
 
     def test_want_with_metadata(self):
         # If we detect a binary, then we score 10. The way we determine if
         # something is a binary is if it has a devportal-metadata.json in its
         # top-level.
-        tempdir = self.useFixture(TempdirFixture())
-        tempdir.touch(METADATA_FILE)
+        path = self.useFixture(MetadataFixture({})).path
         backend = ExternalHelpersBackend(BACKEND_NAME, backend_dir)
-        self.assertEqual(10, backend.want(tempdir.path))
+        self.assertEqual(10, backend.want(path))
 
     def test_want_without_metadata(self):
         # If we do *not* detect a binary, then we score 0. The way we
         # determine if something is a binary is if it has a
         # devportal-metadata.json in its top-level.
-        tempdir = self.useFixture(TempdirFixture())
+        tempdir = self.useFixture(TempDir())
         backend = ExternalHelpersBackend(BACKEND_NAME, backend_dir)
         self.assertEqual(0, backend.want(tempdir.path))
 
     def test_package_name(self):
         # The binary backend gets the package name from the metadata file.
-        tempdir = self.useFixture(TempdirFixture())
-        tempdir.create_file(METADATA_FILE, json.dumps({PACKAGE_NAME: 'foo'}))
-        backend = ExternalHelpersBackend(BACKEND_NAME, backend_dir)
-        info = backend.get_info(tempdir.path)
-        self.assertEqual(
-            {PackageName.name: "foo"}, info.get_all([PackageName.name]))
+        path = self.useFixture(MetadataFixture({PACKAGE_NAME: 'foo'})).path
+        backend = ExternalHelpersBackend(BACKEND_NAME, backend_dir)
+        info = backend.get_info(path)
+        self.assertThat(info, HasField(PackageName, 'foo'))
+
+    def test_description(self):
+        # The binary backend uses the package description that's in the
+        # metadata.
+        description = self.getUniqueString()
+        path = self.useFixture(MetadataFixture({
+                    PACKAGE_NAME: 'foo',
+                    DESCRIPTION: description,
+                    })).path
+        backend = ExternalHelpersBackend(BACKEND_NAME, backend_dir)
+        info = backend.get_info(path)
+        self.assertThat(info, HasField(Description, description))
+
+    def test_no_description(self):
+        # If no description is provided in the metadata then the description
+        # in the package info is just an empty string.
+        path = self.useFixture(MetadataFixture({PACKAGE_NAME: 'foo'})).path
+        backend = ExternalHelpersBackend(BACKEND_NAME, backend_dir)
+        info = backend.get_info(path)
+        self.assertThat(info, HasField(Description, ''))
 
     def test_build_depends(self):
         # Make sure there's a database.
         self.useFixture(DatabaseFixture())
-        tempdir = self.useFixture(TempdirFixture())
-        tempdir.create_file(METADATA_FILE, json.dumps({PACKAGE_NAME: 'foo'}))
+        path = self.useFixture(MetadataFixture({PACKAGE_NAME: 'foo'})).path
         shutil.copy(
             os.path.join(os.path.dirname(__file__), 'hello'),
-            tempdir.path)
+            path)
         backend = ExternalHelpersBackend(BACKEND_NAME, backend_dir)
-        info = backend.get_info(tempdir.path)
-        deps = ', '.join(guess_dependencies(tempdir.path))
-        self.assertEqual(
-            {BuildDepends.name: deps}, info.get_all([BuildDepends.name]))
+        info = backend.get_info(path)
+        deps = ', '.join(guess_dependencies(path))
+        self.assertThat(info, HasField(BuildDepends, deps))
 
     def test_depends(self):
-        tempdir = self.useFixture(TempdirFixture())
-        tempdir.create_file(METADATA_FILE, json.dumps({PACKAGE_NAME: 'foo'}))
+        path = self.useFixture(MetadataFixture({PACKAGE_NAME: 'foo'})).path
         backend = ExternalHelpersBackend(BACKEND_NAME, backend_dir)
-        info = backend.get_info(tempdir.path)
-        self.assertEqual({Depends.name: DEPENDS}, info.get_all([Depends.name]))
+        info = backend.get_info(path)
+        self.assertThat(info, HasField(Depends, DEPENDS))
 
     def test_extra_files_install_file(self):
         # We create an 'install' file that tells debhelper to just copy
         # everything to opt.
-        tempdir = self.useFixture(TempdirFixture())
         package_name = self.getUniqueString()
-        tempdir.create_file(METADATA_FILE, json.dumps({PACKAGE_NAME: package_name}))
+        path = self.useFixture(MetadataFixture({PACKAGE_NAME: package_name})).path
         backend = ExternalHelpersBackend(BACKEND_NAME, backend_dir)
-        info = backend.get_info(tempdir.path)
+        info = backend.get_info(path)
         extra_files = info.get_all([ExtraFiles.name])[ExtraFiles.name]
         install_file = json.loads(extra_files)['debian/install']
         self.assertEqual(
-            get_install_file(package_name, tempdir.path, True),
+            get_install_file(package_name, path, True),
             install_file)
 
     def test_extra_files_desktop_file(self):
         # We create an 'desktop' file that launches the guessed binary
-        tempdir = self.useFixture(TempdirFixture())
         package_name = self.getUniqueString()
         tagline = self.getUniqueString()
         categories = self.getUniqueString()
@@ -109,7 +142,7 @@
             TAGLINE: tagline,
             CATEGORIES: categories,
             }
-        tempdir.create_file(METADATA_FILE, json.dumps(metadata))
+        tempdir = self.useFixture(MetadataFixture(metadata)).tempdir
         # We need to create an executable in order to be able to generate a
         # desktop.
         tempdir.touch('executable', 0755)

=== modified file 'devportalbinary/tests/test_database.py'
--- devportalbinary/tests/test_database.py	2011-12-09 16:02:24 +0000
+++ devportalbinary/tests/test_database.py	2011-12-20 19:38:24 +0000
@@ -1,5 +1,9 @@
 import os
-from sqlite3 import IntegrityError
+
+from testtools import try_imports
+
+IntegrityError = try_imports(
+    ['pysqlite2.dbapi2.IntegrityError', 'sqlite3.IntegrityError'])
 
 from fixtures import (
     EnvironmentVariableFixture,