Move legal hold device reporting to devices.py, write tests, and rescind previous edits to legalhold.py

Author: maddie-vargo

docs/userguides/legalhold.md

@@ -93,8 +93,4 @@ To view all custodians (including inactive) for a legal hold matter, enter
 
 `code42 legal-hold show <matterID> --include-inactive`
 
-To view all devices associated with selected custodians for a legal hold matter, enter
-
-`code42 legal-hold show <matterID> --include-devices`
-
 Learn more about the [Legal Hold](../commands/legalhold.md) commands.

src/code42cli/cmds/devices.py

@@ -1,6 +1,7 @@
 from datetime import date
 
 import click
+import numpy as np
 from pandas import concat
 from pandas import DataFrame
 from pandas import to_datetime
@@ -19,6 +20,8 @@
 from code42cli.options import sdk_options
 from code42cli.output_formats import DataFrameOutputFormatter
 from code42cli.output_formats import OutputFormatter
+from code42cli.cmds.legal_hold import _get_all_active_matters
+from code42cli.cmds.legal_hold import _get_legal_hold_memberships_for_matter
 
 
 @click.group(cls=OrderedGroup)
@@ -202,6 +205,14 @@ def _get_device_info(sdk, device_guid):
     is_flag=True,
     help="Include device settings in output.",
 )
+@click.option(
+    "--include-legal-hold-membership",
+    required=False,
+    type=bool,
+    default=False,
+    is_flag=True,
+    help="Include legal hold membership in output.",
+)
 @click.option(
     "--exclude-most-recently-connected",
     type=int,
@@ -243,6 +254,7 @@ def list_devices(
     include_backup_usage,
     include_usernames,
     include_settings,
+    include_legal_hold_membership,
     exclude_most_recently_connected,
     last_connected_after,
     last_connected_before,
@@ -288,13 +300,59 @@ def list_devices(
         df = _add_settings_to_dataframe(state.sdk, df)
     if include_usernames:
         df = _add_usernames_to_device_dataframe(state.sdk, df)
+    if include_legal_hold_membership:
+        df = _add_legal_hold_membership_to_device_dataframe(state.sdk, df)   
     if df.empty:
         click.echo("No results found.")
     else:
         formatter = DataFrameOutputFormatter(format)
         formatter.echo_formatted_dataframe(df)
 
 
+def _add_legal_hold_membership_to_device_dataframe(sdk, df):
+    matters = _get_all_active_matters(sdk)
+    matters = [matter["legalHoldUid"] for matter in matters]
+
+    legal_hold_members = []
+
+    for matter in matters:
+        memberships = _get_legal_hold_memberships_for_matter(sdk, matter_id=matter, active=None)
+
+        legal_hold_members.extend(
+            [
+                [
+                    str(member["active"]),
+                    member["user"]["userUid"],
+                    member["legalHold"]["legalHoldUid"],
+                    member["legalHold"]["name"]
+                ]
+                for member in memberships
+            ]
+        )
+        
+    legal_hold_member_dataframe = DataFrame.from_records(
+        legal_hold_members, columns=[
+            "legalHoldMemberActive",
+            "userUid",
+            "legalHoldUid", 
+            "legalHoldName"
+        ]
+    ).groupby(["userUid"]).agg(lambda col: ",".join(col))
+    df = df.merge(legal_hold_member_dataframe, how="left", on="userUid")
+
+    df.loc[
+        df["status"] == "Deactivated", 
+        [
+            "legalHoldMemberActive",
+            "legalHoldUid",
+            "legalHoldName"
+        ]
+    ] = np.nan
+    
+    return df
+
+
+
 def _get_device_dataframe(
     sdk, columns, active=None, org_uid=None, include_backup_usage=False
 ):

src/code42cli/cmds/legal_hold.py

@@ -5,7 +5,6 @@
 
 import click
 from click import echo
-from pandas import DataFrame
 
 from code42cli.bulk import generate_template_cmd_factory
 from code42cli.bulk import run_bulk_process
@@ -93,19 +92,8 @@ def _list(state, format=None):
     is_flag=True,
     help="View details of the preservation policy associated with the legal hold matter.",
 )
-@click.option(
-    "--include-devices",
-    is_flag=True,
-    help="View devices and storage associated with legal hold custodians.",
-)
 @sdk_options()
-def show(
-    state,
-    matter_id,
-    include_inactive=False,
-    include_policy=False,
-    include_devices=False,
-):
+def show(state, matter_id, include_inactive=False, include_policy=False):
     """Display details of a given legal hold matter."""
     matter = _check_matter_is_accessible(state.sdk, matter_id)
     matter["creator_username"] = matter["creator"]["username"]
@@ -117,32 +105,19 @@ def show(
     memberships = _get_legal_hold_memberships_for_matter(
         state.sdk, matter_id, active=active
     )
+    active_usernames = [
+        member["user"]["username"] for member in memberships if member["active"]
+    ]
+    inactive_usernames = [
+        member["user"]["username"] for member in memberships if not member["active"]
+    ]
 
     formatter = OutputFormatter(OutputFormat.TABLE, _MATTER_KEYS_MAP)
     formatter.echo_formatted_list([matter])
-
-    users = [
-        [member["active"], member["user"]["userUid"], member["user"]["username"]]
-        for member in memberships
-    ]
-
-    usernames = [user[2] for user in users if user[0] is True]
-    _print_matter_members(usernames, member_type="active")
+    _print_matter_members(active_usernames, member_type="active")
+    
     if include_inactive:
-        usernames = [user[2] for user in users if user[0] is not True]
-        _print_matter_members(usernames, member_type="inactive")
-
-    if include_devices:
-        user_dataframe = _build_user_dataframe(users)
-        devices_dataframe = _merge_matter_members_with_devices(
-            state.sdk, user_dataframe
-        )
-        if len(devices_dataframe.index):
-            echo("\nMatter Members and Devices:\n")
-            click.echo(devices_dataframe.to_csv())
-            echo(_print_storage_by_org(devices_dataframe))
-        else:
-            echo("\nNo devices associated with matter.\n")
+        _print_matter_members(inactive_usernames, member_type="inactive")
 
     if include_policy:
         _get_and_print_preservation_policy(state.sdk, matter["holdPolicyUid"])
@@ -263,50 +238,6 @@ def _print_matter_members(username_list, member_type="active"):
         echo("No {} matter members.\n".format(member_type))
 
 
-def _merge_matter_members_with_devices(sdk, user_dataframe):
-    devices_generator = sdk.devices.get_all(active=True, include_backup_usage=True)
-    device_list = _get_total_archive_bytes_per_device(devices_generator)
-    devices_dataframe = DataFrame.from_records(
-        device_list,
-        columns=[
-            "userUid",
-            "guid",
-            "name",
-            "osHostname",
-            "status",
-            "alertStates",
-            "orgId",
-            "lastConnected",
-            "version",
-            "archiveBytes",
-        ],
-    )
-    return user_dataframe.merge(
-        devices_dataframe, how="inner", on="userUid"
-    ).reset_index(drop=True)
-
-
-def _build_user_dataframe(users):
-    user_dataframe = DataFrame.from_records(
-        users, columns=["activeMembership", "userUid", "username"]
-    )
-    return user_dataframe
-
-
-def _get_total_archive_bytes_per_device(devices_generator):
-    device_list = [device for page in devices_generator for device in page["computers"]]
-    for device in device_list:
-        archive_bytes = [archive["archiveBytes"] for archive in device["backupUsage"]]
-        device["archiveBytes"] = sum(archive_bytes)
-    return device_list
-
-
-def _get_storage_by_org(devices_dataframe):
-    echo("\nLegal Hold Storage by Org\n")
-    devices_dataframe = devices_dataframe.filter(["orgId", "archiveBytes"])
-    return devices_dataframe.groupby("orgId").sum()
-
-
 @lru_cache(maxsize=None)
 def _check_matter_is_accessible(sdk, matter_id):
     return sdk.legalhold.get_matter_by_uid(matter_id)