github/pelican
1
0
Fork 1
mirror of https://github.com/getpelican/pelican.git synced 2025-10-15 20:28:56 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

tests.support: Use kwargs overrides in get_settings()

Browse source 
This avoids harcoding test-specific overrides, and makes it easy to
setup a settings dictionary based on DEFAULT_CONFIG for testing.
Because you can trust Pelican to use settings based on DEFAULT_CONFIG,
you are free to go about using:

  settings[my_key]

instead of:

  settings.get(my_key, some_fallback)

or:

  if my_key in settings:
      ...

if you know that `my_key` is in DEFAULT_CONFIG.
This commit is contained in:
W. Trevor King 2013-03-24 15:08:33 -04:00
commit c8e7d95b34
4 changed files with 66 additions and 68 deletions
Download patch file Download diff file Expand all files Collapse all files

10
pelican/tests/support.py
View file

@ -161,10 +161,14 @@ def locale_available(locale_):
return True return True
def get_settings(): def get_settings(**kwargs):
"""Provide tweaked setting dictionaries for testing
Set keyword arguments to override specific settings.
"""
settings = DEFAULT_CONFIG.copy() settings = DEFAULT_CONFIG.copy()
settings['DIRECT_TEMPLATES'] = ['archives'] for key,value in kwargs.items():
settings['filenames'] = {} settings[key] = value
return settings return settings

10
pelican/tests/test_contents.py
View file

@ -4,7 +4,7 @@ from __future__ import unicode_literals
from datetime import datetime from datetime import datetime
from sys import platform from sys import platform
from .support import unittest from .support import unittest, get_settings
from pelican.contents import Page, Article, URLWrapper from pelican.contents import Page, Article, URLWrapper
from pelican.settings import DEFAULT_CONFIG from pelican.settings import DEFAULT_CONFIG
@ -62,7 +62,7 @@ class TestPage(unittest.TestCase):
# If a :SUMMARY_MAX_LENGTH: is set, and there is no other summary, # If a :SUMMARY_MAX_LENGTH: is set, and there is no other summary,
# generated summary should not exceed the given length. # generated summary should not exceed the given length.
page_kwargs = self._copy_page_kwargs() page_kwargs = self._copy_page_kwargs()
settings = DEFAULT_CONFIG.copy() settings = get_settings()
page_kwargs['settings'] = settings page_kwargs['settings'] = settings
del page_kwargs['metadata']['summary'] del page_kwargs['metadata']['summary']
settings['SUMMARY_MAX_LENGTH'] = None settings['SUMMARY_MAX_LENGTH'] = None
@ -108,8 +108,7 @@ class TestPage(unittest.TestCase):
page = Page(**self.page_kwargs) page = Page(**self.page_kwargs)
self.assertIn('summary', page.url_format.keys()) self.assertIn('summary', page.url_format.keys())
page.metadata['directory'] = 'test-dir' page.metadata['directory'] = 'test-dir'
page.settings = DEFAULT_CONFIG.copy() page.settings = get_settings(PAGE_SAVE_AS='{directory}/{slug}')
page.settings['PAGE_SAVE_AS'] = '{directory}/{slug}'
self.assertEqual(page.save_as, 'test-dir/foo-bar') self.assertEqual(page.save_as, 'test-dir/foo-bar')
def test_datetime(self): def test_datetime(self):
@ -125,8 +124,7 @@ class TestPage(unittest.TestCase):
self.assertEqual(page.locale_date, self.assertEqual(page.locale_date,
dt.strftime(DEFAULT_CONFIG['DEFAULT_DATE_FORMAT'])) dt.strftime(DEFAULT_CONFIG['DEFAULT_DATE_FORMAT']))
page_kwargs['settings'] = dict([(x, DEFAULT_CONFIG[x]) for x in page_kwargs['settings'] = get_settings()
DEFAULT_CONFIG])
# I doubt this can work on all platforms ... # I doubt this can work on all platforms ...
if platform == "win32": if platform == "win32":

6
pelican/tests/test_generators.py
View file

@ -29,7 +29,7 @@ class TestArticlesGenerator(unittest.TestCase):
for each test. for each test.
""" """
if self.generator is None: if self.generator is None:
settings = get_settings() settings = get_settings(filenames={})
settings['ARTICLE_DIR'] = 'content' settings['ARTICLE_DIR'] = 'content'
settings['DEFAULT_CATEGORY'] = 'Default' settings['DEFAULT_CATEGORY'] = 'Default'
settings['DEFAULT_DATE'] = (1970, 1, 1) settings['DEFAULT_DATE'] = (1970, 1, 1)
@ -144,7 +144,7 @@ class TestArticlesGenerator(unittest.TestCase):
def test_direct_templates_save_as_default(self): def test_direct_templates_save_as_default(self):
settings = get_settings() settings = get_settings(filenames={})
generator = ArticlesGenerator(settings, settings, None, generator = ArticlesGenerator(settings, settings, None,
settings['THEME'], None, settings['THEME'], None,
settings['MARKUP']) settings['MARKUP'])
@ -212,7 +212,7 @@ class TestPageGenerator(unittest.TestCase):
return distilled return distilled
def test_generate_context(self): def test_generate_context(self):
settings = get_settings() settings = get_settings(filenames={})
settings['PAGE_DIR'] = 'TestPages' settings['PAGE_DIR'] = 'TestPages'
settings['DEFAULT_DATE'] = (1970, 1, 1) settings['DEFAULT_DATE'] = (1970, 1, 1)

108
pelican/tests/test_readers.py
View file

@ -5,7 +5,7 @@ import datetime
import os import os
from pelican import readers from pelican import readers
from pelican.tests.support import unittest from pelican.tests.support import unittest, get_settings
CUR_DIR = os.path.dirname(__file__) CUR_DIR = os.path.dirname(__file__)
CONTENT_PATH = os.path.join(CUR_DIR, 'content') CONTENT_PATH = os.path.join(CUR_DIR, 'content')
@ -15,11 +15,18 @@ def _path(*args):
return os.path.join(CONTENT_PATH, *args) return os.path.join(CONTENT_PATH, *args)
class RstReaderTest(unittest.TestCase): class ReaderTest(unittest.TestCase):
def read_file(self, path, **kwargs):
# Isolate from future API changes to readers.read_file
return readers.read_file(
_path(path), settings=get_settings(**kwargs))
class RstReaderTest(ReaderTest):
def test_article_with_metadata(self): def test_article_with_metadata(self):
reader = readers.RstReader({}) content, metadata = self.read_file(path='article_with_metadata.rst')
content, metadata = reader.read(_path('article_with_metadata.rst'))
expected = { expected = {
'category': 'yeah', 'category': 'yeah',
'author': 'Alexis Métaireau', 'author': 'Alexis Métaireau',
@ -36,8 +43,9 @@ class RstReaderTest(unittest.TestCase):
self.assertEqual(value, metadata[key], key) self.assertEqual(value, metadata[key], key)
def test_article_with_filename_metadata(self): def test_article_with_filename_metadata(self):
content, metadata = readers.read_file( content, metadata = self.read_file(
_path('2012-11-29_rst_w_filename_meta#foo-bar.rst')) path='2012-11-29_rst_w_filename_meta#foo-bar.rst',
FILENAME_METADATA=None)
expected = { expected = {
'category': 'yeah', 'category': 'yeah',
'author': 'Alexis Métaireau', 'author': 'Alexis Métaireau',
@ -46,11 +54,9 @@ class RstReaderTest(unittest.TestCase):
for key, value in metadata.items(): for key, value in metadata.items():
self.assertEqual(value, expected[key], key) self.assertEqual(value, expected[key], key)
content, metadata = readers.read_file( content, metadata = self.read_file(
_path('2012-11-29_rst_w_filename_meta#foo-bar.rst'), path='2012-11-29_rst_w_filename_meta#foo-bar.rst',
settings={ FILENAME_METADATA='(?P<date>\d{4}-\d{2}-\d{2}).*')
'FILENAME_METADATA': '(?P<date>\d{4}-\d{2}-\d{2}).*'
})
expected = { expected = {
'category': 'yeah', 'category': 'yeah',
'author': 'Alexis Métaireau', 'author': 'Alexis Métaireau',
@ -60,13 +66,12 @@ class RstReaderTest(unittest.TestCase):
for key, value in metadata.items(): for key, value in metadata.items():
self.assertEqual(value, expected[key], key) self.assertEqual(value, expected[key], key)
content, metadata = readers.read_file( content, metadata = self.read_file(
_path('2012-11-29_rst_w_filename_meta#foo-bar.rst'), path='2012-11-29_rst_w_filename_meta#foo-bar.rst',
settings={ FILENAME_METADATA=(
'FILENAME_METADATA': '(?P<date>\d{4}-\d{2}-\d{2})_' '(?P<date>\d{4}-\d{2}-\d{2})_'
'_(?P<Slug>.*)' '_(?P<Slug>.*)'
'#(?P<MyMeta>.*)-(?P<author>.*)' '#(?P<MyMeta>.*)-(?P<author>.*)'))
})
expected = { expected = {
'category': 'yeah', 'category': 'yeah',
'author': 'Alexis Métaireau', 'author': 'Alexis Métaireau',
@ -91,7 +96,7 @@ class RstReaderTest(unittest.TestCase):
def test_typogrify(self): def test_typogrify(self):
# if nothing is specified in the settings, the content should be # if nothing is specified in the settings, the content should be
# unmodified # unmodified
content, _ = readers.read_file(_path('article.rst')) content, _ = self.read_file(path='article.rst')
expected = ('<p>This is some content. With some stuff to ' expected = ('<p>This is some content. With some stuff to '
'&quot;typogrify&quot;.</p>\n<p>Now with added ' '&quot;typogrify&quot;.</p>\n<p>Now with added '
'support for <abbr title="three letter acronym">' 'support for <abbr title="three letter acronym">'
@ -101,8 +106,7 @@ class RstReaderTest(unittest.TestCase):
try: try:
# otherwise, typogrify should be applied # otherwise, typogrify should be applied
content, _ = readers.read_file(_path('article.rst'), content, _ = self.read_file(path='article.rst', TYPOGRIFY=True)
settings={'TYPOGRIFY': True})
expected = ('<p>This is some content. With some stuff to&nbsp;' expected = ('<p>This is some content. With some stuff to&nbsp;'
'&#8220;typogrify&#8221;.</p>\n<p>Now with added ' '&#8220;typogrify&#8221;.</p>\n<p>Now with added '
'support for <abbr title="three letter acronym">' 'support for <abbr title="three letter acronym">'
@ -113,7 +117,7 @@ class RstReaderTest(unittest.TestCase):
return unittest.skip('need the typogrify distribution') return unittest.skip('need the typogrify distribution')
class MdReaderTest(unittest.TestCase): class MdReaderTest(ReaderTest):
@unittest.skipUnless(readers.Markdown, "markdown isn't installed") @unittest.skipUnless(readers.Markdown, "markdown isn't installed")
def test_article_with_metadata(self): def test_article_with_metadata(self):
@ -221,9 +225,9 @@ class MdReaderTest(unittest.TestCase):
def test_article_with_markdown_markup_extension(self): def test_article_with_markdown_markup_extension(self):
# test to ensure the markdown markup extension is being processed as # test to ensure the markdown markup extension is being processed as
# expected # expected
content, metadata = readers.read_file( content, metadata = self.read_file(
_path('article_with_markdown_markup_extensions.md'), path='article_with_markdown_markup_extensions.md',
settings={'MD_EXTENSIONS': ['toc', 'codehilite', 'extra']}) MD_EXTENSIONS=['toc', 'codehilite', 'extra'])
expected = ('<div class="toc">\n' expected = ('<div class="toc">\n'
'<ul>\n' '<ul>\n'
'<li><a href="#level1">Level1</a><ul>\n' '<li><a href="#level1">Level1</a><ul>\n'
@ -239,8 +243,9 @@ class MdReaderTest(unittest.TestCase):
@unittest.skipUnless(readers.Markdown, "markdown isn't installed") @unittest.skipUnless(readers.Markdown, "markdown isn't installed")
def test_article_with_filename_metadata(self): def test_article_with_filename_metadata(self):
content, metadata = readers.read_file( content, metadata = self.read_file(
_path('2012-11-30_md_w_filename_meta#foo-bar.md')) path='2012-11-30_md_w_filename_meta#foo-bar.md',
FILENAME_METADATA=None)
expected = { expected = {
'category': 'yeah', 'category': 'yeah',
'author': 'Alexis Métaireau', 'author': 'Alexis Métaireau',
@ -248,11 +253,9 @@ class MdReaderTest(unittest.TestCase):
for key, value in expected.items(): for key, value in expected.items():
self.assertEqual(value, metadata[key], key) self.assertEqual(value, metadata[key], key)
content, metadata = readers.read_file( content, metadata = self.read_file(
_path('2012-11-30_md_w_filename_meta#foo-bar.md'), path='2012-11-30_md_w_filename_meta#foo-bar.md',
settings={ FILENAME_METADATA='(?P<date>\d{4}-\d{2}-\d{2}).*')
'FILENAME_METADATA': '(?P<date>\d{4}-\d{2}-\d{2}).*'
})
expected = { expected = {
'category': 'yeah', 'category': 'yeah',
'author': 'Alexis Métaireau', 'author': 'Alexis Métaireau',
@ -261,13 +264,12 @@ class MdReaderTest(unittest.TestCase):
for key, value in expected.items(): for key, value in expected.items():
self.assertEqual(value, metadata[key], key) self.assertEqual(value, metadata[key], key)
content, metadata = readers.read_file( content, metadata = self.read_file(
_path('2012-11-30_md_w_filename_meta#foo-bar.md'), path='2012-11-30_md_w_filename_meta#foo-bar.md',
settings={ FILENAME_METADATA=(
'FILENAME_METADATA': '(?P<date>\d{4}-\d{2}-\d{2})' '(?P<date>\d{4}-\d{2}-\d{2})'
'_(?P<Slug>.*)' '_(?P<Slug>.*)'
'#(?P<MyMeta>.*)-(?P<author>.*)' '#(?P<MyMeta>.*)-(?P<author>.*)'))
})
expected = { expected = {
'category': 'yeah', 'category': 'yeah',
'author': 'Alexis Métaireau', 'author': 'Alexis Métaireau',
@ -279,14 +281,13 @@ class MdReaderTest(unittest.TestCase):
self.assertEqual(value, metadata[key], key) self.assertEqual(value, metadata[key], key)
class AdReaderTest(unittest.TestCase): class AdReaderTest(ReaderTest):
@unittest.skipUnless(readers.asciidoc, "asciidoc isn't installed") @unittest.skipUnless(readers.asciidoc, "asciidoc isn't installed")
def test_article_with_asc_extension(self): def test_article_with_asc_extension(self):
# Ensure the asc extension is being processed by the correct reader # Ensure the asc extension is being processed by the correct reader
reader = readers.AsciiDocReader({}) content, metadata = self.read_file(
content, metadata = reader.read( path='article_with_asc_extension.asc')
_path('article_with_asc_extension.asc'))
expected = ('<hr>\n<h2><a name="_used_for_pelican_test">' expected = ('<hr>\n<h2><a name="_used_for_pelican_test">'
'</a>Used for pelican test</h2>\n' '</a>Used for pelican test</h2>\n'
'<p>The quick brown fox jumped over' '<p>The quick brown fox jumped over'
@ -316,10 +317,9 @@ class AdReaderTest(unittest.TestCase):
self.assertEqual(content, expected) self.assertEqual(content, expected)
class HTMLReaderTest(unittest.TestCase): class HTMLReaderTest(ReaderTest):
def test_article_with_comments(self): def test_article_with_comments(self):
reader = readers.HTMLReader({}) content, metadata = self.read_file(path='article_with_comments.html')
content, metadata = reader.read(_path('article_with_comments.html'))
self.assertEqual(''' self.assertEqual('''
Body content Body content
@ -327,8 +327,7 @@ class HTMLReaderTest(unittest.TestCase):
''', content) ''', content)
def test_article_with_keywords(self): def test_article_with_keywords(self):
reader = readers.HTMLReader({}) content, metadata = self.read_file(path='article_with_keywords.html')
content, metadata = reader.read(_path('article_with_keywords.html'))
expected = { expected = {
'tags': ['foo', 'bar', 'foobar'], 'tags': ['foo', 'bar', 'foobar'],
} }
@ -337,8 +336,7 @@ class HTMLReaderTest(unittest.TestCase):
self.assertEqual(value, metadata[key], key) self.assertEqual(value, metadata[key], key)
def test_article_with_metadata(self): def test_article_with_metadata(self):
reader = readers.HTMLReader({}) content, metadata = self.read_file(path='article_with_metadata.html')
content, metadata = reader.read(_path('article_with_metadata.html'))
expected = { expected = {
'category': 'yeah', 'category': 'yeah',
'author': 'Alexis Métaireau', 'author': 'Alexis Métaireau',
@ -353,9 +351,8 @@ class HTMLReaderTest(unittest.TestCase):
self.assertEqual(value, metadata[key], key) self.assertEqual(value, metadata[key], key)
def test_article_with_null_attributes(self): def test_article_with_null_attributes(self):
reader = readers.HTMLReader({}) content, metadata = self.read_file(
content, metadata = reader.read( path='article_with_null_attributes.html')
_path('article_with_null_attributes.html'))
self.assertEqual(''' self.assertEqual('''
Ensure that empty attributes are copied properly. Ensure that empty attributes are copied properly.
@ -364,9 +361,8 @@ class HTMLReaderTest(unittest.TestCase):
def test_article_metadata_key_lowercase(self): def test_article_metadata_key_lowercase(self):
# Keys of metadata should be lowercase. # Keys of metadata should be lowercase.
reader = readers.HTMLReader({}) content, metadata = self.read_file(
content, metadata = reader.read( path='article_with_uppercase_metadata.html')
_path('article_with_uppercase_metadata.html'))
self.assertIn('category', metadata, 'Key should be lowercase.') self.assertIn('category', metadata, 'Key should be lowercase.')
self.assertEqual('Yeah', metadata.get('category'), self.assertEqual('Yeah', metadata.get('category'),
'Value keeps cases.') 'Value keeps cases.')