Make sure locale is what we want before/after the tests

The locale is a global state, and it was not properly reset to
whatever it was before the unitttest possibly changed it.
This is now fixed.

Not restoring the locale led to weird issues: depending on
the order chosen by "python -m unittest discover" to run
the unit tests, some tests would apparently randomly fail
due to the locale not being what was expected.

For example, test_period_in_timeperiod_archive would
call mock('posts/1970/ 1月/index.html',...) instead of
expected mock('posts/1970/Jan/index.html',...) and fail.
This commit is contained in:
Antoine Brenner 2014-04-15 16:36:29 +02:00
commit 7277c95fb5
7 changed files with 44 additions and 2 deletions

View file

@ -4,6 +4,7 @@ from __future__ import unicode_literals, absolute_import
import six import six
from datetime import datetime from datetime import datetime
from sys import platform from sys import platform
import locale
from pelican.tests.support import unittest, get_settings from pelican.tests.support import unittest, get_settings
@ -22,6 +23,8 @@ class TestPage(unittest.TestCase):
def setUp(self): def setUp(self):
super(TestPage, self).setUp() super(TestPage, self).setUp()
self.old_locale = locale.setlocale(locale.LC_ALL)
locale.setlocale(locale.LC_ALL, str('C'))
self.page_kwargs = { self.page_kwargs = {
'content': TEST_CONTENT, 'content': TEST_CONTENT,
'context': { 'context': {
@ -35,6 +38,9 @@ class TestPage(unittest.TestCase):
'source_path': '/path/to/file/foo.ext' 'source_path': '/path/to/file/foo.ext'
} }
def tearDown(self):
locale.setlocale(locale.LC_ALL, self.old_locale)
def test_use_args(self): def test_use_args(self):
# Creating a page with arguments passed to the constructor should use # Creating a page with arguments passed to the constructor should use
# them to initialise object's attributes. # them to initialise object's attributes.

View file

@ -14,6 +14,7 @@ from pelican.generators import (Generator, ArticlesGenerator, PagesGenerator,
TemplatePagesGenerator) TemplatePagesGenerator)
from pelican.writers import Writer from pelican.writers import Writer
from pelican.tests.support import unittest, get_settings from pelican.tests.support import unittest, get_settings
import locale
CUR_DIR = os.path.dirname(__file__) CUR_DIR = os.path.dirname(__file__)
CONTENT_DIR = os.path.join(CUR_DIR, 'content') CONTENT_DIR = os.path.join(CUR_DIR, 'content')
@ -21,11 +22,17 @@ CONTENT_DIR = os.path.join(CUR_DIR, 'content')
class TestGenerator(unittest.TestCase): class TestGenerator(unittest.TestCase):
def setUp(self): def setUp(self):
self.old_locale = locale.setlocale(locale.LC_ALL)
locale.setlocale(locale.LC_ALL, str('C'))
self.settings = get_settings() self.settings = get_settings()
self.settings['READERS'] = {'asc': None} self.settings['READERS'] = {'asc': None}
self.generator = Generator(self.settings.copy(), self.settings, self.generator = Generator(self.settings.copy(), self.settings,
CUR_DIR, self.settings['THEME'], None) CUR_DIR, self.settings['THEME'], None)
def tearDown(self):
locale.setlocale(locale.LC_ALL, self.old_locale)
def test_include_path(self): def test_include_path(self):
filename = os.path.join(CUR_DIR, 'content', 'article.rst') filename = os.path.join(CUR_DIR, 'content', 'article.rst')
include_path = self.generator._include_path include_path = self.generator._include_path
@ -373,10 +380,14 @@ class TestTemplatePagesGenerator(unittest.TestCase):
def setUp(self): def setUp(self):
self.temp_content = mkdtemp(prefix='pelicantests.') self.temp_content = mkdtemp(prefix='pelicantests.')
self.temp_output = mkdtemp(prefix='pelicantests.') self.temp_output = mkdtemp(prefix='pelicantests.')
self.old_locale = locale.setlocale(locale.LC_ALL)
locale.setlocale(locale.LC_ALL, str('C'))
def tearDown(self): def tearDown(self):
rmtree(self.temp_content) rmtree(self.temp_content)
rmtree(self.temp_output) rmtree(self.temp_output)
locale.setlocale(locale.LC_ALL, self.old_locale)
def test_generate_output(self): def test_generate_output(self):

View file

@ -4,6 +4,7 @@ from __future__ import unicode_literals, print_function
import os import os
import re import re
import locale
from pelican.tools.pelican_import import wp2fields, fields2pelican, decode_wp_content, build_header, build_markdown_header, get_attachments, download_attachments from pelican.tools.pelican_import import wp2fields, fields2pelican, decode_wp_content, build_header, build_markdown_header, get_attachments, download_attachments
from pelican.tests.support import (unittest, temporary_folder, mute, from pelican.tests.support import (unittest, temporary_folder, mute,
skipIfNoExecutable) skipIfNoExecutable)
@ -30,9 +31,14 @@ except ImportError:
class TestWordpressXmlImporter(unittest.TestCase): class TestWordpressXmlImporter(unittest.TestCase):
def setUp(self): def setUp(self):
self.old_locale = locale.setlocale(locale.LC_ALL)
locale.setlocale(locale.LC_ALL, str('C'))
self.posts = list(wp2fields(WORDPRESS_XML_SAMPLE)) self.posts = list(wp2fields(WORDPRESS_XML_SAMPLE))
self.custposts = list(wp2fields(WORDPRESS_XML_SAMPLE, True)) self.custposts = list(wp2fields(WORDPRESS_XML_SAMPLE, True))
def tearDown(self):
locale.setlocale(locale.LC_ALL, self.old_locale)
def test_ignore_empty_posts(self): def test_ignore_empty_posts(self):
self.assertTrue(self.posts) self.assertTrue(self.posts)
for title, content, fname, date, author, categ, tags, kind, format in self.posts: for title, content, fname, date, author, categ, tags, kind, format in self.posts:
@ -261,8 +267,13 @@ class TestBuildHeader(unittest.TestCase):
@unittest.skipUnless(BeautifulSoup, 'Needs BeautifulSoup module') @unittest.skipUnless(BeautifulSoup, 'Needs BeautifulSoup module')
class TestWordpressXMLAttachements(unittest.TestCase): class TestWordpressXMLAttachements(unittest.TestCase):
def setUp(self): def setUp(self):
self.old_locale = locale.setlocale(locale.LC_ALL)
locale.setlocale(locale.LC_ALL, str('C'))
self.attachments = get_attachments(WORDPRESS_XML_SAMPLE) self.attachments = get_attachments(WORDPRESS_XML_SAMPLE)
def tearDown(self):
locale.setlocale(locale.LC_ALL, self.old_locale)
def test_recognise_attachments(self): def test_recognise_attachments(self):
self.assertTrue(self.attachments) self.assertTrue(self.attachments)
self.assertTrue(len(self.attachments.keys()) == 3) self.assertTrue(len(self.attachments.keys()) == 3)

View file

@ -1,6 +1,7 @@
# -*- coding: utf-8 -*- # -*- coding: utf-8 -*-
from __future__ import unicode_literals, absolute_import from __future__ import unicode_literals, absolute_import
import six import six
import locale
from pelican.tests.support import unittest, get_settings from pelican.tests.support import unittest, get_settings
@ -16,6 +17,8 @@ TEST_SUMMARY = generate_lorem_ipsum(n=1, html=False)
class TestPage(unittest.TestCase): class TestPage(unittest.TestCase):
def setUp(self): def setUp(self):
super(TestPage, self).setUp() super(TestPage, self).setUp()
self.old_locale = locale.setlocale(locale.LC_ALL)
locale.setlocale(locale.LC_ALL, str('C'))
self.page_kwargs = { self.page_kwargs = {
'content': TEST_CONTENT, 'content': TEST_CONTENT,
'context': { 'context': {
@ -29,6 +32,9 @@ class TestPage(unittest.TestCase):
'source_path': '/path/to/file/foo.ext' 'source_path': '/path/to/file/foo.ext'
} }
def tearDown(self):
locale.setlocale(locale.LC_ALL, self.old_locale)
def test_save_as_preservation(self): def test_save_as_preservation(self):
settings = get_settings() settings = get_settings()
# fix up pagination rules # fix up pagination rules

View file

@ -44,8 +44,8 @@ class TestPelican(LoggedTestCase):
super(TestPelican, self).setUp() super(TestPelican, self).setUp()
self.temp_path = mkdtemp(prefix='pelicantests.') self.temp_path = mkdtemp(prefix='pelicantests.')
self.temp_cache = mkdtemp(prefix='pelican_cache.') self.temp_cache = mkdtemp(prefix='pelican_cache.')
self.old_locale = locale.setlocale(locale.LC_ALL)
self.maxDiff = None self.maxDiff = None
self.old_locale = locale.setlocale(locale.LC_ALL)
locale.setlocale(locale.LC_ALL, str('C')) locale.setlocale(locale.LC_ALL, str('C'))
def tearDown(self): def tearDown(self):

View file

@ -16,10 +16,15 @@ class TestSettingsConfiguration(unittest.TestCase):
optimizations. optimizations.
""" """
def setUp(self): def setUp(self):
self.old_locale = locale.setlocale(locale.LC_ALL)
locale.setlocale(locale.LC_ALL, str('C'))
self.PATH = abspath(dirname(__file__)) self.PATH = abspath(dirname(__file__))
default_conf = join(self.PATH, 'default_conf.py') default_conf = join(self.PATH, 'default_conf.py')
self.settings = read_settings(default_conf) self.settings = read_settings(default_conf)
def tearDown(self):
locale.setlocale(locale.LC_ALL, self.old_locale)
def test_overwrite_existing_settings(self): def test_overwrite_existing_settings(self):
self.assertEqual(self.settings.get('SITENAME'), "Alexis' log") self.assertEqual(self.settings.get('SITENAME'), "Alexis' log")
self.assertEqual(self.settings.get('SITEURL'), self.assertEqual(self.settings.get('SITEURL'),

View file

@ -354,9 +354,12 @@ class TestCopy(unittest.TestCase):
def setUp(self): def setUp(self):
self.root_dir = mkdtemp(prefix='pelicantests.') self.root_dir = mkdtemp(prefix='pelicantests.')
self.old_locale = locale.setlocale(locale.LC_ALL)
locale.setlocale(locale.LC_ALL, str('C'))
def tearDown(self): def tearDown(self):
shutil.rmtree(self.root_dir) shutil.rmtree(self.root_dir)
locale.setlocale(locale.LC_ALL, self.old_locale)
def _create_file(self, *path): def _create_file(self, *path):
with open(os.path.join(self.root_dir, *path), 'w') as f: with open(os.path.join(self.root_dir, *path), 'w') as f: