Merge lp:~jml/pkgme/split-write-packaging into lp:pkgme

[Jonathan Lange]

Split write_packaging so that there's a way to get information.

Reasonably simple thing to let pkgme-service get the info that pkgme finds.

It just blows up ``write_packaging`` into its constituent parts. I considered making ``write_packaging`` return info. I didn't. I don't know why.

Switched to use treeshape to make the tests a bit more declarative.

get_packaging_info really ought to include the want reasons & scores from rejected backends, but I think that ought to be a simple change.

Thanks,
jml

[lp:~jml/pkgme/split-write-packaging]

142. By Jonathan Lange on 2012-08-29

PEP 8

[James Westby (james-w)]

67 + # Do these imports in the function to reduce the side-effects of importing
68 + # pkgme. This avoids the need for setup.py of the tool being packaged
69 + # from having to find all the imported dependencies when running the
70 + # extension pkgme_info setup.py command.

There's no imports in that function. Maybe it was supposed to be in the previous function?

Thanks,

James

review: Approve

[lp:~jml/pkgme/split-write-packaging]

143. By Jonathan Lange on 2012-08-29

Move the comment

=== modified file 'buildout.cfg'
--- buildout.cfg	2012-08-24 19:50:26 +0000
+++ buildout.cfg	2012-08-29 16:20:27 +0000
@@ -32,5 +32,6 @@
 # python-subunit is needed for those that use testr
 eggs = pkgme
        python-subunit
+       treeshape
 include-site-packages = false
 interpreter = py

=== modified file 'pkgme/__init__.py'
--- pkgme/__init__.py	2012-08-28 10:57:30 +0000
+++ pkgme/__init__.py	2012-08-29 16:20:27 +0000
@@ -21,25 +21,54 @@
 __metaclass__ = type
 __all__ = [
     '__version__',
+    'get_packaging_info',
     'write_packaging',
+    'write_packaging_info',
     ]
 
 
 __version__ = '0.3.1'
 
 
-def write_packaging(path, distribution=None, allowed_backend_names=None):
+
+def get_packaging_info(path, distribution=None, allowed_backend_names=None):
+    """Get the packaging information for 'path'.
+
+    :param path: Path to the thing being packaged.
+    :param distribution: Name of the distribution being packaged for.
+    :param allowed_backend_names: List of allowed backend names.  If not,
+        provided, all backends are allowed.
+    :return: A ``ProjectInfo`` object.
+    """
     # Do these imports in the function to reduce the side-effects of importing
     # pkgme.   This avoids the need for setup.py of the tool being packaged
     # from having to find all the imported dependencies when running the
     # extension pkgme_info setup.py command.
     from pkgme.backend import get_info_for
-    from pkgme.package_files import default_package_file_group
-    from pkgme.write import Writer
     info = get_info_for(path, allowed_backend_names=allowed_backend_names)
     if distribution:
         from pkgme.info_elements import Distribution
         from pkgme.project_info import DictInfo, FallbackInfo
         info = FallbackInfo(DictInfo({Distribution.name: distribution}), info)
+    return info
+
+
+def write_packaging_info(path, info):
+    """Write packaging information for 'path'.
+
+    :param path: Path to write the packaging information to.
+    :param info: A ``ProjectInfo`` containing everything we need to package it.
+    """
+    # Do these imports in the function to reduce the side-effects of importing
+    # pkgme.   This avoids the need for setup.py of the tool being packaged
+    # from having to find all the imported dependencies when running the
+    # extension pkgme_info setup.py command.
+    from pkgme.package_files import default_package_file_group
+    from pkgme.write import Writer
     files = default_package_file_group.get_files(info)
     Writer().write(files, path)
+
+
+def write_packaging(path, distribution=None, allowed_backend_names=None):
+    info = get_packaging_info(path, distribution, allowed_backend_names)
+    write_packaging_info(path, info)

=== modified file 'pkgme/tests/test_write_packaging.py'
--- pkgme/tests/test_write_packaging.py	2012-02-04 18:24:41 +0000
+++ pkgme/tests/test_write_packaging.py	2012-08-29 16:20:27 +0000
@@ -1,8 +1,14 @@
 import os
 
+from fixtures import TempDir
 from testtools import TestCase
+from treeshape import HasFileTree
 
-from pkgme import write_packaging
+from pkgme import (
+    get_packaging_info,
+    write_packaging,
+    write_packaging_info,
+    )
 from pkgme.backend import StaticBackend
 from pkgme.info_elements import (
     Architecture,
@@ -16,21 +22,18 @@
 from pkgme.testing import (
     ControlSourceStanzaHasField,
     StaticLoaderFixture,
-    TempdirFixture,
     )
 
 
+def ControlHasSourceName(name):
+    control_path = os.path.join(DEBIAN_DIR, Control.filename)
+    return HasFileTree(
+        {control_path:
+             {'content': ControlSourceStanzaHasField("Source", name)}})
+
+
 class WritePackagingTests(TestCase):
 
-    def assert_control_has_source_name(self, name, tempdir):
-        control_path = os.path.join(
-            tempdir.path, DEBIAN_DIR, Control.filename)
-        with open(control_path) as f:
-            control_contents = f.read()
-        self.assertThat(
-            control_contents,
-            ControlSourceStanzaHasField("Source", name))
-
     def make_info(self, name):
         info = DictInfo(
             {
@@ -45,25 +48,76 @@
     def test_write_packaging(self):
         name = PackageName.clean(self.getUniqueString())
         info = self.make_info(name)
-        tempdir = self.useFixture(TempdirFixture())
+        tempdir = self.useFixture(TempDir()).path
         backend = StaticBackend(
-            self.getUniqueString(), 10, info, expected_path=tempdir.path)
+            self.getUniqueString(), 10, info, expected_path=tempdir)
         self.useFixture(StaticLoaderFixture([backend]))
-        write_packaging(tempdir.path)
-        self.assert_control_has_source_name(name, tempdir)
+        write_packaging(tempdir)
+        self.assertThat(tempdir, ControlHasSourceName(name))
 
     def test_write_packaging_passes_allowed_backend_names(self):
         name = PackageName.clean(self.getUniqueString())
-        other_name = name+"WRONG"
+        other_name = name + "WRONG"
         info1 = self.make_info(name)
         info2 = self.make_info(other_name)
-        tempdir = self.useFixture(TempdirFixture())
+        tempdir = self.useFixture(TempDir()).path
         backend1 = StaticBackend(
-            self.getUniqueString(), 10, info1, expected_path=tempdir.path)
+            self.getUniqueString(), 10, info1, expected_path=tempdir)
         backend2 = StaticBackend(
             self.getUniqueString(), 20, info2)
         self.useFixture(StaticLoaderFixture(
             [backend1, backend2]))
-        write_packaging(tempdir.path,
-                allowed_backend_names=[backend1.name])
-        self.assert_control_has_source_name(name, tempdir)
+        write_packaging(tempdir, allowed_backend_names=[backend1.name])
+        self.assertThat(tempdir, ControlHasSourceName(name))
+
+
+class TestWritePackagingInformation(TestCase):
+
+    def test_writes_packaging(self):
+        path = self.useFixture(TempDir()).path
+        package_name = PackageName.clean(self.getUniqueString())
+        info = DictInfo(
+            {
+                PackageName.name: package_name,
+                Maintainer.name: self.getUniqueString(),
+                Architecture.name: "all",
+                Description.name: self.getUniqueString(),
+                Version.name: "1",
+            })
+        write_packaging_info(path, info)
+        self.assertThat(path, ControlHasSourceName(package_name))
+
+
+class TestGetPackagingInfo(TestCase):
+
+    def make_info(self):
+        return DictInfo(
+            {
+                PackageName.name: PackageName.clean(self.getUniqueString()),
+                Maintainer.name: self.getUniqueString(),
+                Architecture.name: "all",
+                Description.name: self.getUniqueString(),
+                Version.name: "1",
+            })
+
+    def test_get_packaging_info(self):
+        info = self.make_info()
+        tempdir = self.useFixture(TempDir()).path
+        backend = StaticBackend(
+            self.getUniqueString(), 10, info, expected_path=tempdir)
+        self.useFixture(StaticLoaderFixture([backend]))
+        found = get_packaging_info(tempdir)
+        self.assertEqual(found, info)
+
+    def test_allowed_backend_names(self):
+        info1 = self.make_info()
+        info2 = self.make_info()
+        tempdir = self.useFixture(TempDir()).path
+        backend1 = StaticBackend(
+            self.getUniqueString(), 10, info1, expected_path=tempdir)
+        backend2 = StaticBackend(
+            self.getUniqueString(), 20, info2)
+        self.useFixture(StaticLoaderFixture([backend1, backend2]))
+        found = get_packaging_info(
+            tempdir, allowed_backend_names=[backend1.name])
+        self.assertEqual(found, info1)

=== modified file 'versions.cfg'
--- versions.cfg	2012-08-24 19:50:26 +0000
+++ versions.cfg	2012-08-29 16:20:27 +0000
@@ -25,7 +25,8 @@
 python-subunit = 0.0.8
 simplejson = 2.6.1
 testresources = 0.2.5
-testtools = 0.9.15
+testtools = 0.9.16
+treeshape = 0.2.0
 wadllib = 1.3.1
 wsgi-intercept = 0.5.1
 z3c.recipe.scripts = 1.0.1