Chore/rename exception catch (#360)

* rename exception catching

* upgrade black to 22.3.0

* upgrade cla assistant

* improved error checking

* bump py42 version

Author: tora-kozic

.github/workflows/cla.yml

@@ -12,7 +12,7 @@ jobs:
       - name: "CLA Assistant"
         if: (github.event.comment.body == 'recheckcla' || github.event.comment.body == 'I have read the CLA Document and I hereby sign the CLA') || github.event_name == 'pull_request_target'
         # Alpha Release
-        uses: cla-assistant/github-action@v2.0.1-alpha
+        uses: cla-assistant/github-action@v2.13.0
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           # the below token should have repo scope and must be manually added by you in the repository's secret
@@ -22,7 +22,7 @@ jobs:
           path-to-cla-document: 'https://code42.github.io/code42-cla/Code42_Individual_Contributor_License_Agreement'
           # branch should not be protected
           branch: 'main'
-          allowlist: alang13,unparalleled-js,kiran-chaudhary,timabrmsn,ceciliastevens,DiscoRiver,annie-payseur,amoravec,patelsagar192
+          allowlist: alang13,unparalleled-js,kiran-chaudhary,timabrmsn,ceciliastevens,DiscoRiver,annie-payseur,amoravec,patelsagar192,tora-kozic
 
           #below are the optional inputs - If the optional inputs are not given, then default values will be taken
           #remote-organization-name: enter the remote organization name where the signatures should be stored (Default is storing the signatures in the same repository)

.pre-commit-config.yaml

@@ -10,7 +10,7 @@ repos:
         - id: reorder-python-imports
           args: ["--application-directories", "src"]
     - repo: https://github.com/psf/black
-      rev: 19.10b0
+      rev: 22.3.0
       hooks:
         - id: black
     - repo: https://gitlab.com/pycqa/flake8

CHANGELOG.md

@@ -11,7 +11,15 @@ how a consumer would use the library (e.g. adding unit tests, updating documenta
 ## Unreleased
 
 ### Added
-- `users add-alias`, `users remove-alias`, `users bulk add-alias`, and `users bulk remove-alias` for managing cloud aliases for users.
+- `departing-employee bulk remove` and `high-risk-employee bulk remove` commands now accept an optional header, as well as extraneous columns if a header is provided.
+- Added `devices rename` and `devices bulk rename` commands to rename devices.
+  - *Note: Incydr devices cannot be renamed.*
+- Added the following commands for managing users' cloud aliases:
+  - `users add-alias`
+  - `users remove-alias`
+  - `users list-aliases`
+  - `users bulk add-alias`
+  - `users bulk remove-alias`
 
 ## 1.12.1 - 2022-01-21
 

CONTRIBUTING.md

@@ -50,6 +50,8 @@ pyenv virtualenv 3.6.10 code42cli
 pyenv activate code42cli
 ```
 
+**Note**: The CLI supports pythons versions 3.6 through 3.9 - any versions within that range should work for your virtual environment.  Use `pyenv --versions` to see all versions available for install. There are some known issues installing python 3.6 with pyenv on certain OS.
+
 Use `source deactivate` to exit the virtual environment and `pyenv activate code42cli` to reactivate it.
 
 ### Windows/Linux
@@ -76,7 +78,7 @@ Next, with your virtual environment activated, install code42cli and its develop
 ["editable mode"](https://pip.pypa.io/en/stable/reference/pip_install/#editable-installs).
 
 ```bash
-pip install -e .[dev]
+pip install -e .'[dev]'
 ```
 
 Open the project in your IDE of choice and change the python environment to

setup.py

@@ -39,7 +39,7 @@
         "keyrings.alt==3.2.0",
         "ipython==7.16.3",
         "pandas>=1.1.3",
-        "py42>=1.21.1",
+        "py42>=1.22.0",
     ],
     extras_require={
         "dev": [

src/code42cli/cmds/alerts.py

@@ -432,7 +432,9 @@ def handle_row(id, state, note):
         _update_alert(sdk, id, state, note)
 
     run_bulk_process(
-        handle_row, csv_rows, progress_label="Updating alerts:",
+        handle_row,
+        csv_rows,
+        progress_label="Updating alerts:",
     )
 
 

src/code42cli/cmds/cases.py

@@ -24,7 +24,10 @@
 case_number_option = click.option(
     "--case-number", type=int, help="The number assigned to the case.", required=True
 )
-name_option = click.option("--name", help="The name 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."
 )
@@ -117,7 +120,8 @@ 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 the user UID of the subject of a case.")
 @click.option("--assignee", help="Filter by the user UID of an assignee.")
@@ -299,7 +303,9 @@ def handle_row(number, event_id):
         sdk.cases.file_events.add(number, event_id)
 
     run_bulk_process(
-        handle_row, csv_rows, progress_label="Associating file events to cases:",
+        handle_row,
+        csv_rows,
+        progress_label="Associating file events to cases:",
     )
 
 

src/code42cli/cmds/departing_employee.py

@@ -49,7 +49,9 @@ def _list(state, format, filter):
     """Lists the users on the Departing Employees list."""
     employee_generator = _get_departing_employees(state.sdk, filter)
     list_employees(
-        employee_generator, format, {"departureDate": "Departure Date"},
+        employee_generator,
+        format,
+        {"departureDate": "Departure Date"},
     )
 
 

src/code42cli/cmds/devices.py

@@ -8,6 +8,7 @@
 from pandas import Series
 from pandas import to_datetime
 from py42 import exceptions
+from py42.clients.settings.device_settings import IncydrDeviceSettings
 from py42.exceptions import Py42NotFoundError
 
 from code42cli.bulk import generate_template_cmd_factory
@@ -35,7 +36,9 @@ def devices(state):
 
 
 device_guid_argument = click.argument(
-    "device-guid", type=str, callback=lambda ctx, param, arg: _verify_guid_type(arg),
+    "device-guid",
+    type=str,
+    callback=lambda ctx, param, arg: _verify_guid_type(arg),
 )
 
 new_device_name_option = click.option(
@@ -159,8 +162,16 @@ def _update_cold_storage_purge_date(sdk, guid, purge_date):
 def _change_device_name(sdk, guid, name):
     try:
         device_settings = sdk.devices.get_settings(guid)
+        if isinstance(device_settings, IncydrDeviceSettings):
+            raise Code42CLIError(
+                "Failed to rename device. Incydr devices cannot be renamed."
+            )
         device_settings.name = name
         sdk.devices.update_settings(device_settings)
+    except KeyError:
+        raise Code42CLIError(
+            "Failed to rename device. This device is missing expected settings fields."
+        )
     except exceptions.Py42ForbiddenError:
         raise Code42CLIError(
             f"You don't have the necessary permissions to rename the device with GUID '{guid}'."
@@ -500,7 +511,12 @@ def _break_backup_usage_into_total_storage(backup_usage):
 @format_option
 @sdk_options()
 def list_backup_sets(
-    state, active, inactive, org_uid, include_usernames, format,
+    state,
+    active,
+    inactive,
+    org_uid,
+    include_usernames,
+    format,
 ):
     """Get information about many devices and their backup sets."""
     if inactive:

src/code42cli/cmds/high_risk_employee.py

@@ -176,7 +176,9 @@ def handle_row(username, tag):
         _add_risk_tags(sdk, username, tag)
 
     run_bulk_process(
-        handle_row, csv_rows, progress_label="Adding risk tags to users:",
+        handle_row,
+        csv_rows,
+        progress_label="Adding risk tags to users:",
     )
 
 
@@ -194,7 +196,9 @@ def handle_row(username, tag):
         _remove_risk_tags(sdk, username, tag)
 
     run_bulk_process(
-        handle_row, csv_rows, progress_label="Removing risk tags from users:",
+        handle_row,
+        csv_rows,
+        progress_label="Removing risk tags from users:",
     )