This file is indexed.

/usr/lib/python3/dist-packages/provisioningserver/drivers/power/tests/test_msftocs.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
# Copyright 2015-2016 Canonical Ltd.  This software is licensed under the
# GNU Affero General Public License version 3 (see the file LICENSE).

"""Tests for `provisioningserver.drivers.power.msftocs`."""

__all__ = []

from io import StringIO
from random import randint
from textwrap import dedent
import urllib.parse

from hypothesis import given
from hypothesis.strategies import sampled_from
from maastesting.factory import factory
from maastesting.matchers import (
    MockCalledOnceWith,
    MockCallsMatch,
)
from maastesting.testcase import (
    MAASTestCase,
    MAASTwistedRunTest,
)
from mock import (
    call,
    Mock,
)
from provisioningserver.drivers.power import (
    msftocs as msftocs_module,
    PowerActionError,
    PowerConnError,
    PowerFatalError,
)
from provisioningserver.drivers.power.msftocs import (
    MicrosoftOCSPowerDriver,
    MicrosoftOCSState,
    probe_and_enlist_msftocs,
)
from provisioningserver.utils.twisted import asynchronous
from testtools.matchers import Equals
from testtools.testcase import ExpectedException
from twisted.internet.defer import inlineCallbacks
from twisted.internet.threads import deferToThread


XMLNS = "http://schemas.datacontract.org/2004/07/Microsoft.GFS.WCS.Contracts"
XMLNS_I = "http://www.w3.org/2001/XMLSchema-instance"


def make_context():
    """Make and return a power parameters context."""
    return {
        'power_address': factory.make_ipv4_address(),
        'power_port': randint(2000, 4000),
        'power_user': factory.make_name('power_user'),
        'power_pass': factory.make_name('power_pass'),
        'blade_id': randint(1, 24),
    }


class TestMicrosoftOCSPowerDriver(MAASTestCase):

    def test_missing_packages(self):
        # there's nothing to check for, just confirm it returns []
        driver = MicrosoftOCSPowerDriver()
        missing = driver.detect_missing_packages()
        self.assertItemsEqual([], missing)

    def test_extract_from_response_finds_element_content(self):
        driver = MicrosoftOCSPowerDriver()
        response = dedent("""
            <a xmlns='%s' xmlns:i='%s'>
                <b/>
                <c/>
                <d>Test</d>
            </a>
        """ % (XMLNS, XMLNS_I))
        element_tag = 'd'
        expected = 'Test'
        output = driver.extract_from_response(response, element_tag)
        self.assertThat(output, Equals(expected))

    def test_get_gets_response(self):
        driver = MicrosoftOCSPowerDriver()
        context = make_context()
        command = factory.make_string()
        params = [factory.make_string() for _ in range(3)]
        expected = dedent("""
            <ChassisInfoResponse xmlns='%s' xmlns:i='%s'>
                <bladeCollections>
                    <BladeInfo>
                    </BladeInfo>
                </bladeCollections>
            </ChassisInfoResponse>
        """ % (XMLNS, XMLNS_I))
        response = StringIO(expected)
        self.patch(urllib.request, "urlopen", Mock(return_value=response))
        output = driver.get(command, context, params)
        self.assertEquals(output, expected)

    def test_get_crashes_on_http_error(self):
        driver = MicrosoftOCSPowerDriver()
        context = make_context()
        command = factory.make_string()
        mock_urlopen = self.patch(urllib.request, "urlopen")
        mock_urlopen.side_effect = urllib.error.HTTPError(
            None, None, None, None, None)
        self.assertRaises(
            PowerConnError, driver.get, command, context)

    def test_get_crashes_on_url_error(self):
        driver = MicrosoftOCSPowerDriver()
        context = make_context()
        command = factory.make_string()
        mock_urlopen = self.patch(urllib.request, "urlopen")
        mock_urlopen.side_effect = urllib.error.URLError("URL Error")
        self.assertRaises(
            PowerConnError, driver.get, command, context)

    def test_set_next_boot_device_sets_device(self):
        driver = MicrosoftOCSPowerDriver()
        context = make_context()
        bootType = '2'
        boot_uefi = 'false'
        boot_persistent = 'false'
        params = [
            "bladeid=%s" % context['blade_id'], "bootType=%s" % bootType,
            "uefi=%s" % boot_uefi, "persistent=%s" % boot_persistent
        ]
        mock_get = self.patch(driver, "get")
        driver.set_next_boot_device(context, pxe=True)
        self.assertThat(
            mock_get, MockCalledOnceWith('SetNextBoot', context, params))

    def test_get_blades_gets_blades(self):
        driver = MicrosoftOCSPowerDriver()
        context = make_context()
        response = dedent("""
            <ChassisInfoResponse xmlns='%s' xmlns:i='%s'>
                <bladeCollections>
                    <BladeInfo>
                        <completionCode>Success</completionCode>
                        <apiVersion>1</apiVersion>
                        <statusDescription/>
                        <bladeNumber>11</bladeNumber>
                        <bladeGuid></bladeGuid>
                        <bladeName>BLADE11</bladeName>
                        <powerState>ON</powerState>
                        <bladeMacAddress>
                            <NicInfo>
                                <completionCode>Success</completionCode>
                                <apiVersion>1</apiVersion>
                                <statusDescription/>
                                <deviceId>1</deviceId>
                                <macAddress>F4:52:14:D6:70:98</macAddress>
                            </NicInfo>
                            <NicInfo>
                                <completionCode>Success</completionCode>
                                <apiVersion>1</apiVersion>
                                <statusDescription></statusDescription>
                                <deviceId>2</deviceId>
                                <macAddress/>
                            </NicInfo>
                        </bladeMacAddress>
                    </BladeInfo>
                </bladeCollections>
            </ChassisInfoResponse>
        """ % (XMLNS, XMLNS_I))
        mock_get = self.patch(
            driver, "get", Mock(return_value=response))
        expected = {'11': ['F4:52:14:D6:70:98']}
        output = driver.get_blades(context)

        self.expectThat(output, Equals(expected))
        self.expectThat(
            mock_get, MockCalledOnceWith('GetChassisInfo', context))

    def test_power_on_powers_on_blade(self):
        driver = MicrosoftOCSPowerDriver()
        context = make_context()
        system_id = factory.make_name('system_id')
        mock_power_query = self.patch(driver, "power_query")
        mock_power_query.return_value = 'on'
        mock_power_off = self.patch(driver, "power_off")
        mock_set_next_boot_device = self.patch(
            driver, "set_next_boot_device")
        mock_get = self.patch(driver, "get")
        driver.power_on(system_id, context)

        self.expectThat(
            mock_power_query, MockCalledOnceWith(system_id, context))
        self.expectThat(mock_power_off, MockCalledOnceWith(system_id, context))
        self.expectThat(
            mock_set_next_boot_device, MockCallsMatch(
                call(context, persistent=True), call(context, pxe=True)))
        self.expectThat(
            mock_get, MockCalledOnceWith(
                'SetBladeOn', context, ["bladeid=%s" % context['blade_id']]))

    def test_power_on_crashes_for_connection_error(self):
        driver = MicrosoftOCSPowerDriver()
        context = make_context()
        system_id = factory.make_name('system_id')
        self.patch(driver, "power_query", Mock(return_value='off'))
        self.patch(driver, "set_next_boot_device")
        mock_get = self.patch(driver, "get")
        mock_get.side_effect = PowerConnError("Connection Error")
        self.assertRaises(
            PowerActionError, driver.power_on, system_id, context)

    def test_power_off_powers_off_blade(self):
        driver = MicrosoftOCSPowerDriver()
        context = make_context()
        system_id = factory.make_name('system_id')
        mock_get = self.patch(driver, "get")
        driver.power_off(system_id, context)
        self.assertThat(
            mock_get, MockCalledOnceWith(
                'SetBladeOff', context, ["bladeid=%s" % context['blade_id']]))

    def test_power_off_crashes_for_connection_error(self):
        driver = MicrosoftOCSPowerDriver()
        context = make_context()
        system_id = factory.make_name('system_id')
        mock_get = self.patch(driver, "get")
        mock_get.side_effect = PowerConnError("Connection Error")
        self.assertRaises(
            PowerActionError, driver.power_off, system_id, context)

    @given(sampled_from([MicrosoftOCSState.ON, MicrosoftOCSState.OFF]))
    def test_power_query_returns_power_state(self, power_state):
        def get_msftocs_state(power_state):
            if power_state == MicrosoftOCSState.OFF:
                return 'off'
            elif power_state == MicrosoftOCSState.ON:
                return 'on'
        driver = MicrosoftOCSPowerDriver()
        context = make_context()
        system_id = factory.make_name('system_id')
        mock_extract_from_response = self.patch(
            driver, "extract_from_response")
        mock_extract_from_response.return_value = power_state
        self.patch(driver, "get")
        output = driver.power_query(system_id, context)
        self.assertThat(output, Equals(get_msftocs_state(power_state)))

    def test_power_query_crashes_for_connection_error(self):
        driver = MicrosoftOCSPowerDriver()
        context = make_context()
        system_id = factory.make_name('system_id')
        mock_extract_from_response = self.patch(
            driver, "extract_from_response")
        mock_extract_from_response.side_effect = PowerConnError(
            "Connection Error")
        self.patch(driver, "get")
        self.assertRaises(
            PowerActionError, driver.power_query, system_id, context)

    def test_power_query_crashes_when_unable_to_find_match(self):
        driver = MicrosoftOCSPowerDriver()
        context = make_context()
        system_id = factory.make_name('system_id')
        mock_extract_from_response = self.patch(
            driver, "extract_from_response")
        mock_extract_from_response.return_value = "Rubbish"
        self.patch(driver, "get")
        self.assertRaises(
            PowerFatalError, driver.power_query, system_id, context)


class TestMicrosoftOCSProbeAndEnlist(MAASTestCase):
    """Tests for `probe_and_enlist_msftocs`."""

    run_tests_with = MAASTwistedRunTest.make_factory(timeout=5)

    @inlineCallbacks
    def test_probe_and_enlist_msftocs_probes_and_enlists(self):
        context = make_context()
        user = factory.make_name('user')
        system_id = factory.make_name('system_id')
        domain = factory.make_name('domain')
        macs = [factory.make_mac_address() for _ in range(3)]
        mock_get_blades = self.patch(MicrosoftOCSPowerDriver, "get_blades")
        mock_get_blades.return_value = {'%s' % context['blade_id']: macs}
        self.patch(MicrosoftOCSPowerDriver, "set_next_boot_device")
        mock_create_node = self.patch(msftocs_module, "create_node")
        mock_create_node.side_effect = asynchronous(lambda *args: system_id)
        mock_commission_node = self.patch(msftocs_module, "commission_node")

        yield deferToThread(
            probe_and_enlist_msftocs, user, context['power_address'],
            context['power_port'], context['power_user'],
            context['power_pass'], True, domain)

        self.expectThat(
            mock_create_node, MockCalledOnceWith(
                macs, 'amd64', 'msftocs', context, domain))
        self.expectThat(
            mock_commission_node, MockCalledOnceWith(system_id, user))

    @inlineCallbacks
    def test_probe_and_enlist_msftocs_get_blades_failure_server_error(self):
        user = factory.make_name('user')
        context = make_context()
        mock_get_blades = self.patch(MicrosoftOCSPowerDriver, "get_blades")
        mock_get_blades.side_effect = urllib.error.URLError("URL Error")

        with ExpectedException(PowerFatalError):
            yield deferToThread(
                probe_and_enlist_msftocs, user, context['power_address'],
                context['power_port'], context['power_user'],
                context['power_pass'])

    @inlineCallbacks
    def test_probe_and_enlist_msftocs_get_blades_failure_http_error(self):
        user = factory.make_name('user')
        context = make_context()
        mock_get_blades = self.patch(MicrosoftOCSPowerDriver, "get_blades")
        mock_get_blades.side_effect = urllib.error.HTTPError(
            None, None, None, None, None)

        with ExpectedException(PowerFatalError):
            yield deferToThread(
                probe_and_enlist_msftocs, user, context['power_address'],
                context['power_port'], context['power_user'],
                context['power_pass'])