experiments: fix inconsistent dvc exp checkout behavior (#4461)

* experiments: stage workspace changes before using stash apply

* add test for dvc exp checkout
This commit is contained in:
Peter Rowlands (변기호)
2020-08-25 14:33:14 +03:00
committed by GitHub
parent 026c4fa47d
commit 01a6580b3d
2 changed files with 43 additions and 3 deletions
+16 -3
View File
@@ -557,10 +557,23 @@ class Experiments:
# to prefer the applied experiment changes over stashed workspace
# changes. git stash doesn't support merge strategy parameters, but we
# can do it ourselves with checkout/reset.
from git.exc import GitCommandError
logger.debug("Unstashing workspace changes.")
self.repo.scm.repo.git.checkout("--ours", "stash@{0}", "--", ".")
self.repo.scm.repo.git.reset("HEAD")
self.repo.scm.repo.git.stash("drop", "stash@{0}")
git_repo = self.repo.scm.repo.git
# stage workspace changes, then apply stashed changes on top
git_repo.add(A=True)
try:
git_repo.stash("apply", "stash@{0}")
except GitCommandError:
# stash apply will return error code on merge conflicts,
# prefer workspace changes over stash changes
git_repo.checkout("--ours", "--", ".")
# unstage changes and drop the stash entry
git_repo.reset("HEAD")
git_repo.stash("drop", "stash@{0}")
def checkout(self, *args, **kwargs):
from dvc.repo.experiments.checkout import checkout
@@ -49,3 +49,30 @@ def test_update_with_pull(tmp_dir, scm, dvc, mocker):
exp_scm = dvc.experiments.scm
for rev in expected_revs:
assert exp_scm.has_rev(rev)
def test_checkout(tmp_dir, scm, dvc):
tmp_dir.gen("copy.py", COPY_SCRIPT)
tmp_dir.gen("params.yaml", "foo: 1")
stage = dvc.run(
cmd="python copy.py params.yaml metrics.yaml",
metrics_no_cache=["metrics.yaml"],
params=["foo"],
name="copy-file",
)
scm.add(["dvc.yaml", "dvc.lock", "copy.py", "params.yaml", "metrics.yaml"])
scm.commit("init")
dvc.reproduce(stage.addressing, experiment=True, params=["foo=2"])
exp_a = dvc.experiments.scm.get_rev()
dvc.reproduce(stage.addressing, experiment=True, params=["foo=3"])
exp_b = dvc.experiments.scm.get_rev()
dvc.experiments.checkout(exp_a)
assert (tmp_dir / "params.yaml").read_text().strip() == "foo: 2"
assert (tmp_dir / "metrics.yaml").read_text().strip() == "foo: 2"
dvc.experiments.checkout(exp_b)
assert (tmp_dir / "params.yaml").read_text().strip() == "foo: 3"
assert (tmp_dir / "metrics.yaml").read_text().strip() == "foo: 3"