From e3004fc3f7701b45d18d1fee192473d2eedb0ca2 Mon Sep 17 00:00:00 2001 From: karajan1001 Date: Sun, 19 Sep 2021 19:55:38 +0800 Subject: [PATCH 1/9] machine: Add a new command `dvc machine status` fix#6482 1. add a new command `dvc machien status` 2. add a unit test for the cli call. 3. add a unit test for the shown result. --- dvc/command/machine.py | 28 +++++++++++++++ dvc/machine/__init__.py | 6 ++++ tests/func/machine/__init__.py | 10 ++++++ tests/func/machine/test_machine_config.py | 9 +---- tests/func/machine/test_machine_status.py | 42 +++++++++++++++++++++++ tests/unit/command/test_machine.py | 14 ++++++++ 6 files changed, 101 insertions(+), 8 deletions(-) create mode 100644 tests/func/machine/test_machine_status.py diff --git a/dvc/command/machine.py b/dvc/command/machine.py index 3554ca9cd7..c939158a84 100644 --- a/dvc/command/machine.py +++ b/dvc/command/machine.py @@ -143,6 +143,21 @@ def run(self): return 0 +class CmdMachineStatus(CmdBase): + def run(self): + if self.repo.machine is None: + raise MachineDisabledError + + all_status = self.repo.machine.status(self.args.name) + for i, status in enumerate(all_status): + ui.write(f"instance_num_{i+1}:") + keys = list(status.keys()) + keys.sort() + for key in keys: + ui.write(f"\t{key:20}: {status[key]}") + return 0 + + class CmdMachineDestroy(CmdBase): def run(self): if self.repo.machine is None: @@ -306,6 +321,19 @@ def add_parser(subparsers, parent_parser): ) machine_create_parser.set_defaults(func=CmdMachineCreate) + machine_STATUS_HELP = "List the status of a running machine." + machine_status_parser = machine_subparsers.add_parser( + "status", + parents=[parent_config_parser, parent_parser], + description=append_doc_link(machine_STATUS_HELP, "machine/status"), + help=machine_STATUS_HELP, + formatter_class=argparse.RawDescriptionHelpFormatter, + ) + machine_status_parser.add_argument( + "name", help="Name of the running machine." + ) + machine_status_parser.set_defaults(func=CmdMachineStatus) + machine_DESTROY_HELP = "Destroy an machine instance." machine_destroy_parser = machine_subparsers.add_parser( "destroy", diff --git a/dvc/machine/__init__.py b/dvc/machine/__init__.py index 8197df4ba9..811f721643 100644 --- a/dvc/machine/__init__.py +++ b/dvc/machine/__init__.py @@ -2,8 +2,10 @@ import os from typing import ( TYPE_CHECKING, + Any, Dict, Iterable, + Iterator, Mapping, Optional, Tuple, @@ -200,3 +202,7 @@ def get_sshfs(self, name: Optional[str]): def run_shell(self, name: Optional[str]): config, backend = self.get_config_and_backend(name) return backend.run_shell(**config) + + def status(self, name: Optional[str]) -> Iterator[Dict[Any, Any]]: + config, backend = self.get_config_and_backend(name) + return backend.instances(**config) diff --git a/tests/func/machine/__init__.py b/tests/func/machine/__init__.py index e69de29bb2..1f211233a9 100644 --- a/tests/func/machine/__init__.py +++ b/tests/func/machine/__init__.py @@ -0,0 +1,10 @@ +import textwrap + +CONFIG_TEXT = textwrap.dedent( + """\ + [feature] + machine = true + ['machine \"foo\"'] + cloud = aws + """ +) diff --git a/tests/func/machine/test_machine_config.py b/tests/func/machine/test_machine_config.py index 6b89d9d99b..af90b924f7 100644 --- a/tests/func/machine/test_machine_config.py +++ b/tests/func/machine/test_machine_config.py @@ -5,14 +5,7 @@ from dvc.main import main -CONFIG_TEXT = textwrap.dedent( - """\ - [feature] - machine = true - ['machine \"foo\"'] - cloud = aws - """ -) +from . import CONFIG_TEXT @pytest.mark.parametrize( diff --git a/tests/func/machine/test_machine_status.py b/tests/func/machine/test_machine_status.py new file mode 100644 index 0000000000..9cee2a6def --- /dev/null +++ b/tests/func/machine/test_machine_status.py @@ -0,0 +1,42 @@ +import json + +from tpi.terraform import TerraformBackend + +from dvc.main import main + +from . import CONFIG_TEXT + +STATUS = """{ + "aws_security_group": null, + "cloud": "aws", + "id": "iterative-2jyhw8j9ieov6", + "image": "ubuntu-bionic-18.04-amd64-server-20210818", + "instance_gpu": null, + "instance_hdd_size": 35, + "instance_ip": "123.123.123.123", + "instance_launch_time": "2021-08-25T07:13:03Z", + "instance_type": "m", + "name": "test-resource", + "region": "us-west", + "spot": false, + "spot_price": -1, + "ssh_name": null, + "ssh_private": "-----BEGIN RSA PRIVATE KEY-----\\n", + "startup_script": "IyEvYmluL2Jhc2g=", + "timeouts": null +}""" + + +def test_status(tmp_dir, scm, dvc, mocker, capsys): + (tmp_dir / ".dvc" / "config").write_text(CONFIG_TEXT) + status = json.loads(STATUS) + + mocker.patch.object( + TerraformBackend, "instances", autospec=True, return_value=[status] + ) + + assert main(["machine", "status", "foo"]) == 0 + cap = capsys.readouterr() + assert "instance_num_1:" in cap.out + for key, value in status.items(): + assert f"\t{key:20}: {value}" in cap.out diff --git a/tests/unit/command/test_machine.py b/tests/unit/command/test_machine.py index dd77b9bc5d..33159197f1 100644 --- a/tests/unit/command/test_machine.py +++ b/tests/unit/command/test_machine.py @@ -9,6 +9,7 @@ CmdMachineModify, CmdMachineRemove, CmdMachineSsh, + CmdMachineStatus, ) DATA = { @@ -56,6 +57,19 @@ def test_create(tmp_dir, dvc, mocker): m.assert_called_once_with("foo") +def test_status(tmp_dir, dvc, mocker): + cli_args = parse_args(["machine", "status", "foo"]) + assert cli_args.func == CmdMachineStatus + + cmd = cli_args.func(cli_args) + m = mocker.patch.object( + cmd.repo.machine, "status", autospec=True, return_value=[] + ) + + assert cmd.run() == 0 + m.assert_called_once_with("foo") + + def test_destroy(tmp_dir, dvc, mocker): cli_args = parse_args(["machine", "destroy", "foo"]) assert cli_args.func == CmdMachineDestroy From db743f4ec602b17561013b1c57f415b12d40a199 Mon Sep 17 00:00:00 2001 From: Gao Date: Mon, 20 Sep 2021 17:01:30 +0800 Subject: [PATCH 2/9] Update dvc/command/machine.py Co-authored-by: Saugat Pachhai --- dvc/command/machine.py | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/dvc/command/machine.py b/dvc/command/machine.py index c939158a84..c35644cfe0 100644 --- a/dvc/command/machine.py +++ b/dvc/command/machine.py @@ -151,10 +151,8 @@ def run(self): all_status = self.repo.machine.status(self.args.name) for i, status in enumerate(all_status): ui.write(f"instance_num_{i+1}:") - keys = list(status.keys()) - keys.sort() - for key in keys: - ui.write(f"\t{key:20}: {status[key]}") + for key, value in sorted(status.items()): + ui.write(f"\t{key:20}: {value}") return 0 From a4e8d839fbe7781718a020972353f09e9ffad811 Mon Sep 17 00:00:00 2001 From: Gao Date: Mon, 20 Sep 2021 17:01:38 +0800 Subject: [PATCH 3/9] Update dvc/command/machine.py Co-authored-by: Saugat Pachhai --- dvc/command/machine.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dvc/command/machine.py b/dvc/command/machine.py index c35644cfe0..aab283080a 100644 --- a/dvc/command/machine.py +++ b/dvc/command/machine.py @@ -149,7 +149,7 @@ def run(self): raise MachineDisabledError all_status = self.repo.machine.status(self.args.name) - for i, status in enumerate(all_status): + for i, status in enumerate(all_status, start=1): ui.write(f"instance_num_{i+1}:") for key, value in sorted(status.items()): ui.write(f"\t{key:20}: {value}") From 6ee958f95898ac2d07385afa5238b1f53a77d66a Mon Sep 17 00:00:00 2001 From: Gao Date: Mon, 20 Sep 2021 17:02:23 +0800 Subject: [PATCH 4/9] Update machine.py --- dvc/command/machine.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dvc/command/machine.py b/dvc/command/machine.py index aab283080a..3aae64ea28 100644 --- a/dvc/command/machine.py +++ b/dvc/command/machine.py @@ -150,7 +150,7 @@ def run(self): all_status = self.repo.machine.status(self.args.name) for i, status in enumerate(all_status, start=1): - ui.write(f"instance_num_{i+1}:") + ui.write(f"instance_num_{i}:") for key, value in sorted(status.items()): ui.write(f"\t{key:20}: {value}") return 0 From d65fdab90a14ceb61cc9c7efc7b7e7e354a1976c Mon Sep 17 00:00:00 2001 From: karajan1001 Date: Tue, 28 Sep 2021 17:03:38 +0800 Subject: [PATCH 5/9] Remove sensitive fields --- dvc/command/machine.py | 7 ++++++- tests/func/machine/test_machine_status.py | 8 ++++++-- 2 files changed, 12 insertions(+), 3 deletions(-) diff --git a/dvc/command/machine.py b/dvc/command/machine.py index 3aae64ea28..6047a72cb3 100644 --- a/dvc/command/machine.py +++ b/dvc/command/machine.py @@ -144,6 +144,8 @@ def run(self): class CmdMachineStatus(CmdBase): + SENSITIVE_FIELDS = {"ssh_private", "startup_script"} + def run(self): if self.repo.machine is None: raise MachineDisabledError @@ -152,7 +154,10 @@ def run(self): for i, status in enumerate(all_status, start=1): ui.write(f"instance_num_{i}:") for key, value in sorted(status.items()): - ui.write(f"\t{key:20}: {value}") + if key in self.SENSITIVE_FIELDS: + ui.write(f"\t{key:20}: (sensitive value)") + else: + ui.write(f"\t{key:20}: {value}") return 0 diff --git a/tests/func/machine/test_machine_status.py b/tests/func/machine/test_machine_status.py index 9cee2a6def..c4ef01829c 100644 --- a/tests/func/machine/test_machine_status.py +++ b/tests/func/machine/test_machine_status.py @@ -2,6 +2,7 @@ from tpi.terraform import TerraformBackend +from dvc.command.machine import CmdMachineStatus from dvc.main import main from . import CONFIG_TEXT @@ -38,5 +39,8 @@ def test_status(tmp_dir, scm, dvc, mocker, capsys): assert main(["machine", "status", "foo"]) == 0 cap = capsys.readouterr() assert "instance_num_1:" in cap.out - for key, value in status.items(): - assert f"\t{key:20}: {value}" in cap.out + for key, value in CmdMachineStatus.SENSITIVE_FIELDS: + if key in {"ssh_private", "startup_script"}: + assert f"\t{key:20}: (sensitive value)" in cap.out + else: + assert f"\t{key:20}: {value}" in cap.out From 74dccc4f3a3ca0bc3a24687bd69173e94dbc62ea Mon Sep 17 00:00:00 2001 From: Gao Date: Wed, 29 Sep 2021 16:26:19 +0800 Subject: [PATCH 6/9] Update dvc/machine/__init__.py Co-authored-by: Casper da Costa-Luis --- dvc/machine/__init__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dvc/machine/__init__.py b/dvc/machine/__init__.py index 811f721643..5f4d95c5c0 100644 --- a/dvc/machine/__init__.py +++ b/dvc/machine/__init__.py @@ -203,6 +203,6 @@ def run_shell(self, name: Optional[str]): config, backend = self.get_config_and_backend(name) return backend.run_shell(**config) - def status(self, name: Optional[str]) -> Iterator[Dict[Any, Any]]: + def status(self, name: str, hide_sensitive: bool=True) -> Iterator[Dict[Any, Any]]: config, backend = self.get_config_and_backend(name) return backend.instances(**config) From df5d636ebcad3d3fc5fa0cfb43e443097f69ee7c Mon Sep 17 00:00:00 2001 From: Gao Date: Wed, 29 Sep 2021 16:26:28 +0800 Subject: [PATCH 7/9] Update tests/func/machine/__init__.py Co-authored-by: Casper da Costa-Luis --- tests/func/machine/__init__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/func/machine/__init__.py b/tests/func/machine/__init__.py index 1f211233a9..12b6782f54 100644 --- a/tests/func/machine/__init__.py +++ b/tests/func/machine/__init__.py @@ -4,7 +4,7 @@ """\ [feature] machine = true - ['machine \"foo\"'] + ['machine "foo"'] cloud = aws """ ) From 0f2f621a9a886ffbbde08e6fe93921b5fa10ab3f Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Wed, 29 Sep 2021 08:27:12 +0000 Subject: [PATCH 8/9] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- dvc/machine/__init__.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/dvc/machine/__init__.py b/dvc/machine/__init__.py index 5f4d95c5c0..900dd6ccdf 100644 --- a/dvc/machine/__init__.py +++ b/dvc/machine/__init__.py @@ -203,6 +203,8 @@ def run_shell(self, name: Optional[str]): config, backend = self.get_config_and_backend(name) return backend.run_shell(**config) - def status(self, name: str, hide_sensitive: bool=True) -> Iterator[Dict[Any, Any]]: + def status( + self, name: str, hide_sensitive: bool = True + ) -> Iterator[Dict[Any, Any]]: config, backend = self.get_config_and_backend(name) return backend.instances(**config) From 6569b4733de6108a710b35f8057278e58fc4754a Mon Sep 17 00:00:00 2001 From: karajan1001 Date: Thu, 30 Sep 2021 11:38:27 +0800 Subject: [PATCH 9/9] Use white list to limit shown fields --- dvc/command/machine.py | 10 ++++------ dvc/machine/__init__.py | 4 +--- tests/func/machine/test_machine_status.py | 7 ++----- 3 files changed, 7 insertions(+), 14 deletions(-) diff --git a/dvc/command/machine.py b/dvc/command/machine.py index 6047a72cb3..24f0e22e94 100644 --- a/dvc/command/machine.py +++ b/dvc/command/machine.py @@ -144,7 +144,7 @@ def run(self): class CmdMachineStatus(CmdBase): - SENSITIVE_FIELDS = {"ssh_private", "startup_script"} + SHOWN_FIELD = ["name", "cloud", "instance_hdd_size", "instance_ip"] def run(self): if self.repo.machine is None: @@ -153,11 +153,9 @@ def run(self): all_status = self.repo.machine.status(self.args.name) for i, status in enumerate(all_status, start=1): ui.write(f"instance_num_{i}:") - for key, value in sorted(status.items()): - if key in self.SENSITIVE_FIELDS: - ui.write(f"\t{key:20}: (sensitive value)") - else: - ui.write(f"\t{key:20}: {value}") + for field in self.SHOWN_FIELD: + value = status.get(field, None) + ui.write(f"\t{field:20}: {value}") return 0 diff --git a/dvc/machine/__init__.py b/dvc/machine/__init__.py index 900dd6ccdf..acc3b84b63 100644 --- a/dvc/machine/__init__.py +++ b/dvc/machine/__init__.py @@ -203,8 +203,6 @@ def run_shell(self, name: Optional[str]): config, backend = self.get_config_and_backend(name) return backend.run_shell(**config) - def status( - self, name: str, hide_sensitive: bool = True - ) -> Iterator[Dict[Any, Any]]: + def status(self, name: str) -> Iterator[Dict[Any, Any]]: config, backend = self.get_config_and_backend(name) return backend.instances(**config) diff --git a/tests/func/machine/test_machine_status.py b/tests/func/machine/test_machine_status.py index c4ef01829c..5c5081e28c 100644 --- a/tests/func/machine/test_machine_status.py +++ b/tests/func/machine/test_machine_status.py @@ -39,8 +39,5 @@ def test_status(tmp_dir, scm, dvc, mocker, capsys): assert main(["machine", "status", "foo"]) == 0 cap = capsys.readouterr() assert "instance_num_1:" in cap.out - for key, value in CmdMachineStatus.SENSITIVE_FIELDS: - if key in {"ssh_private", "startup_script"}: - assert f"\t{key:20}: (sensitive value)" in cap.out - else: - assert f"\t{key:20}: {value}" in cap.out + for key in CmdMachineStatus.SHOWN_FIELD: + assert f"\t{key:20}: {status[key]}" in cap.out