From d80611412956282c849eaf8c2e1dff8d9e9e4f50 Mon Sep 17 00:00:00 2001
From: Nolan Brubaker <nolan.brubaker@rackspace.com>
Date: Wed, 24 May 2017 23:10:37 -0400
Subject: [PATCH] Make console logging optional

Console logging is useful when using the tool interactively, but
generats extra noise when using in a gating scenario. Move this into a
flag that enables it should it be necessary.

As part of this, the failure rate will be printed to stdout regardless
of console logging's status. This is so automated tools can use the
returned number to check for passing or failing.

Also, remove the old `configure_logging` function that was no longer in
use.

Change-Id: I55d410e6d504b03993f90cfd38dcd938390d02d5
---
 bowling_ball/rolling_tests.py | 58 ++++++++++++++++-------------------
 1 file changed, 26 insertions(+), 32 deletions(-)

diff --git a/bowling_ball/rolling_tests.py b/bowling_ball/rolling_tests.py
index f49c2645..b8d2fe50 100755
--- a/bowling_ball/rolling_tests.py
+++ b/bowling_ball/rolling_tests.py
@@ -33,30 +33,6 @@ import tempfile
 logger = logging.getLogger(__name__)
 
 
-def configure_logging(service):
-    """Configure a stream and file log for a given service
-
-    :param: service - name of service for log file.
-            generates `/var/log/{service_name}_query.log`
-    """
-    logger.setLevel(logging.INFO)
-    console = logging.StreamHandler()
-    logfile = logging.FileHandler('/var/log/keystone_query.log', 'a')
-
-    console.setLevel(logging.INFO)
-    logfile.setLevel(logging.INFO)
-
-    formatter = logging.Formatter('%(asctime)s - %(levelname)s - %(message)s')
-    # Make sure we're using UTC for everything.
-    formatter.converter = time.gmtime
-
-    console.setFormatter(formatter)
-    logfile.setFormatter(formatter)
-
-    logger.addHandler(console)
-    logger.addHandler(logfile)
-
-
 class ServiceTest(object):
     def pre_test(self, *args, **kwargs):
         """Any actions that need to be taken before starting the timer
@@ -81,7 +57,7 @@ class ServiceTest(object):
         """Any post-test clean up work that needs to be done and not timed."""
         raise NotImplementedError
 
-    def configure_logger(self, logger):
+    def configure_logger(self, logger, console_logging=False):
         """Configure a stream and file log for a given service
 
         :param: service - name of service for log file.
@@ -89,13 +65,13 @@ class ServiceTest(object):
         :param: logger - logger to be configure for the test.
                 Filename will be based on the test's `service_name`
                 property
+        :param: console_logging - flag controlling whether or not a console
+                logger is used
         """
         logger.setLevel(logging.INFO)
-        console = logging.StreamHandler()
         filename = '/var/log/{}_rolling.log'.format(self.service_name)
         logfile = logging.FileHandler(filename, 'a')
 
-        console.setLevel(logging.INFO)
         logfile.setLevel(logging.INFO)
 
         formatter = logging.Formatter(
@@ -103,12 +79,16 @@ class ServiceTest(object):
         # Make sure we're using UTC for everything.
         formatter.converter = time.gmtime
 
-        console.setFormatter(formatter)
         logfile.setFormatter(formatter)
 
-        logger.addHandler(console)
         logger.addHandler(logfile)
 
+        if console_logging:
+            console = logging.StreamHandler()
+            console.setLevel(logging.INFO)
+            console.setFormatter(formatter)
+            logger.addHandler(console)
+
     # This is useful to a lot of tests, so implement it here for re-use
     def get_session(self):
         auth_url = os.environ['OS_AUTH_URL']
@@ -201,7 +181,12 @@ class TestRunner(object):
     def write_summary(self):
         percentage = (self.failures / self.attempts) * 100
         # Display minimum of 2 digits, but don't use decimals.
-        logger.info("%2.0f%% failure rate", percentage)
+        percent_str = "%2.0f" % percentage
+
+        logger.info("%s%% failure rate", percent_str)
+
+        # Output to stdout for use by other programs
+        print(percent_str)
 
     def test_loop(self, test):
         """Main loop to execute tests
@@ -276,7 +261,8 @@ def args(arg_list):
 
     parser = argparse.ArgumentParser(
         usage='%(prog)s',
-        description='OpenStack activity simulators',
+        description=('OpenStack activity simulators. Returns percentage of '
+                     'failed attempts at creating/deleting resources.'),
     )
 
     parser.add_argument(
@@ -284,6 +270,14 @@ def args(arg_list):
         help=("Name of test to execute, 'list' for a list of available"
               " tests")
     )
+
+    parser.add_argument(
+        '-c',
+        '--console',
+        help=("Log output to the console for interactive viewing"),
+        action='store_true',
+    )
+
     return parser.parse_args(arg_list)
 
 
@@ -305,7 +299,7 @@ if __name__ == "__main__":
     target_test_class = find_test(all_args.test)
 
     target_test = target_test_class()
-    target_test.configure_logger(logger)
+    target_test.configure_logger(logger, console_logging=all_args.console)
 
     runner = TestRunner()