aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/test/py/conftest.py
blob: 6c34f4d581cb218de3db147b7c11cfefc36f1e76 (plain) (blame)
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
# Copyright (c) 2023 Egor Tensin <egor@tensin.name>
# This file is part of the "cimple" project.
# For details, see https://github.com/egor-tensin/cimple.
# Distributed under the MIT License.

from collections import namedtuple
import logging
import os

from pytest import fixture

from lib import test_repo as repo
from lib.db import Database
from lib.net import random_unused_port
from lib.process import CmdLine


class Param:
    def __init__(self, codename, help_string, required=True):
        self.codename = codename
        self.help_string = help_string
        self.required = required

    @property
    def cmd_line(self):
        return f"--{self.codename.replace('_', '-')}"

    def add_to_parser(self, parser):
        parser.addoption(self.cmd_line, required=self.required, help=self.help_string)


PARAMS = [
    Param(f'{name}', f'cimple-{name} binary path')
    for name in ('server', 'worker', 'client')
]
PARAMS += [
    Param('sigsegv', 'sigsegv binary path'),
    Param('project_version', 'project version'),
    Param('valgrind', 'path to valgrind.sh', required=False),
    Param('flamegraph', 'path to flamegraph.sh', required=False),
    Param('flame_graphs_dir', 'directory to store flame graphs', required=False),
]


def pytest_addoption(parser):
    for opt in PARAMS:
        opt.add_to_parser(parser)


class Params:
    def __init__(self, pytestconfig):
        for opt in PARAMS:
            setattr(self, opt.codename, None)
        for opt in PARAMS:
            path = pytestconfig.getoption(opt.codename)
            if path is None:
                continue
            logging.info("'%s' parameter value: %s", opt.codename, path)
            setattr(self, opt.codename, path)


@fixture(scope='session')
def params(pytestconfig):
    return Params(pytestconfig)


class CmdLineValgrind(CmdLine):
    def __init__(self, binary):
        # Signal to Valgrind that ci scripts should obviously be exempt from
        # memory leak checking:
        super().__init__(binary, '--trace-children-skip=*/ci', '--')


@fixture(scope='session')
def base_cmd_line(params):
    cmd_line = CmdLine.unbuffered()
    valgrind = params.valgrind
    if valgrind is not None:
        cmd_line = CmdLine.wrap(CmdLineValgrind(valgrind), cmd_line)
    return cmd_line


@fixture(scope='session')
def version(params):
    return params.project_version


@fixture(scope='session')
def server_port():
    return str(random_unused_port())


@fixture
def sqlite_path(tmp_path):
    return os.path.join(tmp_path, 'cimple.sqlite')


@fixture
def sqlite_db(server, sqlite_path):
    return Database(sqlite_path)


class CmdLineServer(CmdLine):
    def log_line_means_process_ready(self, line):
        return line.endswith('Waiting for new connections')


class CmdLineWorker(CmdLine):
    def log_line_means_process_ready(self, line):
        return line.endswith('Waiting for a new command')


@fixture
def server_exe(params):
    return CmdLineServer(params.server)


@fixture
def worker_exe(params):
    return CmdLineWorker(params.worker)


@fixture
def client_exe(params):
    return CmdLine(params.client)


@fixture
def server_cmd(base_cmd_line, params, server_port, sqlite_path):
    args = ['--port', server_port, '--sqlite', sqlite_path]
    return CmdLineServer.wrap(base_cmd_line, CmdLine(params.server, *args))


@fixture
def worker_cmd(base_cmd_line, params, server_port):
    args = ['--host', '127.0.0.1', '--port', server_port]
    return CmdLineWorker.wrap(base_cmd_line, CmdLine(params.worker, *args))


@fixture
def client(base_cmd_line, params, server_port):
    args = ['--host', '127.0.0.1', '--port', server_port]
    return CmdLine.wrap(base_cmd_line, CmdLine(params.client, *args))


@fixture
def sigsegv(params):
    return CmdLine(params.sigsegv)


@fixture
def server(server_cmd):
    with server_cmd.run_async() as server:
        yield server
    assert server.returncode == 0


@fixture
def workers(worker_cmd):
    with worker_cmd.run_async() as worker1, \
         worker_cmd.run_async() as worker2:
        yield [worker1, worker2]
    assert worker1.returncode == 0
    assert worker2.returncode == 0


@fixture
def flame_graph_svg(params, tmp_path, flame_graph_repo):
    dir = params.flame_graphs_dir
    if dir is None:
        return os.path.join(tmp_path, 'flame_graph.svg')
    os.makedirs(dir, exist_ok=True)
    return os.path.join(dir, f'flame_graph_{flame_graph_repo.codename()}.svg')


@fixture
def profiler(params, server, workers, flame_graph_svg):
    pids = [server.pid] + [worker.pid for worker in workers]
    pids = map(str, pids)
    cmd_line = CmdLine(params.flamegraph, flame_graph_svg, *pids)
    with cmd_line.run_async() as proc:
        yield
    assert proc.returncode == 0


@fixture
def repo_path(tmp_path):
    return os.path.join(tmp_path, 'repo')


TEST_REPOS = [
    repo.TestRepoOutputSimple,
    repo.TestRepoOutputEmpty,
    repo.TestRepoOutputLong,
    repo.TestRepoOutputNull,
    repo.TestRepoSegfault,
]

STRESS_TEST_REPOS = [
    repo.TestRepoOutputSimple,
    repo.TestRepoOutputLong,
]


def _make_repo(repo_path, params, cls):
    args = [repo_path]
    if cls is repo.TestRepoSegfault:
        args += [params.sigsegv]
    return cls(*args)


@fixture(params=TEST_REPOS, ids=[repo.codename() for repo in TEST_REPOS])
def test_repo(repo_path, params, request):
    return _make_repo(repo_path, params, request.param)


@fixture(params=STRESS_TEST_REPOS, ids=[repo.codename() for repo in STRESS_TEST_REPOS])
def stress_test_repo(repo_path, params, request):
    return _make_repo(repo_path, params, request.param)


@fixture
def flame_graph_repo(stress_test_repo):
    return stress_test_repo


Env = namedtuple('Env', ['server', 'workers', 'client', 'db'])


@fixture
def env(server, workers, client, sqlite_db):
    return Env(server, workers, client, sqlite_db)