Merge lp:~gmb/trac-launchpad-migrator/fix-render_text-bug-456182 into lp:trac-launchpad-migrator

[Graham Binns]

[Graham Binns (gmb)]

This branch fixes bug 456182, which makes the migrator mangle bug descriptions with more than one Trac wiki markup block in them.

The simple fix was to simplify the code that removed the block markup (because multiline regexes are asking for pain).

[Gavin Panella (allenap)]

This looks good, though I'm inclined to think we should just leave the description alone entirely.

review: Approve

=== modified file 'migrate.py'
--- migrate.py	2009-10-19 13:50:08 +0000
+++ migrate.py	2009-10-20 10:40:23 +0000
@@ -290,15 +290,11 @@
     # handle trac {{{ }}} formatting (incl. ReST).
     text = ''.join([_rstrip(line).expandtabs() + "\n"
                     for line in text.splitlines()])
-    for regex in (RST_RE, PRE_RE):
-        rg = re.compile(regex,
-                        re.IGNORECASE|re.DOTALL|re.MULTILINE)
-        m = rg.search(text)
-        if m:
-            text = m.group(1)
-            break
 
-    return text
+    # Simply remove the {{{s and }}}s from the text. We don't want to
+    # care too much about blocks right now, so we just remove them.
+    block_re = re.compile('(\{\{\{|\}\}\})\r?\n')
+    return block_re.sub('', text)
 
 
 def ensure_valid_username(username):

=== modified file 'tests.py'
--- tests.py	2009-10-19 13:49:32 +0000
+++ tests.py	2009-10-20 10:40:23 +0000
@@ -18,7 +18,8 @@
 import re
 import unittest
 
-from migrate import ensure_valid_username, extract_person_email
+from migrate import (
+    ensure_valid_username, extract_person_email, render_text)
 
 
 class ExtractPersonEmailTestCase(unittest.TestCase):
@@ -180,3 +181,25 @@
             re.match('\s+', returned_name) is None,
             "Returned name '%s' shouldn't contain whitespace" %
             returned_name)
+
+
+class RenderTextTestCase(unittest.TestCase):
+    """Tests for the render_text function."""
+
+    def test_render_text_removes_blocks(self):
+        # render_text will strip out {{{s and }}}s from text.
+        text = (
+            "This is a description\n"
+            "{{{\n"
+            "Which has some block text\n"
+            "}}}\n")
+
+        expected_text = (
+            "This is a description\n"
+            "Which has some block text\n")
+
+        rendered_text = render_text(text)
+        self.assertEqual(
+            rendered_text, expected_text,
+            "render_text returned '%s', expected '%s'" %
+            (rendered_text, expected_text))