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
|
# Copyright 2017 IBM Corp.
#
# 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.
import mock
import testtools
import pypowervm.exceptions as exc
import pypowervm.tasks.power_opts as popts
import pypowervm.wrappers.base_partition as bp
class TestPowerOpts(testtools.TestCase):
def _test_enum(self, enum):
"""Validate that an enum class has a KEY and proper ALL_VALUES.
:param enum: Enumeration class.
"""
# Get the public symbols in the enum
syms = {sym for sym in dir(enum) if not sym.startswith('_')}
# Must have a KEY
self.assertIn('KEY', syms)
self.assertIsNotNone(getattr(enum, 'KEY'))
syms.remove('KEY')
# Must have ALL_VALUES
self.assertIn('ALL_VALUES', syms)
syms.remove('ALL_VALUES')
# ALL_VALUES must include all the values that aren't KEY or ALL_VALUES
self.assertEqual({getattr(enum, sym) for sym in syms},
set(enum.ALL_VALUES))
def test_enums(self):
self._test_enum(popts.IPLSrc)
self._test_enum(popts.BootMode)
self._test_enum(popts.KeylockPos)
self._test_enum(popts.IBMiOperationType)
self._test_enum(popts.PowerOffOperation)
def test_remove_optical(self):
knm = popts.RemoveOptical.KEY_NAME
ktm = popts.RemoveOptical.KEY_TIME
# Default time
self.assertEqual({knm: 'name', ktm: 0},
popts.RemoveOptical.bld_map('name'))
# Explicit time
self.assertEqual({knm: 'name', ktm: 10},
popts.RemoveOptical.bld_map('name', time=10))
def test_power_on_opts(self):
# Default init
poo = popts.PowerOnOpts()
self.assertEqual('PowerOn()', str(poo))
self.assertEqual('PowerOn', poo.JOB_SUFFIX)
# Legacy add_parms init
poo = popts.PowerOnOpts(legacy_add_parms=dict(foo=1, bar=2))
self.assertEqual('PowerOn(bar=2, foo=1)', str(poo))
# Carry those additional params forward to make sure they don't vanish
# Enum validation
for meth in ('bootmode', 'keylock_pos', 'ibmi_ipl_source',
'ibmi_op_type'):
self.assertRaises(exc.InvalidEnumValue, getattr(poo, meth), 'foo')
# Set specific (valid) values
# Setter method returns the instance
self.assertIs(poo, poo.bootmode(popts.BootMode.NORM))
self.assertEqual('PowerOn(bar=2, bootmode=norm, foo=1)', str(poo))
self.assertIs(poo, poo.keylock_pos(popts.KeylockPos.MANUAL))
self.assertEqual(
'PowerOn(bar=2, bootmode=norm, foo=1, keylock=manual)', str(poo))
self.assertIs(poo, poo.bootstring('canvas cord with aglet'))
self.assertEqual(
'PowerOn(bar=2, bootmode=norm, bootstring=canvas cord with aglet, '
'foo=1, keylock=manual)', str(poo))
# Make sure overwrite works
self.assertIs(poo, poo.bootstring('sturdy shoelace'))
self.assertEqual(
'PowerOn(bar=2, bootmode=norm, bootstring=sturdy shoelace, foo=1, '
'keylock=manual)', str(poo))
self.assertIs(poo, poo.force())
self.assertEqual(
'PowerOn(bar=2, bootmode=norm, bootstring=sturdy shoelace, foo=1, '
'force=true, keylock=manual)', str(poo))
# Turning off force gets rid of the key
self.assertIs(poo, poo.force(value=False))
self.assertEqual(
'PowerOn(bar=2, bootmode=norm, bootstring=sturdy shoelace, foo=1, '
'keylock=manual)', str(poo))
# Remove optical with default time
self.assertIs(poo, poo.remove_optical('vopt'))
self.assertEqual(
'PowerOn(bar=2, bootmode=norm, bootstring=sturdy shoelace, foo=1, '
'keylock=manual, remove_optical_name=vopt, remove_optical_time=0)',
str(poo))
# Remove optical with explicit time. Values are overwritten.
self.assertIs(poo, poo.remove_optical('VOPT', time=5))
self.assertEqual(
'PowerOn(bar=2, bootmode=norm, bootstring=sturdy shoelace, foo=1, '
'keylock=manual, remove_optical_name=VOPT, remove_optical_time=5)',
str(poo))
self.assertIs(poo, poo.ibmi_ipl_source(popts.IPLSrc.A))
self.assertEqual(
'PowerOn(bar=2, bootmode=norm, bootstring=sturdy shoelace, foo=1, '
'iIPLsource=a, keylock=manual, remove_optical_name=VOPT, '
'remove_optical_time=5)', str(poo))
self.assertIs(poo, poo.ibmi_op_type(popts.IBMiOperationType.NETBOOT))
self.assertEqual(
'PowerOn(OperationType=netboot, bar=2, bootmode=norm, '
'bootstring=sturdy shoelace, foo=1, iIPLsource=a, keylock=manual, '
'remove_optical_name=VOPT, remove_optical_time=5)', str(poo))
# Netboot params.
poo = popts.PowerOnOpts().ibmi_netboot_params(
'ip', 'serverip', 'gateway', 'serverdir')
self.assertEqual(
'PowerOn(Gateway=gateway, IBMiImageServerDirectory=serverdir, '
'IPAddress=ip, ServerIPAddress=serverip)', str(poo))
# Optional netboot params, and overwrites
self.assertIs(poo, poo.ibmi_netboot_params(
'IP', 'ServerIP', 'Gateway', 'ServerDir', vlanid=2, mtu='mtu',
duplex='duplex', connspeed=100, subnet='subnet'))
self.assertEqual(
'PowerOn(ConnectionSpeed=100, DuplexMode=duplex, Gateway=Gateway, '
'IBMiImageServerDirectory=ServerDir, IPAddress=IP, '
'MaximumTransmissionUnit=mtu, ServerIPAddress=ServerIP, '
'SubnetMask=subnet, VLANID=2)', str(poo))
def test_power_off_opts(self):
# Can OS shutdown?
ltyp = bp.LPARType
rmcs = bp.RMCState
for env, rmc, exp in ((ltyp.AIXLINUX, rmcs.ACTIVE, True),
(ltyp.AIXLINUX, rmcs.BUSY, False),
(ltyp.AIXLINUX, rmcs.INACTIVE, False),
(ltyp.OS400, rmcs.ACTIVE, True),
(ltyp.OS400, rmcs.BUSY, True),
(ltyp.OS400, rmcs.INACTIVE, True),
(ltyp.VIOS, rmcs.ACTIVE, True),
(ltyp.VIOS, rmcs.BUSY, False),
(ltyp.VIOS, rmcs.INACTIVE, False)):
self.assertEqual(exp, popts.PowerOffOpts.can_os_shutdown(
mock.Mock(env=env, rmc_state=rmc)))
# Default init
poo = popts.PowerOffOpts()
self.assertEqual('PowerOff()', str(poo))
self.assertEqual('PowerOff', poo.JOB_SUFFIX)
self.assertFalse(poo.is_param_set(popts.PowerOffOperation.KEY))
# Legacy add_parms init. Unknown keys are ignored.
poo = popts.PowerOffOpts(
legacy_add_parms=dict(operation='shutdown', foo=1, restart='true',
bar=2, immediate='true'))
self.assertEqual(
'PowerOff(immediate=true, operation=shutdown, restart=true)',
str(poo))
self.assertTrue(poo.is_immediate)
self.assertTrue(poo.is_restart)
self.assertFalse(poo.is_os)
self.assertTrue(poo.is_param_set(popts.PowerOffOperation.KEY))
# Now an "empty" one
poo = popts.PowerOffOpts(legacy_add_parms=dict(foo=1, bar=2))
self.assertEqual('PowerOff()', str(poo))
self.assertFalse(poo.is_immediate)
self.assertFalse(poo.is_restart)
self.assertFalse(poo.is_os)
self.assertFalse(poo.is_param_set(popts.PowerOffOperation.KEY))
# Immediate
self.assertIs(poo, poo.immediate())
self.assertEqual('PowerOff(immediate=true)', str(poo))
self.assertTrue(poo.is_immediate)
self.assertFalse(poo.is_restart)
self.assertFalse(poo.is_os)
self.assertFalse(poo.is_param_set(popts.PowerOffOperation.KEY))
# Restart
self.assertIs(poo, poo.restart())
self.assertEqual(
'PowerOff(immediate=true, restart=true)', str(poo))
self.assertTrue(poo.is_immediate)
self.assertTrue(poo.is_restart)
self.assertFalse(poo.is_os)
self.assertFalse(poo.is_param_set(popts.PowerOffOperation.KEY))
# Operation
self.assertIs(poo, poo.operation(popts.PowerOffOperation.DUMPRESTART))
self.assertEqual(
'PowerOff(immediate=true, operation=dumprestart, restart=true)',
str(poo))
self.assertTrue(poo.is_immediate)
self.assertTrue(poo.is_restart)
self.assertFalse(poo.is_os)
self.assertTrue(poo.is_param_set(popts.PowerOffOperation.KEY))
# OS shutdown
self.assertIs(poo, poo.operation(popts.PowerOffOperation.OS))
self.assertEqual(
'PowerOff(immediate=true, operation=osshutdown, restart=true)',
str(poo))
self.assertTrue(poo.is_immediate)
self.assertTrue(poo.is_restart)
self.assertTrue(poo.is_os)
self.assertTrue(poo.is_param_set(popts.PowerOffOperation.KEY))
# Booleans can be shut off
self.assertIs(poo, poo.immediate(value=False))
self.assertEqual('PowerOff(operation=osshutdown, restart=true)',
str(poo))
self.assertFalse(poo.is_immediate)
self.assertTrue(poo.is_restart)
self.assertTrue(poo.is_os)
self.assertIs(poo, poo.restart(value=False))
self.assertEqual('PowerOff(operation=osshutdown)', str(poo))
self.assertFalse(poo.is_immediate)
self.assertFalse(poo.is_restart)
self.assertTrue(poo.is_os)
# "Smart" methods. Make sure restart is preserved every time we change
poo.restart()
# OS immediate
self.assertIs(poo, poo.os_immediate())
self.assertEqual('PowerOff(immediate=true, operation=osshutdown, '
'restart=true)', str(poo))
self.assertTrue(poo.is_immediate)
self.assertTrue(poo.is_restart)
self.assertTrue(poo.is_os)
self.assertTrue(poo.is_param_set(popts.PowerOffOperation.KEY))
# OS normal (wipes out immediate)
self.assertIs(poo, poo.os_normal())
self.assertEqual('PowerOff(operation=osshutdown, restart=true)',
str(poo))
self.assertFalse(poo.is_immediate)
self.assertTrue(poo.is_restart)
self.assertTrue(poo.is_os)
self.assertTrue(poo.is_param_set(popts.PowerOffOperation.KEY))
# VSP hard
self.assertIs(poo, poo.vsp_hard())
self.assertEqual('PowerOff(immediate=true, operation=shutdown, '
'restart=true)', str(poo))
self.assertTrue(poo.is_immediate)
self.assertTrue(poo.is_restart)
self.assertFalse(poo.is_os)
self.assertTrue(poo.is_param_set(popts.PowerOffOperation.KEY))
# VSP normal (wipes out immediate)
self.assertIs(poo, poo.vsp_normal())
self.assertEqual('PowerOff(operation=shutdown, restart=true)',
str(poo))
self.assertFalse(poo.is_immediate)
self.assertTrue(poo.is_restart)
self.assertFalse(poo.is_os)
self.assertTrue(poo.is_param_set(popts.PowerOffOperation.KEY))
# Soft detect
part = mock.Mock(env=ltyp.AIXLINUX, rmc_state=rmcs.ACTIVE)
self.assertIs(poo, poo.soft_detect(part))
self.assertTrue(poo.is_os)
self.assertTrue(poo.is_immediate)
self.assertTrue(poo.is_restart)
self.assertTrue(poo.is_param_set(popts.PowerOffOperation.KEY))
# Explicit normal shutdown
self.assertIs(poo, poo.soft_detect(part, immed_if_os=False))
self.assertTrue(poo.is_os)
self.assertFalse(poo.is_immediate)
self.assertTrue(poo.is_restart)
self.assertTrue(poo.is_param_set(popts.PowerOffOperation.KEY))
# Explicit immediate OS shutdown
self.assertIs(poo, poo.soft_detect(part, immed_if_os=True))
self.assertTrue(poo.is_os)
self.assertTrue(poo.is_immediate)
self.assertTrue(poo.is_restart)
self.assertTrue(poo.is_param_set(popts.PowerOffOperation.KEY))
# Can't OS shutdown
part = mock.Mock(env=ltyp.VIOS, rmc_state=rmcs.BUSY)
self.assertIs(poo, poo.soft_detect(part))
self.assertFalse(poo.is_os)
self.assertFalse(poo.is_immediate)
self.assertTrue(poo.is_restart)
self.assertTrue(poo.is_param_set(popts.PowerOffOperation.KEY))
# immed_if_os ignored
self.assertIs(poo, poo.soft_detect(part, immed_if_os=True))
self.assertFalse(poo.is_os)
self.assertFalse(poo.is_immediate)
self.assertTrue(poo.is_restart)
self.assertIs(poo, poo.soft_detect(part, immed_if_os=False))
self.assertFalse(poo.is_os)
self.assertFalse(poo.is_immediate)
self.assertTrue(poo.is_restart)
self.assertEqual('PowerOff(operation=shutdown, restart=true)',
str(poo))
self.assertTrue(poo.is_param_set(popts.PowerOffOperation.KEY))
# IBMi defaults to OS normal
part = mock.Mock(env=ltyp.OS400, rmc_state=rmcs.INACTIVE)
self.assertIs(poo, poo.soft_detect(part))
self.assertTrue(poo.is_os)
self.assertFalse(poo.is_immediate)
self.assertTrue(poo.is_restart)
self.assertTrue(poo.is_param_set(popts.PowerOffOperation.KEY))
# Explicit immediate
self.assertIs(poo, poo.soft_detect(part, immed_if_os=True))
self.assertTrue(poo.is_os)
self.assertTrue(poo.is_immediate)
self.assertTrue(poo.is_restart)
self.assertTrue(poo.is_param_set(popts.PowerOffOperation.KEY))
|
