Fix rally task verification log
- Fix rally task verification log for FAILED tasks. - Fix inconsistent output of "rally task detailed" for non-FINISHED / non-FAILED tasks. - Fix unit tests for rally.cli.commands.task Change-Id: I97787b211aca0872251fab3b80cc213338ac2657 Closes-Bug: #1562713
This commit is contained in:
Piyush Raman Srivastava
parent
37ffd64fb1
commit
bc819cb728
@ -19,6 +19,7 @@ from __future__ import print_function
|
||||
import json
|
||||
import os
|
||||
import sys
|
||||
import traceback
|
||||
import webbrowser
|
||||
|
||||
import jsonschema
|
||||
@ -131,10 +132,14 @@ class TaskCommands(object):
|
||||
|
||||
def _load_and_validate_task(self, task, task_args, task_args_file,
|
||||
deployment, task_instance=None):
|
||||
if not os.path.exists(task) or os.path.isdir(task):
|
||||
if not os.path.isfile(task):
|
||||
err_cls = IOError
|
||||
msg = "No such file '%s'" % task
|
||||
if task_instance:
|
||||
task_instance.set_failed(log="No such file '%s'" % task)
|
||||
raise IOError("File '%s' is not found." % task)
|
||||
task_instance.set_failed(err_cls.__name__,
|
||||
msg,
|
||||
json.dumps(traceback.format_stack()))
|
||||
raise err_cls(msg)
|
||||
input_task = self._load_task(task, task_args, task_args_file)
|
||||
api.Task.validate(deployment, input_task, task_instance)
|
||||
print(_("Task config is valid :)"))
|
||||
@ -252,7 +257,9 @@ class TaskCommands(object):
|
||||
self.detailed(task_id=task_instance["uuid"])
|
||||
|
||||
except (exceptions.InvalidTaskException, FailedToLoadTask) as e:
|
||||
task_instance.set_failed(log=e.format_message())
|
||||
task_instance.set_failed(type(e).__name__,
|
||||
str(e),
|
||||
json.dumps(traceback.format_exc()))
|
||||
print(e, file=sys.stderr)
|
||||
return(1)
|
||||
|
||||
@ -318,7 +325,6 @@ class TaskCommands(object):
|
||||
if task["status"] == consts.TaskStatus.FAILED:
|
||||
print("-" * 80)
|
||||
verification = yaml.safe_load(task["verification_log"])
|
||||
|
||||
if logging.is_debug():
|
||||
print(yaml.safe_load(verification[2]))
|
||||
else:
|
||||
@ -327,6 +333,13 @@ class TaskCommands(object):
|
||||
print(_("\nFor more details run:\nrally -vd task detailed %s")
|
||||
% task["uuid"])
|
||||
return 0
|
||||
elif task["status"] not in [consts.TaskStatus.FINISHED,
|
||||
consts.TaskStatus.ABORTED]:
|
||||
print("-" * 80)
|
||||
print(_("\nThe task %s marked as '%s'. Results "
|
||||
"available when it is '%s'.") % (
|
||||
task_id, task["status"], consts.TaskStatus.FINISHED))
|
||||
return 0
|
||||
for result in task["results"]:
|
||||
key = result["key"]
|
||||
print("-" * 80)
|
||||
|
||||
@ -346,9 +346,12 @@ class Task(object):
|
||||
def update_verification_log(self, log):
|
||||
self._update({"verification_log": json.dumps(log)})
|
||||
|
||||
def set_failed(self, log=""):
|
||||
def set_failed(self, etype, msg, etraceback):
|
||||
self._update({"status": consts.TaskStatus.FAILED,
|
||||
"verification_log": json.dumps(log)})
|
||||
"verification_log": json.dumps([etype,
|
||||
msg,
|
||||
etraceback
|
||||
])})
|
||||
|
||||
def get_results(self):
|
||||
return db.task_result_get_all_by_uuid(self.task["uuid"])
|
||||
|
||||
@ -188,8 +188,9 @@ class TaskEngine(object):
|
||||
try:
|
||||
self.config = TaskConfig(config)
|
||||
except Exception as e:
|
||||
log = [str(type(e)), str(e), json.dumps(traceback.format_exc())]
|
||||
task.set_failed(log=log)
|
||||
task.set_failed(type(e).__name__,
|
||||
str(e),
|
||||
json.dumps(traceback.format_exc()))
|
||||
raise exceptions.InvalidTaskException(str(e))
|
||||
|
||||
self.task = task
|
||||
@ -285,8 +286,9 @@ class TaskEngine(object):
|
||||
self._validate_config_syntax(self.config)
|
||||
self._validate_config_semantic(self.config)
|
||||
except Exception as e:
|
||||
log = [str(type(e)), str(e), json.dumps(traceback.format_exc())]
|
||||
self.task.set_failed(log=log)
|
||||
self.task.set_failed(type(e).__name__,
|
||||
str(e),
|
||||
json.dumps(traceback.format_exc()))
|
||||
raise exceptions.InvalidTaskException(str(e))
|
||||
|
||||
def _get_runner(self, config):
|
||||
|
||||
@ -15,10 +15,12 @@
|
||||
|
||||
import copy
|
||||
import datetime as dt
|
||||
import json
|
||||
import os.path
|
||||
|
||||
import ddt
|
||||
import mock
|
||||
import yaml
|
||||
|
||||
from rally.cli.commands import task
|
||||
from rally import consts
|
||||
@ -121,13 +123,13 @@ class TaskCommandsTestCase(test.TestCase):
|
||||
actual = self.task._load_task(input_task_file)
|
||||
self.assertEqual(expect, actual)
|
||||
|
||||
@mock.patch("rally.cli.commands.task.os.path.exists", return_value=True)
|
||||
@mock.patch("rally.cli.commands.task.os.path.isfile", return_value=True)
|
||||
@mock.patch("rally.cli.commands.task.api.Task.validate",
|
||||
return_value=fakes.FakeTask())
|
||||
@mock.patch("rally.cli.commands.task.TaskCommands._load_task",
|
||||
return_value={"uuid": "some_uuid"})
|
||||
def test__load_and_validate_task(self, mock__load_task,
|
||||
mock_task_validate, mock_os_path_exists):
|
||||
mock_task_validate, mock_os_path_isfile):
|
||||
deployment = "some_deployment_uuid"
|
||||
self.task._load_and_validate_task("some_task", "task_args",
|
||||
"task_args_file", deployment)
|
||||
@ -136,20 +138,17 @@ class TaskCommandsTestCase(test.TestCase):
|
||||
mock_task_validate.assert_called_once_with(
|
||||
deployment, mock__load_task.return_value, None)
|
||||
|
||||
@mock.patch("rally.cli.commands.task.os.path.exists", return_value=True)
|
||||
@mock.patch("rally.cli.commands.task.os.path.isdir", return_value=True)
|
||||
@mock.patch("rally.cli.commands.task.os.path.isfile", return_value=False)
|
||||
@mock.patch("rally.cli.commands.task.TaskCommands._load_task")
|
||||
@mock.patch("rally.api.Task.validate")
|
||||
def test__load_and_validate_directory(self, mock_task_validate,
|
||||
mock__load_task, mock_os_path_isdir,
|
||||
mock_os_path_exists):
|
||||
def test__load_and_validate_file(self, mock_task_validate, mock__load_task,
|
||||
mock_os_path_isfile):
|
||||
deployment = "some_deployment_uuid"
|
||||
self.assertRaises(IOError, self.task._load_and_validate_task,
|
||||
"some_task", "task_args",
|
||||
"task_args_file", deployment)
|
||||
|
||||
@mock.patch("rally.cli.commands.task.os.path.exists", return_value=True)
|
||||
@mock.patch("rally.cli.commands.task.os.path.isdir", return_value=False)
|
||||
@mock.patch("rally.cli.commands.task.os.path.isfile", return_value=True)
|
||||
@mock.patch("rally.cli.commands.task.api.Task.create",
|
||||
return_value=fakes.FakeTask(uuid="some_new_uuid", tag="tag"))
|
||||
@mock.patch("rally.cli.commands.task.TaskCommands.use")
|
||||
@ -162,7 +161,7 @@ class TaskCommandsTestCase(test.TestCase):
|
||||
@mock.patch("rally.cli.commands.task.api.Task.start")
|
||||
def test_start(self, mock_task_start, mock_task_validate, mock__load_task,
|
||||
mock_detailed, mock_use, mock_task_create,
|
||||
mock_os_path_isdir, mock_os_path_exists):
|
||||
mock_os_path_isfile):
|
||||
deployment_id = "e0617de9-77d1-4875-9b49-9d5789e29f20"
|
||||
task_path = "path_to_config.json"
|
||||
self.task.start(task_path, deployment_id, do_use=True)
|
||||
@ -175,8 +174,7 @@ class TaskCommandsTestCase(test.TestCase):
|
||||
mock_use.assert_called_once_with("some_new_uuid")
|
||||
mock_detailed.assert_called_once_with(task_id="some_new_uuid")
|
||||
|
||||
@mock.patch("rally.cli.commands.task.os.path.exists", return_value=True)
|
||||
@mock.patch("rally.cli.commands.task.os.path.isdir", return_value=False)
|
||||
@mock.patch("rally.cli.commands.task.os.path.isfile", return_value=True)
|
||||
@mock.patch("rally.cli.commands.task.api.Task.create",
|
||||
return_value=fakes.FakeTask(uuid="new_uuid", tag="some_tag"))
|
||||
@mock.patch("rally.cli.commands.task.TaskCommands.detailed")
|
||||
@ -187,8 +185,7 @@ class TaskCommandsTestCase(test.TestCase):
|
||||
return_value=fakes.FakeTask(uuid="some_id"))
|
||||
def test_start_with_task_args(self, mock_task_validate, mock__load_task,
|
||||
mock_task_start, mock_detailed,
|
||||
mock_task_create, mock_os_path_isdir,
|
||||
mock_os_path_exists):
|
||||
mock_task_create, mock_os_path_isfile):
|
||||
task_path = mock.MagicMock()
|
||||
task_args = mock.MagicMock()
|
||||
task_args_file = mock.MagicMock()
|
||||
@ -211,8 +208,7 @@ class TaskCommandsTestCase(test.TestCase):
|
||||
self.assertRaises(exceptions.InvalidArgumentsException,
|
||||
self.task.start, "path_to_config.json", None)
|
||||
|
||||
@mock.patch("rally.cli.commands.task.os.path.exists", return_value=True)
|
||||
@mock.patch("rally.cli.commands.task.os.path.isdir", return_value=False)
|
||||
@mock.patch("rally.cli.commands.task.os.path.isfile", return_value=True)
|
||||
@mock.patch("rally.cli.commands.task.api.Task.create",
|
||||
return_value=fakes.FakeTask(temporary=False, tag="tag",
|
||||
uuid="uuid"))
|
||||
@ -223,7 +219,7 @@ class TaskCommandsTestCase(test.TestCase):
|
||||
side_effect=exceptions.InvalidTaskException)
|
||||
def test_start_invalid_task(self, mock_task_start, mock_task_validate,
|
||||
mock__load_task, mock_task_create,
|
||||
mock_os_path_isdir, mock_os_path_exists):
|
||||
mock_os_path_isfile):
|
||||
result = self.task.start("task_path", "deployment", tag="tag")
|
||||
self.assertEqual(1, result)
|
||||
|
||||
@ -317,23 +313,59 @@ class TaskCommandsTestCase(test.TestCase):
|
||||
extended_results=True)
|
||||
self.task.detailed(test_uuid, iterations_data=True)
|
||||
|
||||
@mock.patch("rally.cli.commands.task.sys.stdout")
|
||||
@mock.patch("rally.cli.commands.task.api.Task")
|
||||
@mock.patch("rally.cli.commands.task.logging")
|
||||
def test_detailed_task_failed(self, mock_logging, mock_task):
|
||||
@ddt.data({"debug": True},
|
||||
{"debug": False})
|
||||
@ddt.unpack
|
||||
def test_detailed_task_failed(self, mock_logging, mock_task,
|
||||
mock_stdout, debug):
|
||||
test_uuid = "test_task_id"
|
||||
value = {
|
||||
"id": "task",
|
||||
"uuid": "task_uuid",
|
||||
"uuid": test_uuid,
|
||||
"status": consts.TaskStatus.FAILED,
|
||||
"results": [],
|
||||
"verification_log": "['1', '2', '3']"
|
||||
"verification_log": json.dumps(["error_type", "error_message",
|
||||
"error_traceback"])
|
||||
}
|
||||
mock_task.get_detailed = mock.MagicMock(return_value=value)
|
||||
|
||||
mock_logging.is_debug.return_value = False
|
||||
self.task.detailed("task_uuid")
|
||||
mock_logging.is_debug.return_value = debug
|
||||
self.task.detailed(test_uuid)
|
||||
verification = yaml.safe_load(value["verification_log"])
|
||||
if debug:
|
||||
expected_calls = [mock.call("Task test_task_id: failed"),
|
||||
mock.call("%s" % verification[2])]
|
||||
mock_stdout.write.assert_has_calls(expected_calls, any_order=True)
|
||||
else:
|
||||
expected_calls = [mock.call("Task test_task_id: failed"),
|
||||
mock.call("%s" % verification[0]),
|
||||
mock.call("%s" % verification[1]),
|
||||
mock.call("\nFor more details run:\nrally "
|
||||
"-vd task detailed %s" % test_uuid)]
|
||||
mock_stdout.write.assert_has_calls(expected_calls, any_order=True)
|
||||
|
||||
mock_logging.is_debug.return_value = True
|
||||
self.task.detailed("task_uuid")
|
||||
@mock.patch("rally.cli.commands.task.api.Task")
|
||||
@mock.patch("rally.cli.commands.task.sys.stdout")
|
||||
def test_detailed_task_status_not_in_finished_abort(self,
|
||||
mock_stdout,
|
||||
mock_task):
|
||||
test_uuid = "test_task_id"
|
||||
value = {
|
||||
"id": "task",
|
||||
"uuid": test_uuid,
|
||||
"status": consts.TaskStatus.INIT,
|
||||
"results": []
|
||||
}
|
||||
mock_task.get_detailed = mock.MagicMock(return_value=value)
|
||||
self.task.detailed(test_uuid)
|
||||
expected_calls = [mock.call("Task test_task_id: init"),
|
||||
mock.call("\nThe task test_task_id marked as "
|
||||
"'init'. Results available when it "
|
||||
"is 'finished'.")]
|
||||
mock_stdout.write.assert_has_calls(expected_calls, any_order=True)
|
||||
|
||||
@mock.patch("rally.cli.commands.task.envutils.get_global")
|
||||
def test_detailed_no_task_id(self, mock_get_global):
|
||||
@ -694,22 +726,22 @@ class TaskCommandsTestCase(test.TestCase):
|
||||
result = self.task.sla_check(task_id="fake_task_id", tojson=True)
|
||||
self.assertEqual(0, result)
|
||||
|
||||
@mock.patch("rally.cli.commands.task.os.path.exists", return_value=True)
|
||||
@mock.patch("rally.cli.commands.task.os.path.isfile", return_value=True)
|
||||
@mock.patch("rally.api.Task.validate")
|
||||
@mock.patch("rally.cli.commands.task.open",
|
||||
side_effect=mock.mock_open(read_data="{\"some\": \"json\"}"),
|
||||
create=True)
|
||||
def test_validate(self, mock_open, mock_task_validate,
|
||||
mock_os_path_exists):
|
||||
mock_os_path_isfile):
|
||||
self.task.validate("path_to_config.json", "fake_id")
|
||||
mock_task_validate.assert_called_once_with("fake_id", {"some": "json"},
|
||||
None)
|
||||
|
||||
@mock.patch("rally.cli.commands.task.os.path.exists", return_value=True)
|
||||
@mock.patch("rally.cli.commands.task.os.path.isfile", return_value=True)
|
||||
@mock.patch("rally.cli.commands.task.TaskCommands._load_task",
|
||||
side_effect=task.FailedToLoadTask)
|
||||
def test_validate_failed_to_load_task(self, mock__load_task,
|
||||
mock_os_path_exists):
|
||||
mock_os_path_isfile):
|
||||
args = mock.MagicMock()
|
||||
args_file = mock.MagicMock()
|
||||
|
||||
@ -719,11 +751,11 @@ class TaskCommandsTestCase(test.TestCase):
|
||||
mock__load_task.assert_called_once_with(
|
||||
"path_to_task", args, args_file)
|
||||
|
||||
@mock.patch("rally.cli.commands.task.os.path.exists", return_value=True)
|
||||
@mock.patch("rally.cli.commands.task.os.path.isfile", return_value=True)
|
||||
@mock.patch("rally.cli.commands.task.TaskCommands._load_task")
|
||||
@mock.patch("rally.api.Task.validate")
|
||||
def test_validate_invalid(self, mock_task_validate, mock__load_task,
|
||||
mock_os_path_exists):
|
||||
mock_os_path_isfile):
|
||||
mock_task_validate.side_effect = exceptions.InvalidTaskException
|
||||
result = self.task.validate("path_to_task", "deployment")
|
||||
self.assertEqual(1, result)
|
||||
@ -782,10 +814,12 @@ class TaskCommandsTestCase(test.TestCase):
|
||||
@mock.patch("rally.cli.commands.task.api.Task")
|
||||
@ddt.data({"error_type": "test_no_trace_type",
|
||||
"error_message": "no_trace_error_message",
|
||||
"error_traceback": None},
|
||||
"error_traceback": None,
|
||||
},
|
||||
{"error_type": "test_error_type",
|
||||
"error_message": "test_error_message",
|
||||
"error_traceback": "test\nerror\ntraceback"})
|
||||
"error_traceback": "test\nerror\ntraceback",
|
||||
})
|
||||
@ddt.unpack
|
||||
def test_show_task_errors_no_trace(self, mock_task, mock_stdout,
|
||||
error_type, error_message,
|
||||
@ -798,7 +832,7 @@ class TaskCommandsTestCase(test.TestCase):
|
||||
mock_task.get_detailed.return_value = {
|
||||
"id": "task",
|
||||
"uuid": test_uuid,
|
||||
"status": "status",
|
||||
"status": "finished",
|
||||
"results": [{
|
||||
"key": {
|
||||
"name": "fake_name",
|
||||
@ -819,8 +853,11 @@ class TaskCommandsTestCase(test.TestCase):
|
||||
"atomic_actions": {"foo": 0.6, "bar": 0.7},
|
||||
"error": error_data
|
||||
},
|
||||
]}
|
||||
]}
|
||||
]},
|
||||
],
|
||||
"verification_log": json.dumps([error_type, error_message,
|
||||
error_traceback])
|
||||
}
|
||||
self.task.detailed(test_uuid)
|
||||
mock_task.get_detailed.assert_called_once_with(test_uuid,
|
||||
extended_results=True)
|
||||
|
||||
@ -240,10 +240,12 @@ class TaskTestCase(test.TestCase):
|
||||
def test_set_failed(self, mock_task_update):
|
||||
mock_task_update.return_value = self.task
|
||||
task = objects.Task(task=self.task)
|
||||
task.set_failed()
|
||||
task.set_failed("foo_type", "foo_error_message", "foo_trace")
|
||||
mock_task_update.assert_called_once_with(
|
||||
self.task["uuid"],
|
||||
{"status": consts.TaskStatus.FAILED, "verification_log": "\"\""},
|
||||
{"status": consts.TaskStatus.FAILED,
|
||||
"verification_log": "[\"foo_type\", \"foo_error_message\", "
|
||||
"\"foo_trace\"]"},
|
||||
)
|
||||
|
||||
@ddt.data(
|
||||
|
||||
Loading…
Reference in New Issue
Block a user