rally/tests/unit/benchmark/test_engine.py
Boris Pavlovic c6ce128d7b Switch to plugin base: context, sla, runners
This patch attempts to switch to plugin base
and unify context sla and runners plugins.

*) Context, Runners, and SLA inherit Plugin class

*) Remove Context, Runners and SLA implementations of plugin methods

*) Use Meta for Context order and hidden options

*) Fix rally-info to use new kind of plugins

Change-Id: I5f13e07fa4d3048f86e7d7ef0ee39f9701463838
2015-06-09 16:54:17 +03:00

433 lines
19 KiB
Python

# Copyright 2013: Mirantis Inc.
# All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
"""Tests for the Test engine."""
import collections
import copy
import jsonschema
import mock
from rally.benchmark import engine
from rally import consts
from rally import exceptions
from tests.unit import fakes
from tests.unit import test
class BenchmarkEngineTestCase(test.TestCase):
def test_init(self):
config = mock.MagicMock()
task = mock.MagicMock()
eng = engine.BenchmarkEngine(config, task)
self.assertEqual(eng.config, config)
self.assertEqual(eng.task, task)
@mock.patch("rally.benchmark.engine.jsonschema.validate")
def test_validate(self, mock_json_validate):
config = mock.MagicMock()
eng = engine.BenchmarkEngine(config, mock.MagicMock())
mock_validate = mock.MagicMock()
eng._validate_config_scenarios_name = mock_validate.names
eng._validate_config_syntax = mock_validate.syntax
eng._validate_config_semantic = mock_validate.semantic
eng.validate()
expected_calls = [
mock.call.names(config),
mock.call.syntax(config),
mock.call.semantic(config)
]
mock_validate.assert_has_calls(expected_calls)
def test_validate__wrong_schema(self):
config = {
"wrong": True
}
task = mock.MagicMock()
eng = engine.BenchmarkEngine(config, task)
self.assertRaises(exceptions.InvalidTaskException,
eng.validate)
self.assertTrue(task.set_failed.called)
@mock.patch("rally.benchmark.engine.jsonschema.validate")
def test_validate__wrong_scenarios_name(self, mova_validate):
task = mock.MagicMock()
eng = engine.BenchmarkEngine(mock.MagicMock(), task)
eng._validate_config_scenarios_name = mock.MagicMock(
side_effect=exceptions.NotFoundScenarios)
self.assertRaises(exceptions.InvalidTaskException, eng.validate)
self.assertTrue(task.set_failed.called)
@mock.patch("rally.benchmark.engine.jsonschema.validate")
def test_validate__wrong_syntax(self, mova_validate):
task = mock.MagicMock()
eng = engine.BenchmarkEngine(mock.MagicMock(), task)
eng._validate_config_scenarios_name = mock.MagicMock()
eng._validate_config_syntax = mock.MagicMock(
side_effect=exceptions.InvalidBenchmarkConfig)
self.assertRaises(exceptions.InvalidTaskException, eng.validate)
self.assertTrue(task.set_failed.called)
@mock.patch("rally.benchmark.engine.jsonschema.validate")
def test_validate__wrong_semantic(self, mova_validate):
task = mock.MagicMock()
eng = engine.BenchmarkEngine(mock.MagicMock(), task)
eng._validate_config_scenarios_name = mock.MagicMock()
eng._validate_config_syntax = mock.MagicMock()
eng._validate_config_semantic = mock.MagicMock(
side_effect=exceptions.InvalidBenchmarkConfig)
self.assertRaises(exceptions.InvalidTaskException, eng.validate)
self.assertTrue(task.set_failed.called)
@mock.patch("rally.benchmark.engine.base_scenario.Scenario")
def test__validate_config_scenarios_name(self, mock_scenario):
config = {
"a": [],
"b": []
}
mock_scenario.list_benchmark_scenarios.return_value = ["e", "b", "a"]
eng = engine.BenchmarkEngine(config, mock.MagicMock())
eng._validate_config_scenarios_name(config)
@mock.patch("rally.benchmark.engine.base_scenario.Scenario")
def test__validate_config_scenarios_name_non_exsisting(self,
mock_scenario):
config = {
"exist": [],
"nonexist1": [],
"nonexist2": []
}
mock_scenario.list_benchmark_scenarios.return_value = ["exist", "aaa"]
eng = engine.BenchmarkEngine(config, mock.MagicMock())
self.assertRaises(exceptions.NotFoundScenarios,
eng._validate_config_scenarios_name, config)
@mock.patch("rally.benchmark.engine.runner.ScenarioRunner.validate")
@mock.patch("rally.benchmark.engine.context.ContextManager.validate")
def test__validate_config_syntax(self, mock_context, mock_runner):
config = {"sca": [{"context": "a"}], "scb": [{"runner": "b"}]}
eng = engine.BenchmarkEngine(mock.MagicMock(), mock.MagicMock())
eng._validate_config_syntax(config)
mock_runner.assert_has_calls([mock.call({}), mock.call("b")],
any_order=True)
mock_context.assert_has_calls([mock.call("a", non_hidden=True),
mock.call({}, non_hidden=True)],
any_order=True)
@mock.patch("rally.benchmark.engine.runner.ScenarioRunner")
@mock.patch("rally.benchmark.engine.context.ContextManager.validate")
def test__validate_config_syntax__wrong_runner(self, mock_context,
mock_runner):
config = {"sca": [{"context": "a"}], "scb": [{"runner": "b"}]}
eng = engine.BenchmarkEngine(mock.MagicMock(), mock.MagicMock())
mock_runner.validate = mock.MagicMock(
side_effect=jsonschema.ValidationError("a"))
self.assertRaises(exceptions.InvalidBenchmarkConfig,
eng._validate_config_syntax, config)
@mock.patch("rally.benchmark.engine.runner.ScenarioRunner.validate")
@mock.patch("rally.benchmark.engine.context.ContextManager")
def test__validate_config_syntax__wrong_context(self, mock_context,
mock_runner):
config = {"sca": [{"context": "a"}], "scb": [{"runner": "b"}]}
eng = engine.BenchmarkEngine(mock.MagicMock(), mock.MagicMock())
mock_context.validate = mock.MagicMock(
side_effect=jsonschema.ValidationError("a"))
self.assertRaises(exceptions.InvalidBenchmarkConfig,
eng._validate_config_syntax, config)
@mock.patch("rally.benchmark.engine.base_scenario.Scenario.validate")
def test__validate_config_semantic_helper(self, mock_validate):
deployment = mock.MagicMock()
eng = engine.BenchmarkEngine(mock.MagicMock(), mock.MagicMock())
eng._validate_config_semantic_helper("admin", "user", "name", "pos",
deployment, {"args": "args"})
mock_validate.assert_called_once_with("name", {"args": "args"},
admin="admin", users=["user"],
deployment=deployment)
@mock.patch("rally.benchmark.engine.base_scenario.Scenario.validate")
def test__validate_config_semanitc_helper_invalid_arg(self, mock_validate):
mock_validate.side_effect = exceptions.InvalidScenarioArgument()
eng = engine.BenchmarkEngine(mock.MagicMock(), mock.MagicMock())
self.assertRaises(exceptions.InvalidBenchmarkConfig,
eng._validate_config_semantic_helper, "a", "u", "n",
"p", mock.MagicMock(), {})
@mock.patch("rally.benchmark.engine.existingusers_ctx.ExistingUsers")
def test_get_user_ctx_for_validation_existing_users(self, mock_users_ctx):
context = {"a": 10}
users = [mock.MagicMock(), mock.MagicMock()]
eng = engine.BenchmarkEngine(mock.MagicMock(), mock.MagicMock(),
users=users)
result = eng._get_user_ctx_for_validation(context)
self.assertEqual(context["config"]["existing_users"], users)
mock_users_ctx.assert_called_once_with(context)
self.assertEqual(mock_users_ctx.return_value, result)
@mock.patch("rally.benchmark.engine.osclients.Clients")
@mock.patch("rally.benchmark.engine.users_ctx")
@mock.patch("rally.benchmark.engine.BenchmarkEngine"
"._validate_config_semantic_helper")
@mock.patch("rally.benchmark.engine.objects.Deployment.get",
return_value="FakeDeployment")
def test__validate_config_semantic(self, mock_deployment_get,
mock_helper, mock_userctx,
mock_osclients):
mock_userctx.UserGenerator = fakes.FakeUserContext
mock_osclients.return_value = mock.MagicMock()
config = {
"a": [mock.MagicMock(), mock.MagicMock()],
"b": [mock.MagicMock()]
}
fake_task = mock.MagicMock()
eng = engine.BenchmarkEngine(config, fake_task)
eng.admin = "admin"
eng._validate_config_semantic(config)
expected_calls = [
mock.call("admin"),
mock.call(fakes.FakeUserContext.user["endpoint"])
]
mock_osclients.assert_has_calls(expected_calls)
mock_deployment_get.assert_called_once_with(fake_task["uuid"])
admin = user = mock_osclients.return_value
fake_deployment = mock_deployment_get.return_value
expected_calls = [
mock.call(admin, user, "a", 0, fake_deployment, config["a"][0]),
mock.call(admin, user, "a", 1, fake_deployment, config["a"][1]),
mock.call(admin, user, "b", 0, fake_deployment, config["b"][0])
]
mock_helper.assert_has_calls(expected_calls, any_order=True)
@mock.patch("rally.benchmark.engine.BenchmarkEngine.consume_results")
@mock.patch("rally.benchmark.engine.context.ContextManager.cleanup")
@mock.patch("rally.benchmark.engine.context.ContextManager.setup")
@mock.patch("rally.benchmark.engine.base_scenario.Scenario")
@mock.patch("rally.benchmark.engine.runner.ScenarioRunner")
def test_run__update_status(self, mock_runner, mock_scenario,
mock_setup, mock_cleanup, mock_consume):
task = mock.MagicMock()
eng = engine.BenchmarkEngine([], task)
eng.run()
task.update_status.assert_has_calls([
mock.call(consts.TaskStatus.RUNNING),
mock.call(consts.TaskStatus.FINISHED)
])
@mock.patch("rally.benchmark.engine.BenchmarkEngine.consume_results")
@mock.patch("rally.benchmark.engine.base_scenario.Scenario")
@mock.patch("rally.benchmark.engine.runner.ScenarioRunner")
@mock.patch("rally.benchmark.engine.context.ContextManager.cleanup")
@mock.patch("rally.benchmark.engine.context.ContextManager.setup")
def test_run__config_has_args(self, mock_setup, mock_cleanup,
mock_runner, mock_scenario, mock_consume):
config = {
"a.benchmark": [{"args": {"a": "a", "b": 1}}],
"b.benchmark": [{"args": {"a": 1}}]
}
task = mock.MagicMock()
eng = engine.BenchmarkEngine(config, task)
eng.run()
@mock.patch("rally.benchmark.engine.BenchmarkEngine.consume_results")
@mock.patch("rally.benchmark.engine.base_scenario.Scenario")
@mock.patch("rally.benchmark.engine.runner.ScenarioRunner")
@mock.patch("rally.benchmark.engine.context.ContextManager.cleanup")
@mock.patch("rally.benchmark.engine.context.ContextManager.setup")
def test_run__config_has_runner(self, mock_setup, mock_cleanup,
mock_runner, mock_scenario, mock_consume):
config = {
"a.benchmark": [{"runner": {"type": "a", "b": 1}}],
"b.benchmark": [{"runner": {"type": "c", "a": 1}}]
}
task = mock.MagicMock()
eng = engine.BenchmarkEngine(config, task)
eng.run()
@mock.patch("rally.benchmark.engine.BenchmarkEngine.consume_results")
@mock.patch("rally.benchmark.engine.base_scenario.Scenario")
@mock.patch("rally.benchmark.engine.runner.ScenarioRunner")
@mock.patch("rally.benchmark.engine.context.ContextManager.cleanup")
@mock.patch("rally.benchmark.engine.context.ContextManager.setup")
def test_run__config_has_context(self, mock_ctx_setup, mock_ctx_cleanup,
mock_runner, mock_scenario, mock_consume):
config = {
"a.benchmark": [{"context": {"context_a": {"a": 1}}}],
"b.benchmark": [{"context": {"context_b": {"b": 2}}}]
}
task = mock.MagicMock()
eng = engine.BenchmarkEngine(config, task)
eng.run()
@mock.patch("rally.benchmark.engine.LOG")
@mock.patch("rally.benchmark.engine.BenchmarkEngine.consume_results")
@mock.patch("rally.benchmark.engine.base_scenario.Scenario")
@mock.patch("rally.benchmark.engine.runner.ScenarioRunner")
@mock.patch("rally.benchmark.engine.context.ContextManager.cleanup")
@mock.patch("rally.benchmark.engine.context.ContextManager.setup")
def test_run_exception_is_logged(self, mock_ctx_setup, mock_ctx_cleanup,
mock_runner, mock_scenario, mock_consume,
mock_log):
mock_ctx_setup.side_effect = Exception
config = {
"a.benchmark": [{"context": {"context_a": {"a": 1}}}],
"b.benchmark": [{"context": {"context_b": {"b": 2}}}]
}
task = mock.MagicMock()
eng = engine.BenchmarkEngine(config, task)
eng.run()
self.assertEqual(2, mock_log.exception.call_count)
@mock.patch("rally.benchmark.engine.base_scenario.Scenario.meta")
def test__prepare_context(self, mock_meta):
default_context = {"a": 1, "b": 2}
mock_meta.return_value = default_context
task = mock.MagicMock()
name = "a.benchmark"
context = {"b": 3, "c": 4}
endpoint = mock.MagicMock()
config = {
"a.benchmark": [{"context": {"context_a": {"a": 1}}}],
}
eng = engine.BenchmarkEngine(config, task)
result = eng._prepare_context(context, name, endpoint)
expected_context = copy.deepcopy(default_context)
expected_context.setdefault("users", {})
expected_context.update(context)
expected_result = {
"task": task,
"admin": {"endpoint": endpoint},
"scenario_name": name,
"config": expected_context
}
self.assertEqual(result, expected_result)
mock_meta.assert_called_once_with(name, "context")
@mock.patch("rally.benchmark.engine.base_scenario.Scenario.meta")
def test__prepare_context_with_existing_users(self, mock_meta):
mock_meta.return_value = {}
task = mock.MagicMock()
name = "a.benchmark"
context = {"b": 3, "c": 4}
endpoint = mock.MagicMock()
config = {
"a.benchmark": [{"context": {"context_a": {"a": 1}}}],
}
existing_users = [mock.MagicMock()]
eng = engine.BenchmarkEngine(config, task, users=existing_users)
result = eng._prepare_context(context, name, endpoint)
expected_context = {"existing_users": existing_users}
expected_context.update(context)
expected_result = {
"task": task,
"admin": {"endpoint": endpoint},
"scenario_name": name,
"config": expected_context
}
self.assertEqual(result, expected_result)
mock_meta.assert_called_once_with(name, "context")
@mock.patch("rally.benchmark.sla.SLAChecker")
def test_consume_results(self, mock_sla):
mock_sla_instance = mock.MagicMock()
mock_sla.return_value = mock_sla_instance
key = {"kw": {"fake": 2}, "name": "fake", "pos": 0}
task = mock.MagicMock()
config = {
"a.benchmark": [{"context": {"context_a": {"a": 1}}}],
}
runner = mock.MagicMock()
runner.result_queue = collections.deque([1, 2])
is_done = mock.MagicMock()
is_done.isSet.side_effect = [False, False, True]
eng = engine.BenchmarkEngine(config, task)
eng.duration = 123
eng.full_duration = 456
eng.consume_results(key, task, is_done, {}, runner)
mock_sla.assert_called_once_with({"fake": 2})
expected_iteration_calls = [mock.call(1), mock.call(2)]
self.assertEqual(expected_iteration_calls,
mock_sla_instance.add_iteration.mock_calls)
@mock.patch("rally.benchmark.sla.SLAChecker")
def test_consume_results_sla_failure_abort(self, mock_sla):
mock_sla_instance = mock.MagicMock()
mock_sla.return_value = mock_sla_instance
mock_sla_instance.add_iteration.side_effect = [True, True, False,
False]
key = {"kw": {"fake": 2}, "name": "fake", "pos": 0}
task = mock.MagicMock()
config = {
"a.benchmark": [{"context": {"context_a": {"a": 1}}}],
}
runner = mock.MagicMock()
runner.result_queue = collections.deque([1, 2, 3, 4])
is_done = mock.MagicMock()
is_done.isSet.side_effect = [False, False, False, False, True]
eng = engine.BenchmarkEngine(config, task, abort_on_sla_failure=True)
eng.duration = 123
eng.full_duration = 456
eng.consume_results(key, task, is_done, {}, runner)
mock_sla.assert_called_once_with({"fake": 2})
self.assertTrue(runner.abort.called)
@mock.patch("rally.benchmark.sla.SLAChecker")
def test_consume_results_sla_failure_continue(self, mock_sla):
mock_sla_instance = mock.MagicMock()
mock_sla.return_value = mock_sla_instance
mock_sla_instance.add_iteration.side_effect = [True, True, False,
False]
key = {"kw": {"fake": 2}, "name": "fake", "pos": 0}
task = mock.MagicMock()
config = {
"a.benchmark": [{"context": {"context_a": {"a": 1}}}],
}
runner = mock.MagicMock()
runner.result_queue = collections.deque([1, 2, 3, 4])
is_done = mock.MagicMock()
is_done.isSet.side_effect = [False, False, False, False, True]
eng = engine.BenchmarkEngine(config, task, abort_on_sla_failure=False)
eng.duration = 123
eng.full_duration = 456
eng.consume_results(key, task, is_done, {}, runner)
mock_sla.assert_called_once_with({"fake": 2})
self.assertEqual(0, runner.abort.call_count)