1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
|
#
# This file is part of m.css.
#
# Copyright © 2017, 2018, 2019, 2020, 2021, 2022, 2023
# Vladimír Vondruš <mosra@centrum.cz>
#
# Permission is hereby granted, free of charge, to any person obtaining a
# copy of this software and associated documentation files (the "Software"),
# to deal in the Software without restriction, including without limitation
# the rights to use, copy, modify, merge, publish, distribute, sublicense,
# and/or sell copies of the Software, and to permit persons to whom the
# Software is furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included
# in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
# DEALINGS IN THE SOFTWARE.
#
import os
import shutil
import unittest
from pelican import read_settings, Pelican
class MinimalTestCase(unittest.TestCase):
def __init__(self, path, dir, *args, **kwargs):
unittest.TestCase.__init__(self, *args, **kwargs)
# Source files for test_something.py are in something_{dir}/ subdirectory
self.path = os.path.join(os.path.dirname(os.path.realpath(path)), os.path.splitext(os.path.basename(path))[0][5:] + ('_' + dir if dir else ''))
# Display ALL THE DIFFS
self.maxDiff = None
def setUp(self):
if os.path.exists(os.path.join(self.path, 'output')): shutil.rmtree(os.path.join(self.path, 'output'))
def run_pelican(self, settings):
implicit_settings = {
# Contains just stuff that isn't required by the m.css theme itself,
# but is needed to have the test setup working correctly
'RELATIVE_URLS': True,
'TIMEZONE': 'UTC',
'READERS': {'html': None},
'SITEURL': '.',
'PATH': os.path.join(self.path),
'OUTPUT_PATH': os.path.join(self.path, 'output'),
'PAGE_EXCLUDES': [os.path.join(self.path, 'output')],
'ARTICLE_EXCLUDES': [os.path.join(self.path, 'output')],
# Don't render feeds, we don't want to test them all the time
'FEED_ALL_ATOM': None,
'CATEGORY_FEED_ATOM': None
}
implicit_settings.update(settings)
settings = read_settings(path=None, override=implicit_settings)
pelican = Pelican(settings=settings)
pelican.run()
def actual_expected_contents(self, actual, expected = None):
if not expected: expected = actual
with open(os.path.join(self.path, expected)) as f:
expected_contents = f.read().strip()
with open(os.path.join(self.path, 'output', actual)) as f:
actual_contents = f.read().strip()
return actual_contents, expected_contents
class BaseTestCase(MinimalTestCase):
def run_pelican(self, settings):
implicit_settings = {
'THEME': '.',
'PLUGIN_PATHS': ['../plugins'],
'PLUGINS': ['m.htmlsanity'],
'THEME_STATIC_DIR': 'static',
'M_CSS_FILES': ['https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i',
'static/m-dark.css'],
# i.e., not rendering the category, tag and author lists as they
# are not supported anyway
'DIRECT_TEMPLATES': ['index', 'archives'],
'SLUGIFY_SOURCE': 'basename'
}
implicit_settings.update(settings)
MinimalTestCase.run_pelican(self, implicit_settings)
class PageTestCase(BaseTestCase):
def run_pelican(self, settings):
implicit_settings = {
'M_FINE_PRINT': None,
'M_DISABLE_SOCIAL_META_TAGS': True,
'PAGE_PATHS': ['.'],
'PAGE_SAVE_AS': '{slug}.html',
'PAGE_URL': '{slug}.html',
'ARTICLE_PATHS': ['articles'], # doesn't exist
'DIRECT_TEMPLATES': []
}
implicit_settings.update(settings)
BaseTestCase.run_pelican(self, implicit_settings)
class BlogTestCase(BaseTestCase):
def run_pelican(self, settings):
implicit_settings = {
'DATE_FORMATS': {'en': ('en_US.UTF-8', '%b %d, %Y')},
'M_FINE_PRINT': None,
'M_DISABLE_SOCIAL_META_TAGS': True,
'PAGE_PATHS': ['pages'], # doesn't exist, usually
'ARTICLE_PATHS': [''],
'AUTHOR_SAVE_AS': 'author-{slug}.html',
'AUTHOR_URL': 'author-{slug}.html',
'CATEGORY_SAVE_AS': 'category-{slug}.html',
'CATEGORY_URL': 'category-{slug}.html',
'TAG_SAVE_AS': 'tag-{slug}.html',
'TAG_URL': 'tag-{slug}.html',
# No m.css stuff to test there
'CATEGORY_FEED_ATOM': None,
'AUTHOR_FEED_ATOM': None,
'AUTHOR_FEED_RSS': None,
'TRANSLATION_FEED_ATOM': None
}
implicit_settings.update(settings)
BaseTestCase.run_pelican(self, implicit_settings)
|
