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

[Jonathan Davies]

Added models and tests for DistributionMirror.country_dns_mirror.

= Summary =

This branch builds on the schema changes introduced for bug #361650. Adding stuff to our models.

It also adds the API parts and mirror checks when marking mirrors as country mirrors with complete test suite.

[Curtis Hovey (sinzui)]

Your merge proposal should show the output of make lint to verify your
changes did not have any cruft. It will also inform you of style mistakes
that must be fixed before making a merge proposal.

I have some ideas to improve the code, and I think the interface and model
are missing essential documentation and unit tests. I suspect that the
story tests (which are integration tests) are test what should be testing
as documentation and unit tests.

> === modified file 'lib/lp/registry/interfaces/distribution.py'
> --- lib/lp/registry/interfaces/distribution.py 2010-02-27 10:19:18 +0000
> +++ lib/lp/registry/interfaces/distribution.py 2010-03-06 00:09:35 +0000
> @@ -318,6 +318,16 @@
> if it's not found.
> """
>
> + @operation_parameters(
> + country=copy_field(IDistributionMirror['country'], required=True),
> + mirror_type=copy_field(IDistributionMirror['content'], required=True))
> + @operation_returns_entry(IDistributionMirror)
> + @export_read_operation()
> + def getCountryMirror(country, mirror_type):
> + """Return the country DNS mirror for a given country and content
> + type.
> + """
> +

This docstring does not follow PEP 257. The first sentence must be one line.
Subsequent sentences may follow after a blank line:
    http://www.python.org/dev/peps/pep-0257/

Think this fixes the issue:

        """Return the country DNS mirror for a country and content type."""

> === modified file 'lib/lp/registry/interfaces/distributionmirror.py'
> --- lib/lp/registry/interfaces/distributionmirror.py 2010-02-22 15:50:06 +0000
> +++ lib/lp/registry/interfaces/distributionmirror.py 2010-03-06 00:09:35 +0000
> @@ -6,21 +6,23 @@
> __metaclass__ = type
>
> __all__ = [
> +'CannotTransitionToCountryMirror',
> +'CountryMirrorAlreadySet',
> 'IDistributionMirror',
> -'IDistributionMirrorAdminRestricted',
> -'IDistributionMirrorEditRestricted',
> -'IDistributionMirrorPublic',
> 'IMirrorDistroArchSeries',
> 'IMirrorDistroSeriesSource',
> 'IMirrorProbeRecord',
> 'IDistributionMirrorSet',
> 'IMirrorCDImageDistroSeries',
> 'PROBE_INTERVAL',
> -'UnableToFetchCDImageFileList',
> 'MirrorContent',
> 'MirrorFreshness',
> +'MirrorHasNoHTTPUrl',
> +'MirrorNotOfficial',
> +'MirrorNotProbed',
> 'MirrorSpeed',
> -'MirrorStatus']
> +'MirrorStatus',
> +'UnableToFetchCDImageFileList']

Per PEP 8, this list of single entries must each be indented and required a
trailing comma; the closing bracket on on a separate line to minimise diffs,
which I can see that this diff is already a victim:

    'MirrorStatus',
    'UnableToFetchCDImageFileList',
    ]

> @@ -47,6 +52,44 @@
> PROBE_INTERVAL = 23
>
> +class CannotTransitionToCountryMirror(Exception):
> + """Root exception for transitions to country mirrors.
> + """

The closing quotes belong on the previous line PEP 257.

> + webservice_error(400) # HTTP Error: 'Bad Request'.

Launchpad style does not use trailing comments because they interfere with
refactoring. I do not think comments about HTTP codes are informative;
we are expect to know them.

> @@ -386,6 +406,33 @@
> date_created = exported(Datetime(
> title=_('Date Crea...

review: Needs Fixing (code)

[Curtis Hovey (sinzui)]

Hi Jonathan.

I have some trivial suggestions to improve this branch. I think the implementation
is good and ready to land.

I can land the branch at the end of this week after these changes are made.

make lint reported these problems that need fixing:

lib/lp/registry/interfaces/distributionmirror.py
    339: [C0301] Line too long (83/78)
    436: [W0311] Bad indentation. Found 7 spaces, expected 8

> === modified file 'lib/lp/registry/doc/distribution-mirror.txt'
> --- lib/lp/registry/doc/distribution-mirror.txt 2009-12-09 10:03:20 +0000
> +++ lib/lp/registry/doc/distribution-mirror.txt 2010-03-29 15:54:12 +0000

@@ -814,3 +814,107 @@

> +Country DNS mirrors
> +-------------------
> +
> +Country DNS mirrors are mirrors which have been assigned $CC.archive.ubuntu.com
> +or $CC.releases.ubuntu.com. These assignments are tracked in Launchpad.

Wrap the narrative at 78 characters.

> + >>> login('<email address hidden>')
> + >>> ubuntu_distro = getUtility(IDistributionSet).getByName('ubuntu')
> + >>> de_archive_mirror = factory.makeMirror(ubuntu_distro,
> + ... "Technische Universitaet Dresden", country=82,
> + ... http_url="http://ubuntu.mirror.tudos.de/ubuntu/",
> + ... official_candidate=True)
> + >>> davis_station_archive = factory.makeMirror(ubuntu_distro,
> + ... "Davis Station", country=9,
> + ... http_url="http://mirror.davis.antarctica.org/ubuntu",
> + ... official_candidate=True)
> + >>> de_archive_mirror.status = MirrorStatus.OFFICIAL
> + >>> de_archive_prober_log = factory.makeMirrorProbeRecord(de_archive_mirror)
> + >>> logout()

Wrap the code at 78 characters.

...

> +Mirrors which are not official or do not have an HTTP URL may not be set as
> +country mirrors:
> +
> + >>> login('<email address hidden>')
> + >>> osuosl_mirror = factory.makeMirror(ubuntu_distro, "OSU Open Source Lab",
> + ... country=226,
> + ... ftp_url="ftp://ubuntu.osuosl.org/pub/ubuntu/",
> + ... official_candidate=True)
> + >>> osuosl_mirror.status = MirrorStatus.OFFICIAL
> + >>> print osuosl_mirror.http_base_url
> + None

Wrap the code at 78 characters.

> === modified file 'lib/lp/registry/interfaces/distribution.py'
> --- lib/lp/registry/interfaces/distribution.py 2010-03-24 21:59:58 +0000
> +++ lib/lp/registry/interfaces/distribution.py 2010-03-29 15:54:12 +0000
>
> @@ -321,6 +321,14 @@
> if it's not found.
> """
>
> + @operation_parameters(
> + country=copy_field(IDistributionMirror['country'], required=True),
> + mirror_type=copy_field(IDistributionMirror['content'], required=True))
> + @operation_returns_entry(IDistributionMirror)
> + @export_read_operation()
> + def getCountryMirror(country, mirror_type):
> + """Return the country DNS mirror for acountry and content type."""

grammar: s/acountry/a country/

> === modified file 'lib/lp/registry/interfaces/distributionmirror.py'
> --- lib/lp/registry/interfaces/distributionmirror.py 2010-02-22 15:50:06 +0000
> +++ lib/lp/registry/interfaces/distributionmirror.py 2010-03-29 15:54:12 +0000
> @@ -6,21 +6,24 @@
> __metaclass__ = type

 __all__ = [
...

> + ...

review: Needs Fixing (code)

[Curtis Hovey (sinzui)]

review: Approve (code)

=== modified file 'lib/lp/registry/configure.zcml'
--- lib/lp/registry/configure.zcml	2010-03-19 11:33:44 +0000
+++ lib/lp/registry/configure.zcml	2010-03-31 15:03:35 +0000
@@ -1644,18 +1644,60 @@
     <!-- DistributionMirror -->
     <class class="lp.registry.model.distributionmirror.DistributionMirror">
         <allow
-            interface="lp.registry.interfaces.distributionmirror.IDistributionMirrorPublic" />
+            attributes="
+                id
+                name
+                displayname
+                description
+                distribution
+                http_base_url
+                ftp_base_url
+                rsync_base_url
+                enabled
+                speed
+                status
+                country
+                content
+                owner
+                title
+                cdimage_series
+                source_series
+                arch_series
+                last_probe_record
+                all_probe_records
+                has_ftp_or_rsync_base_url
+                base_url
+                date_created
+                country_dns_mirror
+                mirrorMustHaveHTTPOrFTPURL
+                getSummarizedMirroredSourceSeries
+                getSummarizedMirroredArchSeries
+                getOverallFreshness
+                isOfficial
+                shouldDisable
+                disable
+                newProbeRecord
+                deleteMirrorDistroArchSeries
+                ensureMirrorDistroArchSeries
+                ensureMirrorDistroSeriesSource
+                deleteMirrorDistroSeriesSource
+                ensureMirrorCDImageSeries
+                deleteMirrorCDImageSeries
+                deleteAllMirrorCDImageSeries
+                getExpectedPackagesPaths
+                getExpectedSourcesPaths
+                canTransitionToCountryMirror" />
         <require
             permission="launchpad.Edit"
-            interface="lp.registry.interfaces.distributionmirror.IDistributionMirrorEditRestricted"
             set_attributes="name displayname description whiteboard
                             http_base_url ftp_base_url rsync_base_url enabled
-                            speed country content official_candidate owner" />
+                            speed country content official_candidate owner"
+            attributes="official_candidate whiteboard" />
         <require
             permission="launchpad.Admin"
-            interface="lp.registry.interfaces.distributionmirror.IDistributionMirrorAdminRestricted"
             set_attributes="status reviewer date_reviewed"
-            attributes="destroySelf" />
+            attributes="reviewer date_reviewed destroySelf
+                transitionToCountryMirror" />
     </class>
 
     <adapter

=== modified file 'lib/lp/registry/doc/distribution-mirror.txt'
--- lib/lp/registry/doc/distribution-mirror.txt	2009-12-09 10:03:20 +0000
+++ lib/lp/registry/doc/distribution-mirror.txt	2010-03-31 15:03:35 +0000
@@ -8,7 +8,7 @@
     >>> from canonical.launchpad.interfaces import (
     ...     ICountrySet, IDistributionSet, IDistributionMirrorSet,
     ...     IDistroArchSeriesSet, IDistroSeriesSet, ILibraryFileAliasSet,
-    ...     IPersonSet, MirrorContent, MirrorSpeed)
+    ...     IPersonSet, MirrorContent, MirrorSpeed, MirrorStatus)
     >>> from lp.registry.interfaces.pocket import PackagePublishingPocket
     >>> mirrorset = getUtility(IDistributionMirrorSet)
     >>> distroset = getUtility(IDistributionSet)
@@ -814,3 +814,121 @@
     >>> mirrorset.getByName('invalid-mirror') is None
     True
 
+Country DNS mirrors
+-------------------
+
+Country DNS mirrors are mirrors which have been assigned
+$CC.archive.ubuntu.com or $CC.releases.ubuntu.com. These assignments are
+tracked in Launchpad.
+
+    >>> login('[e-mail]')
+    >>> ubuntu_distro = getUtility(IDistributionSet).getByName('ubuntu')
+    >>> de_archive_mirror = factory.makeMirror(ubuntu_distro,
+    ...     "Technische Universitaet Dresden", country=82,
+    ...     http_url="http://ubuntu.mirror.tudos.de/ubuntu/",
+    ...     official_candidate=True)
+    >>> davis_station_archive = factory.makeMirror(ubuntu_distro,
+    ...     "Davis Station", country=9,
+    ...     http_url="http://mirror.davis.antarctica.org/ubuntu",
+    ...     official_candidate=True)
+    >>> de_archive_mirror.status = MirrorStatus.OFFICIAL
+    >>> de_archive_prober_log = factory.makeMirrorProbeRecord(de_archive_mirror)
+    >>> logout()
+
+Normal users can access country_dns_mirror, can see if a mirror is eligible
+for the status, however, they may not change it:
+
+    >>> login('[e-mail]')
+    >>> de_archive_mirror.canTransitionToCountryMirror()
+    True
+    >>> de_archive_mirror.transitionToCountryMirror(True)
+    Traceback (most recent call last):
+    ...
+    Unauthorized: (<DistributionMirror at ...>, 'transitionToCountryMirror',
+      'launchpad.Admin')
+    >>> logout()
+
+Mirror listing administrators may change the status however:
+
+    >>> login('[e-mail]')
+    >>> de_archive_mirror.transitionToCountryMirror(True)
+
+Mirrors which are already set as country mirrors can't be 'set' as such
+again:
+
+    >>> de_archive_mirror.canTransitionToCountryMirror()
+    False
+    >>> de_archive_mirror.transitionToCountryMirror(True)
+    >>> logout()
+
+There cannot be multiple country mirrors of one type for one country:
+
+    >>> login('[e-mail]')
+    >>> proberecord = factory.makeMirrorProbeRecord(davis_station_archive)
+
+    >>> print davis_station_archive.content.name
+    ARCHIVE
+    >>> print davis_station_archive.country_dns_mirror
+    False
+    >>> print davis_station_archive.country.name
+    Antarctica
+
+    >>> archive_mirror2 = getUtility(IDistributionMirrorSet).getByName(
+    ...     'archive-mirror2')
+    >>> print archive_mirror2.content.name
+    ARCHIVE
+    >>> print archive_mirror2.country_dns_mirror
+    False
+    >>> print archive_mirror2.country.name
+    Antarctica
+
+    >>> davis_station_archive.status = MirrorStatus.OFFICIAL
+
+    >>> davis_station_archive.transitionToCountryMirror(True)
+    >>> archive_mirror2.transitionToCountryMirror(True)
+    Traceback (most recent call last):
+    ...
+    CountryMirrorAlreadySet: Antarctica already has a country Archive mirror
+      set.
+
+Mirrors which have not been probed may not be marked as country mirrors:
+
+    >>> linux_au_mirror = factory.makeMirror(ubuntu_distro,
+    ...     "Linux.org.au", country=14,
+    ...     http_url="http://mirror.linux.org.au/ubuntu",
+    ...     official_candidate=True)
+    >>> linux_au_mirror.status = MirrorStatus.OFFICIAL
+    >>> linux_au_mirror.transitionToCountryMirror(True)
+    Traceback (most recent call last):
+    ...
+    MirrorNotProbed: This mirror may not be set as a country mirror as it has
+      not been probed.
+    >>> logout()
+
+Mirrors which are not official or do not have an HTTP URL may not be set as
+country mirrors:
+
+    >>> login('[e-mail]')
+    >>> osuosl_mirror = factory.makeMirror(ubuntu_distro,
+    ...     "OSU Open Source Lab", country=226,
+    ...     ftp_url="ftp://ubuntu.osuosl.org/pub/ubuntu/",
+    ...     official_candidate=True)
+    >>> osuosl_mirror.status = MirrorStatus.OFFICIAL
+    >>> print osuosl_mirror.http_base_url
+    None
+
+    >>> osuosl_mirror.canTransitionToCountryMirror()
+    False
+
+    >>> osuosl_mirror.transitionToCountryMirror(None)
+    Traceback (most recent call last):
+    ...
+    NoneError: None isn't acceptable as a value for
+      DistributionMirror.country_dns_mirror
+
+    >>> osuosl_mirror.transitionToCountryMirror(True)
+    Traceback (most recent call last):
+    ...
+    MirrorHasNoHTTPURL: This mirror may not be set as a country mirror as it
+      does not have an HTTP URL set.
+    >>> logout()

=== modified file 'lib/lp/registry/interfaces/distribution.py'
--- lib/lp/registry/interfaces/distribution.py	2010-03-24 21:59:58 +0000
+++ lib/lp/registry/interfaces/distribution.py	2010-03-31 15:03:35 +0000
@@ -25,7 +25,7 @@
 
 from lazr.restful.fields import CollectionField, Reference
 from lazr.restful.declarations import (
-   collection_default_content, export_as_webservice_collection,
+   collection_default_content, copy_field, export_as_webservice_collection,
    export_as_webservice_entry, export_operation_as,
    export_read_operation, exported, operation_parameters,
    operation_returns_collection_of, operation_returns_entry,
@@ -321,6 +321,14 @@
         if it's not found.
         """
 
+    @operation_parameters(
+        country=copy_field(IDistributionMirror['country'], required=True),
+        mirror_type=copy_field(IDistributionMirror['content'], required=True))
+    @operation_returns_entry(IDistributionMirror)
+    @export_read_operation()
+    def getCountryMirror(country, mirror_type):
+        """Return the country DNS mirror for a country and content type."""
+
     def newMirror(owner, speed, country, content, displayname=None,
                   description=None, http_base_url=None,
                   ftp_base_url=None, rsync_base_url=None, enabled=False,

=== modified file 'lib/lp/registry/interfaces/distributionmirror.py'
--- lib/lp/registry/interfaces/distributionmirror.py	2010-02-22 15:50:06 +0000
+++ lib/lp/registry/interfaces/distributionmirror.py	2010-03-31 15:03:35 +0000
@@ -6,21 +6,24 @@
 __metaclass__ = type
 
 __all__ = [
-'IDistributionMirror',
-'IDistributionMirrorAdminRestricted',
-'IDistributionMirrorEditRestricted',
-'IDistributionMirrorPublic',
-'IMirrorDistroArchSeries',
-'IMirrorDistroSeriesSource',
-'IMirrorProbeRecord',
-'IDistributionMirrorSet',
-'IMirrorCDImageDistroSeries',
-'PROBE_INTERVAL',
-'UnableToFetchCDImageFileList',
-'MirrorContent',
-'MirrorFreshness',
-'MirrorSpeed',
-'MirrorStatus']
+    'CannotTransitionToCountryMirror',
+    'CountryMirrorAlreadySet',
+    'IDistributionMirror',
+    'IMirrorDistroArchSeries',
+    'IMirrorDistroSeriesSource',
+    'IMirrorProbeRecord',
+    'IDistributionMirrorSet',
+    'IMirrorCDImageDistroSeries',
+    'PROBE_INTERVAL',
+    'MirrorContent',
+    'MirrorFreshness',
+    'MirrorHasNoHTTPURL',
+    'MirrorNotOfficial',
+    'MirrorNotProbed',
+    'MirrorSpeed',
+    'MirrorStatus',
+    'UnableToFetchCDImageFileList',
+    ]
 
 from cgi import escape
 
@@ -31,8 +34,11 @@
 from zope.component import getUtility
 from lazr.enum import DBEnumeratedType, DBItem
 from lazr.restful.declarations import (
-    export_as_webservice_entry, export_read_operation, exported)
+    export_as_webservice_entry, export_read_operation,
+    export_write_operation, exported, mutator_for, operation_parameters,
+    webservice_error)
 from lazr.restful.fields import Reference, ReferenceChoice
+from lazr.restful.interface import copy_field
 
 from canonical.launchpad import _
 from canonical.launchpad.fields import (
@@ -47,6 +53,43 @@
 PROBE_INTERVAL = 23
 
 
+class CannotTransitionToCountryMirror(Exception):
+    """Root exception for transitions to country mirrors."""
+    webservice_error(400)
+
+
+class CountryMirrorAlreadySet(CannotTransitionToCountryMirror):
+    """Distribution mirror cannot be set as a country mirror.
+
+    Raised when a user tries to change set a distribution mirror as a country
+    mirror, however there is already one set for that country.
+    """
+
+
+class MirrorNotOfficial(CannotTransitionToCountryMirror):
+    """Distribution mirror is not permitted to become a country mirror.
+
+    Raised when a user tries to change set a distribution mirror as a country
+    mirror, however the mirror in question is not official.
+    """
+
+
+class MirrorHasNoHTTPURL(CannotTransitionToCountryMirror):
+    """Distribution mirror has no HTTP URL.
+
+    Raised when a user tries to make an official mirror a country mirror,
+    however the mirror has not HTTP URL set.
+    """
+
+
+class MirrorNotProbed(CannotTransitionToCountryMirror):
+    """Distribution mirror has not been probed.
+
+    Raised when a user tries to set an official mirror as a country mirror,
+    however the mirror has not been probed yet.
+    """
+
+
 class MirrorContent(DBEnumeratedType):
     """The content that is mirrored."""
 
@@ -284,33 +327,10 @@
     def getMirrorByURI(self, url):
         return getUtility(IDistributionMirrorSet).getByRsyncUrl(url)
 
-class IDistributionMirrorAdminRestricted(Interface):
-    """IDistributionMirror properties requiring launchpad.Admin permission."""
-
-    reviewer = exported(PublicPersonChoice(
-        title=_('Reviewer'), required=False, readonly=True,
-        vocabulary='ValidPersonOrTeam', description=_(
-            "The person who last reviewed this mirror.")))
-    date_reviewed = exported(Datetime(
-        title=_('Date reviewed'), required=False, readonly=True,
-        description=_(
-            "The date on which this mirror was last reviewed by a mirror admin.")))
-
-
-class IDistributionMirrorEditRestricted(Interface):
-    """IDistributionMirror properties requiring launchpad.Edit permission."""
-    
-    official_candidate = exported(Bool(
-        title=_('Apply to be an official mirror of this distribution'),
-        required=False, readonly=False, default=True))
-    whiteboard = exported(Whiteboard(
-        title=_('Whiteboard'), required=False, readonly=False,
-        description=_("Notes on the current status of the mirror (only "
-                      "visible to admins and the mirror's registrant).")))
-
-
-class IDistributionMirrorPublic(Interface):
-    """Public IDistributionMirror properties."""
+
+class IDistributionMirror(Interface):
+    """A mirror of a given distribution."""
+    export_as_webservice_entry()
 
     id = Int(title=_('The unique id'), required=True, readonly=True)
     owner = exported(PublicPersonChoice(
@@ -386,6 +406,39 @@
     date_created = exported(Datetime(
         title=_('Date Created'), required=True, readonly=True,
         description=_("The date on which this mirror was registered.")))
+    country_dns_mirror = exported(Bool(
+        title=_('Country DNS Mirror'),
+        description=_('Whether this is a country mirror in DNS.'),
+        required=False, readonly=True, default=False))
+
+    reviewer = exported(PublicPersonChoice(
+        title=_('Reviewer'), required=False, readonly=True,
+        vocabulary='ValidPersonOrTeam', description=_(
+            "The person who last reviewed this mirror.")))
+    date_reviewed = exported(Datetime(
+        title=_('Date reviewed'), required=False, readonly=True,
+        description=_(
+            "The date on which this mirror was last reviewed by a mirror "
+            "admin.")))
+
+    official_candidate = exported(Bool(
+        title=_('Apply to be an official mirror of this distribution'),
+        required=False, readonly=False, default=True))
+    whiteboard = exported(Whiteboard(
+        title=_('Whiteboard'), required=False, readonly=False,
+        description=_("Notes on the current status of the mirror (only "
+                      "visible to admins and the mirror's registrant).")))
+
+    @export_read_operation()
+    def canTransitionToCountryMirror():
+        """Verify if a mirror can be set as a country mirror or return
+        False."""
+
+    @mutator_for(country_dns_mirror)
+    @operation_parameters(country_dns_mirror=copy_field(country_dns_mirror))
+    @export_write_operation()
+    def transitionToCountryMirror(country_dns_mirror):
+       """Method run on changing country_dns_mirror."""
 
     @invariant
     def mirrorMustHaveHTTPOrFTPURL(mirror):
@@ -521,10 +574,6 @@
         Sources.gz file refer to and the path to the file itself.
         """
 
-class IDistributionMirror(IDistributionMirrorAdminRestricted,
-        IDistributionMirrorEditRestricted, IDistributionMirrorPublic):
-    """A mirror of a given distribution."""
-    export_as_webservice_entry()
 
 
 class UnableToFetchCDImageFileList(Exception):

=== modified file 'lib/lp/registry/model/distribution.py'
--- lib/lp/registry/model/distribution.py	2010-03-24 02:53:42 +0000
+++ lib/lp/registry/model/distribution.py	2010-03-31 15:03:35 +0000
@@ -402,6 +402,17 @@
         """See `IDistribution`."""
         return DistributionMirror.selectOneBy(distribution=self, name=name)
 
+    def getCountryMirror(self, country, mirror_type):
+        """See `IDistribution`."""
+        store = Store.of(self)
+        results = store.find(
+            DistributionMirror,
+            DistributionMirror.distribution == self,
+            DistributionMirror.country == country,
+            DistributionMirror.content == mirror_type,
+            DistributionMirror.country_dns_mirror == True)
+        return results.one()
+
     def newMirror(self, owner, speed, country, content, displayname=None,
                   description=None, http_base_url=None,
                   ftp_base_url=None, rsync_base_url=None,

=== modified file 'lib/lp/registry/model/distributionmirror.py'
--- lib/lp/registry/model/distributionmirror.py	2010-03-23 20:42:23 +0000
+++ lib/lp/registry/model/distributionmirror.py	2010-03-31 15:03:35 +0000
@@ -45,9 +45,11 @@
 from canonical.launchpad.interfaces.launchpad import ILaunchpadCelebrities
 from lp.soyuz.interfaces.publishing import PackagePublishingStatus
 from lp.registry.interfaces.distributionmirror import (
+    CannotTransitionToCountryMirror, CountryMirrorAlreadySet,
     IDistributionMirror, IDistributionMirrorSet, IMirrorCDImageDistroSeries,
     IMirrorDistroArchSeries, IMirrorDistroSeriesSource, IMirrorProbeRecord,
-    MirrorContent, MirrorFreshness, MirrorSpeed, MirrorStatus, PROBE_INTERVAL)
+    MirrorContent, MirrorFreshness, MirrorHasNoHTTPURL, MirrorNotOfficial,
+    MirrorNotProbed, MirrorSpeed, MirrorStatus, PROBE_INTERVAL)
 from lp.registry.interfaces.distroseries import IDistroSeries
 from lp.registry.interfaces.sourcepackage import SourcePackageFileType
 from canonical.launchpad.mail import simple_sendmail, format_address
@@ -100,6 +102,8 @@
     date_reviewed = UtcDateTimeCol(default=None)
     whiteboard = StringCol(
         notNull=False, default=None)
+    country_dns_mirror = BoolCol(
+        notNull=True, default=False)
 
     @property
     def base_url(self):
@@ -145,6 +149,64 @@
             "This mirror has been probed and thus can't be removed.")
         SQLBase.destroySelf(self)
 
+    def verifyTransitionToCountryMirror(self):
+        """Verify that a mirror can be set as a country mirror.
+
+        Return True if valid, otherwise raise a subclass of
+        CannotTransitionToCountryMirror.
+        """
+
+        current_country_mirror = self.distribution.getCountryMirror(
+            self.country, self.content)
+
+        if current_country_mirror is not None:
+            # Country already has a country mirror.
+            raise CountryMirrorAlreadySet(
+                "%s already has a country %s mirror set." % (
+                    self.country.name, self.content))
+
+        if not self.isOfficial():
+            # Only official mirrors may be set as country mirrors.
+            raise MirrorNotOfficial(
+                "This mirror may not be set as a country mirror as it is not "
+                "an official mirror.")
+
+        if self.http_base_url is None:
+            # Country mirrors must have HTTP URLs set.
+            raise MirrorHasNoHTTPURL(
+                "This mirror may not be set as a country mirror as it does "
+                "not have an HTTP URL set.")
+
+        if not self.last_probe_record:
+            # Only mirrors which have been probed may be set as country
+            # mirrors.
+            raise MirrorNotProbed(
+                "This mirror may not be set as a country mirror as it has "
+                "not been probed.")
+
+        # Verification done.
+        return True
+
+    def canTransitionToCountryMirror(self):
+        """See `IDistributionMirror`."""
+        try:
+            return self.verifyTransitionToCountryMirror()
+        except CannotTransitionToCountryMirror:
+            return False
+
+    def transitionToCountryMirror(self, country_dns_mirror):
+        """See `IDistributionMirror`."""
+
+        # country_dns_mirror has not been changed, do nothing.
+        if self.country_dns_mirror == country_dns_mirror:
+            return
+
+        # Environment sanity checks.
+        if country_dns_mirror:
+            self.verifyTransitionToCountryMirror()
+
+        self.country_dns_mirror = country_dns_mirror
+
     def getOverallFreshness(self):
         """See IDistributionMirror"""
         # XXX Guilherme Salgado 2006-08-16:

=== modified file 'lib/lp/registry/stories/distributionmirror/xx-distribution-mirrors.txt'
--- lib/lp/registry/stories/distributionmirror/xx-distribution-mirrors.txt	2009-12-10 23:32:13 +0000
+++ lib/lp/registry/stories/distributionmirror/xx-distribution-mirrors.txt	2010-03-31 15:03:35 +0000
@@ -40,13 +40,14 @@
     >>> print browser.title
     Mirrors of Ubuntu Linux...
     >>> print_mirrors_by_countries(browser.contents)
-    Antarctica:
-      [(u'Archive-mirror2',    u'http', u'128 Kbps', u'Six hours behind')]
+    Antarctica: [(u'Archive-mirror2', u'http', u'128 Kbps',
+      u'Six hours behind')]
     France:
       [(u'Archive-404-mirror', u'http', u'512 Kbps', u'Last update unknown'),
-       (u'Archive-mirror',     u'http', u'128 Kbps', u'Last update unknown')]
-    United Kingdom:
-      [(u'Canonical-archive',  u'http', u'100 Mbps', u'Last update unknown')]
+       (u'Archive-mirror', u'http', u'128 Kbps', u'Last update unknown')]
+    United Kingdom: [(u'Canonical-archive', u'http', u'100 Mbps',
+      u'Last update unknown')]
+
     >>> find_tags_by_class(browser.contents, 'distromirrorstatusSIXHOURSBEHIND')
     [<span class="distromirrorstatusSIXHOURSBEHIND">Six hours behind</span>]
     >>> find_tags_by_class(browser.contents, 'distromirrorstatusUNKNOWN')[0]
@@ -59,13 +60,12 @@
     >>> browser.url
     'http://launchpad.dev/ubuntu/+cdmirrors'
     >>> print_mirrors_by_countries(browser.contents)
-    France:
-      [(u'Releases-mirror',    u'http', u'2 Mbps'),
+    France: 
+      [(u'Releases-mirror', u'http', u'2 Mbps'),
        (u'Unreachable-mirror', u'http', u'512 Kbps')]
-    Germany:
-      [(u'Releases-mirror2',   u'http', u'2 Mbps')]
-    United Kingdom:
-      [(u'Canonical-releases', u'http', u'100 Mbps')]
+    Germany: [(u'Releases-mirror2', u'http', u'2 Mbps')]
+    United Kingdom: [(u'Canonical-releases', u'http', u'100 Mbps')]
+
 
 === Disabled mirrors ===
 

=== modified file 'lib/lp/registry/stories/webservice/xx-distribution-mirror.txt'
--- lib/lp/registry/stories/webservice/xx-distribution-mirror.txt	2010-02-23 19:40:45 +0000
+++ lib/lp/registry/stories/webservice/xx-distribution-mirror.txt	2010-03-31 15:03:35 +0000
@@ -8,10 +8,12 @@
     >>> 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)
+    >>> canonical_archive = webservice.named_get(
+    ...     ubuntu['self_link'], 'getMirrorByName',
+    ...     name='canonical-archive').jsonBody()
+    >>> pprint_entry(canonical_archive)
     content: u'Archive'
+    country_dns_mirror: False
     country_link: u'http://.../+countries/GB'
     date_created: u'2006-10-16T18:31:43.434567+00:00'
     date_reviewed: None
@@ -39,6 +41,7 @@
     >>> canonical_releases_json = webservice.get(canonical_releases['self_link']).jsonBody()
     >>> pprint_entry(canonical_releases_json)
     content: u'CD Image'
+    country_dns_mirror: False
     country_link: u'http://.../+countries/GB'
     date_created: u'2006-10-16T18:31:43.434567+00:00'
     date_reviewed: None
@@ -73,12 +76,12 @@
     >>> karl_db = getUtility(IPersonSet).getByName('karl')
     >>> test_db = getUtility(IPersonSet).getByName('name12')
     >>> no_priv_db = getUtility(IPersonSet).getByName('no-priv')
-    >>> karl_webservice = webservice_for_person(karl_db,
-    ...     permission=OAuthPermission.WRITE_PUBLIC)
-    >>> test_webservice = webservice_for_person(test_db,
-    ...     permission=OAuthPermission.WRITE_PUBLIC)
-    >>> no_priv_webservice = webservice_for_person(no_priv_db,
-    ...     permission=OAuthPermission.READ_PUBLIC)
+    >>> karl_webservice = webservice_for_person(
+    ...     karl_db, permission=OAuthPermission.WRITE_PUBLIC)
+    >>> test_webservice = webservice_for_person(
+    ...     test_db, permission=OAuthPermission.WRITE_PUBLIC)
+    >>> no_priv_webservice = webservice_for_person(
+    ...     no_priv_db, permission=OAuthPermission.READ_PUBLIC)
     >>> logout()
 
 Ensure that anonymous API sessions can view mirror listings; archive/releases.
@@ -97,7 +100,9 @@
 
 One must have special permissions to access certain attributes:
 
-    >>> archive_404_mirror = ubuntu_archive_mirrors['entries'][1]
+    >>> archive_404_mirror = webservice.named_get(
+    ...     ubuntu['self_link'], 'getMirrorByName',
+    ...     name="archive-404-mirror").jsonBody()
     >>> response = no_priv_webservice.get(
     ...     archive_404_mirror['self_link']).jsonBody()
     >>> pprint_entry(response)
@@ -128,6 +133,7 @@
     ...     archive_404_mirror['self_link']).jsonBody()
     >>> pprint_entry(response)
     content: u'Archive'
+    country_dns_mirror: False
     country_link: u'http://.../+countries/FR'
     date_created: u'2006-10-16T18:31:43.438573+00:00'
     date_reviewed: None
@@ -209,6 +215,7 @@
     ...     canonical_releases['self_link'], 'application/json', dumps(patch)).jsonBody()
     >>> pprint_entry(response)
     content: u'CD Image'
+    country_dns_mirror: False
     country_link: u'http://.../+countries/GL'
     date_created: u'2006-10-16T18:31:43.434567+00:00'
     date_reviewed: None
@@ -244,7 +251,9 @@
 "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]
+    >>> releases_mirror2 = webservice.named_get(
+    ...     ubuntu['self_link'], 'getMirrorByName',
+    ...     name='releases-mirror2').jsonBody()
     >>> freshness = webservice.named_get(releases_mirror2['self_link'],
     ...     'getOverallFreshness').jsonBody()
     >>> print freshness

=== modified file 'lib/lp/registry/stories/webservice/xx-distribution.txt'
--- lib/lp/registry/stories/webservice/xx-distribution.txt	2010-02-23 17:36:27 +0000
+++ lib/lp/registry/stories/webservice/xx-distribution.txt	2010-03-31 15:03:35 +0000
@@ -123,6 +123,7 @@
     ...     name='canonical-releases').jsonBody()
     >>> pprint_entry(canonical_releases)
     content: u'CD Image'
+    country_dns_mirror: False
     country_link: u'http://.../+countries/GB'
     date_created: u'2006-10-16T18:31:43.434567+00:00'
     date_reviewed: None
@@ -142,3 +143,76 @@
     speed: u'100 Mbps'
     status: u'Official'
     whiteboard: None
+
+"getCountryMirror" returns the country DNS mirror for a given country;
+returning None if there isn't one.
+
+    >>> # Prepare stuff.
+    >>> from lp.registry.interfaces.distribution import IDistributionSet
+    >>> from zope.component import getUtility
+    >>> from canonical.launchpad.testing.pages import webservice_for_person
+    >>> from canonical.launchpad.webapp.interfaces import OAuthPermission
+    >>> from lp.registry.interfaces.person import IPersonSet
+    >>> from simplejson import dumps
+
+    >>> login('[e-mail]')
+    >>> ubuntu_distro = getUtility(IDistributionSet).getByName('ubuntu')
+    >>> showa_station = factory.makeMirror(ubuntu_distro,
+    ...     "Showa Station", country=9,
+    ...     http_url="http://mirror.showa.antarctica.org/ubuntu",
+    ...     official_candidate=True)
+    >>> showa_station_log = factory.makeMirrorProbeRecord(showa_station)
+    >>> logout()
+
+    >>> login(ANONYMOUS)
+    >>> karl_db = getUtility(IPersonSet).getByName('karl')
+    >>> karl_webservice = webservice_for_person(karl_db,
+    ...     permission=OAuthPermission.WRITE_PUBLIC)
+    >>> logout()
+
+    >>> # Mark new mirror as official and a country mirror.
+    >>> patch = {
+    ...     u'status': 'Official',
+    ...     u'country_dns_mirror': True
+    ... }
+
+    >>> antarctica_patch_target = webservice.named_get(
+    ...     ubuntu['self_link'], 'getMirrorByName',
+    ...     name='mirror.showa.antarctica.org-archive').jsonBody()
+    ... )
+
+    >>> response = karl_webservice.patch(
+    ...     antarctica_patch_target['self_link'], 'application/json',
+    ...     dumps(patch))
+
+    >>> antarctica = webservice.get("/+countries/AQ").jsonBody()
+    >>> antarctica_country_mirror_archive = webservice.named_get(
+    ...     ubuntu['self_link'], 'getCountryMirror',
+    ...     country=antarctica['self_link'],
+    ...     mirror_type="Archive").jsonBody()
+    >>> pprint_entry(antarctica_country_mirror_archive)
+    content: u'Archive'
+    country_dns_mirror: True
+    country_link: u'http://.../+countries/AQ'
+    ...
+
+    >>> uk = webservice.get("/+countries/GB").jsonBody()
+    >>> uk_country_mirror_archive = webservice.named_get(
+    ...     ubuntu['self_link'], 'getCountryMirror',
+    ...     country=uk['self_link'],
+    ...     mirror_type="Archive")
+    >>> print uk_country_mirror_archive.jsonBody()
+    None
+
+For "getCountryMirror", the mirror_type parameter must be "Archive" or
+"CD Images":
+
+    >>> uk_country_mirror_archive = webservice.named_get(
+    ...     ubuntu['self_link'], 'getCountryMirror',
+    ...     country=uk['self_link'],
+    ...     mirror_type="Bogus")
+    >>> print uk_country_mirror_archive.jsonBody()
+    Traceback (most recent call last):
+    ...
+    ValueError: mirror_type: Invalid value "Bogus". Acceptable values are:
+      Archive, CD Image

=== modified file 'lib/lp/registry/tests/test_distributionmirror.py'
--- lib/lp/registry/tests/test_distributionmirror.py	2009-10-26 18:40:04 +0000
+++ lib/lp/registry/tests/test_distributionmirror.py	2010-03-31 15:03:35 +0000
@@ -3,7 +3,6 @@
 
 __metaclass__ = type
 
-from StringIO import StringIO
 import unittest
 
 import transaction
@@ -17,19 +16,19 @@
 from lp.registry.interfaces.distributionmirror import (
     IDistributionMirrorSet, MirrorContent, MirrorFreshness)
 from canonical.launchpad.interfaces.launchpad import ILaunchpadCelebrities
-from canonical.launchpad.interfaces.librarian import ILibraryFileAliasSet
 from lp.registry.interfaces.pocket import PackagePublishingPocket
 from lp.registry.interfaces.distribution import IDistributionSet
 from lp.services.mail import stub
+from lp.testing.factory import LaunchpadObjectFactory
 
 from canonical.testing import LaunchpadFunctionalLayer
 
-
 class TestDistributionMirror(unittest.TestCase):
     layer = LaunchpadFunctionalLayer
 
     def setUp(self):
         login('[e-mail]')
+        self.factory = LaunchpadObjectFactory()
         mirrorset = getUtility(IDistributionMirrorSet)
         self.cdimage_mirror = getUtility(IDistributionMirrorSet).getByName(
             'releases-mirror')
@@ -132,15 +131,6 @@
             self.archive_mirror.getOverallFreshness(),
             MirrorFreshness.TWODAYSBEHIND)
 
-    def _create_probe_record(self, mirror):
-        log_file = StringIO()
-        log_file.write("Fake probe, nothing useful here.")
-        log_file.seek(0)
-        library_alias = getUtility(ILibraryFileAliasSet).create(
-            name='foo', size=len(log_file.getvalue()),
-            file=log_file, contentType='text/plain')
-        proberecord = mirror.newProbeRecord(library_alias)
-
     def test_disabling_mirror_and_notifying_owner(self):
         login('[e-mail]')
 
@@ -148,7 +138,7 @@
         # If a mirror has been probed only once, the owner will always be
         # notified when it's disabled --it doesn't matter whether it was
         # previously enabled or disabled.
-        self._create_probe_record(mirror)
+        self.factory.makeMirrorProbeRecord(mirror)
         self.failUnless(mirror.enabled)
         log = 'Got a 404 on http://foo/baz'
         mirror.disable(notify_owner=True, log=log)
@@ -166,7 +156,7 @@
 
         # For mirrors that have been probed more than once, we'll only notify
         # the owner if the mirror was previously enabled.
-        self._create_probe_record(mirror)
+        self.factory.makeMirrorProbeRecord(mirror)
         mirror.enabled = True
         mirror.disable(notify_owner=True, log=log)
         # A notification was sent to the owner and other to the mirror admins.

=== modified file 'lib/lp/testing/factory.py'
--- lib/lp/testing/factory.py	2010-03-25 02:21:15 +0000
+++ lib/lp/testing/factory.py	2010-03-31 15:03:35 +0000
@@ -1981,8 +1981,22 @@
         team_list = self.makeMailingList(team, owner)
         return team, team_list
 
+    def makeMirrorProbeRecord(self, mirror):
+        """Create a probe record for a mirror of a distribution."""
+        log_file = StringIO()
+        log_file.write("Fake probe, nothing useful here.")
+        log_file.seek(0)
+
+        library_alias = getUtility(ILibraryFileAliasSet).create(
+            name='foo', size=len(log_file.getvalue()),
+            file=log_file, contentType='text/plain')
+
+        proberecord = mirror.newProbeRecord(library_alias)
+        return proberecord
+
     def makeMirror(self, distribution, displayname, country=None,
-                   http_url=None, ftp_url=None, rsync_url=None):
+                   http_url=None, ftp_url=None, rsync_url=None,
+                   official_candidate=False):
         """Create a mirror for the distribution."""
         # If no URL is specified create an HTTP URL.
         if http_url is None and ftp_url is None and rsync_url is None:
@@ -2001,7 +2015,7 @@
             http_base_url=http_url,
             ftp_base_url=ftp_url,
             rsync_base_url=rsync_url,
-            official_candidate=False)
+            official_candidate=official_candidate)
         return mirror
 
     def makeUniqueRFC822MsgId(self):