/usr/lib/python3/dist-packages/provisioningserver/drivers/power/tests/test_base.py is in python3-maas-provisioningserver 2.0.0~beta3+bzr4941-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 | # Copyright 2014-2015 Canonical Ltd. This software is licensed under the
# GNU Affero General Public License version 3 (see the file LICENSE).
"""Tests for `provisioningserver.drivers.power`."""
__all__ = []
import random
from maastesting.factory import factory
from maastesting.matchers import (
MockCalledOnceWith,
MockCallsMatch,
MockNotCalled,
)
from maastesting.testcase import MAASTestCase
from mock import (
call,
sentinel,
)
from provisioningserver.drivers import (
make_setting_field,
power,
validate_settings,
)
from provisioningserver.drivers.power import (
get_error_message,
PowerActionError,
PowerAuthError,
PowerConnError,
PowerDriver,
PowerDriverBase,
PowerDriverRegistry,
PowerError,
PowerFatalError,
PowerSettingError,
PowerToolError,
)
from provisioningserver.utils.testing import RegistryFixture
from testtools.deferredruntest import AsynchronousDeferredRunTest
from testtools.matchers import Equals
from testtools.testcase import ExpectedException
from twisted.internet import reactor
from twisted.internet.defer import inlineCallbacks
class FakePowerDriverBase(PowerDriverBase):
name = ""
description = ""
settings = []
def __init__(self, name, description, settings):
self.name = name
self.description = description
self.settings = settings
super(FakePowerDriverBase, self).__init__()
def on(self, system_id, context):
raise NotImplementedError
def off(self, system_id, context):
raise NotImplementedError
def query(self, system_id, context):
raise NotImplementedError
def make_power_driver_base(name=None, description=None, settings=None):
if name is None:
name = factory.make_name('diskless')
if description is None:
description = factory.make_name('description')
if settings is None:
settings = []
return FakePowerDriverBase(name, description, settings)
class TestFakePowerDriverBase(MAASTestCase):
def test_attributes(self):
fake_name = factory.make_name('name')
fake_description = factory.make_name('description')
fake_setting = factory.make_name('setting')
fake_settings = [
make_setting_field(
fake_setting, fake_setting.title()),
]
attributes = {
'name': fake_name,
'description': fake_description,
'settings': fake_settings,
}
fake_driver = FakePowerDriverBase(
fake_name, fake_description, fake_settings)
self.assertAttributes(fake_driver, attributes)
def test_make_power_driver_base(self):
fake_name = factory.make_name('name')
fake_description = factory.make_name('description')
fake_setting = factory.make_name('setting')
fake_settings = [
make_setting_field(
fake_setting, fake_setting.title()),
]
attributes = {
'name': fake_name,
'description': fake_description,
'settings': fake_settings,
}
fake_driver = make_power_driver_base(
name=fake_name, description=fake_description,
settings=fake_settings)
self.assertAttributes(fake_driver, attributes)
def test_make_power_driver_base_makes_name_and_description(self):
fake_driver = make_power_driver_base()
self.assertNotEqual("", fake_driver.name)
self.assertNotEqual("", fake_driver.description)
def test_on_raises_not_implemented(self):
fake_driver = make_power_driver_base()
self.assertRaises(
NotImplementedError,
fake_driver.on, sentinel.system_id, sentinel.context)
def test_off_raises_not_implemented(self):
fake_driver = make_power_driver_base()
self.assertRaises(
NotImplementedError,
fake_driver.off, sentinel.system_id, sentinel.context)
def test_query_raises_not_implemented(self):
fake_driver = make_power_driver_base()
self.assertRaises(
NotImplementedError,
fake_driver.query, sentinel.system_id, sentinel.context)
class TestPowerDriverBase(MAASTestCase):
def test_get_schema(self):
fake_name = factory.make_name('name')
fake_description = factory.make_name('description')
fake_setting = factory.make_name('setting')
fake_settings = [
make_setting_field(
fake_setting, fake_setting.title()),
]
fake_driver = make_power_driver_base()
self.assertItemsEqual({
'name': fake_name,
'description': fake_description,
'fields': fake_settings,
},
fake_driver.get_schema())
def test_get_schema_returns_valid_schema(self):
fake_driver = make_power_driver_base()
#: doesn't raise ValidationError
validate_settings(fake_driver.get_schema())
class TestPowerDriverRegistry(MAASTestCase):
def setUp(self):
super(TestPowerDriverRegistry, self).setUp()
# Ensure the global registry is empty for each test run.
self.useFixture(RegistryFixture())
def test_registry(self):
self.assertItemsEqual([], PowerDriverRegistry)
PowerDriverRegistry.register_item("driver", sentinel.driver)
self.assertIn(
sentinel.driver,
(item for name, item in PowerDriverRegistry))
def test_get_schema(self):
fake_driver_one = make_power_driver_base()
fake_driver_two = make_power_driver_base()
PowerDriverRegistry.register_item(
fake_driver_one.name, fake_driver_one)
PowerDriverRegistry.register_item(
fake_driver_two.name, fake_driver_two)
self.assertItemsEqual([
{
'name': fake_driver_one.name,
'description': fake_driver_one.description,
'fields': [],
},
{
'name': fake_driver_two.name,
'description': fake_driver_two.description,
'fields': [],
}],
PowerDriverRegistry.get_schema())
class TestGetErrorMessage(MAASTestCase):
scenarios = [
('auth', dict(
exception=PowerAuthError('auth'),
message="Could not authenticate to node's BMC: auth",
)),
('conn', dict(
exception=PowerConnError('conn'),
message="Could not contact node's BMC: conn",
)),
('setting', dict(
exception=PowerSettingError('setting'),
message="Missing or invalid power setting: setting",
)),
('tool', dict(
exception=PowerToolError('tool'),
message="Missing power tool: tool",
)),
('action', dict(
exception=PowerActionError('action'),
message="Failed to complete power action: action",
)),
('unknown', dict(
exception=PowerError('unknown error'),
message="Failed talking to node's BMC: unknown error",
)),
]
def test_return_msg(self):
self.assertEqual(self.message, get_error_message(self.exception))
class FakePowerDriver(PowerDriver):
name = ""
description = ""
settings = []
def __init__(self, name, description, settings, wait_time=None,
clock=reactor):
self.name = name
self.description = description
self.settings = settings
if wait_time is not None:
self.wait_time = wait_time
super(FakePowerDriver, self).__init__(clock)
def detect_missing_packages(self):
raise NotImplementedError
def power_on(self, system_id, context):
raise NotImplementedError
def power_off(self, system_id, context):
raise NotImplementedError
def power_query(self, system_id, context):
raise NotImplementedError
def make_power_driver(name=None, description=None, settings=None,
wait_time=None, clock=reactor):
if name is None:
name = factory.make_name('diskless')
if description is None:
description = factory.make_name('description')
if settings is None:
settings = []
return FakePowerDriver(
name, description, settings, wait_time=wait_time, clock=clock)
class TestPowerDriverPowerAction(MAASTestCase):
run_tests_with = AsynchronousDeferredRunTest.make_factory(timeout=5)
scenarios = [
('on', dict(
action='on', action_func='power_on', bad_state='off')),
('off', dict(
action='off', action_func='power_off', bad_state='on')),
]
def make_error_message(self):
error = factory.make_name('msg')
self.patch(power, 'get_error_message').return_value = error
return error
@inlineCallbacks
def test_success(self):
system_id = factory.make_name('system_id')
context = {'context': factory.make_name('context')}
driver = make_power_driver(wait_time=[0])
self.patch(driver, self.action_func)
self.patch(driver, 'power_query').return_value = self.action
method = getattr(driver, self.action)
result = yield method(system_id, context)
self.assertEqual(result, None)
@inlineCallbacks
def test_handles_fatal_error_on_first_call(self):
system_id = factory.make_name('system_id')
context = {'context': factory.make_name('context')}
driver = make_power_driver(wait_time=[0, 0])
mock_on = self.patch(driver, self.action_func)
mock_on.side_effect = [PowerFatalError(), None]
mock_query = self.patch(driver, 'power_query')
mock_query.return_value = self.action
method = getattr(driver, self.action)
with ExpectedException(PowerFatalError):
yield method(system_id, context)
self.expectThat(
mock_query,
Equals(MockNotCalled()))
@inlineCallbacks
def test_handles_non_fatal_error_on_first_call(self):
system_id = factory.make_name('system_id')
context = {'context': factory.make_name('context')}
driver = make_power_driver(wait_time=[0, 0])
mock_on = self.patch(driver, self.action_func)
mock_on.side_effect = [PowerError(), None]
mock_query = self.patch(driver, 'power_query')
mock_query.return_value = self.action
method = getattr(driver, self.action)
result = yield method(system_id, context)
self.expectThat(
mock_query,
Equals(MockCalledOnceWith(system_id, context)))
self.expectThat(result, Equals(None))
@inlineCallbacks
def test_handles_non_fatal_error_and_holds_error(self):
system_id = factory.make_name('system_id')
context = {'context': factory.make_name('context')}
driver = make_power_driver(wait_time=[0])
error_msg = factory.make_name('error')
self.patch(driver, self.action_func)
mock_query = self.patch(driver, 'power_query')
mock_query.side_effect = PowerError(error_msg)
method = getattr(driver, self.action)
with ExpectedException(PowerError):
yield method(system_id, context)
self.expectThat(
mock_query,
Equals(MockCalledOnceWith(system_id, context)))
@inlineCallbacks
def test_handles_non_fatal_error(self):
system_id = factory.make_name('system_id')
context = {'context': factory.make_name('context')}
driver = make_power_driver(wait_time=[0])
mock_on = self.patch(driver, self.action_func)
mock_on.side_effect = PowerError()
method = getattr(driver, self.action)
with ExpectedException(PowerError):
yield method(system_id, context)
@inlineCallbacks
def test_handles_fails_to_complete_power_action_in_time(self):
system_id = factory.make_name('system_id')
context = {'context': factory.make_name('context')}
driver = make_power_driver(wait_time=[0])
self.patch(driver, self.action_func)
mock_query = self.patch(driver, 'power_query')
mock_query.return_value = self.bad_state
method = getattr(driver, self.action)
with ExpectedException(PowerError):
yield method(system_id, context)
class TestPowerDriverQuery(MAASTestCase):
run_tests_with = AsynchronousDeferredRunTest.make_factory(timeout=5)
def setUp(self):
super(TestPowerDriverQuery, self).setUp()
self.patch(power, "pause")
@inlineCallbacks
def test_returns_state(self):
system_id = factory.make_name('system_id')
context = {'context': factory.make_name('context')}
driver = make_power_driver()
state = factory.make_name('state')
self.patch(driver, 'power_query').return_value = state
output = yield driver.query(system_id, context)
self.assertEqual(state, output)
@inlineCallbacks
def test_retries_on_failure_then_returns_state(self):
driver = make_power_driver()
self.patch(driver, 'power_query').side_effect = [
PowerError("one"), PowerError("two"), sentinel.state]
output = yield driver.query(sentinel.system_id, sentinel.context)
self.assertEqual(sentinel.state, output)
@inlineCallbacks
def test_raises_last_exception_after_all_retries_fail(self):
wait_time = [random.randrange(1, 10) for _ in range(3)]
driver = make_power_driver(wait_time=wait_time)
exception_types = list(
factory.make_exception_type((PowerError,))
for _ in wait_time)
self.patch(driver, 'power_query').side_effect = exception_types
with ExpectedException(exception_types[-1]):
yield driver.query(sentinel.system_id, sentinel.context)
@inlineCallbacks
def test_pauses_between_retries(self):
wait_time = [random.randrange(1, 10) for _ in range(3)]
driver = make_power_driver(wait_time=wait_time)
self.patch(driver, 'power_query').side_effect = PowerError
with ExpectedException(PowerError):
yield driver.query(sentinel.system_id, sentinel.context)
self.assertThat(power.pause, MockCallsMatch(
*(call(wait, reactor) for wait in wait_time)))
|