Gen template devices (#213)

Author: Juliya Smith

CHANGELOG.md

@@ -20,6 +20,7 @@ how a consumer would use the library (e.g. adding unit tests, updating documenta
     - `devices list-backup-sets` to retrieve detailed info about device backup sets.
     - `devices bulk deactivate` to deactivate a list of devices.
     - `devices bulk reactivate` to reactivate a list of devices.
+    - `devices bulk generate-template` to create a blank CSV file for bulk commands.
 
 - `code42 departing-employee list` command.
 

src/code42cli/bulk.py

@@ -29,7 +29,7 @@ def write_template_file(path, columns=None, flat_item=None):
             )
 
 
-def generate_template_cmd_factory(group_name, commands_dict):
+def generate_template_cmd_factory(group_name, commands_dict, help_message=None):
     """Helper function that creates a `generate-template` click command that can be added to `bulk`
     sub-command groups.
 
@@ -42,8 +42,12 @@ def generate_template_cmd_factory(group_name, commands_dict):
             If a cmd takes a flat file, value should be a string indicating what item the flat file
             rows should contain.
     """
+    help_message = (
+        help_message
+        or "Generate the CSV template needed for bulk adding/removing users."
+    )
 
-    @click.command()
+    @click.command(help=help_message)
     @click.argument("cmd", type=click.Choice(list(commands_dict)))
     @click.option(
         "--path",
@@ -52,9 +56,6 @@ def generate_template_cmd_factory(group_name, commands_dict):
         help="Write template file to specific file path/name.",
     )
     def generate_template(cmd, path):
-        """\b
-        Generate the CSV template needed for bulk adding/removing users.
-        """
         columns = commands_dict[cmd]
         if not path:
             filename = "{}_bulk_{}.csv".format(group_name, cmd.replace("-", "_"))

src/code42cli/cmds/alert_rules.py

@@ -117,7 +117,7 @@ def bulk(state):
 
 
 @bulk.command(
-    help="Bulk add users to alert rules from a csv file. CSV file format: {}".format(
+    help="Bulk add users to alert rules from a CSV file. CSV file format: {}".format(
         ",".join(ALERT_RULES_CSV_HEADERS)
     )
 )

src/code42cli/cmds/devices.py

@@ -7,6 +7,7 @@
 from py42 import exceptions
 from py42.exceptions import Py42NotFoundError
 
+from code42cli.bulk import generate_template_cmd_factory
 from code42cli.bulk import run_bulk_process
 from code42cli.click_ext.groups import OrderedGroup
 from code42cli.click_ext.options import incompatible_with
@@ -456,8 +457,22 @@ def bulk(state):
     pass
 
 
+_bulk_device_activation_headers = ["guid"]
+
+
+devices_generate_template = generate_template_cmd_factory(
+    group_name="devices",
+    commands_dict={
+        "reactivate": _bulk_device_activation_headers,
+        "deactivate": _bulk_device_activation_headers,
+    },
+    help_message="Generate the CSV template needed for bulk device commands.",
+)
+bulk.add_command(devices_generate_template)
+
+
 @bulk.command(name="deactivate")
-@read_csv_arg(headers=["guid"])
+@read_csv_arg(headers=_bulk_device_activation_headers)
 @change_device_name_option
 @purge_date_option
 @format_option
@@ -488,7 +503,7 @@ def handle_row(**row):
 
 
 @bulk.command(name="reactivate")
-@read_csv_arg(headers=["guid"])
+@read_csv_arg(headers=_bulk_device_activation_headers)
 @format_option
 @sdk_options()
 def bulk_reactivate(state, csv_rows, format):

tests/test_bulk.py

@@ -5,6 +5,7 @@
 from code42cli import errors
 from code42cli import PRODUCT_NAME
 from code42cli.bulk import BulkProcessor
+from code42cli.bulk import generate_template_cmd_factory
 from code42cli.bulk import run_bulk_process
 from code42cli.logger import get_view_error_details_message
 
@@ -31,6 +32,41 @@ def func_with_one_arg(sdk, profile, test1):
     pass
 
 
+def test_generate_template_cmd_factory_returns_expected_command():
+    add_headers = ["foo", "bar"]
+    remove_headers = ["test"]
+    help_message = "HELP!"
+    template = generate_template_cmd_factory(
+        group_name="cmd-group",
+        commands_dict={"add": add_headers, "remove": remove_headers},
+        help_message=help_message,
+    )
+    assert template.help == help_message
+    assert template.name == "generate-template"
+    assert len(template.params) == 2
+    assert template.params[0].name == "cmd"
+    assert template.params[0].type.choices == ["add", "remove"]
+    assert template.params[1].name == "path"
+
+
+def test_generate_template_cmd_factory_when_using_defaults_returns_expected_command():
+    add_headers = ["foo", "bar"]
+    remove_headers = ["test"]
+    template = generate_template_cmd_factory(
+        group_name="cmd-group",
+        commands_dict={"add": add_headers, "remove": remove_headers},
+    )
+    assert (
+        template.help
+        == "Generate the CSV template needed for bulk adding/removing users."
+    )
+    assert template.name == "generate-template"
+    assert len(template.params) == 2
+    assert template.params[0].name == "cmd"
+    assert template.params[0].type.choices == ["add", "remove"]
+    assert template.params[1].name == "path"
+
+
 def test_run_bulk_process_calls_run(bulk_processor, bulk_processor_factory):
     errors.ERRORED = False
     run_bulk_process(func_with_one_arg, None)