-
Notifications
You must be signed in to change notification settings - Fork 37
/
Copy pathtest_dvc.py
231 lines (182 loc) · 6.92 KB
/
test_dvc.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
import os
import pytest
from dvc.exceptions import DvcException
from dvc.repo import Repo
from dvc.scm import NoSCM
from scmrepo.git import Git
from dvclive import Live
from dvclive.dvc import get_dvc_repo
from dvclive.env import DVC_EXP_BASELINE_REV, DVC_EXP_NAME, DVC_ROOT, DVCLIVE_TEST
def test_get_dvc_repo(tmp_dir):
assert get_dvc_repo() is None
Git.init(tmp_dir)
assert isinstance(get_dvc_repo(), Repo)
def test_get_dvc_repo_subdir(tmp_dir):
Git.init(tmp_dir)
subdir = tmp_dir / "sub"
subdir.mkdir()
os.chdir(subdir)
assert get_dvc_repo().root_dir == str(tmp_dir)
@pytest.mark.parametrize("save", [True, False])
def test_exp_save_on_end(tmp_dir, save, mocked_dvc_repo):
live = Live(save_dvc_exp=save)
live.end()
assert live._baseline_rev is not None
assert live._exp_name is not None
if save:
mocked_dvc_repo.experiments.save.assert_called_with(
name=live._exp_name,
include_untracked=[live.dir, "dvc.yaml"],
force=True,
message=None,
)
else:
mocked_dvc_repo.experiments.save.assert_not_called()
def test_exp_save_skip_on_env_vars(tmp_dir, monkeypatch):
monkeypatch.setenv(DVC_EXP_BASELINE_REV, "foo")
monkeypatch.setenv(DVC_EXP_NAME, "bar")
monkeypatch.setenv(DVC_ROOT, tmp_dir)
live = Live()
live.end()
assert live._dvc_repo is None
assert live._baseline_rev == "foo"
assert live._exp_name == "bar"
assert live._inside_dvc_exp
assert live._inside_dvc_pipeline
def test_exp_save_with_dvc_files(tmp_dir, mocker):
dvc_repo = mocker.MagicMock()
dvc_file = mocker.MagicMock()
dvc_file.is_data_source = True
dvc_repo.index.stages = [dvc_file]
dvc_repo.scm.get_rev.return_value = "current_rev"
dvc_repo.scm.get_ref.return_value = None
dvc_repo.scm.no_commits = False
dvc_repo.root_dir = tmp_dir
dvc_repo.config = {}
mocker.patch("dvclive.live.get_dvc_repo", return_value=dvc_repo)
live = Live()
live.end()
dvc_repo.experiments.save.assert_called_with(
name=live._exp_name,
include_untracked=[live.dir, "dvc.yaml"],
force=True,
message=None,
)
def test_exp_save_dvcexception_is_ignored(tmp_dir, mocker):
from dvc.exceptions import DvcException
dvc_repo = mocker.MagicMock()
dvc_repo.index.stages = []
dvc_repo.scm.get_rev.return_value = "current_rev"
dvc_repo.scm.get_ref.return_value = None
dvc_repo.config = {}
dvc_repo.experiments.save.side_effect = DvcException("foo")
mocker.patch("dvclive.live.get_dvc_repo", return_value=dvc_repo)
with Live():
pass
def test_untracked_dvclive_files_inside_dvc_exp_run_are_added(
tmp_dir, mocked_dvc_repo, monkeypatch
):
monkeypatch.setenv(DVC_EXP_BASELINE_REV, "foo")
monkeypatch.setenv(DVC_EXP_NAME, "bar")
monkeypatch.setenv(DVC_ROOT, tmp_dir)
plot_file = os.path.join("dvclive", "plots", "metrics", "foo.tsv")
mocked_dvc_repo.scm.untracked_files.return_value = [
"dvclive/metrics.json",
plot_file,
]
with Live() as live:
live.log_metric("foo", 1)
live.next_step()
live._dvc_repo.scm.add.assert_any_call(["dvclive/metrics.json", plot_file])
live._dvc_repo.scm.add.assert_any_call(live.dvc_file)
def test_dvc_outs_are_not_added(tmp_dir, mocked_dvc_repo, monkeypatch):
"""Regression test for https://github.com/iterative/dvclive/issues/516"""
monkeypatch.setenv(DVC_EXP_BASELINE_REV, "foo")
monkeypatch.setenv(DVC_EXP_NAME, "bar")
monkeypatch.setenv(DVC_ROOT, tmp_dir)
mocked_dvc_repo.index.outs = ["dvclive/plots"]
plot_file = os.path.join("dvclive", "plots", "metrics", "foo.tsv")
mocked_dvc_repo.scm.untracked_files.return_value = [
"dvclive/metrics.json",
plot_file,
]
with Live() as live:
live.log_metric("foo", 1)
live.next_step()
live._dvc_repo.scm.add.assert_any_call(["dvclive/metrics.json"])
def test_errors_on_git_add_are_catched(tmp_dir, mocked_dvc_repo, monkeypatch):
monkeypatch.setenv(DVC_EXP_BASELINE_REV, "foo")
monkeypatch.setenv(DVC_EXP_NAME, "bar")
mocked_dvc_repo.scm.untracked_files.return_value = ["dvclive/metrics.json"]
mocked_dvc_repo.scm.add.side_effect = DvcException("foo")
with Live() as live:
live.summary["foo"] = 1
def test_exp_save_message(tmp_dir, mocked_dvc_repo):
live = Live(exp_message="Custom message")
live.end()
mocked_dvc_repo.experiments.save.assert_called_with(
name=live._exp_name,
include_untracked=[live.dir, "dvc.yaml"],
force=True,
message="Custom message",
)
def test_exp_save_name(tmp_dir, mocked_dvc_repo):
live = Live(exp_name="custom-name")
live.end()
mocked_dvc_repo.experiments.save.assert_called_with(
name="custom-name",
include_untracked=[live.dir, "dvc.yaml"],
force=True,
message=None,
)
def test_no_scm_repo(tmp_dir, mocker):
dvc_repo = mocker.MagicMock()
dvc_repo.scm = NoSCM()
mocker.patch("dvclive.live.get_dvc_repo", return_value=dvc_repo)
live = Live()
assert live._dvc_repo == dvc_repo
live = Live()
assert live._save_dvc_exp is False
def test_dvc_repro(tmp_dir, monkeypatch, mocked_dvc_repo, mocked_studio_post):
monkeypatch.setenv(DVC_ROOT, "root")
live = Live(save_dvc_exp=True)
assert live._baseline_rev is not None
assert live._exp_name is not None
assert not live._studio_events_to_skip
assert not live._save_dvc_exp
def test_get_exp_name_valid(tmp_dir, mocked_dvc_repo):
live = Live(exp_name="name")
assert live._exp_name == "name"
def test_get_exp_name_random(tmp_dir, mocked_dvc_repo, mocker):
mocker.patch(
"dvc.repo.experiments.utils.get_random_exp_name", return_value="random"
)
live = Live()
assert live._exp_name == "random"
def test_get_exp_name_invalid(tmp_dir, mocked_dvc_repo, mocker, caplog):
mocker.patch(
"dvc.repo.experiments.utils.get_random_exp_name", return_value="random"
)
with caplog.at_level("WARNING"):
live = Live(exp_name="invalid//name")
assert live._exp_name == "random"
assert caplog.text
def test_get_exp_name_duplicate(tmp_dir, mocked_dvc_repo, mocker, caplog):
mocker.patch(
"dvc.repo.experiments.utils.get_random_exp_name", return_value="random"
)
mocked_dvc_repo.scm.get_ref.return_value = "duplicate"
with caplog.at_level("WARNING"):
live = Live(exp_name="duplicate")
assert live._exp_name == "random"
msg = "Experiment conflicts with existing experiment 'duplicate'."
assert msg in caplog.text
def test_test_mode(tmp_dir, monkeypatch, mocked_dvc_repo):
monkeypatch.setenv(DVCLIVE_TEST, "true")
live = Live("dir", dvcyaml="dvc.yaml")
live.make_dvcyaml()
assert live._dir != "dir"
assert live._dvc_file != "dvc.yaml"
assert live._save_dvc_exp is False
assert not os.path.exists("dir")
assert not os.path.exists("dvc.yaml")