This file is indexed.

/usr/lib/python3/dist-packages/provisioningserver/drivers/hardware/tests/test_ucsm.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
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
# 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.ucsm``."""

__all__ = []

from io import StringIO
from itertools import permutations
import random
import urllib.error
import urllib.parse
import urllib.request

from lxml.etree import (
    Element,
    SubElement,
    XML,
)
from maastesting.factory import factory
from maastesting.matchers import (
    MockCalledOnceWith,
    MockCallsMatch,
    MockNotCalled,
)
from maastesting.testcase import (
    MAASTestCase,
    MAASTwistedRunTest,
)
from mock import (
    ANY,
    call,
    Mock,
    sentinel,
)
from provisioningserver.drivers.hardware import ucsm
from provisioningserver.drivers.hardware.ucsm import (
    get_children,
    get_first_booter,
    get_macs,
    get_power_command,
    get_server_power_control,
    get_servers,
    get_service_profile,
    logged_in,
    make_policy_change,
    make_request_data,
    parse_response,
    power_control_ucsm,
    power_state_ucsm,
    probe_and_enlist_ucsm,
    probe_lan_boot_options,
    probe_servers,
    RO_KEYS,
    set_lan_boot_default,
    set_server_power_control,
    strip_ro_keys,
    UCSM_XML_API,
    UCSM_XML_API_Error,
)
from provisioningserver.utils.twisted import asynchronous
from testtools.matchers import Equals
from twisted.internet.defer import inlineCallbacks
from twisted.internet.threads import deferToThread


def make_api(url='http://url', user='u', password='p',
             cookie='foo', mock_call=True):
    api = UCSM_XML_API(url, user, password)
    api.cookie = cookie
    return api


def make_api_patch_call(testcase, *args, **kwargs):
    api = make_api(*args, **kwargs)
    mock = testcase.patch(api, '_call')
    return api, mock


def make_fake_result(root_class, child_tag, container='outConfigs'):
    fake_result = Element(root_class)
    outConfigs = SubElement(fake_result, container)
    outConfigs.append(Element(child_tag))
    return outConfigs


def make_class():
    return factory.make_name('class')


def make_dn():
    return factory.make_name('dn')


def make_server():
    return factory.make_name('server')


class TestUCSMXMLAPIError(MAASTestCase):
    """Tests for ``UCSM_XML_API_Error``."""

    def test_includes_code_and_msg(self):
        def raise_error():
            raise UCSM_XML_API_Error('bad', 4224)

        error = self.assertRaises(UCSM_XML_API_Error, raise_error)

        self.assertEqual('bad', error.args[0])
        self.assertEqual(4224, error.code)


class TestMakeRequestData(MAASTestCase):
    """Tests for ``make_request_data``."""

    def test_no_children(self):
        fields = {'hello': 'there'}
        request_data = make_request_data('foo', fields)
        root = XML(request_data)
        self.assertEqual('foo', root.tag)
        self.assertEqual('there', root.get('hello'))

    def test_with_children(self):
        fields = {'hello': 'there'}
        children_tags = ['bar', 'baz']
        children = [Element(child_tag) for child_tag in children_tags]
        request_data = make_request_data('foo', fields, children)
        root = XML(request_data)
        self.assertEqual('foo', root.tag)
        self.assertItemsEqual(children_tags, (e.tag for e in root))

    def test_no_fields(self):
        request_data = make_request_data('foo')
        root = XML(request_data)
        self.assertEqual('foo', root.tag)


class TestParseResonse(MAASTestCase):
    """Tests for ``parse_response``."""

    def test_no_error(self):
        xml = '<foo/>'
        response = parse_response(xml)
        self.assertEqual('foo', response.tag)

    def test_error(self):
        xml = '<foo errorCode="123" errorDescr="mayday!"/>'
        self.assertRaises(UCSM_XML_API_Error, parse_response, xml)


class TestLogin(MAASTestCase):
    """"Tests for ``UCSM_XML_API.login``."""

    def test_login_assigns_cookie(self):
        cookie = 'chocolate chip'
        api, mock = make_api_patch_call(self)
        mock.return_value = Element('aaaLogin', {'outCookie': cookie})
        api.login()
        self.assertEqual(cookie, api.cookie)

    def test_login_call_parameters(self):
        user = 'user'
        password = 'pass'
        api, mock = make_api_patch_call(self, user=user, password=password)
        api.login()
        fields = {'inName': user, 'inPassword': password}
        self.assertThat(mock, MockCalledOnceWith('aaaLogin', fields))


class TestLogout(MAASTestCase):
    """"Tests for ``UCSM_XML_API.logout``."""

    def test_logout_clears_cookie(self):
        api = make_api()
        self.patch(api, '_call')
        api.logout()
        self.assertIsNone(api.cookie)

    def test_logout_uses_cookie(self):
        api, mock = make_api_patch_call(self)
        cookie = api.cookie
        api.logout()
        fields = {'inCookie': cookie}
        self.assertThat(mock, MockCalledOnceWith('aaaLogout', fields))


class TestConfigResolveClass(MAASTestCase):
    """"Tests for ``UCSM_XML_API.config_resolve_class``."""

    def test_no_filters(self):
        class_id = make_class()
        api, mock = make_api_patch_call(self)
        api.config_resolve_class(class_id)
        fields = {'cookie': api.cookie, 'classId': class_id}
        self.assertThat(mock, MockCalledOnceWith('configResolveClass', fields,
                                                 ANY))

    def test_with_filters(self):
        class_id = make_class()
        filter_element = Element('hi')
        api, mock = make_api_patch_call(self)
        api.config_resolve_class(class_id, [filter_element])
        in_filters = mock.call_args[0][2]
        self.assertEqual([filter_element], in_filters[0][:])

    def test_return_response(self):
        api, mock = make_api_patch_call(self)
        mock.return_value = Element('test')
        result = api.config_resolve_class('c')
        self.assertEqual(mock.return_value, result)


class TestConfigResolveChildren(MAASTestCase):
    """"Tests for ``UCSM_XML_API.config_resolve_children``."""

    def test_parameters(self):
        dn = make_dn()
        class_id = make_class()
        api, mock = make_api_patch_call(self)
        api.config_resolve_children(dn, class_id)
        fields = {'inDn': dn, 'classId': class_id, 'cookie': api.cookie}
        self.assertThat(mock,
                        MockCalledOnceWith('configResolveChildren', fields))

    def test_no_class_id(self):
        dn = make_dn()
        api, mock = make_api_patch_call(self)
        api.config_resolve_children(dn)
        fields = {'inDn': dn, 'cookie': api.cookie}
        self.assertThat(mock,
                        MockCalledOnceWith('configResolveChildren', fields))

    def test_return_response(self):
        api, mock = make_api_patch_call(self)
        mock.return_value = Element('test')
        result = api.config_resolve_children('d', 'c')
        self.assertEqual(mock.return_value, result)


class TestConfigConfMo(MAASTestCase):
    """"Tests for ``UCSM_XML_API.config_conf_mo``."""

    def test_parameters(self):
        dn = make_dn()
        config_items = [Element('hi')]
        api, mock = make_api_patch_call(self)
        api.config_conf_mo(dn, config_items)
        fields = {'dn': dn, 'cookie': api.cookie}
        self.assertThat(mock, MockCalledOnceWith('configConfMo', fields, ANY))
        in_configs = mock.call_args[0][2]
        self.assertEqual(config_items, in_configs[0][:])


class TestCall(MAASTestCase):
    """"Tests for ``UCSM_XML_API._call``."""

    def test_call(self):
        name = 'method'
        fields = {1: 2}
        children = [3, 4]
        request = '<yes/>'
        response = Element('good')
        api = make_api()

        mock_make_request_data = self.patch(ucsm, 'make_request_data')
        mock_make_request_data.return_value = request

        mock_send_request = self.patch(api, '_send_request')
        mock_send_request.return_value = response

        api._call(name, fields, children)
        self.assertThat(mock_make_request_data,
                        MockCalledOnceWith(name, fields, children))
        self.assertThat(mock_send_request, MockCalledOnceWith(request))


class TestSendRequest(MAASTestCase):
    """"Tests for ``UCSM_XML_API._send_request``."""

    def test_send_request(self):
        request_data = 'foo'
        api = make_api()
        self.patch(api, '_call')
        stream = StringIO('<hi/>')
        mock = self.patch(urllib.request, 'urlopen')
        mock.return_value = stream
        response = api._send_request(request_data)
        self.assertEqual('hi', response.tag)
        urllib_request = mock.call_args[0][0]
        self.assertEqual(request_data, urllib_request.data)


class TestConfigResolveDn(MAASTestCase):
    """Tests for ``UCSM_XML_API.config_resolve_dn``."""

    def test_parameters(self):
        api, mock = make_api_patch_call(self)
        test_dn = make_dn()
        fields = {'cookie': api.cookie, 'dn': test_dn}
        api.config_resolve_dn(test_dn)
        self.assertThat(mock,
                        MockCalledOnceWith('configResolveDn', fields))


class TestGetServers(MAASTestCase):
    """Tests for ``get_servers``."""

    def test_uses_uuid(self):
        uuid = factory.make_UUID()
        api = make_api()
        mock = self.patch(api, 'config_resolve_class')
        get_servers(api, uuid)
        filters = mock.call_args[0][1]
        attrib = {'class': 'computeItem', 'property': 'uuid', 'value': uuid}
        self.assertEqual(attrib, filters[0].attrib)

    def test_returns_result(self):
        uuid = factory.make_UUID()
        api = make_api()
        fake_result = make_fake_result('configResolveClass', 'found')
        self.patch(api, 'config_resolve_class').return_value = fake_result
        result = get_servers(api, uuid)
        self.assertEqual('found', result[0].tag)

    def test_class_id(self):
        uuid = factory.make_UUID()
        api = make_api()
        mock = self.patch(api, 'config_resolve_class')
        get_servers(api, uuid)
        self.assertThat(mock, MockCalledOnceWith('computeItem', ANY))


class TestProbeLanBootOptions(MAASTestCase):
    """Tests for ``probe_lan_boot_options``."""

    def test_returns_result(self):
        api = make_api()
        server = sentinel.server
        mock_service_profile = Mock()
        mock_get_service_profile = self.patch(ucsm, 'get_service_profile')
        mock_get_service_profile.return_value = mock_service_profile
        mock_service_profile.get.return_value = sentinel.profile_get
        fake_result = make_fake_result('tag', 'lsbootLan')
        mock_config_resolve_children = self.patch(
            api, 'config_resolve_children')
        mock_config_resolve_children.return_value = fake_result
        self.assertEqual(1, len(probe_lan_boot_options(api, server)))
        self.assertThat(
            mock_config_resolve_children,
            MockCalledOnceWith(sentinel.profile_get))
        self.assertThat(
            mock_service_profile.get, MockCalledOnceWith('operBootPolicyName'))
        self.assertThat(
            mock_get_service_profile, MockCalledOnceWith(api, server))


class TestGetChildren(MAASTestCase):
    """Tests for ``get_children``."""

    def test_returns_result(self):
        search_class = make_class()
        api = make_api()
        fake_result = make_fake_result('configResolveChildren', search_class)
        self.patch(api, 'config_resolve_children').return_value = fake_result
        in_element = Element('test', {'dn': make_dn()})
        class_id = search_class
        result = get_children(api, in_element, class_id)
        self.assertEqual(search_class, result[0].tag)

    def test_parameters(self):
        search_class = make_class()
        parent_dn = make_dn()
        api = make_api()
        mock = self.patch(api, 'config_resolve_children')
        in_element = Element('test', {'dn': parent_dn})
        class_id = search_class
        get_children(api, in_element, class_id)
        self.assertThat(mock, MockCalledOnceWith(parent_dn, search_class))


class TestGetMacs(MAASTestCase):
    """Tests for ``get_macs``."""

    def test_gets_adaptors(self):
        adaptor = 'adaptor'
        server = make_server()
        mac = 'xx'
        api = make_api()
        mock = self.patch(ucsm, 'get_children')

        def fake_get_children(api, element, class_id):
            if class_id == 'adaptorUnit':
                return [adaptor]
            elif class_id == 'adaptorHostEthIf':
                return [Element('ethif', {'mac': mac})]

        mock.side_effect = fake_get_children
        macs = get_macs(api, server)
        self.assertThat(mock, MockCallsMatch(
                        call(api, server, 'adaptorUnit'),
                        call(api, adaptor, 'adaptorHostEthIf')))
        self.assertEqual([mac], macs)


class TestProbeServers(MAASTestCase):
    """Tests for ``probe_servers``."""

    def test_uses_api(self):
        api = make_api()
        mock = self.patch(ucsm, 'get_servers')
        probe_servers(api)
        self.assertThat(mock, MockCalledOnceWith(api))

    def test_returns_results(self):
        servers = [{'uuid': factory.make_UUID()}]
        mac = 'mac'
        api = make_api()
        self.patch(ucsm, 'get_servers').return_value = servers
        self.patch(ucsm, 'get_macs').return_value = [mac]
        self.patch(ucsm, 'probe_lan_boot_options').return_value = ['option']
        server_list = probe_servers(api)
        self.assertEqual([(servers[0], [mac])], server_list)

    def test_no_results_with_no_server_macs(self):
        servers = [{'uuid': factory.make_UUID()}]
        api = make_api()
        self.patch(ucsm, 'get_servers').return_value = servers
        self.patch(ucsm, 'get_macs').return_value = []
        self.patch(ucsm, 'probe_lan_boot_options').return_value = ['option']
        server_list = probe_servers(api)
        self.assertEqual([], server_list)

    def test_no_results_with_no_boot_options(self):
        servers = [{'uuid': factory.make_UUID()}]
        mac = 'mac'
        api = make_api()
        self.patch(ucsm, 'get_servers').return_value = servers
        self.patch(ucsm, 'get_macs').return_value = mac
        self.patch(ucsm, 'probe_lan_boot_options').return_value = []
        server_list = probe_servers(api)
        self.assertEqual([], server_list)


class TestGetServerPowerControl(MAASTestCase):
    """Tests for ``get_server_power_control``."""

    def test_get_server_power_control(self):
        api = make_api()
        mock = self.patch(api, 'config_resolve_children')
        fake_result = make_fake_result('configResolveChildren', 'lsPower')
        mock.return_value = fake_result
        dn = make_dn()
        server = Element('computeItem', {'assignedToDn': dn})
        power_control = get_server_power_control(api, server)
        self.assertThat(mock, MockCalledOnceWith(dn, 'lsPower'))
        self.assertEqual('lsPower', power_control.tag)


class TestSetServerPowerControl(MAASTestCase):
    """Tests for ``set_server_power_control``."""

    def test_set_server_power_control(self):
        api = make_api()
        power_dn = make_dn()
        power_control = Element('lsPower', {'dn': power_dn})
        config_conf_mo_mock = self.patch(api, 'config_conf_mo')
        state = 'state'
        set_server_power_control(api, power_control, state)
        self.assertThat(config_conf_mo_mock, MockCalledOnceWith(power_dn, ANY))
        power_change = config_conf_mo_mock.call_args[0][1][0]
        self.assertEqual(power_change.tag, 'lsPower')
        self.assertEqual({'state': state, 'dn': power_dn}, power_change.attrib)


class TestLoggedIn(MAASTestCase):
    """Tests for ``logged_in``."""

    def test_logged_in(self):
        mock = self.patch(ucsm, 'UCSM_XML_API')
        url = 'url'
        username = 'username'
        password = 'password'
        mock.return_value = Mock()

        with logged_in(url, username, password) as api:
            self.assertEqual(mock.return_value, api)
            self.assertThat(api.login, MockCalledOnceWith())

        self.assertThat(mock.return_value.logout, MockCalledOnceWith())


class TestValidGetPowerCommand(MAASTestCase):
    scenarios = [
        ('Power On', dict(
            power_mode='on', current_state='down', command='admin-up')),
        ('Power On', dict(
            power_mode='on', current_state='up', command='cycle-immediate')),
        ('Power Off', dict(
            power_mode='off', current_state='up', command='admin-down')),
    ]

    def test_get_power_command(self):
        command = get_power_command(self.power_mode, self.current_state)
        self.assertEqual(self.command, command)


class TestInvalidGetPowerCommand(MAASTestCase):

    def test_get_power_command_raises_assertion_error_on_bad_power_mode(self):
        bad_power_mode = factory.make_name('unlikely')
        error = self.assertRaises(UCSM_XML_API_Error, get_power_command,
                                  bad_power_mode, None)
        self.assertIn(bad_power_mode, error.args[0])


class TestPowerControlUCSM(MAASTestCase):
    """Tests for ``power_control_ucsm``."""

    def test_power_control_ucsm(self):
        uuid = factory.make_UUID()
        api = Mock()
        self.patch(ucsm, 'UCSM_XML_API').return_value = api
        get_servers_mock = self.patch(ucsm, 'get_servers')
        server = make_server()
        state = 'admin-down'
        power_control = Element('lsPower', {'state': state})
        get_servers_mock.return_value = [server]
        get_server_power_control_mock = self.patch(ucsm,
                                                   'get_server_power_control')
        get_server_power_control_mock.return_value = power_control
        set_server_power_control_mock = self.patch(ucsm,
                                                   'set_server_power_control')
        power_control_ucsm('url', 'username', 'password', uuid,
                           'off')
        self.assertThat(get_servers_mock, MockCalledOnceWith(api, uuid))
        self.assertThat(set_server_power_control_mock,
                        MockCalledOnceWith(api, power_control, state))


class TestUCSMPowerState(MAASTestCase):
    """Tests for `power_state_ucsm`."""

    def test_power_state_get_off(self):
        url = factory.make_name('url')
        username = factory.make_name('username')
        password = factory.make_name('password')
        uuid = factory.make_UUID()
        api = Mock()
        self.patch(ucsm, 'UCSM_XML_API').return_value = api
        get_servers_mock = self.patch(ucsm, 'get_servers')
        server = make_server()
        current_state = 'down'
        power_control = Element('lsPower', {'state': current_state})
        get_servers_mock.return_value = [server]
        get_server_power_control_mock = self.patch(
            ucsm, 'get_server_power_control')
        get_server_power_control_mock.return_value = power_control

        power_state = power_state_ucsm(url, username, password, uuid)
        self.expectThat(get_servers_mock, MockCalledOnceWith(api, uuid))
        self.expectThat(
            get_server_power_control_mock,
            MockCalledOnceWith(api, server))
        self.expectThat(power_state, Equals('off'))

    def test_power_state_get_on(self):
        url = factory.make_name('url')
        username = factory.make_name('username')
        password = factory.make_name('password')
        uuid = factory.make_UUID()
        api = Mock()
        self.patch(ucsm, 'UCSM_XML_API').return_value = api
        get_servers_mock = self.patch(ucsm, 'get_servers')
        server = make_server()
        current_state = 'up'
        power_control = Element('lsPower', {'state': current_state})
        get_servers_mock.return_value = [server]
        get_server_power_control_mock = self.patch(
            ucsm, 'get_server_power_control')
        get_server_power_control_mock.return_value = power_control

        power_state = power_state_ucsm(url, username, password, uuid)
        self.expectThat(get_servers_mock, MockCalledOnceWith(api, uuid))
        self.expectThat(
            get_server_power_control_mock,
            MockCalledOnceWith(api, server))
        self.expectThat(power_state, Equals('on'))

    def test_power_state_error_on_unknown_state(self):
        url = factory.make_name('url')
        username = factory.make_name('username')
        password = factory.make_name('password')
        uuid = factory.make_UUID()
        api = Mock()
        self.patch(ucsm, 'UCSM_XML_API').return_value = api
        get_servers_mock = self.patch(ucsm, 'get_servers')
        server = make_server()
        current_state = factory.make_name('error')
        power_control = Element('lsPower', {'state': current_state})
        get_servers_mock.return_value = [server]
        get_server_power_control_mock = self.patch(
            ucsm, 'get_server_power_control')
        get_server_power_control_mock.return_value = power_control

        self.assertRaises(
            UCSM_XML_API_Error, power_state_ucsm, url,
            username, password, uuid)


class TestProbeAndEnlistUCSM(MAASTestCase):
    """Tests for ``probe_and_enlist_ucsm``."""

    run_tests_with = MAASTwistedRunTest.make_factory(timeout=5)

    @inlineCallbacks
    def test_probe_and_enlist(self):
        user = factory.make_name('user')
        url = factory.make_name('url')
        username = factory.make_name('username')
        password = factory.make_name('password')
        system_id = factory.make_name('system_id')
        domain = factory.make_name('domain')
        api = Mock()
        self.patch(ucsm, 'UCSM_XML_API').return_value = api
        server_element = {'uuid': 'uuid'}
        server = (server_element, ['mac'],)
        probe_servers_mock = self.patch(ucsm, 'probe_servers')
        probe_servers_mock.return_value = [server]
        set_lan_boot_default_mock = self.patch(ucsm, 'set_lan_boot_default')
        create_node_mock = self.patch(ucsm, 'create_node')
        create_node_mock.side_effect = asynchronous(lambda *args: system_id)
        commission_node_mock = self.patch(ucsm, 'commission_node')

        yield deferToThread(
            probe_and_enlist_ucsm, user, url, username,
            password, True, domain)
        self.expectThat(
            set_lan_boot_default_mock,
            MockCalledOnceWith(api, server_element))
        self.expectThat(probe_servers_mock, MockCalledOnceWith(api))
        params = {
            'power_address': url,
            'power_user': username,
            'power_pass': password,
            'uuid': server[0]['uuid']
        }
        self.expectThat(
            create_node_mock,
            MockCalledOnceWith(server[1], 'amd64', 'ucsm', params, domain))
        self.expectThat(
            commission_node_mock,
            MockCalledOnceWith(system_id, user))


class TestGetServiceProfile(MAASTestCase):
    """Tests for ``get_service_profile.``"""

    def test_get_service_profile(self):
        test_dn = make_dn()
        server = Element('computeBlade', {'assignedToDn': test_dn})
        api = make_api()
        mock = self.patch(api, 'config_resolve_dn')
        mock.return_value = make_fake_result('configResolveDn', 'lsServer',
                                             'outConfig')
        service_profile = get_service_profile(api, server)
        self.assertThat(mock, MockCalledOnceWith(test_dn))
        self.assertEqual(mock.return_value[0], service_profile)


def make_boot_order_scenarios(size):
    """Produce test scenarios for testing get_first_booter.

    Each scenario is one of the permutations of a set of ``size``
    elements, where each element has an integer 'order' attribute
    that get_first_booter will use to determine which device boots
    first.
    """
    minimum = random.randint(0, 500)
    ordinals = range(minimum, minimum + size)

    elements = [
        Element('Entry%d' % i, {'order': '%d' % i})
        for i in ordinals
    ]

    orders = permutations(elements)
    orders = [{'order': order} for order in orders]

    scenarios = [('%d' % i, order) for i, order in enumerate(orders)]
    return scenarios, minimum


class TestGetFirstBooter(MAASTestCase):
    """Tests for ``get_first_booter.``"""

    scenarios, minimum = make_boot_order_scenarios(3)

    def test_first_booter(self):
        """Ensure the boot device is picked according to the order
        attribute, not the order of elements in the list of devices."""
        root = Element('outConfigs')
        root.extend(self.order)
        picked = get_first_booter(root)
        self.assertEqual(self.minimum, int(picked.get('order')))


class TestsForStripRoKeys(MAASTestCase):
    """Tests for ``strip_ro_keys.``"""

    def test_strip_ro_keys(self):
        attributes = {key: 'DC' for key in RO_KEYS}

        elements = [
            Element('Element%d' % i, attributes)
            for i in range(random.randint(0, 10))
        ]

        strip_ro_keys(elements)

        for key in RO_KEYS:
            values = [element.get(key) for element in elements]
            for value in values:
                self.assertIsNone(value)


class TestMakePolicyChange(MAASTestCase):
    """Tests for ``make_policy_change``."""

    def test_lan_already_top_priority(self):
        boot_profile_response = make_fake_result('configResolveChildren',
                                                 'lsbootLan')
        mock = self.patch(ucsm, 'get_first_booter')
        mock.return_value = boot_profile_response[0]
        change = make_policy_change(boot_profile_response)
        self.assertIsNone(change)
        self.assertThat(mock, MockCalledOnceWith(boot_profile_response))

    def test_change_lan_to_top_priority(self):
        boot_profile_response = Element('outConfigs')
        lan_boot = Element('lsbootLan', {'order': 'second'})
        storage_boot = Element('lsbootStorage', {'order': 'first'})
        boot_profile_response.extend([lan_boot, storage_boot])
        self.patch(ucsm, 'get_first_booter').return_value = storage_boot
        self.patch(ucsm, 'strip_ro_keys')
        change = make_policy_change(boot_profile_response)
        lan_boot_order = change.xpath('//lsbootPolicy/lsbootLan/@order')
        storage_boot_order = \
            change.xpath('//lsbootPolicy/lsbootStorage/@order')
        self.assertEqual(['first'], lan_boot_order)
        self.assertEqual(['second'], storage_boot_order)


class TestSetLanBootDefault(MAASTestCase):
    """Tets for ``set_lan_boot_default.``"""

    def test_no_change(self):
        api = make_api()
        server = make_server()
        self.patch(ucsm, 'get_service_profile')
        self.patch(api, 'config_resolve_children')
        self.patch(ucsm, 'make_policy_change').return_value = None
        config_conf_mo = self.patch(api, 'config_conf_mo')
        set_lan_boot_default(api, server)
        self.assertThat(config_conf_mo, MockNotCalled())

    def test_with_change(self):
        api = make_api()
        server = make_server()
        test_dn = make_dn()
        test_change = 'change'
        service_profile = Element('test', {'operBootPolicyName': test_dn})
        self.patch(ucsm, 'get_service_profile').return_value = service_profile
        self.patch(api, 'config_resolve_children')
        self.patch(ucsm, 'make_policy_change').return_value = test_change
        config_conf_mo = self.patch(api, 'config_conf_mo')
        set_lan_boot_default(api, server)
        self.assertThat(config_conf_mo,
                        MockCalledOnceWith(test_dn, [test_change]))