From 74df72ec294998787a8f0af5e2084db91ba0778b Mon Sep 17 00:00:00 2001
From: =?utf8?q?C=C3=A9dric=20Ollivier?= <cedric.ollivier@orange.com>
Date: Fri, 11 Oct 2019 10:44:25 +0200
Subject: [PATCH] Leverage on Rally task tags
MIME-Version: 1.0
Content-Type: text/plain; charset=utf8
Content-Transfer-Encoding: 8bit

It avoids parsing rally task outputs which may hang (subprocess
communicate) as seen in rally_full and rally_jobs.

It simply selects test names as tags.

Change-Id: I88b54a8f155e557f8a606fdbd7d86c1f4d5dae3b
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>
---
 functest/opnfv_tests/openstack/rally/rally.py     | 43 +++++++++++------------
 functest/tests/unit/openstack/rally/test_rally.py | 22 +++++++-----
 2 files changed, 33 insertions(+), 32 deletions(-)

diff --git a/functest/opnfv_tests/openstack/rally/rally.py b/functest/opnfv_tests/openstack/rally/rally.py
index d3b82b789..3f483069b 100644
--- a/functest/opnfv_tests/openstack/rally/rally.py
+++ b/functest/opnfv_tests/openstack/rally/rally.py
@@ -25,6 +25,7 @@ import time
 import pkg_resources
 import prettytable
 from ruamel.yaml import YAML
+import six
 from six.moves import configparser
 from xtesting.core import testcase
 import yaml
@@ -234,20 +235,17 @@ class RallyBase(singlevm.VmReady2):
                 rconfig.write(config_file)
 
     @staticmethod
-    def get_task_id(cmd_raw):
+    def get_task_id(tag):
         """
         Get task id from command rally result.
 
-        :param cmd_raw:
+        :param tag:
         :return: task_id as string
         """
-        taskid_re = re.compile('^Task +(.*): started$')
-        for line in cmd_raw.splitlines(True):
-            line = line.strip()
-            match = taskid_re.match(line.decode("utf-8"))
-            if match:
-                return match.group(1)
-        return None
+        cmd = ["rally", "task", "list", "--tag", tag, "--uuids-only"]
+        output = subprocess.check_output(cmd).decode("utf-8").rstrip()
+        LOGGER.info("%s: %s", " ".join(cmd), output)
+        return output
 
     @staticmethod
     def task_succeed(json_raw):
@@ -429,20 +427,17 @@ class RallyBase(singlevm.VmReady2):
         """Run a task."""
         LOGGER.info('Starting test scenario "%s" ...', test_name)
         LOGGER.debug('running command: %s', self.run_cmd)
-        proc = subprocess.Popen(self.run_cmd, stdout=subprocess.PIPE,
-                                stderr=subprocess.STDOUT)
-        try:
-            output = proc.communicate(timeout=self.task_timeout)[0]
-        except subprocess.TimeoutExpired:
-            proc.kill()
-            proc.communicate()
-            LOGGER.error("Failed to complete run task")
-            raise Exception("Failed to complete run task")
-        task_id = self.get_task_id(output)
+        if six.PY3:
+            subprocess.call(
+                self.run_cmd, timeout=self.task_timeout,
+                stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
+        else:
+            with open(os.devnull, 'wb') as devnull:
+                subprocess.call(self.run_cmd, stdout=devnull, stderr=devnull)
+        task_id = self.get_task_id(test_name)
         LOGGER.debug('task_id : %s', task_id)
-        if task_id is None:
+        if not task_id:
             LOGGER.error("Failed to retrieve task_id")
-            LOGGER.error("Result:\n%s", output.decode("utf-8"))
             raise Exception("Failed to retrieve task id")
         self._save_results(test_name, task_id)
 
@@ -532,7 +527,8 @@ class RallyBase(singlevm.VmReady2):
         if self.file_is_empty(file_name):
             LOGGER.info('No tests for scenario "%s"', test_name)
             return False
-        self.run_cmd = (["rally", "task", "start", "--abort-on-sla-failure",
+        self.run_cmd = (["rally", "task", "start", "--tag", test_name,
+                         "--abort-on-sla-failure",
                          "--task", self.task_file, "--task-args",
                          str(self.build_task_args(test_name))])
         return True
@@ -845,7 +841,8 @@ class RallyJobs(RallyBase):
             os.makedirs(self.temp_dir)
         task_file_name = os.path.join(self.temp_dir, task_name)
         self.apply_blacklist(task, task_file_name)
-        self.run_cmd = (["rally", "task", "start", "--task", task_file_name,
+        self.run_cmd = (["rally", "task", "start", "--tag", test_name,
+                         "--task", task_file_name,
                          "--task-args", str(self.build_task_args(test_name))])
         return True
 
diff --git a/functest/tests/unit/openstack/rally/test_rally.py b/functest/tests/unit/openstack/rally/test_rally.py
index ae3c3976b..c281d4f52 100644
--- a/functest/tests/unit/openstack/rally/test_rally.py
+++ b/functest/tests/unit/openstack/rally/test_rally.py
@@ -103,15 +103,19 @@ class OSRallyTesting(unittest.TestCase):
         mock_method.assert_called()
         mock_os_makedirs.assert_called()
 
-    def test_get_task_id_default(self):
-        cmd_raw = b'Task 1: started'
-        self.assertEqual(self.rally_base.get_task_id(cmd_raw),
-                         '1')
-
-    def test_get_task_id_missing_id(self):
-        cmd_raw = b''
-        self.assertEqual(self.rally_base.get_task_id(cmd_raw),
-                         None)
+    @mock.patch('subprocess.check_output', return_value=b'1\n')
+    def test_get_task_id_default(self, *args):
+        tag = 'nova'
+        self.assertEqual(self.rally_base.get_task_id(tag), '1')
+        args[0].assert_called_with(
+            ['rally', 'task', 'list', '--tag', tag, '--uuids-only'])
+
+    @mock.patch('subprocess.check_output', return_value=b'\n')
+    def test_get_task_id_missing_id(self, *args):
+        tag = 'nova'
+        self.assertEqual(self.rally_base.get_task_id(tag), '')
+        args[0].assert_called_with(
+            ['rally', 'task', 'list', '--tag', tag, '--uuids-only'])
 
     def test_task_succeed_fail(self):
         json_raw = json.dumps({})
-- 
2.16.6