forked from iterative/dvc
-
Notifications
You must be signed in to change notification settings - Fork 0
/
conftest.py
261 lines (205 loc) · 7.18 KB
/
conftest.py
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
import json
import os
import sys
from contextlib import suppress
import pytest
from dvc.testing.fixtures import * # noqa, pylint: disable=wildcard-import
from .dir_helpers import * # noqa, pylint: disable=wildcard-import
from .remotes import * # noqa, pylint: disable=wildcard-import
from .scripts import * # noqa, pylint: disable=wildcard-import
# Prevent updater and analytics from running their processes
os.environ["DVC_TEST"] = "true"
# Ensure progress output even when not outputting to raw sys.stderr console
os.environ["DVC_IGNORE_ISATTY"] = "true"
# Disable system git config
os.environ["GIT_CONFIG_NOSYSTEM"] = "1"
REMOTES = {
# remote: enabled_by_default?
"azure": False,
"gdrive": False,
"gs": False,
"hdfs": True,
"real_hdfs": False,
"http": True,
"oss": False,
"s3": False,
"ssh": False,
"webdav": True,
}
@pytest.fixture(autouse=True)
def reset_loglevel(request, caplog):
"""
Use it to ensure log level at the start of each test
regardless of dvc.logger.setup(), Repo configs or whatever.
"""
ini_opt = None
with suppress(ValueError):
ini_opt = request.config.getini("log_level")
level = request.config.getoption("--log-level") or ini_opt
if level:
with caplog.at_level(level.upper(), logger="dvc"):
yield
else:
yield
@pytest.fixture(autouse=True)
def enable_ui():
from dvc.ui import ui
ui.enable()
@pytest.fixture(autouse=True)
def clean_repos():
# pylint: disable=redefined-outer-name
from dvc.external_repo import clean_repos
clean_repos()
def _get_opt(remote_name, action):
return f"--{action}-{remote_name}"
def pytest_addoption(parser):
"""Adds remote-related flags to selectively disable/enable for tests
Eg: If some remotes, eg: ssh is enabled to be tested for by default
(see above `REMOTES`), then, `--disable-ssh` flag is added. If remotes
like `hdfs` are disabled by default, `--enable-hdfs` is added to make them
run.
You can also make everything run-by-default with `--all` flag, which takes
precedence on all previous `--enable-*`/`--disable-*` flags.
"""
parser.addoption(
"--all",
action="store_true",
default=False,
help="Test all of the remotes, unless other flags also supplied",
)
for remote_name in REMOTES:
for action in ("enable", "disable"):
opt = _get_opt(remote_name, action)
parser.addoption(
opt,
action="store_true",
default=None,
help=f"{action} tests for {remote_name}",
)
class DVCTestConfig:
def __init__(self):
self.enabled_remotes = set()
def requires(self, remote_name):
if remote_name not in REMOTES or remote_name in self.enabled_remotes:
return
pytest.skip(f"{remote_name} tests not enabled through CLI")
def apply_marker(self, marker):
self.requires(marker.name)
def pytest_runtest_setup(item):
# Apply test markers to skip tests selectively
# NOTE: this only works on individual tests,
# for fixture, use `test_config` fixture and
# run `test_config.requires(remote_name)`.
for marker in item.iter_markers():
item.config.dvc_config.apply_marker(marker)
if (
"CI" in os.environ
and item.get_closest_marker("needs_internet") is not None
):
# remotes that need internet connection might be flaky,
# so we rerun them in case it fails.
item.add_marker(pytest.mark.flaky(max_runs=5, min_passes=1))
@pytest.fixture(scope="session")
def test_config(request):
return request.config.dvc_config
def pytest_configure(config):
config.dvc_config = DVCTestConfig()
for remote_name in REMOTES:
config.addinivalue_line(
"markers", f"{remote_name}: mark test as requiring {remote_name}"
)
enabled_remotes = config.dvc_config.enabled_remotes
if config.getoption("--all"):
enabled_remotes.update(REMOTES)
else:
default_enabled = {k for k, v in REMOTES.items() if v}
enabled_remotes.update(default_enabled)
for remote_name in REMOTES:
enabled_opt = _get_opt(remote_name, "enable")
disabled_opt = _get_opt(remote_name, "disable")
enabled = config.getoption(enabled_opt)
disabled = config.getoption(disabled_opt)
if disabled and enabled:
continue # default behavior if both flags are supplied
if disabled:
enabled_remotes.discard(remote_name)
if enabled:
enabled_remotes.add(remote_name)
@pytest.fixture
def custom_template(tmp_dir, dvc):
from dvc_render.vega_templates import SimpleLinearTemplate
template = tmp_dir / "custom_template.json"
template.write_text(json.dumps(SimpleLinearTemplate.DEFAULT_CONTENT))
return template
@pytest.fixture(autouse=True)
def mocked_webbrowser_open(mocker):
mocker.patch("webbrowser.open")
@pytest.fixture(autouse=True)
def isolate(tmp_path_factory, monkeypatch) -> None:
path = tmp_path_factory.mktemp("mock")
home_dir = path / "home"
home_dir.mkdir()
if sys.platform == "win32":
home_drive, home_path = os.path.splitdrive(home_dir)
monkeypatch.setenv("USERPROFILE", str(home_dir))
monkeypatch.setenv("HOMEDRIVE", home_drive)
monkeypatch.setenv("HOMEPATH", home_path)
for env_var, sub_path in (
("APPDATA", "Roaming"),
("LOCALAPPDATA", "Local"),
):
path = home_dir / "AppData" / sub_path
path.mkdir(parents=True)
monkeypatch.setenv(env_var, os.fspath(path))
else:
monkeypatch.setenv("HOME", str(home_dir))
monkeypatch.setenv("GIT_CONFIG_NOSYSTEM", "1")
contents = b"""
[user]
name=DVC Tester
[init]
defaultBranch=master
"""
(home_dir / ".gitconfig").write_bytes(contents)
import pygit2
pygit2.settings.search_path[pygit2.GIT_CONFIG_LEVEL_GLOBAL] = str(home_dir)
@pytest.fixture
def run_copy_metrics(tmp_dir, copy_script):
def run(
file1,
file2,
commit=None,
tag=None,
single_stage=True,
name=None,
**kwargs,
):
if name:
single_stage = False
stage = tmp_dir.dvc.run(
cmd=f"python copy.py {file1} {file2}",
deps=[file1],
single_stage=single_stage,
name=name,
**kwargs,
)
if hasattr(tmp_dir.dvc, "scm"):
files = [stage.path]
files += [out.fs_path for out in stage.outs if not out.use_cache]
tmp_dir.dvc.scm.add(files)
if commit:
tmp_dir.dvc.scm.commit(commit)
if tag:
tmp_dir.dvc.scm.tag(tag)
return stage
return run
@pytest.fixture(autouse=True)
def mock_hydra_conf(mocker):
if sys.version_info < (3, 11):
return
# `hydra.conf` fails to import in 3.11, it raises ValueError due to changes
# in dataclasses. See https://github.com/python/cpython/pull/29867.
# NOTE: using sentinel here so that any imports from `hydra.conf`
# return a mock.
sys.modules["hydra.conf"] = mocker.sentinel