Chore/profile name in profile cmds (#31)

Author: Juliya Smith

src/code42cli/args.py

@@ -75,7 +75,7 @@ def _create_auto_args_config(arg_position, key, argspec, num_args, num_kw_args):
     param_name = key.replace(u"_", u"-")
     difference = num_args - num_kw_args
     last_positional_arg_idx = difference - 1
-    # postional arguments will come first, so if the arg position
+    # positional arguments will come first, so if the arg position
     # is greater than the index of the last positional arg, it's a kwarg.
     if arg_position > last_positional_arg_idx:
         # this is a keyword arg, treat it as an optional cli arg.

src/code42cli/cmds/profile.py

@@ -3,7 +3,7 @@
 from getpass import getpass
 
 import code42cli.profile as cliprofile
-from code42cli.args import PROFILE_HELP
+from code42cli.args import PROFILE_HELP, ArgConfig
 from code42cli.commands import Command
 from code42cli.sdk_client import validate_connection
 from code42cli.util import does_user_agree, print_error, print_no_existing_profile_message
@@ -18,7 +18,7 @@ def load_subcommands():
         u"Print the details of a profile.",
         u"{} {}".format(usage_prefix, u"show <optional-args>"),
         handler=show_profile,
-        arg_customizer=_load_profile_description,
+        arg_customizer=_load_optional_profile_description,
     )
 
     list_all = Command(
@@ -40,7 +40,7 @@ def load_subcommands():
         u"Change the stored password for a profile.",
         u"{} {}".format(usage_prefix, u"reset-pw <optional-args>"),
         handler=prompt_for_password_reset,
-        arg_customizer=_load_profile_description,
+        arg_customizer=_load_optional_profile_description,
     )
 
     create = Command(
@@ -62,9 +62,9 @@ def load_subcommands():
     return [show, list_all, use, reset_pw, create, update]
 
 
-def show_profile(profile=None):
+def show_profile(name=None):
     """Prints the given profile to stdout."""
-    c42profile = cliprofile.get_profile(profile)
+    c42profile = cliprofile.get_profile(name)
     print(u"\n{0}:".format(c42profile.name))
     print(u"\t* username = {}".format(c42profile.username))
     print(u"\t* authority url = {}".format(c42profile.authority_url))
@@ -79,15 +79,15 @@ def create_profile(profile, server, username, disable_ssl_errors=False):
     _prompt_for_allow_password_set(profile)
 
 
-def update_profile(profile=None, server=None, username=None, disable_ssl_errors=None):
-    profile = cliprofile.get_profile(profile)
+def update_profile(name=None, server=None, username=None, disable_ssl_errors=None):
+    profile = cliprofile.get_profile(name)
     cliprofile.update_profile(profile.name, server, username, disable_ssl_errors)
     _prompt_for_allow_password_set(profile.name)
 
 
-def prompt_for_password_reset(profile=None):
+def prompt_for_password_reset(name=None):
     """Securely prompts for your password and then stores it using keyring."""
-    c42profile = cliprofile.get_profile(profile)
+    c42profile = cliprofile.get_profile(name)
     new_password = getpass()
     _validate_connection(c42profile.authority_url, c42profile.username, new_password)
     cliprofile.set_password(new_password, c42profile.name)
@@ -117,20 +117,20 @@ def use_profile(profile):
     cliprofile.switch_default_profile(profile)
 
 
-def _load_profile_description(argument_collection):
-    profile = argument_collection.arg_configs[u"profile"]
+def _load_optional_profile_description(argument_collection):
+    profile = argument_collection.arg_configs[u"name"]
+    profile.add_short_option_name(u"-n")
     profile.set_help(PROFILE_HELP)
 
 
 def _load_profile_create_descriptions(argument_collection):
     profile = argument_collection.arg_configs[u"profile"]
-    profile.set_help(u"The name to give the profile being created.")
+    profile.set_help(PROFILE_HELP)
     _load_profile_settings_descriptions(argument_collection)
 
 
 def _load_profile_update_descriptions(argument_collection):
-    profile = argument_collection.arg_configs[u"profile"]
-    profile.set_help(u"The name to give the profile being updated.")
+    _load_optional_profile_description(argument_collection)
     _load_profile_settings_descriptions(argument_collection)
     argument_collection.arg_configs[u"server"].add_short_option_name(u"-s")
     argument_collection.arg_configs[u"username"].add_short_option_name(u"-u")

src/code42cli/profile.py

@@ -7,6 +7,7 @@
     print_no_existing_profile_message,
 )
 
+
 class Code42Profile(object):
     def __init__(self, profile):
         self._profile = profile

src/code42cli/util.py

@@ -66,7 +66,7 @@ def print_set_default_profile_help(existing_profiles):
     print(
         u"\nNo default profile set.\n",
         u"\nUse the --profile flag to specify which profile to use.\n",
-        u"\nTo set the default profile (used whenever --profile argument is not provided), use:"
+        u"\nTo set the default profile (used whenever --profile argument is not provided), use:",
     )
     print_bold(u"\tcode42 profile use <profile-name>")
     print(u"\nExisting profiles:")

tests/cmds/test_profile.py

@@ -122,7 +122,7 @@ def test_update_profile_updates_existing_profile(
     profile.name = name
     mock_cliprofile_namespace.get_profile.return_value = profile
 
-    profilecmd.update_profile(name, "bar", "baz", True)
+    profilecmd.update_profile(name=name, server="bar", username="baz", disable_ssl_errors=True)
     mock_cliprofile_namespace.update_profile.assert_called_once_with(name, "bar", "baz", True)
 
 

tests/test_profile.py

@@ -58,6 +58,7 @@ def test_get_profile_returns_expected_profile(config_accessor):
     profile = cliprofile.get_profile("testprofilename")
     assert profile.name == "testprofilename"
 
+
 def test_get_profile_when_config_accessor_throws_exits(config_accessor):
     config_accessor.get_profile.side_effect = NoConfigProfileError()
     with pytest.raises(SystemExit):
@@ -76,18 +77,20 @@ def test_default_profile_exists_when_not_exists_returns_false(config_accessor):
     assert not cliprofile.default_profile_exists()
 
 
-def test_validate_default_profile_prints_set_default_help_when_no_valid_default_but_another_profile_exists(capsys, config_accessor):
+def test_validate_default_profile_prints_set_default_help_when_no_valid_default_but_another_profile_exists(
+    capsys, config_accessor
+):
     config_accessor.get_profile.side_effect = NoConfigProfileError()
-    config_accessor.get_all_profiles.return_value = [
-        MockSection("thisprofilexists")
-    ]
+    config_accessor.get_all_profiles.return_value = [MockSection("thisprofilexists")]
     with pytest.raises(SystemExit):
         cliprofile.validate_default_profile()
         capture = capsys.readouterr()
         assert "No default profile set." in capture.out
 
 
-def test_validate_default_profile_prints_create_profile_help_when_no_valid_default_and_no_other_profiles_exists(capsys, config_accessor):
+def test_validate_default_profile_prints_create_profile_help_when_no_valid_default_and_no_other_profiles_exists(
+    capsys, config_accessor
+):
     config_accessor.get_profile.side_effect = NoConfigProfileError()
     config_accessor.get_all_profiles.return_value = []
     with pytest.raises(SystemExit):