1
diff --git a/cloudinit/analyze/__main__.py b/cloudinit/analyze/__main__.py
2
index 69b9e43..3ba5903 100644
3
--- a/cloudinit/analyze/__main__.py
4
+++ b/cloudinit/analyze/__main__.py
5
@@ -6,6 +6,8 @@ import argparse
6
6
import re
6
import re
7
7
import sys
7
import sys
8
8
8
9
9
from cloudinit.util import json_dumps
10
10
11
9
from . import dump
11
from . import dump
12
10
from . import show
12
from . import show
13
11
13
14
@@ -112,7 +114,7 @@ def analyze_show(name, args):
15
112
def analyze_dump(name, args):
114
def analyze_dump(name, args):
16
113
    """Dump cloud-init events in json format"""
115
    """Dump cloud-init events in json format"""
17
114
    (infh, outfh) = configure_io(args)
116
    (infh, outfh) = configure_io(args)
19
115
    outfh.write(dump.json_dumps(_get_events(infh)) + '\n')
117
    outfh.write(json_dumps(_get_events(infh)) + '\n')
20
116
118
21
117
119
22
118
def _get_events(infile):
120
def _get_events(infile):
23
diff --git a/cloudinit/analyze/dump.py b/cloudinit/analyze/dump.py
24
index ca4da49..b071aa1 100644
25
--- a/cloudinit/analyze/dump.py
26
+++ b/cloudinit/analyze/dump.py
27
@@ -2,7 +2,6 @@
28
2
2
29
3
import calendar
3
import calendar
30
4
from datetime import datetime
4
from datetime import datetime
31
5
import json
32
6
import sys
5
import sys
33
7
6
34
8
from cloudinit import util
7
from cloudinit import util
35
@@ -132,11 +131,6 @@ def parse_ci_logline(line):
36
132
    return event
131
    return event
37
133
132
38
134
133
39
135
def json_dumps(data):
40
136
    return json.dumps(data, indent=1, sort_keys=True,
41
137
                      separators=(',', ': '))
42
138
43
139
44
140
def dump_events(cisource=None, rawdata=None):
134
def dump_events(cisource=None, rawdata=None):
45
141
    events = []
135
    events = []
46
142
    event = None
136
    event = None
47
@@ -169,7 +163,7 @@ def main():
48
169
    else:
163
    else:
49
170
        cisource = sys.stdin
164
        cisource = sys.stdin
50
171
165
52
172
    return json_dumps(dump_events(cisource))
166
    return util.json_dumps(dump_events(cisource))
53
173
167
54
174
168
55
175
if __name__ == "__main__":
169
if __name__ == "__main__":
56
diff --git a/cloudinit/net/tests/test_dhcp.py b/cloudinit/net/tests/test_dhcp.py
57
index fad4e49..db25b6f 100644
58
--- a/cloudinit/net/tests/test_dhcp.py
59
+++ b/cloudinit/net/tests/test_dhcp.py
60
@@ -8,12 +8,8 @@ from cloudinit.net.dhcp import (
61
8
    InvalidDHCPLeaseFileError, maybe_perform_dhcp_discovery,
8
    InvalidDHCPLeaseFileError, maybe_perform_dhcp_discovery,
62
9
    parse_dhcp_lease_file, dhcp_discovery, networkd_load_leases)
9
    parse_dhcp_lease_file, dhcp_discovery, networkd_load_leases)
63
10
from cloudinit.util import ensure_file, write_file
10
from cloudinit.util import ensure_file, write_file
64
11
<<<<<<< cloudinit/net/tests/test_dhcp.py
65
12
from cloudinit.tests.helpers import (
11
from cloudinit.tests.helpers import (
66
13
    CiTestCase, mock, populate_dir, wrap_and_call)
12
    CiTestCase, mock, populate_dir, wrap_and_call)
67
14
=======
68
15
from cloudinit.tests.helpers import CiTestCase
69
16
>>>>>>> cloudinit/net/tests/test_dhcp.py
70
17
13
71
18
14
72
19
class TestParseDHCPLeasesFile(CiTestCase):
15
class TestParseDHCPLeasesFile(CiTestCase):
73
diff --git a/cloudinit/sources/DataSourceAliYun.py b/cloudinit/sources/DataSourceAliYun.py
74
index 43a7e42..7ac8288 100644
75
--- a/cloudinit/sources/DataSourceAliYun.py
76
+++ b/cloudinit/sources/DataSourceAliYun.py
77
@@ -11,6 +11,7 @@ ALIYUN_PRODUCT = "Alibaba Cloud ECS"
78
11
11
79
12
class DataSourceAliYun(EC2.DataSourceEc2):
12
class DataSourceAliYun(EC2.DataSourceEc2):
80
13
13
81
14
    dsname = 'AliYun'
82
14
    metadata_urls = ['http://100.100.100.200']
15
    metadata_urls = ['http://100.100.100.200']
83
15
16
84
16
    # The minimum supported metadata_version from the ec2 metadata apis
17
    # The minimum supported metadata_version from the ec2 metadata apis
85
diff --git a/cloudinit/sources/DataSourceAltCloud.py b/cloudinit/sources/DataSourceAltCloud.py
86
index c78ad9e..be2d6cf 100644
87
--- a/cloudinit/sources/DataSourceAltCloud.py
88
+++ b/cloudinit/sources/DataSourceAltCloud.py
89
@@ -74,6 +74,9 @@ def read_user_data_callback(mount_dir):
90
74
74
91
75
75
92
76
class DataSourceAltCloud(sources.DataSource):
76
class DataSourceAltCloud(sources.DataSource):
93
77
94
78
    dsname = 'AltCloud'
95
79
96
77
    def __init__(self, sys_cfg, distro, paths):
80
    def __init__(self, sys_cfg, distro, paths):
97
78
        sources.DataSource.__init__(self, sys_cfg, distro, paths)
81
        sources.DataSource.__init__(self, sys_cfg, distro, paths)
98
79
        self.seed = None
82
        self.seed = None
99
@@ -112,7 +115,7 @@ class DataSourceAltCloud(sources.DataSource):
100
112
115
101
113
        return 'UNKNOWN'
116
        return 'UNKNOWN'
102
114
117
104
115
    def get_data(self):
118
    def _get_data(self):
105
116
        '''
119
        '''
106
117
        Description:
120
        Description:
107
118
            User Data is passed to the launching instance which
121
            User Data is passed to the launching instance which
108
diff --git a/cloudinit/sources/DataSourceAzure.py b/cloudinit/sources/DataSourceAzure.py
109
index 14367e9..6978d4e 100644
110
--- a/cloudinit/sources/DataSourceAzure.py
111
+++ b/cloudinit/sources/DataSourceAzure.py
112
@@ -246,6 +246,8 @@ def temporary_hostname(temp_hostname, cfg, hostname_command='hostname'):
113
246
246
114
247
247
115
248
class DataSourceAzure(sources.DataSource):
248
class DataSourceAzure(sources.DataSource):
116
249
117
250
    dsname = 'Azure'
118
249
    _negotiated = False
251
    _negotiated = False
119
250
252
120
251
    def __init__(self, sys_cfg, distro, paths):
253
    def __init__(self, sys_cfg, distro, paths):
121
@@ -330,7 +332,7 @@ class DataSourceAzure(sources.DataSource):
122
330
        metadata['public-keys'] = key_value or pubkeys_from_crt_files(fp_files)
332
        metadata['public-keys'] = key_value or pubkeys_from_crt_files(fp_files)
123
331
        return metadata
333
        return metadata
124
332
334
126
333
    def get_data(self):
335
    def _get_data(self):
127
334
        # azure removes/ejects the cdrom containing the ovf-env.xml
336
        # azure removes/ejects the cdrom containing the ovf-env.xml
128
335
        # file on reboot.  So, in order to successfully reboot we
337
        # file on reboot.  So, in order to successfully reboot we
129
336
        # need to look in the datadir and consider that valid
338
        # need to look in the datadir and consider that valid
130
diff --git a/cloudinit/sources/DataSourceBigstep.py b/cloudinit/sources/DataSourceBigstep.py
131
index d7fcd45..699a85b 100644
132
--- a/cloudinit/sources/DataSourceBigstep.py
133
+++ b/cloudinit/sources/DataSourceBigstep.py
134
@@ -16,13 +16,16 @@ LOG = logging.getLogger(__name__)
135
16
16
136
17
17
137
18
class DataSourceBigstep(sources.DataSource):
18
class DataSourceBigstep(sources.DataSource):
138
19
139
20
    dsname = 'Bigstep'
140
21
141
19
    def __init__(self, sys_cfg, distro, paths):
22
    def __init__(self, sys_cfg, distro, paths):
142
20
        sources.DataSource.__init__(self, sys_cfg, distro, paths)
23
        sources.DataSource.__init__(self, sys_cfg, distro, paths)
143
21
        self.metadata = {}
24
        self.metadata = {}
144
22
        self.vendordata_raw = ""
25
        self.vendordata_raw = ""
145
23
        self.userdata_raw = ""
26
        self.userdata_raw = ""
146
24
27
148
25
    def get_data(self, apply_filter=False):
28
    def _get_data(self, apply_filter=False):
149
26
        url = get_url_from_file()
29
        url = get_url_from_file()
150
27
        if url is None:
30
        if url is None:
151
28
            return False
31
            return False
152
diff --git a/cloudinit/sources/DataSourceCloudSigma.py b/cloudinit/sources/DataSourceCloudSigma.py
153
index 19df16b..4eaad47 100644
154
--- a/cloudinit/sources/DataSourceCloudSigma.py
155
+++ b/cloudinit/sources/DataSourceCloudSigma.py
156
@@ -23,6 +23,9 @@ class DataSourceCloudSigma(sources.DataSource):
157
23
    For more information about CloudSigma's Server Context:
23
    For more information about CloudSigma's Server Context:
158
24
    http://cloudsigma-docs.readthedocs.org/en/latest/server_context.html
24
    http://cloudsigma-docs.readthedocs.org/en/latest/server_context.html
159
25
    """
25
    """
160
26
161
27
    dsname = 'CloudSigma'
162
28
163
26
    def __init__(self, sys_cfg, distro, paths):
29
    def __init__(self, sys_cfg, distro, paths):
164
27
        self.cepko = Cepko()
30
        self.cepko = Cepko()
165
28
        self.ssh_public_key = ''
31
        self.ssh_public_key = ''
166
@@ -46,7 +49,7 @@ class DataSourceCloudSigma(sources.DataSource):
167
46
        LOG.warning("failed to query dmi data for system product name")
49
        LOG.warning("failed to query dmi data for system product name")
168
47
        return False
50
        return False
169
48
51
171
49
    def get_data(self):
52
    def _get_data(self):
172
50
        """
53
        """
173
51
        Metadata is the whole server context and /meta/cloud-config is used
54
        Metadata is the whole server context and /meta/cloud-config is used
174
52
        as userdata.
55
        as userdata.
175
diff --git a/cloudinit/sources/DataSourceCloudStack.py b/cloudinit/sources/DataSourceCloudStack.py
176
index 9dc473f..0df545f 100644
177
--- a/cloudinit/sources/DataSourceCloudStack.py
178
+++ b/cloudinit/sources/DataSourceCloudStack.py
179
@@ -65,6 +65,9 @@ class CloudStackPasswordServerClient(object):
180
65
65
181
66
66
182
67
class DataSourceCloudStack(sources.DataSource):
67
class DataSourceCloudStack(sources.DataSource):
183
68
184
69
    dsname = 'CloudStack'
185
70
186
68
    def __init__(self, sys_cfg, distro, paths):
71
    def __init__(self, sys_cfg, distro, paths):
187
69
        sources.DataSource.__init__(self, sys_cfg, distro, paths)
72
        sources.DataSource.__init__(self, sys_cfg, distro, paths)
188
70
        self.seed_dir = os.path.join(paths.seed_dir, 'cs')
73
        self.seed_dir = os.path.join(paths.seed_dir, 'cs')
189
@@ -117,7 +120,7 @@ class DataSourceCloudStack(sources.DataSource):
190
117
    def get_config_obj(self):
120
    def get_config_obj(self):
191
118
        return self.cfg
121
        return self.cfg
192
119
122
194
120
    def get_data(self):
123
    def _get_data(self):
195
121
        seed_ret = {}
124
        seed_ret = {}
196
122
        if util.read_optional_seed(seed_ret, base=(self.seed_dir + "/")):
125
        if util.read_optional_seed(seed_ret, base=(self.seed_dir + "/")):
197
123
            self.userdata_raw = seed_ret['user-data']
126
            self.userdata_raw = seed_ret['user-data']
198
diff --git a/cloudinit/sources/DataSourceConfigDrive.py b/cloudinit/sources/DataSourceConfigDrive.py
199
index ef374f3..870b368 100644
200
--- a/cloudinit/sources/DataSourceConfigDrive.py
201
+++ b/cloudinit/sources/DataSourceConfigDrive.py
202
@@ -32,6 +32,9 @@ OPTICAL_DEVICES = tuple(('/dev/%s%s' % (z, i) for z in POSSIBLE_MOUNTS
203
32
32
204
33
33
205
34
class DataSourceConfigDrive(openstack.SourceMixin, sources.DataSource):
34
class DataSourceConfigDrive(openstack.SourceMixin, sources.DataSource):
206
35
207
36
    dsname = 'ConfigDrive'
208
37
209
35
    def __init__(self, sys_cfg, distro, paths):
38
    def __init__(self, sys_cfg, distro, paths):
210
36
        super(DataSourceConfigDrive, self).__init__(sys_cfg, distro, paths)
39
        super(DataSourceConfigDrive, self).__init__(sys_cfg, distro, paths)
211
37
        self.source = None
40
        self.source = None
212
@@ -50,7 +53,7 @@ class DataSourceConfigDrive(openstack.SourceMixin, sources.DataSource):
213
50
        mstr += "[source=%s]" % (self.source)
53
        mstr += "[source=%s]" % (self.source)
214
51
        return mstr
54
        return mstr
215
52
55
217
53
    def get_data(self):
56
    def _get_data(self):
218
54
        found = None
57
        found = None
219
55
        md = {}
58
        md = {}
220
56
        results = {}
59
        results = {}
221
diff --git a/cloudinit/sources/DataSourceDigitalOcean.py b/cloudinit/sources/DataSourceDigitalOcean.py
222
index 5e7e66b..e0ef665 100644
223
--- a/cloudinit/sources/DataSourceDigitalOcean.py
224
+++ b/cloudinit/sources/DataSourceDigitalOcean.py
225
@@ -27,6 +27,9 @@ MD_USE_IPV4LL = True
226
27
27
227
28
28
228
29
class DataSourceDigitalOcean(sources.DataSource):
29
class DataSourceDigitalOcean(sources.DataSource):
229
30
230
31
    dsname = 'DigitalOcean'
231
32
232
30
    def __init__(self, sys_cfg, distro, paths):
33
    def __init__(self, sys_cfg, distro, paths):
233
31
        sources.DataSource.__init__(self, sys_cfg, distro, paths)
34
        sources.DataSource.__init__(self, sys_cfg, distro, paths)
234
32
        self.distro = distro
35
        self.distro = distro
235
@@ -44,7 +47,7 @@ class DataSourceDigitalOcean(sources.DataSource):
236
44
    def _get_sysinfo(self):
47
    def _get_sysinfo(self):
237
45
        return do_helper.read_sysinfo()
48
        return do_helper.read_sysinfo()
238
46
49
240
47
    def get_data(self):
50
    def _get_data(self):
241
48
        (is_do, droplet_id) = self._get_sysinfo()
51
        (is_do, droplet_id) = self._get_sysinfo()
242
49
52
243
50
        # only proceed if we know we are on DigitalOcean
53
        # only proceed if we know we are on DigitalOcean
244
diff --git a/cloudinit/sources/DataSourceEc2.py b/cloudinit/sources/DataSourceEc2.py
245
index 7bbbfb6..e5c8833 100644
246
--- a/cloudinit/sources/DataSourceEc2.py
247
+++ b/cloudinit/sources/DataSourceEc2.py
248
@@ -31,6 +31,7 @@ _unset = "_unset"
249
31
31
250
32
32
251
33
class Platforms(object):
33
class Platforms(object):
252
34
    # TODO Rename and move to cloudinit.cloud.CloudNames
253
34
    ALIYUN = "AliYun"
35
    ALIYUN = "AliYun"
254
35
    AWS = "AWS"
36
    AWS = "AWS"
255
36
    BRIGHTBOX = "Brightbox"
37
    BRIGHTBOX = "Brightbox"
256
@@ -45,6 +46,7 @@ class Platforms(object):
257
45
46
258
46
class DataSourceEc2(sources.DataSource):
47
class DataSourceEc2(sources.DataSource):
259
47
48
260
49
    dsname = 'Ec2'
261
48
    # Default metadata urls that will be used if none are provided
50
    # Default metadata urls that will be used if none are provided
262
49
    # They will be checked for 'resolveability' and some of the
51
    # They will be checked for 'resolveability' and some of the
263
50
    # following may be discarded if they do not resolve
52
    # following may be discarded if they do not resolve
264
@@ -68,11 +70,15 @@ class DataSourceEc2(sources.DataSource):
265
68
    _fallback_interface = None
70
    _fallback_interface = None
266
69
71
267
70
    def __init__(self, sys_cfg, distro, paths):
72
    def __init__(self, sys_cfg, distro, paths):
269
71
        sources.DataSource.__init__(self, sys_cfg, distro, paths)
73
        super(DataSourceEc2, self).__init__(sys_cfg, distro, paths)
270
72
        self.metadata_address = None
74
        self.metadata_address = None
271
73
        self.seed_dir = os.path.join(paths.seed_dir, "ec2")
75
        self.seed_dir = os.path.join(paths.seed_dir, "ec2")
272
74
76
274
75
    def get_data(self):
77
    def _get_cloud_name(self):
275
78
        """Return the cloud name as identified during _get_data."""
276
79
        return self.cloud_platform
277
80
278
81
    def _get_data(self):
279
76
        seed_ret = {}
82
        seed_ret = {}
280
77
        if util.read_optional_seed(seed_ret, base=(self.seed_dir + "/")):
83
        if util.read_optional_seed(seed_ret, base=(self.seed_dir + "/")):
281
78
            self.userdata_raw = seed_ret['user-data']
84
            self.userdata_raw = seed_ret['user-data']
282
@@ -274,7 +280,7 @@ class DataSourceEc2(sources.DataSource):
283
274
        return None
280
        return None
284
275
281
285
276
    @property
282
    @property
287
277
    def cloud_platform(self):
283
    def cloud_platform(self):  # TODO rename cloud_name
288
278
        if self._cloud_platform is None:
284
        if self._cloud_platform is None:
289
279
            self._cloud_platform = identify_platform()
285
            self._cloud_platform = identify_platform()
290
280
        return self._cloud_platform
286
        return self._cloud_platform
291
diff --git a/cloudinit/sources/DataSourceGCE.py b/cloudinit/sources/DataSourceGCE.py
292
index ccae420..ad6dae3 100644
293
--- a/cloudinit/sources/DataSourceGCE.py
294
+++ b/cloudinit/sources/DataSourceGCE.py
295
@@ -42,6 +42,9 @@ class GoogleMetadataFetcher(object):
296
42
42
297
43
43
298
44
class DataSourceGCE(sources.DataSource):
44
class DataSourceGCE(sources.DataSource):
299
45
300
46
    dsname = 'GCE'
301
47
302
45
    def __init__(self, sys_cfg, distro, paths):
48
    def __init__(self, sys_cfg, distro, paths):
303
46
        sources.DataSource.__init__(self, sys_cfg, distro, paths)
49
        sources.DataSource.__init__(self, sys_cfg, distro, paths)
304
47
        self.metadata = dict()
50
        self.metadata = dict()
305
@@ -50,7 +53,7 @@ class DataSourceGCE(sources.DataSource):
306
50
            BUILTIN_DS_CONFIG])
53
            BUILTIN_DS_CONFIG])
307
51
        self.metadata_address = self.ds_cfg['metadata_url']
54
        self.metadata_address = self.ds_cfg['metadata_url']
308
52
55
310
53
    def get_data(self):
56
    def _get_data(self):
311
54
        ret = util.log_time(
57
        ret = util.log_time(
312
55
            LOG.debug, 'Crawl of GCE metadata service',
58
            LOG.debug, 'Crawl of GCE metadata service',
313
56
            read_md, kwargs={'address': self.metadata_address})
59
            read_md, kwargs={'address': self.metadata_address})
314
diff --git a/cloudinit/sources/DataSourceMAAS.py b/cloudinit/sources/DataSourceMAAS.py
315
index 77df5a5..496bd06 100644
316
--- a/cloudinit/sources/DataSourceMAAS.py
317
+++ b/cloudinit/sources/DataSourceMAAS.py
318
@@ -39,6 +39,9 @@ class DataSourceMAAS(sources.DataSource):
319
39
      hostname
39
      hostname
320
40
      vendor-data
40
      vendor-data
321
41
    """
41
    """
322
42
323
43
    dsname = "MAAS"
324
44
325
42
    def __init__(self, sys_cfg, distro, paths):
45
    def __init__(self, sys_cfg, distro, paths):
326
43
        sources.DataSource.__init__(self, sys_cfg, distro, paths)
46
        sources.DataSource.__init__(self, sys_cfg, distro, paths)
327
44
        self.base_url = None
47
        self.base_url = None
328
@@ -62,7 +65,7 @@ class DataSourceMAAS(sources.DataSource):
329
62
        root = sources.DataSource.__str__(self)
65
        root = sources.DataSource.__str__(self)
330
63
        return "%s [%s]" % (root, self.base_url)
66
        return "%s [%s]" % (root, self.base_url)
331
64
67
333
65
    def get_data(self):
68
    def _get_data(self):
334
66
        mcfg = self.ds_cfg
69
        mcfg = self.ds_cfg
335
67
70
336
68
        try:
71
        try:
337
diff --git a/cloudinit/sources/DataSourceNoCloud.py b/cloudinit/sources/DataSourceNoCloud.py
338
index e641244..5d3a8dd 100644
339
--- a/cloudinit/sources/DataSourceNoCloud.py
340
+++ b/cloudinit/sources/DataSourceNoCloud.py
341
@@ -20,6 +20,9 @@ LOG = logging.getLogger(__name__)
342
20
20
343
21
21
344
22
class DataSourceNoCloud(sources.DataSource):
22
class DataSourceNoCloud(sources.DataSource):
345
23
346
24
    dsname = "NoCloud"
347
25
348
23
    def __init__(self, sys_cfg, distro, paths):
26
    def __init__(self, sys_cfg, distro, paths):
349
24
        sources.DataSource.__init__(self, sys_cfg, distro, paths)
27
        sources.DataSource.__init__(self, sys_cfg, distro, paths)
350
25
        self.seed = None
28
        self.seed = None
351
@@ -32,7 +35,7 @@ class DataSourceNoCloud(sources.DataSource):
352
32
        root = sources.DataSource.__str__(self)
35
        root = sources.DataSource.__str__(self)
353
33
        return "%s [seed=%s][dsmode=%s]" % (root, self.seed, self.dsmode)
36
        return "%s [seed=%s][dsmode=%s]" % (root, self.seed, self.dsmode)
354
34
37
356
35
    def get_data(self):
38
    def _get_data(self):
357
36
        defaults = {
39
        defaults = {
358
37
            "instance-id": "nocloud",
40
            "instance-id": "nocloud",
359
38
            "dsmode": self.dsmode,
41
            "dsmode": self.dsmode,
360
diff --git a/cloudinit/sources/DataSourceNone.py b/cloudinit/sources/DataSourceNone.py
361
index 906bb27..e63a7e3 100644
362
--- a/cloudinit/sources/DataSourceNone.py
363
+++ b/cloudinit/sources/DataSourceNone.py
364
@@ -11,12 +11,15 @@ LOG = logging.getLogger(__name__)
365
11
11
366
12
12
367
13
class DataSourceNone(sources.DataSource):
13
class DataSourceNone(sources.DataSource):
368
14
369
15
    dsname = "None"
370
16
371
14
    def __init__(self, sys_cfg, distro, paths, ud_proc=None):
17
    def __init__(self, sys_cfg, distro, paths, ud_proc=None):
372
15
        sources.DataSource.__init__(self, sys_cfg, distro, paths, ud_proc)
18
        sources.DataSource.__init__(self, sys_cfg, distro, paths, ud_proc)
373
16
        self.metadata = {}
19
        self.metadata = {}
374
17
        self.userdata_raw = ''
20
        self.userdata_raw = ''
375
18
21
377
19
    def get_data(self):
22
    def _get_data(self):
378
20
        # If the datasource config has any provided 'fallback'
23
        # If the datasource config has any provided 'fallback'
379
21
        # userdata or metadata, use it...
24
        # userdata or metadata, use it...
380
22
        if 'userdata_raw' in self.ds_cfg:
25
        if 'userdata_raw' in self.ds_cfg:
381
diff --git a/cloudinit/sources/DataSourceOVF.py b/cloudinit/sources/DataSourceOVF.py
382
index ccebf11..6ac621f 100644
383
--- a/cloudinit/sources/DataSourceOVF.py
384
+++ b/cloudinit/sources/DataSourceOVF.py
385
@@ -43,6 +43,9 @@ LOG = logging.getLogger(__name__)
386
43
43
387
44
44
388
45
class DataSourceOVF(sources.DataSource):
45
class DataSourceOVF(sources.DataSource):
389
46
390
47
    dsname = "OVF"
391
48
392
46
    def __init__(self, sys_cfg, distro, paths):
49
    def __init__(self, sys_cfg, distro, paths):
393
47
        sources.DataSource.__init__(self, sys_cfg, distro, paths)
50
        sources.DataSource.__init__(self, sys_cfg, distro, paths)
394
48
        self.seed = None
51
        self.seed = None
395
@@ -60,7 +63,7 @@ class DataSourceOVF(sources.DataSource):
396
60
        root = sources.DataSource.__str__(self)
63
        root = sources.DataSource.__str__(self)
397
61
        return "%s [seed=%s]" % (root, self.seed)
64
        return "%s [seed=%s]" % (root, self.seed)
398
62
65
400
63
    def get_data(self):
66
    def _get_data(self):
401
64
        found = []
67
        found = []
402
65
        md = {}
68
        md = {}
403
66
        ud = ""
69
        ud = ""
404
diff --git a/cloudinit/sources/DataSourceOpenNebula.py b/cloudinit/sources/DataSourceOpenNebula.py
405
index 5fdac19..5da1184 100644
406
--- a/cloudinit/sources/DataSourceOpenNebula.py
407
+++ b/cloudinit/sources/DataSourceOpenNebula.py
408
@@ -31,6 +31,9 @@ CONTEXT_DISK_FILES = ["context.sh"]
409
31
31
410
32
32
411
33
class DataSourceOpenNebula(sources.DataSource):
33
class DataSourceOpenNebula(sources.DataSource):
412
34
413
35
    dsname = "OpenNebula"
414
36
415
34
    def __init__(self, sys_cfg, distro, paths):
37
    def __init__(self, sys_cfg, distro, paths):
416
35
        sources.DataSource.__init__(self, sys_cfg, distro, paths)
38
        sources.DataSource.__init__(self, sys_cfg, distro, paths)
417
36
        self.seed = None
39
        self.seed = None
418
@@ -40,7 +43,7 @@ class DataSourceOpenNebula(sources.DataSource):
419
40
        root = sources.DataSource.__str__(self)
43
        root = sources.DataSource.__str__(self)
420
41
        return "%s [seed=%s][dsmode=%s]" % (root, self.seed, self.dsmode)
44
        return "%s [seed=%s][dsmode=%s]" % (root, self.seed, self.dsmode)
421
42
45
423
43
    def get_data(self):
46
    def _get_data(self):
424
44
        defaults = {"instance-id": DEFAULT_IID}
47
        defaults = {"instance-id": DEFAULT_IID}
425
45
        results = None
48
        results = None
426
46
        seed = None
49
        seed = None
427
diff --git a/cloudinit/sources/DataSourceOpenStack.py b/cloudinit/sources/DataSourceOpenStack.py
428
index b64a7f2..e55a763 100644
429
--- a/cloudinit/sources/DataSourceOpenStack.py
430
+++ b/cloudinit/sources/DataSourceOpenStack.py
431
@@ -24,6 +24,9 @@ DEFAULT_METADATA = {
432
24
24
433
25
25
434
26
class DataSourceOpenStack(openstack.SourceMixin, sources.DataSource):
26
class DataSourceOpenStack(openstack.SourceMixin, sources.DataSource):
435
27
436
28
    dsname = "OpenStack"
437
29
438
27
    def __init__(self, sys_cfg, distro, paths):
30
    def __init__(self, sys_cfg, distro, paths):
439
28
        super(DataSourceOpenStack, self).__init__(sys_cfg, distro, paths)
31
        super(DataSourceOpenStack, self).__init__(sys_cfg, distro, paths)
440
29
        self.metadata_address = None
32
        self.metadata_address = None
441
@@ -96,7 +99,7 @@ class DataSourceOpenStack(openstack.SourceMixin, sources.DataSource):
442
96
        self.metadata_address = url2base.get(avail_url)
99
        self.metadata_address = url2base.get(avail_url)
443
97
        return bool(avail_url)
100
        return bool(avail_url)
444
98
101
446
99
    def get_data(self):
102
    def _get_data(self):
447
100
        try:
103
        try:
448
101
            if not self.wait_for_metadata_service():
104
            if not self.wait_for_metadata_service():
449
102
                return False
105
                return False
450
diff --git a/cloudinit/sources/DataSourceScaleway.py b/cloudinit/sources/DataSourceScaleway.py
451
index 3a8a8e8..b0b19c9 100644
452
--- a/cloudinit/sources/DataSourceScaleway.py
453
+++ b/cloudinit/sources/DataSourceScaleway.py
454
@@ -169,6 +169,8 @@ def query_data_api(api_type, api_address, retries, timeout):
455
169
169
456
170
class DataSourceScaleway(sources.DataSource):
170
class DataSourceScaleway(sources.DataSource):
457
171
171
458
172
    dsname = "Scaleway"
459
173
460
172
    def __init__(self, sys_cfg, distro, paths):
174
    def __init__(self, sys_cfg, distro, paths):
461
173
        super(DataSourceScaleway, self).__init__(sys_cfg, distro, paths)
175
        super(DataSourceScaleway, self).__init__(sys_cfg, distro, paths)
462
174
176
463
@@ -184,7 +186,7 @@ class DataSourceScaleway(sources.DataSource):
464
184
        self.retries = int(self.ds_cfg.get('retries', DEF_MD_RETRIES))
186
        self.retries = int(self.ds_cfg.get('retries', DEF_MD_RETRIES))
465
185
        self.timeout = int(self.ds_cfg.get('timeout', DEF_MD_TIMEOUT))
187
        self.timeout = int(self.ds_cfg.get('timeout', DEF_MD_TIMEOUT))
466
186
188
468
187
    def get_data(self):
189
    def _get_data(self):
469
188
        if not on_scaleway():
190
        if not on_scaleway():
470
189
            return False
191
            return False
471
190
192
472
diff --git a/cloudinit/sources/DataSourceSmartOS.py b/cloudinit/sources/DataSourceSmartOS.py
473
index 6c6902f..86bfa5d 100644
474
--- a/cloudinit/sources/DataSourceSmartOS.py
475
+++ b/cloudinit/sources/DataSourceSmartOS.py
476
@@ -159,6 +159,9 @@ LEGACY_USER_D = "/var/db"
477
159
159
478
160
160
479
161
class DataSourceSmartOS(sources.DataSource):
161
class DataSourceSmartOS(sources.DataSource):
480
162
481
163
    dsname = "Joyent"
482
164
483
162
    _unset = "_unset"
165
    _unset = "_unset"
484
163
    smartos_type = _unset
166
    smartos_type = _unset
485
164
    md_client = _unset
167
    md_client = _unset
486
@@ -211,7 +214,7 @@ class DataSourceSmartOS(sources.DataSource):
487
211
            os.rename('/'.join([svc_path, 'provisioning']),
214
            os.rename('/'.join([svc_path, 'provisioning']),
488
212
                      '/'.join([svc_path, 'provision_success']))
215
                      '/'.join([svc_path, 'provision_success']))
489
213
216
491
214
    def get_data(self):
217
    def _get_data(self):
492
215
        self._init()
218
        self._init()
493
216
219
494
217
        md = {}
220
        md = {}
495
diff --git a/cloudinit/sources/__init__.py b/cloudinit/sources/__init__.py
496
index 9a43fbe..4b819ce 100644
497
--- a/cloudinit/sources/__init__.py
498
+++ b/cloudinit/sources/__init__.py
499
@@ -10,9 +10,11 @@
500
10
10
501
11
import abc
11
import abc
502
12
import copy
12
import copy
503
13
import json
504
13
import os
14
import os
505
14
import six
15
import six
506
15
16
507
17
from cloudinit.atomic_helper import write_json
508
16
from cloudinit import importer
18
from cloudinit import importer
509
17
from cloudinit import log as logging
19
from cloudinit import log as logging
510
18
from cloudinit import type_utils
20
from cloudinit import type_utils
511
@@ -33,6 +35,12 @@ DEP_FILESYSTEM = "FILESYSTEM"
512
33
DEP_NETWORK = "NETWORK"
35
DEP_NETWORK = "NETWORK"
513
34
DS_PREFIX = 'DataSource'
36
DS_PREFIX = 'DataSource'
514
35
37
515
38
# File in which instance meta-data, user-data and vendor-data is written
516
39
INSTANCE_JSON_FILE = 'instance-data.json'
517
40
518
41
# Key which can be provide a cloud's official product name to cloud-init
519
42
METADATA_CLOUD_NAME_KEY = 'cloud-name'
520
43
521
36
LOG = logging.getLogger(__name__)
44
LOG = logging.getLogger(__name__)
522
37
45
523
38
46
524
@@ -40,12 +48,39 @@ class DataSourceNotFoundException(Exception):
525
40
    pass
48
    pass
526
41
49
527
42
50
528
51
def process_base64_metadata(metadata, key_path=''):
529
52
    """Strip ci-b64 prefix and return metadata with base64-encoded-keys set."""
530
53
    md_copy = copy.deepcopy(metadata)
531
54
    md_copy['base64-encoded-keys'] = []
532
55
    for key, val in metadata.items():
533
56
        if key_path:
534
57
            sub_key_path = key_path + '/' + key
535
58
        else:
536
59
            sub_key_path = key
537
60
        if isinstance(val, str) and val.startswith('ci-b64:'):
538
61
            md_copy['base64-encoded-keys'].append(sub_key_path)
539
62
            md_copy[key] = val.replace('ci-b64:', '')
540
63
        if isinstance(val, dict):
541
64
            return_val = process_base64_metadata(val, sub_key_path)
542
65
            md_copy['base64-encoded-keys'].extend(
543
66
                return_val.pop('base64-encoded-keys'))
544
67
            md_copy[key] = return_val
545
68
    return md_copy
546
69
547
70
548
43
@six.add_metaclass(abc.ABCMeta)
71
@six.add_metaclass(abc.ABCMeta)
549
44
class DataSource(object):
72
class DataSource(object):
550
45
73
551
46
    dsmode = DSMODE_NETWORK
74
    dsmode = DSMODE_NETWORK
552
47
    default_locale = 'en_US.UTF-8'
75
    default_locale = 'en_US.UTF-8'
553
48
76
554
77
    # Datasource name needs to be set by subclasses to determine which
555
78
    # cloud-config datasource key is loaded
556
79
    dsname = '_undef'
557
80
558
81
    # Cached cloud_name as determined by _get_cloud_name
559
82
    _cloud_name = None
560
83
561
49
    def __init__(self, sys_cfg, distro, paths, ud_proc=None):
84
    def __init__(self, sys_cfg, distro, paths, ud_proc=None):
562
50
        self.sys_cfg = sys_cfg
85
        self.sys_cfg = sys_cfg
563
51
        self.distro = distro
86
        self.distro = distro
564
@@ -56,17 +91,8 @@ class DataSource(object):
565
56
        self.vendordata = None
91
        self.vendordata = None
566
57
        self.vendordata_raw = None
92
        self.vendordata_raw = None
567
58
93
579
59
        # find the datasource config name.
94
        self.ds_cfg = util.get_cfg_by_path(
580
60
        # remove 'DataSource' from classname on front, and remove 'Net' on end.
95
            self.sys_cfg, ("datasource", self.dsname), {})
570
61
        # Both Foo and FooNet sources expect config in cfg['sources']['Foo']
571
62
        name = type_utils.obj_name(self)
572
63
        if name.startswith(DS_PREFIX):
573
64
            name = name[len(DS_PREFIX):]
574
65
        if name.endswith('Net'):
575
66
            name = name[0:-3]
576
67
577
68
        self.ds_cfg = util.get_cfg_by_path(self.sys_cfg,
578
69
                                           ("datasource", name), {})
581
70
        if not self.ds_cfg:
96
        if not self.ds_cfg:
582
71
            self.ds_cfg = {}
97
            self.ds_cfg = {}
583
72
98
584
@@ -78,6 +104,51 @@ class DataSource(object):
585
78
    def __str__(self):
104
    def __str__(self):
586
79
        return type_utils.obj_name(self)
105
        return type_utils.obj_name(self)
587
80
106
588
107
    def _get_standardized_metadata(self):
589
108
        """Return a dictionary of standardized metadata keys."""
590
109
        return {'v1': {
591
110
            'local-hostname': self.get_hostname(),
592
111
            'instance-id': self.get_instance_id(),
593
112
            'cloud-name': self.cloud_name,
594
113
            'region': self.region,
595
114
            'availability-zone': self.availability_zone}}
596
115
597
116
    def get_data(self):
598
117
        """Datasources implement _get_data to setup metadata and userdata_raw.
599
118
600
119
        Minimally, the datasource should return a boolean True on success.
601
120
        """
602
121
        return_value = self._get_data()
603
122
        json_file = os.path.join(self.paths.run_dir, INSTANCE_JSON_FILE)
604
123
        if not return_value:
605
124
            return return_value
606
125
607
126
        instance_data = {
608
127
            'ds': {
609
128
                'meta-data': self.metadata,
610
129
                'user-data': self.get_userdata_raw(),
611
130
                'vendor-data': self.get_vendordata_raw()}}
612
131
        instance_data.update(
613
132
            self._get_standardized_metadata())
614
133
        try:
615
134
            # Process content base64encoding unserializable values
616
135
            content = util.json_dumps(instance_data)
617
136
            # Strip base64: prefix and return base64-encoded-keys
618
137
            processed_data = process_base64_metadata(json.loads(content))
619
138
        except TypeError as e:
620
139
            LOG.warning('Error persisting instance-data.json: %s', str(e))
621
140
            return return_value
622
141
        except UnicodeDecodeError as e:
623
142
            LOG.warning('Error persisting instance-data.json: %s', str(e))
624
143
            return return_value
625
144
        write_json(json_file, processed_data, mode=0o600)
626
145
        return return_value
627
146
628
147
    def _get_data(self):
629
148
        raise NotImplementedError(
630
149
            'Subclasses of DataSource must implement _get_data which'
631
150
            ' sets self.metadata, vendordata_raw and userdata_raw.')
632
151
633
81
    def get_userdata(self, apply_filter=False):
152
    def get_userdata(self, apply_filter=False):
634
82
        if self.userdata is None:
153
        if self.userdata is None:
635
83
            self.userdata = self.ud_proc.process(self.get_userdata_raw())
154
            self.userdata = self.ud_proc.process(self.get_userdata_raw())
636
@@ -91,6 +162,34 @@ class DataSource(object):
637
91
        return self.vendordata
162
        return self.vendordata
638
92
163
639
93
    @property
164
    @property
640
165
    def cloud_name(self):
641
166
        """Return lowercase cloud name as determined by the datasource.
642
167
643
168
        Datasource can determine or define its own cloud product name in
644
169
        metadata.
645
170
        """
646
171
        if self._cloud_name:
647
172
            return self._cloud_name
648
173
        if self.metadata and self.metadata.get(METADATA_CLOUD_NAME_KEY):
649
174
            cloud_name = self.metadata.get(METADATA_CLOUD_NAME_KEY)
650
175
            if isinstance(cloud_name, six.string_types):
651
176
                self._cloud_name = cloud_name.lower()
652
177
            LOG.debug(
653
178
                'Ignoring metadata provided key %s: non-string type %s',
654
179
                METADATA_CLOUD_NAME_KEY, type(cloud_name))
655
180
        else:
656
181
            self._cloud_name = self._get_cloud_name().lower()
657
182
        return self._cloud_name
658
183
659
184
    def _get_cloud_name(self):
660
185
        """Return the datasource name as it frequently matches cloud name.
661
186
662
187
        Should be overridden in subclasses which can run on multiple
663
188
        cloud names, such as DatasourceEc2.
664
189
        """
665
190
        return self.dsname
666
191
667
192
    @property
668
94
    def launch_index(self):
193
    def launch_index(self):
669
95
        if not self.metadata:
194
        if not self.metadata:
670
96
            return None
195
            return None
671
@@ -161,8 +260,11 @@ class DataSource(object):
672
161
260
673
162
    @property
261
    @property
674
163
    def availability_zone(self):
262
    def availability_zone(self):
677
164
        return self.metadata.get('availability-zone',
263
        top_level_az = self.metadata.get(
678
165
                                 self.metadata.get('availability_zone'))
264
            'availability-zone', self.metadata.get('availability_zone'))
679
265
        if top_level_az:
680
266
            return top_level_az
681
267
        return self.metadata.get('placement', {}).get('availability-zone')
682
166
268
683
167
    @property
269
    @property
684
168
    def region(self):
270
    def region(self):
685
@@ -417,4 +519,5 @@ def list_from_depends(depends, ds_list):
686
417
            ret_list.append(cls)
519
            ret_list.append(cls)
687
418
    return ret_list
520
    return ret_list
688
419
521
689
522
690
420
# vi: ts=4 expandtab
523
# vi: ts=4 expandtab
691
diff --git a/cloudinit/sources/tests/__init__.py b/cloudinit/sources/tests/__init__.py
692
421
new file mode 100644
524
new file mode 100644
693
index 0000000..e69de29
694
--- /dev/null
695
+++ b/cloudinit/sources/tests/__init__.py
696
diff --git a/cloudinit/sources/tests/test_init.py b/cloudinit/sources/tests/test_init.py
697
422
new file mode 100644
525
new file mode 100644
698
index 0000000..af15115
699
--- /dev/null
700
+++ b/cloudinit/sources/tests/test_init.py
701
@@ -0,0 +1,202 @@
702
1
# This file is part of cloud-init. See LICENSE file for license information.
703
2
704
3
import os
705
4
import six
706
5
import stat
707
6
708
7
from cloudinit.helpers import Paths
709
8
from cloudinit.sources import (
710
9
    INSTANCE_JSON_FILE, DataSource)
711
10
from cloudinit.tests.helpers import CiTestCase, skipIf
712
11
from cloudinit.user_data import UserDataProcessor
713
12
from cloudinit import util
714
13
715
14
716
15
class DataSourceTestSubclassNet(DataSource):
717
16
718
17
    dsname = 'MyTestSubclass'
719
18
720
19
    def __init__(self, sys_cfg, distro, paths, custom_userdata=None):
721
20
        super(DataSourceTestSubclassNet, self).__init__(
722
21
            sys_cfg, distro, paths)
723
22
        self._custom_userdata = custom_userdata
724
23
725
24
    def _get_cloud_name(self):
726
25
        return 'SubclassCloudName'
727
26
728
27
    def _get_data(self):
729
28
        self.metadata = {'availability_zone': 'myaz',
730
29
                         'local-hostname': 'test-subclass-hostname',
731
30
                         'region': 'myregion'}
732
31
        if self._custom_userdata:
733
32
            self.userdata_raw = self._custom_userdata
734
33
        else:
735
34
            self.userdata_raw = 'userdata_raw'
736
35
        self.vendordata_raw = 'vendordata_raw'
737
36
        return True
738
37
739
38
740
39
class InvalidDataSourceTestSubclassNet(DataSource):
741
40
    pass
742
41
743
42
744
43
class TestDataSource(CiTestCase):
745
44
746
45
    with_logs = True
747
46
748
47
    def setUp(self):
749
48
        super(TestDataSource, self).setUp()
750
49
        self.sys_cfg = {'datasource': {'_undef': {'key1': False}}}
751
50
        self.distro = 'distrotest'  # generally should be a Distro object
752
51
        self.paths = Paths({})
753
52
        self.datasource = DataSource(self.sys_cfg, self.distro, self.paths)
754
53
755
54
    def test_datasource_init(self):
756
55
        """DataSource initializes metadata attributes, ds_cfg and ud_proc."""
757
56
        self.assertEqual(self.paths, self.datasource.paths)
758
57
        self.assertEqual(self.sys_cfg, self.datasource.sys_cfg)
759
58
        self.assertEqual(self.distro, self.datasource.distro)
760
59
        self.assertIsNone(self.datasource.userdata)
761
60
        self.assertEqual({}, self.datasource.metadata)
762
61
        self.assertIsNone(self.datasource.userdata_raw)
763
62
        self.assertIsNone(self.datasource.vendordata)
764
63
        self.assertIsNone(self.datasource.vendordata_raw)
765
64
        self.assertEqual({'key1': False}, self.datasource.ds_cfg)
766
65
        self.assertIsInstance(self.datasource.ud_proc, UserDataProcessor)
767
66
768
67
    def test_datasource_init_gets_ds_cfg_using_dsname(self):
769
68
        """Init uses DataSource.dsname for sourcing ds_cfg."""
770
69
        sys_cfg = {'datasource': {'MyTestSubclass': {'key2': False}}}
771
70
        distro = 'distrotest'  # generally should be a Distro object
772
71
        paths = Paths({})
773
72
        datasource = DataSourceTestSubclassNet(sys_cfg, distro, paths)
774
73
        self.assertEqual({'key2': False}, datasource.ds_cfg)
775
74
776
75
    def test_str_is_classname(self):
777
76
        """The string representation of the datasource is the classname."""
778
77
        self.assertEqual('DataSource', str(self.datasource))
779
78
        self.assertEqual(
780
79
            'DataSourceTestSubclassNet',
781
80
            str(DataSourceTestSubclassNet('', '', self.paths)))
782
81
783
82
    def test__get_data_unimplemented(self):
784
83
        """Raise an error when _get_data is not implemented."""
785
84
        with self.assertRaises(NotImplementedError) as context_manager:
786
85
            self.datasource.get_data()
787
86
        self.assertIn(
788
87
            'Subclasses of DataSource must implement _get_data',
789
88
            str(context_manager.exception))
790
89
        datasource2 = InvalidDataSourceTestSubclassNet(
791
90
            self.sys_cfg, self.distro, self.paths)
792
91
        with self.assertRaises(NotImplementedError) as context_manager:
793
92
            datasource2.get_data()
794
93
        self.assertIn(
795
94
            'Subclasses of DataSource must implement _get_data',
796
95
            str(context_manager.exception))
797
96
798
97
    def test_get_data_calls_subclass__get_data(self):
799
98
        """Datasource.get_data uses the subclass' version of _get_data."""
800
99
        tmp = self.tmp_dir()
801
100
        datasource = DataSourceTestSubclassNet(
802
101
            self.sys_cfg, self.distro, Paths({'run_dir': tmp}))
803
102
        self.assertTrue(datasource.get_data())
804
103
        self.assertEqual(
805
104
            {'availability_zone': 'myaz',
806
105
             'local-hostname': 'test-subclass-hostname',
807
106
             'region': 'myregion'},
808
107
            datasource.metadata)
809
108
        self.assertEqual('userdata_raw', datasource.userdata_raw)
810
109
        self.assertEqual('vendordata_raw', datasource.vendordata_raw)
811
110
812
111
    def test_get_data_write_json_instance_data(self):
813
112
        """get_data writes INSTANCE_JSON_FILE to run_dir as readonly root."""
814
113
        tmp = self.tmp_dir()
815
114
        datasource = DataSourceTestSubclassNet(
816
115
            self.sys_cfg, self.distro, Paths({'run_dir': tmp}))
817
116
        datasource.get_data()
818
117
        json_file = self.tmp_path(INSTANCE_JSON_FILE, tmp)
819
118
        content = util.load_file(json_file)
820
119
        expected = {
821
120
            'base64-encoded-keys': [],
822
121
            'v1': {
823
122
                'availability-zone': 'myaz',
824
123
                'cloud-name': 'subclasscloudname',
825
124
                'instance-id': 'iid-datasource',
826
125
                'local-hostname': 'test-subclass-hostname',
827
126
                'region': 'myregion'},
828
127
            'ds': {
829
128
                'meta-data': {'availability_zone': 'myaz',
830
129
                              'local-hostname': 'test-subclass-hostname',
831
130
                              'region': 'myregion'},
832
131
                'user-data': 'userdata_raw',
833
132
                'vendor-data': 'vendordata_raw'}}
834
133
        self.assertEqual(expected, util.load_json(content))
835
134
        file_stat = os.stat(json_file)
836
135
        self.assertEqual(0o600, stat.S_IMODE(file_stat.st_mode))
837
136
838
137
    def test_get_data_handles_redacted_unserializable_content(self):
839
138
        """get_data warns unserializable content in INSTANCE_JSON_FILE."""
840
139
        tmp = self.tmp_dir()
841
140
        datasource = DataSourceTestSubclassNet(
842
141
            self.sys_cfg, self.distro, Paths({'run_dir': tmp}),
843
142
            custom_userdata={'key1': 'val1', 'key2': {'key2.1': self.paths}})
844
143
        self.assertTrue(datasource.get_data())
845
144
        json_file = self.tmp_path(INSTANCE_JSON_FILE, tmp)
846
145
        content = util.load_file(json_file)
847
146
        expected_userdata = {
848
147
            'key1': 'val1',
849
148
            'key2': {
850
149
                'key2.1': "Warning: redacted unserializable type <class"
851
150
                          " 'cloudinit.helpers.Paths'>"}}
852
151
        instance_json = util.load_json(content)
853
152
        self.assertEqual(
854
153
            expected_userdata, instance_json['ds']['user-data'])
855
154
856
155
    @skipIf(not six.PY3, "json serialization on <= py2.7 handles bytes")
857
156
    def test_get_data_base64encodes_unserializable_bytes(self):
858
157
        """On py3, get_data base64encodes any unserializable content."""
859
158
        tmp = self.tmp_dir()
860
159
        datasource = DataSourceTestSubclassNet(
861
160
            self.sys_cfg, self.distro, Paths({'run_dir': tmp}),
862
161
            custom_userdata={'key1': 'val1', 'key2': {'key2.1': b'\x123'}})
863
162
        self.assertTrue(datasource.get_data())
864
163
        json_file = self.tmp_path(INSTANCE_JSON_FILE, tmp)
865
164
        content = util.load_file(json_file)
866
165
        instance_json = util.load_json(content)
867
166
        self.assertEqual(
868
167
            ['ds/user-data/key2/key2.1'],
869
168
            instance_json['base64-encoded-keys'])
870
169
        self.assertEqual(
871
170
            {'key1': 'val1', 'key2': {'key2.1': 'EjM='}},
872
171
            instance_json['ds']['user-data'])
873
172
874
173
    @skipIf(not six.PY2, "json serialization on <= py2.7 handles bytes")
875
174
    def test_get_data_handles_bytes_values(self):
876
175
        """On py2 get_data handles bytes values without having to b64encode."""
877
176
        tmp = self.tmp_dir()
878
177
        datasource = DataSourceTestSubclassNet(
879
178
            self.sys_cfg, self.distro, Paths({'run_dir': tmp}),
880
179
            custom_userdata={'key1': 'val1', 'key2': {'key2.1': b'\x123'}})
881
180
        self.assertTrue(datasource.get_data())
882
181
        json_file = self.tmp_path(INSTANCE_JSON_FILE, tmp)
883
182
        content = util.load_file(json_file)
884
183
        instance_json = util.load_json(content)
885
184
        self.assertEqual([], instance_json['base64-encoded-keys'])
886
185
        self.assertEqual(
887
186
            {'key1': 'val1', 'key2': {'key2.1': '\x123'}},
888
187
            instance_json['ds']['user-data'])
889
188
890
189
    @skipIf(not six.PY2, "Only python2 hits UnicodeDecodeErrors on non-utf8")
891
190
    def test_non_utf8_encoding_logs_warning(self):
892
191
        """When non-utf-8 values exist in py2 instance-data is not written."""
893
192
        tmp = self.tmp_dir()
894
193
        datasource = DataSourceTestSubclassNet(
895
194
            self.sys_cfg, self.distro, Paths({'run_dir': tmp}),
896
195
            custom_userdata={'key1': 'val1', 'key2': {'key2.1': b'ab\xaadef'}})
897
196
        self.assertTrue(datasource.get_data())
898
197
        json_file = self.tmp_path(INSTANCE_JSON_FILE, tmp)
899
198
        self.assertFalse(os.path.exists(json_file))
900
199
        self.assertIn(
901
200
            "WARNING: Error persisting instance-data.json: 'utf8' codec can't"
902
201
            " decode byte 0xaa in position 2: invalid start byte",
903
202
            self.logs.getvalue())
904
diff --git a/cloudinit/tests/helpers.py b/cloudinit/tests/helpers.py
905
index e0adbda..feb884a 100644
906
--- a/cloudinit/tests/helpers.py
907
+++ b/cloudinit/tests/helpers.py
908
@@ -3,7 +3,6 @@
909
3
from __future__ import print_function
3
from __future__ import print_function
910
4
4
911
5
import functools
5
import functools
912
6
import json
913
7
import logging
6
import logging
914
8
import os
7
import os
915
9
import shutil
8
import shutil
916
@@ -104,7 +103,6 @@ class TestCase(unittest2.TestCase):
917
104
        super(TestCase, self).setUp()
103
        super(TestCase, self).setUp()
918
105
        self.reset_global_state()
104
        self.reset_global_state()
919
106
105
920
107
<<<<<<< cloudinit/tests/helpers.py
921
108
    def add_patch(self, target, attr, **kwargs):
106
    def add_patch(self, target, attr, **kwargs):
922
109
        """Patches specified target object and sets it as attr on test
107
        """Patches specified target object and sets it as attr on test
923
110
        instance also schedules cleanup"""
108
        instance also schedules cleanup"""
924
@@ -115,8 +113,6 @@ class TestCase(unittest2.TestCase):
925
115
        self.addCleanup(m.stop)
113
        self.addCleanup(m.stop)
926
116
        setattr(self, attr, p)
114
        setattr(self, attr, p)
927
117
115
928
118
=======
929
119
>>>>>>> cloudinit/tests/helpers.py
930
120
116
931
121
class CiTestCase(TestCase):
117
class CiTestCase(TestCase):
932
122
    """This is the preferred test case base class unless user
118
    """This is the preferred test case base class unless user
933
@@ -340,12 +336,6 @@ def dir2dict(startdir, prefix=None):
934
340
    return flist
336
    return flist
935
341
337
936
342
338
937
343
def json_dumps(data):
938
344
    # print data in nicely formatted json.
939
345
    return json.dumps(data, indent=1, sort_keys=True,
940
346
                      separators=(',', ': '))
941
347
942
348
943
349
def wrap_and_call(prefix, mocks, func, *args, **kwargs):
339
def wrap_and_call(prefix, mocks, func, *args, **kwargs):
944
350
    """
340
    """
945
351
    call func(args, **kwargs) with mocks applied, then unapplies mocks
341
    call func(args, **kwargs) with mocks applied, then unapplies mocks
946
diff --git a/cloudinit/util.py b/cloudinit/util.py
947
index 6c014ba..30c5995 100644
948
--- a/cloudinit/util.py
949
+++ b/cloudinit/util.py
950
@@ -533,15 +533,6 @@ def multi_log(text, console=True, stderr=True,
951
533
            log.log(log_level, text)
533
            log.log(log_level, text)
952
534
534
953
535
535
954
536
def load_json(text, root_types=(dict,)):
955
537
    decoded = json.loads(decode_binary(text))
956
538
    if not isinstance(decoded, tuple(root_types)):
957
539
        expected_types = ", ".join([str(t) for t in root_types])
958
540
        raise TypeError("(%s) root types expected, got %s instead"
959
541
                        % (expected_types, type(decoded)))
960
542
    return decoded
961
543
962
544
963
545
def is_ipv4(instr):
536
def is_ipv4(instr):
964
546
    """determine if input string is a ipv4 address. return boolean."""
537
    """determine if input string is a ipv4 address. return boolean."""
965
547
    toks = instr.split('.')
538
    toks = instr.split('.')
966
@@ -1454,7 +1445,31 @@ def ensure_dirs(dirlist, mode=0o755):
967
1454
        ensure_dir(d, mode)
1445
        ensure_dir(d, mode)
968
1455
1446
969
1456
1447
970
1448
def load_json(text, root_types=(dict,)):
971
1449
    decoded = json.loads(decode_binary(text))
972
1450
    if not isinstance(decoded, tuple(root_types)):
973
1451
        expected_types = ", ".join([str(t) for t in root_types])
974
1452
        raise TypeError("(%s) root types expected, got %s instead"
975
1453
                        % (expected_types, type(decoded)))
976
1454
    return decoded
977
1455
978
1456
979
1457
def json_serialize_default(_obj):
980
1458
    """Handler for types which aren't json serializable."""
981
1459
    try:
982
1460
        return 'ci-b64:{0}'.format(b64e(_obj))
983
1461
    except AttributeError:
984
1462
        return 'Warning: redacted unserializable type {0}'.format(type(_obj))
985
1463
986
1464
987
1465
def json_dumps(data):
988
1466
    """Return data in nicely formatted json."""
989
1467
    return json.dumps(data, indent=1, sort_keys=True,
990
1468
                      separators=(',', ': '), default=json_serialize_default)
991
1469
992
1470
993
1457
def yaml_dumps(obj, explicit_start=True, explicit_end=True):
1471
def yaml_dumps(obj, explicit_start=True, explicit_end=True):
994
1472
    """Return data in nicely formatted yaml."""
995
1458
    return yaml.safe_dump(obj,
1473
    return yaml.safe_dump(obj,
996
1459
                          line_break="\n",
1474
                          line_break="\n",
997
1460
                          indent=4,
1475
                          indent=4,
998
diff --git a/tests/unittests/test_datasource/test_aliyun.py b/tests/unittests/test_datasource/test_aliyun.py
999
index 82ee971..714f5da 100644
1000
--- a/tests/unittests/test_datasource/test_aliyun.py
1001
+++ b/tests/unittests/test_datasource/test_aliyun.py
1002
@@ -67,7 +67,7 @@ class TestAliYunDatasource(test_helpers.HttprettyTestCase):
1003
67
        super(TestAliYunDatasource, self).setUp()
67
        super(TestAliYunDatasource, self).setUp()
1004
68
        cfg = {'datasource': {'AliYun': {'timeout': '1', 'max_wait': '1'}}}
68
        cfg = {'datasource': {'AliYun': {'timeout': '1', 'max_wait': '1'}}}
1005
69
        distro = {}
69
        distro = {}
1007
70
        paths = helpers.Paths({})
70
        paths = helpers.Paths({'run_dir': self.tmp_dir()})
1008
71
        self.ds = ay.DataSourceAliYun(cfg, distro, paths)
71
        self.ds = ay.DataSourceAliYun(cfg, distro, paths)
1009
72
        self.metadata_address = self.ds.metadata_urls[0]
72
        self.metadata_address = self.ds.metadata_urls[0]
1010
73
73
1011
diff --git a/tests/unittests/test_datasource/test_altcloud.py b/tests/unittests/test_datasource/test_altcloud.py
1012
index a4dfb54..3253f3a 100644
1013
--- a/tests/unittests/test_datasource/test_altcloud.py
1014
+++ b/tests/unittests/test_datasource/test_altcloud.py
1015
@@ -18,7 +18,7 @@ import tempfile
1016
18
from cloudinit import helpers
18
from cloudinit import helpers
1017
19
from cloudinit import util
19
from cloudinit import util
1018
20
20
1020
21
from cloudinit.tests.helpers import TestCase
21
from cloudinit.tests.helpers import CiTestCase
1021
22
22
1022
23
import cloudinit.sources.DataSourceAltCloud as dsac
23
import cloudinit.sources.DataSourceAltCloud as dsac
1023
24
24
1024
@@ -97,7 +97,7 @@ def _dmi_data(expected):
1025
97
    return _data
97
    return _data
1026
98
98
1027
99
99
1029
100
class TestGetCloudType(TestCase):
100
class TestGetCloudType(CiTestCase):
1030
101
    '''
101
    '''
1031
102
    Test to exercise method: DataSourceAltCloud.get_cloud_type()
102
    Test to exercise method: DataSourceAltCloud.get_cloud_type()
1032
103
    '''
103
    '''
1033
@@ -143,14 +143,16 @@ class TestGetCloudType(TestCase):
1034
143
        self.assertEqual('UNKNOWN', dsrc.get_cloud_type())
143
        self.assertEqual('UNKNOWN', dsrc.get_cloud_type())
1035
144
144
1036
145
145
1038
146
class TestGetDataCloudInfoFile(TestCase):
146
class TestGetDataCloudInfoFile(CiTestCase):
1039
147
    '''
147
    '''
1040
148
    Test to exercise method: DataSourceAltCloud.get_data()
148
    Test to exercise method: DataSourceAltCloud.get_data()
1041
149
    With a contrived CLOUD_INFO_FILE
149
    With a contrived CLOUD_INFO_FILE
1042
150
    '''
150
    '''
1043
151
    def setUp(self):
151
    def setUp(self):
1044
152
        '''Set up.'''
152
        '''Set up.'''
1046
153
        self.paths = helpers.Paths({'cloud_dir': '/tmp'})
153
        self.tmp = self.tmp_dir()
1047
154
        self.paths = helpers.Paths(
1048
155
            {'cloud_dir': self.tmp, 'run_dir': self.tmp})
1049
154
        self.cloud_info_file = tempfile.mkstemp()[1]
156
        self.cloud_info_file = tempfile.mkstemp()[1]
1050
155
        self.dmi_data = util.read_dmi_data
157
        self.dmi_data = util.read_dmi_data
1051
156
        dsac.CLOUD_INFO_FILE = self.cloud_info_file
158
        dsac.CLOUD_INFO_FILE = self.cloud_info_file
1052
@@ -207,14 +209,16 @@ class TestGetDataCloudInfoFile(TestCase):
1053
207
        self.assertEqual(False, dsrc.get_data())
209
        self.assertEqual(False, dsrc.get_data())
1054
208
210
1055
209
211
1057
210
class TestGetDataNoCloudInfoFile(TestCase):
212
class TestGetDataNoCloudInfoFile(CiTestCase):
1058
211
    '''
213
    '''
1059
212
    Test to exercise method: DataSourceAltCloud.get_data()
214
    Test to exercise method: DataSourceAltCloud.get_data()
1060
213
    Without a CLOUD_INFO_FILE
215
    Without a CLOUD_INFO_FILE
1061
214
    '''
216
    '''
1062
215
    def setUp(self):
217
    def setUp(self):
1063
216
        '''Set up.'''
218
        '''Set up.'''
1065
217
        self.paths = helpers.Paths({'cloud_dir': '/tmp'})
219
        self.tmp = self.tmp_dir()
1066
220
        self.paths = helpers.Paths(
1067
221
            {'cloud_dir': self.tmp, 'run_dir': self.tmp})
1068
218
        self.dmi_data = util.read_dmi_data
222
        self.dmi_data = util.read_dmi_data
1069
219
        dsac.CLOUD_INFO_FILE = \
223
        dsac.CLOUD_INFO_FILE = \
1070
220
            'no such file'
224
            'no such file'
1071
@@ -254,7 +258,7 @@ class TestGetDataNoCloudInfoFile(TestCase):
1072
254
        self.assertEqual(False, dsrc.get_data())
258
        self.assertEqual(False, dsrc.get_data())
1073
255
259
1074
256
260
1076
257
class TestUserDataRhevm(TestCase):
261
class TestUserDataRhevm(CiTestCase):
1077
258
    '''
262
    '''
1078
259
    Test to exercise method: DataSourceAltCloud.user_data_rhevm()
263
    Test to exercise method: DataSourceAltCloud.user_data_rhevm()
1079
260
    '''
264
    '''
1080
@@ -320,7 +324,7 @@ class TestUserDataRhevm(TestCase):
1081
320
        self.assertEqual(False, dsrc.user_data_rhevm())
324
        self.assertEqual(False, dsrc.user_data_rhevm())
1082
321
325
1083
322
326
1085
323
class TestUserDataVsphere(TestCase):
327
class TestUserDataVsphere(CiTestCase):
1086
324
    '''
328
    '''
1087
325
    Test to exercise method: DataSourceAltCloud.user_data_vsphere()
329
    Test to exercise method: DataSourceAltCloud.user_data_vsphere()
1088
326
    '''
330
    '''
1089
@@ -368,7 +372,7 @@ class TestUserDataVsphere(TestCase):
1090
368
        self.assertEqual(1, m_mount_cb.call_count)
372
        self.assertEqual(1, m_mount_cb.call_count)
1091
369
373
1092
370
374
1094
371
class TestReadUserDataCallback(TestCase):
375
class TestReadUserDataCallback(CiTestCase):
1095
372
    '''
376
    '''
1096
373
    Test to exercise method: DataSourceAltCloud.read_user_data_callback()
377
    Test to exercise method: DataSourceAltCloud.read_user_data_callback()
1097
374
    '''
378
    '''
1098
diff --git a/tests/unittests/test_datasource/test_azure.py b/tests/unittests/test_datasource/test_azure.py
1099
index 7cb1812..226c214 100644
1100
--- a/tests/unittests/test_datasource/test_azure.py
1101
+++ b/tests/unittests/test_datasource/test_azure.py
1102
@@ -11,9 +11,7 @@ from cloudinit.tests.helpers import (CiTestCase, TestCase, populate_dir, mock,
1103
11
11
1104
12
import crypt
12
import crypt
1105
13
import os
13
import os
1106
14
import shutil
1107
15
import stat
14
import stat
1108
16
import tempfile
1109
17
import xml.etree.ElementTree as ET
15
import xml.etree.ElementTree as ET
1110
18
import yaml
16
import yaml
1111
19
17
1112
@@ -84,11 +82,11 @@ class TestAzureDataSource(CiTestCase):
1113
84
        super(TestAzureDataSource, self).setUp()
82
        super(TestAzureDataSource, self).setUp()
1114
85
        if PY26:
83
        if PY26:
1115
86
            raise SkipTest("Does not work on python 2.6")
84
            raise SkipTest("Does not work on python 2.6")
1118
87
        self.tmp = tempfile.mkdtemp()
85
        self.tmp = self.tmp_dir()
1117
88
        self.addCleanup(shutil.rmtree, self.tmp)
1119
89
86
1120
90
        # patch cloud_dir, so our 'seed_dir' is guaranteed empty
87
        # patch cloud_dir, so our 'seed_dir' is guaranteed empty
1122
91
        self.paths = helpers.Paths({'cloud_dir': self.tmp})
88
        self.paths = helpers.Paths(
1123
89
            {'cloud_dir': self.tmp, 'run_dir': self.tmp})
1124
92
        self.waagent_d = os.path.join(self.tmp, 'var', 'lib', 'waagent')
90
        self.waagent_d = os.path.join(self.tmp, 'var', 'lib', 'waagent')
1125
93
91
1126
94
        self.patches = ExitStack()
92
        self.patches = ExitStack()
1127
@@ -642,7 +640,7 @@ fdescfs            /dev/fd          fdescfs rw              0 0
1128
642
        self.assertEqual(netconfig, expected_config)
640
        self.assertEqual(netconfig, expected_config)
1129
643
641
1130
644
642
1132
645
class TestAzureBounce(TestCase):
643
class TestAzureBounce(CiTestCase):
1133
646
644
1134
647
    def mock_out_azure_moving_parts(self):
645
    def mock_out_azure_moving_parts(self):
1135
648
        self.patches.enter_context(
646
        self.patches.enter_context(
1136
@@ -669,10 +667,10 @@ class TestAzureBounce(TestCase):
1137
669
667
1138
670
    def setUp(self):
668
    def setUp(self):
1139
671
        super(TestAzureBounce, self).setUp()
669
        super(TestAzureBounce, self).setUp()
1141
672
        self.tmp = tempfile.mkdtemp()
670
        self.tmp = self.tmp_dir()
1142
673
        self.waagent_d = os.path.join(self.tmp, 'var', 'lib', 'waagent')
671
        self.waagent_d = os.path.join(self.tmp, 'var', 'lib', 'waagent')
1145
674
        self.paths = helpers.Paths({'cloud_dir': self.tmp})
672
        self.paths = helpers.Paths(
1146
675
        self.addCleanup(shutil.rmtree, self.tmp)
673
            {'cloud_dir': self.tmp, 'run_dir': self.tmp})
1147
676
        dsaz.BUILTIN_DS_CONFIG['data_dir'] = self.waagent_d
674
        dsaz.BUILTIN_DS_CONFIG['data_dir'] = self.waagent_d
1148
677
        self.patches = ExitStack()
675
        self.patches = ExitStack()
1149
678
        self.mock_out_azure_moving_parts()
676
        self.mock_out_azure_moving_parts()
1150
@@ -714,21 +712,24 @@ class TestAzureBounce(TestCase):
1151
714
712
1152
715
    def test_disabled_bounce_does_not_change_hostname(self):
713
    def test_disabled_bounce_does_not_change_hostname(self):
1153
716
        cfg = {'hostname_bounce': {'policy': 'off'}}
714
        cfg = {'hostname_bounce': {'policy': 'off'}}
1155
717
        self._get_ds(self.get_ovf_env_with_dscfg('test-host', cfg)).get_data()
715
        ds = self._get_ds(self.get_ovf_env_with_dscfg('test-host', cfg))
1156
716
        ds.get_data()
1157
718
        self.assertEqual(0, self.set_hostname.call_count)
717
        self.assertEqual(0, self.set_hostname.call_count)
1158
719
718
1159
720
    @mock.patch('cloudinit.sources.DataSourceAzure.perform_hostname_bounce')
719
    @mock.patch('cloudinit.sources.DataSourceAzure.perform_hostname_bounce')
1160
721
    def test_disabled_bounce_does_not_perform_bounce(
720
    def test_disabled_bounce_does_not_perform_bounce(
1161
722
            self, perform_hostname_bounce):
721
            self, perform_hostname_bounce):
1162
723
        cfg = {'hostname_bounce': {'policy': 'off'}}
722
        cfg = {'hostname_bounce': {'policy': 'off'}}
1164
724
        self._get_ds(self.get_ovf_env_with_dscfg('test-host', cfg)).get_data()
723
        ds = self._get_ds(self.get_ovf_env_with_dscfg('test-host', cfg))
1165
724
        ds.get_data()
1166
725
        self.assertEqual(0, perform_hostname_bounce.call_count)
725
        self.assertEqual(0, perform_hostname_bounce.call_count)
1167
726
726
1168
727
    def test_same_hostname_does_not_change_hostname(self):
727
    def test_same_hostname_does_not_change_hostname(self):
1169
728
        host_name = 'unchanged-host-name'
728
        host_name = 'unchanged-host-name'
1170
729
        self.get_hostname.return_value = host_name
729
        self.get_hostname.return_value = host_name
1171
730
        cfg = {'hostname_bounce': {'policy': 'yes'}}
730
        cfg = {'hostname_bounce': {'policy': 'yes'}}
1173
731
        self._get_ds(self.get_ovf_env_with_dscfg(host_name, cfg)).get_data()
731
        ds = self._get_ds(self.get_ovf_env_with_dscfg(host_name, cfg))
1174
732
        ds.get_data()
1175
732
        self.assertEqual(0, self.set_hostname.call_count)
733
        self.assertEqual(0, self.set_hostname.call_count)
1176
733
734
1177
734
    @mock.patch('cloudinit.sources.DataSourceAzure.perform_hostname_bounce')
735
    @mock.patch('cloudinit.sources.DataSourceAzure.perform_hostname_bounce')
1178
@@ -737,7 +738,8 @@ class TestAzureBounce(TestCase):
1179
737
        host_name = 'unchanged-host-name'
738
        host_name = 'unchanged-host-name'
1180
738
        self.get_hostname.return_value = host_name
739
        self.get_hostname.return_value = host_name
1181
739
        cfg = {'hostname_bounce': {'policy': 'yes'}}
740
        cfg = {'hostname_bounce': {'policy': 'yes'}}
1183
740
        self._get_ds(self.get_ovf_env_with_dscfg(host_name, cfg)).get_data()
741
        ds = self._get_ds(self.get_ovf_env_with_dscfg(host_name, cfg))
1184
742
        ds.get_data()
1185
741
        self.assertEqual(0, perform_hostname_bounce.call_count)
743
        self.assertEqual(0, perform_hostname_bounce.call_count)
1186
742
744
1187
743
    @mock.patch('cloudinit.sources.DataSourceAzure.perform_hostname_bounce')
745
    @mock.patch('cloudinit.sources.DataSourceAzure.perform_hostname_bounce')
1188
diff --git a/tests/unittests/test_datasource/test_azure_helper.py b/tests/unittests/test_datasource/test_azure_helper.py
1189
index 0c468dc..b42b073 100644
1190
--- a/tests/unittests/test_datasource/test_azure_helper.py
1191
+++ b/tests/unittests/test_datasource/test_azure_helper.py
1192
@@ -4,11 +4,7 @@ import os
1193
4
from textwrap import dedent
4
from textwrap import dedent
1194
5
5
1195
6
from cloudinit.sources.helpers import azure as azure_helper
6
from cloudinit.sources.helpers import azure as azure_helper
1196
7
<<<<<<< tests/unittests/test_datasource/test_azure_helper.py
1197
8
from cloudinit.tests.helpers import CiTestCase, ExitStack, mock, populate_dir
7
from cloudinit.tests.helpers import CiTestCase, ExitStack, mock, populate_dir
1198
9
=======
1199
10
from cloudinit.tests.helpers import ExitStack, mock, TestCase
1200
11
>>>>>>> tests/unittests/test_datasource/test_azure_helper.py
1201
12
8
1202
13
from cloudinit.sources.helpers.azure import WALinuxAgentShim as wa_shim
9
from cloudinit.sources.helpers.azure import WALinuxAgentShim as wa_shim
1203
14
10
1204
diff --git a/tests/unittests/test_datasource/test_cloudsigma.py b/tests/unittests/test_datasource/test_cloudsigma.py
1205
index e4c5990..f6a59b6 100644
1206
--- a/tests/unittests/test_datasource/test_cloudsigma.py
1207
+++ b/tests/unittests/test_datasource/test_cloudsigma.py
1208
@@ -3,6 +3,7 @@
1209
3
import copy
3
import copy
1210
4
4
1211
5
from cloudinit.cs_utils import Cepko
5
from cloudinit.cs_utils import Cepko
1212
6
from cloudinit import helpers
1213
6
from cloudinit import sources
7
from cloudinit import sources
1214
7
from cloudinit.sources import DataSourceCloudSigma
8
from cloudinit.sources import DataSourceCloudSigma
1215
8
9
1216
@@ -38,10 +39,12 @@ class CepkoMock(Cepko):
1217
38
        return self
39
        return self
1218
39
40
1219
40
41
1221
41
class DataSourceCloudSigmaTest(test_helpers.TestCase):
42
class DataSourceCloudSigmaTest(test_helpers.CiTestCase):
1222
42
    def setUp(self):
43
    def setUp(self):
1223
43
        super(DataSourceCloudSigmaTest, self).setUp()
44
        super(DataSourceCloudSigmaTest, self).setUp()
1225
44
        self.datasource = DataSourceCloudSigma.DataSourceCloudSigma("", "", "")
45
        self.paths = helpers.Paths({'run_dir': self.tmp_dir()})
1226
46
        self.datasource = DataSourceCloudSigma.DataSourceCloudSigma(
1227
47
            "", "", paths=self.paths)
1228
45
        self.datasource.is_running_in_cloudsigma = lambda: True
48
        self.datasource.is_running_in_cloudsigma = lambda: True
1229
46
        self.datasource.cepko = CepkoMock(SERVER_CONTEXT)
49
        self.datasource.cepko = CepkoMock(SERVER_CONTEXT)
1230
47
        self.datasource.get_data()
50
        self.datasource.get_data()
1231
@@ -85,7 +88,8 @@ class DataSourceCloudSigmaTest(test_helpers.TestCase):
1232
85
    def test_lack_of_vendor_data(self):
88
    def test_lack_of_vendor_data(self):
1233
86
        stripped_context = copy.deepcopy(SERVER_CONTEXT)
89
        stripped_context = copy.deepcopy(SERVER_CONTEXT)
1234
87
        del stripped_context["vendor_data"]
90
        del stripped_context["vendor_data"]
1236
88
        self.datasource = DataSourceCloudSigma.DataSourceCloudSigma("", "", "")
91
        self.datasource = DataSourceCloudSigma.DataSourceCloudSigma(
1237
92
            "", "", paths=self.paths)
1238
89
        self.datasource.cepko = CepkoMock(stripped_context)
93
        self.datasource.cepko = CepkoMock(stripped_context)
1239
90
        self.datasource.get_data()
94
        self.datasource.get_data()
1240
91
95
1241
@@ -94,7 +98,8 @@ class DataSourceCloudSigmaTest(test_helpers.TestCase):
1242
94
    def test_lack_of_cloudinit_key_in_vendor_data(self):
98
    def test_lack_of_cloudinit_key_in_vendor_data(self):
1243
95
        stripped_context = copy.deepcopy(SERVER_CONTEXT)
99
        stripped_context = copy.deepcopy(SERVER_CONTEXT)
1244
96
        del stripped_context["vendor_data"]["cloudinit"]
100
        del stripped_context["vendor_data"]["cloudinit"]
1246
97
        self.datasource = DataSourceCloudSigma.DataSourceCloudSigma("", "", "")
101
        self.datasource = DataSourceCloudSigma.DataSourceCloudSigma(
1247
102
            "", "", paths=self.paths)
1248
98
        self.datasource.cepko = CepkoMock(stripped_context)
103
        self.datasource.cepko = CepkoMock(stripped_context)
1249
99
        self.datasource.get_data()
104
        self.datasource.get_data()
1250
100
105
1251
diff --git a/tests/unittests/test_datasource/test_cloudstack.py b/tests/unittests/test_datasource/test_cloudstack.py
1252
index 180ebee..d6d2d6b 100644
1253
--- a/tests/unittests/test_datasource/test_cloudstack.py
1254
+++ b/tests/unittests/test_datasource/test_cloudstack.py
1255
@@ -5,11 +5,7 @@ from cloudinit import util
1256
5
from cloudinit.sources.DataSourceCloudStack import (
5
from cloudinit.sources.DataSourceCloudStack import (
1257
6
    DataSourceCloudStack, get_latest_lease)
6
    DataSourceCloudStack, get_latest_lease)
1258
7
7
1259
8
<<<<<<< tests/unittests/test_datasource/test_cloudstack.py
1260
9
from cloudinit.tests.helpers import CiTestCase, ExitStack, mock
8
from cloudinit.tests.helpers import CiTestCase, ExitStack, mock
1261
10
=======
1262
11
from cloudinit.tests.helpers import TestCase, mock, ExitStack
1263
12
>>>>>>> tests/unittests/test_datasource/test_cloudstack.py
1264
13
9
1265
14
import os
10
import os
1266
15
import time
11
import time
1267
@@ -37,6 +33,7 @@ class TestCloudStackPasswordFetching(CiTestCase):
1268
37
        self.patches.enter_context(mock.patch(
33
        self.patches.enter_context(mock.patch(
1269
38
            mod_name + '.dhcp.networkd_get_option_from_leases',
34
            mod_name + '.dhcp.networkd_get_option_from_leases',
1270
39
            get_networkd_server_address))
35
            get_networkd_server_address))
1271
36
        self.tmp = self.tmp_dir()
1272
40
37
1273
41
    def _set_password_server_response(self, response_string):
38
    def _set_password_server_response(self, response_string):
1274
42
        subp = mock.MagicMock(return_value=(response_string, ''))
39
        subp = mock.MagicMock(return_value=(response_string, ''))
1275
@@ -47,26 +44,30 @@ class TestCloudStackPasswordFetching(CiTestCase):
1276
47
44
1277
48
    def test_empty_password_doesnt_create_config(self):
45
    def test_empty_password_doesnt_create_config(self):
1278
49
        self._set_password_server_response('')
46
        self._set_password_server_response('')
1280
50
        ds = DataSourceCloudStack({}, None, helpers.Paths({}))
47
        ds = DataSourceCloudStack(
1281
48
            {}, None, helpers.Paths({'run_dir': self.tmp}))
1282
51
        ds.get_data()
49
        ds.get_data()
1283
52
        self.assertEqual({}, ds.get_config_obj())
50
        self.assertEqual({}, ds.get_config_obj())
1284
53
51
1285
54
    def test_saved_password_doesnt_create_config(self):
52
    def test_saved_password_doesnt_create_config(self):
1286
55
        self._set_password_server_response('saved_password')
53
        self._set_password_server_response('saved_password')
1288
56
        ds = DataSourceCloudStack({}, None, helpers.Paths({}))
54
        ds = DataSourceCloudStack(
1289
55
            {}, None, helpers.Paths({'run_dir': self.tmp}))
1290
57
        ds.get_data()
56
        ds.get_data()
1291
58
        self.assertEqual({}, ds.get_config_obj())
57
        self.assertEqual({}, ds.get_config_obj())
1292
59
58
1293
60
    def test_password_sets_password(self):
59
    def test_password_sets_password(self):
1294
61
        password = 'SekritSquirrel'
60
        password = 'SekritSquirrel'
1295
62
        self._set_password_server_response(password)
61
        self._set_password_server_response(password)
1297
63
        ds = DataSourceCloudStack({}, None, helpers.Paths({}))
62
        ds = DataSourceCloudStack(
1298
63
            {}, None, helpers.Paths({'run_dir': self.tmp}))
1299
64
        ds.get_data()
64
        ds.get_data()
1300
65
        self.assertEqual(password, ds.get_config_obj()['password'])
65
        self.assertEqual(password, ds.get_config_obj()['password'])
1301
66
66
1302
67
    def test_bad_request_doesnt_stop_ds_from_working(self):
67
    def test_bad_request_doesnt_stop_ds_from_working(self):
1303
68
        self._set_password_server_response('bad_request')
68
        self._set_password_server_response('bad_request')
1305
69
        ds = DataSourceCloudStack({}, None, helpers.Paths({}))
69
        ds = DataSourceCloudStack(
1306
70
            {}, None, helpers.Paths({'run_dir': self.tmp}))
1307
70
        self.assertTrue(ds.get_data())
71
        self.assertTrue(ds.get_data())
1308
71
72
1309
72
    def assertRequestTypesSent(self, subp, expected_request_types):
73
    def assertRequestTypesSent(self, subp, expected_request_types):
1310
@@ -81,14 +82,16 @@ class TestCloudStackPasswordFetching(CiTestCase):
1311
81
    def test_valid_response_means_password_marked_as_saved(self):
82
    def test_valid_response_means_password_marked_as_saved(self):
1312
82
        password = 'SekritSquirrel'
83
        password = 'SekritSquirrel'
1313
83
        subp = self._set_password_server_response(password)
84
        subp = self._set_password_server_response(password)
1315
84
        ds = DataSourceCloudStack({}, None, helpers.Paths({}))
85
        ds = DataSourceCloudStack(
1316
86
            {}, None, helpers.Paths({'run_dir': self.tmp}))
1317
85
        ds.get_data()
87
        ds.get_data()
1318
86
        self.assertRequestTypesSent(subp,
88
        self.assertRequestTypesSent(subp,
1319
87
                                    ['send_my_password', 'saved_password'])
89
                                    ['send_my_password', 'saved_password'])
1320
88
90
1321
89
    def _check_password_not_saved_for(self, response_string):
91
    def _check_password_not_saved_for(self, response_string):
1322
90
        subp = self._set_password_server_response(response_string)
92
        subp = self._set_password_server_response(response_string)
1324
91
        ds = DataSourceCloudStack({}, None, helpers.Paths({}))
93
        ds = DataSourceCloudStack(
1325
94
            {}, None, helpers.Paths({'run_dir': self.tmp}))
1326
92
        ds.get_data()
95
        ds.get_data()
1327
93
        self.assertRequestTypesSent(subp, ['send_my_password'])
96
        self.assertRequestTypesSent(subp, ['send_my_password'])
1328
94
97
1329
diff --git a/tests/unittests/test_datasource/test_configdrive.py b/tests/unittests/test_datasource/test_configdrive.py
1330
index 237c189..9849788 100644
1331
--- a/tests/unittests/test_datasource/test_configdrive.py
1332
+++ b/tests/unittests/test_datasource/test_configdrive.py
1333
@@ -725,8 +725,9 @@ class TestConvertNetworkData(TestCase):
1334
725
725
1335
726
726
1336
727
def cfg_ds_from_dir(seed_d):
727
def cfg_ds_from_dir(seed_d):
1337
728
    tmp = tempfile.mkdtemp()
1338
728
    cfg_ds = ds.DataSourceConfigDrive(settings.CFG_BUILTIN, None,
729
    cfg_ds = ds.DataSourceConfigDrive(settings.CFG_BUILTIN, None,
1340
729
                                      helpers.Paths({}))
730
                                      helpers.Paths({'run_dir': tmp}))
1341
730
    cfg_ds.seed_dir = seed_d
731
    cfg_ds.seed_dir = seed_d
1342
731
    cfg_ds.known_macs = KNOWN_MACS.copy()
732
    cfg_ds.known_macs = KNOWN_MACS.copy()
1343
732
    if not cfg_ds.get_data():
733
    if not cfg_ds.get_data():
1344
diff --git a/tests/unittests/test_datasource/test_digitalocean.py b/tests/unittests/test_datasource/test_digitalocean.py
1345
index f264f36..ec32173 100644
1346
--- a/tests/unittests/test_datasource/test_digitalocean.py
1347
+++ b/tests/unittests/test_datasource/test_digitalocean.py
1348
@@ -13,7 +13,7 @@ from cloudinit import settings
1349
13
from cloudinit.sources import DataSourceDigitalOcean
13
from cloudinit.sources import DataSourceDigitalOcean
1350
14
from cloudinit.sources.helpers import digitalocean
14
from cloudinit.sources.helpers import digitalocean
1351
15
15
1353
16
from cloudinit.tests.helpers import mock, TestCase
16
from cloudinit.tests.helpers import mock, CiTestCase
1354
17
17
1355
18
DO_MULTIPLE_KEYS = ["ssh-rsa AAAAB3NzaC1yc2EAAAA... test1@do.co",
18
DO_MULTIPLE_KEYS = ["ssh-rsa AAAAB3NzaC1yc2EAAAA... test1@do.co",
1356
19
                    "ssh-rsa AAAAB3NzaC1yc2EAAAA... test2@do.co"]
19
                    "ssh-rsa AAAAB3NzaC1yc2EAAAA... test2@do.co"]
1357
@@ -135,14 +135,17 @@ def _mock_dmi():
1358
135
    return (True, DO_META.get('id'))
135
    return (True, DO_META.get('id'))
1359
136
136
1360
137
137
1362
138
class TestDataSourceDigitalOcean(TestCase):
138
class TestDataSourceDigitalOcean(CiTestCase):
1363
139
    """
139
    """
1364
140
    Test reading the meta-data
140
    Test reading the meta-data
1365
141
    """
141
    """
1366
142
    def setUp(self):
1367
143
        super(TestDataSourceDigitalOcean, self).setUp()
1368
144
        self.tmp = self.tmp_dir()
1369
142
145
1370
143
    def get_ds(self, get_sysinfo=_mock_dmi):
146
    def get_ds(self, get_sysinfo=_mock_dmi):
1371
144
        ds = DataSourceDigitalOcean.DataSourceDigitalOcean(
147
        ds = DataSourceDigitalOcean.DataSourceDigitalOcean(
1373
145
            settings.CFG_BUILTIN, None, helpers.Paths({}))
148
            settings.CFG_BUILTIN, None, helpers.Paths({'run_dir': self.tmp}))
1374
146
        ds.use_ip4LL = False
149
        ds.use_ip4LL = False
1375
147
        if get_sysinfo is not None:
150
        if get_sysinfo is not None:
1376
148
            ds._get_sysinfo = get_sysinfo
151
            ds._get_sysinfo = get_sysinfo
1377
@@ -194,7 +197,7 @@ class TestDataSourceDigitalOcean(TestCase):
1378
194
        self.assertIsInstance(ds.get_public_ssh_keys(), list)
197
        self.assertIsInstance(ds.get_public_ssh_keys(), list)
1379
195
198
1380
196
199
1382
197
class TestNetworkConvert(TestCase):
200
class TestNetworkConvert(CiTestCase):
1383
198
201
1384
199
    @mock.patch('cloudinit.net.get_interfaces_by_mac')
202
    @mock.patch('cloudinit.net.get_interfaces_by_mac')
1385
200
    def _get_networking(self, m_get_by_mac):
203
    def _get_networking(self, m_get_by_mac):
1386
diff --git a/tests/unittests/test_datasource/test_ec2.py b/tests/unittests/test_datasource/test_ec2.py
1387
index ba328ee..ba042ea 100644
1388
--- a/tests/unittests/test_datasource/test_ec2.py
1389
+++ b/tests/unittests/test_datasource/test_ec2.py
1390
@@ -186,6 +186,7 @@ class TestEc2(test_helpers.HttprettyTestCase):
1391
186
        super(TestEc2, self).setUp()
186
        super(TestEc2, self).setUp()
1392
187
        self.datasource = ec2.DataSourceEc2
187
        self.datasource = ec2.DataSourceEc2
1393
188
        self.metadata_addr = self.datasource.metadata_urls[0]
188
        self.metadata_addr = self.datasource.metadata_urls[0]
1394
189
        self.tmp = self.tmp_dir()
1395
189
190
1396
190
    def data_url(self, version):
191
    def data_url(self, version):
1397
191
        """Return a metadata url based on the version provided."""
192
        """Return a metadata url based on the version provided."""
1398
@@ -199,7 +200,7 @@ class TestEc2(test_helpers.HttprettyTestCase):
1399
199
    def _setup_ds(self, sys_cfg, platform_data, md, md_version=None):
200
    def _setup_ds(self, sys_cfg, platform_data, md, md_version=None):
1400
200
        self.uris = []
201
        self.uris = []
1401
201
        distro = {}
202
        distro = {}
1403
202
        paths = helpers.Paths({})
203
        paths = helpers.Paths({'run_dir': self.tmp})
1404
203
        if sys_cfg is None:
204
        if sys_cfg is None:
1405
204
            sys_cfg = {}
205
            sys_cfg = {}
1406
205
        ds = self.datasource(sys_cfg=sys_cfg, distro=distro, paths=paths)
206
        ds = self.datasource(sys_cfg=sys_cfg, distro=distro, paths=paths)
1407
diff --git a/tests/unittests/test_datasource/test_gce.py b/tests/unittests/test_datasource/test_gce.py
1408
index d399ae7..82c788d 100644
1409
--- a/tests/unittests/test_datasource/test_gce.py
1410
+++ b/tests/unittests/test_datasource/test_gce.py
1411
@@ -70,9 +70,10 @@ def _set_mock_metadata(gce_meta=None):
1412
70
class TestDataSourceGCE(test_helpers.HttprettyTestCase):
70
class TestDataSourceGCE(test_helpers.HttprettyTestCase):
1413
71
71
1414
72
    def setUp(self):
72
    def setUp(self):
1415
73
        tmp = self.tmp_dir()
1416
73
        self.ds = DataSourceGCE.DataSourceGCE(
74
        self.ds = DataSourceGCE.DataSourceGCE(
1417
74
            settings.CFG_BUILTIN, None,
75
            settings.CFG_BUILTIN, None,
1419
75
            helpers.Paths({}))
76
            helpers.Paths({'run_dir': tmp}))
1420
76
        ppatch = self.m_platform_reports_gce = mock.patch(
77
        ppatch = self.m_platform_reports_gce = mock.patch(
1421
77
            'cloudinit.sources.DataSourceGCE.platform_reports_gce')
78
            'cloudinit.sources.DataSourceGCE.platform_reports_gce')
1422
78
        self.m_platform_reports_gce = ppatch.start()
79
        self.m_platform_reports_gce = ppatch.start()
1423
diff --git a/tests/unittests/test_datasource/test_nocloud.py b/tests/unittests/test_datasource/test_nocloud.py
1424
index fea9156..70d50de 100644
1425
--- a/tests/unittests/test_datasource/test_nocloud.py
1426
+++ b/tests/unittests/test_datasource/test_nocloud.py
1427
@@ -3,22 +3,20 @@
1428
3
from cloudinit import helpers
3
from cloudinit import helpers
1429
4
from cloudinit.sources import DataSourceNoCloud
4
from cloudinit.sources import DataSourceNoCloud
1430
5
from cloudinit import util
5
from cloudinit import util
1432
6
from cloudinit.tests.helpers import TestCase, populate_dir, mock, ExitStack
6
from cloudinit.tests.helpers import CiTestCase, populate_dir, mock, ExitStack
1433
7
7
1434
8
import os
8
import os
1435
9
import shutil
1436
10
import tempfile
1437
11
import textwrap
9
import textwrap
1438
12
import yaml
10
import yaml
1439
13
11
1440
14
12
1442
15
class TestNoCloudDataSource(TestCase):
13
class TestNoCloudDataSource(CiTestCase):
1443
16
14
1444
17
    def setUp(self):
15
    def setUp(self):
1445
18
        super(TestNoCloudDataSource, self).setUp()
16
        super(TestNoCloudDataSource, self).setUp()
1449
19
        self.tmp = tempfile.mkdtemp()
17
        self.tmp = self.tmp_dir()
1450
20
        self.addCleanup(shutil.rmtree, self.tmp)
18
        self.paths = helpers.Paths(
1451
21
        self.paths = helpers.Paths({'cloud_dir': self.tmp})
19
            {'cloud_dir': self.tmp, 'run_dir': self.tmp})
1452
22
20
1453
23
        self.cmdline = "root=TESTCMDLINE"
21
        self.cmdline = "root=TESTCMDLINE"
1454
24
22
1455
@@ -215,7 +213,7 @@ class TestNoCloudDataSource(TestCase):
1456
215
        self.assertNotIn(gateway, str(dsrc.network_config))
213
        self.assertNotIn(gateway, str(dsrc.network_config))
1457
216
214
1458
217
215
1460
218
class TestParseCommandLineData(TestCase):
216
class TestParseCommandLineData(CiTestCase):
1461
219
217
1462
220
    def test_parse_cmdline_data_valid(self):
218
    def test_parse_cmdline_data_valid(self):
1463
221
        ds_id = "ds=nocloud"
219
        ds_id = "ds=nocloud"
1464
diff --git a/tests/unittests/test_datasource/test_opennebula.py b/tests/unittests/test_datasource/test_opennebula.py
1465
index e7d5569..2326dd5 100644
1466
--- a/tests/unittests/test_datasource/test_opennebula.py
1467
+++ b/tests/unittests/test_datasource/test_opennebula.py
1468
@@ -3,12 +3,10 @@
1469
3
from cloudinit import helpers
3
from cloudinit import helpers
1470
4
from cloudinit.sources import DataSourceOpenNebula as ds
4
from cloudinit.sources import DataSourceOpenNebula as ds
1471
5
from cloudinit import util
5
from cloudinit import util
1473
6
from cloudinit.tests.helpers import mock, populate_dir, TestCase
6
from cloudinit.tests.helpers import mock, populate_dir, CiTestCase
1474
7
7
1475
8
import os
8
import os
1476
9
import pwd
9
import pwd
1477
10
import shutil
1478
11
import tempfile
1479
12
import unittest
10
import unittest
1480
13
11
1481
14
12
1482
@@ -36,14 +34,14 @@ PUBLIC_IP = '10.0.0.3'
1483
36
DS_PATH = "cloudinit.sources.DataSourceOpenNebula"
34
DS_PATH = "cloudinit.sources.DataSourceOpenNebula"
1484
37
35
1485
38
36
1487
39
class TestOpenNebulaDataSource(TestCase):
37
class TestOpenNebulaDataSource(CiTestCase):
1488
40
    parsed_user = None
38
    parsed_user = None
1489
41
39
1490
42
    def setUp(self):
40
    def setUp(self):
1491
43
        super(TestOpenNebulaDataSource, self).setUp()
41
        super(TestOpenNebulaDataSource, self).setUp()
1495
44
        self.tmp = tempfile.mkdtemp()
42
        self.tmp = self.tmp_dir()
1496
45
        self.addCleanup(shutil.rmtree, self.tmp)
43
        self.paths = helpers.Paths(
1497
46
        self.paths = helpers.Paths({'cloud_dir': self.tmp})
44
            {'cloud_dir': self.tmp, 'run_dir': self.tmp})
1498
47
45
1499
48
        # defaults for few tests
46
        # defaults for few tests
1500
49
        self.ds = ds.DataSourceOpenNebula
47
        self.ds = ds.DataSourceOpenNebula
1501
diff --git a/tests/unittests/test_datasource/test_openstack.py b/tests/unittests/test_datasource/test_openstack.py
1502
index ed367e0..42c3155 100644
1503
--- a/tests/unittests/test_datasource/test_openstack.py
1504
+++ b/tests/unittests/test_datasource/test_openstack.py
1505
@@ -131,6 +131,10 @@ def _read_metadata_service():
1506
131
class TestOpenStackDataSource(test_helpers.HttprettyTestCase):
131
class TestOpenStackDataSource(test_helpers.HttprettyTestCase):
1507
132
    VERSION = 'latest'
132
    VERSION = 'latest'
1508
133
133
1509
134
    def setUp(self):
1510
135
        super(TestOpenStackDataSource, self).setUp()
1511
136
        self.tmp = self.tmp_dir()
1512
137
1513
134
    @hp.activate
138
    @hp.activate
1514
135
    def test_successful(self):
139
    def test_successful(self):
1515
136
        _register_uris(self.VERSION, EC2_FILES, EC2_META, OS_FILES)
140
        _register_uris(self.VERSION, EC2_FILES, EC2_META, OS_FILES)
1516
@@ -232,7 +236,7 @@ class TestOpenStackDataSource(test_helpers.HttprettyTestCase):
1517
232
        _register_uris(self.VERSION, EC2_FILES, EC2_META, OS_FILES)
236
        _register_uris(self.VERSION, EC2_FILES, EC2_META, OS_FILES)
1518
233
        ds_os = ds.DataSourceOpenStack(settings.CFG_BUILTIN,
237
        ds_os = ds.DataSourceOpenStack(settings.CFG_BUILTIN,
1519
234
                                       None,
238
                                       None,
1521
235
                                       helpers.Paths({}))
239
                                       helpers.Paths({'run_dir': self.tmp}))
1522
236
        self.assertIsNone(ds_os.version)
240
        self.assertIsNone(ds_os.version)
1523
237
        found = ds_os.get_data()
241
        found = ds_os.get_data()
1524
238
        self.assertTrue(found)
242
        self.assertTrue(found)
1525
@@ -256,7 +260,7 @@ class TestOpenStackDataSource(test_helpers.HttprettyTestCase):
1526
256
        _register_uris(self.VERSION, {}, {}, os_files)
260
        _register_uris(self.VERSION, {}, {}, os_files)
1527
257
        ds_os = ds.DataSourceOpenStack(settings.CFG_BUILTIN,
261
        ds_os = ds.DataSourceOpenStack(settings.CFG_BUILTIN,
1528
258
                                       None,
262
                                       None,
1530
259
                                       helpers.Paths({}))
263
                                       helpers.Paths({'run_dir': self.tmp}))
1531
260
        self.assertIsNone(ds_os.version)
264
        self.assertIsNone(ds_os.version)
1532
261
        found = ds_os.get_data()
265
        found = ds_os.get_data()
1533
262
        self.assertFalse(found)
266
        self.assertFalse(found)
1534
@@ -271,7 +275,7 @@ class TestOpenStackDataSource(test_helpers.HttprettyTestCase):
1535
271
        _register_uris(self.VERSION, {}, {}, os_files)
275
        _register_uris(self.VERSION, {}, {}, os_files)
1536
272
        ds_os = ds.DataSourceOpenStack(settings.CFG_BUILTIN,
276
        ds_os = ds.DataSourceOpenStack(settings.CFG_BUILTIN,
1537
273
                                       None,
277
                                       None,
1539
274
                                       helpers.Paths({}))
278
                                       helpers.Paths({'run_dir': self.tmp}))
1540
275
        ds_os.ds_cfg = {
279
        ds_os.ds_cfg = {
1541
276
            'max_wait': 0,
280
            'max_wait': 0,
1542
277
            'timeout': 0,
281
            'timeout': 0,
1543
@@ -294,7 +298,7 @@ class TestOpenStackDataSource(test_helpers.HttprettyTestCase):
1544
294
        _register_uris(self.VERSION, {}, {}, os_files)
298
        _register_uris(self.VERSION, {}, {}, os_files)
1545
295
        ds_os = ds.DataSourceOpenStack(settings.CFG_BUILTIN,
299
        ds_os = ds.DataSourceOpenStack(settings.CFG_BUILTIN,
1546
296
                                       None,
300
                                       None,
1548
297
                                       helpers.Paths({}))
301
                                       helpers.Paths({'run_dir': self.tmp}))
1549
298
        ds_os.ds_cfg = {
302
        ds_os.ds_cfg = {
1550
299
            'max_wait': 0,
303
            'max_wait': 0,
1551
300
            'timeout': 0,
304
            'timeout': 0,
1552
diff --git a/tests/unittests/test_datasource/test_scaleway.py b/tests/unittests/test_datasource/test_scaleway.py
1553
index 436df9e..8dec06b 100644
1554
--- a/tests/unittests/test_datasource/test_scaleway.py
1555
+++ b/tests/unittests/test_datasource/test_scaleway.py
1556
@@ -9,7 +9,7 @@ from cloudinit import helpers
1557
9
from cloudinit import settings
9
from cloudinit import settings
1558
10
from cloudinit.sources import DataSourceScaleway
10
from cloudinit.sources import DataSourceScaleway
1559
11
11
1561
12
from cloudinit.tests.helpers import mock, HttprettyTestCase, TestCase
12
from cloudinit.tests.helpers import mock, HttprettyTestCase, CiTestCase
1562
13
13
1563
14
14
1564
15
class DataResponses(object):
15
class DataResponses(object):
1565
@@ -63,7 +63,11 @@ class MetadataResponses(object):
1566
63
        return 200, headers, json.dumps(cls.FAKE_METADATA)
63
        return 200, headers, json.dumps(cls.FAKE_METADATA)
1567
64
64
1568
65
65
1570
66
class TestOnScaleway(TestCase):
66
class TestOnScaleway(CiTestCase):
1571
67
1572
68
    def setUp(self):
1573
69
        super(TestOnScaleway, self).setUp()
1574
70
        self.tmp = self.tmp_dir()
1575
67
71
1576
68
    def install_mocks(self, fake_dmi, fake_file_exists, fake_cmdline):
72
    def install_mocks(self, fake_dmi, fake_file_exists, fake_cmdline):
1577
69
        mock, faked = fake_dmi
73
        mock, faked = fake_dmi
1578
@@ -91,7 +95,7 @@ class TestOnScaleway(TestCase):
1579
91
95
1580
92
        # When not on Scaleway, get_data() returns False.
96
        # When not on Scaleway, get_data() returns False.
1581
93
        datasource = DataSourceScaleway.DataSourceScaleway(
97
        datasource = DataSourceScaleway.DataSourceScaleway(
1583
94
            settings.CFG_BUILTIN, None, helpers.Paths({})
98
            settings.CFG_BUILTIN, None, helpers.Paths({'run_dir': self.tmp})
1584
95
        )
99
        )
1585
96
        self.assertFalse(datasource.get_data())
100
        self.assertFalse(datasource.get_data())
1586
97
101
1587
@@ -159,8 +163,9 @@ def get_source_address_adapter(*args, **kwargs):
1588
159
class TestDataSourceScaleway(HttprettyTestCase):
163
class TestDataSourceScaleway(HttprettyTestCase):
1589
160
164
1590
161
    def setUp(self):
165
    def setUp(self):
1591
166
        tmp = self.tmp_dir()
1592
162
        self.datasource = DataSourceScaleway.DataSourceScaleway(
167
        self.datasource = DataSourceScaleway.DataSourceScaleway(
1594
163
            settings.CFG_BUILTIN, None, helpers.Paths({})
168
            settings.CFG_BUILTIN, None, helpers.Paths({'run_dir': tmp})
1595
164
        )
169
        )
1596
165
        super(TestDataSourceScaleway, self).setUp()
170
        super(TestDataSourceScaleway, self).setUp()
1597
166
171
1598
diff --git a/tests/unittests/test_datasource/test_smartos.py b/tests/unittests/test_datasource/test_smartos.py
1599
index 933d5b6..88bae5f 100644
1600
--- a/tests/unittests/test_datasource/test_smartos.py
1601
+++ b/tests/unittests/test_datasource/test_smartos.py
1602
@@ -359,7 +359,8 @@ class TestSmartOSDataSource(FilesystemMockingTestCase):
1603
359
359
1604
360
        self.tmp = tempfile.mkdtemp()
360
        self.tmp = tempfile.mkdtemp()
1605
361
        self.addCleanup(shutil.rmtree, self.tmp)
361
        self.addCleanup(shutil.rmtree, self.tmp)
1607
362
        self.paths = c_helpers.Paths({'cloud_dir': self.tmp})
362
        self.paths = c_helpers.Paths(
1608
363
            {'cloud_dir': self.tmp, 'run_dir': self.tmp})
1609
363
364
1610
364
        self.legacy_user_d = os.path.join(self.tmp, 'legacy_user_tmp')
365
        self.legacy_user_d = os.path.join(self.tmp, 'legacy_user_tmp')
1611
365
        os.mkdir(self.legacy_user_d)
366
        os.mkdir(self.legacy_user_d)
1612
diff --git a/tests/unittests/test_ds_identify.py b/tests/unittests/test_ds_identify.py
1613
index 1284e75..7a920d4 100644
1614
--- a/tests/unittests/test_ds_identify.py
1615
+++ b/tests/unittests/test_ds_identify.py
1616
@@ -7,7 +7,7 @@ from uuid import uuid4
1617
7
from cloudinit import safeyaml
7
from cloudinit import safeyaml
1618
8
from cloudinit import util
8
from cloudinit import util
1619
9
from cloudinit.tests.helpers import (
9
from cloudinit.tests.helpers import (
1621
10
    CiTestCase, dir2dict, json_dumps, populate_dir)
10
    CiTestCase, dir2dict, populate_dir)
1622
11
11
1623
12
UNAME_MYSYS = ("Linux bart 4.4.0-62-generic #83-Ubuntu "
12
UNAME_MYSYS = ("Linux bart 4.4.0-62-generic #83-Ubuntu "
1624
13
               "SMP Wed Jan 18 14:10:15 UTC 2017 x86_64 GNU/Linux")
13
               "SMP Wed Jan 18 14:10:15 UTC 2017 x86_64 GNU/Linux")
1625
@@ -319,7 +319,7 @@ def _print_run_output(rc, out, err, cfg, files):
1626
319
        '-- rc = %s --' % rc,
319
        '-- rc = %s --' % rc,
1627
320
        '-- out --', str(out),
320
        '-- out --', str(out),
1628
321
        '-- err --', str(err),
321
        '-- err --', str(err),
1630
322
        '-- cfg --', json_dumps(cfg)]))
322
        '-- cfg --', util.json_dumps(cfg)]))
1631
323
    print('-- files --')
323
    print('-- files --')
1632
324
    for k, v in files.items():
324
    for k, v in files.items():
1633
325
        if "/_shwrap" in k:
325
        if "/_shwrap" in k:
1634
diff --git a/tests/unittests/test_handler/test_handler_chef.py b/tests/unittests/test_handler/test_handler_chef.py
1635
index 002fa19..0136a93 100644
1636
--- a/tests/unittests/test_handler/test_handler_chef.py
1637
+++ b/tests/unittests/test_handler/test_handler_chef.py
1638
@@ -13,12 +13,8 @@ from cloudinit import helpers
1639
13
from cloudinit.sources import DataSourceNone
13
from cloudinit.sources import DataSourceNone
1640
14
from cloudinit import util
14
from cloudinit import util
1641
15
15
1642
16
<<<<<<< tests/unittests/test_handler/test_handler_chef.py
1643
17
from cloudinit.tests.helpers import (
16
from cloudinit.tests.helpers import (
1644
18
    CiTestCase, FilesystemMockingTestCase, mock, skipIf)
17
    CiTestCase, FilesystemMockingTestCase, mock, skipIf)
1645
19
=======
1646
20
from cloudinit.tests import helpers as t_help
1647
21
>>>>>>> tests/unittests/test_handler/test_handler_chef.py
1648
22
18
1649
23
LOG = logging.getLogger(__name__)
19
LOG = logging.getLogger(__name__)
1650
24
20
1651
diff --git a/tests/unittests/test_handler/test_handler_lxd.py b/tests/unittests/test_handler/test_handler_lxd.py
1652
index a8ce315..e0d9ab6 100644
1653
--- a/tests/unittests/test_handler/test_handler_lxd.py
1654
+++ b/tests/unittests/test_handler/test_handler_lxd.py
1655
@@ -4,11 +4,6 @@ from cloudinit.config import cc_lxd
1656
4
from cloudinit.sources import DataSourceNoCloud
4
from cloudinit.sources import DataSourceNoCloud
1657
5
from cloudinit import (distros, helpers, cloud)
5
from cloudinit import (distros, helpers, cloud)
1658
6
from cloudinit.tests import helpers as t_help
6
from cloudinit.tests import helpers as t_help
1659
7
<<<<<<< tests/unittests/test_handler/test_handler_lxd.py
1660
8
=======
1661
9
1662
10
import logging
1663
11
>>>>>>> tests/unittests/test_handler/test_handler_lxd.py
1664
12
7
1665
13
try:
8
try:
1666
14
    from unittest import mock
9
    from unittest import mock
1667
diff --git a/tests/unittests/test_runs/test_merge_run.py b/tests/unittests/test_runs/test_merge_run.py
1668
index add9365..5d3f1ca 100644
1669
--- a/tests/unittests/test_runs/test_merge_run.py
1670
+++ b/tests/unittests/test_runs/test_merge_run.py
1671
@@ -23,6 +23,7 @@ class TestMergeRun(helpers.FilesystemMockingTestCase):
1672
23
        cfg = {
23
        cfg = {
1673
24
            'datasource_list': ['None'],
24
            'datasource_list': ['None'],
1674
25
            'cloud_init_modules': ['write-files'],
25
            'cloud_init_modules': ['write-files'],
1675
26
            'system_info': {'paths': {'run_dir': new_root}}
1676
26
        }
27
        }
1677
27
        ud = self.readResource('user_data.1.txt')
28
        ud = self.readResource('user_data.1.txt')
1678
28
        cloud_cfg = util.yaml_dumps(cfg)
29
        cloud_cfg = util.yaml_dumps(cfg)
1679
diff --git a/tests/unittests/test_runs/test_simple_run.py b/tests/unittests/test_runs/test_simple_run.py
1680
index b8fb479..762974e 100644
1681
--- a/tests/unittests/test_runs/test_simple_run.py
1682
+++ b/tests/unittests/test_runs/test_simple_run.py
1683
@@ -2,10 +2,10 @@
1684
2
2
1685
3
import os
3
import os
1686
4
4
1687
5
from cloudinit.tests import helpers
1688
6
5
1689
7
from cloudinit.settings import PER_INSTANCE
6
from cloudinit.settings import PER_INSTANCE
1690
8
from cloudinit import stages
7
from cloudinit import stages
1691
8
from cloudinit.tests import helpers
1692
9
from cloudinit import util
9
from cloudinit import util
1693
10
10
1694
11
11
1695
@@ -23,6 +23,7 @@ class TestSimpleRun(helpers.FilesystemMockingTestCase):
1696
23
            'datasource_list': ['None'],
23
            'datasource_list': ['None'],
1697
24
            'runcmd': ['ls /etc'],  # test ALL_DISTROS
24
            'runcmd': ['ls /etc'],  # test ALL_DISTROS
1698
25
            'spacewalk': {},  # test non-ubuntu distros module definition
25
            'spacewalk': {},  # test non-ubuntu distros module definition
1699
26
            'system_info': {'paths': {'run_dir': self.new_root}},
1700
26
            'write_files': [
27
            'write_files': [
1701
27
                {
28
                {
1702
28
                    'path': '/etc/blah.ini',
29
                    'path': '/etc/blah.ini',
1703
diff --git a/tests/unittests/test_vmware_config_file.py b/tests/unittests/test_vmware_config_file.py
1704
index 306ee15..808d303 100644
1705
--- a/tests/unittests/test_vmware_config_file.py
1706
+++ b/tests/unittests/test_vmware_config_file.py
1707
@@ -8,7 +8,6 @@
1708
8
import logging
8
import logging
1709
9
import sys
9
import sys
1710
10
10
1711
11
<<<<<<< tests/unittests/test_vmware_config_file.py
1712
12
from cloudinit.sources.DataSourceOVF import get_network_config_from_conf
11
from cloudinit.sources.DataSourceOVF import get_network_config_from_conf
1713
13
from cloudinit.sources.DataSourceOVF import read_vmware_imc
12
from cloudinit.sources.DataSourceOVF import read_vmware_imc
1714
14
from cloudinit.sources.helpers.vmware.imc.boot_proto import BootProtoEnum
13
from cloudinit.sources.helpers.vmware.imc.boot_proto import BootProtoEnum
1715
@@ -16,11 +15,6 @@ from cloudinit.sources.helpers.vmware.imc.config import Config
1716
16
from cloudinit.sources.helpers.vmware.imc.config_file import ConfigFile
15
from cloudinit.sources.helpers.vmware.imc.config_file import ConfigFile
1717
17
from cloudinit.sources.helpers.vmware.imc.config_nic import gen_subnet
16
from cloudinit.sources.helpers.vmware.imc.config_nic import gen_subnet
1718
18
from cloudinit.sources.helpers.vmware.imc.config_nic import NicConfigurator
17
from cloudinit.sources.helpers.vmware.imc.config_nic import NicConfigurator
1719
19
=======
1720
20
from cloudinit.sources.helpers.vmware.imc.boot_proto import BootProtoEnum
1721
21
from cloudinit.sources.helpers.vmware.imc.config import Config
1722
22
from cloudinit.sources.helpers.vmware.imc.config_file import ConfigFile
1723
23
>>>>>>> tests/unittests/test_vmware_config_file.py
1724
24
from cloudinit.tests.helpers import CiTestCase
18
from cloudinit.tests.helpers import CiTestCase
1725
25
19
1726
26
logging.basicConfig(level=logging.DEBUG, stream=sys.stdout)
20
logging.basicConfig(level=logging.DEBUG, stream=sys.stdout)
Status:	Merged
Approved by:	Chad Smith on 2017-12-06
Approved revision:	88aefe1fc382327420b91b71246226e7fc378006
Merged at revision:	0cf6db3617e0cebeb89c4809396f84360827e96c
Proposed branch:	~chad.smith/cloud-init:unify-datasource-get-data
Merge into:	cloud-init:master
Prerequisite:	~chad.smith/cloud-init:feature/move-base-testcase
Diff against target:	1726 lines (+517/-153) 47 files modified cloudinit/analyze/__main__.py (+3/-1) cloudinit/analyze/dump.py (+1/-7) cloudinit/net/tests/test_dhcp.py (+0/-4) cloudinit/sources/DataSourceAliYun.py (+1/-0) cloudinit/sources/DataSourceAltCloud.py (+4/-1) cloudinit/sources/DataSourceAzure.py (+3/-1) cloudinit/sources/DataSourceBigstep.py (+4/-1) cloudinit/sources/DataSourceCloudSigma.py (+4/-1) cloudinit/sources/DataSourceCloudStack.py (+4/-1) cloudinit/sources/DataSourceConfigDrive.py (+4/-1) cloudinit/sources/DataSourceDigitalOcean.py (+4/-1) cloudinit/sources/DataSourceEc2.py (+9/-3) cloudinit/sources/DataSourceGCE.py (+4/-1) cloudinit/sources/DataSourceMAAS.py (+4/-1) cloudinit/sources/DataSourceNoCloud.py (+4/-1) cloudinit/sources/DataSourceNone.py (+4/-1) cloudinit/sources/DataSourceOVF.py (+4/-1) cloudinit/sources/DataSourceOpenNebula.py (+4/-1) cloudinit/sources/DataSourceOpenStack.py (+4/-1) cloudinit/sources/DataSourceScaleway.py (+3/-1) cloudinit/sources/DataSourceSmartOS.py (+4/-1) cloudinit/sources/__init__.py (+116/-13) cloudinit/sources/tests/__init__.py (+0/-0) cloudinit/sources/tests/test_init.py (+202/-0) cloudinit/tests/helpers.py (+0/-10) cloudinit/util.py (+24/-9) tests/unittests/test_datasource/test_aliyun.py (+1/-1) tests/unittests/test_datasource/test_altcloud.py (+13/-9) tests/unittests/test_datasource/test_azure.py (+15/-13) tests/unittests/test_datasource/test_azure_helper.py (+0/-4) tests/unittests/test_datasource/test_cloudsigma.py (+9/-4) tests/unittests/test_datasource/test_cloudstack.py (+13/-10) tests/unittests/test_datasource/test_configdrive.py (+2/-1) tests/unittests/test_datasource/test_digitalocean.py (+7/-4) tests/unittests/test_datasource/test_ec2.py (+2/-1) tests/unittests/test_datasource/test_gce.py (+2/-1) tests/unittests/test_datasource/test_nocloud.py (+6/-8) tests/unittests/test_datasource/test_opennebula.py (+5/-7) tests/unittests/test_datasource/test_openstack.py (+8/-4) tests/unittests/test_datasource/test_scaleway.py (+9/-4) tests/unittests/test_datasource/test_smartos.py (+2/-1) tests/unittests/test_ds_identify.py (+2/-2) tests/unittests/test_handler/test_handler_chef.py (+0/-4) tests/unittests/test_handler/test_handler_lxd.py (+0/-5) tests/unittests/test_runs/test_merge_run.py (+1/-0) tests/unittests/test_runs/test_simple_run.py (+2/-1) tests/unittests/test_vmware_config_file.py (+0/-6)
Related bugs:	Link a bug report
Reviewer	Review Type	Date Requested	Status
Scott Moser		2017-09-01	Approve on 2017-12-05
Server Team CI bot	continuous-integration	2017-09-01	Approve on 2017-12-05
Review via email: mp+330115@code.launchpad.net