From 01a6580b3d333372b942887677614cace795e5e9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Peter=20Rowlands=20=28=EB=B3=80=EA=B8=B0=ED=98=B8=29?= Date: Tue, 25 Aug 2020 20:33:14 +0900 Subject: [PATCH] experiments: fix inconsistent dvc exp checkout behavior (#4461) * experiments: stage workspace changes before using stash apply * add test for dvc exp checkout --- dvc/repo/experiments/__init__.py | 19 ++++++++++++--- tests/func/experiments/test_experiments.py | 27 ++++++++++++++++++++++ 2 files changed, 43 insertions(+), 3 deletions(-) diff --git a/dvc/repo/experiments/__init__.py b/dvc/repo/experiments/__init__.py index 947ed09f5..1d65a743a 100644 --- a/dvc/repo/experiments/__init__.py +++ b/dvc/repo/experiments/__init__.py @@ -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 diff --git a/tests/func/experiments/test_experiments.py b/tests/func/experiments/test_experiments.py index bc41e62c6..52330df0a 100644 --- a/tests/func/experiments/test_experiments.py +++ b/tests/func/experiments/test_experiments.py @@ -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"