JSON output format and other fixes (#217)

Author: Juliya Smith

src/code42cli/cmds/cases.py

@@ -1,6 +1,5 @@
 import json
 import os
-from pprint import pformat
 
 import click
 from py42.clients.cases import CaseStatus
@@ -20,20 +19,23 @@
 case_number_option = click.option(
     "--case-number", type=int, help="The number assigned to the case.", required=True
 )
-name_option = click.option("--name", help="Name of the case.",)
-assignee_option = click.option("--assignee", help="User UID of the assignee.")
-description_option = click.option("--description", help="Description of the case.")
-findings_option = click.option("--findings", help="Findings on the case.")
-subject_option = click.option("--subject", help="User UID of a subject of the case.")
+name_option = click.option("--name", help="The name of the case.",)
+assignee_option = click.option(
+    "--assignee", help="The UID of the user to assign to the case."
+)
+description_option = click.option("--description", help="The description of the case.")
+findings_option = click.option("--findings", help="Any findings for the case.")
+subject_option = click.option(
+    "--subject", help="The user UID of the subject of the case."
+)
 status_option = click.option(
     "--status",
     help="Status of the case. `OPEN` or `CLOSED`.",
     type=click.Choice(CaseStatus.choices()),
 )
 file_event_id_option = click.option(
-    "--event-id", required=True, help="File event id associated to the case."
+    "--event-id", required=True, help="The file event ID associated with the case."
 )
-
 CASES_KEYWORD = "cases"
 BEGIN_DATE_DICT = set_begin_default_dict(CASES_KEYWORD)
 END_DATE_DICT = set_end_default_dict(CASES_KEYWORD)
@@ -110,10 +112,10 @@ def update(state, case_number, name, subject, assignee, description, findings, s
 
 @cases.command("list")
 @click.option(
-    "--name", help="Filter by name of a case, supports partial name matches.",
+    "--name", help="Filter by name of a case. Supports partial name matches.",
 )
-@click.option("--subject", help="Filter by user UID of the subject of a case.")
-@click.option("--assignee", help="Filter by user UID of assignee.")
+@click.option("--subject", help="Filter by the user UID of the subject of a case.")
+@click.option("--assignee", help="Filter by the user UID of an assignee.")
 @click.option("--begin-create-time", **BEGIN_DATE_DICT)
 @click.option("--end-create-time", **END_DATE_DICT)
 @click.option("--begin-update-time", **BEGIN_DATE_DICT)
@@ -162,7 +164,7 @@ def _get_file_events(sdk, case_number):
 def _display_file_events(events):
     if events:
         click.echo("\nFile Events:\n")
-        click.echo(pformat(events))
+        click.echo(json.dumps(events, indent=4))
     else:
         click.echo("\nNo events found.")
 
@@ -190,7 +192,9 @@ def show(state, case_number, format, include_file_events):
 @cases.command()
 @case_number_arg
 @click.option(
-    "--path", help="File path. Defaults to the current directory.", default="."
+    "--path",
+    help="The file path where to save the PDF. Defaults to the current directory.",
+    default=os.getcwd(),
 )
 @sdk_options()
 def export(state, case_number, path):

src/code42cli/cmds/devices.py

@@ -33,13 +33,16 @@ def devices(state):
     "device-guid", type=str, callback=lambda ctx, param, arg: _verify_guid_type(arg),
 )
 
-change_device_name_option = click.option(
-    "--change-device-name",
-    required=False,
-    is_flag=True,
-    default=False,
-    help="Prepend 'deactivated_<current_date>' to the name of any deactivated devices.",
-)
+
+def change_device_name_option(help_msg):
+    return click.option(
+        "--change-device-name",
+        required=False,
+        is_flag=True,
+        default=False,
+        help=help_msg,
+    )
+
 
 DATE_FORMAT = "%Y-%m-%d"
 purge_date_option = click.option(
@@ -54,7 +57,9 @@ def devices(state):
 
 @devices.command()
 @device_guid_argument
-@change_device_name_option
+@change_device_name_option(
+    "Prepend 'deactivated_<current_date>' to the name of the device if deactivation is successful."
+)
 @purge_date_option
 @sdk_options()
 def deactivate(state, device_guid, change_device_name, purge_date):
@@ -479,7 +484,9 @@ def bulk(state):
 
 @bulk.command(name="deactivate")
 @read_csv_arg(headers=_bulk_device_activation_headers)
-@change_device_name_option
+@change_device_name_option(
+    "Prepend 'deactivated_<current_date>' to the name of any successfully deactivated devices."
+)
 @purge_date_option
 @format_option
 @sdk_options()

tests/cmds/test_cases.py

@@ -1,4 +1,5 @@
 import json
+import os
 from unittest import mock
 from unittest.mock import mock_open
 
@@ -227,7 +228,8 @@ def test_export_calls_export_summary_with_expected_params(runner, cli_state, moc
             cli, ["cases", "export", "1"], obj=cli_state,
         )
         cli_state.sdk.cases.export_summary.assert_called_once_with(1)
-        mf.assert_called_once_with("./1_case_summary.pdf", "wb")
+        expected = os.path.join(os.getcwd(), "1_case_summary.pdf")
+        mf.assert_called_once_with(expected, "wb")
 
 
 def test_export_when_missing_case_number_prints_error(runner, cli_state):