Chore/agent str (#33)

Author: Juliya Smith

src/code42cli/__init__.py

@@ -1 +1 @@
-
+PRODUCT_NAME = u"code42cli"

src/code42cli/cmds/securitydata/extraction.py

@@ -17,6 +17,7 @@
 from code42cli.compat import str
 from code42cli.util import is_interactive, print_bold, print_error, print_to_stderr
 
+
 _EXCEPTIONS_OCCURRED = False
 _TOTAL_EVENTS = 0
 

src/code42cli/main.py

@@ -1,6 +1,9 @@
 import platform
 import sys
 
+from py42.sdk.settings import set_user_agent_suffix
+
+from code42cli import PRODUCT_NAME
 from code42cli.cmds import profile
 from code42cli.cmds.detectionlists import main as dlmain
 from code42cli.cmds.securitydata import main as secmain
@@ -19,6 +22,11 @@
     windll.kernel32.SetConsoleMode(c_int(stdout_handle), mode)
 
 
+# Sets part of the user agent string that py42 attaches to requests for the purposes of
+# identifying CLI users.
+set_user_agent_suffix(PRODUCT_NAME)
+
+
 def main():
     top = Command(u"", u"", subcommand_loader=_load_top_commands)
     invoker = CommandInvoker(top)

src/code42cli/password.py

@@ -4,10 +4,9 @@
 
 import keyring
 
+from code42cli import PRODUCT_NAME
 from code42cli.util import does_user_agree
 
-_ROOT_SERVICE_NAME = u"code42cli"
-
 
 def get_stored_password(profile):
     """Gets your currently stored password for the given profile name."""
@@ -31,7 +30,7 @@ def set_password(profile, new_password):
 
 
 def _get_keyring_service_name(profile_name):
-    return u"{}::{}".format(_ROOT_SERVICE_NAME, profile_name)
+    return u"{}::{}".format(PRODUCT_NAME, profile_name)
 
 
 def _prompt_for_alternative_store():

tests/cmds/detectionlists/test_high_risk.py

@@ -1,5 +1,6 @@
 import pytest
 
+from code42cli import PRODUCT_NAME
 from code42cli.cmds.detectionlists.high_risk import (
     generate_csv_file,
     add_high_risk_employee,
@@ -9,7 +10,16 @@
 
 @pytest.fixture
 def bulk_template_generator(mocker):
-    return mocker.patch("code42cli.cmds.detectionlists.high_risk.generate_template")
+    return mocker.patch("{}.cmds.detectionlists.high_risk.generate_template".format(PRODUCT_NAME))
+
+
+@pytest.fixture
+def bulk_processor_factory(mocker, bulk_processor):
+    factory = mocker.patch(
+        "{}.cmds.detectionlists.high_risk.create_bulk_processor".format(PRODUCT_NAME)
+    )
+    factory.return_value = bulk_processor
+    return factory
 
 
 def test_generate_csv_file_generates_template(bulk_template_generator):
@@ -18,15 +28,11 @@ def test_generate_csv_file_generates_template(bulk_template_generator):
     bulk_template_generator.assert_called_once_with(add_high_risk_employee, path)
 
 
-def test_bulk_add_high_risk_employees_runs(mocker, bulk_processor, sdk, profile):
-    factory = mocker.patch("code42cli.cmds.detectionlists.high_risk.create_bulk_processor")
-    factory.return_value = bulk_processor
+def test_bulk_add_high_risk_employees_runs(sdk, profile, bulk_processor, bulk_processor_factory):
     bulk_add_high_risk_employees(sdk, profile, "")
     assert bulk_processor.run.call_count == 1
 
 
-def test_bulk_add_high_risk_employees_creates_processor(mocker, bulk_processor, sdk, profile):
-    factory = mocker.patch("code42cli.cmds.detectionlists.high_risk.create_bulk_processor")
-    factory.return_value = bulk_processor
+def test_bulk_add_high_risk_employees_creates_processor(sdk, profile, bulk_processor_factory):
     bulk_add_high_risk_employees(sdk, profile, "csv_test")
-    assert factory.call_args[0][0] == "csv_test"
+    assert bulk_processor_factory.call_args[0][0] == "csv_test"

tests/cmds/securitydata/conftest.py

@@ -3,7 +3,9 @@
 
 import pytest
 
-SECURITYDATA_NAMESPACE = "code42cli.cmds.securitydata"
+from code42cli import PRODUCT_NAME
+
+SECURITYDATA_NAMESPACE = "{}.cmds.securitydata".format(PRODUCT_NAME)
 
 
 def get_filter_value_from_json(json, filter_index):

tests/cmds/securitydata/test_cursor_store.py

@@ -1,6 +1,8 @@
 from os import path
 
 from c42eventextractor.extractors import INSERTION_TIMESTAMP_FIELD_NAME
+
+from code42cli import PRODUCT_NAME
 from code42cli.cmds.shared.cursor_store import BaseCursorStore, FileEventCursorStore
 
 
@@ -27,7 +29,9 @@ class TestFileEventCursorStore(object):
     def test_init_when_called_twice_with_different_profile_names_creates_two_rows(
         self, mocker, sqlite_connection
     ):
-        mock = mocker.patch("code42cli.cmds.shared.cursor_store.FileEventCursorStore._row_exists")
+        mock = mocker.patch(
+            "{}.cmds.shared.cursor_store.FileEventCursorStore._row_exists".format(PRODUCT_NAME)
+        )
         mock.return_value = False
         spy = mocker.spy(FileEventCursorStore, "_insert_new_row")
         FileEventCursorStore("Profile A", self.MOCK_TEST_DB_NAME)

tests/cmds/securitydata/test_extraction.py

@@ -1,9 +1,11 @@
-import code42cli.cmds.securitydata.extraction as extraction_module
 import pytest
-from code42cli.cmds.securitydata.enums import ExposureType as ExposureTypeOptions
+
 from py42.sdk import SDKClient
 from py42.sdk.queries.fileevents.filters import *
 
+from code42cli import PRODUCT_NAME
+from code42cli.cmds.securitydata.enums import ExposureType as ExposureTypeOptions
+import code42cli.cmds.securitydata.extraction as extraction_module
 from .conftest import (
     SECURITYDATA_NAMESPACE,
     begin_date_str,
@@ -34,6 +36,11 @@ def error_logger(mocker):
     return mocker.patch("{0}.extraction.get_error_logger".format(SECURITYDATA_NAMESPACE))
 
 
+@pytest.fixture
+def error_printer(mocker):
+    return mocker.patch("{}.cmds.securitydata.extraction.print_error".format(PRODUCT_NAME))
+
+
 @pytest.fixture
 def extractor(mocker):
     mock = mocker.MagicMock()
@@ -50,6 +57,32 @@ def namespace_with_begin(namespace):
     return namespace
 
 
+@pytest.fixture
+def is_interactive_function(mocker):
+    return mocker.patch("{}.cmds.securitydata.extraction.is_interactive".format(PRODUCT_NAME))
+
+
+@pytest.fixture
+def interactive_mode(is_interactive_function):
+    is_interactive_function.return_value = True
+    return is_interactive_function
+
+
+@pytest.fixture
+def non_interactive_mode(is_interactive_function):
+    is_interactive_function.return_value = False
+    return is_interactive_function
+
+
+@pytest.fixture
+def checkpoint(mocker):
+    return mocker.patch(
+        "{}.cmds.shared.cursor_store.FileEventCursorStore.get_stored_insertion_timestamp".format(
+            PRODUCT_NAME
+        )
+    )
+
+
 def filter_term_is_in_call_args(extractor, term):
     arg_filters = extractor.extract.call_args[0]
     for f in arg_filters:
@@ -292,27 +325,21 @@ def test_extract_when_end_date_is_before_begin_date_causes_exit(
 
 
 def test_when_given_begin_date_past_90_days_and_is_incremental_and_a_stored_cursor_exists_and_not_given_end_date_does_not_use_any_event_timestamp_filter(
-    mocker, sdk, profile, logger, namespace, extractor
+    sdk, profile, logger, namespace, extractor, checkpoint
 ):
     namespace.begin = "2019-01-01"
     namespace.incremental = True
-    mock_checkpoint = mocker.patch(
-        "code42cli.cmds.shared.cursor_store.FileEventCursorStore.get_stored_insertion_timestamp"
-    )
-    mock_checkpoint.return_value = 22624624
+    checkpoint.return_value = 22624624
     extraction_module.extract(sdk, profile, logger, namespace)
     assert not filter_term_is_in_call_args(extractor, EventTimestamp._term)
 
 
 def test_when_given_begin_date_and_not_interactive_mode_and_cursor_exists_uses_begin_date(
-    mocker, sdk, profile, logger, namespace, extractor
+    sdk, profile, logger, namespace, extractor
 ):
     namespace.begin = get_test_date_str(days_ago=1)
     namespace.incremental = False
-    mock_checkpoint = mocker.patch(
-        "code42cli.cmds.shared.cursor_store.FileEventCursorStore.get_stored_insertion_timestamp"
-    )
-    mock_checkpoint.return_value = 22624624
+    checkpoint.return_value = 22624624
     extraction_module.extract(sdk, profile, logger, namespace)
 
     actual_ts = get_filter_value_from_json(extractor.extract.call_args[0][0], filter_index=0)
@@ -322,14 +349,11 @@ def test_when_given_begin_date_and_not_interactive_mode_and_cursor_exists_uses_b
 
 
 def test_when_not_given_begin_date_and_is_incremental_but_no_stored_checkpoint_exists_causes_exit(
-    mocker, sdk, profile, logger, namespace, extractor
+    sdk, profile, logger, namespace, extractor
 ):
     namespace.begin = None
     namespace.is_incremental = True
-    mock_checkpoint = mocker.patch(
-        "code42cli.cmds.shared.cursor_store.FileEventCursorStore.get_stored_insertion_timestamp"
-    )
-    mock_checkpoint.return_value = None
+    checkpoint.return_value = None
     with pytest.raises(SystemExit):
         extraction_module.extract(sdk, profile, logger, namespace)
 
@@ -492,42 +516,27 @@ def side_effect():
 
 
 def test_extract_when_global_variable_is_true_and_is_interactive_prints_error(
-    mocker, sdk, profile, logger, namespace_with_begin, extractor
+    sdk, profile, logger, namespace_with_begin, extractor, error_printer, interactive_mode
 ):
-    mock_error_printer = mocker.patch("code42cli.cmds.securitydata.extraction.print_error")
-    mock_is_interactive_function = mocker.patch(
-        "code42cli.cmds.securitydata.extraction.is_interactive"
-    )
-    mock_is_interactive_function.return_value = True
     extraction_module._EXCEPTIONS_OCCURRED = True
     extraction_module.extract(sdk, profile, logger, namespace_with_begin)
-    assert mock_error_printer.call_count
+    assert error_printer.call_count
 
 
 def test_extract_when_global_variable_is_true_and_not_is_interactive_does_not_print_error(
-    mocker, sdk, profile, logger, namespace_with_begin, extractor
+    sdk, profile, logger, namespace_with_begin, extractor, error_printer, non_interactive_mode
 ):
-    mock_error_printer = mocker.patch("code42cli.cmds.securitydata.extraction.print_error")
-    mock_is_interactive_function = mocker.patch(
-        "code42cli.cmds.securitydata.extraction.is_interactive"
-    )
-    mock_is_interactive_function.return_value = False
     extraction_module._EXCEPTIONS_OCCURRED = True
     extraction_module.extract(sdk, profile, logger, namespace_with_begin)
-    assert not mock_error_printer.call_count
+    assert not error_printer.call_count
 
 
 def test_extract_when_global_variable_is_false_and_is_interactive_does_not_print_error(
-    mocker, sdk, profile, logger, namespace_with_begin, extractor
+    sdk, profile, logger, namespace_with_begin, extractor, error_printer, interactive_mode
 ):
-    mock_error_printer = mocker.patch("code42cli.cmds.securitydata.extraction.print_error")
-    mock_is_interactive_function = mocker.patch(
-        "code42cli.cmds.securitydata.extraction.is_interactive"
-    )
-    mock_is_interactive_function.return_value = True
     extraction_module._EXCEPTIONS_OCCURRED = False
     extraction_module.extract(sdk, profile, logger, namespace_with_begin)
-    assert not mock_error_printer.call_count
+    assert not error_printer.call_count
 
 
 def test_when_sdk_raises_exception_global_variable_gets_set(
@@ -537,7 +546,7 @@ def test_when_sdk_raises_exception_global_variable_gets_set(
     mock_sdk = mocker.MagicMock()
 
     # For ease
-    mock = mocker.patch("code42cli.cmds.securitydata.extraction.is_interactive")
+    mock = mocker.patch("{}.cmds.securitydata.extraction.is_interactive".format(PRODUCT_NAME))
     mock.return_value = False
 
     def sdk_side_effect(self, *args):

tests/cmds/securitydata/test_main.py

@@ -1,15 +1,16 @@
+from code42cli import PRODUCT_NAME
 import code42cli.cmds.securitydata.main as main
 import pytest
 
 
 @pytest.fixture
 def mock_logger_factory(mocker):
-    return mocker.patch("code42cli.cmds.securitydata.main.logger_factory")
+    return mocker.patch("{}.cmds.securitydata.main.logger_factory".format(PRODUCT_NAME))
 
 
 @pytest.fixture
 def mock_extract(mocker):
-    return mocker.patch("code42cli.cmds.securitydata.main.extract")
+    return mocker.patch("{}.cmds.securitydata.main.extract".format(PRODUCT_NAME))
 
 
 def test_print_out(sdk, profile, namespace, mocker, mock_logger_factory, mock_extract):

tests/cmds/test_profile.py

@@ -1,37 +1,38 @@
 import code42cli.cmds.profile as profilecmd
 import pytest
 
+from code42cli import PRODUCT_NAME
 from ..conftest import create_mock_profile
 
 
 @pytest.fixture
 def user_agreement(mocker):
-    mock = mocker.patch("code42cli.cmds.profile.does_user_agree")
+    mock = mocker.patch("{}.cmds.profile.does_user_agree".format(PRODUCT_NAME))
     mock.return_value = True
     return mocker
 
 
 @pytest.fixture
 def user_disagreement(mocker):
-    mock = mocker.patch("code42cli.cmds.profile.does_user_agree")
+    mock = mocker.patch("{}.cmds.profile.does_user_agree".format(PRODUCT_NAME))
     mock.return_value = False
     return mocker
 
 
 @pytest.fixture
 def mock_cliprofile_namespace(mocker):
-    return mocker.patch("code42cli.cmds.profile.cliprofile")
+    return mocker.patch("{}.cmds.profile.cliprofile".format(PRODUCT_NAME))
 
 
 @pytest.fixture(autouse=True)
 def mock_getpass(mocker):
-    mock = mocker.patch("code42cli.cmds.profile.getpass")
+    mock = mocker.patch("{}.cmds.profile.getpass".format(PRODUCT_NAME))
     mock.return_value = "newpassword"
 
 
 @pytest.fixture
 def mock_verify(mocker):
-    return mocker.patch("code42cli.cmds.profile.validate_connection")
+    return mocker.patch("{}.cmds.profile.validate_connection".format(PRODUCT_NAME))
 
 
 @pytest.fixture