adding trusted activities commands (#325)

* adding trusted activities commands

* fixing integration test

* added trust service to build.yml

* doc fixes

* styling

* remove trusted-activities show cmd

* remove trusted-activities show integration test

* styling

* adjust changelog

* by row error handling

* check resource-id type in bulk cmds

* style

* whitespace

* removing redundant try-catch block

Author: tora-kozic

.github/workflows/build.yml

@@ -50,6 +50,7 @@ jobs:
           127.0.0.1 preservation-data-service
           127.0.0.1 connected-server
           127.0.0.1 cases
+          127.0.0.1 trusted-activities-service
           EOF
       - name: Install ncat
         run: sudo apt-get install ncat

CHANGELOG.md

@@ -15,13 +15,22 @@ how a consumer would use the library (e.g. adding unit tests, updating documenta
 - New option `--include-legal-hold-membership` on command `code42 users list` that includes the legal hold matter name and ID for any user on legal hold.
 
 - New commands for deactivating/reactivating Code42 user accounts:
-  - `code42 users deactivate`
-  - `code42 users reactivate`
-  - `code42 users bulk deactivate`
-  - `code42 users bulk reactivate`
+    - `code42 users deactivate`
+    - `code42 users reactivate`
+    - `code42 users bulk deactivate`
+    - `code42 users bulk reactivate`
 
 - `code42 profile use` now prompts you to select a profile when not given a profile name argument.
 
+- New `trusted-activities` commands for managing trusted activities and resources:
+    - `code42 trusted-activities create` to create a trusted activity.
+    - `code42 trusted-activities update` to update a trusted activity.
+    - `code42 trusted-activities remove` to remove a trusted activity.
+    - `code42 trusted-activities list` to print the details of all trusted activities.
+    - `code42 trusted-activities bulk create` to bulk create trusted activities from a CSV file.
+    - `code42 trusted-activities bulk update` to bulk update trusted activities from a CSV file.
+    - `code42 trusted-activities bulk remove` to bulk remove trusted activities from a CSV file.
+
 ### Fixed
 
 - Bug where `audit-logs search` with `--use-checkpoint` option was causing output formatting problems.

docs/commands.md

@@ -1,13 +1,14 @@
 # Commands
 
-* [Profile](commands/profile.rst)
-* [Security Data](commands/securitydata.rst)
-* [Audit Logs](commands/auditlogs.rst)
-* [Alerts](commands/alerts.rst)
 * [Alert Rules](commands/alertrules.rst)
+* [Alerts](commands/alerts.rst)
+* [Audit Logs](commands/auditlogs.rst)
+* [Cases](commands/cases.rst)
 * [Departing Employee](commands/departingemployee.rst)
 * [Devices](commands/devices.rst)
 * [High Risk Employee](commands/highriskemployee.rst)
 * [Legal Hold](commands/legalhold.rst)
-* [Cases](commands/cases.rst)
+* [Profile](commands/profile.rst)
+* [Security Data](commands/securitydata.rst)
+* [Trusted Activities](commands/trustedactivities.rst)
 * [Users](commands/users.rst)

docs/commands/trustedactivities.rst

@@ -0,0 +1,3 @@
+.. click:: code42cli.cmds.trustedactivities:trusted_activities
+  :prog: trusted-activities
+  :nested: full

setup.py

@@ -40,7 +40,7 @@
         "keyrings.alt==3.2.0",
         "ipython>=7.16.1",
         "pandas>=1.1.3",
-        "py42>=1.18.1",
+        "py42>=1.19.0",
     ],
     extras_require={
         "dev": [

src/code42cli/click_ext/groups.py

@@ -15,6 +15,9 @@
 from py42.exceptions import Py42InvalidUsernameError
 from py42.exceptions import Py42LegalHoldNotFoundOrPermissionDeniedError
 from py42.exceptions import Py42OrgNotFoundError
+from py42.exceptions import Py42TrustedActivityConflictError
+from py42.exceptions import Py42TrustedActivityIdNotFound
+from py42.exceptions import Py42TrustedActivityInvalidCharacterError
 from py42.exceptions import Py42UpdateClosedCaseError
 from py42.exceptions import Py42UserAlreadyAddedError
 from py42.exceptions import Py42UsernameMustBeEmailError
@@ -79,6 +82,9 @@ def invoke(self, ctx):
             Py42InvalidUsernameError,
             Py42ActiveLegalHoldError,
             Py42OrgNotFoundError,
+            Py42TrustedActivityConflictError,
+            Py42TrustedActivityInvalidCharacterError,
+            Py42TrustedActivityIdNotFound,
         ) as err:
             self.logger.log_error(err)
             raise Code42CLIError(str(err))

src/code42cli/cmds/trustedactivities.py

@@ -0,0 +1,215 @@
+import click
+from py42.clients.trustedactivities import TrustedActivityType
+
+from code42cli.bulk import generate_template_cmd_factory
+from code42cli.bulk import run_bulk_process
+from code42cli.click_ext.groups import OrderedGroup
+from code42cli.errors import Code42CLIError
+from code42cli.file_readers import read_csv_arg
+from code42cli.options import format_option
+from code42cli.options import sdk_options
+from code42cli.output_formats import OutputFormatter
+
+resource_id_arg = click.argument("resource-id", type=int)
+type_option = click.option(
+    "--type",
+    help=f"Type of trusted activity. Valid types include {', '.join(TrustedActivityType.choices())}.",
+    type=click.Choice(TrustedActivityType.choices()),
+)
+value_option = click.option(
+    "--value",
+    help="The value of the trusted activity, such as the domain or Slack workspace name.",
+)
+description_option = click.option(
+    "--description", help="The description of the trusted activity."
+)
+
+
+def _get_trust_header():
+    return {
+        "resourceId": "Resource Id",
+        "type": "Type",
+        "value": "Value",
+        "description": "Description",
+        "updatedAt": "Last Update Time",
+        "updatedByUsername": "Last Updated By (Username)",
+        "updatedByUserUid": "Last updated By (UserUID)",
+    }
+
+
+@click.group(cls=OrderedGroup)
+@sdk_options(hidden=True)
+def trusted_activities(state):
+    """Manage trusted activities and resources."""
+    pass
+
+
+@trusted_activities.command()
+@click.argument("type", type=click.Choice(TrustedActivityType.choices()))
+@click.argument("value")
+@description_option
+@sdk_options()
+def create(state, type, value, description):
+    """Create a trusted activity.
+
+    VALUE is the name of the domain or Slack workspace.
+    """
+    state.sdk.trustedactivities.create(
+        type, value, description=description,
+    )
+
+
+@trusted_activities.command()
+@resource_id_arg
+@value_option
+@description_option
+@sdk_options()
+def update(state, resource_id, value, description):
+    """Update a trusted activity.  Requires the activity's resource ID."""
+    state.sdk.trustedactivities.update(
+        resource_id, value=value, description=description,
+    )
+
+
+@trusted_activities.command()
+@resource_id_arg
+@sdk_options()
+def remove(state, resource_id):
+    """Remove a trusted activity.  Requires the activity's resource ID."""
+    state.sdk.trustedactivities.delete(resource_id)
+
+
+@trusted_activities.command("list")
+@click.option("--type", type=click.Choice(TrustedActivityType.choices()))
+@format_option
+@sdk_options()
+def _list(state, type, format):
+    """List all trusted activities."""
+    pages = state.sdk.trustedactivities.get_all(type=type)
+    formatter = OutputFormatter(format, _get_trust_header())
+    trusted_resources = [
+        resource for page in pages for resource in page["trustResources"]
+    ]
+    if trusted_resources:
+        formatter.echo_formatted_list(trusted_resources)
+    else:
+        click.echo("No trusted activities found.")
+
+
+@trusted_activities.group(cls=OrderedGroup)
+@sdk_options(hidden=True)
+def bulk(state):
+    """Tools for executing bulk trusted activity actions."""
+    pass
+
+
+TRUST_CREATE_HEADERS = [
+    "type",
+    "value",
+    "description",
+]
+TRUST_UPDATE_HEADERS = [
+    "resource_id",
+    "value",
+    "description",
+]
+TRUST_REMOVE_HEADERS = [
+    "resource_id",
+]
+
+trusted_activities_generate_template = generate_template_cmd_factory(
+    group_name="trusted_activities",
+    commands_dict={
+        "create": TRUST_CREATE_HEADERS,
+        "update": TRUST_UPDATE_HEADERS,
+        "remove": TRUST_REMOVE_HEADERS,
+    },
+    help_message="Generate the CSV template needed for bulk trusted-activities commands",
+)
+bulk.add_command(trusted_activities_generate_template)
+
+
+@bulk.command(
+    name="create",
+    help="Bulk create trusted activities using a CSV file with "
+    f"format: {','.join(TRUST_UPDATE_HEADERS)}.",
+)
+@read_csv_arg(headers=TRUST_CREATE_HEADERS)
+@sdk_options()
+def bulk_create(state, csv_rows):
+    """Bulk create trusted activities."""
+    sdk = state.sdk
+
+    def handle_row(type, value, description):
+        if type not in TrustedActivityType.choices():
+            message = f"Invalid type {type}, valid types include {', '.join(TrustedActivityType.choices())}."
+            raise Code42CLIError(message)
+        if type is None:
+            message = "'type' is a required field to create a trusted activity."
+            raise Code42CLIError(message)
+        if value is None:
+            message = "'value' is a required field to create a trusted activity."
+            raise Code42CLIError(message)
+        sdk.trustedactivities.create(type, value, description)
+
+    run_bulk_process(
+        handle_row, csv_rows, progress_label="Creating trusting activities:",
+    )
+
+
+@bulk.command(
+    name="update",
+    help="Bulk update trusted activities using a CSV file with "
+    f"format: {','.join(TRUST_UPDATE_HEADERS)}.",
+)
+@read_csv_arg(headers=TRUST_UPDATE_HEADERS)
+@sdk_options()
+def bulk_update(state, csv_rows):
+    """Bulk update trusted activities."""
+    sdk = state.sdk
+
+    def handle_row(resource_id, value, description):
+        if resource_id is None:
+            message = "'resource_id' is a required field to update a trusted activity."
+            raise Code42CLIError(message)
+        _check_resource_id_type(resource_id)
+        sdk.trustedactivities.update(resource_id, value, description)
+
+    run_bulk_process(
+        handle_row, csv_rows, progress_label="Updating trusted activities:"
+    )
+
+
+@bulk.command(
+    name="remove",
+    help="Bulk remove trusted activities using a CSV file with "
+    f"format: {','.join(TRUST_REMOVE_HEADERS)}.",
+)
+@read_csv_arg(headers=TRUST_REMOVE_HEADERS)
+@sdk_options()
+def bulk_remove(state, csv_rows):
+    """Bulk remove trusted activities."""
+    sdk = state.sdk
+
+    def handle_row(resource_id):
+        if resource_id is None:
+            message = "'resource_id' is a required field to remove a trusted activity."
+            raise Code42CLIError(message)
+        _check_resource_id_type(resource_id)
+        sdk.trustedactivities.delete(resource_id)
+
+    run_bulk_process(
+        handle_row, csv_rows, progress_label="Removing trusted activities:",
+    )
+
+
+def _check_resource_id_type(resource_id):
+    def raise_error(resource_id):
+        message = f"Invalid resource ID {resource_id}.  Must be an integer."
+        raise Code42CLIError(message)
+
+    try:
+        if not float(resource_id).is_integer():
+            raise_error(resource_id)
+    except ValueError:
+        raise_error(resource_id)

src/code42cli/main.py

@@ -22,6 +22,7 @@
 from code42cli.cmds.profile import profile
 from code42cli.cmds.securitydata import security_data
 from code42cli.cmds.shell import shell
+from code42cli.cmds.trustedactivities import trusted_activities
 from code42cli.cmds.users import users
 from code42cli.options import sdk_options
 
@@ -91,3 +92,4 @@ def cli(state, python, script_dir):
 cli.add_command(security_data)
 cli.add_command(shell)
 cli.add_command(users)
+cli.add_command(trusted_activities)

tests/cmds/test_cases.py

@@ -417,7 +417,7 @@ def test_cases_create_when_description_length_limit_exceeds_raises_exception_pri
     assert "Description limit exceeded, max 250 characters allowed." in result.output
 
 
-def test_cases_udpate_when_description_length_limit_exceeds_raises_exception_prints_error_message(
+def test_cases_update_when_description_length_limit_exceeds_raises_exception_prints_error_message(
     runner, cli_state, case_description_limit_exceeded_error
 ):
     cli_state.sdk.cases.update.side_effect = case_description_limit_exceeded_error