update python script to manage Rally bench tests, add help section, exclude Tempest from all bench tests

JIRA: FUNCTEST-1

Change-Id: I479c3216706635738321fc96f6e02f84bbd707a4
Signed-off-by: morganrOL <morgan.richomme@orange.com>

1 files changed, 97 insertions, 53 deletions

diff --git a/testcases/VIM/OpenStack/CI/libraries/run_rally.py b/testcases/VIM/OpenStack/CI/libraries/run_rally.py
index da5e6adc..898fca6b 100644
--- a/testcases/VIM/OpenStack/CI/libraries/run_rally.py
+++ b/testcases/VIM/OpenStack/CI/libraries/run_rally.py
@@ -8,8 +8,35 @@
 # which accompanies this distribution, and is available at
 # http://www.apache.org/licenses/LICENSE-2.0
 #
-import re, json, os, sys, urllib2
- 
+import re, json, os, urllib2, argparse, logging
+
+""" tests configuration """
+tests = ['authenticate', 'glance', 'heat', 'keystone', 'neutron', 'nova', 'tempest', 'vm', 'all']
+parser = argparse.ArgumentParser()
+parser.add_argument("test_name", help="The name of the test you want to perform with rally. "
+                                      "Possible values are : "
+                                      "[ {d[0]} | {d[1]} | {d[2]} | {d[3]} | {d[4]} | {d[5]} | {d[6]} "
+                                      "| {d[7]} | {d[8]} ]. The 'all' value performs all the tests scenarios "
+                                      "except 'tempest'".format(d=tests))
+
+parser.add_argument("-d", "--debug", help="Debug mode",  action="store_true")
+args = parser.parse_args()
+
+""" logging configuration """
+logger = logging.getLogger('run_rally')
+logger.setLevel(logging.DEBUG)
+
+ch = logging.StreamHandler()
+if args.debug:
+    ch.setLevel(logging.DEBUG)
+else:
+    ch.setLevel(logging.INFO)
+
+formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
+ch.setFormatter(formatter)
+logger.addHandler(ch)
+
+
 def get_task_id(cmd_raw):
     """
     get task id from command rally result
@@ -23,7 +50,8 @@ def get_task_id(cmd_raw):
         if match:
             return match.group(1)
     return None
- 
+
+
 def task_succeed(json_raw):
     """
     Parse JSON from rally JSON results
@@ -43,94 +71,110 @@ def task_succeed(json_raw):
  
     return True
  
+ 
 def run_task(test_name):
     """
     the "main" function of the script who lunch rally for a task
     :param test_name: name for the rally test
     :return: void
     """
+    logger.info('starting {} test ...'.format(test_name))
  
     """ get the date """
     cmd = os.popen("date '+%d%m%Y_%H%M'")
     test_date = cmd.read().rstrip()
  
-    """ check directory for test scenarios files or retrieve from git otherwise"""
+    """ check directory for scenarios test files or retrieve from git otherwise"""
+    proceed_test = True
     tests_path = "./scenarios"
     test_file_name = '{}/opnfv-{}.json'.format(tests_path, test_name)
     if not os.path.exists(test_file_name):
-        retrieve_test_cases_file(test_name, tests_path)
-	print "Scenario successfully downloaded"
- 
-    print "Start test..."
-    cmd = os.popen("rally task start --abort-on-sla-failure %s" % test_file_name)
-    task_id = get_task_id(cmd.read())
- 
-    if task_id is None:
-        print "./run_rally : failed to retrieve task_id"
-        exit(-1)
- 
-    """ check for result directory and create it otherwise """
-    report_path = "./results"
-    if not os.path.exists(report_path):
-        os.makedirs(report_path)
- 
-    report_file_name = '{}/opnfv-{}-{}.html'.format(report_path, test_name, test_date)
-    
-    os.popen("rally task report %s --out %s" % (task_id, report_file_name))
-    cmd = os.popen("rally task results %s" % task_id)
-    if task_succeed(cmd.read()):
-        print "OK"
+        logger.debug('{} does not exists'.format(test_file_name))
+        proceed_test = retrieve_test_cases_file(test_name, tests_path)
+        logger.debug('successfully downloaded to : {}'.format(test_file_name))
+ 
+    """ we do the test only if we have a scenario test file """
+    if proceed_test:
+        cmd_line = "rally task start --abort-on-sla-failure %s" % test_file_name
+        logger.debug('running command line : {}'.format(cmd_line))
+        cmd = os.popen(cmd_line)
+        task_id = get_task_id(cmd.read())
+        logger.debug('task_id : {}'.format(task_id))
+ 
+        if task_id is None:
+            logger.error("failed to retrieve task_id")
+            exit(-1)
+ 
+        """ check for result directory and create it otherwise """
+        report_path = "./results"
+        if not os.path.exists(report_path):
+            logger.debug('does not exists, we create it'.format(report_path))
+            os.makedirs(report_path)
+ 
+        """ write html report file """
+        report_file_name = '{}/opnfv-{}-{}.html'.format(report_path, test_name, test_date)
+        cmd_line = "rally task report %s --out %s" % (task_id, report_file_name)
+        logger.debug('running command line : {}'.format(cmd_line))
+        os.popen(cmd_line)
+ 
+        """ get and save rally operation JSON result """
+        cmd_line = "rally task results %s" % task_id
+        logger.debug('running command line : {}'.format(cmd_line))
+        cmd = os.popen(cmd_line)
+        json_results = cmd.read()
+        with open('{}/opnfv-{}-{}.json'.format(report_path, test_name, test_date), 'w') as f:
+            logger.debug('saving json file')
+            f.write(json_results)
+ 
+        """ parse JSON operation result """
+        if task_succeed(json_results):
+            print '{} OK'.format(test_date)
+        else:
+            print '{} KO'.format(test_date)
     else:
-        print "KO"
+        logger.error('{} test failed, unable to find a scenario test file'.format(test_name))
  
  
 def retrieve_test_cases_file(test_name, tests_path):
     """
     Retrieve from github the sample test files
-    :return: void
+    :return: Boolean that indicates the retrieval status
     """
  
     """ do not add the "/" at the end """
     url_base = "https://git.opnfv.org/cgit/functest/plain/testcases/VIM/OpenStack/CI/suites"
  
     test_file_name = 'opnfv-{}.json'.format(test_name)
-    print 'fetching {}/{} ...'.format(url_base, test_file_name)
-    response = urllib2.urlopen('{}/{}'.format(url_base, test_file_name))
+    logger.info('fetching {}/{} ...'.format(url_base, test_file_name))
+ 
+    try:
+        response = urllib2.urlopen('{}/{}'.format(url_base, test_file_name))
+    except (urllib2.HTTPError, urllib2.URLError):
+        return False
     file_raw = response.read()
  
-    """ check if the test path existe otherwise we create it """
+    """ check if the test path exist otherwise we create it """
     if not os.path.exists(tests_path):
         os.makedirs(tests_path)
  
-    with open('{}/{}'.format(tests_path,test_file_name), 'w') as file:
-        file.write(file_raw)
- 
- 
+    with open('{}/{}'.format(tests_path, test_file_name), 'w') as f:
+        f.write(file_raw)
+    return True
+
+
 def main():
     """ configure script """
-    tests = ['authenticate','glance','heat','keystone','neutron','nova','tempest','vm', 'all'];
- 
- 
-    if len(sys.argv) != 2:
-        options = '{d[0]} | {d[1]} | {d[2]} | {d[3]} | {d[4]} | {d[5]} | {d[6]} | {d[7]} | {d[8]}'.format(d=tests)
-        print "./run_rally [", options, "]"
+    if not (args.test_name in tests):
+        logger.error('argument not valid')
         exit(-1)
-    test_name = sys.argv[1]
- 
-    if not (test_name in tests):
-        print "argument not valid"
-        exit(-1)
- 
-    if test_name == "all":
+
+    if args.test_name == "all":
         for test_name in tests:
             if not (test_name == 'all' or test_name == 'tempest'):
                 print(test_name)
                 run_task(test_name)
- 
     else:
-        run_task(test_name)
- 
- 
+        run_task(args.test_name)
+
 if __name__ == '__main__':
     main()
-