add --password option to profile create and profile update commands (#113)

* add --password option to `profile create` and `profile update` commands

* remove unused `_reset_pw()`

* remove unused `_reset_pw()`

* clarify reset-pw help

* fix bad merge and test

Author: timabrmsn

src/code42cli/cmds/profile.py

@@ -22,14 +22,18 @@ def profile():
     "-n",
     "--name",
     required=True,
-    type=str,
     help="The name of the Code42 CLI profile to use when executing this command.",
 )
 server_option = click.option(
-    "-s", "--server", required=True, type=str, help="The url and port of the Code42 server."
+    "-s", "--server", required=True, help="The url and port of the Code42 server."
 )
 username_option = click.option(
-    "-u", "--username", required=True, type=str, help="The username of the Code42 API user."
+    "-u", "--username", required=True, help="The username of the Code42 API user."
+)
+password_option = click.option(
+    "--password",
+    help="The password for the Code42 API user. If this option is omitted, interactive prompts "
+    "will be used to obtain the password.",
 )
 disable_ssl_option = click.option(
     "--disable-ssl-errors",
@@ -58,32 +62,44 @@ def show(profile_name):
 @name_option
 @server_option
 @username_option
+@password_option
 @disable_ssl_option
-def create(name, server, username, disable_ssl_errors=False):
+def create(name, server, username, password, disable_ssl_errors):
     """Create profile settings. The first profile created will be the default."""
     cliprofile.create_profile(name, server, username, disable_ssl_errors)
-    _prompt_for_allow_password_set(name)
+    if password:
+        _set_pw(name, password)
+    else:
+        _prompt_for_allow_password_set(name)
     echo("Successfully created profile '{}'.".format(name))
 
 
 @profile.command()
 @name_option
 @server_option
 @username_option
+@password_option
 @disable_ssl_option
-def update(name=None, server=None, username=None, disable_ssl_errors=None):
+def update(name, server, username, password, disable_ssl_errors):
     """Update an existing profile."""
     c42profile = cliprofile.get_profile(name)
     cliprofile.update_profile(c42profile.name, server, username, disable_ssl_errors)
-    _prompt_for_allow_password_set(c42profile.name)
+    if password:
+        _set_pw(name, password)
+    else:
+        _prompt_for_allow_password_set(c42profile.name)
     echo("Profile '{}' has been updated.".format(c42profile.name))
 
 
 @profile.command()
 @profile_name_arg
-def reset_pw(profile_name=None):
-    """Change the stored password for a profile."""
-    _reset_pw(profile_name)
+def reset_pw(profile_name):
+    """\b
+    Change the stored password for a profile. Only affects what's stored in the local profile, 
+    does not make any changes to the Code42 user account."""
+    password = getpass()
+    _set_pw(profile_name, password)
+    echo("Password updated for profile '{}'".format(profile_name))
 
 
 @profile.command("list")
@@ -101,6 +117,7 @@ def _list():
 def use(profile_name):
     """Set a profile as the default."""
     cliprofile.switch_default_profile(profile_name)
+    echo("{} has been set as the default profile.".format(profile_name))
 
 
 @profile.command()
@@ -136,15 +153,15 @@ def delete_all():
 
 def _prompt_for_allow_password_set(profile_name):
     if does_user_agree("Would you like to set a password? (y/n): "):
-        _reset_pw(profile_name)
+        password = getpass()
+        _set_pw(profile_name, password)
 
 
-def _reset_pw(profile_name):
+def _set_pw(profile_name, password):
     c42profile = cliprofile.get_profile(profile_name)
-    new_password = getpass()
     try:
-        validate_connection(c42profile.authority_url, c42profile.username, new_password)
+        validate_connection(c42profile.authority_url, c42profile.username, password)
     except Exception:
         secho("Password not stored!", bold=True)
         raise
-    cliprofile.set_password(new_password, c42profile.name)
+    cliprofile.set_password(password, c42profile.name)

src/code42cli/config.py

@@ -83,7 +83,6 @@ def switch_default_profile(self, new_default_name):
             raise NoConfigProfileError(new_default_name)
         self._internal[self.DEFAULT_PROFILE] = new_default_name
         self._save()
-        echo("{} has been set as the default profile.".format(new_default_name))
 
     def delete_profile(self, name):
         """Deletes a profile."""
@@ -149,7 +148,6 @@ def _try_complete_setup(self, profile):
             return
 
         self._save()
-        echo("Successfully saved profile '{}'.".format(profile.name))
 
         default_profile = self._internal.get(self.DEFAULT_PROFILE)
         if default_profile is None or default_profile == self.DEFAULT_VALUE:

tests/cmds/test_profile.py

@@ -103,24 +103,45 @@ def test_create_profile_if_user_does_not_agree_does_not_save_password(
 def test_create_profile_if_credentials_invalid_password_not_saved(
     runner, user_agreement, invalid_connection, mock_cliprofile_namespace
 ):
+    mock_cliprofile_namespace.profile_exists.return_value = False
+    result = runner.invoke(cli, ["profile", "create", "-n", "foo", "-s", "bar", "-u", "baz"],)
+    assert "Password not stored!" in result.output
+    assert not mock_cliprofile_namespace.set_password.call_count
+
+
+def test_create_profile_with_password_option_if_credentials_invalid_password_not_saved(
+    runner, invalid_connection, mock_cliprofile_namespace
+):
+    password = "test_pass"
     mock_cliprofile_namespace.profile_exists.return_value = False
     result = runner.invoke(
-        cli, ["profile", "create", "-n", "foo", "-s", "bar", "-u", "baz", "--disable-ssl-errors"],
+        cli, ["profile", "create", "-n", "foo", "-s", "bar", "-u", "baz", "--password", password],
     )
     assert "Password not stored!" in result.output
     assert not mock_cliprofile_namespace.set_password.call_count
+    assert "Would you like to set a password?" not in result.output
 
 
 def test_create_profile_if_credentials_valid_password_saved(
     runner, mocker, user_agreement, valid_connection, mock_cliprofile_namespace
 ):
     mock_cliprofile_namespace.profile_exists.return_value = False
-    runner.invoke(
-        cli, ["profile", "create", "-n", "foo", "-s", "bar", "-u", "baz", "--disable-ssl-errors"]
-    )
+    runner.invoke(cli, ["profile", "create", "-n", "foo", "-s", "bar", "-u", "baz"])
     mock_cliprofile_namespace.set_password.assert_called_once_with("newpassword", mocker.ANY)
 
 
+def test_create_profile_with_password_option_if_credentials_valid_password_saved(
+    runner, mocker, valid_connection, mock_cliprofile_namespace
+):
+    password = "test_pass"
+    mock_cliprofile_namespace.profile_exists.return_value = False
+    result = runner.invoke(
+        cli, ["profile", "create", "-n", "foo", "-s", "bar", "-u", "baz", "--password", password],
+    )
+    mock_cliprofile_namespace.set_password.assert_called_once_with(password, mocker.ANY)
+    assert "Would you like to set a password?" not in result.output
+
+
 def test_create_profile_outputs_confirmation(
     runner, user_agreement, valid_connection, mock_cliprofile_namespace
 ):
@@ -280,5 +301,6 @@ def test_list_profiles_when_no_profiles_outputs_no_profiles_message(
 
 
 def test_use_profile(runner, mock_cliprofile_namespace, profile):
-    runner.invoke(cli, ["profile", "use", profile.name])
+    result = runner.invoke(cli, ["profile", "use", profile.name])
     mock_cliprofile_namespace.switch_default_profile.assert_called_once_with(profile.name)
+    assert "{} has been set as the default profile.".format(profile.name) in result.output

tests/test_config.py

@@ -1,10 +1,7 @@
-from __future__ import with_statement
+from configparser import ConfigParser
 
 import pytest
-from configparser import ConfigParser
-import logging
 
-from code42cli import PRODUCT_NAME
 from code42cli.config import ConfigAccessor, NoConfigProfileError
 from .conftest import MockSection
 
@@ -143,14 +140,6 @@ def test_switch_default_profile_saves(self, config_parser_for_multiple_profiles,
         accessor.switch_default_profile(_TEST_SECOND_PROFILE_NAME)
         assert mock_saver.call_count
 
-    def test_switch_default_profile_outputs_confirmation(
-        self, capsys, config_parser_for_multiple_profiles, mock_saver
-    ):
-        accessor = ConfigAccessor(config_parser_for_multiple_profiles)
-        accessor.switch_default_profile(_TEST_SECOND_PROFILE_NAME)
-        output = capsys.readouterr()
-        assert "set as the default profile" in output.out
-
     def test_create_profile_when_given_default_name_does_not_create(self, config_parser_for_create):
         accessor = ConfigAccessor(config_parser_for_create)
         with pytest.raises(Exception):
@@ -189,16 +178,6 @@ def test_create_profile_when_not_existing_saves(self, config_parser_for_create,
         accessor.create_profile(_TEST_PROFILE_NAME, "example.com", "bar", False)
         assert mock_saver.call_count
 
-    def test_create_profile_when_not_existing_outputs_confirmation(
-        self, capsys, config_parser_for_create, mock_saver
-    ):
-        mock_internal = create_internal_object(False)
-        setup_parser_one_profile(mock_internal, mock_internal, config_parser_for_create)
-        accessor = ConfigAccessor(config_parser_for_create)
-        accessor.create_profile(_TEST_PROFILE_NAME, "example.com", "bar", False)
-        output = capsys.readouterr()
-        assert "Successfully saved" in output.out
-
     def test_update_profile_when_no_profile_exists_raises_exception(
         self, config_parser_for_multiple_profiles
     ):