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
|
# This file is part of cloud-init. See LICENSE file for license information.
import sys
import pytest
from cloudinit import distros, helpers
from cloudinit.config import cc_power_state_change as psc
from cloudinit.config.schema import (
SchemaValidationError,
get_schema,
validate_cloudconfig_schema,
)
from tests.unittests import helpers as t_help
from tests.unittests.helpers import mock, skipUnlessJsonSchema
class TestLoadPowerState(t_help.TestCase):
def setUp(self):
super(TestLoadPowerState, self).setUp()
cls = distros.fetch("ubuntu")
paths = helpers.Paths({})
self.dist = cls("ubuntu", {}, paths)
def test_no_config(self):
# completely empty config should mean do nothing
(cmd, _timeout, _condition) = psc.load_power_state({}, self.dist)
self.assertIsNone(cmd)
def test_irrelevant_config(self):
# no power_state field in config should return None for cmd
(cmd, _timeout, _condition) = psc.load_power_state(
{"foo": "bar"}, self.dist
)
self.assertIsNone(cmd)
def test_invalid_mode(self):
cfg = {"power_state": {"mode": "gibberish"}}
self.assertRaises(TypeError, psc.load_power_state, cfg, self.dist)
cfg = {"power_state": {"mode": ""}}
self.assertRaises(TypeError, psc.load_power_state, cfg, self.dist)
def test_empty_mode(self):
cfg = {"power_state": {"message": "goodbye"}}
self.assertRaises(TypeError, psc.load_power_state, cfg, self.dist)
def test_valid_modes(self):
cfg = {"power_state": {}}
for mode in ("halt", "poweroff", "reboot"):
cfg["power_state"]["mode"] = mode
check_lps_ret(psc.load_power_state(cfg, self.dist), mode=mode)
def test_invalid_delay(self):
cfg = {"power_state": {"mode": "poweroff", "delay": "goodbye"}}
self.assertRaises(TypeError, psc.load_power_state, cfg, self.dist)
def test_valid_delay(self):
cfg = {"power_state": {"mode": "poweroff", "delay": ""}}
for delay in ("now", "+1", "+30"):
cfg["power_state"]["delay"] = delay
check_lps_ret(psc.load_power_state(cfg, self.dist))
def test_message_present(self):
cfg = {"power_state": {"mode": "poweroff", "message": "GOODBYE"}}
ret = psc.load_power_state(cfg, self.dist)
check_lps_ret(psc.load_power_state(cfg, self.dist))
self.assertIn(cfg["power_state"]["message"], ret[0])
def test_no_message(self):
# if message is not present, then no argument should be passed for it
cfg = {"power_state": {"mode": "poweroff"}}
(cmd, _timeout, _condition) = psc.load_power_state(cfg, self.dist)
self.assertNotIn("", cmd)
check_lps_ret(psc.load_power_state(cfg, self.dist))
self.assertTrue(len(cmd) == 3)
def test_condition_null_raises(self):
cfg = {"power_state": {"mode": "poweroff", "condition": None}}
self.assertRaises(TypeError, psc.load_power_state, cfg, self.dist)
def test_condition_default_is_true(self):
cfg = {"power_state": {"mode": "poweroff"}}
_cmd, _timeout, cond = psc.load_power_state(cfg, self.dist)
self.assertEqual(cond, True)
def test_freebsd_poweroff_uses_lowercase_p(self):
with mock.patch(
"cloudinit.distros.networking.subp.subp",
return_value=("", None),
):
cls = distros.fetch("freebsd")
paths = helpers.Paths({})
freebsd = cls("freebsd", {}, paths)
cfg = {"power_state": {"mode": "poweroff"}}
ret = psc.load_power_state(cfg, freebsd)
self.assertIn("-p", ret[0])
def test_alpine_delay(self):
# alpine takes delay in seconds.
cls = distros.fetch("alpine")
paths = helpers.Paths({})
alpine = cls("alpine", {}, paths)
cfg = {"power_state": {"mode": "poweroff", "delay": ""}}
for delay, value in (("now", 0), ("+1", 60), ("+30", 1800)):
cfg["power_state"]["delay"] = delay
ret = psc.load_power_state(cfg, alpine)
self.assertEqual("-d", ret[0][1])
self.assertEqual(str(value), ret[0][2])
class TestCheckCondition(t_help.TestCase):
def cmd_with_exit(self, rc):
return [sys.executable, "-c", "import sys; sys.exit(%s)" % rc]
def test_true_is_true(self):
self.assertEqual(psc.check_condition(True), True)
def test_false_is_false(self):
self.assertEqual(psc.check_condition(False), False)
def test_cmd_exit_zero_true(self):
self.assertEqual(psc.check_condition(self.cmd_with_exit(0)), True)
def test_cmd_exit_one_false(self):
self.assertEqual(psc.check_condition(self.cmd_with_exit(1)), False)
def test_cmd_exit_nonzero_warns(self):
mocklog = mock.Mock()
self.assertEqual(
psc.check_condition(self.cmd_with_exit(2), mocklog), False
)
self.assertEqual(mocklog.warning.call_count, 1)
def check_lps_ret(psc_return, mode=None):
if len(psc_return) != 3:
raise TypeError("length returned = %d" % len(psc_return))
errs = []
cmd = psc_return[0]
timeout = psc_return[1]
condition = psc_return[2]
if "shutdown" not in psc_return[0][0]:
errs.append("string 'shutdown' not in cmd")
if condition is None:
errs.append("condition was not returned")
if mode is not None:
opt = {"halt": "-H", "poweroff": "-P", "reboot": "-r"}[mode]
if opt not in psc_return[0]:
errs.append("opt '%s' not in cmd: %s" % (opt, cmd))
if len(cmd) != 3 and len(cmd) != 4:
errs.append("Invalid command length: %s" % len(cmd))
try:
float(timeout)
except Exception:
errs.append("timeout failed convert to float")
if len(errs):
lines = ["Errors in result: %s" % str(psc_return)] + errs
raise RuntimeError("\n".join(lines))
class TestPowerStateChangeSchema:
@pytest.mark.parametrize(
"config, error_msg",
[
# Invalid mode
(
{"power_state": {"mode": "test"}},
r"'test' is not one of \['poweroff', 'reboot', 'halt'\]",
),
# Delay can be a number, a +number, or "now"
(
{"power_state": {"mode": "halt", "delay": "5"}},
(
"Cloud config schema deprecations: "
"power_state.delay: Changed in version 22.3. Use "
"of type string for this value is deprecated. Use "
"``now`` or integer type."
),
),
({"power_state": {"mode": "halt", "delay": "now"}}, None),
(
{"power_state": {"mode": "halt", "delay": "+5"}},
(
"Cloud config schema deprecations: "
"power_state.delay: Changed in version 22.3. Use "
"of type string for this value is deprecated. Use "
"``now`` or integer type."
),
),
({"power_state": {"mode": "halt", "delay": "+"}}, ""),
({"power_state": {"mode": "halt", "delay": "++5"}}, ""),
({"power_state": {"mode": "halt", "delay": "-5"}}, ""),
({"power_state": {"mode": "halt", "delay": "test"}}, ""),
# Condition
({"power_state": {"mode": "halt", "condition": False}}, None),
({"power_state": {"mode": "halt", "condition": "ls /tmp"}}, None),
(
{"power_state": {"mode": "halt", "condition": ["ls", "/tmp"]}},
None,
),
({"power_state": {"mode": "halt", "condition": 5}}, ""),
],
)
@skipUnlessJsonSchema()
def test_schema_validation(self, config, error_msg):
if error_msg is None:
validate_cloudconfig_schema(config, get_schema(), strict=True)
else:
with pytest.raises(SchemaValidationError, match=error_msg):
validate_cloudconfig_schema(config, get_schema(), strict=True)
# vi: ts=4 expandtab
|
