summaryrefslogtreecommitdiff
path: root/tests/unittests/test_datasource/test_digitalocean.py
blob: 9be6bc19f2e4efe9eeb276a8ecf5fb6b56bfdb42 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
# Copyright (C) 2014 Neal Shrader
#
# Author: Neal Shrader <neal@digitalocean.com>
#
# This file is part of cloud-init. See LICENSE file for license information.

import json

from cloudinit import helpers
from cloudinit import settings
from cloudinit.sources import DataSourceDigitalOcean
from cloudinit.sources.helpers import digitalocean

from ..helpers import mock, TestCase

DO_MULTIPLE_KEYS = ["ssh-rsa AAAAB3NzaC1yc2EAAAA... test1@do.co",
                    "ssh-rsa AAAAB3NzaC1yc2EAAAA... test2@do.co"]
DO_SINGLE_KEY = "ssh-rsa AAAAB3NzaC1yc2EAAAA... test@do.co"

# the following JSON was taken from droplet (that's why its a string)
DO_META = json.loads("""
{
  "droplet_id": "22532410",
  "hostname": "utl-96268",
  "vendor_data": "vendordata goes here",
  "user_data": "userdata goes here",
  "public_keys": "",
  "auth_key": "authorization_key",
  "region": "nyc3",
  "interfaces": {
    "private": [
      {
        "ipv4": {
          "ip_address": "10.132.6.205",
          "netmask": "255.255.0.0",
          "gateway": "10.132.0.1"
        },
        "mac": "04:01:57:d1:9e:02",
        "type": "private"
      }
    ],
    "public": [
      {
        "ipv4": {
          "ip_address": "192.0.0.20",
          "netmask": "255.255.255.0",
          "gateway": "104.236.0.1"
        },
        "ipv6": {
          "ip_address": "2604:A880:0800:0000:1000:0000:0000:0000",
          "cidr": 64,
          "gateway": "2604:A880:0800:0000:0000:0000:0000:0001"
        },
        "anchor_ipv4": {
          "ip_address": "10.0.0.5",
          "netmask": "255.255.0.0",
          "gateway": "10.0.0.1"
        },
        "mac": "04:01:57:d1:9e:01",
        "type": "public"
      }
    ]
  },
  "floating_ip": {
    "ipv4": {
      "active": false
    }
  },
  "dns": {
    "nameservers": [
      "2001:4860:4860::8844",
      "2001:4860:4860::8888",
      "8.8.8.8"
    ]
  }
}
""")

# This has no private interface
DO_META_2 = {
    "droplet_id": 27223699,
    "hostname": "smtest1",
    "vendor_data": "\n".join([
        ('"Content-Type: multipart/mixed; '
         'boundary=\"===============8645434374073493512==\"'),
        'MIME-Version: 1.0',
        '',
        '--===============8645434374073493512==',
        'MIME-Version: 1.0'
        'Content-Type: text/cloud-config; charset="us-ascii"'
        'Content-Transfer-Encoding: 7bit'
        'Content-Disposition: attachment; filename="cloud-config"'
        '',
        '#cloud-config',
        'disable_root: false',
        'manage_etc_hosts: true',
        '',
        '',
        '--===============8645434374073493512=='
    ]),
    "public_keys": [
        "ssh-rsa AAAAB3NzaN...N3NtHw== smoser@brickies"
    ],
    "auth_key": "88888888888888888888888888888888",
    "region": "nyc3",
    "interfaces": {
        "public": [{
            "ipv4": {
                "ip_address": "45.55.249.133",
                "netmask": "255.255.192.0",
                "gateway": "45.55.192.1"
            },
            "anchor_ipv4": {
                "ip_address": "10.17.0.5",
                "netmask": "255.255.0.0",
                "gateway": "10.17.0.1"
            },
            "mac": "ae:cc:08:7c:88:00",
            "type": "public"
        }]
    },
    "floating_ip": {"ipv4": {"active": True, "ip_address": "138.197.59.92"}},
    "dns": {"nameservers": ["8.8.8.8", "8.8.4.4"]},
    "tags": None,
}

DO_META['public_keys'] = DO_SINGLE_KEY

MD_URL = 'http://169.254.169.254/metadata/v1.json'


def _mock_dmi():
    return (True, DO_META.get('id'))


class TestDataSourceDigitalOcean(TestCase):
    """
    Test reading the meta-data
    """

    def get_ds(self, get_sysinfo=_mock_dmi):
        ds = DataSourceDigitalOcean.DataSourceDigitalOcean(
            settings.CFG_BUILTIN, None, helpers.Paths({}))
        ds.use_ip4LL = False
        if get_sysinfo is not None:
            ds._get_sysinfo = get_sysinfo
        return ds

    @mock.patch('cloudinit.sources.helpers.digitalocean.read_sysinfo')
    def test_returns_false_not_on_docean(self, m_read_sysinfo):
        m_read_sysinfo.return_value = (False, None)
        ds = self.get_ds(get_sysinfo=None)
        self.assertEqual(False, ds.get_data())
        self.assertTrue(m_read_sysinfo.called)

    @mock.patch('cloudinit.sources.helpers.digitalocean.read_metadata')
    def test_metadata(self, mock_readmd):
        mock_readmd.return_value = DO_META.copy()

        ds = self.get_ds()
        ret = ds.get_data()
        self.assertTrue(ret)

        self.assertTrue(mock_readmd.called)

        self.assertEqual(DO_META.get('user_data'), ds.get_userdata_raw())
        self.assertEqual(DO_META.get('vendor_data'), ds.get_vendordata_raw())
        self.assertEqual(DO_META.get('region'), ds.availability_zone)
        self.assertEqual(DO_META.get('droplet_id'), ds.get_instance_id())
        self.assertEqual(DO_META.get('hostname'), ds.get_hostname())

        # Single key
        self.assertEqual([DO_META.get('public_keys')],
                         ds.get_public_ssh_keys())

        self.assertIsInstance(ds.get_public_ssh_keys(), list)

    @mock.patch('cloudinit.sources.helpers.digitalocean.read_metadata')
    def test_multiple_ssh_keys(self, mock_readmd):
        metadata = DO_META.copy()
        metadata['public_keys'] = DO_MULTIPLE_KEYS
        mock_readmd.return_value = metadata.copy()

        ds = self.get_ds()
        ret = ds.get_data()
        self.assertTrue(ret)

        self.assertTrue(mock_readmd.called)

        # Multiple keys
        self.assertEqual(metadata['public_keys'], ds.get_public_ssh_keys())
        self.assertIsInstance(ds.get_public_ssh_keys(), list)


class TestNetworkConvert(TestCase):

    def _get_networking(self):
        netcfg = digitalocean.convert_network_configuration(
            DO_META['interfaces'], DO_META['dns']['nameservers'])
        self.assertIn('config', netcfg)
        return netcfg

    def test_networking_defined(self):
        netcfg = self._get_networking()
        self.assertIsNotNone(netcfg)

        for nic_def in netcfg.get('config'):
            print(json.dumps(nic_def, indent=3))
            n_type = nic_def.get('type')
            n_subnets = nic_def.get('type')
            n_name = nic_def.get('name')
            n_mac = nic_def.get('mac_address')

            self.assertIsNotNone(n_type)
            self.assertIsNotNone(n_subnets)
            self.assertIsNotNone(n_name)
            self.assertIsNotNone(n_mac)

    def _get_nic_definition(self, int_type, expected_name):
        """helper function to return if_type (i.e. public) and the expected
           name used by cloud-init (i.e eth0)"""
        netcfg = self._get_networking()
        meta_def = (DO_META.get('interfaces')).get(int_type)[0]

        self.assertEqual(int_type, meta_def.get('type'))

        for nic_def in netcfg.get('config'):
            print(nic_def)
            if nic_def.get('name') == expected_name:
                return nic_def, meta_def

    def _get_match_subn(self, subnets, ip_addr):
        """get the matching subnet definition based on ip address"""
        for subn in subnets:
            address = subn.get('address')
            self.assertIsNotNone(address)

            # equals won't work because of ipv6 addressing being in
            # cidr notation, i.e fe00::1/64
            if ip_addr in address:
                print(json.dumps(subn, indent=3))
                return subn

    def test_public_interface_defined(self):
        """test that the public interface is defined as eth0"""
        (nic_def, meta_def) = self._get_nic_definition('public', 'eth0')
        self.assertEqual('eth0', nic_def.get('name'))
        self.assertEqual(meta_def.get('mac'), nic_def.get('mac_address'))
        self.assertEqual('physical', nic_def.get('type'))

    def test_private_interface_defined(self):
        """test that the private interface is defined as eth1"""
        (nic_def, meta_def) = self._get_nic_definition('private', 'eth1')
        self.assertEqual('eth1', nic_def.get('name'))
        self.assertEqual(meta_def.get('mac'), nic_def.get('mac_address'))
        self.assertEqual('physical', nic_def.get('type'))

    def _check_dns_nameservers(self, subn_def):
        self.assertIn('dns_nameservers', subn_def)
        expected_nameservers = DO_META['dns']['nameservers']
        nic_nameservers = subn_def.get('dns_nameservers')
        self.assertEqual(expected_nameservers, nic_nameservers)

    def test_public_interface_ipv6(self):
        """test public ipv6 addressing"""
        (nic_def, meta_def) = self._get_nic_definition('public', 'eth0')
        ipv6_def = meta_def.get('ipv6')
        self.assertIsNotNone(ipv6_def)

        subn_def = self._get_match_subn(nic_def.get('subnets'),
                                        ipv6_def.get('ip_address'))

        cidr_notated_address = "{0}/{1}".format(ipv6_def.get('ip_address'),
                                                ipv6_def.get('cidr'))

        self.assertEqual(cidr_notated_address, subn_def.get('address'))
        self.assertEqual(ipv6_def.get('gateway'), subn_def.get('gateway'))
        self._check_dns_nameservers(subn_def)

    def test_public_interface_ipv4(self):
        """test public ipv4 addressing"""
        (nic_def, meta_def) = self._get_nic_definition('public', 'eth0')
        ipv4_def = meta_def.get('ipv4')
        self.assertIsNotNone(ipv4_def)

        subn_def = self._get_match_subn(nic_def.get('subnets'),
                                        ipv4_def.get('ip_address'))

        self.assertEqual(ipv4_def.get('netmask'), subn_def.get('netmask'))
        self.assertEqual(ipv4_def.get('gateway'), subn_def.get('gateway'))
        self._check_dns_nameservers(subn_def)

    def test_public_interface_anchor_ipv4(self):
        """test public ipv4 addressing"""
        (nic_def, meta_def) = self._get_nic_definition('public', 'eth0')
        ipv4_def = meta_def.get('anchor_ipv4')
        self.assertIsNotNone(ipv4_def)

        subn_def = self._get_match_subn(nic_def.get('subnets'),
                                        ipv4_def.get('ip_address'))

        self.assertEqual(ipv4_def.get('netmask'), subn_def.get('netmask'))
        self.assertNotIn('gateway', subn_def)

    def test_convert_without_private(self):
        netcfg = digitalocean.convert_network_configuration(
            DO_META_2['interfaces'], DO_META_2['dns']['nameservers'])

        byname = {}
        for i in netcfg['config']:
            if 'name' in i:
                if i['name'] in byname:
                    raise ValueError("name '%s' in config twice: %s" %
                                     (i['name'], netcfg))
                byname[i['name']] = i
        self.assertTrue('eth0' in byname)
        self.assertTrue('subnets' in byname['eth0'])
        eth0 = byname['eth0']
        self.assertEqual(
            sorted(['45.55.249.133', '10.17.0.5']),
            sorted([i['address'] for i in eth0['subnets']]))

# vi: ts=4 expandtab