Imported Upstream version 6.2.1upstream/6.2.1

1 files changed, 107 insertions, 2 deletions

diff --git a/tests/base.py b/tests/base.py
index 92576c7..00f7486 100644
--- a/tests/base.py
+++ b/tests/base.py
@@ -6,12 +6,21 @@
 """ Base class for Nikola test cases """
 
 
-__all__ = ["BaseTestCase"]
-
+__all__ = ["BaseTestCase", "cd", "LocaleSupportInTesting"]
 
+from contextlib import contextmanager
+import locale
+import os
 import sys
 import unittest
 
+import logbook
+
+# Make logbook shutup
+import nikola.utils
+
+nikola.utils.LOGGER.handlers.append(logbook.TestHandler())
+
 
 if sys.version_info < (2, 7):
 
@@ -56,3 +65,99 @@ if sys.version_info < (2, 7):
 
 else:
     BaseTestCase = unittest.TestCase
+
+
+@contextmanager
+def cd(path):
+    old_dir = os.getcwd()
+    os.chdir(path)
+    yield
+    os.chdir(old_dir)
+
+
+class LocaleSupportInTesting(object):
+    """
+    Nikola needs two pairs of valid (language, locale_n) to test multilingual sites.
+
+    As languages of interest and installed OS support varies from host to host
+    we allow to specify two such pairs.
+
+    A valid pair complies
+        'languaje' one of the names of nikola translations ('en', 'es', ...)
+        'locale_n' is a string that python accepts to set a locale, like in
+            import locale
+            locale.setlocale(locale.LC_ALL, str(locale_n))
+
+    You specify the custom pairs to use with two environment variables
+    NIKOLA_LOCALE_DEFAULT (lang and locale to use as nikola's DEFAULT_LANG)
+    NIKOLA_LOCALE_OTHER
+
+    The value of the pair is lang (as in keys of Nikola's TRANSLATIONS), followed
+    by coma, followed by the locale.
+    """
+
+    @classmethod
+    def initialize(cls):
+        """Determines and diagnoses the two (lang, locale) pairs to use in testing
+
+        While it only needs to run once at the beginning of the testing session,
+        calling multiple times is fine.
+        """
+        if hasattr(cls, 'langlocales'):
+            return
+        defaults = {
+            'linux': {
+                # non-windows defaults, must be two locales suported by .travis.yml
+                'default': ("en", str("en_US.utf8")),
+                'other': ("es", str("es_ES.utf8")),
+            },
+            'windows': {
+                # windows defaults
+                'default': ("en", str("English")),
+                'other': ("es", str("Spanish")),
+            },
+        }
+        os_id = 'windows' if sys.platform == 'win32' else 'linux'
+        langlocales = {}
+        for suffix in ['other', 'default']:
+            try:
+                envar = 'NIKOLA_LOCALE_' + suffix.upper()
+                s = os.environ[envar]
+                parts = s.split(',')
+                lang = parts[0].strip()
+                try:
+                    locale_n = str(parts[1].strip())
+                    locale.setlocale(locale.LC_ALL, locale_n)
+                except Exception:
+                    msg = ("Environment variable {0} fails to specify a valid <lang>,<locale>." +
+                           "Check your syntax, check that python supports that locale in your host.")
+                    nikola.utils.LOGGER.error(msg.format(envar))
+                    sys.exit(1)
+            except KeyError:
+                lang, locale_n = defaults[os_id][suffix]
+            langlocales[suffix] = (lang, locale_n)
+        if (langlocales['default'][0] == langlocales['other'][0] or
+            langlocales['default'][1] == langlocales['other'][1]):  # NOQA
+            # the mix of defaults and enviro is not good
+            msg = ('Locales for testing should differ in lang and locale, else ' +
+                   'the test would we weak. Check your environment settings for ' +
+                   'NIKOLA_LOCALE_DEFAULT and NIKOLA_LOCALE_OTHER')
+            nikola.utils.LOGGER.error(msg)
+        setattr(cls, 'langlocales', langlocales)
+
+    @classmethod
+    def initialize_locales_for_testing(cls, variant):
+        """initializes nikola.utils.LocaleBorg"""
+        if not hasattr(cls, 'langlocales'):
+            cls.initialize()
+        default_lang = cls.langlocales['default'][0]
+        locales = {}
+        locales[default_lang] = cls.langlocales['default'][1]
+        if variant == 'unilingual':
+            pass
+        elif variant == 'bilingual':
+            locales[cls.langlocales['other'][0]] = cls.langlocales['other'][1]
+        else:
+            raise ValueError('Unknown locale variant')
+        nikola.utils.LocaleBorg.reset()
+        nikola.utils.LocaleBorg.initialize(locales, default_lang)