base: Cleanups and tweaks with use_api_key

crobinso · crobinso · commit cd955c658b7b · 2019-11-22T19:37:07.000-05:00
* Break out save_api_key from the class object
* Add explicit use_creds tracking
* Tweak the output strings we print
* Minor other improvements

Signed-off-by: Cole Robinson &lt;crobinso@redhat.com&gt;
diff --git a/bugzilla/_cli.py b/bugzilla/_cli.py
@@ -1080,13 +1080,11 @@ def _handle_login(opt, action, bz):
     use_key = getattr(opt, "api_key", False)
 
     try:
-        if is_login_command and use_key:
-            bz.interactive_login(use_api_key=True,
-                    restrict_login=opt.restrict_login)
-        elif do_interactive_login:
-            if bz.url:
+        if do_interactive_login or use_key:
+            if bz.url and not use_key:
                 print("Logging into %s" % urlparse(bz.url)[1])
             bz.interactive_login(username, password,
+                    use_api_key=use_key,
                     restrict_login=opt.restrict_login)
     except bugzilla.BugzillaError as e:
         print(str(e))
@@ -1099,7 +1097,7 @@ def _handle_login(opt, action, bz):
 
     if is_login_command:
         msg = "Login successful."
-        if bz.cookiefile or bz.tokenfile:
+        if (bz.cookiefile or bz.tokenfile) and not use_key:
             msg = "Login successful, token cache updated."
 
         print(msg)
diff --git a/bugzilla/base.py b/bugzilla/base.py
@@ -129,6 +129,32 @@ def _open_bugzillarc(configpaths=-1):
     return cfg
 
 
+def _save_api_key(url, api_key):
+    """
+    Save the API_KEY in the config file.
+
+    If tokenfile and cookiefile are undefined, it means that the
+    API was called with --no-cache-credentials and no change will be
+    made
+    """
+    config_filename = _default_config_location('bugzillarc')
+    section = _parse_hostname(url)
+
+    cfg = ConfigParser()
+    cfg.read(config_filename)
+
+    if section not in cfg.sections():
+        cfg.add_section(section)
+
+    cfg[section]['api_key'] = api_key.strip()
+
+    with open(config_filename, 'w') as configfile:
+        cfg.write(configfile)
+
+    log.info("API key written to %s", config_filename)
+    print("API key written to %s" % config_filename)
+
+
 class _FieldAlias(object):
     """
     Track API attribute names that differ from what we expose in users.
@@ -311,7 +337,8 @@ def __init__(self, url=-1, user=None, password=None, cookiefile=-1,
         self._field_aliases = []
         self._init_field_aliases()
 
-        if not use_creds:
+        self._use_creds = use_creds
+        if not self._use_creds:
             cookiefile = None
             tokenfile = None
             configpaths = []
@@ -646,34 +673,6 @@ def login(self, user=None, password=None, restrict_login=None):
         except Fault as e:
             raise BugzillaError("Login failed: %s" % str(e.faultString))
 
-    def _save_api_key(self):
-        """
-        Save the API_KEY in the config file.
-
-        If toklenfile and cookiefile are undefined, it meas that the
-        API was called with --no-cache-credentials and no change will be
-        made
-        """
-        if self.tokenfile is None and self.cookiefile is None:
-            log.info("API Key won't be updated")
-            return
-
-        config_filename = _default_config_location('bugzillarc')
-        section = _parse_hostname(self.url)
-
-        cfg = ConfigParser()
-        cfg.read(config_filename)
-
-        if section not in cfg.sections():
-            cfg.add_section(section)
-
-        cfg[section]['api_key'] = self.api_key.strip()
-
-        with open(config_filename, 'w') as configfile:
-            cfg.write(configfile)
-
-        log.info("API Key updated in %s", config_filename)
-
     def interactive_login(self, user=None, password=None, force=False,
                           restrict_login=None, use_api_key=False):
         """
@@ -683,7 +682,7 @@ def interactive_login(self, user=None, password=None, force=False,
         :param password: bugzilla password. If not specified, prompt for it.
         :param force: Unused
         :param restrict_login: restricts session to IP address
-        :param use_api_key: True if the login should be done using an api_key
+        :param use_api_key: If True, prompt for an api_key instead
         """
         ignore = force
         log.debug('Calling interactive_login')
@@ -701,9 +700,12 @@ def interactive_login(self, user=None, password=None, force=False,
 
             if not self.logged_in:
                 raise BugzillaError("Login with API_KEY failed")
-            log.info('API Key acepted')
+            log.info('API Key accepted')
 
-            self._save_api_key()
+            if self._use_creds:
+                _save_api_key(self.url, self.api_key)
+            else:
+                log.info("API Key won't be updated because use_creds=False")
             return
 
         if not user:
