This file is indexed.

/usr/lib/python2.7/dist-packages/os_xenapi/tests/plugins/test_agent.py is in python-os-xenapi 0.3.1-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
# Copyright (c) 2017 Citrix Systems, Inc
# All Rights Reserved.
#
#    Licensed under the Apache License, Version 2.0 (the "License"); you may
#    not use this file except in compliance with the License. You may obtain
#    a copy of the License at
#
#         http://www.apache.org/licenses/LICENSE-2.0
#
#    Unless required by applicable law or agreed to in writing, software
#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
#    License for the specific language governing permissions and limitations
#    under the License.

import base64
import mock
from os_xenapi.tests.plugins import plugin_test
import time
try:
    import json
except ImportError:
    import simplejson as json

# global variable definition for fake arg
FAKE_ARG_DICT = {'id': 'fake_id',
                 'pub': 'fake_pub',
                 'enc_pass': 'fake_enc_pass',
                 'dom_id': 'fake_dom_id',
                 'url': 'fake_url',
                 'b64_path': 'fake_b64_path=',
                 'b64_contents': 'fake_b64_contents=',
                 'md5sum': 'fake_md5sum'}


class FakeTimeoutException(Exception):
    def __init__(self, details):
        self.details = details


class AgentTestCase(plugin_test.PluginTestBase):
    def setUp(self):
        super(AgentTestCase, self).setUp()

        self.agent = self.load_plugin("agent.py")
        self.mock_patch_object(self.agent,
                               '_wait_for_agent',
                               "fake_wait_agent_return")
        self.mock_patch_object(self.agent.xenstore,
                               'write_record',
                               'fake_write_recode_return')

    def test_version(self):
        tmp_arg_dict = FAKE_ARG_DICT
        tmp_arg_dict["value"] = json.dumps({"name": "version",
                                            "value": "agent"})
        request_id = tmp_arg_dict["id"]
        tmp_arg_dict["path"] = "data/host/%s" % request_id
        self.agent.version(self.agent, FAKE_ARG_DICT)

        self.agent._wait_for_agent.assert_called_once()
        self.agent.xenstore.write_record.assert_called_with(self.agent,
                                                            tmp_arg_dict)

    def test_version_timout_exception(self):
        tmp_arg_dict = FAKE_ARG_DICT
        tmp_arg_dict["value"] = json.dumps({"name": "version",
                                            "value": "agent"})
        request_id = tmp_arg_dict["id"]
        tmp_arg_dict["path"] = "data/host/%s" % request_id
        side_effects = [FakeTimeoutException('TIME_OUT')]
        self.agent.PluginError = FakeTimeoutException
        self.agent._wait_for_agent.side_effect = side_effects

        self.assertRaises(self.agent.PluginError,
                          self.agent.version,
                          self.agent, FAKE_ARG_DICT)
        self.agent._wait_for_agent.assert_called_once()
        self.agent.xenstore.write_record.assert_called_with(self.agent,
                                                            tmp_arg_dict)

    def test_key_init_ok(self):
        tmp_arg_dict = FAKE_ARG_DICT
        pub = tmp_arg_dict["pub"]
        tmp_arg_dict["value"] = json.dumps({"name": "keyinit",
                                            "value": pub})
        request_id = tmp_arg_dict["id"]
        tmp_arg_dict["path"] = "data/host/%s" % request_id
        self.agent.key_init(self.agent, FAKE_ARG_DICT)

        self.agent._wait_for_agent.assert_called_once()
        self.agent.xenstore.write_record.assert_called_with(self.agent,
                                                            tmp_arg_dict)

    def test_key_init_timout_exception(self):
        tmp_arg_dict = FAKE_ARG_DICT
        pub = tmp_arg_dict["pub"]
        tmp_arg_dict["value"] = json.dumps({"name": "keyinit",
                                            "value": pub})
        request_id = tmp_arg_dict["id"]
        tmp_arg_dict["path"] = "data/host/%s" % request_id
        side_effects = [FakeTimeoutException('TIME_OUT')]
        self.agent.PluginError = FakeTimeoutException
        self.agent._wait_for_agent.side_effect = side_effects

        self.assertRaises(self.agent.PluginError,
                          self.agent.key_init,
                          self.agent, FAKE_ARG_DICT)
        self.agent._wait_for_agent.assert_called_once()
        self.agent.xenstore.write_record.assert_called_with(self.agent,
                                                            tmp_arg_dict)

    def test_password_ok(self):
        tmp_arg_dict = FAKE_ARG_DICT
        enc_pass = tmp_arg_dict["enc_pass"]
        tmp_arg_dict["value"] = json.dumps({"name": "password",
                                            "value": enc_pass})
        request_id = tmp_arg_dict["id"]
        tmp_arg_dict["path"] = "data/host/%s" % request_id
        self.agent.password(self.agent, FAKE_ARG_DICT)

        self.agent._wait_for_agent.assert_called_once()
        self.agent.xenstore.write_record.assert_called_with(self.agent,
                                                            tmp_arg_dict)

    def test_password_timout_exception(self):
        tmp_arg_dict = FAKE_ARG_DICT
        enc_pass = tmp_arg_dict["enc_pass"]
        tmp_arg_dict["value"] = json.dumps({"name": "password",
                                            "value": enc_pass})
        request_id = tmp_arg_dict["id"]
        tmp_arg_dict["path"] = "data/host/%s" % request_id
        side_effects = [FakeTimeoutException('TIME_OUT')]
        self.agent.PluginError = FakeTimeoutException
        self.agent._wait_for_agent.side_effect = side_effects

        self.assertRaises(self.agent.PluginError,
                          self.agent.password,
                          self.agent, FAKE_ARG_DICT)
        self.agent._wait_for_agent.assert_called_once()
        self.agent.xenstore.write_record.assert_called_with(self.agent,
                                                            tmp_arg_dict)

    def test_reset_network_ok(self):
        tmp_arg_dict = FAKE_ARG_DICT
        tmp_arg_dict['value'] = json.dumps({'name': 'resetnetwork',
                                            'value': ''})
        request_id = tmp_arg_dict['id']
        tmp_arg_dict['path'] = "data/host/%s" % request_id
        self.agent.resetnetwork(self.agent, FAKE_ARG_DICT)

        self.agent._wait_for_agent.assert_called_once()
        self.agent.xenstore.write_record.assert_called_with(self.agent,
                                                            tmp_arg_dict)

    def test_reset_network_timout_exception(self):
        tmp_arg_dict = FAKE_ARG_DICT
        tmp_arg_dict['value'] = json.dumps({'name': 'resetnetwork',
                                            'value': ''})
        request_id = tmp_arg_dict['id']
        tmp_arg_dict['path'] = "data/host/%s" % request_id
        side_effects = [FakeTimeoutException('TIME_OUT')]
        self.agent.PluginError = FakeTimeoutException
        self.agent._wait_for_agent.side_effect = side_effects

        self.assertRaises(self.agent.PluginError,
                          self.agent.resetnetwork,
                          self.agent, FAKE_ARG_DICT)
        self.agent._wait_for_agent.assert_called_once()
        self.agent.xenstore.write_record.assert_called_with(self.agent,
                                                            tmp_arg_dict)

    def test_inject_file_with_new_agent(self):
        tmp_arg_dict = FAKE_ARG_DICT
        request_id = tmp_arg_dict["id"]
        b64_path = tmp_arg_dict["b64_path"]
        b64_file = tmp_arg_dict["b64_contents"]
        self.mock_patch_object(self.agent,
                               '_get_agent_features',
                               'file_inject')
        tmp_arg_dict["value"] = json.dumps({"name": "file_inject",
                                            "value": {"b64_path": b64_path,
                                                      "b64_file": b64_file}})
        tmp_arg_dict["path"] = "data/host/%s" % request_id
        self.agent.inject_file(self.agent, FAKE_ARG_DICT)

        self.agent._wait_for_agent.assert_called_once()
        self.agent.xenstore.write_record.assert_called_with(self.agent,
                                                            tmp_arg_dict)
        self.agent._get_agent_features.assert_called_once()

    def test_inject_file_with_old_agent(self):
        tmp_arg_dict = FAKE_ARG_DICT
        request_id = tmp_arg_dict["id"]
        b64_path = tmp_arg_dict["b64_path"]
        b64_file = tmp_arg_dict["b64_contents"]
        raw_path = base64.b64decode(b64_path)
        raw_file = base64.b64decode(b64_file)
        new_b64 = base64.b64encode("%s,%s" % (raw_path, raw_file))
        self.mock_patch_object(self.agent,
                               '_get_agent_features',
                               'injectfile')
        tmp_arg_dict["value"] = json.dumps({"name": "injectfile",
                                            "value": new_b64})
        tmp_arg_dict["path"] = "data/host/%s" % request_id
        self.agent.inject_file(self.agent, FAKE_ARG_DICT)

        self.agent._wait_for_agent.assert_called_once()
        self.agent.xenstore.write_record.assert_called_with(self.agent,
                                                            tmp_arg_dict)
        self.agent._get_agent_features.assert_called_once()

    def test_inject_file_NotImp_exception(self):
        self.mock_patch_object(self.agent,
                               '_get_agent_features',
                               'fake_not_imp_exp')

        self.assertRaises(NotImplementedError,
                          self.agent.inject_file,
                          self.agent, FAKE_ARG_DICT)
        self.agent._get_agent_features.assert_called_once()

    def test_inject_file_Timeout_exception(self):
        tmp_arg_dict = FAKE_ARG_DICT
        request_id = tmp_arg_dict["id"]
        b64_path = tmp_arg_dict["b64_path"]
        b64_file = tmp_arg_dict["b64_contents"]
        tmp_arg_dict["value"] = json.dumps({"name": "file_inject",
                                            "value": {"b64_path": b64_path,
                                                      "b64_file": b64_file}})
        tmp_arg_dict["path"] = "data/host/%s" % request_id
        self.mock_patch_object(self.agent,
                               '_get_agent_features',
                               'file_inject')
        side_effects = [FakeTimeoutException('TIME_OUT')]
        self.agent.PluginError = FakeTimeoutException
        self.agent._wait_for_agent.side_effect = side_effects

        self.assertRaises(self.agent.PluginError,
                          self.agent.inject_file,
                          self.agent, FAKE_ARG_DICT)
        self.agent._wait_for_agent.assert_called_once()
        self.agent.xenstore.write_record.assert_called_with(self.agent,
                                                            tmp_arg_dict)

    def test_agent_update_ok(self):
        tmp_arg_dict = FAKE_ARG_DICT
        request_id = tmp_arg_dict["id"]
        url = tmp_arg_dict["url"]
        md5sum = tmp_arg_dict["md5sum"]
        tmp_arg_dict["value"] = json.dumps({"name": "agentupdate",
                                            "value": "%s,%s" % (url, md5sum)})
        tmp_arg_dict["path"] = "data/host/%s" % request_id
        self.agent.agent_update(self.agent, FAKE_ARG_DICT)

        self.agent._wait_for_agent.assert_called_once()
        self.agent.xenstore.write_record.assert_called_with(self.agent,
                                                            tmp_arg_dict)

    def test_agent_update_timout_exception(self):
        tmp_arg_dict = FAKE_ARG_DICT
        request_id = tmp_arg_dict["id"]
        url = tmp_arg_dict["url"]
        md5sum = tmp_arg_dict["md5sum"]
        tmp_arg_dict["value"] = json.dumps({"name": "agentupdate",
                                            "value": "%s,%s" % (url, md5sum)})
        tmp_arg_dict["path"] = "data/host/%s" % request_id
        side_effects = [FakeTimeoutException('TIME_OUT')]
        self.agent.PluginError = FakeTimeoutException
        self.agent._wait_for_agent.side_effect = side_effects

        self.assertRaises(self.agent.PluginError,
                          self.agent.agent_update,
                          self.agent, FAKE_ARG_DICT)
        self.agent._wait_for_agent.assert_called_once()
        self.agent.xenstore.write_record.assert_called_once()

    def test_get_agent_features_returncode_0(self):
        self.mock_patch_object(self.agent.json,
                               'loads',
                               {'returncode': 0})
        featrues_ret = self.agent._get_agent_features(self.agent,
                                                      FAKE_ARG_DICT)

        self.assertFalse(bool(featrues_ret))
        self.agent._wait_for_agent.assert_called_once()
        self.agent.xenstore.write_record.assert_called_once()

    def test_get_agent_features_returncode_not_0(self):
        self.mock_patch_object(self.agent,
                               '_wait_for_agent',
                               'fake_wait_agent_return')
        self.mock_patch_object(self.agent.json,
                               'loads',
                               {'returncode': 'fake_return_code',
                                'message': 'fake_message'})
        featrues_ret = self.agent._get_agent_features(self.agent,
                                                      FAKE_ARG_DICT)

        self.assertTrue(bool(featrues_ret))
        self.agent._wait_for_agent.assert_called_once()
        self.agent.xenstore.write_record.assert_called_once()

    def test_get_agent_features_timout_exception(self):
        side_effects = [FakeTimeoutException('TIME_OUT')]
        self.agent.PluginError = FakeTimeoutException
        self.agent._wait_for_agent.side_effect = side_effects

        self.assertRaises(self.agent.PluginError,
                          self.agent._get_agent_features,
                          self.agent, FAKE_ARG_DICT)
        self.agent._wait_for_agent.assert_called_once()
        self.agent.xenstore.write_record.assert_called_once()


class WaitForAgentTestCase(plugin_test.PluginTestBase):
    def setUp(self):
        super(WaitForAgentTestCase, self).setUp()

        self.agent = self.load_plugin("agent.py")

    def test_wait_for_agent_ok(self):
        tmp_arg_dict = FAKE_ARG_DICT
        tmp_arg_dict["path"] = "data/guest/%s" % 'fake_id'
        tmp_arg_dict["ignore_missing_path"] = True
        self.mock_patch_object(self.agent.xenstore,
                               'read_record',
                               'fake_read_record')
        ret_str = self.agent._wait_for_agent(self.agent,
                                             'fake_id',
                                             FAKE_ARG_DICT,
                                             self.agent.DEFAULT_TIMEOUT)

        self.agent.xenstore.read_record.assert_called_with(self.agent,
                                                           tmp_arg_dict)
        self.assertEqual(ret_str, 'fake_read_record')

    @mock.patch.object(time, 'sleep')
    def test_wait_for_agent_reboot_detected_exception(self, mock_sleep):
        tmp_arg_dict = FAKE_ARG_DICT
        tmp_arg_dict["path"] = "data/guest/%s" % 'fake_id'
        tmp_arg_dict["ignore_missing_path"] = True
        self.mock_patch_object(self.agent.xenstore,
                               'read_record',
                               '"None"')
        self.mock_patch_object(self.agent.xenstore,
                               'record_exists',
                               False)
        self.mock_patch_object(self.agent.xenstore,
                               'delete_record',
                               'fake_del_record')

        self.assertRaises(self.agent.RebootDetectedError,
                          self.agent._wait_for_agent,
                          self.agent, 'fake_id', FAKE_ARG_DICT,
                          self.agent.DEFAULT_TIMEOUT)
        self.agent.xenstore.read_record.assert_called_with(self.agent,
                                                           tmp_arg_dict)
        exists_args = {
            "dom_id": tmp_arg_dict["dom_id"],
            "path": "name",
        }
        self.agent.xenstore.record_exists.assert_called_with(exists_args)
        tmp_arg_dict["path"] = "data/host/%s" % 'fake_id'
        self.agent.xenstore.delete_record.assert_called_with(self.agent,
                                                             tmp_arg_dict)

    @mock.patch.object(time, 'sleep')
    @mock.patch.object(time, 'time')
    def test_wait_for_agent_timeout_exception(self, mock_time, mock_sleep):
        tmp_arg_dict = FAKE_ARG_DICT
        tmp_arg_dict["path"] = "data/guest/%s" % 'fake_id'
        tmp_arg_dict["ignore_missing_path"] = True
        self.mock_patch_object(self.agent.xenstore,
                               'read_record',
                               '"None"')
        self.mock_patch_object(self.agent.xenstore,
                               'record_exists',
                               True)
        self.mock_patch_object(self.agent.xenstore,
                               'delete_record',
                               'fake_del_record')
        mock_time.side_effect = list(range(self.agent.DEFAULT_TIMEOUT + 1))

        self.assertRaises(self.agent.TimeoutError,
                          self.agent._wait_for_agent,
                          self.agent, 'fake_id', FAKE_ARG_DICT,
                          self.agent.DEFAULT_TIMEOUT)
        self.agent.xenstore.read_record.assert_called_with(self.agent,
                                                           tmp_arg_dict)
        exists_args = {
            "dom_id": tmp_arg_dict["dom_id"],
            "path": "name",
        }
        self.agent.xenstore.record_exists.assert_called_with(exists_args)
        tmp_arg_dict["path"] = "data/host/%s" % 'fake_id'
        self.agent.xenstore.delete_record.assert_called_with(self.agent,
                                                             tmp_arg_dict)
        self.assertEqual(self.agent.DEFAULT_TIMEOUT - 1,
                         self.agent.xenstore.read_record.call_count)