mirror of
https://github.com/Stone-Red-Code/dvc.git
synced 2026-11-02 07:18:25 +01:00
Raphaël Michelandpre-commit-ci[bot]
368c785410
* Add keep_selected parameter, and corresponding code to keep only the selected exps (and remove all the other ones) * test keep_selected_by_name * test keep_selected_by_rev * test keep_selected multiple, by name * test keep all by name * test keep by rev, with num=2 * added option to cli * refactoring to meet pr needs * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * fixed test_experiments to add keep_selected=False to remove tests * rename parameter to match cli option * follow the normal path, then invert the selection before removing * fixed tests for list ordering + fixed test with non existent name, it didn't make sense to delete everything if an exp name did not exist * changed cli option comment * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * fixed typing issue * updated parameter name * removed handling queued experiments (since --queue would remove them all) * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * code simplification, added __eq__ and __hash__ to be able to compare ExpRefs, updated and parametrized tests. * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * fixed linting issues * - --keep and --queue together raise an InvalidArgumentError - added a test to check if the error is raised - fixed CLI message * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * re-run gh tests. Some tests which did not involve my changes started failing while they were passing fine before. --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
520 lines
13 KiB
Python
520 lines
13 KiB
Python
import pytest
|
|
|
|
from dvc.cli import parse_args
|
|
from dvc.commands.experiments.apply import CmdExperimentsApply
|
|
from dvc.commands.experiments.branch import CmdExperimentsBranch
|
|
from dvc.commands.experiments.clean import CmdExperimentsClean
|
|
from dvc.commands.experiments.diff import CmdExperimentsDiff
|
|
from dvc.commands.experiments.ls import CmdExperimentsList
|
|
from dvc.commands.experiments.pull import CmdExperimentsPull
|
|
from dvc.commands.experiments.push import CmdExperimentsPush
|
|
from dvc.commands.experiments.remove import CmdExperimentsRemove
|
|
from dvc.commands.experiments.rename import CmdExperimentsRename
|
|
from dvc.commands.experiments.run import CmdExperimentsRun
|
|
from dvc.commands.experiments.save import CmdExperimentsSave
|
|
from dvc.commands.experiments.show import CmdExperimentsShow
|
|
from dvc.exceptions import InvalidArgumentError
|
|
|
|
from .test_repro import common_arguments as repro_arguments
|
|
|
|
|
|
def test_experiments_apply(dvc, scm, mocker):
|
|
cli_args = parse_args(["experiments", "apply", "exp_rev"])
|
|
assert cli_args.func == CmdExperimentsApply
|
|
|
|
cmd = cli_args.func(cli_args)
|
|
m = mocker.patch("dvc.repo.experiments.apply.apply", return_value={})
|
|
|
|
assert cmd.run() == 0
|
|
|
|
m.assert_called_once_with(cmd.repo, "exp_rev")
|
|
|
|
|
|
def test_experiments_diff(dvc, scm, mocker):
|
|
cli_args = parse_args(
|
|
[
|
|
"experiments",
|
|
"diff",
|
|
"HEAD~10",
|
|
"HEAD~1",
|
|
"--all",
|
|
"--param-deps",
|
|
"--json",
|
|
"--md",
|
|
"--precision",
|
|
"10",
|
|
]
|
|
)
|
|
assert cli_args.func == CmdExperimentsDiff
|
|
|
|
cmd = cli_args.func(cli_args)
|
|
m = mocker.patch("dvc.repo.experiments.diff.diff", return_value={})
|
|
|
|
assert cmd.run() == 0
|
|
|
|
m.assert_called_once_with(
|
|
cmd.repo, a_rev="HEAD~10", b_rev="HEAD~1", all=True, param_deps=True
|
|
)
|
|
|
|
|
|
def test_experiments_diff_revs(mocker, capsys, dvc, scm):
|
|
mocker.patch(
|
|
"dvc.repo.experiments.diff.diff",
|
|
return_value={
|
|
"params": {"params.yaml": {"foo": {"diff": 1, "old": 1, "new": 2}}},
|
|
"metrics": {"metrics.yaml": {"foo": {"diff": 1, "old": 1, "new": 2}}},
|
|
},
|
|
)
|
|
|
|
cli_args = parse_args(["exp", "diff", "exp_a", "exp_b"])
|
|
cmd = cli_args.func(cli_args)
|
|
|
|
capsys.readouterr()
|
|
assert cmd.run() == 0
|
|
cap = capsys.readouterr()
|
|
assert "exp_a" in cap.out
|
|
assert "exp_b" in cap.out
|
|
|
|
|
|
def test_experiments_show(dvc, scm, mocker):
|
|
cli_args = parse_args(
|
|
[
|
|
"experiments",
|
|
"show",
|
|
"--all-tags",
|
|
"--all-branches",
|
|
"--all-commits",
|
|
"--hide-queued",
|
|
"--hide-failed",
|
|
"--sha",
|
|
"--param-deps",
|
|
"-n",
|
|
"1",
|
|
"--rev",
|
|
"foo",
|
|
"--force",
|
|
]
|
|
)
|
|
assert cli_args.func == CmdExperimentsShow
|
|
|
|
cmd = cli_args.func(cli_args)
|
|
|
|
m = mocker.patch("dvc.repo.experiments.show.show", return_value={})
|
|
assert cmd.run() == 0
|
|
|
|
m.assert_called_once_with(
|
|
cmd.repo,
|
|
all_tags=True,
|
|
all_branches=True,
|
|
all_commits=True,
|
|
hide_queued=True,
|
|
hide_failed=True,
|
|
num=1,
|
|
revs=["foo"],
|
|
sha_only=True,
|
|
param_deps=True,
|
|
fetch_running=True,
|
|
force=True,
|
|
)
|
|
|
|
|
|
def test_experiments_run(dvc, scm, mocker):
|
|
default_arguments = {
|
|
"params": [],
|
|
"name": None,
|
|
"queue": False,
|
|
"run_all": False,
|
|
"jobs": 1,
|
|
"tmp_dir": False,
|
|
"copy_paths": [],
|
|
"message": None,
|
|
}
|
|
default_arguments.update(repro_arguments)
|
|
|
|
cmd = CmdExperimentsRun(parse_args(["exp", "run"]))
|
|
mocker.patch.object(cmd.repo, "reproduce")
|
|
mocker.patch.object(cmd.repo.experiments, "run")
|
|
cmd.run()
|
|
cmd.repo.experiments.run.assert_called_with(**default_arguments)
|
|
|
|
|
|
@pytest.mark.parametrize("flag", ["-m", "-M", "--message"])
|
|
def test_experiments_run_message(dvc, scm, mocker, flag):
|
|
default_arguments = {
|
|
"params": [],
|
|
"name": None,
|
|
"queue": False,
|
|
"run_all": False,
|
|
"jobs": 1,
|
|
"tmp_dir": False,
|
|
"copy_paths": [],
|
|
"message": "mymessage",
|
|
}
|
|
default_arguments.update(repro_arguments)
|
|
|
|
cmd = CmdExperimentsRun(parse_args(["exp", "run", flag, "mymessage"]))
|
|
mocker.patch.object(cmd.repo, "reproduce")
|
|
mocker.patch.object(cmd.repo.experiments, "run")
|
|
cmd.run()
|
|
cmd.repo.experiments.run.assert_called_with(**default_arguments)
|
|
|
|
|
|
def test_experiments_branch(dvc, scm, mocker):
|
|
m = mocker.patch("dvc.repo.experiments.branch.branch", return_value={})
|
|
|
|
cli_args = parse_args(["experiments", "branch", "expname"])
|
|
assert cli_args.func == CmdExperimentsBranch
|
|
|
|
cmd = cli_args.func(cli_args)
|
|
assert cmd.run() == 0
|
|
|
|
m.assert_called_with(cmd.repo, "expname", None)
|
|
|
|
cli_args = parse_args(["experiments", "branch", "expname", "branchname"])
|
|
cmd = cli_args.func(cli_args)
|
|
assert cmd.run() == 0
|
|
|
|
m.assert_called_with(cmd.repo, "expname", "branchname")
|
|
|
|
|
|
def test_experiments_list(dvc, scm, mocker):
|
|
cli_args = parse_args(
|
|
[
|
|
"experiments",
|
|
"list",
|
|
"origin",
|
|
"--all-commits",
|
|
"-n",
|
|
"-1",
|
|
"--rev",
|
|
"foo",
|
|
"--name-only",
|
|
]
|
|
)
|
|
assert cli_args.func == CmdExperimentsList
|
|
|
|
cmd = cli_args.func(cli_args)
|
|
m = mocker.patch("dvc.repo.experiments.ls.ls", return_value={})
|
|
|
|
assert cmd.run() == 0
|
|
|
|
m.assert_called_once_with(
|
|
cmd.repo,
|
|
git_remote="origin",
|
|
rev=["foo"],
|
|
all_commits=True,
|
|
num=-1,
|
|
)
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"args,expected",
|
|
[
|
|
([], "master:\n\tsha-a [exp-a]\n"),
|
|
(["--name-only"], "exp-a\n"),
|
|
(["--sha-only"], "sha-a\n"),
|
|
],
|
|
)
|
|
def test_experiments_list_format(mocker, capsys, args, expected, dvc, scm):
|
|
mocker.patch(
|
|
"dvc.repo.experiments.ls.ls",
|
|
return_value={
|
|
scm.get_rev(): [
|
|
("exp-a", "sha-a"),
|
|
]
|
|
},
|
|
)
|
|
raw_args = ["experiments", "list", *args]
|
|
cli_args = parse_args(raw_args)
|
|
|
|
cmd = cli_args.func(cli_args)
|
|
|
|
capsys.readouterr()
|
|
assert cmd.run() == 0
|
|
cap = capsys.readouterr()
|
|
assert cap.out == expected
|
|
|
|
|
|
def test_experiments_list_remote(mocker, capsys, dvc, scm):
|
|
mocker.patch(
|
|
"dvc.repo.experiments.ls.ls",
|
|
return_value={
|
|
"main": [
|
|
("exp-a", None),
|
|
]
|
|
},
|
|
)
|
|
cli_args = parse_args(["experiments", "list", "git_remote"])
|
|
|
|
cmd = cli_args.func(cli_args)
|
|
|
|
capsys.readouterr()
|
|
assert cmd.run() == 0
|
|
cap = capsys.readouterr()
|
|
assert cap.out == "main:\n\texp-a\n"
|
|
|
|
cli_args = parse_args(["experiments", "list", "git_remote", "--sha-only"])
|
|
|
|
cmd = cli_args.func(cli_args)
|
|
|
|
capsys.readouterr()
|
|
|
|
with pytest.raises(InvalidArgumentError):
|
|
cmd.run()
|
|
|
|
|
|
def test_experiments_push(dvc, scm, mocker):
|
|
cli_args = parse_args(
|
|
[
|
|
"experiments",
|
|
"push",
|
|
"origin",
|
|
"experiment1",
|
|
"experiment2",
|
|
"--all-commits",
|
|
"-n",
|
|
"2",
|
|
"--rev",
|
|
"foo",
|
|
"--force",
|
|
"--no-cache",
|
|
"--remote",
|
|
"my-remote",
|
|
"--jobs",
|
|
"1",
|
|
"--run-cache",
|
|
]
|
|
)
|
|
assert cli_args.func == CmdExperimentsPush
|
|
|
|
cmd = cli_args.func(cli_args)
|
|
m = mocker.patch("dvc.repo.experiments.push.push", return_value={})
|
|
|
|
assert cmd.run() == 0
|
|
|
|
m.assert_called_once_with(
|
|
cmd.repo,
|
|
"origin",
|
|
["experiment1", "experiment2"],
|
|
rev=["foo"],
|
|
all_commits=True,
|
|
num=2,
|
|
force=True,
|
|
push_cache=False,
|
|
dvc_remote="my-remote",
|
|
jobs=1,
|
|
run_cache=True,
|
|
)
|
|
|
|
cli_args = parse_args(["experiments", "push", "origin"])
|
|
cmd = cli_args.func(cli_args)
|
|
|
|
assert cmd.run() == 0
|
|
|
|
|
|
def test_experiments_pull(dvc, scm, mocker):
|
|
cli_args = parse_args(
|
|
[
|
|
"experiments",
|
|
"pull",
|
|
"origin",
|
|
"experiment",
|
|
"--all-commits",
|
|
"--rev",
|
|
"foo",
|
|
"--force",
|
|
"--no-cache",
|
|
"--remote",
|
|
"my-remote",
|
|
"--jobs",
|
|
"1",
|
|
"--run-cache",
|
|
]
|
|
)
|
|
assert cli_args.func == CmdExperimentsPull
|
|
|
|
cmd = cli_args.func(cli_args)
|
|
m = mocker.patch("dvc.repo.experiments.pull.pull", return_value={})
|
|
|
|
assert cmd.run() == 0
|
|
|
|
m.assert_called_once_with(
|
|
cmd.repo,
|
|
"origin",
|
|
["experiment"],
|
|
rev=["foo"],
|
|
all_commits=True,
|
|
num=1,
|
|
force=True,
|
|
pull_cache=False,
|
|
dvc_remote="my-remote",
|
|
jobs=1,
|
|
run_cache=True,
|
|
)
|
|
|
|
cli_args = parse_args(["experiments", "pull", "origin"])
|
|
cmd = cli_args.func(cli_args)
|
|
|
|
assert cmd.run() == 0
|
|
|
|
|
|
def test_experiments_remove_flag(dvc, scm, mocker, capsys, caplog):
|
|
cli_args = parse_args(
|
|
[
|
|
"experiments",
|
|
"remove",
|
|
"--all-commits",
|
|
"--rev",
|
|
"foo",
|
|
"--num",
|
|
"2",
|
|
"--git-remote",
|
|
"myremote",
|
|
]
|
|
)
|
|
assert cli_args.func == CmdExperimentsRemove
|
|
cmd = cli_args.func(cli_args)
|
|
m = mocker.patch("dvc.repo.experiments.remove.remove", return_value={})
|
|
assert cmd.run() == 0
|
|
m.assert_called_once_with(
|
|
cmd.repo,
|
|
exp_names=[],
|
|
all_commits=True,
|
|
rev=["foo"],
|
|
num=2,
|
|
queue=False,
|
|
git_remote="myremote",
|
|
keep=False,
|
|
)
|
|
|
|
|
|
def test_experiments_remove_special(dvc, scm, mocker, capsys, caplog):
|
|
cli_args = parse_args(
|
|
[
|
|
"experiments",
|
|
"remove",
|
|
"--git-remote",
|
|
"myremote",
|
|
"exp-123",
|
|
"exp-234",
|
|
]
|
|
)
|
|
assert cli_args.func == CmdExperimentsRemove
|
|
cmd = cli_args.func(cli_args)
|
|
m = mocker.patch("dvc.repo.experiments.remove.remove", return_value={})
|
|
assert cmd.run() == 0
|
|
m.assert_called_once_with(
|
|
cmd.repo,
|
|
exp_names=["exp-123", "exp-234"],
|
|
all_commits=False,
|
|
rev=None,
|
|
num=1,
|
|
queue=False,
|
|
git_remote="myremote",
|
|
keep=False,
|
|
)
|
|
|
|
|
|
def test_experiments_remove_invalid(dvc, scm, mocker, capsys, caplog):
|
|
cmd = CmdExperimentsRemove(
|
|
parse_args(["exp", "remove", "--all-commits", "exp-1", "exp-2"])
|
|
)
|
|
with pytest.raises(InvalidArgumentError):
|
|
cmd.run()
|
|
cmd = CmdExperimentsRemove(parse_args(["exp", "remove"]))
|
|
with pytest.raises(InvalidArgumentError) as excinfo:
|
|
cmd.run()
|
|
assert (
|
|
str(excinfo.value) == "Either provide an `experiment` argument"
|
|
", or use the `--rev` or `--all-commits` or `--queue` flag."
|
|
)
|
|
|
|
|
|
def test_experiments_rename_flag(dvc, scm, mocker, capsys, caplog):
|
|
cli_args = parse_args(
|
|
[
|
|
"experiments",
|
|
"rename",
|
|
"--git-remote",
|
|
"myremote",
|
|
"exp-123",
|
|
"exp-234",
|
|
]
|
|
)
|
|
assert cli_args.func == CmdExperimentsRename
|
|
cmd = cli_args.func(cli_args)
|
|
m = mocker.patch("dvc.repo.experiments.rename.rename", return_value={})
|
|
assert cmd.run() == 0
|
|
m.assert_called_once_with(
|
|
cmd.repo,
|
|
exp_name="exp-123",
|
|
new_name="exp-234",
|
|
git_remote="myremote",
|
|
force=False,
|
|
)
|
|
|
|
|
|
def test_experiments_rename_invalid(dvc, scm, mocker, capsys, caplog):
|
|
cmd = CmdExperimentsRename(parse_args(["exp", "rename", "exp-1"]))
|
|
with pytest.raises(InvalidArgumentError) as excinfo:
|
|
cmd.run()
|
|
assert (
|
|
str(excinfo.value)
|
|
== "An experiment to rename and a new experiment name are required."
|
|
)
|
|
|
|
|
|
def test_experiments_save(dvc, scm, mocker):
|
|
cli_args = parse_args(
|
|
["exp", "save", "target", "--name", "exp-name", "--recursive", "--force"]
|
|
)
|
|
assert cli_args.func == CmdExperimentsSave
|
|
|
|
cmd = cli_args.func(cli_args)
|
|
m = mocker.patch("dvc.repo.experiments.save.save", return_value="acabb")
|
|
|
|
assert cmd.run() == 0
|
|
|
|
m.assert_called_once_with(
|
|
cmd.repo,
|
|
targets=["target"],
|
|
name="exp-name",
|
|
recursive=True,
|
|
force=True,
|
|
include_untracked=[],
|
|
message=None,
|
|
)
|
|
|
|
|
|
@pytest.mark.parametrize("flag", ["-m", "-M", "--message"])
|
|
def test_experiments_save_message(dvc, scm, mocker, flag):
|
|
cli_args = parse_args(["exp", "save", flag, "custom commit message"])
|
|
assert cli_args.func == CmdExperimentsSave
|
|
|
|
cmd = cli_args.func(cli_args)
|
|
m = mocker.patch("dvc.repo.experiments.save.save", return_value="acabb")
|
|
|
|
assert cmd.run() == 0
|
|
|
|
m.assert_called_once_with(
|
|
cmd.repo,
|
|
targets=[],
|
|
name=None,
|
|
recursive=False,
|
|
force=False,
|
|
include_untracked=[],
|
|
message="custom commit message",
|
|
)
|
|
|
|
|
|
def test_experiments_clean(dvc, scm, mocker):
|
|
cli_args = parse_args(["experiments", "clean"])
|
|
assert cli_args.func == CmdExperimentsClean
|
|
|
|
cmd = cli_args.func(cli_args)
|
|
m = mocker.patch("dvc.repo.experiments.clean.clean", return_value={})
|
|
|
|
assert cmd.run() == 0
|
|
|
|
m.assert_called_once_with(cmd.repo)
|