Merge lp:~allenap/launchpad/initseries-for-one-night-only-bug-793620 into lp:launchpad

[Gavin Panella]

[r=julian-edwards][bug=793620] Show a message on DistroSeries:+initseries, and prevent attempts to use the page, when the distroseries is in the process of being initialized or when the distroseries has already been initialized.

Show a message on +initseries, and prevent attempts to use the page,
when the distroseries is in the process of being derived or when the
distroseries has already been derived.

[Steve Kowalik (stevenk)]

I think you're conflating things were they don't need to be. For +initseries, you only really care if the distroseries has been initialised, not if it is a derived series.

The with featureflag(): section reads as a little messy -- I thought we had FeatureFixture for that which makes it easier?

Thank you for cleaning up the imports, but I don't think you can import DSDJ from lp.soyuz.model? Or if you can, why are you importing the whole module?

review: Needs Fixing (code)

[Gavin Panella (allenap)]

Thanks for the review!

> I think you're conflating things were they don't need to be. For
> +initseries, you only really care if the distroseries has been
> initialised, not if it is a derived series.

I have completely lost track of what this all means.

DistroSeries.is_derived_series checked if there are any DSPs, which
are, iirc, created by InitializeDistroSeries. As I understand it, they
are a marker that the distroseries has been initialized, that it is
now a derived distroseries. If initializing and deriving are very
different things that I'm conflating then I pity the users!

> The with featureflag(): section reads as a little messy -- I thought
> we had FeatureFixture for that which makes it easier?

I cargocult-n-pasted that. I've changed it to use FeatureFixture().

> Thank you for cleaning up the imports, but I don't think you can import DSDJ
> from lp.soyuz.model? Or if you can, why are you importing the whole module?

I didn't clean up the imports, utilities/format-imports took care of
that (by way of utilities/format-new-and-modified-imports). The
machine overlord has made its decision.

[Gavin Panella (allenap)]

Okay, Julian explained it to me. The follow-up is quite large, so I'll
explain what I've done:

- Introduced a new matched, EqualsIgnoringWhitespace. Yes, there are
  other ways to do this, but this seems to be a common test that was
  worth cementing. I suppose DocTestMatches is the closest thing to
  it, but this is simpler to grok.

- Removes DistroSeries.is_initialising. As Julian pointed out, this
  hits the database so would be better as a method...

- Introduce DistroSeries.isInitializing() and .isInitialized(). The
  former replaces .is_initialising and the latter reports if there are
  any published sources in the series' main archive.

- These are then used in the +initseries template.

- I also fixed some lint and imports.

[Jonathan Lange (jml)]

`EqualsIgnoringWhitespace` could be written as:

  EqualsIgnoringWhitespace = lambda s: AfterPreprocessing(normalize_whitespace, Equals(s))

This wouldn't have the (str, unicode) type guard, but I'm not really sure that adds much anyway.

[Gavin Panella (allenap)]

I hadn't seen AfterPreprocessing before, neat :)

However, AfterPreprocessing only processes the matchee, not the
matcher, so that lambda doesn't ignore whitespace in the same way as
EqualsIgnoringWhitespace does. In that respect I think
EqualsIgnoringWhitespace is less surprising.

Having said that, EqualsIgnoringWhitespace doesn't actually *ignore*
whitespace, it just treats any run of whitespace as equal in matcher
and matchee. It's misnamed, but I don't think people are going to be
surprised by its behaviour anyway.

The reason for the (str, unicode) guard is so that the assertion
doesn't fail with an AttributeError (i.e. '...' object has no
attribute 'split') when the matcher or, more significantly, the
matchee are None or some other unexpected result.

[Jonathan Lange (jml)]

On Thu, Jun 9, 2011 at 3:43 PM, Gavin Panella
<email address hidden> wrote:
> I hadn't seen AfterPreprocessing before, neat :)
>
> However, AfterPreprocessing only processes the matchee, not the
> matcher, so that lambda doesn't ignore whitespace in the same way as
> EqualsIgnoringWhitespace does. In that respect I think
> EqualsIgnoringWhitespace is less surprising.
>

Ahh, OK. I guess testtools could use a combinator like
AfterPreprocessing that maps both the matcher and the matchee.
Shouldn't have to write a class to do this.

jml

[Julian Edwards (julian-edwards)]

Lovely!

review: Approve

=== modified file 'lib/lp/registry/browser/distroseries.py'
--- lib/lp/registry/browser/distroseries.py	2011-06-09 10:34:37 +0000
+++ lib/lp/registry/browser/distroseries.py	2011-06-10 15:18:35 +0000
@@ -647,6 +647,29 @@
         return getFeatureFlag("soyuz.derived_series_ui.enabled") is not None
 
     @property
+    def show_derivation_not_yet_available(self):
+        return not self.is_derived_series_feature_enabled
+
+    @property
+    def show_derivation_form(self):
+        return (
+            self.is_derived_series_feature_enabled and
+            not self.context.isInitializing() and
+            not self.context.isInitialized())
+
+    @property
+    def show_already_initialized_message(self):
+        return (
+            self.is_derived_series_feature_enabled and
+            self.context.isInitialized())
+
+    @property
+    def show_already_initializing_message(self):
+        return (
+            self.is_derived_series_feature_enabled and
+            self.context.isInitializing())
+
+    @property
     def rebuilding_allowed(self):
         """If the distribution has got any initialized series already,
         rebuilding is not allowed.
 
=== modified file 'lib/lp/registry/browser/tests/test_distroseries.py'
--- lib/lp/registry/browser/tests/test_distroseries.py	2011-06-09 10:34:37 +0000
+++ lib/lp/registry/browser/tests/test_distroseries.py	2011-06-10 15:18:35 +0000
@@ -40,11 +40,11 @@
     LaunchpadFunctionalLayer,
     LaunchpadZopelessLayer,
     )
+from lp.app.interfaces.launchpad import ILaunchpadCelebrities
 from lp.archivepublisher.debversion import Version
-from lp.app.interfaces.launchpad import ILaunchpadCelebrities
 from lp.registry.browser.distroseries import (
+    HIGHER_VERSION_THAN_PARENT,
     IGNORED,
-    HIGHER_VERSION_THAN_PARENT,
     NON_IGNORED,
     RESOLVED,
     )
@@ -73,22 +73,23 @@
 from lp.soyuz.interfaces.sourcepackageformat import (
     ISourcePackageFormatSelectionSet,
     )
+from lp.soyuz.model import distroseriesdifferencejob
 from lp.soyuz.model.archivepermission import ArchivePermission
 from lp.soyuz.model.packagecopyjob import PlainPackageCopyJob
-from lp.soyuz.model import distroseriesdifferencejob
 from lp.testing import (
     anonymous_logged_in,
     celebrity_logged_in,
-    feature_flags,
     login_person,
     person_logged_in,
-    set_feature_flag,
     StormStatementRecorder,
     TestCaseWithFactory,
     with_celebrity_logged_in,
     )
 from lp.testing.fakemethod import FakeMethod
-from lp.testing.matchers import HasQueryCount
+from lp.testing.matchers import (
+    EqualsIgnoringWhitespace,
+    HasQueryCount,
+    )
 from lp.testing.views import create_initialized_view
 
 
@@ -324,7 +325,7 @@
             view.request.features = get_relevant_feature_controller()
             html_content = view()
 
-        self.assertTrue(derived_series.is_initialising)
+        self.assertTrue(derived_series.isInitializing())
         self.assertThat(html_content, portlet_display)
 
 
@@ -417,17 +418,17 @@
         # the soyuz.derived_series_ui.enabled flag.
         distroseries = self.factory.makeDistroSeries()
         view = create_initialized_view(distroseries, "+initseries")
-        with feature_flags():
+        with FeatureFixture({}):
             self.assertFalse(view.is_derived_series_feature_enabled)
-        with feature_flags():
-            set_feature_flag(u"soyuz.derived_series_ui.enabled", u"true")
+        flags = {u"soyuz.derived_series_ui.enabled": u"true"}
+        with FeatureFixture(flags):
             self.assertTrue(view.is_derived_series_feature_enabled)
 
     def test_form_hidden_when_derived_series_feature_disabled(self):
         # The form is hidden when the feature flag is not set.
         distroseries = self.factory.makeDistroSeries()
         view = create_initialized_view(distroseries, "+initseries")
-        with feature_flags():
+        with FeatureFixture({}):
             root = html.fromstring(view())
             self.assertEqual(
                 [], root.cssselect("#initseries-form-container"))
@@ -441,8 +442,8 @@
         # The form is shown when the feature flag is set.
         distroseries = self.factory.makeDistroSeries()
         view = create_initialized_view(distroseries, "+initseries")
-        with feature_flags():
-            set_feature_flag(u"soyuz.derived_series_ui.enabled", u"true")
+        flags = {u"soyuz.derived_series_ui.enabled": u"true"}
+        with FeatureFixture(flags):
             root = html.fromstring(view())
             self.assertNotEqual(
                 [], root.cssselect("#initseries-form-container"))
@@ -462,7 +463,6 @@
         self.factory.makeDistroSeries(
             distribution=distroseries.distribution)
         view = create_initialized_view(distroseries, "+initseries")
-
         self.assertTrue(view.rebuilding_allowed)
 
     def test_rebuilding_not_allowed(self):
@@ -473,9 +473,45 @@
         self.factory.makeSourcePackagePublishingHistory(
             distroseries=another_distroseries)
         view = create_initialized_view(distroseries, "+initseries")
-
         self.assertFalse(view.rebuilding_allowed)
 
+    def test_form_hidden_when_distroseries_is_initialized(self):
+        # The form is hidden when the feature flag is set but the series has
+        # already been initialized.
+        distroseries = self.factory.makeDistroSeries()
+        self.factory.makeSourcePackagePublishingHistory(
+            distroseries=distroseries, archive=distroseries.main_archive)
+        view = create_initialized_view(distroseries, "+initseries")
+        flags = {u"soyuz.derived_series_ui.enabled": u"true"}
+        with FeatureFixture(flags):
+            root = html.fromstring(view())
+            self.assertEqual(
+                [], root.cssselect("#initseries-form-container"))
+            # Instead an explanatory message is shown.
+            [message] = root.cssselect("p.error.message")
+            self.assertThat(
+                message.text, EqualsIgnoringWhitespace(
+                    u"This series already contains source packages "
+                    u"and cannot be initialized again."))
+
+    def test_form_hidden_when_distroseries_is_being_initialized(self):
+        # The form is hidden when the feature flag is set but the series has
+        # already been derived.
+        distroseries = self.factory.makeDistroSeries()
+        getUtility(IInitialiseDistroSeriesJobSource).create(
+            distroseries, [self.factory.makeDistroSeries().id])
+        view = create_initialized_view(distroseries, "+initseries")
+        flags = {u"soyuz.derived_series_ui.enabled": u"true"}
+        with FeatureFixture(flags):
+            root = html.fromstring(view())
+            self.assertEqual(
+                [], root.cssselect("#initseries-form-container"))
+            # Instead an explanatory message is shown.
+            [message] = root.cssselect("p.error.message")
+            self.assertThat(
+                message.text, EqualsIgnoringWhitespace(
+                    u"This series is already being initialized."))
+
 
 class DistroSeriesDifferenceMixin:
     """A helper class for testing differences pages"""
@@ -1701,7 +1737,7 @@
             person, sp_name)
         self._syncAndGetView(
             derived_series, person, [diff_id])
-        parent_pub = parent_series.main_archive.getPublishedSources(
+        parent_series.main_archive.getPublishedSources(
             name='my-src-name', version=versions['parent'],
             distroseries=parent_series).one()
 
 
=== modified file 'lib/lp/registry/interfaces/distroseries.py'
--- lib/lp/registry/interfaces/distroseries.py	2011-06-08 11:06:04 +0000
+++ lib/lp/registry/interfaces/distroseries.py	2011-06-10 15:18:35 +0000
@@ -213,7 +213,7 @@
             description=_("The version string for this series.")))
     distribution = exported(
         Reference(
-            Interface, # Really IDistribution, see circular import fix below.
+            Interface,  # Really IDistribution, see circular import fix below.
             title=_("Distribution"), required=True,
             description=_("The distribution for which this is a series.")))
     distributionID = Attribute('The distribution ID.')
@@ -239,16 +239,13 @@
     is_derived_series = Bool(
         title=u'Is this series a derived series?', readonly=True,
         description=(u"Whether or not this series is a derived series."))
-    is_initialising = Bool(
-        title=u'Is this series initialising?', readonly=True,
-        description=(u"Whether or not this series is initialising."))
     datereleased = exported(
         Datetime(title=_("Date released")))
     previous_series = exported(
         ReferenceChoice(
             title=_("Parent series"),
             description=_("The series from which this one was branched."),
-            required=True, schema=Interface, # Really IDistroSeries, see below
+            required=True, schema=Interface,  # Really IDistroSeries
             vocabulary='DistroSeries'),
         ("devel", dict(exported_as="previous_series")),
         ("1.0", dict(exported_as="parent_series")),
@@ -370,7 +367,7 @@
 
     main_archive = exported(
         Reference(
-            Interface, # Really IArchive, see below for circular import fix.
+            Interface,  # Really IArchive, see below for circular import fix.
             title=_('Distribution Main Archive')))
 
     supported = exported(
@@ -418,7 +415,7 @@
     architectures = exported(
         CollectionField(
             title=_("All architectures in this series."),
-            value_type=Reference(schema=Interface), # IDistroArchSeries.
+            value_type=Reference(schema=Interface),  # IDistroArchSeries.
             readonly=True))
 
     enabled_architectures = Attribute(
@@ -848,18 +845,18 @@
 
     @operation_parameters(
         parent_series=Reference(
-            schema=Interface, # IDistroSeries
+            schema=Interface,  # IDistroSeries
             title=_("The parent series to consider."),
             required=False),
         difference_type=Choice(
-            vocabulary=DBEnumeratedType, # DistroSeriesDifferenceType
+            vocabulary=DBEnumeratedType,  # DistroSeriesDifferenceType
             title=_("Only return differences of this type."), required=False),
         source_package_name_filter=TextLine(
             title=_("Only return differences for packages matching this "
                     "name."),
             required=False),
         status=Choice(
-            vocabulary=DBEnumeratedType, # DistroSeriesDifferenceStatus
+            vocabulary=DBEnumeratedType,  # DistroSeriesDifferenceStatus
             title=_("Only return differences of this status."),
             required=False),
         child_version_higher=Bool(
@@ -886,6 +883,12 @@
             child's version is higher than the parent's version.
         """
 
+    def isInitializing():
+        """Is this series initializing?"""
+
+    def isInitialized():
+        """Has this series been initialized?"""
+
 
 class IDistroSeriesEditRestricted(Interface):
     """IDistroSeries properties which require launchpad.Edit."""
@@ -1032,7 +1035,7 @@
 
 class DerivationError(Exception):
     """Raised when there is a problem deriving a distroseries."""
-    webservice_error(400) # Bad Request
+    webservice_error(400)  # Bad Request
     _message_prefix = "Error deriving distro series"
 
 
 
=== modified file 'lib/lp/registry/model/distroseries.py'
--- lib/lp/registry/model/distroseries.py	2011-06-08 15:27:40 +0000
+++ lib/lp/registry/model/distroseries.py	2011-06-10 15:18:35 +0000
@@ -802,13 +802,6 @@
         return not self.getParentSeries() == []
 
     @property
-    def is_initialising(self):
-        """See `IDistroSeries`."""
-        return not getUtility(
-            IInitialiseDistroSeriesJobSource).getPendingJobsForDistroseries(
-                self).is_empty()
-
-    @property
     def bugtargetname(self):
         """See IBugTarget."""
         # XXX mpt 2007-07-10 bugs 113258, 113262:
@@ -2037,6 +2030,17 @@
                 status=status,
                 child_version_higher=child_version_higher)
 
+    def isInitializing(self):
+        """See `IDistroSeries`."""
+        job_source = getUtility(IInitialiseDistroSeriesJobSource)
+        pending_jobs = job_source.getPendingJobsForDistroseries(self)
+        return not pending_jobs.is_empty()
+
+    def isInitialized(self):
+        """See `IDistroSeries`."""
+        published = self.main_archive.getPublishedSources(distroseries=self)
+        return not published.is_empty()
+
 
 class DistroSeriesSet:
     implements(IDistroSeriesSet)
 
=== modified file 'lib/lp/registry/templates/distroseries-index.pt'
--- lib/lp/registry/templates/distroseries-index.pt	2011-05-24 10:08:33 +0000
+++ lib/lp/registry/templates/distroseries-index.pt	2011-06-10 15:18:35 +0000
@@ -68,7 +68,8 @@
         <tal:derivation
           tal:condition="request/features/soyuz.derived_series_ui.enabled">
           <div class="yui-u"
-               tal:condition="python:context.is_derived_series or context.is_initialising">
+               tal:condition="python: context.is_derived_series or
+                              context.isInitializing()">
             <div tal:replace="structure context/@@+portlet-derivation" />
           </div>
         </tal:derivation>
 
=== modified file 'lib/lp/registry/templates/distroseries-initialize.pt'
--- lib/lp/registry/templates/distroseries-initialize.pt	2011-06-06 09:32:14 +0000
+++ lib/lp/registry/templates/distroseries-initialize.pt	2011-06-10 15:18:35 +0000
@@ -12,13 +12,13 @@
   </metal:head-epilogue>
   <body>
     <div metal:fill-slot="main">
-      <tal:enabled condition="view/is_derived_series_feature_enabled">
+
+      <tal:enabled condition="view/show_derivation_form">
       <div class="top-portlet">
         This page allows you to initialize a distribution series.
         <a href="/+help/init-series-title-help.html"
            target="help" class="sprite maybe">&nbsp;
           <span class="invisible-link">Initialization help</span></a>
-
       </div>
       <p class="error message javascript-disabled">
         Javascript is required to use this page. Please enable
@@ -42,7 +42,8 @@
         many thousands of packages is likely to take hours to complete.
       </p>
       </tal:enabled>
-      <tal:disabled condition="not:view/is_derived_series_feature_enabled">
+
+      <tal:disabled condition="view/show_derivation_not_yet_available">
       <p class="error message">
         The Derivative Distributions feature is under development
         and is not yet generally available. You can read more about
@@ -51,6 +52,21 @@
         page</a>.
       </p>
       </tal:disabled>
+
+      <tal:already-initialized condition="view/show_already_initialized_message">
+      <p class="error message">
+        This series already contains source packages and cannot be
+        initialized again.
+      </p>
+      </tal:already-initialized>
+
+      <tal:already-initializing
+          condition="view/show_already_initializing_message">
+      <p class="error message">
+        This series is already being initialized.
+      </p>
+      </tal:already-initializing>
+
     </div>
   </body>
 </html>
 
=== modified file 'lib/lp/registry/templates/distroseries-portlet-derivation.pt'
--- lib/lp/registry/templates/distroseries-portlet-derivation.pt	2011-05-31 11:55:38 +0000
+++ lib/lp/registry/templates/distroseries-portlet-derivation.pt	2011-06-10 15:18:35 +0000
@@ -5,7 +5,7 @@
   id="series-derivation" class="portlet"
   tal:define="overview_menu context/menu:overview">
   <tal:is_derived condition="context/is_derived_series">
-    <tal:is_initialised condition="not: context/is_initialising">
+    <tal:is_initialised condition="not: context/isInitializing">
     <tal:one_parent condition="view/has_unique_parent">
       <h2>Derived from <tal:name replace="view/unique_parent/displayname"/></h2>
     </tal:one_parent>
@@ -61,7 +61,7 @@
       </tal:diffs>
   </tal:is_initialised>
   </tal:is_derived>
-  <tal:is_initialising condition="context/is_initialising">
+  <tal:is_initialising condition="context/isInitializing">
     <h2>Series initialisation in progress</h2>
       This series is initialising.
   </tal:is_initialising>
 
=== modified file 'lib/lp/registry/tests/test_distroseries.py'
--- lib/lp/registry/tests/test_distroseries.py	2011-05-31 15:40:10 +0000
+++ lib/lp/registry/tests/test_distroseries.py	2011-06-10 15:18:35 +0000
@@ -222,22 +222,31 @@
         self.assertEquals(registrant, distroseries.registrant)
         self.assertNotEqual(distroseries.registrant, distroseries.owner)
 
-    def test_is_initialising(self):
-        # The series is_initialising only if there is an initialisation
-        # job with a pending status attached to this series.
+    def test_isInitializing(self):
+        # The series method isInitializing() returns True only if there is an
+        # initialisation job with a pending status attached to this series.
         distroseries = self.factory.makeDistroSeries()
         parent_distroseries = self.factory.makeDistroSeries()
-        self.assertEquals(False, distroseries.is_initialising)
+        self.assertFalse(distroseries.isInitializing())
         job_source = getUtility(IInitialiseDistroSeriesJobSource)
         job = job_source.create(distroseries, [parent_distroseries.id])
-        self.assertEquals(True, distroseries.is_initialising)
+        self.assertTrue(distroseries.isInitializing())
         job.start()
-        self.assertEquals(True, distroseries.is_initialising)
+        self.assertTrue(distroseries.isInitializing())
         job.queue()
-        self.assertEquals(True, distroseries.is_initialising)
+        self.assertTrue(distroseries.isInitializing())
         job.start()
         job.complete()
-        self.assertEquals(False, distroseries.is_initialising)
+        self.assertFalse(distroseries.isInitializing())
+
+    def test_isInitialized(self):
+        # The series method isInitialized() returns True once the series has
+        # been initialized.
+        distroseries = self.factory.makeDistroSeries()
+        self.assertFalse(distroseries.isInitialized())
+        self.factory.makeSourcePackagePublishingHistory(
+            distroseries=distroseries, archive=distroseries.main_archive)
+        self.assertTrue(distroseries.isInitialized())
 
 
 class TestDistroSeriesPackaging(TestCaseWithFactory):
 
=== modified file 'lib/lp/testing/__init__.py'
--- lib/lp/testing/__init__.py	2011-05-19 15:15:16 +0000
+++ lib/lp/testing/__init__.py	2011-06-10 15:18:35 +0000
@@ -163,7 +163,6 @@
     )
 from lp.testing.fixture import ZopeEventHandlerFixture
 from lp.testing.karma import KarmaRecorder
-from lp.testing.matchers import Provides
 from lp.testing.windmill import (
     constants,
     lpuser,
@@ -390,6 +389,7 @@
 
     def assertProvides(self, obj, interface):
         """Assert 'obj' correctly provides 'interface'."""
+        from lp.testing.matchers import Provides
         self.assertThat(obj, Provides(interface))
 
     def assertClassImplements(self, cls, interface):
 
=== modified file 'lib/lp/testing/matchers.py'
--- lib/lp/testing/matchers.py	2011-03-02 23:54:25 +0000
+++ lib/lp/testing/matchers.py	2011-06-10 15:18:35 +0000
@@ -8,6 +8,7 @@
     'DocTestMatches',
     'DoesNotCorrectlyProvide',
     'DoesNotProvide',
+    'EqualsIgnoringWhitespace',
     'HasQueryCount',
     'IsNotProxied',
     'IsProxied',
@@ -20,17 +21,17 @@
     ]
 
 from lazr.lifecycle.snapshot import Snapshot
+from testtools import matchers
 from testtools.content import Content
 from testtools.content_type import UTF8_TEXT
 from testtools.matchers import (
+    DocTestMatches as OriginalDocTestMatches,
     Equals,
-    DocTestMatches as OriginalDocTestMatches,
     LessThan,
     Matcher,
     Mismatch,
     MismatchesAll,
     )
-from testtools import matchers
 from zope.interface.exceptions import (
     BrokenImplementation,
     BrokenMethodImplementation,
@@ -44,6 +45,7 @@
 
 from canonical.launchpad.webapp import canonical_url
 from canonical.launchpad.webapp.batching import BatchNavigator
+from lp.testing import normalize_whitespace
 from lp.testing._login import person_logged_in
 from lp.testing._webservice import QueryCollector
 
@@ -290,7 +292,8 @@
 
         :param singular: The singular header the batch should be using.
         :param plural: The plural header the batch should be using.
-        :param batch_size: The batch size that should be configured by default.
+        :param batch_size: The batch size that should be configured by
+            default.
         """
         self._single = Equals(singular)
         self._plural = Equals(plural)
@@ -438,3 +441,21 @@
         text = widget.findAll(attrs={'class': 'yui3-activator-data-box'})[0]
         text_matcher = DocTestMatches(extract_text(text))
         return text_matcher.match(matchee)
+
+
+class EqualsIgnoringWhitespace(Equals):
+    """Compare equality, ignoring whitespace in strings.
+
+    Whitespace in strings is normalized before comparison. All other objects
+    are compared as they come.
+    """
+
+    def __init__(self, expected):
+        if isinstance(expected, (str, unicode)):
+            expected = normalize_whitespace(expected)
+        super(EqualsIgnoringWhitespace, self).__init__(expected)
+
+    def match(self, observed):
+        if isinstance(observed, (str, unicode)):
+            observed = normalize_whitespace(observed)
+        return super(EqualsIgnoringWhitespace, self).match(observed)
 
=== modified file 'lib/lp/testing/tests/test_matchers.py'
--- lib/lp/testing/tests/test_matchers.py	2011-02-25 07:15:06 +0000
+++ lib/lp/testing/tests/test_matchers.py	2011-06-10 15:18:35 +0000
@@ -29,6 +29,7 @@
     DoesNotContain,
     DoesNotCorrectlyProvide,
     DoesNotProvide,
+    EqualsIgnoringWhitespace,
     HasQueryCount,
     IsNotProxied,
     IsProxied,
@@ -274,3 +275,36 @@
         matcher = Contains("bar")
         mismatch = matcher.match("foo")
         self.assertEqual("bar", mismatch.expected)
+
+
+class EqualsIgnoringWhitespaceTests(TestCase):
+
+    def test_str(self):
+        matcher = EqualsIgnoringWhitespace("abc")
+        self.assertEqual("EqualsIgnoringWhitespace('abc')", str(matcher))
+
+    def test_match_str(self):
+        matcher = EqualsIgnoringWhitespace("one \t two \n three")
+        self.assertIs(None, matcher.match(" one \r two     three "))
+
+    def test_mismatch_str(self):
+        matcher = EqualsIgnoringWhitespace("one \t two \n three")
+        mismatch = matcher.match(" one \r three ")
+        self.assertEqual(
+            "'one two three' != 'one three'",
+            mismatch.describe())
+
+    def test_match_unicode(self):
+        matcher = EqualsIgnoringWhitespace(u"one \t two \n \u1234  ")
+        self.assertIs(None, matcher.match(u" one \r two     \u1234 "))
+
+    def test_mismatch_unicode(self):
+        matcher = EqualsIgnoringWhitespace(u"one \t two \n \u1234  ")
+        mismatch = matcher.match(u" one \r \u1234 ")
+        self.assertEqual(
+            u"u'one two \\u1234' != u'one \\u1234'",
+            mismatch.describe())
+
+    def test_match_non_string(self):
+        matcher = EqualsIgnoringWhitespace(1234)
+        self.assertIs(None, matcher.match(1234))