Merge lp:~jpds/launchpad/fix_515388 into lp:launchpad

[Jonathan Davies]

Added DistributionMirrors to the Launchpad API.

[Jonathan Davies (jpds)]

= Summary =

Distribution mirrors should be exposed via the Launchpad API. This branch makes the necessary changes to make this a reality.

[Graham Binns (gmb)]

review: Approve (code)

=== modified file 'lib/canonical/launchpad/interfaces/_schema_circular_imports.py'
--- lib/canonical/launchpad/interfaces/_schema_circular_imports.py	2010-01-15 01:59:08 +0000
+++ lib/canonical/launchpad/interfaces/_schema_circular_imports.py	2010-02-01 23:20:32 +0000
@@ -44,6 +44,7 @@
 from lp.code.interfaces.diff import IPreviewDiff
 from lp.code.interfaces.hasbranches import IHasBranches, IHasMergeProposals
 from lp.registry.interfaces.distribution import IDistribution
+from lp.registry.interfaces.distributionmirror import IDistributionMirror
 from lp.registry.interfaces.distributionsourcepackage import (
     IDistributionSourcePackage)
 from lp.registry.interfaces.distroseries import IDistroSeries
@@ -261,6 +262,10 @@
 IDistribution['all_distro_archives'].value_type.schema = IArchive
 
 
+# IDistributionMirror
+IDistributionMirror['distribution'].schema = IDistribution
+
+
 # IDistroSeries
 patch_entry_return_type(
     IDistroSeries, 'getDistroArchSeries', IDistroArchSeries)

=== modified file 'lib/lp/registry/interfaces/distribution.py'
--- lib/lp/registry/interfaces/distribution.py	2009-12-09 14:55:02 +0000
+++ lib/lp/registry/interfaces/distribution.py	2010-02-01 23:20:32 +0000
@@ -20,7 +20,7 @@
     'NoSuchDistribution',
     ]
 
-from zope.schema import Bool, Choice, Datetime, List, Text, TextLine
+from zope.schema import Bool, Choice, Datetime, List, Object, Text, TextLine
 from zope.interface import Attribute, Interface
 
 from lazr.restful.fields import CollectionField, Reference
@@ -39,6 +39,7 @@
     IStructuralSubscriptionTarget)
 from lp.app.interfaces.headings import IRootContext
 from lp.registry.interfaces.announcement import IMakesAnnouncements
+from lp.registry.interfaces.distributionmirror import IDistributionMirror
 from lp.bugs.interfaces.bugtarget import (
     IBugTarget, IOfficialBugTagTargetPublic, IOfficialBugTagTargetRestricted)
 from lp.soyuz.interfaces.buildrecords import IHasBuildRecords
@@ -184,18 +185,22 @@
         title=_("Members"),
         description=_("The distro's members team."), required=True,
         vocabulary='ValidPersonOrTeam')
-    mirror_admin = PublicPersonChoice(
+    mirror_admin = exported(PublicPersonChoice(
         title=_("Mirror Administrator"),
         description=_("The person or team that has the rights to review and "
                       "mark this distribution's mirrors as official."),
-        required=True, vocabulary='ValidPersonOrTeam')
+        required=True, vocabulary='ValidPersonOrTeam'))
     lucilleconfig = TextLine(
         title=_("Lucille Config"),
         description=_("The Lucille Config."), required=False)
-    archive_mirrors = Attribute(
-        "All enabled and official ARCHIVE mirrors of this Distribution.")
-    cdimage_mirrors = Attribute(
-        "All enabled and official RELEASE mirrors of this Distribution.")
+    archive_mirrors = exported(CollectionField(
+        description=_("All enabled and official ARCHIVE mirrors of this "
+                      "Distribution."),
+        readonly=True, value_type=Object(schema=IDistributionMirror)))
+    cdimage_mirrors = exported(CollectionField(
+        description=_("All enabled and official RELEASE mirrors of this "
+                      "Distribution."),
+        readonly=True, value_type=Object(schema=IDistributionMirror)))
     disabled_mirrors = Attribute(
         "All disabled and official mirrors of this Distribution.")
     unofficial_mirrors = Attribute(
@@ -304,6 +309,10 @@
             `IDistroSeries.version`.
         """
 
+    @operation_parameters(
+        name=TextLine(title=_("Name"), required=True))
+    @operation_returns_entry(IDistributionMirror)
+    @export_read_operation()
     def getMirrorByName(name):
         """Return the mirror with the given name for this distribution or None
         if it's not found.

=== modified file 'lib/lp/registry/interfaces/distributionmirror.py'
--- lib/lp/registry/interfaces/distributionmirror.py	2009-10-26 18:40:04 +0000
+++ lib/lp/registry/interfaces/distributionmirror.py	2010-02-01 23:20:32 +0000
@@ -27,6 +27,9 @@
 from zope.interface.interface import invariant
 from zope.component import getUtility
 from lazr.enum import DBEnumeratedType, DBItem
+from lazr.restful.declarations import (
+    export_as_webservice_entry, export_read_operation, exported)
+from lazr.restful.fields import Reference
 
 from canonical.launchpad import _
 from canonical.launchpad.fields import (
@@ -280,61 +283,68 @@
 
 class IDistributionMirror(Interface):
     """A mirror of a given distribution."""
+    export_as_webservice_entry()
 
     id = Int(title=_('The unique id'), required=True, readonly=True)
-    owner = PublicPersonChoice(
+    owner = exported(PublicPersonChoice(
         title=_('Owner'), required=False, readonly=True,
-        vocabulary='ValidOwner')
+        vocabulary='ValidOwner'))
     reviewer = PublicPersonChoice(
         title=_('Reviewer'), required=False, readonly=False,
         vocabulary='ValidPersonOrTeam')
-    distribution = Attribute(_("The distribution that is mirrored"))
-    name = DistributionMirrorNameField(
+    distribution = exported(
+        Reference(
+            Interface,
+            # Really IDistribution, circular import fixed in
+            # _schema_circular_imports.
+            title=_("Distribution"), required=True,
+            description=_("The distribution that is mirrored")))
+    name = exported(DistributionMirrorNameField(
         title=_('Name'), required=True, readonly=False,
         description=_('A short and unique name for this mirror.'),
-        constraint=name_validator)
-    displayname = TextLine(
+        constraint=name_validator))
+    displayname = exported(TextLine(
         title=_('Organisation'), required=False, readonly=False,
-        description=_('The name of the organization hosting this mirror.'))
-    description = TextLine(
-        title=_('Description'), required=False, readonly=False)
-    http_base_url = DistroMirrorHTTPURIField(
+        description=_('The name of the organization hosting this mirror.')))
+    description = exported(TextLine(
+        title=_('Description'), required=False, readonly=False))
+    http_base_url = exported(DistroMirrorHTTPURIField(
         title=_('HTTP URL'), required=False, readonly=False,
         allowed_schemes=['http'], allow_userinfo=False,
         allow_query=False, allow_fragment=False, trailing_slash=True,
-        description=_('e.g.: http://archive.ubuntu.com/ubuntu/'))
-    ftp_base_url = DistroMirrorFTPURIField(
+        description=_('e.g.: http://archive.ubuntu.com/ubuntu/')))
+    ftp_base_url = exported(DistroMirrorFTPURIField(
         title=_('FTP URL'), required=False, readonly=False,
         allowed_schemes=['ftp'], allow_userinfo=False,
         allow_query=False, allow_fragment=False, trailing_slash=True,
-        description=_('e.g.: ftp://archive.ubuntu.com/ubuntu/'))
-    rsync_base_url = DistroMirrorRsyncURIField(
+        description=_('e.g.: ftp://archive.ubuntu.com/ubuntu/')))
+    rsync_base_url = exported(DistroMirrorRsyncURIField(
         title=_('Rsync URL'), required=False, readonly=False,
         allowed_schemes=['rsync'], allow_userinfo=False,
         allow_query=False, allow_fragment=False, trailing_slash=True,
-        description=_('e.g.: rsync://archive.ubuntu.com/ubuntu/'))
-    enabled = Bool(
+        description=_('e.g.: rsync://archive.ubuntu.com/ubuntu/')))
+    enabled = exported(Bool(
         title=_('This mirror was probed successfully.'),
-        required=False, readonly=False, default=False)
-    speed = Choice(
+        required=False, readonly=False, default=False))
+    speed = exported(Choice(
         title=_('Link Speed'), required=True, readonly=False,
-        vocabulary=MirrorSpeed)
+        vocabulary=MirrorSpeed))
     country = Choice(
         title=_('Location'), required=True, readonly=False,
         vocabulary='CountryName')
-    content = Choice(
+    content = exported(Choice(
         title=_('Content'), required=True, readonly=False,
         description=_(
             'Choose "CD Image" if this mirror contains CD images of '
             'this distribution. Choose "Archive" if this is a '
             'mirror of packages for this distribution.'),
-        vocabulary=MirrorContent)
-    official_candidate = Bool(
+        vocabulary=MirrorContent))
+    official_candidate = exported(Bool(
         title=_('Apply to be an official mirror of this distribution'),
-        required=False, readonly=False, default=True)
-    status = Choice(
+        required=False, readonly=False, default=True))
+    status = exported(Choice(
         title=_('Status'), required=True, readonly=False,
-        vocabulary=MirrorStatus)
+        vocabulary=MirrorStatus))
 
     title = Attribute('The title of this mirror')
     cdimage_series = Attribute(
@@ -345,11 +355,11 @@
     last_probe_record = Attribute(
         'The last MirrorProbeRecord for this mirror.')
     all_probe_records = Attribute('All MirrorProbeRecords for this mirror.')
-    has_ftp_or_rsync_base_url = Bool(
-        title=_('Does this mirror have a ftp or rsync base URL?'))
+    has_ftp_or_rsync_base_url = exported(Bool(
+        title=_('Does this mirror have a ftp or rsync base URL?')))
     base_url = Attribute('The HTTP or FTP base URL of this mirror')
-    date_created = Datetime(
-        title=_('Date Created'), required=True, readonly=True)
+    date_created = exported(Datetime(
+        title=_('Date Created'), required=True, readonly=True))
     date_reviewed = Datetime(
         title=_('Date reviewed'), required=False, readonly=False)
     whiteboard = Whiteboard(
@@ -380,6 +390,7 @@
         each distro_arch_series of this distribution mirror.
         """
 
+    @export_read_operation()
     def getOverallFreshness():
         """Return this mirror's overall freshness.
 
@@ -392,6 +403,7 @@
         contain one or more ISO images.
         """
 
+    @export_read_operation()
     def isOfficial():
         """Return True if this is an official mirror."""
 

=== added file 'lib/lp/registry/stories/webservice/xx-distribution-mirror.txt'
--- lib/lp/registry/stories/webservice/xx-distribution-mirror.txt	1970-01-01 00:00:00 +0000
+++ lib/lp/registry/stories/webservice/xx-distribution-mirror.txt	2010-02-01 23:20:32 +0000
@@ -0,0 +1,75 @@
+= Distribution Mirrors =
+
+For every mirror of distribution we publish most of its attributes. For archive
+mirrors:
+
+    >>> from lazr.restful.testing.webservice import pprint_entry
+    >>> distros = webservice.get("/distros").jsonBody()
+    >>> distro = distros['entries'][0]
+    >>> ubuntu = webservice.get(distro['self_link']).jsonBody()
+    >>> ubuntu_archive_mirrors = webservice.get(ubuntu['archive_mirrors_collection_link']).jsonBody()
+    >>> canonical_archive = ubuntu_archive_mirrors['entries'][0]
+    >>> canonical_archive_json = webservice.get(canonical_archive['self_link']).jsonBody()
+    >>> pprint_entry(canonical_archive_json)
+    content: u'Archive'
+    date_created: u'2006-10-16T18:31:43.434567+00:00'
+    description: None
+    displayname: None
+    distribution_link: u'http://.../ubuntu'
+    enabled: True
+    ftp_base_url: None
+    has_ftp_or_rsync_base_url: False
+    http_base_url: u'http://archive.ubuntu.com/ubuntu/'
+    name: u'canonical-archive'
+    official_candidate: True
+    owner_link: u'http://.../~mark'
+    resource_type_link: u'http://.../#distribution_mirror'
+    rsync_base_url: None
+    self_link: u'http://.../ubuntu/+mirror/canonical-archive'
+    speed: u'100 Mbps'
+    status: u'Official'
+
+And CD image mirrors:
+
+    >>> ubuntu_cd_mirrors = webservice.get(ubuntu['cdimage_mirrors_collection_link']).jsonBody()
+    >>> canonical_releases =  ubuntu_cd_mirrors['entries'][0]
+    >>> canonical_releases_json = webservice.get(canonical_releases['self_link']).jsonBody()
+    >>> pprint_entry(canonical_releases_json)
+    content: u'CD Image'
+    date_created: u'2006-10-16T18:31:43.434567+00:00'
+    description: None
+    displayname: None
+    distribution_link: u'http://.../ubuntu'
+    enabled: True
+    ftp_base_url: None
+    has_ftp_or_rsync_base_url: False
+    http_base_url: u'http://releases.ubuntu.com/'
+    name: u'canonical-releases'
+    official_candidate: True
+    owner_link: u'http://.../~mark'
+    resource_type_link: u'http://.../#distribution_mirror'
+    rsync_base_url: None
+    self_link: u'http://.../ubuntu/+mirror/canonical-releases'
+    speed: u'100 Mbps'
+    status: u'Official'
+
+= Distribution Mirror Custom Operations =
+
+DistributionMirror has some custom operations.
+
+"isOfficial" returns a boolean result on whether a mirror is an official mirror
+or not.
+
+    >>> is_official_mirror = webservice.named_get(canonical_releases['self_link'],
+    ...     'isOfficial').jsonBody()
+    >>> print is_official_mirror
+    True
+
+"getOverallFreshness" returns the freshness of the mirror determined by the
+mirror prober from the mirror's last probe.
+
+    >>> releases_mirror2 = ubuntu_cd_mirrors['entries'][2]
+    >>> freshness = webservice.named_get(releases_mirror2['self_link'],
+    ...     'getOverallFreshness').jsonBody()
+    >>> print freshness
+    Up to date

=== modified file 'lib/lp/registry/stories/webservice/xx-distribution.txt'
--- lib/lp/registry/stories/webservice/xx-distribution.txt	2009-05-08 20:20:40 +0000
+++ lib/lp/registry/stories/webservice/xx-distribution.txt	2010-02-01 23:20:32 +0000
@@ -21,8 +21,10 @@
     active: True
     active_milestones_collection_link: u'http://.../ubuntu/active_milestones'
     all_milestones_collection_link: u'http://.../ubuntu/all_milestones'
+    archive_mirrors_collection_link: u'http://.../ubuntu/archive_mirrors'
     archives_collection_link: u'http://.../ubuntu/archives'
     bug_reporting_guidelines: None
+    cdimage_mirrors_collection_link: u'http://.../ubuntu/cdimage_mirrors'
     current_series_link: u'http://.../ubuntu/hoary'
     date_created: u'2006-10-16T18:31:43.415195+00:00'
     description: u'Ubuntu is a new approach...'
@@ -33,6 +35,7 @@
     icon_link: u'http://.../ubuntu/icon'
     logo_link: u'http://.../ubuntu/logo'
     main_archive_link: u'http://.../ubuntu/+archive/primary'
+    mirror_admin_link: u'http://.../~ubuntu-mirror-admins'
     mugshot_link: u'http://.../ubuntu/mugshot'
     name: u'ubuntu'
     official_bug_tags: []
@@ -112,3 +115,27 @@
     http://.../ubuntu/+source/alsa-utils
     http://.../ubuntu/+source/foobar
     http://.../ubuntu/+source/commercialpackage
+
+"getMirrorByName" returns a mirror by its unique name.
+
+    >>> canonical_releases = webservice.named_get(
+    ...     ubuntu['self_link'], 'getMirrorByName',
+    ...     name='canonical-releases').jsonBody()
+    >>> pprint_entry(canonical_releases)
+    content: u'CD Image'
+    date_created: u'2006-10-16T18:31:43.434567+00:00'
+    description: None
+    displayname: None
+    distribution_link: u'http://.../ubuntu'
+    enabled: True
+    ftp_base_url: None
+    has_ftp_or_rsync_base_url: False
+    http_base_url: u'http://releases.ubuntu.com/'
+    name: u'canonical-releases'
+    official_candidate: True
+    owner_link: u'http://.../~mark'
+    resource_type_link: u'http://.../#distribution_mirror'
+    rsync_base_url: None
+    self_link: u'http://.../ubuntu/+mirror/canonical-releases'
+    speed: u'100 Mbps'
+    status: u'Official'