From 2c9f5e3980c8d9281f6e2a2c35423e41c7b3c2b5 Mon Sep 17 00:00:00 2001
From: Sumanth V Rao <sumanthvrao@gmail.com>
Date: Sat, 6 Jul 2019 09:33:08 +0530
Subject: [PATCH] tools: Add tool to update API field of local zuliprc file.

This tool can be used to update the API field of local
zuliprc files for dummy users of development server
(iago, prospero, etc) with the correct API key from database.

This tool can be run after provisioning (or similar tools) which change
the API keys in the database.
---
 scripts/lib/zulip_tools.py     |  3 ++
 tools/update-zuliprc-api-field | 75 ++++++++++++++++++++++++++++++++++
 2 files changed, 78 insertions(+)
 create mode 100755 tools/update-zuliprc-api-field

diff --git a/scripts/lib/zulip_tools.py b/scripts/lib/zulip_tools.py
index 18f59cbc16..2adb29239a 100755
--- a/scripts/lib/zulip_tools.py
+++ b/scripts/lib/zulip_tools.py
@@ -473,6 +473,9 @@ def get_or_create_dev_uuid_var_path(path: str) -> str:
     os.makedirs(absolute_path, exist_ok=True)
     return absolute_path
 
+def is_vagrant_env_host(path: str) -> bool:
+    return '.vagrant' in os.listdir(path)
+
 if __name__ == '__main__':
     cmd = sys.argv[1]
     if cmd == 'make_deploy_path':
diff --git a/tools/update-zuliprc-api-field b/tools/update-zuliprc-api-field
new file mode 100755
index 0000000000..6f7349725d
--- /dev/null
+++ b/tools/update-zuliprc-api-field
@@ -0,0 +1,75 @@
+#!/usr/bin/env python3
+
+"""
+This tool is for updating API key field `zuliprc` files of dummy users
+in development environment, with the correct keys from the database.
+Ensure running this outside of vagrant environment.
+Usage:
+./tools/update-zuliprc-api-field /path/to/zuliprc_dev
+"""
+
+import argparse
+import configparser
+import os
+import subprocess
+import sys
+
+ZULIP_PATH = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+sys.path.insert(0, ZULIP_PATH)
+from scripts.lib.zulip_tools import is_vagrant_env_host
+
+parser = argparse.ArgumentParser(description=__doc__)
+parser.add_argument('path', metavar='FILE', type=str, nargs='+',
+                    help='config file of dummy users in development server')
+args = parser.parse_args()
+
+zuliprc_paths_list = args.path
+for zuliprc_path in zuliprc_paths_list:
+    zuliprc = configparser.ConfigParser()
+    result = ''
+    try:
+        with open(zuliprc_path, 'r') as f:
+            zuliprc.read_file(f, zuliprc_path)
+        api_details = zuliprc['api']
+        email = api_details['email']
+        key = api_details['key']
+        site = api_details['site']
+        if 'localhost' not in site:
+            result = 'ABORTED'
+            reason = 'Script to be used for development server config files only'
+    except (KeyError, configparser.MissingSectionHeaderError):
+        result = 'FAILURE'
+        reason = 'Could not parse file due to missing required fields/sections'
+    except FileNotFoundError:
+        result = 'ABORTED'
+        reason = 'No zuliprc file found at specified path'
+
+    if result not in ('ABORTED', 'FAILURE'):
+        # Make sure the cwd is the root of Zulip checkout.
+        os.chdir(ZULIP_PATH)
+
+        if is_vagrant_env_host(ZULIP_PATH):
+            arguments = ['vagrant', 'ssh', '--command',
+                         './manage.py print_initial_password ' + email]
+        else:
+            # Support users who don't have vagrant based setup
+            arguments = ['./manage.py', 'print_initial_password', email]
+        # We redirect 'stderr' to 'stdout' to avoid 'Connection to 127.0.0.1 closed'
+        # appearing after this script finishes.
+        output = subprocess.check_output(arguments, stderr=subprocess.STDOUT).decode('UTF-8')
+        new_key = output.split()[6]
+
+        if new_key != key:
+            try:
+                zuliprc.set('api', 'key', new_key)
+                with open(zuliprc_path, 'w+') as w:
+                    zuliprc.write(w)
+                result = 'SUCCESS'
+                reason = 'API field updated for user %s' % (email,)
+            except (IOError, OSError):
+                result = 'FAILURE'
+                reason = 'Writing to file unsuccessful'
+        else:
+            result = 'SUCCESS'
+            reason = 'API key for user %s is already consistent' % (email,)
+    print('{}: {}: {}'.format(zuliprc_path, result, reason))