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
|
# This file is part of cloud-init. See LICENSE file for license information.
"""Tests for cloud-id command line utility."""
import pytest
from cloudinit import atomic_helper
from cloudinit.cmd import cloud_id, status
from cloudinit.helpers import Paths
from tests.unittests.helpers import mock
M_PATH = "cloudinit.cmd.cloud_id."
STATUS_DETAILS_DONE = status.StatusDetails(
status.RunningStatus.DONE,
status.ConditionStatus.PEACHY,
status.EnabledStatus.UNKNOWN,
"DataSourceNoCloud somedetail",
[],
{},
"",
"nocloud",
{},
)
STATUS_DETAILS_DISABLED = status.StatusDetails(
status.RunningStatus.DISABLED,
status.ConditionStatus.PEACHY,
status.EnabledStatus.DISABLED_BY_GENERATOR,
"DataSourceNoCloud somedetail",
[],
{},
"",
"",
{},
)
STATUS_DETAILS_NOT_STARTED = status.StatusDetails(
status.RunningStatus.NOT_STARTED,
status.ConditionStatus.PEACHY,
status.EnabledStatus.UNKNOWN,
"",
[],
{},
"",
"",
{},
)
STATUS_DETAILS_RUNNING = status.StatusDetails(
status.RunningStatus.RUNNING,
status.ConditionStatus.PEACHY,
status.EnabledStatus.UNKNOWN,
"",
[],
{},
"",
"",
{},
)
STATUS_DETAILS_RUNNING_DS_NONE = status.StatusDetails(
status.RunningStatus.RUNNING,
status.ConditionStatus.PEACHY,
status.EnabledStatus.UNKNOWN,
"",
[],
{},
"",
None,
{},
)
@pytest.fixture(autouse=True)
def setup_mocks(mocker):
mocker.patch(
"cloudinit.cmd.cloud_id.read_cfg_paths", return_value=Paths({})
)
class TestCloudId:
def test_cloud_id_arg_parser_defaults(self):
"""Validate the argument defaults when not provided by the end-user."""
cmd = ["cloud-id"]
with mock.patch("sys.argv", cmd):
args = cloud_id.get_parser().parse_args()
assert "/run/cloud-init/instance-data.json" == args.instance_data
assert False is args.long
assert False is args.json
def test_cloud_id_arg_parse_overrides(self, tmpdir):
"""Override argument defaults by specifying values for each param."""
instance_data = tmpdir.join("instance-data.json")
instance_data.write("{}")
cmd = [
"cloud-id",
"--instance-data",
instance_data.strpath,
"--long",
"--json",
]
with mock.patch("sys.argv", cmd):
args = cloud_id.get_parser().parse_args()
assert instance_data.strpath == args.instance_data
assert True is args.long
assert True is args.json
@mock.patch(M_PATH + "get_status_details")
def test_cloud_id_missing_instance_data_json(
self, get_status_details, tmpdir, capsys
):
"""Exit error when the provided instance-data.json does not exist."""
get_status_details.return_value = STATUS_DETAILS_DONE
instance_data = tmpdir.join("instance-data.json")
cmd = ["cloud-id", "--instance-data", instance_data.strpath]
with mock.patch("sys.argv", cmd):
with pytest.raises(SystemExit) as context_manager:
cloud_id.main()
assert 1 == context_manager.value.code
_out, err = capsys.readouterr()
assert "Error:\nFile not found '%s'" % instance_data.strpath in err
@mock.patch(M_PATH + "get_status_details")
def test_cloud_id_non_json_instance_data(
self, get_status_details, tmpdir, capsys
):
"""Exit error when the provided instance-data.json is not json."""
get_status_details.return_value = STATUS_DETAILS_DONE
instance_data = tmpdir.join("instance-data.json")
cmd = ["cloud-id", "--instance-data", instance_data.strpath]
instance_data.write("{")
with mock.patch("sys.argv", cmd):
with pytest.raises(SystemExit) as context_manager:
cloud_id.main()
assert 1 == context_manager.value.code
_out, err = capsys.readouterr()
assert (
"Error:\nFile '%s' is not valid json." % instance_data.strpath
in err
)
@mock.patch(M_PATH + "get_status_details")
def test_cloud_id_from_cloud_name_in_instance_data(
self, get_status_details, tmpdir, capsys
):
"""Report canonical cloud-id from cloud_name in instance-data."""
instance_data = tmpdir.join("instance-data.json")
get_status_details.return_value = STATUS_DETAILS_DONE
instance_data.write(
'{"v1": {"cloud_name": "mycloud", "region": "somereg"}}',
)
cmd = ["cloud-id", "--instance-data", instance_data.strpath]
with mock.patch("sys.argv", cmd):
with pytest.raises(SystemExit) as context_manager:
cloud_id.main()
assert 0 == context_manager.value.code
out, _err = capsys.readouterr()
assert "mycloud\n" == out
@mock.patch(M_PATH + "get_status_details")
def test_cloud_id_long_name_from_instance_data(
self, get_status_details, tmpdir, capsys
):
"""Report long cloud-id format from cloud_name and region."""
get_status_details.return_value = STATUS_DETAILS_DONE
instance_data = tmpdir.join("instance-data.json")
instance_data.write(
'{"v1": {"cloud_name": "mycloud", "region": "somereg"}}',
)
cmd = ["cloud-id", "--instance-data", instance_data.strpath, "--long"]
with mock.patch("sys.argv", cmd):
with pytest.raises(SystemExit) as context_manager:
cloud_id.main()
out, _err = capsys.readouterr()
assert 0 == context_manager.value.code
assert "mycloud\tsomereg\n" == out
@mock.patch(M_PATH + "get_status_details")
def test_cloud_id_lookup_from_instance_data_region(
self, get_status_details, tmpdir, capsys
):
"""Report discovered canonical cloud_id when region lookup matches."""
get_status_details.return_value = STATUS_DETAILS_DONE
instance_data = tmpdir.join("instance-data.json")
instance_data.write(
'{"v1": {"cloud_name": "aws", "region": "cn-north-1",'
' "platform": "ec2"}}',
)
cmd = ["cloud-id", "--instance-data", instance_data.strpath, "--long"]
with mock.patch("sys.argv", cmd):
with pytest.raises(SystemExit) as context_manager:
cloud_id.main()
assert 0 == context_manager.value.code
out, _err = capsys.readouterr()
assert "aws-china\tcn-north-1\n" == out
@mock.patch(M_PATH + "get_status_details")
def test_cloud_id_lookup_json_instance_data_adds_cloud_id_to_json(
self, get_status_details, tmpdir, capsys
):
"""Report v1 instance-data content with cloud_id when --json set."""
get_status_details.return_value = STATUS_DETAILS_DONE
instance_data = tmpdir.join("instance-data.json")
instance_data.write(
'{"v1": {"cloud_name": "unknown", "region": "dfw",'
' "platform": "openstack", "public_ssh_keys": []}}',
)
expected = atomic_helper.json_dumps(
{
"cloud_id": "openstack",
"cloud_name": "unknown",
"platform": "openstack",
"public_ssh_keys": [],
"region": "dfw",
}
)
cmd = ["cloud-id", "--instance-data", instance_data.strpath, "--json"]
with mock.patch("sys.argv", cmd):
with pytest.raises(SystemExit) as context_manager:
cloud_id.main()
out, err = capsys.readouterr()
assert "DEPRECATED: Use: cloud-init query v1\n" == err
assert 0 == context_manager.value.code
assert expected + "\n" == out
@pytest.mark.parametrize(
"details, exit_code",
(
(STATUS_DETAILS_DISABLED, 2),
(STATUS_DETAILS_NOT_STARTED, 3),
(STATUS_DETAILS_RUNNING, 0),
(STATUS_DETAILS_RUNNING_DS_NONE, 0),
),
)
@mock.patch(M_PATH + "get_status_details")
def test_cloud_id_unique_exit_codes_for_status(
self,
get_status_details,
details: status.StatusDetails,
exit_code,
tmpdir,
capsys,
):
"""cloud-id returns unique exit codes for status."""
get_status_details.return_value = details
instance_data = tmpdir.join("instance-data.json")
if details.running_status == cloud_id.RunningStatus.RUNNING:
instance_data.write("{}")
cmd = ["cloud-id", "--instance-data", instance_data.strpath, "--json"]
with mock.patch("sys.argv", cmd):
with pytest.raises(SystemExit) as context_manager:
cloud_id.main()
assert exit_code == context_manager.value.code
|
