Added a test that checks for localized strings in the source code that contain position-based string formatting placeholders. If found, an exception message is generated that summarizes the problem, as well as the location of the problematic code. This will prevent future trunk commits from adding localized strings that cannot be properly translated.

1 files changed, 100 insertions, 0 deletions

diff --git a/nova/tests/test_localization.py b/nova/tests/test_localization.py
new file mode 100644
index 000000000..6992773f5
--- /dev/null
+++ b/nova/tests/test_localization.py
@@ -0,0 +1,100 @@
+# vim: tabstop=4 shiftwidth=4 softtabstop=4
+#
+#    Copyright 2011 OpenStack LLC
+#
+#    Licensed under the Apache License, Version 2.0 (the "License"); you may
+#    not use this file except in compliance with the License. You may obtain
+#    a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#    License for the specific language governing permissions and limitations
+#    under the License.
+
+import glob
+import logging
+import os
+import re
+import sys
+import unittest
+
+import nova
+
+
+class LocalizationTestCase(unittest.TestCase):
+    def test_multiple_positional_format_placeholders(self):
+        pat = re.compile("\W_\(")
+        single_pat = re.compile("\W%\W")
+        root_path = os.path.dirname(nova.__file__)
+        problems = {}
+        for root, dirs, files in os.walk(root_path):
+            for fname in files:
+                if not fname.endswith(".py"):
+                    continue
+                pth = os.path.join(root, fname)
+                txt = fulltext = file(pth).read()
+                txt_lines = fulltext.splitlines()
+                if not pat.search(txt):
+                    continue
+                problems[pth] = []
+                pos = txt.find("_(")
+                while pos > -1:
+                    # Make sure that this isn't part of a dunder;
+                    # e.g., __init__(...
+                    # or something like 'self.assert_(...'
+                    test_txt = txt[pos - 1: pos + 10]
+                    if not (pat.search(test_txt)):
+                        txt = txt[pos + 2:]
+                        pos = txt.find("_(")
+                        continue
+                    pos += 2
+                    txt = txt[pos:]
+                    innerChars = []
+                    # Count pairs of open/close parens until _() closing
+                    # paren is found.
+                    parenCount = 1
+                    pos = 0
+                    while parenCount > 0:
+                        char = txt[pos]
+                        if char == "(":
+                            parenCount += 1
+                        elif char == ")":
+                            parenCount -= 1
+                        innerChars.append(char)
+                        pos += 1
+                    inner_all = "".join(innerChars)
+                    # Filter out '%%' and '%('
+                    inner = inner_all.replace("%%", "").replace("%(", "")
+                    # Filter out the single '%' operators
+                    inner = single_pat.sub("", inner)
+                    # Within the remaining content, count %
+                    fmtCount = inner.count("%")
+                    if fmtCount > 1:
+                        inner_first = inner_all.splitlines()[0]
+                        lns = ["%s" % (p + 1)
+                                for p, t in enumerate(txt_lines)
+                                if inner_first in t]
+                        lnums = ", ".join(lns)
+                        # Using ugly string concatenation to avoid having
+                        # this test fail itself.
+                        inner_all = "_" + "(" + "%s" % inner_all
+                        problems[pth].append("Line: %s Text: %s" %
+                                (lnums, inner_all))
+                    # Look for more
+                    pos = txt.find("_(")
+                if not problems[pth]:
+                    del problems[pth]
+        if problems:
+            out = ["Problem(s) found in localized string formatting",
+                    "(see http://www.gnu.org/software/hello/manual/"
+                    "gettext/Python.html for more information)",
+                    "",
+                    "    ------------ Files to fix ------------"]
+            for pth in problems:
+                out.append("    %s:" % pth)
+                for val in set(problems[pth]):
+                    out.append("        %s" % val)
+            raise AssertionError("\n".join(out))