Feature/select profile (#262)

* Add select command

* add cl

* Rm fstr

* PR Feedback

* CL for profile use change

* Add missing test and cl entry

* A and The

* fstr

* refactor

* rm conflict markers

* add tests for prompt choice class

* test prompt text

* rm accidental part of cl

* Add word was

* cond

* Doc

* spell out var

* add eg

* rename method

* use helper method

* doc

* rm unused fixtures

* rm var from str intp in test

* rm extra space

* conform modular naming

* fix tests

* doc

* undo unreleated changes

* Undo unreleated changes pt2

* hmmm.....

* add missing echo

* undo and actually add missing echo

* correct changelog

* clarify

Co-authored-by: tim.abramson <tim.abramson@code42.com>

Author: Juliya Smith

CHANGELOG.md

@@ -14,12 +14,14 @@ 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:
+- New commands for deactivating/reactivating Code42 user accounts:
   - `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.
+
 ## 1.9.0 - 2021-08-19
 
 ### Added

src/code42cli/click_ext/types.py

@@ -8,6 +8,7 @@
 from click.exceptions import BadParameter
 
 from code42cli.logger import CliLogger
+from code42cli.util import print_numbered_list
 
 
 class AutoDecodedFile(click.File):
@@ -151,6 +152,21 @@ def convert(self, value, param, ctx):
         return super().convert(value, param, ctx)
 
 
+class PromptChoice(click.ParamType):
+    def __init__(self, choices):
+        self.choices = choices
+
+    def print_choices(self):
+        print_numbered_list(self.choices)
+
+    def convert(self, value, param, ctx):
+        try:
+            choice_index = int(value) - 1
+            return self.choices[choice_index]
+        except Exception:
+            self.fail("Invalid choice", param=param)
+
+
 class TOTP(click.ParamType):
     """Validates param to be a 6-digit integer, which is what all Code42 TOTP tokens will be."""
 

src/code42cli/cmds/auditlogs.py

@@ -49,7 +49,6 @@ def _get_audit_logs_default_header():
     help="Filter results by actor user IDs.",
     multiple=True,
 )
-
 filter_option_user_ip_addresses = click.option(
     "--actor-ip",
     required=False,

src/code42cli/cmds/profile.py

@@ -5,6 +5,7 @@
 from click import secho
 
 import code42cli.profile as cliprofile
+from code42cli.click_ext.types import PromptChoice
 from code42cli.click_ext.types import TOTP
 from code42cli.errors import Code42CLIError
 from code42cli.options import yes_option
@@ -158,9 +159,15 @@ def _list():
 @profile.command()
 @profile_name_arg()
 def use(profile_name):
-    """Set a profile as the default."""
-    cliprofile.switch_default_profile(profile_name)
-    echo(f"{profile_name} has been set as the default profile.")
+    """\b
+    Set a profile as the default. If not providing a profile-name,
+    prompts for a choice from a list of all profiles."""
+
+    if not profile_name:
+        _select_profile_from_prompt()
+        return
+
+    _set_default_profile(profile_name)
 
 
 @profile.command()
@@ -219,3 +226,23 @@ def _set_pw(profile_name, password, debug, totp=None):
         raise
     cliprofile.set_password(password, c42profile.name)
     return c42profile.name
+
+
+def _select_profile_from_prompt():
+    """Set the default profile from user input."""
+    profiles = cliprofile.get_all_profiles()
+    profile_names = [profile_choice.name for profile_choice in profiles]
+    choices = PromptChoice(profile_names)
+    choices.print_choices()
+    prompt_message = "Input the number of the profile you wish to use"
+    profile_name = click.prompt(prompt_message, type=choices)
+    _set_default_profile(profile_name)
+
+
+def _set_default_profile(profile_name):
+    cliprofile.switch_default_profile(profile_name)
+    _print_default_profile_was_set(profile_name)
+
+
+def _print_default_profile_was_set(profile_name):
+    echo(f"{profile_name} has been set as the default profile.")

src/code42cli/util.py

@@ -38,6 +38,7 @@ def get_user_project_path(*subdirs):
     result_path = path.join(user_project_path, *subdirs)
     if not path.exists(result_path):
         os.makedirs(result_path)
+
     return result_path
 
 
@@ -156,6 +157,7 @@ def get_url_parts(url_str):
     port = None
     if len(parts) > 1 and parts[1] != "":
         port = int(parts[1])
+
     return parts[0], port
 
 
@@ -170,6 +172,7 @@ def _get_default_header(header_items):
         for key in keys:
             if key not in header and isinstance(key, str):
                 header[key] = key
+
     return header
 
 
@@ -179,6 +182,17 @@ def hash_event(event):
     return md5(event.encode()).hexdigest()
 
 
+def print_numbered_list(items):
+    """Outputs a numbered list of items to the user.
+    For example, provide ["test", "foo"] to print "1. test\n2. foo".
+    """
+
+    choices = dict(enumerate(items, 1))
+    for num in choices:
+        echo(f"{num}. {choices[num]}")
+    echo()
+
+
 def parse_timestamp(date_str):
     # example: {"property": "bar", "timestamp": "2020-11-23T17:13:26.239647Z"}
     ts = date_str[:-1]

tests/click_ext/__init__.py

@@ -0,0 +1,10 @@
+from code42cli.click_ext.types import PromptChoice
+
+
+class TestPromptChoice:
+    def test_convert_returns_expected_item(self):
+        choices = ["foo", "bar", "test"]
+        prompt_choice = PromptChoice(choices)
+        assert prompt_choice.convert("1", None, None) == "foo"
+        assert prompt_choice.convert("2", None, None) == "bar"
+        assert prompt_choice.convert("3", None, None) == "test"

tests/click_ext/test_types.py

@@ -66,7 +66,8 @@ def audit_log_cursor_with_checkpoint(mocker):
     mock_cursor = mocker.MagicMock(spec=AuditLogCursorStore)
     mock_cursor.get.return_value = CURSOR_TIMESTAMP
     mocker.patch(
-        "code42cli.cmds.auditlogs._get_audit_log_cursor_store", return_value=mock_cursor
+        "code42cli.cmds.auditlogs._get_audit_log_cursor_store",
+        return_value=mock_cursor,
     )
     return mock_cursor
 
@@ -79,7 +80,8 @@ def audit_log_cursor_with_checkpoint_and_events(mocker):
         hash_event(TEST_EVENTS_WITH_SAME_TIMESTAMP[0])
     ]
     mocker.patch(
-        "code42cli.cmds.auditlogs._get_audit_log_cursor_store", return_value=mock_cursor
+        "code42cli.cmds.auditlogs._get_audit_log_cursor_store",
+        return_value=mock_cursor,
     )
     return mock_cursor
 

tests/cmds/test_auditlogs.py

@@ -7,6 +7,9 @@
 from code42cli.main import cli
 
 
+_SELECTED_PROFILE_NAME = "test_profile"
+
+
 @pytest.fixture
 def user_agreement(mocker):
     mock = mocker.patch("code42cli.cmds.profile.does_user_agree")
@@ -50,6 +53,13 @@ def invalid_connection(mock_verify):
     return mock_verify
 
 
+@pytest.fixture
+def profile_name_selector(mocker):
+    mock = mocker.patch("code42cli.cmds.profile.click.prompt")
+    mock.return_value = _SELECTED_PROFILE_NAME
+    return mock
+
+
 def test_show_profile_outputs_profile_info(runner, mock_cliprofile_namespace, profile):
     profile.name = "testname"
     profile.authority_url = "example.com"
@@ -511,6 +521,29 @@ def test_use_profile(runner, mock_cliprofile_namespace, profile):
     assert f"{profile.name} has been set as the default profile." in result.output
 
 
+def test_use_profile_when_not_given_profile_name_arg_sets_selected_profile_as_default(
+    runner, mock_cliprofile_namespace, profile_name_selector
+):
+    runner.invoke(cli, ["profile", "use"])
+    mock_cliprofile_namespace.switch_default_profile.assert_called_once_with(
+        _SELECTED_PROFILE_NAME
+    )
+
+
+def test_use_profile_when_not_given_profile_name_outputs_expected_text(
+    runner, mock_cliprofile_namespace, profile_name_selector
+):
+    mock_cliprofile_namespace.get_all_profiles.return_value = [
+        create_mock_profile("test1"),
+        create_mock_profile("test2"),
+    ]
+    result = runner.invoke(cli, ["profile", "use"])
+    expected_prompt = "1. test1\n2. test2"
+    expected_result_message = "test_profile has been set as the default profile."
+    assert expected_prompt in result.output
+    assert expected_result_message in result.output
+
+
 def test_totp_option_passes_token_to_sdk_on_profile_cmds_that_init_sdk(
     runner, mocker, mock_cliprofile_namespace, cli_state
 ):

tests/cmds/test_profile.py

@@ -61,7 +61,7 @@ def test_does_user_agree_when_user_says_n_returns_false(
 
 
 def test_does_user_agree_when_assume_yes_argument_passed_returns_true_and_does_not_print_prompt(
-    mocker, context_with_assume_yes, capsys
+    context_with_assume_yes, capsys
 ):
     result = does_user_agree("Test Prompt")
     output = capsys.readouterr()