summaryrefslogtreecommitdiff
path: root/tests/conftest.py
blob: 063f4a22844fbc59ba68a6aa0a67ff89af20d9c4 (plain)
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
import os
import sys
import pytest
import shutil
from pathlib import Path
from typing import Any, Callable
from pytest import MonkeyPatch
from argparse import ArgumentParser
from datetime import datetime, timezone
from importlib.metadata import version as v
from logging import Logger, getLogger, DEBUG

from pyssg.arg_parser import get_parser
from pyssg.custom_logger import setup_logger
from pyssg.database_entry import DatabaseEntry


@pytest.fixture(scope='session')
def version():
    return v('pyssg')


@pytest.fixture(scope='session')
def rss_date_fmt():
    return '%a, %d %b %Y %H:%M:%S GMT'


@pytest.fixture(scope='session')
def sitemap_date_fmt():
    return '%Y-%m-%d'


@pytest.fixture(scope='session')
def test_dir() -> str:
    return str(os.path.dirname(os.path.abspath(__file__)))


@pytest.fixture(scope='session')
def test_resource() -> str:
    return 'tests.io_files'


@pytest.fixture(scope='session')
def simple_yaml() -> str:
    return 'simple.yaml'


@pytest.fixture(scope='session')
def arg_parser() -> ArgumentParser:
    return get_parser()


@pytest.fixture(scope='session')
def logger() -> Logger:
    setup_logger(__name__, DEBUG)
    return getLogger(__name__)


@pytest.fixture
def capture_stdout(monkeypatch: MonkeyPatch) -> dict[str, str | int]:
    buffer: dict[str, str | int] = {'stdout': '', 'write_calls': 0}

    def fake_writer(s):
        buffer['stdout'] += s
        buffer['write_calls'] += 1  # type: ignore

    monkeypatch.setattr(sys.stdout, 'write', fake_writer)
    return buffer


@pytest.fixture
def get_fmt_time() -> Callable[..., str]:
    def fmt_time(fmt: str) -> str:
        return datetime.now(tz=timezone.utc).strftime(fmt)
    return fmt_time


@pytest.fixture
def simple_dict() -> dict[str, Any]:
    return {'define': '$PYSSG_HOME/pyssg/site_example/',
            'title': 'Example site',
            'path': {
                'src': '/tmp/pyssg/pyssg/site_example/src',
                'dst': '/tmp/pyssg/pyssg/site_example/dst',
                'plt': '/tmp/pyssg/pyssg/site_example/plt',
                'db': '/tmp/pyssg/pyssg/site_example/.files'},
            'url': {
                'main': 'https://example.com',
                'static': 'https://static.example.com',
                'default_image': 'images/default.png'},
            'fmt': {
                'date': '%a, %b %d, %Y @ %H:%M %Z',
                'list_date': '%b %d',
                'list_sep_date': '%B %Y'},
            'dirs': {
                '/': {
                    'cfg': {
                        'plt': 'page.html',
                        'tags': False,
                        'index': False,
                        'rss': False,
                        'sitemap': False,
                        'exclude_dirs': []}}}}


@pytest.fixture(scope='function')
def tmp_dir_structure(tmp_path: Path) -> Path:
    root: Path = tmp_path/'dir_str'
    # order matters
    dirs: list[Path] = [root,
                        root/'first',
                        root/'first/f1',
                        root/'first/f1/f2',
                        root/'second',
                        root/'second/s1']
    for i, d in enumerate(dirs):
        d.mkdir()
        for ext in ['txt', 'md', 'html']:
            (d/f'f{i}.{ext}').write_text('sample')
    return root


@pytest.fixture(scope='session')
def tmp_db_e1() -> DatabaseEntry:
    return DatabaseEntry(('first.md',
                          1671076311.823135,
                          0.0,
                          '778bce781d95730cd1e872a10130e20d',
                          '-'))


@pytest.fixture(scope='session')
def tmp_db_e2() -> DatabaseEntry:
    return DatabaseEntry(('a/second.md',
                          1671077831.63301,
                          # 1671078892.892921,
                          1677381461.8107588,
                          #'6092d6471d3a83135293e34ef6012939',
                          'a61d0116844b6ebc02db62b4b1bf453d',
                          'english,short,update'))


@pytest.fixture(scope='function')
def tmp_db(tmp_path: Path,
           tmp_db_e1: DatabaseEntry,
           tmp_db_e2: DatabaseEntry) -> Path:
    root: Path = tmp_path/'db'
    db_path: Path = tmp_path/'db/sample_db.psv'
    root.mkdir()
    e1: str = '|'.join(tmp_db_e1.get_raw_entry())
    e2: str = '|'.join(tmp_db_e2.get_raw_entry())
    db_path.write_text(f'{e1}\n{e2}\n')
    return db_path


@pytest.fixture(scope='function')
def tmp_db_wrong_col_num(tmp_path: Path) -> Path:
    root: Path = tmp_path/'db'
    db_path: Path = tmp_path/'db/sample_db_wrong_col_num.psv'
    root.mkdir()
    # missing tags, could be anything though
    db_path.write_text('name|0.0|0.0|cksm\n')
    return db_path


@pytest.fixture(scope='function')
def tmp_src_dir(tmp_path: Path,
                test_dir: str) -> Path:
    src: Path = tmp_path/'src'
    src_a: Path = src/'a'
    src.mkdir()
    src_a.mkdir()
    src_test: str = f'{test_dir}/io_files/md'

    files: list[str] = ['first.md', 'new.md', 'a/second.md']
    for f in files:
        shutil.copy2(f'{src_test}/{f}', f'{str(src)}/{f}')
    return src