Merge lp:~wgrant/launchpad/bug-558905-get-archive into lp:launchpad

[William Grant]

Create and expose Distribution.getArchive.

This branch fixes bug 558905, moving traverse_distro_archive to Distribution.getArchive and exposing it over the API. I've replaced the old function's single callsite with a call to the new method.

There is no lint.

[Eleanor Berger (intellectronica)]

review: Approve (code)

=== modified file 'lib/canonical/launchpad/interfaces/_schema_circular_imports.py'
--- lib/canonical/launchpad/interfaces/_schema_circular_imports.py	2010-04-23 03:16:22 +0000
+++ lib/canonical/launchpad/interfaces/_schema_circular_imports.py	2010-05-14 08:12:30 +0000
@@ -276,6 +276,8 @@
 patch_reference_property(
     IDistribution, 'currentseries', IDistroSeries)
 patch_entry_return_type(
+    IDistribution, 'getArchive', IArchive)
+patch_entry_return_type(
     IDistribution, 'getSeries', IDistroSeries)
 patch_collection_return_type(
     IDistribution, 'getDevelopmentSeries', IDistroSeries)

=== modified file 'lib/lp/registry/browser/distribution.py'
--- lib/lp/registry/browser/distribution.py	2010-03-08 05:03:15 +0000
+++ lib/lp/registry/browser/distribution.py	2010-05-14 08:12:30 +0000
@@ -51,7 +51,6 @@
 from lp.registry.browser.announcement import HasAnnouncementsView
 from lp.registry.browser.menu import (
     IRegistryCollectionNavigationMenu, RegistryCollectionActionMenuBase)
-from lp.soyuz.browser.archive import traverse_distro_archive
 from lp.bugs.browser.bugtask import BugTargetTraversalMixin
 from lp.answers.browser.faqtarget import FAQTargetNavigationMixin
 from canonical.launchpad.browser.feeds import FeedsMixin
@@ -161,7 +160,7 @@
 
     @stepthrough('+archive')
     def traverse_archive(self, name):
-        return traverse_distro_archive(self.context, name)
+        return self.context.getArchive(name)
 
 
 class DistributionSetNavigation(Navigation):

=== modified file 'lib/lp/registry/doc/distribution.txt'
--- lib/lp/registry/doc/distribution.txt	2010-03-23 14:52:14 +0000
+++ lib/lp/registry/doc/distribution.txt	2010-05-14 08:12:30 +0000
@@ -592,3 +592,20 @@
     >>> [milestone.name for milestone in debian.all_milestones]
     [u'3.1', u'3.1-rc1', u'woody-rc1']
 
+
+== Archives ==
+
+A distribution archive (primary, partner, debug or copy) can be retrieved
+by name using IDistribution.getArchive.
+
+    >>> def display_archive(archive):
+    ...     print '%s %s %s' % (
+    ...         archive.distribution.name, archive.owner.name, archive.name)
+    >>> display_archive(ubuntu.getArchive('primary'))
+    ubuntu ubuntu-team primary
+    >>> display_archive(ubuntu.getArchive('partner'))
+    ubuntu ubuntu-team partner
+    >>> display_archive(debian.getArchive('primary'))
+    debian mark primary
+    >>> ubuntu.getArchive('ppa')
+    >>> debian.getArchive('partner')

=== modified file 'lib/lp/registry/interfaces/distribution.py'
--- lib/lp/registry/interfaces/distribution.py	2010-05-07 18:18:56 +0000
+++ lib/lp/registry/interfaces/distribution.py	2010-05-14 08:12:30 +0000
@@ -295,6 +295,18 @@
     def __iter__():
         """Iterate over the series for this distribution."""
 
+    @operation_parameters(
+        name=TextLine(title=_("Archive name"), required=True))
+    @operation_returns_entry(Interface)
+    @export_read_operation()
+    def getArchive(name):
+        """Return the distribution archive with the given name.
+
+        Only distribution archives are considered -- PPAs will not be found.
+
+        :param name: The name of the archive, e.g. 'partner'
+        """
+
     # Really IDistroSeries, see _schema_circular_imports.py.
     @operation_returns_collection_of(Interface)
     @export_operation_as(name="getDevelopmentSeries")

=== modified file 'lib/lp/registry/model/distribution.py'
--- lib/lp/registry/model/distribution.py	2010-05-07 20:09:03 +0000
+++ lib/lp/registry/model/distribution.py	2010-05-14 08:12:30 +0000
@@ -516,6 +516,11 @@
     def __iter__(self):
         return iter(self.series)
 
+    def getArchive(self, name):
+        """See `IDistribution.`"""
+        return getUtility(
+            IArchiveSet).getByDistroAndName(self, name)
+
     def getSeries(self, name_or_version):
         """See `IDistribution`."""
         distroseries = DistroSeries.selectOneBy(

=== modified file 'lib/lp/registry/stories/webservice/xx-distribution.txt'
--- lib/lp/registry/stories/webservice/xx-distribution.txt	2010-04-30 17:45:51 +0000
+++ lib/lp/registry/stories/webservice/xx-distribution.txt	2010-05-14 08:12:30 +0000
@@ -118,6 +118,14 @@
     http://.../ubuntu/+source/foobar
     http://.../ubuntu/+source/commercialpackage
 
+"getArchive" returns a distribution archive (not a PPA) with the given name.
+
+    >>> partner = webservice.named_get(
+    ...     ubuntu['self_link'], 'getArchive',
+    ...     name='partner').jsonBody()
+    >>> print partner['self_link']
+    http://.../ubuntu/+archive/partner
+
 "getMirrorByName" returns a mirror by its unique name.
 
     >>> canonical_releases = webservice.named_get(

=== modified file 'lib/lp/soyuz/browser/archive.py'
--- lib/lp/soyuz/browser/archive.py	2010-04-30 03:10:17 +0000
+++ lib/lp/soyuz/browser/archive.py	2010-05-14 08:12:30 +0000
@@ -23,7 +23,6 @@
     'ArchiveView',
     'ArchiveViewBase',
     'make_archive_vocabulary',
-    'traverse_distro_archive',
     'traverse_named_ppa',
     ]
 
@@ -111,21 +110,6 @@
         return "This archive is private."
 
 
-def traverse_distro_archive(distribution, name):
-    """For distribution archives, traverse to the right place.
-
-    This traversal only applies to distribution archives, not PPAs.
-
-    :param name: The name of the archive, e.g. 'partner'
-    """
-    archive = getUtility(
-        IArchiveSet).getByDistroAndName(distribution, name)
-    if archive is None:
-        raise NotFoundError(name)
-
-    return archive
-
-
 def traverse_named_ppa(person_name, ppa_name):
     """For PPAs, traverse the right place.