File: test_blag.py

package info (click to toggle)
blag 2.3.3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 520 kB
  • sloc: python: 1,037; makefile: 71
file content (360 lines) | stat: -rw-r--r-- 9,939 bytes parent folder | download
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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
"""Test blag."""

import os
from argparse import Namespace
from datetime import datetime
from tempfile import TemporaryDirectory
from typing import Any

import pytest
from jinja2 import Template
from pytest import CaptureFixture, LogCaptureFixture

from blag import __VERSION__, blag


def test_generate_feed(cleandir: str) -> None:
    """Test generate_feed."""
    articles: list[tuple[str, dict[str, Any]]] = []
    blag.generate_feed(articles, "build", " ", " ", " ", " ")
    assert os.path.exists("build/atom.xml")


def test_feed(cleandir: str) -> None:
    """Test feed."""
    articles: list[tuple[str, dict[str, Any]]] = [
        (
            "dest1.html",
            {
                "title": "title1",
                "date": datetime(2019, 6, 6),
                "content": "content1",
            },
        ),
        (
            "dest2.html",
            {
                "title": "title2",
                "date": datetime(1980, 5, 9),
                "content": "content2",
            },
        ),
    ]

    blag.generate_feed(
        articles,
        "build",
        "https://example.com/",
        "blog title",
        "blog description",
        "blog author",
    )
    with open("build/atom.xml") as fh:
        feed = fh.read()

    assert "<title>blog title</title>" in feed
    # enable when https://github.com/getpelican/feedgenerator/issues/22
    # is fixed
    # assert '<subtitle>blog description</subtitle>' in feed
    assert "<author><name>blog author</name></author>" in feed

    # article 1
    assert "<title>title1</title>" in feed
    assert '<summary type="html">title1' in feed
    assert "<published>2019-06-06" in feed
    assert '<content type="html">content1' in feed
    assert '<link href="https://example.com/dest1.html"' in feed

    # article 2
    assert "<title>title2</title>" in feed
    assert '<summary type="html">title2' in feed
    assert "<published>1980-05-09" in feed
    assert '<content type="html">content2' in feed
    assert '<link href="https://example.com/dest2.html"' in feed


def test_generate_feed_with_description(cleandir: str) -> None:
    """Test generate_feed with description."""
    # if a description is provided, it will be used as the summary in
    # the feed, otherwise we simply use the title of the article
    articles: list[tuple[str, dict[str, Any]]] = [
        (
            "dest.html",
            {
                "title": "title",
                "description": "description",
                "date": datetime(2019, 6, 6),
                "content": "content",
            },
        )
    ]
    blag.generate_feed(articles, "build", " ", " ", " ", " ")

    with open("build/atom.xml") as fh:
        feed = fh.read()

    assert "<title>title</title>" in feed
    assert '<summary type="html">description' in feed
    assert "<published>2019-06-06" in feed
    assert '<content type="html">content' in feed


def test_feed_is_unicode(cleandir: str) -> None:
    """Test generate_feed."""
    articles: list[tuple[str, dict[str, Any]]] = []
    blag.generate_feed(articles, "build", " ", " ", " ", " ")
    with open("build/atom.xml") as fh:
        feed = fh.read()
    assert 'encoding="utf-8"' in feed


def test_parse_args_build() -> None:
    """Test parse_args with build."""
    # test default args
    args = blag.parse_args(["build"])
    assert args.input_dir == "content"
    assert args.output_dir == "build"
    assert args.template_dir == "templates"
    assert args.static_dir == "static"

    # input dir
    args = blag.parse_args(["build", "-i", "foo"])
    assert args.input_dir == "foo"
    args = blag.parse_args(["build", "--input-dir", "foo"])
    assert args.input_dir == "foo"

    # output dir
    args = blag.parse_args(["build", "-o", "foo"])
    assert args.output_dir == "foo"
    args = blag.parse_args(["build", "--output-dir", "foo"])
    assert args.output_dir == "foo"

    # template dir
    args = blag.parse_args(["build", "-t", "foo"])
    assert args.template_dir == "foo"
    args = blag.parse_args(["build", "--template-dir", "foo"])
    assert args.template_dir == "foo"

    # static dir
    args = blag.parse_args(["build", "-s", "foo"])
    assert args.static_dir == "foo"
    args = blag.parse_args(["build", "--static-dir", "foo"])
    assert args.static_dir == "foo"


def test_get_config() -> None:
    """Test get_config."""
    config = """
[main]
base_url = https://example.com/
title = title
description = description
author = a. u. thor
    """
    # happy path
    with TemporaryDirectory() as dir:
        configfile = f"{dir}/config.ini"
        with open(configfile, "w") as fh:
            fh.write(config)

        config_parsed = blag.get_config(configfile)
        assert config_parsed["base_url"] == "https://example.com/"
        assert config_parsed["title"] == "title"
        assert config_parsed["description"] == "description"
        assert config_parsed["author"] == "a. u. thor"

    # a missing required config causes a sys.exit
    for x in "base_url", "title", "description", "author":
        config2 = "\n".join(
            [line for line in config.splitlines() if not line.startswith(x)]
        )
        with TemporaryDirectory() as dir:
            configfile = f"{dir}/config.ini"
            with open(configfile, "w") as fh:
                fh.write(config2)
            with pytest.raises(SystemExit):
                config_parsed = blag.get_config(configfile)

    # base_url gets / appended if it is missing
    config = """
[main]
base_url = https://example.com
title = title
description = description
author = a. u. thor
    """
    with TemporaryDirectory() as dir:
        configfile = f"{dir}/config.ini"
        with open(configfile, "w") as fh:
            fh.write(config)

        config_parsed = blag.get_config(configfile)
        assert config_parsed["base_url"] == "https://example.com/"


def test_environment_factory(cleandir: str) -> None:
    """Test environment_factory."""
    globals_: dict[str, object] = {"foo": "bar", "test": "me"}
    env = blag.environment_factory("templates", globals_=globals_)
    assert env.globals["foo"] == "bar"
    assert env.globals["test"] == "me"


def test_process_markdown(
    cleandir: str,
    page_template: Template,
    article_template: Template,
) -> None:
    """Test process_markdown."""
    page1 = """\
title: some page

some text
foo bar
    """

    article1 = """\
title: some article1
date: 2020-01-01

some text
foo bar
    """

    article2 = """\
title: some article2
date: 2021-01-01

some text
foo bar
    """

    convertibles = []
    for i, txt in enumerate((page1, article1, article2)):
        with open(f"content/{str(i)}", "w") as fh:
            fh.write(txt)
        convertibles.append((str(i), str(i)))

    articles, pages = blag.process_markdown(
        convertibles, "content", "build", page_template, article_template
    )

    assert isinstance(articles, list)
    assert len(articles) == 2
    for dst, context in articles:
        assert isinstance(dst, str)
        assert isinstance(context, dict)
        assert "content" in context

    assert isinstance(pages, list)
    assert len(pages) == 1
    for dst, context in pages:
        assert isinstance(dst, str)
        assert isinstance(context, dict)
        assert "content" in context


def test_build(args: Namespace) -> None:
    """Test build."""
    page1 = """\
title: some page

some text
foo bar
    """

    article1 = """\
title: some article1
date: 2020-01-01
tags: foo, bar

some text
foo bar
    """

    article2 = """\
title: some article2
date: 2021-01-01
tags: baz

some text
foo bar
    """

    # write some convertibles
    convertibles = []
    for i, txt in enumerate((page1, article1, article2)):
        with open(f"{args.input_dir}/{str(i)}.md", "w") as fh:
            fh.write(txt)
        convertibles.append((str(i), str(i)))

    # some static files
    with open(f"{args.static_dir}/test", "w") as fh:
        fh.write("hello")

    os.mkdir(f"{args.input_dir}/testdir")
    with open(f"{args.input_dir}/testdir/test", "w") as fh:
        fh.write("hello")

    blag.build(args)

    # test existence of the three converted files
    for i in range(3):
        assert os.path.exists(f"{args.output_dir}/{i}.html")
    # ... static file
    assert os.path.exists(f"{args.output_dir}/test")
    # ... directory
    assert os.path.exists(f"{args.output_dir}/testdir/test")
    # ... feed
    assert os.path.exists(f"{args.output_dir}/atom.xml")
    # ... index
    assert os.path.exists(f"{args.output_dir}/index.html")
    # ... archive
    assert os.path.exists(f"{args.output_dir}/archive.html")
    # ... tags
    assert os.path.exists(f"{args.output_dir}/tags/index.html")
    assert os.path.exists(f"{args.output_dir}/tags/foo.html")
    assert os.path.exists(f"{args.output_dir}/tags/bar.html")


@pytest.mark.parametrize(
    "template",
    [
        "page.html",
        "article.html",
        "index.html",
        "archive.html",
        "tags.html",
        "tag.html",
    ],
)
def test_missing_template_raises(template: str, args: Namespace) -> None:
    """Test that missing templates raise SystemExit."""
    os.remove(f"templates/{template}")
    with pytest.raises(SystemExit):
        blag.build(args)


def test_main(cleandir: str) -> None:
    """Test main."""
    blag.main(["build"])


def test_cli_version(capsys: CaptureFixture[str]) -> None:
    """Test --version."""
    with pytest.raises(SystemExit) as ex:
        blag.main(["--version"])
    # normal system exit
    assert ex.value.code == 0
    # proper version reported
    out, _ = capsys.readouterr()
    assert __VERSION__ in out


def test_cli_verbose(cleandir: str, caplog: LogCaptureFixture) -> None:
    """Test --verbose."""
    blag.main(["build"])
    assert "DEBUG" not in caplog.text

    blag.main(["--verbose", "build"])
    assert "DEBUG" in caplog.text