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
|
# This file is part of cloud-init. See LICENSE file for license information.
import logging
import os
import shutil
import tempfile
from io import BytesIO
from pathlib import Path
from unittest import mock
from configobj import ConfigObj
from cloudinit import cloud, distros, helpers, util
from cloudinit.config import cc_set_hostname
from cloudinit.sources import DataSourceNone
from tests.unittests import helpers as t_help
LOG = logging.getLogger(__name__)
class TestHostname(t_help.FilesystemMockingTestCase):
with_logs = True
def setUp(self):
super(TestHostname, self).setUp()
self.tmp = tempfile.mkdtemp()
util.ensure_dir(os.path.join(self.tmp, "data"))
self.addCleanup(shutil.rmtree, self.tmp)
def _fetch_distro(self, kind, conf=None):
cls = distros.fetch(kind)
paths = helpers.Paths({"cloud_dir": self.tmp})
conf = {} if conf is None else conf
return cls(kind, conf, paths)
def test_debian_write_hostname_prefer_fqdn(self):
cfg = {
"hostname": "blah",
"prefer_fqdn_over_hostname": True,
"fqdn": "blah.yahoo.com",
}
distro = self._fetch_distro("debian", cfg)
paths = helpers.Paths({"cloud_dir": self.tmp})
ds = None
cc = cloud.Cloud(ds, paths, {}, distro, None)
self.patchUtils(self.tmp)
cc_set_hostname.handle("cc_set_hostname", cfg, cc, LOG, [])
contents = util.load_file("/etc/hostname")
self.assertEqual("blah.yahoo.com", contents.strip())
@mock.patch("cloudinit.distros.Distro.uses_systemd", return_value=False)
def test_rhel_write_hostname_prefer_hostname(self, m_uses_systemd):
cfg = {
"hostname": "blah",
"prefer_fqdn_over_hostname": False,
"fqdn": "blah.yahoo.com",
}
distro = self._fetch_distro("rhel", cfg)
paths = helpers.Paths({"cloud_dir": self.tmp})
ds = None
cc = cloud.Cloud(ds, paths, {}, distro, None)
self.patchUtils(self.tmp)
cc_set_hostname.handle("cc_set_hostname", cfg, cc, LOG, [])
contents = util.load_file("/etc/sysconfig/network", decode=False)
n_cfg = ConfigObj(BytesIO(contents))
self.assertEqual({"HOSTNAME": "blah"}, dict(n_cfg))
@mock.patch("cloudinit.distros.Distro.uses_systemd", return_value=False)
def test_write_hostname_rhel(self, m_uses_systemd):
cfg = {"hostname": "blah", "fqdn": "blah.blah.blah.yahoo.com"}
distro = self._fetch_distro("rhel")
paths = helpers.Paths({"cloud_dir": self.tmp})
ds = None
cc = cloud.Cloud(ds, paths, {}, distro, None)
self.patchUtils(self.tmp)
cc_set_hostname.handle("cc_set_hostname", cfg, cc, LOG, [])
contents = util.load_file("/etc/sysconfig/network", decode=False)
n_cfg = ConfigObj(BytesIO(contents))
self.assertEqual({"HOSTNAME": "blah.blah.blah.yahoo.com"}, dict(n_cfg))
def test_write_hostname_debian(self):
cfg = {
"hostname": "blah",
"fqdn": "blah.blah.blah.yahoo.com",
}
distro = self._fetch_distro("debian")
paths = helpers.Paths({"cloud_dir": self.tmp})
ds = None
cc = cloud.Cloud(ds, paths, {}, distro, None)
self.patchUtils(self.tmp)
cc_set_hostname.handle("cc_set_hostname", cfg, cc, LOG, [])
contents = util.load_file("/etc/hostname")
self.assertEqual("blah", contents.strip())
@mock.patch("cloudinit.distros.Distro.uses_systemd", return_value=False)
def test_write_hostname_sles(self, m_uses_systemd):
cfg = {
"hostname": "blah.blah.blah.suse.com",
}
distro = self._fetch_distro("sles")
paths = helpers.Paths({"cloud_dir": self.tmp})
ds = None
cc = cloud.Cloud(ds, paths, {}, distro, None)
self.patchUtils(self.tmp)
cc_set_hostname.handle("cc_set_hostname", cfg, cc, LOG, [])
contents = util.load_file(distro.hostname_conf_fn)
self.assertEqual("blah", contents.strip())
@mock.patch("cloudinit.distros.photon.subp.subp")
def test_photon_hostname(self, m_subp):
cfg1 = {
"hostname": "photon",
"prefer_fqdn_over_hostname": True,
"fqdn": "test1.vmware.com",
}
cfg2 = {
"hostname": "photon",
"prefer_fqdn_over_hostname": False,
"fqdn": "test2.vmware.com",
}
ds = None
m_subp.return_value = (None, None)
distro = self._fetch_distro("photon", cfg1)
paths = helpers.Paths({"cloud_dir": self.tmp})
cc = cloud.Cloud(ds, paths, {}, distro, None)
for c in [cfg1, cfg2]:
cc_set_hostname.handle("cc_set_hostname", c, cc, LOG, [])
print("\n", m_subp.call_args_list)
if c["prefer_fqdn_over_hostname"]:
assert [
mock.call(
["hostnamectl", "set-hostname", c["fqdn"]],
capture=True,
)
] in m_subp.call_args_list
assert [
mock.call(
["hostnamectl", "set-hostname", c["hostname"]],
capture=True,
)
] not in m_subp.call_args_list
else:
assert [
mock.call(
["hostnamectl", "set-hostname", c["hostname"]],
capture=True,
)
] in m_subp.call_args_list
assert [
mock.call(
["hostnamectl", "set-hostname", c["fqdn"]],
capture=True,
)
] not in m_subp.call_args_list
@mock.patch("cloudinit.util.get_hostname", return_value="localhost")
def test_multiple_calls_skips_unchanged_hostname(self, get_hostname):
"""Only new hostname or fqdn values will generate a hostname call."""
distro = self._fetch_distro("debian")
paths = helpers.Paths({"cloud_dir": self.tmp})
ds = None
cc = cloud.Cloud(ds, paths, {}, distro, None)
self.patchUtils(self.tmp)
cc_set_hostname.handle(
"cc_set_hostname", {"hostname": "hostname1.me.com"}, cc, LOG, []
)
contents = util.load_file("/etc/hostname")
self.assertEqual("hostname1", contents.strip())
cc_set_hostname.handle(
"cc_set_hostname", {"hostname": "hostname1.me.com"}, cc, LOG, []
)
self.assertIn(
"DEBUG: No hostname changes. Skipping set-hostname\n",
self.logs.getvalue(),
)
cc_set_hostname.handle(
"cc_set_hostname", {"hostname": "hostname2.me.com"}, cc, LOG, []
)
contents = util.load_file("/etc/hostname")
self.assertEqual("hostname2", contents.strip())
self.assertIn(
"Non-persistently setting the system hostname to hostname2",
self.logs.getvalue(),
)
@mock.patch("cloudinit.util.get_hostname", return_value="localhost")
def test_localhost_default_hostname(self, get_hostname):
"""
No hostname set. Default value returned is localhost,
but we shouldn't write it in /etc/hostname
"""
distro = self._fetch_distro("debian")
paths = helpers.Paths({"cloud_dir": self.tmp})
ds = DataSourceNone.DataSourceNone({}, None, paths)
cc = cloud.Cloud(ds, paths, {}, distro, None)
self.patchUtils(self.tmp)
util.write_file("/etc/hostname", "")
cc_set_hostname.handle("cc_set_hostname", {}, cc, LOG, [])
contents = util.load_file("/etc/hostname")
self.assertEqual("", contents.strip())
@mock.patch("cloudinit.util.get_hostname", return_value="localhost")
def test_localhost_user_given_hostname(self, get_hostname):
"""
User set hostname is localhost. We should write it in /etc/hostname
"""
distro = self._fetch_distro("debian")
paths = helpers.Paths({"cloud_dir": self.tmp})
ds = DataSourceNone.DataSourceNone({}, None, paths)
cc = cloud.Cloud(ds, paths, {}, distro, None)
self.patchUtils(self.tmp)
# user-provided localhost should not be ignored
util.write_file("/etc/hostname", "")
cc_set_hostname.handle(
"cc_set_hostname", {"hostname": "localhost"}, cc, LOG, []
)
contents = util.load_file("/etc/hostname")
self.assertEqual("localhost", contents.strip())
def test_error_on_distro_set_hostname_errors(self):
"""Raise SetHostnameError on exceptions from distro.set_hostname."""
distro = self._fetch_distro("debian")
def set_hostname_error(hostname, fqdn):
raise Exception("OOPS on: %s" % fqdn)
distro.set_hostname = set_hostname_error
paths = helpers.Paths({"cloud_dir": self.tmp})
ds = None
cc = cloud.Cloud(ds, paths, {}, distro, None)
self.patchUtils(self.tmp)
with self.assertRaises(cc_set_hostname.SetHostnameError) as ctx_mgr:
cc_set_hostname.handle(
"somename", {"hostname": "hostname1.me.com"}, cc, LOG, []
)
self.assertEqual(
"Failed to set the hostname to hostname1.me.com (hostname1):"
" OOPS on: hostname1.me.com",
str(ctx_mgr.exception),
)
def test_ignore_empty_previous_artifact_file(self):
cfg = {
"hostname": "blah",
"fqdn": "blah.blah.blah.yahoo.com",
}
distro = self._fetch_distro("debian")
paths = helpers.Paths({"cloud_dir": self.tmp})
ds = None
cc = cloud.Cloud(ds, paths, {}, distro, None)
self.patchUtils(self.tmp)
prev_fn = Path(cc.get_cpath("data")) / "set-hostname"
prev_fn.touch()
cc_set_hostname.handle("cc_set_hostname", cfg, cc, LOG, [])
contents = util.load_file("/etc/hostname")
self.assertEqual("blah", contents.strip())
# vi: ts=4 expandtab
|
