Improvement/help (#18)

Juliya Smith · web-flow · commit 231cf93af796 · 2020-03-17T12:34:25.000Z
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -18,6 +18,10 @@ how a consumer would use the library (e.g. adding unit tests, updating documenta
 
 - Bug where keyring caused errors on certain operating systems when not supported.
 
+### Changed
+
+- Updated help texts to be more descriptive.
+
 ## 0.4.2 - 2020-03-13
 
 ### Fixed
diff --git a/setup.py b/setup.py
@@ -20,7 +20,7 @@
     packages=find_packages("src"),
     package_dir={"": "src"},
     python_requires=">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, <4",
-    install_requires=["c42eventextractor==0.2.1", "keyring==18.0.1","py42==0.5.1"],
+    install_requires=["c42eventextractor==0.2.2", "keyring==18.0.1","py42==0.6.0"],
     license="MIT",
     include_package_data=True,
     zip_safe=False,
diff --git a/src/code42cli/main.py b/src/code42cli/main.py
@@ -1,13 +1,13 @@
 import platform
-from argparse import ArgumentParser
+from argparse import ArgumentParser, RawDescriptionHelpFormatter
 
 import code42cli.securitydata.main as securitydata
 from code42cli.compat import str
 from code42cli.profile import profile
 
 # If on Windows, configure console session to handle ANSI escape sequences correctly
 # source: https://bugs.python.org/issue29059
-if platform.system().lower() == "windows":
+if platform.system().lower() == u"windows":
     from ctypes import windll, c_int, byref
 
     stdout_handle = windll.kernel32.GetStdHandle(c_int(-11))
@@ -18,8 +18,17 @@
 
 
 def main():
-    code42_arg_parser = ArgumentParser()
-    subcommand_parser = code42_arg_parser.add_subparsers()
+    description = u"""
+    Groups:
+        profile      - For managing Code42 settings.
+        securitydata - Tools for getting security related data, such as file events.
+    """
+    code42_arg_parser = ArgumentParser(
+        formatter_class=RawDescriptionHelpFormatter,
+        description=description,
+        usage=u"code42 <group> <subcommand> <optional args>",
+    )
+    subcommand_parser = code42_arg_parser.add_subparsers(title=u"groups")
     profile.init(subcommand_parser)
     securitydata.init_subcommand(subcommand_parser)
     _run(code42_arg_parser)
@@ -30,7 +39,7 @@ def _run(parser):
         args = parser.parse_args()
         args.func(args)
     except AttributeError as ex:
-        if str(ex) == "'Namespace' object has no attribute 'func'":
+        if str(ex) == u"'Namespace' object has no attribute 'func'":
             parser.print_help()
             return
         raise ex
diff --git a/src/code42cli/profile/profile.py b/src/code42cli/profile/profile.py
@@ -1,5 +1,7 @@
 from __future__ import print_function
 
+from argparse import RawDescriptionHelpFormatter
+
 import code42cli.arguments as main_args
 import code42cli.profile.password as password
 from code42cli.compat import str
@@ -52,14 +54,48 @@ def init(subcommand_parser):
         Args:
             subcommand_parser: The subparsers group created by the parent parser.
     """
-    parser_profile = subcommand_parser.add_parser(u"profile")
-    profile_subparsers = parser_profile.add_subparsers()
-
-    parser_for_show = profile_subparsers.add_parser(u"show")
-    parser_for_set = profile_subparsers.add_parser(u"set")
-    parser_for_reset_password = profile_subparsers.add_parser(u"reset-pw")
-    parser_for_list = profile_subparsers.add_parser(u"list")
-    parser_for_use = profile_subparsers.add_parser(u"use")
+
+    description = u"""
+    Subcommands:
+          show      - Print the details of a profile.
+          set       - Create or update profile settings. The first profile created will be the default.
+          reset-pw  - Change the stored password for a profile.
+          list      - Show all existing stored profiles.
+          use       - Set a profile as the default.
+    """
+    parser_profile = subcommand_parser.add_parser(
+        u"profile",
+        formatter_class=RawDescriptionHelpFormatter,
+        description=description,
+        usage=u"code42 profile <subcommand> <optional args>",
+    )
+    profile_subparsers = parser_profile.add_subparsers(title="subcommands")
+
+    parser_for_show = profile_subparsers.add_parser(
+        u"show",
+        description=u"Print the details of a profile.",
+        usage=u"code42 profile show <optional-args>",
+    )
+    parser_for_set = profile_subparsers.add_parser(
+        u"set",
+        description=u"Create or update profile settings. The first profile created will be the default.",
+        usage=u"code42 profile set <optional-args>",
+    )
+    parser_for_reset_password = profile_subparsers.add_parser(
+        u"reset-pw",
+        description=u"Change the stored password for a profile.",
+        usage=u"code42 profile reset-pw <optional-args>",
+    )
+    parser_for_list = profile_subparsers.add_parser(
+        u"list",
+        description=u"Show all existing stored profiles.",
+        usage=u"code42 profile list <optional-args>",
+    )
+    parser_for_use = profile_subparsers.add_parser(
+        u"use",
+        description=u"Set a profile as the default.",
+        usage=u"code42 profile use <profile-name>",
+    )
 
     parser_for_show.set_defaults(func=show_profile)
     parser_for_set.set_defaults(func=set_profile)
diff --git a/src/code42cli/sdk_client.py b/src/code42cli/sdk_client.py
@@ -1,16 +1,15 @@
-from py42 import debug_level
-from py42 import settings
-from py42.sdk import SDK
+import py42.sdk
+import py42.sdk.settings.debug as debug
 
 from code42cli.util import print_error
 
 
 def create_sdk(profile, is_debug_mode):
     if is_debug_mode:
-        settings.debug_level = debug_level.DEBUG
+        py42.sdk.settings.debug.level = debug.DEBUG
     try:
         password = profile.get_password()
-        return SDK.create_using_local_account(profile.authority_url, profile.username, password)
+        return py42.sdk.from_local_account(profile.authority_url, profile.username, password)
     except Exception:
         print_error(
             u"Invalid credentials or host address. "
@@ -21,7 +20,8 @@ def create_sdk(profile, is_debug_mode):
 
 def validate_connection(authority_url, username, password):
     try:
-        SDK.create_using_local_account(authority_url, username, password)
+        py42.sdk.from_local_account(authority_url, username, password)
         return True
     except:
+        print(username, password, authority_url)
         return False
diff --git a/src/code42cli/securitydata/arguments/search.py b/src/code42cli/securitydata/arguments/search.py
@@ -116,7 +116,7 @@ def _add_actor_arg(parser):
         nargs=u"+",
         action=u"store",
         dest=SearchArguments.ACTOR,
-        help=u"Limits events to only those enacted by these actors.",
+        help=u"Limits events to only those enacted by the cloud service user of the person who caused the event.",
     )
 
 
diff --git a/src/code42cli/securitydata/date_helper.py b/src/code42cli/securitydata/date_helper.py
@@ -1,7 +1,7 @@
 from datetime import datetime, timedelta
 
 from c42eventextractor.common import convert_datetime_to_timestamp
-from py42.sdk.file_event_query.event_query import EventTimestamp
+from py42.sdk.queries.fileevents.filters.event_filter import EventTimestamp
 
 _MAX_LOOK_BACK_DAYS = 90
 _FORMAT_VALUE_ERROR_MESSAGE = u"input must be a date in YYYY-MM-DD or YYYY-MM-DD HH:MM:SS format."
diff --git a/src/code42cli/securitydata/extraction.py b/src/code42cli/securitydata/extraction.py
@@ -4,11 +4,7 @@
 
 from c42eventextractor import FileEventHandlers
 from c42eventextractor.extractors import FileEventExtractor
-from py42.sdk.file_event_query.cloud_query import Actor
-from py42.sdk.file_event_query.device_query import DeviceUsername
-from py42.sdk.file_event_query.event_query import Source
-from py42.sdk.file_event_query.exposure_query import ExposureType, ProcessOwner, TabURL
-from py42.sdk.file_event_query.file_query import MD5, SHA256, FileName, FilePath
+from py42.sdk.queries.fileevents.filters import *
 
 from code42cli.compat import str
 from code42cli.profile.profile import get_profile
diff --git a/src/code42cli/securitydata/main.py b/src/code42cli/securitydata/main.py
@@ -1,11 +1,26 @@
+from argparse import RawDescriptionHelpFormatter
+
 from code42cli.securitydata.subcommands import clear_checkpoint, print_out, write_to
 from code42cli.securitydata.subcommands import send_to
 
 
 def init_subcommand(subcommand_parser):
-    securitydata_arg_parser = subcommand_parser.add_parser("securitydata")
-    securitydata_subparser = securitydata_arg_parser.add_subparsers()
-    send_to.init(securitydata_subparser)
-    write_to.init(securitydata_subparser)
-    print_out.init(securitydata_subparser)
-    clear_checkpoint.init(securitydata_subparser)
+    description = u"""
+    Subcommands:
+            print             - Print file events to stdout.
+            send-to           - Send file events to the given server address.
+            write-to          - Write file events to the file with the given name.
+            clear-checkpoint  - Remove the saved checkpoint from 'incremental' (-i) mode.
+    """
+    securitydata_arg_parser = subcommand_parser.add_parser(
+        u"securitydata",
+        formatter_class=RawDescriptionHelpFormatter,
+        description=description,
+        epilog=u"Use '--profile <profile-name>' to execute any of these commands for the given profile.",
+        usage=u"code42 securitydata <subcommand> <optional args>",
+    )
+    securitydata_subparsers = securitydata_arg_parser.add_subparsers(title=u"subcommands")
+    send_to.init(securitydata_subparsers)
+    write_to.init(securitydata_subparsers)
+    print_out.init(securitydata_subparsers)
+    clear_checkpoint.init(securitydata_subparsers)
diff --git a/src/code42cli/securitydata/subcommands/clear_checkpoint.py b/src/code42cli/securitydata/subcommands/clear_checkpoint.py
@@ -8,7 +8,11 @@ def init(subcommand_parser):
         Args:
             subcommand_parser: The subparsers group created by the parent parser.
     """
-    parser = subcommand_parser.add_parser("clear-checkpoint")
+    parser = subcommand_parser.add_parser(
+        u"clear-checkpoint",
+        description=u"Remove the saved checkpoint from 'incremental' (-i) mode.",
+        usage=u"code42 securitydata clear-checkpoint <optional-args>",
+    )
     add_profile_name_arg(parser)
     parser.set_defaults(func=clear_checkpoint)
 
diff --git a/src/code42cli/securitydata/subcommands/print_out.py b/src/code42cli/securitydata/subcommands/print_out.py
@@ -11,7 +11,11 @@ def init(subcommand_parser):
         Args:
             subcommand_parser: The subparsers group created by the parent parser.
     """
-    parser = subcommand_parser.add_parser("print")
+    parser = subcommand_parser.add_parser(
+        u"print",
+        description=u"Print file events to stdout",
+        usage=u"code42 securitydata print <optional-args>",
+    )
     parser.set_defaults(func=print_out)
     search_args.add_arguments_to_parser(parser)
     securitydata_main_args.add_arguments_to_parser(parser)
diff --git a/src/code42cli/securitydata/subcommands/send_to.py b/src/code42cli/securitydata/subcommands/send_to.py
@@ -12,7 +12,11 @@ def init(subcommand_parser):
         Args:
             subcommand_parser: The subparsers group created by the parent parser
     """
-    parser = subcommand_parser.add_parser("send-to")
+    parser = subcommand_parser.add_parser(
+        u"send-to",
+        description=u"Send file events to the given server address.",
+        usage=u"code42 securitydata send-to <server-address> <optional-args>",
+    )
     parser.set_defaults(func=send_to)
     _add_server_arg(parser)
     _add_protocol_arg(parser)
@@ -28,16 +32,18 @@ def send_to(args):
 
 
 def _add_server_arg(parser):
-    parser.add_argument(action="store", dest="server", help="The server address to send output to.")
+    parser.add_argument(
+        action=u"store", dest=u"server", help=u"The server address to send output to."
+    )
 
 
 def _add_protocol_arg(parser):
     parser.add_argument(
-        "-p",
-        "--protocol",
-        action="store",
-        dest="protocol",
+        u"-p",
+        u"--protocol",
+        action=u"store",
+        dest=u"protocol",
         choices=ServerProtocol(),
         default=ServerProtocol.UDP,
-        help="Protocol used to send logs to server.",
+        help=u"Protocol used to send logs to server.",
     )
diff --git a/src/code42cli/securitydata/subcommands/write_to.py b/src/code42cli/securitydata/subcommands/write_to.py
@@ -11,7 +11,11 @@ def init(subcommand_parser):
         Args:
             subcommand_parser: The subparsers group created by the parent parser.
     """
-    parser = subcommand_parser.add_parser("write-to")
+    parser = subcommand_parser.add_parser(
+        u"write-to",
+        description=u"Write file events to the file with the given name.",
+        usage=u"code42 securitydata write-to <filename> <optional-args>",
+    )
     parser.set_defaults(func=write_to)
     _add_filename_subcommand(parser)
     search_args.add_arguments_to_parser(parser)
diff --git a/tests/securitydata/test_extraction.py b/tests/securitydata/test_extraction.py
@@ -1,9 +1,5 @@
 import pytest
-from py42.sdk.alert_query import Actor
-from py42.sdk.file_event_query.device_query import DeviceUsername
-from py42.sdk.file_event_query.event_query import Source, EventTimestamp
-from py42.sdk.file_event_query.exposure_query import ExposureType, ProcessOwner, TabURL
-from py42.sdk.file_event_query.file_query import FilePath, FileName, SHA256, MD5
+from py42.sdk.queries.fileevents.filters import *
 
 import code42cli.securitydata.extraction as extraction_module
 from code42cli.securitydata.options import ExposureType as ExposureTypeOptions
@@ -13,7 +9,7 @@
 
 @pytest.fixture(autouse=True)
 def mock_42(mocker):
-    return mocker.patch("py42.sdk.SDK.create_using_local_account")
+    return mocker.patch("py42.sdk.from_local_account")
 
 
 @pytest.fixture
diff --git a/tests/test_sdk_client.py b/tests/test_sdk_client.py
@@ -1,18 +1,18 @@
 import pytest
-from py42 import debug_level
-from py42 import settings
+import py42.sdk
+import py42.sdk.settings.debug as debug
 
 from code42cli.sdk_client import create_sdk, validate_connection
 from .conftest import create_mock_profile
 
 
 @pytest.fixture
 def mock_sdk_factory(mocker):
-    return mocker.patch("py42.sdk.SDK.create_using_local_account")
+    return mocker.patch("py42.sdk.from_local_account")
 
 
 @pytest.fixture
-def error_sdk_factory(mocker, mock_sdk_factory):
+def error_sdk_factory(mock_sdk_factory):
     def side_effect():
         raise Exception()
 
@@ -29,7 +29,7 @@ def test_create_sdk_when_py42_exception_occurs_causes_exit(error_sdk_factory):
 def test_create_sdk_when_told_to_debug_turns_on_debug(mock_sdk_factory):
     profile = create_mock_profile()
     create_sdk(profile, True)
-    assert settings.debug_level == debug_level.DEBUG
+    assert py42.sdk.settings.debug.level == debug.DEBUG
 
 
 def test_validate_connection_when_creating_sdk_raises_returns_false(error_sdk_factory):

Original file line number	Diff line number	Diff line change
`@@ -116,7 +116,7 @@ def _add_actor_arg(parser):`
`116`	`116`	`nargs=u"+",`
`117`	`117`	`action=u"store",`
`118`	`118`	`dest=SearchArguments.ACTOR,`
`119`		`- help=u"Limits events to only those enacted by these actors.",`
	`119`	`+ help=u"Limits events to only those enacted by the cloud service user of the person who caused the event.",`
`120`	`120`	`)`
`121`	`121`
`122`	`122`