Users fixes (#274)

Author: Juliya Smith

src/code42cli/cmds/users.py

@@ -7,6 +7,7 @@
 from code42cli.options import format_option
 from code42cli.options import sdk_options
 from code42cli.output_formats import DataFrameOutputFormatter
+from code42cli.output_formats import OutputFormat
 
 
 @click.group(cls=OrderedGroup)
@@ -46,7 +47,12 @@ def list_users(state, org_uid, role_name, active, inactive, format):
     if inactive:
         active = False
     role_id = _get_role_id(state.sdk, role_name) if role_name else None
-    df = _get_users_dataframe(state.sdk, org_uid, role_id, active)
+    columns = (
+        ["userUid", "status", "username", "orgUid"]
+        if format == OutputFormat.TABLE
+        else None
+    )
+    df = _get_users_dataframe(state.sdk, columns, org_uid, role_id, active)
     if df.empty:
         click.echo("No results found.")
     else:
@@ -65,9 +71,10 @@ def _get_role_id(sdk, role_name):
         raise Code42CLIError(f"Role with name {role_name} not found.")
 
 
-def _get_users_dataframe(sdk, org_uid, role_id, active):
+def _get_users_dataframe(sdk, columns, org_uid, role_id, active):
     users_generator = sdk.users.get_all(active=active, org_uid=org_uid, role_id=role_id)
     users_list = []
     for page in users_generator:
         users_list.extend(page["users"])
-    return DataFrame.from_records(users_list)
+
+    return DataFrame.from_records(users_list, columns=columns)

tests/cmds/test_users.py

@@ -6,19 +6,29 @@
 
 from code42cli.main import cli
 
+
 TEST_ROLE_RETURN_DATA = {
     "data": [{"roleName": "Customer Cloud Admin", "roleId": "1234543"}]
 }
-
 TEST_USERS_RESPONSE = {
     "users": [
         {
-            "userId": 1234,
-            "userUid": "997962681513153325",
+            "firstName": "test",
+            "lastName": "username",
+            "orgId": 4321,
+            "orgUid": "44444444",
+            "orgName": "ORG_NAME",
             "status": "Active",
-            "username": "test_username@code42.com",
+            "notes": "This is a note.",
+            "active": True,
+            "blocked": False,
             "creationDate": "2021-03-12T20:07:40.898Z",
             "modificationDate": "2021-03-12T20:07:40.938Z",
+            "userId": 1234,
+            "username": "test.username@example.com",
+            "userUid": "911162111513111325",
+            "invited": False,
+            "quotaInBytes": 55555,
         }
     ]
 }
@@ -51,14 +61,49 @@ def get_available_roles_success(cli_state, get_available_roles_response):
     cli_state.sdk.users.get_available_roles.return_value = get_available_roles_response
 
 
-def test_list_outputs_appropriate_columns(runner, cli_state, get_all_users_success):
-    result = runner.invoke(cli, ["users", "list"], obj=cli_state)
+def test_list_when_non_table_format_outputs_expected_columns(
+    runner, cli_state, get_all_users_success
+):
+    result = runner.invoke(cli, ["users", "list", "-f", "CSV"], obj=cli_state)
+    assert "firstName" in result.output
+    assert "lastName" in result.output
+    assert "orgId" in result.output
+    assert "orgUid" in result.output
+    assert "orgName" in result.output
+    assert "status" in result.output
+    assert "notes" in result.output
+    assert "active" in result.output
+    assert "blocked" in result.output
+    assert "creationDate" in result.output
+    assert "modificationDate" in result.output
     assert "userId" in result.output
+    assert "username" in result.output
     assert "userUid" in result.output
+    assert "invited" in result.output
+    assert "quotaInBytes" in result.output
+
+
+def test_list_when_table_format_outputs_expected_columns(
+    runner, cli_state, get_all_users_success
+):
+    result = runner.invoke(cli, ["users", "list", "-f", "TABLE"], obj=cli_state)
+    assert "orgUid" in result.output
     assert "status" in result.output
     assert "username" in result.output
-    assert "creationDate" in result.output
-    assert "modificationDate" in result.output
+    assert "userUid" in result.output
+
+    assert "firstName" not in result.output
+    assert "lastName" not in result.output
+    assert "orgId" not in result.output
+    assert "orgName" not in result.output
+    assert "notes" not in result.output
+    assert "active" not in result.output
+    assert "blocked" not in result.output
+    assert "creationDate" not in result.output
+    assert "modificationDate" not in result.output
+    assert "userId" not in result.output
+    assert "invited" not in result.output
+    assert "quotaInBytes" not in result.output
 
 
 def test_list_users_calls_users_get_all_with_expected_role_id(