add device rename and bulk rename cmds (#350)

* add device rename and bulk rename cmds

* move error checking into helper method so it applies to bulk cmd as well

* move error checking into helper method so that it applies to bulk method

* make forbidden error more specific

Author: tora-kozic

src/code42cli/cmds/devices.py

@@ -38,6 +38,10 @@ def devices(state):
     "device-guid", type=str, callback=lambda ctx, param, arg: _verify_guid_type(arg),
 )
 
+new_device_name_option = click.option(
+    "-n", "--new-device-name", help="The new name for the device.", required=True
+)
+
 
 def change_device_name_option(help_msg):
     return click.option(
@@ -60,6 +64,15 @@ def change_device_name_option(help_msg):
 )
 
 
+@devices.command()
+@device_guid_argument
+@new_device_name_option
+@sdk_options()
+def rename(state, device_guid, new_device_name):
+    """Rename a device with Code42. Requires the device GUID to rename."""
+    _change_device_name(state.sdk, device_guid, new_device_name)
+
+
 @devices.command()
 @device_guid_argument
 @change_device_name_option(
@@ -144,9 +157,16 @@ def _update_cold_storage_purge_date(sdk, guid, purge_date):
 
 
 def _change_device_name(sdk, guid, name):
-    device_settings = sdk.devices.get_settings(guid)
-    device_settings.name = name
-    sdk.devices.update_settings(device_settings)
+    try:
+        device_settings = sdk.devices.get_settings(guid)
+        device_settings.name = name
+        sdk.devices.update_settings(device_settings)
+    except exceptions.Py42ForbiddenError:
+        raise Code42CLIError(
+            f"You don't have the necessary permissions to rename the device with GUID '{guid}'."
+        )
+    except exceptions.Py42NotFoundError:
+        raise Code42CLIError(f"The device with GUID '{guid}' was not found.")
 
 
 @devices.command()
@@ -544,13 +564,15 @@ def bulk(state):
 
 
 _bulk_device_activation_headers = ["guid"]
+_bulk_device_rename_headers = ["guid", "name"]
 
 
 devices_generate_template = generate_template_cmd_factory(
     group_name="devices",
     commands_dict={
         "reactivate": _bulk_device_activation_headers,
         "deactivate": _bulk_device_activation_headers,
+        "rename": _bulk_device_rename_headers,
     },
     help_message="Generate the CSV template needed for bulk device commands.",
 )
@@ -632,3 +654,37 @@ def handle_row(**row):
         raise_global_error=False,
     )
     formatter.echo_formatted_list(result_rows)
+
+
+@bulk.command(name="rename")
+@read_csv_arg(headers=_bulk_device_rename_headers)
+@format_option
+@sdk_options()
+def bulk_rename(state, csv_rows, format):
+    """Rename all devices from the provided CSV containing a 'guid' and a 'name' column."""
+
+    # Initialize the SDK before starting any bulk processes
+    # to prevent multiple instances and having to enter 2fa multiple times.
+    sdk = state.sdk
+
+    csv_rows[0]["renamed"] = "False"
+    formatter = OutputFormatter(format, {key: key for key in csv_rows[0].keys()})
+    stats = create_worker_stats(len(csv_rows))
+
+    def handle_row(**row):
+        try:
+            _change_device_name(sdk, row["guid"], row["name"])
+            row["renamed"] = "True"
+        except Exception as err:
+            row["renamed"] = f"False: {err}"
+            stats.increment_total_errors()
+        return row
+
+    result_rows = run_bulk_process(
+        handle_row,
+        csv_rows,
+        progress_label="Renaming devices:",
+        stats=stats,
+        raise_global_error=False,
+    )
+    formatter.echo_formatted_list(result_rows)

tests/cmds/test_devices.py

@@ -22,6 +22,7 @@
 from code42cli.worker import WorkerStats
 
 _NAMESPACE = "code42cli.cmds.devices"
+TEST_NEW_DEVICE_NAME = "test-new-device-name-123"
 TEST_DATE_OLDER = "2020-01-01T12:00:00.774Z"
 TEST_DATE_NEWER = "2021-01-01T12:00:00.774Z"
 TEST_DATE_MIDDLE = "2020-06-01T12:00:00"
@@ -468,6 +469,61 @@ def worker_stats(mocker, worker_stats_factory):
     return stats
 
 
+def test_rename_calls_get_and_update_settings_with_expected_params(runner, cli_state):
+    cli_state.sdk.devices.get_settings.return_value = mock_device_settings
+    runner.invoke(
+        cli,
+        [
+            "devices",
+            "rename",
+            TEST_DEVICE_GUID,
+            "--new-device-name",
+            TEST_NEW_DEVICE_NAME,
+        ],
+        obj=cli_state,
+    )
+    cli_state.sdk.devices.get_settings.assert_called_once_with(TEST_DEVICE_GUID)
+    cli_state.sdk.devices.update_settings.assert_called_once_with(mock_device_settings)
+
+
+def test_rename_when_missing_guid_prints_error(runner, cli_state):
+    result = runner.invoke(
+        cli, ["devices", "rename", "-n", TEST_NEW_DEVICE_NAME], obj=cli_state
+    )
+    assert result.exit_code == 2
+    assert "Missing argument 'DEVICE_GUID'" in result.output
+
+
+def test_rename_when_missing_name_prints_error(runner, cli_state):
+    result = runner.invoke(cli, ["devices", "rename", TEST_DEVICE_GUID], obj=cli_state)
+    assert result.exit_code == 2
+    assert "Missing option '-n' / '--new-device-name'" in result.output
+
+
+def test_rename_when_guid_not_found_py42_raises_exception_prints_error(
+    runner, cli_state, custom_error
+):
+    cli_state.sdk.devices.get_settings.side_effect = Py42NotFoundError(custom_error)
+
+    result = runner.invoke(
+        cli,
+        [
+            "devices",
+            "rename",
+            TEST_DEVICE_GUID,
+            "--new-device-name",
+            TEST_NEW_DEVICE_NAME,
+        ],
+        obj=cli_state,
+    )
+    cli_state.sdk.devices.get_settings.assert_called_once_with(TEST_DEVICE_GUID)
+    assert result.exit_code == 1
+    assert (
+        f"Error: The device with GUID '{TEST_DEVICE_GUID}' was not found."
+        in result.output
+    )
+
+
 def test_deactivate_deactivates_device(
     runner, cli_state, deactivate_device_success, get_device_by_guid_success
 ):
@@ -983,3 +1039,52 @@ def _get(guid):
     handler(guid="test")
     handler(guid="not test")
     assert worker_stats.increment_total_errors.call_count == 1
+
+
+def test_bulk_rename_uses_expected_arguments(runner, mocker, cli_state):
+    bulk_processor = mocker.patch(f"{_NAMESPACE}.run_bulk_process")
+    with runner.isolated_filesystem():
+        with open("test_bulk_rename.csv", "w") as csv:
+            csv.writelines(["guid,name\n", "test-guid,test-name\n"])
+        runner.invoke(
+            cli, ["devices", "bulk", "rename", "test_bulk_rename.csv"], obj=cli_state,
+        )
+    assert bulk_processor.call_args[0][1] == [
+        {"guid": "test-guid", "name": "test-name", "renamed": "False"}
+    ]
+
+
+def test_bulk_rename_ignores_blank_lines(runner, mocker, cli_state):
+    bulk_processor = mocker.patch(f"{_NAMESPACE}.run_bulk_process")
+    with runner.isolated_filesystem():
+        with open("test_bulk_rename.csv", "w") as csv:
+            csv.writelines(["guid,name\n", "\n", "test-guid,test-name\n\n"])
+        runner.invoke(
+            cli, ["devices", "bulk", "rename", "test_bulk_rename.csv"], obj=cli_state,
+        )
+    assert bulk_processor.call_args[0][1] == [
+        {"guid": "test-guid", "name": "test-name", "renamed": "False"}
+    ]
+    bulk_processor.assert_called_once()
+
+
+def test_bulk_rename_uses_handler_that_when_encounters_error_increments_total_errors(
+    runner, mocker, cli_state, worker_stats
+):
+    def _get(guid):
+        if guid == "test":
+            raise Exception("TEST")
+        return create_mock_response(mocker, data=TEST_DEVICE_RESPONSE)
+
+    cli_state.sdk.devices.get_settings = _get
+    bulk_processor = mocker.patch(f"{_NAMESPACE}.run_bulk_process")
+    with runner.isolated_filesystem():
+        with open("test_bulk_rename.csv", "w") as csv:
+            csv.writelines(["guid,name\n", "1,2\n"])
+        runner.invoke(
+            cli, ["devices", "bulk", "rename", "test_bulk_rename.csv"], obj=cli_state,
+        )
+    handler = bulk_processor.call_args[0][0]
+    handler(guid="test", name="test-name-1")
+    handler(guid="not test", name="test-name-2")
+    assert worker_stats.increment_total_errors.call_count == 1