Default profile validation (#24)

timabrmsn · web-flow · commit 4a60406ff441 · 2020-04-14T11:59:36.000-05:00
* -Add validation logic around default profile.
-Add help message for when default is not set (or points to an invalid/missing entry).

* use \n instead of empty print() calls.

* add tests

* update tests to throw NoConfigProfileError()
diff --git a/src/code42cli/profile.py b/src/code42cli/profile.py
@@ -1,7 +1,11 @@
 import code42cli.password as password
 from code42cli.config import ConfigAccessor, config_accessor, NoConfigProfileError
-from code42cli.util import print_error, print_create_profile_help
-
+from code42cli.util import (
+    print_error,
+    print_create_profile_help,
+    print_set_default_profile_help,
+    print_no_existing_profile_message,
+)
 
 class Code42Profile(object):
     def __init__(self, profile):
@@ -47,6 +51,8 @@ def _get_profile(profile_name=None):
 
 
 def get_profile(profile_name=None):
+    if profile_name is None:
+        validate_default_profile()
     try:
         return _get_profile(profile_name)
     except NoConfigProfileError as ex:
@@ -63,6 +69,16 @@ def default_profile_exists():
         return False
 
 
+def validate_default_profile():
+    if not default_profile_exists():
+        existing_profiles = get_all_profiles()
+        if not existing_profiles:
+            print_no_existing_profile_message()
+        else:
+            print_set_default_profile_help(existing_profiles)
+        exit(1)
+
+
 def profile_exists(profile_name=None):
     try:
         _get_profile(profile_name)
diff --git a/src/code42cli/util.py b/src/code42cli/util.py
@@ -59,9 +59,20 @@ def print_no_existing_profile_message():
 
 
 def print_create_profile_help():
-    print(u"")
-    print(u"To add a profile, use: ")
-    print_bold(u"\tcode42 profile create <profile-name> <authority-URL> <username>")
+    print(u"\nTo add a profile, use: ")
+    print_bold(u"\tcode42 profile create <profile-name> <authority-URL> <username>\n")
+
+
+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:"
+    )
+    print_bold(u"\tcode42 profile use <profile-name>")
+    print(u"\nExisting profiles:")
+    for profile in existing_profiles:
+        print("\t{}".format(profile))
     print(u"")
 
 
diff --git a/tests/test_profile.py b/tests/test_profile.py
@@ -58,7 +58,6 @@ 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):
@@ -77,6 +76,26 @@ 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):
+    config_accessor.get_profile.side_effect = NoConfigProfileError()
+    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):
+    config_accessor.get_profile.side_effect = NoConfigProfileError()
+    config_accessor.get_all_profiles.return_value = []
+    with pytest.raises(SystemExit):
+        cliprofile.validate_default_profile()
+        capture = capsys.readouterr()
+        assert "No existing profile." in capture.out
+
+
 def test_profile_exists_when_exists_returns_true(config_accessor):
     mock_section = MockSection("testprofilename")
     config_accessor.get_profile.return_value = mock_section
