summaryrefslogtreecommitdiff
path: root/tests/unittests/test_datasource/test_smartos.py
blob: b9b3a4792c633bf890abb86511db511797abc109 (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
# vi: ts=4 expandtab
#
#    Copyright (C) 2013 Canonical Ltd.
#
#    Author: Ben Howard <ben.howard@canonical.com>
#
#    This program is free software: you can redistribute it and/or modify
#    it under the terms of the GNU General Public License version 3, as
#    published by the Free Software Foundation.
#
#    This program is distributed in the hope that it will be useful,
#    but WITHOUT ANY WARRANTY; without even the implied warranty of
#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#    GNU General Public License for more details.
#
#    You should have received a copy of the GNU General Public License
#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
#
#
#   This is a testcase for the SmartOS datasource. It replicates a serial
#   console and acts like the SmartOS console does in order to validate
#   return responses.
#

import base64
from cloudinit import helpers
from cloudinit.sources import DataSourceSmartOS

from mocker import MockerTestCase
import uuid

mock_returns = {
    'hostname': 'test-host',
    'root_authorized_keys': 'ssh-rsa AAAAB3Nz...aC1yc2E= keyname',
    'disable_iptables_flag': None,
    'enable_motd_sys_info': None,
    'system_uuid': str(uuid.uuid4()),
    'smartdc': 'smartdc',
    'test-var1': 'some data',
    'user-data': """
#!/bin/sh
/bin/true
""",
}


class MockSerial(object):
    """Fake a serial terminal for testing the code that
        interfaces with the serial"""

    port = None

    def __init__(self, b64encode=False):
        self.last = None
        self.last = None
        self.new = True
        self.count = 0
        self.mocked_out = []
        self.b64encode = b64encode
        self.b64excluded = DataSourceSmartOS.SMARTOS_NO_BASE64

    def open(self):
        return True

    def close(self):
        return True

    def isOpen(self):
        return True

    def write(self, line):
        line = line.replace('GET ', '')
        self.last = line.rstrip()

    def readline(self):
        if self.new:
            self.new = False
            if self.last in mock_returns:
                return 'SUCCESS\n'
            else:
                return 'NOTFOUND %s\n' % self.last

        if self.last in mock_returns:
            if not self.mocked_out:
                self.mocked_out = [x for x in self._format_out()]
                print self.mocked_out

            if len(self.mocked_out) > self.count:
                self.count += 1
                return self.mocked_out[self.count - 1]

    def _format_out(self):
        if self.last in mock_returns:
            _mret = mock_returns[self.last]
            if self.b64encode and \
               self.last not in self.b64excluded:
                yield base64.b64encode(_mret)

            else:
                try:
                    for l in _mret.splitlines():
                        yield "%s\n" % l.rstrip()
                except:
                    yield "%s\n" % _mret.rstrip()

            yield '\n'
            yield '.'


class TestSmartOSDataSource(MockerTestCase):
    def setUp(self):
        # makeDir comes from MockerTestCase
        self.tmp = self.makeDir()

        # patch cloud_dir, so our 'seed_dir' is guaranteed empty
        self.paths = helpers.Paths({'cloud_dir': self.tmp})

        self.unapply = []
        super(TestSmartOSDataSource, self).setUp()

    def tearDown(self):
        apply_patches([i for i in reversed(self.unapply)])
        super(TestSmartOSDataSource, self).tearDown()

    def apply_patches(self, patches):
        ret = apply_patches(patches)
        self.unapply += ret

    def _get_ds(self, b64encode=False, sys_cfg=None):
        mod = DataSourceSmartOS

        def _get_serial(*_):
            return MockSerial(b64encode=b64encode)

        def _dmi_data():
            return mock_returns['system_uuid'], 'smartdc'

        if not sys_cfg:
            sys_cfg = {}

        data = {'sys_cfg': sys_cfg}
        self.apply_patches([(mod, 'get_serial', _get_serial)])
        self.apply_patches([(mod, 'dmi_data', _dmi_data)])
        dsrc = mod.DataSourceSmartOS(
            data.get('sys_cfg', {}), distro=None, paths=self.paths)
        return dsrc

    def test_seed(self):
        dsrc = self._get_ds()
        ret = dsrc.get_data()
        self.assertTrue(ret)
        self.assertEquals('/dev/ttyS1', dsrc.seed)

    def test_issmartdc(self):
        dsrc = self._get_ds()
        ret = dsrc.get_data()
        self.assertTrue(ret)
        self.assertTrue(dsrc.is_smartdc)

    def test_no_base64(self):
        sys_cfg = {'no_base64_decode': ['test_var1'], 'all_base': True}
        dsrc = self._get_ds(sys_cfg=sys_cfg)
        ret = dsrc.get_data()
        self.assertTrue(ret)
        self.assertTrue(dsrc.not_b64_var('test-var'))

    def test_uuid(self):
        dsrc = self._get_ds()
        ret = dsrc.get_data()
        self.assertTrue(ret)
        self.assertEquals(mock_returns['system_uuid'],
                          dsrc.metadata['instance-id'])

    def test_root_keys(self):
        dsrc = self._get_ds()
        ret = dsrc.get_data()
        self.assertTrue(ret)
        self.assertEquals(mock_returns['root_authorized_keys'],
                          dsrc.metadata['public-keys'])

    def test_hostname_b64(self):
        dsrc = self._get_ds(b64encode=True)
        ret = dsrc.get_data()
        self.assertTrue(ret)
        self.assertEquals(base64.b64encode(mock_returns['hostname']),
                          dsrc.metadata['local-hostname'])

    def test_hostname(self):
        dsrc = self._get_ds()
        ret = dsrc.get_data()
        self.assertTrue(ret)
        self.assertEquals(mock_returns['hostname'],
                          dsrc.metadata['local-hostname'])

    def test_base64(self):
        """This tests to make sure that SmartOS system key/value pairs
            are not interpetted as being base64 encoded, while making
            sure that the others are when 'decode_base64' is set"""
        dsrc = self._get_ds(sys_cfg={'decode_base64': True},
                            b64encode=True)
        ret = dsrc.get_data()
        self.assertTrue(ret)
        self.assertEquals(mock_returns['hostname'],
                          dsrc.metadata['local-hostname'])
        self.assertEquals("%s" % mock_returns['user-data'],
                          dsrc.userdata_raw)
        self.assertEquals(mock_returns['root_authorized_keys'],
                          dsrc.metadata['public-keys'])
        self.assertEquals(mock_returns['disable_iptables_flag'],
                          dsrc.metadata['iptables_disable'])
        self.assertEquals(mock_returns['enable_motd_sys_info'],
                          dsrc.metadata['motd_sys_info'])

    def test_userdata(self):
        dsrc = self._get_ds()
        ret = dsrc.get_data()
        self.assertTrue(ret)
        self.assertEquals("%s\n" % mock_returns['user-data'],
                          dsrc.userdata_raw)

    def test_disable_iptables_flag(self):
        dsrc = self._get_ds()
        ret = dsrc.get_data()
        self.assertTrue(ret)
        self.assertEquals(mock_returns['disable_iptables_flag'],
                          dsrc.metadata['iptables_disable'])

    def test_motd_sys_info(self):
        dsrc = self._get_ds()
        ret = dsrc.get_data()
        self.assertTrue(ret)
        self.assertEquals(mock_returns['enable_motd_sys_info'],
                          dsrc.metadata['motd_sys_info'])


def apply_patches(patches):
    ret = []
    for (ref, name, replace) in patches:
        if replace is None:
            continue
        orig = getattr(ref, name)
        setattr(ref, name, replace)
        ret.append((ref, name, orig))
    return ret