Merge pull request #129 from kobotoolbox/53-kobo-coding-style

KoBo coding style compliance

conftest.py

@@ -0,0 +1,34 @@
+# coding: utf-8
+import os
+import pytest
+
+# Python retro compatibility
+try:
+    FileNotFoundError
+except NameError:
+    FileNotFoundError = OSError
+
+
+def clean_up():
+    """
+    Removes files created by tests
+    """
+    files = ['.uniqid',
+             'upsert_db_users']
+    for file_ in files:
+        try:
+            os.remove(os.path.join('/tmp', file_))
+        except FileNotFoundError:
+            pass
+
+
+@pytest.fixture(scope="session", autouse=True)
+def setup(request):
+    # Clean up before tests begin in case of orphan files.
+    clean_up()
+    request.addfinalizer(_tear_down)
+
+
+def _tear_down():
+    clean_up()
+    pass

helpers/cli.py

@@ -1,9 +1,10 @@
 # -*- coding: utf-8 -*-
 from __future__ import print_function, unicode_literals
 
-import re
 import subprocess
 import sys
+import re
+import textwrap
 
 PY2 = sys.version_info[0] == 2
 if PY2:
@@ -15,76 +16,140 @@
 
 class CLI(object):
 
-    NO_COLOR = "\033[0m"
-    COLOR_ERROR = "\033[91m"
-    COLOR_SUCCESS = "\033[92m"
-    COLOR_INFO = "\033[94m"
-    COLOR_WARNING = "\033[95m"
+    NO_COLOR = '\033[0;0m'
+    COLOR_ERROR = '\033[0;31m'  # dark red
+    COLOR_SUCCESS = '\033[0;32m'  # dark green
+    COLOR_INFO = '\033[1;34m'  # blue
+    COLOR_WARNING = '\033[1;31m'  # red
+    COLOR_QUESTION = '\033[1;33m'  # dark yellow
+    COLOR_DEFAULT = '\033[1;37m'  # white
+
+    EMPTY_CHARACTER = '-'
+
+    DEFAULT_CHOICES = {
+        '1': True,
+        '2': False,
+    }
+    # We need an inverted dict version of `DEFAULT_CHOICES` to be able to
+    # retrieve keys from the values
+    DEFAULT_RESPONSES = dict(zip(DEFAULT_CHOICES.values(),
+                                 DEFAULT_CHOICES.keys()))
+
+    @classmethod
+    def colored_input(cls, message, color=NO_COLOR, default=None):
+        text = cls.get_message_with_default(message, default)
+        input_ = input(cls.colorize(text, color))
+
+        # User wants to delete value previously entered.
+        if input_ == '-':
+            default = ''
+            input_ = ''
+
+        return input_ if input_ is not None and input_ != '' else default
 
-    EMPTY_CHARACTER = "-"
+    @classmethod
+    def colored_print(cls, message, color=NO_COLOR):
+        print(cls.colorize(message, color))
+
+    @classmethod
+    def colorize(cls, message, color=NO_COLOR):
+        return '{}{}{}'.format(color, message, cls.NO_COLOR)
 
     @classmethod
-    def get_response(cls, validators=None, default="", to_lower=True,
+    def framed_print(cls, message, color=COLOR_WARNING, columns=70):
+        border = '═' * (columns - 2)
+        framed_message = [
+            '╔{}╗'.format(border),
+            '║ {} ║'.format(' ' * (columns - 4)),
+        ]
+
+        if not isinstance(message, list):
+            paragraphs = message.split('\n')
+        else:
+            paragraphs = ''.join(message).split('\n')
+
+        for paragraph in paragraphs:
+            if paragraph == '':
+                framed_message.append(
+                    '║ {} ║'.format(' ' * (columns - 4))
+                )
+                continue
+
+            for line in textwrap.wrap(paragraph, columns - 4):
+                message_length = len(line)
+                spacer = ' ' * (columns - 4 - message_length)
+                framed_message.append(
+                    '║ {}{} ║'.format(line, spacer)
+                )
+
+        framed_message.append('║ {} ║'.format(' ' * (columns - 4)))
+        framed_message.append('╚{}╝'.format(border))
+        cls.colored_print('\n'.join(framed_message), color=color)
+
+    @classmethod
+    def get_response(cls, validators=None, default='', to_lower=True,
                      error_msg="Sorry, I didn't understand that!"):
-
+
+        use_default = False
+        # If not validators are provided, let's use default validation
+        # "Yes/No", where "Yes" equals 1, and "No" equals 2
+        # Example:
+        #   Are you sure?
+        #       1) Yes
+        #       2) No
+        if validators is None:
+            use_default = True
+            default = cls.DEFAULT_RESPONSES[default]
+            validators = cls.DEFAULT_CHOICES.keys()
+
         while True:
             try:
-                response = cls.colored_input("", cls.COLOR_WARNING, default)
+                response = cls.colored_input('', cls.COLOR_QUESTION, default)
 
                 if (response.lower() in map(lambda x: x.lower(), validators) or
-                    validators is None or
-                    (isinstance(validators, string_type) and
-                     validators.startswith("~") and
-                     re.match(validators[1:], response)
-                     )):
+                        validators is None or
+                        (isinstance(validators, string_type) and
+                         validators.startswith('~') and
+                         re.match(validators[1:], response)
+                        )):
                     break
                 else:
                     cls.colored_print(error_msg,
                                       cls.COLOR_ERROR)
             except ValueError:
                 cls.colored_print("Sorry, I didn't understand that.",
                                   cls.COLOR_ERROR)
-
-        return response.lower() if to_lower else response
-
-    @classmethod
-    def colored_print(cls, message, color=NO_COLOR):
-        print(cls.colorize(message, color))
-
-    @classmethod
-    def colored_input(cls, message, color=NO_COLOR, default=None):
-        text = cls.get_message_with_default(message, default)
-        input_ = input(cls.colorize(text, color))
-
-        # User wants to delete value previously entered.
-        if input_ == "-":
-            default = ""
-            input_ = ""
 
-        return input_ if input_ is not None and input_ != "" else default
+        if use_default:
+            return cls.DEFAULT_CHOICES[response]
 
-    @classmethod
-    def colorize(cls, message, color=NO_COLOR):
-        return "{}{}{}".format(color, message, cls.NO_COLOR)
+        return response.lower() if to_lower else response
 
     @classmethod
     def get_message_with_default(cls, message, default):
-        message = "{} ".format(message) if message else ""
-        default = "{}[{}]{}: ".format(cls.COLOR_WARNING, default, cls.NO_COLOR) \
-            if default else ""
+        message = '{} '.format(message) if message else ''
+
+        if default is None:
+            default = ''
+        else:
+            default = '{white}[{off}{default}{white}]{off}: '.format(
+                white=cls.COLOR_DEFAULT,
+                off=cls.NO_COLOR,
+                default=default
+            )
 
         if message:
-            message = "{}: ".format(message.strip()) if not default else message
+            message = '{}: '.format(message.strip()) if not default else message
 
-        return "{}{}".format(message, default)
+        return '{}{}'.format(message, default)
 
     @classmethod
     def run_command(cls, command, cwd=None, polling=False):
         if polling:
             process = subprocess.Popen(command, stdout=subprocess.PIPE, cwd=cwd)
             while True:
                 output = process.stdout.readline()
-                if output == "" and process.poll() is not None:
+                if output == '' and process.poll() is not None:
                     break
                 if output:
                     if PY2:
@@ -102,6 +167,17 @@ def run_command(cls, command, cwd=None, polling=False):
                 # ^^^ this doesn't seem to be true? let's write it explicitly
                 # see https://docs.python.org/3/library/subprocess.html#subprocess.check_output
                 sys.stderr.write(cpe.output)
-                cls.colored_print("An error has occurred", CLI.COLOR_ERROR)
+                cls.colored_print('An error has occurred', CLI.COLOR_ERROR)
                 sys.exit(1)
             return stdout
+
+    @classmethod
+    def yes_no_question(cls, question, default=True,
+                        labels=['Yes', 'No']):
+        cls.colored_print(question, color=cls.COLOR_QUESTION)
+        for index, label in enumerate(labels):
+            cls.colored_print('\t{index}) {label}'.format(
+                index=index + 1,
+                label=label
+            ))
+        return cls.get_response(default=default)