This file is indexed.

/usr/lib/python3/dist-packages/provisioningserver/drivers/hardware/tests/test_seamicro.py is in python3-maas-provisioningserver 2.0.0~beta3+bzr4941-0ubuntu1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  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
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
# Copyright 2014-2016 Canonical Ltd.  This software is licensed under the
# GNU Affero General Public License version 3 (see the file LICENSE).

"""Tests for `provisioningserver.drivers.hardware.seamicro`.
"""

__all__ = []

import json
import urllib.parse

from maastesting.factory import factory
from maastesting.matchers import (
    MockCalledOnceWith,
    MockCalledWith,
    MockCallsMatch,
)
from maastesting.testcase import (
    MAASTestCase,
    MAASTwistedRunTest,
)
from mock import (
    call,
    Mock,
)
from provisioningserver.drivers.hardware import seamicro
from provisioningserver.drivers.hardware.seamicro import (
    find_seamicro15k_servers,
    power_control_seamicro15k_v09,
    power_control_seamicro15k_v2,
    power_query_seamicro15k_v2,
    POWER_STATUS,
    probe_seamicro15k_and_enlist,
    SeaMicroAPIV09,
    SeaMicroAPIV09Error,
    SeaMicroError,
    select_seamicro15k_api_version,
)
from provisioningserver.utils.twisted import asynchronous
from twisted.internet.defer import inlineCallbacks
from twisted.internet.threads import deferToThread


class FakeResponse:

    def __init__(self, response_code, response, is_json=False):
        self.response_code = response_code
        self.response = response
        if is_json:
            self.response = json.dumps(response)

    def getcode(self):
        return self.response_code

    def read(self):
        return self.response


class FakeServer(object):

    def __init__(self, id):
        self.id = id
        self.nic = {}

    def add_fake_nic(self, id):
        self.nic[id] = {'macAddr': factory.make_mac_address()}

    def get_fake_macs(self):
        return [nic['macAddr'] for nic in self.nic.values()]


class FakeSeaMicroServerManager(object):

    def __init__(self):
        self.servers = []

    def get(self, server_id):
        for server in self.servers:
            if server_id == server.id:
                return server
        return None

    def list(self):
        return self.servers


class FakeSeaMicroClient(object):
    pass


class TestSeaMicroAPIV09(MAASTestCase):
    """Tests for SeaMicroAPIV09."""

    def test_build_url(self):
        url = factory.make_string()
        api = SeaMicroAPIV09('http://%s/' % url)
        location = factory.make_string()
        params = [factory.make_string() for _ in range(3)]
        output = api.build_url(location, params)
        parsed = urllib.parse.urlparse(output)
        self.assertEqual(url, parsed.netloc)
        self.assertEqual(location, parsed.path.split('/')[1])
        self.assertEqual(params, parsed.query.split('&'))

    def test_invalid_reponse_code(self):
        url = 'http://%s/' % factory.make_string()
        api = SeaMicroAPIV09(url)
        response = FakeResponse(401, 'Unauthorized')
        self.assertRaises(
            SeaMicroAPIV09Error, api.parse_response,
            url, response)

    def test_invalid_json_response(self):
        url = 'http://%s/' % factory.make_string()
        api = SeaMicroAPIV09(url)
        response = FakeResponse(200, factory.make_string())
        self.assertRaises(
            SeaMicroAPIV09Error, api.parse_response,
            url, response)

    def test_json_error_response(self):
        url = 'http://%s/' % factory.make_string()
        api = SeaMicroAPIV09(url)
        data = {
            'error': {
                'code': 401
                }
            }
        response = FakeResponse(200, data, is_json=True)
        self.assertRaises(
            SeaMicroAPIV09Error, api.parse_response,
            url, response)

    def test_json_valid_response(self):
        url = 'http://%s/' % factory.make_string()
        api = SeaMicroAPIV09(url)
        output = factory.make_string()
        data = {
            'error': {
                'code': 200
                },
            'result': {
                'data': output
                },
            }
        response = FakeResponse(200, data, is_json=True)
        result = api.parse_response(url, response)
        self.assertEqual(output, result['result']['data'])

    def configure_get_result(self, result=None):
        self.patch(
            SeaMicroAPIV09, 'get',
            Mock(return_value=result))

    def test_login_and_logout(self):
        token = factory.make_string()
        self.configure_get_result(token)
        url = 'http://%s/' % factory.make_string()
        api = SeaMicroAPIV09(url)
        api.login('username', 'password')
        self.assertEqual(token, api.token)
        api.logout()
        self.assertIsNone(api.token)

    def test_get_server_index(self):
        result = {
            'serverId': {
                0: '0/0',
                1: '1/0',
                2: '2/0',
                }
            }
        self.configure_get_result(result)
        url = 'http://%s/' % factory.make_string()
        api = SeaMicroAPIV09(url)
        self.assertEqual(0, api.server_index('0/0'))
        self.assertEqual(1, api.server_index('1/0'))
        self.assertEqual(2, api.server_index('2/0'))
        self.assertIsNone(api.server_index('3/0'))

    def configure_put_server_power(self, token=None):
        result = {
            'serverId': {
                0: '0/0',
                }
            }
        self.configure_get_result(result)
        mock = self.patch(
            SeaMicroAPIV09,
            'put')
        url = 'http://%s/' % factory.make_string()
        api = SeaMicroAPIV09(url)
        api.token = token
        return mock, api

    def assert_put_power_called(self, mock, idx, new_status, *params):
        location = 'servers/%d' % idx
        params = ['action=%s' % new_status] + list(params)
        self.assertThat(mock, MockCalledOnceWith(location, params=params))

    def test_put_server_power_on_using_pxe(self):
        token = factory.make_string()
        mock, api = self.configure_put_server_power(token)
        api.power_on('0/0', do_pxe=True)
        self.assert_put_power_called(
            mock, 0, POWER_STATUS.ON, 'using-pxe=true', token)

    def test_put_server_power_on_not_using_pxe(self):
        token = factory.make_string()
        mock, api = self.configure_put_server_power(token)
        api.power_on('0/0', do_pxe=False)
        self.assert_put_power_called(
            mock, 0, POWER_STATUS.ON, 'using-pxe=false', token)

    def test_put_server_power_reset_using_pxe(self):
        token = factory.make_string()
        mock, api = self.configure_put_server_power(token)
        api.reset('0/0', do_pxe=True)
        self.assert_put_power_called(
            mock, 0, POWER_STATUS.RESET, 'using-pxe=true', token)

    def test_put_server_power_reset_not_using_pxe(self):
        token = factory.make_string()
        mock, api = self.configure_put_server_power(token)
        api.reset('0/0', do_pxe=False)
        self.assert_put_power_called(
            mock, 0, POWER_STATUS.RESET, 'using-pxe=false', token)

    def test_put_server_power_off(self):
        token = factory.make_string()
        mock, api = self.configure_put_server_power(token)
        api.power_off('0/0', force=False)
        self.assert_put_power_called(
            mock, 0, POWER_STATUS.OFF, 'force=false', token)

    def test_put_server_power_off_force(self):
        token = factory.make_string()
        mock, api = self.configure_put_server_power(token)
        api.power_off('0/0', force=True)
        self.assert_put_power_called(
            mock, 0, POWER_STATUS.OFF, 'force=true', token)


class TestSeaMicro(MAASTestCase):
    """Tests for SeaMicro custom hardware."""

    run_tests_with = MAASTwistedRunTest.make_factory(timeout=5)

    def test_select_seamicro15k_api_version_ipmi(self):
        versions = select_seamicro15k_api_version('ipmi')
        self.assertEqual(['v2.0', 'v0.9'], versions)

    def test_select_seamicro15k_api_version_restapi(self):
        versions = select_seamicro15k_api_version('restapi')
        self.assertEqual(['v0.9'], versions)

    def test_select_seamicro15k_api_version_restapi2(self):
        versions = select_seamicro15k_api_version('restapi2')
        self.assertEqual(['v2.0'], versions)

    def configure_get_seamicro15k_api(self, return_value=None):
        ip = factory.make_ipv4_address()
        username = factory.make_string()
        password = factory.make_string()
        mock = self.patch(
            seamicro,
            'get_seamicro15k_api')
        mock.return_value = return_value
        return mock, ip, username, password

    def test_find_seamicro15k_servers_impi(self):
        mock, ip, username, password = self.configure_get_seamicro15k_api()
        self.assertRaises(
            SeaMicroError, find_seamicro15k_servers, ip, username,
            password, 'ipmi')
        self.assertThat(
            mock,
            MockCallsMatch(
                call('v2.0', ip, username, password),
                call('v0.9', ip, username, password)))

    def test_find_seamicro15k_servers_restapi(self):
        mock, ip, username, password = self.configure_get_seamicro15k_api()
        self.assertRaises(
            SeaMicroError, find_seamicro15k_servers, ip, username,
            password, 'restapi')
        self.assertThat(
            mock, MockCalledOnceWith('v0.9', ip, username, password))

    def test_find_seamicro15k_servers_restapi2(self):
        mock, ip, username, password = self.configure_get_seamicro15k_api()
        self.assertRaises(
            SeaMicroError, find_seamicro15k_servers, ip, username,
            password, 'restapi2')
        self.assertThat(
            mock, MockCalledOnceWith('v2.0', ip, username, password))

    def configure_api_v09_login(self, token=None):
        token = token or factory.make_string()
        mock = self.patch(
            SeaMicroAPIV09,
            'login')
        mock.return_value = token
        return mock

    @inlineCallbacks
    def test_probe_seamicro15k_and_enlist_v09(self):
        self.configure_api_v09_login()
        user = factory.make_name('user')
        ip = factory.make_ipv4_address()
        username = factory.make_name('username')
        password = factory.make_name('password')
        system_id = factory.make_name('system_id')
        domain = factory.make_name('domain')
        result = {
            0: {
                'serverId': '0/0',
                'serverNIC': '0',
                'serverMacAddr': factory.make_mac_address(),
                },
            1: {
                'serverId': '1/0',
                'serverNIC': '0',
                'serverMacAddr': factory.make_mac_address(),
                },
            2: {
                'serverId': '2/0',
                'serverNIC': '0',
                'serverMacAddr': factory.make_mac_address(),
                },
            3: {
                'serverId': '3/1',
                'serverNIC': '1',
                'serverMacAddr': factory.make_mac_address(),
                },
            }
        self.patch(
            SeaMicroAPIV09, 'get',
            Mock(return_value=result))
        mock_create_node = self.patch(seamicro, 'create_node')
        mock_create_node.side_effect = asynchronous(lambda *args: system_id)
        mock_commission_node = self.patch(seamicro, 'commission_node')

        yield deferToThread(
            probe_seamicro15k_and_enlist,
            user, ip, username, password,
            power_control='restapi', accept_all=True, domain=domain)
        self.assertEqual(3, mock_create_node.call_count)

        last = result[2]
        power_params = {
            'power_control': 'restapi',
            'system_id': last['serverId'].split('/')[0],
            'power_address': ip,
            'power_pass': password,
            'power_user': username
            }
        self.expectThat(
            mock_create_node,
            MockCalledWith(
                last['serverMacAddr'], 'amd64', 'sm15k', power_params, domain))
        self.expectThat(
            mock_commission_node,
            MockCalledWith(system_id, user))

    def test_power_control_seamicro15k_v09(self):
        self.configure_api_v09_login()
        ip = factory.make_ipv4_address()
        username = factory.make_string()
        password = factory.make_string()
        mock = self.patch(
            SeaMicroAPIV09,
            'power_server')

        power_control_seamicro15k_v09(ip, username, password, '25', 'on')
        self.assertThat(
            mock,
            MockCalledOnceWith('25/0', POWER_STATUS.ON, do_pxe=True))

    def test_power_control_seamicro15k_v09_retry_failure(self):
        self.configure_api_v09_login()
        ip = factory.make_ipv4_address()
        username = factory.make_string()
        password = factory.make_string()
        mock = self.patch(
            SeaMicroAPIV09,
            'power_server')
        mock.side_effect = SeaMicroAPIV09Error("mock error", response_code=401)

        power_control_seamicro15k_v09(
            ip, username, password, '25', 'on',
            retry_count=5, retry_wait=0)
        self.assertEqual(5, mock.call_count)

    def test_power_control_seamicro15k_v09_exception_failure(self):
        self.configure_api_v09_login()
        ip = factory.make_ipv4_address()
        username = factory.make_string()
        password = factory.make_string()
        mock = self.patch(
            SeaMicroAPIV09,
            'power_server')
        mock.side_effect = SeaMicroAPIV09Error("mock error")

        self.assertRaises(
            SeaMicroAPIV09Error, power_control_seamicro15k_v09,
            ip, username, password, '25', 'on')

    @inlineCallbacks
    def test_probe_seamicro15k_and_enlist_v2(self):
        user = factory.make_name('user')
        ip = factory.make_ipv4_address()
        username = factory.make_name('username')
        password = factory.make_name('password')
        system_id = factory.make_name('system_id')

        fake_server_0 = FakeServer('0/0')
        fake_server_0.add_fake_nic('0')
        fake_server_0.add_fake_nic('1')
        fake_server_1 = FakeServer('1/0')
        fake_server_1.add_fake_nic('0')
        fake_server_1.add_fake_nic('1')
        fake_client = FakeSeaMicroClient()
        fake_client.servers = FakeSeaMicroServerManager()
        fake_client.servers.servers.append(fake_server_0)
        fake_client.servers.servers.append(fake_server_1)
        mock_get_api = self.patch(
            seamicro,
            'get_seamicro15k_api')
        mock_get_api.return_value = fake_client
        mock_create_node = self.patch(seamicro, 'create_node')
        mock_create_node.side_effect = asynchronous(lambda *args: system_id)
        mock_commission_node = self.patch(seamicro, 'commission_node')

        yield deferToThread(
            probe_seamicro15k_and_enlist,
            user, ip, username, password,
            power_control='restapi2', accept_all=True)
        self.assertEqual(2, mock_create_node.call_count)

        self.expectThat(
            mock_create_node,
            MockCallsMatch(
                call(
                    fake_server_0.get_fake_macs(), 'amd64', 'sm15k',
                    {
                        'power_control': 'restapi2',
                        'system_id': '0',
                        'power_address': ip,
                        'power_pass': password,
                        'power_user': username
                    }),
                call(
                    fake_server_1.get_fake_macs(), 'amd64', 'sm15k',
                    {
                        'power_control': 'restapi2',
                        'system_id': '1',
                        'power_address': ip,
                        'power_pass': password,
                        'power_user': username
                    })))
        self.expectThat(
            mock_commission_node,
            MockCalledWith(system_id, user))

    def test_power_control_seamicro15k_v2(self):
        ip = factory.make_ipv4_address()
        username = factory.make_string()
        password = factory.make_string()

        fake_server = FakeServer('0/0')
        fake_client = FakeSeaMicroClient()
        fake_client.servers = FakeSeaMicroServerManager()
        fake_client.servers.servers.append(fake_server)
        mock_power_on = self.patch(fake_server, 'power_on')

        mock_get_api = self.patch(
            seamicro,
            'get_seamicro15k_api')
        mock_get_api.return_value = fake_client

        power_control_seamicro15k_v2(ip, username, password, '0', 'on')
        self.assertThat(mock_power_on, MockCalledOnceWith(using_pxe=True))

    def test_power_control_seamicro15k_v2_raises_error_when_api_None(self):
        ip = factory.make_ipv4_address()
        username = factory.make_string()
        password = factory.make_string()

        mock_get_api = self.patch(
            seamicro,
            'get_seamicro15k_api')
        mock_get_api.return_value = None

        self.assertRaises(
            SeaMicroError,
            power_control_seamicro15k_v2, ip, username, password, '0', 'on')

    def test_power_query_seamicro15k_v2_power_on(self):
        ip = factory.make_ipv4_address()
        username = factory.make_string()
        password = factory.make_string()

        fake_server = FakeServer('0/0')
        self.patch(fake_server, 'active', True)
        fake_client = FakeSeaMicroClient()
        fake_client.servers = FakeSeaMicroServerManager()
        fake_client.servers.servers.append(fake_server)

        mock_get_api = self.patch(
            seamicro,
            'get_seamicro15k_api')
        mock_get_api.return_value = fake_client

        self.assertEqual(
            "on",
            power_query_seamicro15k_v2(ip, username, password, '0'))

    def test_power_query_seamicro15k_v2_power_off(self):
        ip = factory.make_ipv4_address()
        username = factory.make_string()
        password = factory.make_string()

        fake_server = FakeServer('0/0')
        self.patch(fake_server, 'active', False)
        fake_client = FakeSeaMicroClient()
        fake_client.servers = FakeSeaMicroServerManager()
        fake_client.servers.servers.append(fake_server)

        mock_get_api = self.patch(
            seamicro,
            'get_seamicro15k_api')
        mock_get_api.return_value = fake_client

        self.assertEqual(
            "off",
            power_query_seamicro15k_v2(ip, username, password, '0'))

    def test_power_query_seamicro15k_v2_raises_error_when_api_None(self):
        ip = factory.make_ipv4_address()
        username = factory.make_string()
        password = factory.make_string()

        mock_get_api = self.patch(
            seamicro,
            'get_seamicro15k_api')
        mock_get_api.return_value = None

        self.assertRaises(
            SeaMicroError,
            power_query_seamicro15k_v2, ip, username, password, '0')