Merge lp:~blake-rouse/maas/sm15k-query into lp:~maas-committers/maas/trunk
- sm15k-query
- Merge into trunk
Proposed by
Blake Rouse
Status: | Merged |
---|---|
Merged at revision: | 3403 |
Proposed branch: | lp:~blake-rouse/maas/sm15k-query |
Merge into: | lp:~maas-committers/maas/trunk |
Diff against target: |
379 lines (+250/-40) 5 files modified
etc/maas/templates/power/sm15k.template (+105/-31) src/provisioningserver/drivers/hardware/seamicro.py (+19/-6) src/provisioningserver/drivers/hardware/tests/test_seamicro.py (+69/-0) src/provisioningserver/rpc/power.py (+3/-3) src/provisioningserver/rpc/tests/test_power.py (+54/-0) |
To merge this branch: | bzr merge lp:~blake-rouse/maas/sm15k-query |
Related bugs: |
Reviewer | Review Type | Date Requested | Status |
---|---|---|---|
Andres Rodriguez (community) | Needs Fixing | ||
Review via email: mp+240785@code.launchpad.net |
Commit message
Support the ability to query the power status of sm15k using RESTAPI v2.0.
Description of the change
To post a comment you must log in.
Preview Diff
[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1 | === modified file 'etc/maas/templates/power/sm15k.template' | |||
2 | --- etc/maas/templates/power/sm15k.template 2014-06-10 14:45:14 +0000 | |||
3 | +++ etc/maas/templates/power/sm15k.template 2014-11-05 21:52:32 +0000 | |||
4 | @@ -3,50 +3,124 @@ | |||
5 | 3 | # Control a system via ipmipower, sending the seamicro specific hex codes | 3 | # Control a system via ipmipower, sending the seamicro specific hex codes |
6 | 4 | # | 4 | # |
7 | 5 | 5 | ||
20 | 6 | # Parameters | 6 | # Exit with failure message. |
21 | 7 | power_change={{power_change}} | 7 | # Parameters: exit code, and error message. |
22 | 8 | power_address={{power_address}} | 8 | fail() { |
23 | 9 | power_user={{power_user}} | 9 | echo "$2" >&2 |
24 | 10 | power_pass={{power_pass}} | 10 | exit $1 |
25 | 11 | power_control={{power_control}} | 11 | } |
14 | 12 | system_id={{system_id}} | ||
15 | 13 | ipmitool={{ipmitool}} | ||
16 | 14 | |||
17 | 15 | # IPMI power mode | ||
18 | 16 | {{py: power_mode = 1 if power_change == 'on' else 6 }} | ||
19 | 17 | power_mode={{power_mode}} | ||
26 | 18 | 12 | ||
27 | 19 | # Control power using IPMI | 13 | # Control power using IPMI |
28 | 20 | issue_ipmi_command() { | 14 | issue_ipmi_command() { |
33 | 21 | ${ipmitool} -I lanplus \ | 15 | {{py: power_mode = 1 if power_change == 'on' else 6 }} |
34 | 22 | -H ${power_address} -U ${power_user}\ | 16 | {{ipmitool}} -I lanplus \ |
35 | 23 | -P ${power_pass} raw 0x2E 1 0x00 0x7d 0xab \ | 17 | -H {{power_address}} -U {{power_user}}\ |
36 | 24 | ${power_mode} 0 ${system_id} | 18 | -P {{power_pass}} raw 0x2E 1 0x00 0x7d 0xab \ |
37 | 19 | {{power_mode}} 0 {{system_id}} | ||
38 | 25 | } | 20 | } |
39 | 26 | 21 | ||
40 | 27 | # Control power using REST v0.9 | 22 | # Control power using REST v0.9 |
41 | 28 | issue_rest_v09_command() { | 23 | issue_rest_v09_command() { |
42 | 29 | python - << END | 24 | python - << END |
43 | 25 | import sys | ||
44 | 30 | from provisioningserver.drivers.hardware.seamicro import power_control_seamicro15k_v09 | 26 | from provisioningserver.drivers.hardware.seamicro import power_control_seamicro15k_v09 |
46 | 31 | power_control_seamicro15k_v09("${power_address}", "${power_user}", "${power_pass}", "${system_id}", "${power_change}") | 27 | try: |
47 | 28 | power_control_seamicro15k_v09( | ||
48 | 29 | {{escape_py_literal(power_address) | safe}}, | ||
49 | 30 | {{escape_py_literal(power_user) | safe}}, | ||
50 | 31 | {{escape_py_literal(power_pass) | safe}}, | ||
51 | 32 | {{escape_py_literal(system_id) | safe}}, | ||
52 | 33 | {{escape_py_literal(power_change) | safe}}, | ||
53 | 34 | ) | ||
54 | 35 | except Exception as e: | ||
55 | 36 | # This gets in the node event log: print the exception's message | ||
56 | 37 | # and not the stacktrace. | ||
57 | 38 | print(unicode(e)) | ||
58 | 39 | sys.exit(1) | ||
59 | 32 | END | 40 | END |
60 | 33 | } | 41 | } |
61 | 34 | 42 | ||
62 | 35 | # Control power using REST v2 | 43 | # Control power using REST v2 |
63 | 36 | issue_rest_v2_command() { | 44 | issue_rest_v2_command() { |
64 | 37 | python - << END | 45 | python - << END |
65 | 46 | import sys | ||
66 | 38 | from provisioningserver.drivers.hardware.seamicro import power_control_seamicro15k_v2 | 47 | from provisioningserver.drivers.hardware.seamicro import power_control_seamicro15k_v2 |
81 | 39 | power_control_seamicro15k_v2("${power_address}", "${power_user}", "${power_pass}", "${system_id}", "${power_change}") | 48 | try: |
82 | 40 | END | 49 | power_control_seamicro15k_v2( |
83 | 41 | } | 50 | {{escape_py_literal(power_address) | safe}}, |
84 | 42 | 51 | {{escape_py_literal(power_user) | safe}}, | |
85 | 43 | if [ "${power_control}" = "ipmi" ] | 52 | {{escape_py_literal(power_pass) | safe}}, |
86 | 44 | then | 53 | {{escape_py_literal(system_id) | safe}}, |
87 | 45 | issue_ipmi_command | 54 | {{escape_py_literal(power_change) | safe}}, |
88 | 46 | elif [ "${power_control}" = "restapi" ] | 55 | ) |
89 | 47 | then | 56 | except Exception as e: |
90 | 48 | issue_rest_v09_command | 57 | # This gets in the node event log: print the exception's message |
91 | 49 | elif [ "${power_control}" = "restapi2" ] | 58 | # and not the stacktrace. |
92 | 50 | then | 59 | print(unicode(e)) |
93 | 51 | issue_rest_v2_command | 60 | sys.exit(1) |
94 | 52 | fi | 61 | END |
95 | 62 | } | ||
96 | 63 | |||
97 | 64 | # Query power state using REST v2 | ||
98 | 65 | query_state_rest_v2() { | ||
99 | 66 | python - << END | ||
100 | 67 | import sys | ||
101 | 68 | from provisioningserver.drivers.hardware.mscm seamicro power_query_seamicro15k_v2 | ||
102 | 69 | try: | ||
103 | 70 | print(power_query_seamicro15k_v2( | ||
104 | 71 | {{escape_py_literal(power_address) | safe}}, | ||
105 | 72 | {{escape_py_literal(power_user) | safe}}, | ||
106 | 73 | {{escape_py_literal(power_pass) | safe}}, | ||
107 | 74 | {{escape_py_literal(system_id) | safe}}, | ||
108 | 75 | )) | ||
109 | 76 | except Exception as e: | ||
110 | 77 | # This gets in the node event log: print the exception's message | ||
111 | 78 | # and not the stacktrace. | ||
112 | 79 | print(unicode(e)) | ||
113 | 80 | sys.exit(1) | ||
114 | 81 | END | ||
115 | 82 | } | ||
116 | 83 | |||
117 | 84 | # Perform power control | ||
118 | 85 | power_control() { | ||
119 | 86 | if [ "{{power_control}}" = "ipmi" ] | ||
120 | 87 | then | ||
121 | 88 | issue_ipmi_command | ||
122 | 89 | elif [ "{{power_control}}" = "restapi" ] | ||
123 | 90 | then | ||
124 | 91 | issue_rest_v09_command | ||
125 | 92 | elif [ "{{power_control}}" = "restapi2" ] | ||
126 | 93 | then | ||
127 | 94 | issue_rest_v2_command | ||
128 | 95 | fi | ||
129 | 96 | } | ||
130 | 97 | |||
131 | 98 | # Query the state. | ||
132 | 99 | # Only supported by REST v2. | ||
133 | 100 | query_state() { | ||
134 | 101 | if [ "{{power_control}}" = "ipmi" ] | ||
135 | 102 | then | ||
136 | 103 | echo "unknown" | ||
137 | 104 | elif [ "{{power_control}}" = "restapi" ] | ||
138 | 105 | then | ||
139 | 106 | echo "unknown" | ||
140 | 107 | elif [ "{{power_control}}" = "restapi2" ] | ||
141 | 108 | then | ||
142 | 109 | query_state_rest_v2 | ||
143 | 110 | fi | ||
144 | 111 | } | ||
145 | 112 | |||
146 | 113 | main() { | ||
147 | 114 | case $1 in | ||
148 | 115 | 'on'|'off') | ||
149 | 116 | power_control | ||
150 | 117 | ;; | ||
151 | 118 | 'query') | ||
152 | 119 | query_state | ||
153 | 120 | ;; | ||
154 | 121 | *) | ||
155 | 122 | fail 2 "Unknown power command: '$1'" | ||
156 | 123 | esac | ||
157 | 124 | } | ||
158 | 125 | |||
159 | 126 | main "{{power_change}}" | ||
160 | 53 | 127 | ||
161 | === modified file 'src/provisioningserver/drivers/hardware/seamicro.py' | |||
162 | --- src/provisioningserver/drivers/hardware/seamicro.py 2014-09-10 16:20:31 +0000 | |||
163 | +++ src/provisioningserver/drivers/hardware/seamicro.py 2014-11-05 21:52:32 +0000 | |||
164 | @@ -320,9 +320,22 @@ | |||
165 | 320 | power_change): | 320 | power_change): |
166 | 321 | server_id = '%s/0' % server_id | 321 | server_id = '%s/0' % server_id |
167 | 322 | api = get_seamicro15k_api('v2.0', ip, username, password) | 322 | api = get_seamicro15k_api('v2.0', ip, username, password) |
174 | 323 | if api: | 323 | if api is None: |
175 | 324 | server = api.servers.get(server_id) | 324 | raise SeaMicroError('Unable to contact BMC controller.') |
176 | 325 | if power_change == "on": | 325 | server = api.servers.get(server_id) |
177 | 326 | server.power_on(using_pxe=True) | 326 | if power_change == "on": |
178 | 327 | elif power_change == "off": | 327 | server.power_on(using_pxe=True) |
179 | 328 | server.power_off(force=True) | 328 | elif power_change == "off": |
180 | 329 | server.power_off(force=True) | ||
181 | 330 | |||
182 | 331 | |||
183 | 332 | def power_query_seamicro15k_v2(ip, username, password, server_id, | ||
184 | 333 | power_change): | ||
185 | 334 | server_id = '%s/0' % server_id | ||
186 | 335 | api = get_seamicro15k_api('v2.0', ip, username, password) | ||
187 | 336 | if api is None: | ||
188 | 337 | raise SeaMicroError('Unable to contact BMC controller.') | ||
189 | 338 | server = api.servers.get(server_id) | ||
190 | 339 | if server.active: | ||
191 | 340 | return "on" | ||
192 | 341 | return "off" | ||
193 | 329 | 342 | ||
194 | === modified file 'src/provisioningserver/drivers/hardware/tests/test_seamicro.py' | |||
195 | --- src/provisioningserver/drivers/hardware/tests/test_seamicro.py 2014-09-18 12:44:38 +0000 | |||
196 | +++ src/provisioningserver/drivers/hardware/tests/test_seamicro.py 2014-11-05 21:52:32 +0000 | |||
197 | @@ -34,6 +34,7 @@ | |||
198 | 34 | find_seamicro15k_servers, | 34 | find_seamicro15k_servers, |
199 | 35 | power_control_seamicro15k_v09, | 35 | power_control_seamicro15k_v09, |
200 | 36 | power_control_seamicro15k_v2, | 36 | power_control_seamicro15k_v2, |
201 | 37 | power_query_seamicro15k_v2, | ||
202 | 37 | POWER_STATUS, | 38 | POWER_STATUS, |
203 | 38 | probe_seamicro15k_and_enlist, | 39 | probe_seamicro15k_and_enlist, |
204 | 39 | SeaMicroAPIV09, | 40 | SeaMicroAPIV09, |
205 | @@ -466,3 +467,71 @@ | |||
206 | 466 | 467 | ||
207 | 467 | power_control_seamicro15k_v2(ip, username, password, '0', 'on') | 468 | power_control_seamicro15k_v2(ip, username, password, '0', 'on') |
208 | 468 | mock_power_on.assert_called() | 469 | mock_power_on.assert_called() |
209 | 470 | |||
210 | 471 | def test_power_control_seamicro15k_v2_raises_error_when_api_None(self): | ||
211 | 472 | ip = factory.make_ipv4_address() | ||
212 | 473 | username = factory.make_string() | ||
213 | 474 | password = factory.make_string() | ||
214 | 475 | |||
215 | 476 | mock_get_api = self.patch( | ||
216 | 477 | seamicro, | ||
217 | 478 | 'get_seamicro15k_api') | ||
218 | 479 | mock_get_api.return_value = None | ||
219 | 480 | |||
220 | 481 | self.assertRaises( | ||
221 | 482 | SeaMicroError, | ||
222 | 483 | power_control_seamicro15k_v2, ip, username, password, '0', 'on') | ||
223 | 484 | |||
224 | 485 | def test_power_query_seamicro15k_v2_power_on(self): | ||
225 | 486 | ip = factory.make_ipv4_address() | ||
226 | 487 | username = factory.make_string() | ||
227 | 488 | password = factory.make_string() | ||
228 | 489 | |||
229 | 490 | fake_server = FakeServer('0/0') | ||
230 | 491 | self.patch(fake_server, 'active', True) | ||
231 | 492 | fake_client = FakeSeaMicroClient() | ||
232 | 493 | fake_client.servers = FakeSeaMicroServerManager() | ||
233 | 494 | fake_client.servers.servers.append(fake_server) | ||
234 | 495 | |||
235 | 496 | mock_get_api = self.patch( | ||
236 | 497 | seamicro, | ||
237 | 498 | 'get_seamicro15k_api') | ||
238 | 499 | mock_get_api.return_value = fake_client | ||
239 | 500 | |||
240 | 501 | self.assertEqual( | ||
241 | 502 | "on", | ||
242 | 503 | power_query_seamicro15k_v2(ip, username, password, '0', 'on')) | ||
243 | 504 | |||
244 | 505 | def test_power_query_seamicro15k_v2_power_off(self): | ||
245 | 506 | ip = factory.make_ipv4_address() | ||
246 | 507 | username = factory.make_string() | ||
247 | 508 | password = factory.make_string() | ||
248 | 509 | |||
249 | 510 | fake_server = FakeServer('0/0') | ||
250 | 511 | self.patch(fake_server, 'active', False) | ||
251 | 512 | fake_client = FakeSeaMicroClient() | ||
252 | 513 | fake_client.servers = FakeSeaMicroServerManager() | ||
253 | 514 | fake_client.servers.servers.append(fake_server) | ||
254 | 515 | |||
255 | 516 | mock_get_api = self.patch( | ||
256 | 517 | seamicro, | ||
257 | 518 | 'get_seamicro15k_api') | ||
258 | 519 | mock_get_api.return_value = fake_client | ||
259 | 520 | |||
260 | 521 | self.assertEqual( | ||
261 | 522 | "off", | ||
262 | 523 | power_query_seamicro15k_v2(ip, username, password, '0', 'on')) | ||
263 | 524 | |||
264 | 525 | def test_power_query_seamicro15k_v2_raises_error_when_api_None(self): | ||
265 | 526 | ip = factory.make_ipv4_address() | ||
266 | 527 | username = factory.make_string() | ||
267 | 528 | password = factory.make_string() | ||
268 | 529 | |||
269 | 530 | mock_get_api = self.patch( | ||
270 | 531 | seamicro, | ||
271 | 532 | 'get_seamicro15k_api') | ||
272 | 533 | mock_get_api.return_value = None | ||
273 | 534 | |||
274 | 535 | self.assertRaises( | ||
275 | 536 | SeaMicroError, | ||
276 | 537 | power_query_seamicro15k_v2, ip, username, password, '0', 'on') | ||
277 | 469 | 538 | ||
278 | === modified file 'src/provisioningserver/rpc/power.py' | |||
279 | --- src/provisioningserver/rpc/power.py 2014-10-28 21:48:26 +0000 | |||
280 | +++ src/provisioningserver/rpc/power.py 2014-11-05 21:52:32 +0000 | |||
281 | @@ -61,7 +61,7 @@ | |||
282 | 61 | # state for these power types. | 61 | # state for these power types. |
283 | 62 | # This is meant to be temporary until all the power types support | 62 | # This is meant to be temporary until all the power types support |
284 | 63 | # querying the power state of a node. | 63 | # querying the power state of a node. |
286 | 64 | QUERY_POWER_TYPES = ['amt', 'ipmi', 'mscm', 'virsh'] | 64 | QUERY_POWER_TYPES = ['amt', 'ipmi', 'mscm', 'sm15k', 'virsh'] |
287 | 65 | 65 | ||
288 | 66 | 66 | ||
289 | 67 | # Timeout for change_power_state(). We set it to 2 minutes by default, | 67 | # Timeout for change_power_state(). We set it to 2 minutes by default, |
290 | @@ -232,7 +232,7 @@ | |||
291 | 232 | new_power_state = yield deferToThread( | 232 | new_power_state = yield deferToThread( |
292 | 233 | perform_power_change, system_id, hostname, power_type, | 233 | perform_power_change, system_id, hostname, power_type, |
293 | 234 | 'query', context) | 234 | 'query', context) |
295 | 235 | if new_power_state == power_change: | 235 | if new_power_state == "unknown" or new_power_state == power_change: |
296 | 236 | yield power_change_success(system_id, hostname, power_change) | 236 | yield power_change_success(system_id, hostname, power_change) |
297 | 237 | return | 237 | return |
298 | 238 | 238 | ||
299 | @@ -298,7 +298,7 @@ | |||
300 | 298 | try: | 298 | try: |
301 | 299 | power_state = yield deferToThread( | 299 | power_state = yield deferToThread( |
302 | 300 | perform_power_query, system_id, hostname, power_type, context) | 300 | perform_power_query, system_id, hostname, power_type, context) |
304 | 301 | if power_state not in ("on", "off"): | 301 | if power_state not in ("on", "off", "unknown"): |
305 | 302 | # This is considered an error. | 302 | # This is considered an error. |
306 | 303 | raise PowerActionFail(power_state) | 303 | raise PowerActionFail(power_state) |
307 | 304 | except PowerActionFail as e: | 304 | except PowerActionFail as e: |
308 | 305 | 305 | ||
309 | === modified file 'src/provisioningserver/rpc/tests/test_power.py' | |||
310 | --- src/provisioningserver/rpc/tests/test_power.py 2014-10-27 11:56:50 +0000 | |||
311 | +++ src/provisioningserver/rpc/tests/test_power.py 2014-11-05 21:52:32 +0000 | |||
312 | @@ -321,6 +321,37 @@ | |||
313 | 321 | self.assertThat(markNodeBroken, MockNotCalled()) | 321 | self.assertThat(markNodeBroken, MockNotCalled()) |
314 | 322 | 322 | ||
315 | 323 | @inlineCallbacks | 323 | @inlineCallbacks |
316 | 324 | def test_change_power_state_doesnt_retry_if_query_returns_unknown(self): | ||
317 | 325 | system_id = factory.make_name('system_id') | ||
318 | 326 | hostname = factory.make_name('hostname') | ||
319 | 327 | power_type = random.choice(power.QUERY_POWER_TYPES) | ||
320 | 328 | power_change = random.choice(['on', 'off']) | ||
321 | 329 | context = { | ||
322 | 330 | factory.make_name('context-key'): factory.make_name('context-val') | ||
323 | 331 | } | ||
324 | 332 | self.patch(power, 'pause') | ||
325 | 333 | power.power_action_registry[system_id] = power_change | ||
326 | 334 | # Patch the power action utility so that it says the node is | ||
327 | 335 | # in the required power state. | ||
328 | 336 | power_action, execute = patch_power_action( | ||
329 | 337 | self, return_value="unknown") | ||
330 | 338 | markNodeBroken = yield self.patch_rpc_methods() | ||
331 | 339 | |||
332 | 340 | yield power.change_power_state( | ||
333 | 341 | system_id, hostname, power_type, power_change, context) | ||
334 | 342 | self.assertThat( | ||
335 | 343 | execute, | ||
336 | 344 | MockCallsMatch( | ||
337 | 345 | # One call to change the power state. | ||
338 | 346 | call(power_change=power_change, **context), | ||
339 | 347 | # One call to query the power state. | ||
340 | 348 | call(power_change='query', **context), | ||
341 | 349 | ), | ||
342 | 350 | ) | ||
343 | 351 | # The node hasn't been marked broken. | ||
344 | 352 | self.assertThat(markNodeBroken, MockNotCalled()) | ||
345 | 353 | |||
346 | 354 | @inlineCallbacks | ||
347 | 324 | def test_change_power_state_marks_the_node_broken_if_failure(self): | 355 | def test_change_power_state_marks_the_node_broken_if_failure(self): |
348 | 325 | system_id = factory.make_name('system_id') | 356 | system_id = factory.make_name('system_id') |
349 | 326 | hostname = factory.make_name('hostname') | 357 | hostname = factory.make_name('hostname') |
350 | @@ -546,6 +577,29 @@ | |||
351 | 546 | self.assertThat( | 577 | self.assertThat( |
352 | 547 | power_state_update, MockCalledOnceWith(system_id, power_state)) | 578 | power_state_update, MockCalledOnceWith(system_id, power_state)) |
353 | 548 | 579 | ||
354 | 580 | def test_get_power_state_changes_power_state_if_unknown(self): | ||
355 | 581 | system_id = factory.make_name('system_id') | ||
356 | 582 | hostname = factory.make_name('hostname') | ||
357 | 583 | power_state = "unknown" | ||
358 | 584 | power_type = random.choice(power.QUERY_POWER_TYPES) | ||
359 | 585 | context = { | ||
360 | 586 | factory.make_name('context-key'): factory.make_name('context-val') | ||
361 | 587 | } | ||
362 | 588 | self.patch(power, 'pause') | ||
363 | 589 | power_state_update = self.patch_autospec(power, 'power_state_update') | ||
364 | 590 | |||
365 | 591 | # Simulate success. | ||
366 | 592 | power_action, execute = patch_power_action( | ||
367 | 593 | self, return_value=power_state) | ||
368 | 594 | _, _, io = self.patch_rpc_methods() | ||
369 | 595 | |||
370 | 596 | d = power.get_power_state( | ||
371 | 597 | system_id, hostname, power_type, context) | ||
372 | 598 | io.flush() | ||
373 | 599 | self.assertEqual(power_state, extract_result(d)) | ||
374 | 600 | self.assertThat( | ||
375 | 601 | power_state_update, MockCalledOnceWith(system_id, power_state)) | ||
376 | 602 | |||
377 | 549 | def test_get_power_state_pauses_inbetween_retries(self): | 603 | def test_get_power_state_pauses_inbetween_retries(self): |
378 | 550 | system_id = factory.make_name('system_id') | 604 | system_id = factory.make_name('system_id') |
379 | 551 | hostname = factory.make_name('hostname') | 605 | hostname = factory.make_name('hostname') |
See comments inline!