Add cmd to reset API tokens in jenkins_jobs.ini

Convenience command to automatically reset API tokens in
jenkins-jobs.ini.

Change-Id: I6d84760368b6a12e9e9622b5ce9496a278321dc4
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>

diff --git a/lftools/cli/jenkins/token.py b/lftools/cli/jenkins/token.py
index c1c4ba1..9dbdbea 100644 (file)
--- a/lftools/cli/jenkins/token.py
+++ b/lftools/cli/jenkins/token.py
@@ -12,9 +12,13 @@
 __author__ = 'Thanh Ha'
 
 import logging
+import sys
 
 import click
+import requests
+from six.moves import configparser
 
+from lftools.jenkins import JJB_INI
 from lftools.jenkins.token import get_token
 
 log = logging.getLogger(__name__)
@@ -40,5 +44,73 @@ def print_token(ctx):
     log.info(get_token(ctx.obj['jenkins_url']))
 
 
+@click.command()
+@click.argument('servers', nargs=-1, required=False)
+@click.pass_context
+def reset(ctx, servers):
+    """Regenerate API tokens for configurations in jenkins_jobs.ini.
+
+    This command has 2 modes to reset API tokens:
+
+    1. Single-server: Resets the API token and returns the new token value.
+    2. Multi-server: Resets the API token for a provided list of servers and
+       returns a summary of the outcome.
+
+    If the server parameter is NOT passed then all servers listed in the
+    configuration file will be reset via multi-server mode.
+    """
+    _require_jjb_ini()
+
+    def _reset_key(config, server):
+        url = config.get(server, 'url')
+
+        try:
+            token = get_token(url, True)
+            config.set(server, 'password', token)
+            with open(JJB_INI, 'w') as configfile:
+                config.write(configfile)
+            return token
+        except requests.exceptions.ConnectionError as e:
+            return None
+
+    fail = 0
+    success = 0
+    config = configparser.ConfigParser()
+    config.read(JJB_INI)
+
+    if len(servers) == 0:
+        cfg_sections = config.sections()
+    elif len(servers) == 1:
+        key = _reset_key(config, servers[0])
+        log.info(key)
+        return
+    else:
+        cfg_sections = list(servers)
+
+    for section in cfg_sections:
+        if not config.has_option(section, 'url'):
+            log.debug('Section does not contain a url, skipping...')
+            continue
+
+        log.info('Resetting API key for {}'.format(section))
+        if _reset_key(config, section):
+            success += 1
+        else:
+            fail += 1
+            log.error('Failed to reset API key for {}'.format(section))
+
+    log.info('Update configurations complete.')
+    log.info('Success: {}'.format(success))
+    log.info('Failed: {}'.format(fail))
+
+
 token.add_command(change)
 token.add_command(print_token)
+token.add_command(reset)
+
+
+def _require_jjb_ini():
+    if not JJB_INI:
+        log.error('jenkins_jobs.ini not found in any of the search paths. '
+                  'Please provide one before proceeding.')
+        sys.exit(1)

diff --git a/releasenotes/notes/jenkins-token-reset-1297047cb9b5804d.yaml b/releasenotes/notes/jenkins-token-reset-1297047cb9b5804d.yaml
new file mode 100644 (file)
index 0000000..321e596
--- /dev/null
+++ b/releasenotes/notes/jenkins-token-reset-1297047cb9b5804d.yaml
@@ -0,0 +1,7 @@
+---
+features:
+  - |
+    Add jenkins token reset command to automatically reset API tokens for all
+    Jenkins systems configured in jenkins_jobs.ini.
+
+    Usage: lftools jenkins token reset [OPTIONS] [SERVER]