Merge lp:~jtv/maas/normalise-whitespace into lp:~maas-committers/maas/trunk

[Jeroen T. Vermeulen]

Unify implementations for normalising a string's whitespace.

This is something Gavin suggested while reviewing another branch.

Jeroen

[Julian Edwards (julian-edwards)]

 review: approve

review: Approve

=== modified file 'src/maasserver/views/tests/test_noderesult.py'
--- src/maasserver/views/tests/test_noderesult.py	2014-08-20 20:24:39 +0000
+++ src/maasserver/views/tests/test_noderesult.py	2014-09-01 03:04:59 +0000
@@ -27,14 +27,10 @@
 from maasserver.utils.orm import get_one
 from maasserver.views.noderesult import NodeCommissionResultListView
 from mock import Mock
+from provisioningserver.utils.text import normalise_whitespace
 from testtools.matchers import HasLength
 
 
-def normalise_whitespace(text):
-    """Replace any whitespace sequence with just a single space."""
-    return ' '.join(text.split())
-
-
 def extract_field(doc, field_name, containing_tag='span'):
     """Get the content text from one of the <li> fields on the page.
 

=== modified file 'src/maasserver/views/tests/test_nodes.py'
--- src/maasserver/views/tests/test_nodes.py	2014-08-30 10:25:02 +0000
+++ src/maasserver/views/tests/test_nodes.py	2014-09-01 03:04:59 +0000
@@ -82,6 +82,7 @@
     LLDP_OUTPUT_NAME,
     )
 from provisioningserver.utils.enum import map_enum
+from provisioningserver.utils.text import normalise_whitespace
 from testtools.matchers import ContainsAll
 
 
@@ -592,7 +593,7 @@
         [interface] = interfaces_list.cssselect('li')
         self.assertEqual(
             "%s (on %s)" % (mac.mac_address, network.name),
-            ' '.join(interface.text_content().split()))
+            normalise_whitespace(interface.text_content()))
         [link] = interface.cssselect('a')
         self.assertEqual(network.name, link.text_content().strip())
         self.assertEqual(
@@ -615,7 +616,7 @@
         [interface] = interfaces_list.cssselect('li')
         self.assertEqual(
             "%s (on %s)" % (mac.mac_address, ', '.join(sorted_names)),
-            ' '.join(interface.text_content().split()))
+            normalise_whitespace(interface.text_content()))
 
     def test_view_node_displays_link_to_edit_if_user_owns_node(self):
         self.client_log_in()
@@ -1340,10 +1341,6 @@
         else:
             self.fail("Found more than one link: %s" % links)
 
-    def normalise_whitespace(self, text):
-        """Return a version of `text` where all whitespace is single spaces."""
-        return ' '.join(text.split())
-
     def test_view_node_links_to_commissioning_results_if_appropriate(self):
         self.client_log_in(as_admin=True)
         result = factory.make_node_commission_result()
@@ -1373,7 +1370,7 @@
         link = self.get_results_link(section)
         self.assertEqual(
             "1 output file",
-            self.normalise_whitespace(link.text_content()))
+            normalise_whitespace(link.text_content()))
 
     def test_view_node_shows_commissioning_results_requires_edit_perm(self):
         password = 'test'
@@ -1394,7 +1391,7 @@
         link = self.get_results_link(section)
         self.assertEqual(
             "1 output file",
-            self.normalise_whitespace(link.text_content()))
+            normalise_whitespace(link.text_content()))
 
     def test_view_node_shows_multiple_commissioning_results(self):
         self.client_log_in(as_admin=True)
@@ -1407,7 +1404,7 @@
         link = self.get_results_link(section)
         self.assertEqual(
             "%d output files" % num_results,
-            self.normalise_whitespace(link.text_content()))
+            normalise_whitespace(link.text_content()))
 
     def test_view_node_shows_installing_results_only_if_present(self):
         self.client_log_in(as_admin=True)
@@ -1425,8 +1422,9 @@
         section = self.request_results_display(
             result.node, RESULT_TYPE.INSTALLING)
         link = self.get_results_link(section)
-        self.assertIsNotNone(
-            self.normalise_whitespace(link.text_content()))
+        self.assertNotIn(
+            normalise_whitespace(link.text_content()),
+            ('', None))
 
     def test_view_node_shows_installing_results_requires_edit_perm(self):
         password = 'test'

=== added file 'src/provisioningserver/utils/tests/test_text.py'
--- src/provisioningserver/utils/tests/test_text.py	1970-01-01 00:00:00 +0000
+++ src/provisioningserver/utils/tests/test_text.py	2014-09-01 03:04:59 +0000
@@ -0,0 +1,41 @@
+# Copyright 2014 Canonical Ltd.  This software is licensed under the
+# GNU Affero General Public License version 3 (see the file LICENSE).
+
+"""Tests for text processing utilities."""
+
+from __future__ import (
+    absolute_import,
+    print_function,
+    unicode_literals,
+    )
+
+str = None
+
+__metaclass__ = type
+__all__ = []
+
+from maastesting.factory import factory
+from maastesting.testcase import MAASTestCase
+from provisioningserver.utils.text import normalise_whitespace
+
+
+class TestNormaliseWhitespace(MAASTestCase):
+
+    def test__preserves_text_without_whitespace(self):
+        word = factory.make_name('word')
+        self.assertEqual(word, normalise_whitespace(word))
+
+    def test__eliminates_leading_space(self):
+        self.assertEqual('word', normalise_whitespace(' word'))
+
+    def test__eliminates_trailing_space(self):
+        self.assertEqual('word', normalise_whitespace('word '))
+
+    def test__replaces_any_whitespace_sequence_with_single_space(self):
+        self.assertEqual(
+            'one two three',
+            normalise_whitespace('one   two\t\nthree'))
+
+    def test__treats_punctuation_as_non_space(self):
+        punctuation = '.?;:!'
+        self.assertEqual(punctuation, normalise_whitespace(punctuation))

=== added file 'src/provisioningserver/utils/text.py'
--- src/provisioningserver/utils/text.py	1970-01-01 00:00:00 +0000
+++ src/provisioningserver/utils/text.py	2014-09-01 03:04:59 +0000
@@ -0,0 +1,22 @@
+# Copyright 2014 Canonical Ltd.  This software is licensed under the
+# GNU Affero General Public License version 3 (see the file LICENSE).
+
+"""Text-processing utilities."""
+
+from __future__ import (
+    absolute_import,
+    print_function,
+    unicode_literals,
+    )
+
+str = None
+
+__metaclass__ = type
+__all__ = [
+    'normalise_whitespace',
+    ]
+
+
+def normalise_whitespace(text):
+    """Replace any whitespace sequence in `text` with just a single space."""
+    return ' '.join(text.split())