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
|
import contextlib
import json
import os
from azurelinuxagent.common import conf
from azurelinuxagent.common.event import WALAEventOperation
from azurelinuxagent.common.exception import AgentUpgradeExitException
from azurelinuxagent.common.future import ustr, httpclient
from azurelinuxagent.common.protocol.restapi import VMAgentUpdateStatuses
from azurelinuxagent.common.protocol.util import ProtocolUtil
from azurelinuxagent.common.version import CURRENT_VERSION, AGENT_NAME
from azurelinuxagent.ga.agent_update_handler import get_agent_update_handler, INITIAL_UPDATE_STATE_FILE, \
RSM_UPDATE_STATE_FILE
from azurelinuxagent.ga.guestagent import GuestAgent
from tests.ga.test_update import UpdateTestCase
from tests.lib.http_request_predicates import HttpRequestPredicates
from tests.lib.mock_wire_protocol import mock_wire_protocol, MockHttpResponse
from tests.lib.wire_protocol_data import DATA_FILE
from tests.lib.tools import clear_singleton_instances, load_bin_data, patch
class TestAgentUpdate(UpdateTestCase):
def setUp(self):
UpdateTestCase.setUp(self)
# Since ProtocolUtil is a singleton per thread, we need to clear it to ensure that the test cases do not
# reuse a previous state
clear_singleton_instances(ProtocolUtil)
@contextlib.contextmanager
def _get_agent_update_handler(self, test_data=None, autoupdate_frequency=0.001, autoupdate_enabled=True, initial_update_attempted=True, protocol_get_error=False, mock_get_header=None, mock_put_header=None):
# Default to DATA_FILE of test_data parameter raises the pylint warning
# W0102: Dangerous default value DATA_FILE (builtins.dict) as argument (dangerous-default-value)
test_data = DATA_FILE if test_data is None else test_data
with mock_wire_protocol(test_data) as protocol:
def get_handler(url, **kwargs):
if HttpRequestPredicates.is_agent_package_request(url):
if not protocol_get_error:
agent_pkg = load_bin_data(self._get_agent_file_name(), self._agent_zip_dir)
return MockHttpResponse(status=httpclient.OK, body=agent_pkg)
else:
return MockHttpResponse(status=httpclient.SERVICE_UNAVAILABLE)
return protocol.mock_wire_data.mock_http_get(url, **kwargs)
def put_handler(url, *args, **_):
if HttpRequestPredicates.is_host_plugin_status_request(url):
# Skip reading the HostGA request data as its encoded
return MockHttpResponse(status=500)
protocol.aggregate_status = json.loads(args[0])
return MockHttpResponse(status=201)
http_get_handler = mock_get_header if mock_get_header else get_handler
http_put_handler = mock_put_header if mock_put_header else put_handler
protocol.set_http_handlers(http_get_handler=http_get_handler, http_put_handler=http_put_handler)
if initial_update_attempted:
open(os.path.join(conf.get_lib_dir(), INITIAL_UPDATE_STATE_FILE), "a").close()
with patch("azurelinuxagent.common.conf.get_autoupdate_enabled", return_value=autoupdate_enabled):
with patch("azurelinuxagent.common.conf.get_autoupdate_frequency", return_value=autoupdate_frequency):
with patch("azurelinuxagent.common.conf.get_autoupdate_gafamily", return_value="Prod"):
with patch("azurelinuxagent.common.conf.get_enable_ga_versioning", return_value=True):
with patch("azurelinuxagent.common.event.EventLogger.add_event") as mock_telemetry:
agent_update_handler = get_agent_update_handler(protocol)
agent_update_handler._protocol = protocol
yield agent_update_handler, mock_telemetry
def _assert_agent_directories_available(self, versions):
for version in versions:
self.assertTrue(os.path.exists(self.agent_dir(version)), "Agent directory {0} not found".format(version))
def _assert_agent_directories_exist_and_others_dont_exist(self, versions):
self._assert_agent_directories_available(versions=versions)
other_agents = [agent_dir for agent_dir in self.agent_dirs() if
agent_dir not in [self.agent_dir(version) for version in versions]]
self.assertFalse(any(other_agents),
"All other agents should be purged from agent dir: {0}".format(other_agents))
def _assert_agent_rsm_version_in_goal_state(self, mock_telemetry, inc=1, version="9.9.9.10"):
upgrade_event_msgs = [kwarg['message'] for _, kwarg in mock_telemetry.call_args_list if
'New agent version:{0} requested by RSM in Goal state incarnation_{1}'.format(version, inc) in kwarg['message'] and kwarg[
'op'] == WALAEventOperation.AgentUpgrade]
self.assertEqual(1, len(upgrade_event_msgs),
"Did not find the event indicating that the agent requested version found. Got: {0}".format(
mock_telemetry.call_args_list))
def _assert_update_discovered_from_agent_manifest(self, mock_telemetry, inc=1, version="9.9.9.10"):
upgrade_event_msgs = [kwarg['message'] for _, kwarg in mock_telemetry.call_args_list if
'Self-update is ready to upgrade the new agent: {0} now before processing the goal state: incarnation_{1}'.format(version, inc) in kwarg['message'] and kwarg[
'op'] == WALAEventOperation.AgentUpgrade]
self.assertEqual(1, len(upgrade_event_msgs),
"Did not find the event indicating that the new version found. Got: {0}".format(
mock_telemetry.call_args_list))
def _assert_no_agent_package_telemetry_emitted(self, mock_telemetry, version="9.9.9.10"):
upgrade_event_msgs = [kwarg['message'] for _, kwarg in mock_telemetry.call_args_list if
'No matching package found in the agent manifest for version: {0}'.format(version) in kwarg['message'] and kwarg[
'op'] == WALAEventOperation.AgentUpgrade]
self.assertEqual(1, len(upgrade_event_msgs),
"Did not find the event indicating that the agent package not found. Got: {0}".format(
mock_telemetry.call_args_list))
def _assert_agent_exit_process_telemetry_emitted(self, message):
self.assertIn("Current Agent {0} completed all update checks, exiting current process".format(CURRENT_VERSION), message)
def test_it_should_not_update_when_autoupdate_disabled(self):
self.prepare_agents(count=1)
with self._get_agent_update_handler(autoupdate_enabled=False) as (agent_update_handler, mock_telemetry):
agent_update_handler.run(agent_update_handler._protocol.get_goal_state(), True)
self._assert_agent_directories_exist_and_others_dont_exist(versions=[str(CURRENT_VERSION)])
self.assertEqual(0, len([kwarg['message'] for _, kwarg in mock_telemetry.call_args_list if
"requesting a new agent version" in kwarg['message'] and kwarg[
'op'] == WALAEventOperation.AgentUpgrade]), "should not check for rsm version")
def test_it_should_update_to_largest_version_if_ga_versioning_disabled(self):
self.prepare_agents(count=1)
data_file = DATA_FILE.copy()
data_file["ext_conf"] = "wire/ext_conf_rsm_version.xml"
with self._get_agent_update_handler(test_data=data_file) as (agent_update_handler, mock_telemetry):
with patch.object(conf, "get_enable_ga_versioning", return_value=False):
with self.assertRaises(AgentUpgradeExitException) as context:
agent_update_handler.run(agent_update_handler._protocol.get_goal_state(), True)
self._assert_update_discovered_from_agent_manifest(mock_telemetry, version="99999.0.0.0")
self._assert_agent_directories_exist_and_others_dont_exist(versions=[str(CURRENT_VERSION), "99999.0.0.0"])
self._assert_agent_exit_process_telemetry_emitted(ustr(context.exception.reason))
def test_it_should_not_update_to_largest_version_if_time_window_not_elapsed(self):
self.prepare_agents(count=1)
data_file = DATA_FILE.copy()
data_file["ga_manifest"] = "wire/ga_manifest_no_uris.xml"
with self._get_agent_update_handler(test_data=data_file, autoupdate_frequency=10) as (agent_update_handler, _):
agent_update_handler.run(agent_update_handler._protocol.get_goal_state(), True)
self.assertFalse(os.path.exists(self.agent_dir("99999.0.0.0")),
"New agent directory should not be found")
agent_update_handler._protocol.mock_wire_data.set_ga_manifest("wire/ga_manifest.xml")
agent_update_handler._protocol.mock_wire_data.set_incarnation(2)
agent_update_handler._protocol.client.update_goal_state()
agent_update_handler.run(agent_update_handler._protocol.get_goal_state(), True)
self.assertFalse(os.path.exists(self.agent_dir("99999.0.0.0")),
"New agent directory should not be found")
def test_it_should_update_to_largest_version_if_time_window_elapsed(self):
self.prepare_agents(count=1)
data_file = DATA_FILE.copy()
data_file["ga_manifest"] = "wire/ga_manifest_no_uris.xml"
with patch("azurelinuxagent.common.conf.get_self_update_hotfix_frequency", return_value=0.001):
with patch("azurelinuxagent.common.conf.get_self_update_regular_frequency", return_value=0.001):
with self._get_agent_update_handler(test_data=data_file) as (agent_update_handler, mock_telemetry):
with self.assertRaises(AgentUpgradeExitException) as context:
agent_update_handler.run(agent_update_handler._protocol.get_goal_state(), True)
self.assertFalse(os.path.exists(self.agent_dir("99999.0.0.0")),
"New agent directory should not be found")
agent_update_handler._protocol.mock_wire_data.set_ga_manifest("wire/ga_manifest.xml")
agent_update_handler._protocol.mock_wire_data.set_incarnation(2)
agent_update_handler._protocol.client.update_goal_state()
agent_update_handler.run(agent_update_handler._protocol.get_goal_state(), True)
self._assert_update_discovered_from_agent_manifest(mock_telemetry, inc=2, version="99999.0.0.0")
self._assert_agent_directories_exist_and_others_dont_exist(versions=[str(CURRENT_VERSION), "99999.0.0.0"])
self._assert_agent_exit_process_telemetry_emitted(ustr(context.exception.reason))
def test_it_should_not_allow_update_if_largest_version_below_current_version(self):
self.prepare_agents(count=1)
data_file = DATA_FILE.copy()
data_file["ga_manifest"] = "wire/ga_manifest_no_upgrade.xml"
with self._get_agent_update_handler(test_data=data_file) as (agent_update_handler, _):
agent_update_handler.run(agent_update_handler._protocol.get_goal_state(), True)
self._assert_agent_directories_exist_and_others_dont_exist(versions=[str(CURRENT_VERSION)])
def test_it_should_update_to_largest_version_if_rsm_version_not_available(self):
self.prepare_agents(count=1)
data_file = DATA_FILE.copy()
data_file['ext_conf'] = "wire/ext_conf.xml"
with self._get_agent_update_handler(test_data=data_file) as (agent_update_handler, mock_telemetry):
with self.assertRaises(AgentUpgradeExitException) as context:
agent_update_handler.run(agent_update_handler._protocol.get_goal_state(), True)
self._assert_update_discovered_from_agent_manifest(mock_telemetry, version="99999.0.0.0")
self._assert_agent_directories_exist_and_others_dont_exist(versions=[str(CURRENT_VERSION), "99999.0.0.0"])
self._assert_agent_exit_process_telemetry_emitted(ustr(context.exception.reason))
def test_it_should_not_download_manifest_again_if_last_attempted_download_time_not_elapsed(self):
self.prepare_agents(count=1)
data_file = DATA_FILE.copy()
data_file['ext_conf'] = "wire/ext_conf.xml"
with self._get_agent_update_handler(test_data=data_file, autoupdate_frequency=10, protocol_get_error=True) as (agent_update_handler, _):
# making multiple agent update attempts
agent_update_handler.run(agent_update_handler._protocol.get_goal_state(), True)
agent_update_handler.run(agent_update_handler._protocol.get_goal_state(), True)
agent_update_handler.run(agent_update_handler._protocol.get_goal_state(), True)
mock_wire_data = agent_update_handler._protocol.mock_wire_data
self.assertEqual(1, mock_wire_data.call_counts['manifest_of_ga.xml'], "Agent manifest should not be downloaded again")
def test_it_should_download_manifest_if_last_attempted_download_time_is_elapsed(self):
self.prepare_agents(count=1)
data_file = DATA_FILE.copy()
data_file['ext_conf'] = "wire/ext_conf.xml"
with self._get_agent_update_handler(test_data=data_file, autoupdate_frequency=0.00001, protocol_get_error=True) as (agent_update_handler, _):
# making multiple agent update attempts
agent_update_handler.run(agent_update_handler._protocol.get_goal_state(), True)
agent_update_handler.run(agent_update_handler._protocol.get_goal_state(), True)
agent_update_handler.run(agent_update_handler._protocol.get_goal_state(), True)
mock_wire_data = agent_update_handler._protocol.mock_wire_data
self.assertEqual(3, mock_wire_data.call_counts['manifest_of_ga.xml'], "Agent manifest should be downloaded in all attempts")
def test_it_should_not_agent_update_if_rsm_version_is_same_as_current_version(self):
data_file = DATA_FILE.copy()
data_file["ext_conf"] = "wire/ext_conf_rsm_version.xml"
# Set the test environment by adding 20 random agents to the agent directory
self.prepare_agents()
self.assertEqual(20, self.agent_count(), "Agent directories not set properly")
with self._get_agent_update_handler(test_data=data_file) as (agent_update_handler, mock_telemetry):
agent_update_handler._protocol.mock_wire_data.set_version_in_agent_family(
str(CURRENT_VERSION))
agent_update_handler._protocol.mock_wire_data.set_incarnation(2)
agent_update_handler._protocol.client.update_goal_state()
agent_update_handler.run(agent_update_handler._protocol.get_goal_state(), True)
self.assertEqual(0, len([kwarg['message'] for _, kwarg in mock_telemetry.call_args_list if
"requesting a new agent version" in kwarg['message'] and kwarg[
'op'] == WALAEventOperation.AgentUpgrade]), "rsm version should be same as current version")
self.assertFalse(os.path.exists(self.agent_dir("99999.0.0.0")),
"New agent directory should not be found")
def test_it_should_upgrade_agent_if_rsm_version_is_available_greater_than_current_version(self):
data_file = DATA_FILE.copy()
data_file["ext_conf"] = "wire/ext_conf_rsm_version.xml"
# Set the test environment by adding 20 random agents to the agent directory
self.prepare_agents()
self.assertEqual(20, self.agent_count(), "Agent directories not set properly")
with self._get_agent_update_handler(test_data=data_file) as (agent_update_handler, mock_telemetry):
with self.assertRaises(AgentUpgradeExitException) as context:
agent_update_handler.run(agent_update_handler._protocol.get_goal_state(), True)
self._assert_agent_rsm_version_in_goal_state(mock_telemetry, version="9.9.9.10")
self._assert_agent_directories_exist_and_others_dont_exist(versions=["9.9.9.10", str(CURRENT_VERSION)])
self._assert_agent_exit_process_telemetry_emitted(ustr(context.exception.reason))
def test_it_should_downgrade_agent_if_rsm_version_is_available_less_than_current_version(self):
data_file = DATA_FILE.copy()
data_file["ext_conf"] = "wire/ext_conf_rsm_version.xml"
# Set the test environment by adding 20 random agents to the agent directory
self.prepare_agents()
self.assertEqual(20, self.agent_count(), "Agent directories not set properly")
downgraded_version = "2.5.0"
with self._get_agent_update_handler(test_data=data_file) as (agent_update_handler, mock_telemetry):
agent_update_handler._protocol.mock_wire_data.set_version_in_agent_family(downgraded_version)
agent_update_handler._protocol.mock_wire_data.set_incarnation(2)
agent_update_handler._protocol.client.update_goal_state()
with self.assertRaises(AgentUpgradeExitException) as context:
agent_update_handler.run(agent_update_handler._protocol.get_goal_state(), True)
self._assert_agent_rsm_version_in_goal_state(mock_telemetry, inc=2, version=downgraded_version)
self._assert_agent_directories_exist_and_others_dont_exist(
versions=[downgraded_version, str(CURRENT_VERSION)])
self._assert_agent_exit_process_telemetry_emitted(ustr(context.exception.reason))
def test_it_should_not_do_rsm_update_if_gs_not_updated_in_next_attempt(self):
self.prepare_agents(count=1)
data_file = DATA_FILE.copy()
data_file["ext_conf"] = "wire/ext_conf_rsm_version.xml"
version = "5.2.0.1"
with self._get_agent_update_handler(test_data=data_file, autoupdate_frequency=10) as (agent_update_handler, mock_telemetry):
agent_update_handler._protocol.mock_wire_data.set_version_in_agent_family(version)
agent_update_handler._protocol.mock_wire_data.set_incarnation(2)
agent_update_handler._protocol.client.update_goal_state()
agent_update_handler.run(agent_update_handler._protocol.get_goal_state(), True)
self._assert_agent_rsm_version_in_goal_state(mock_telemetry, inc=2, version=version)
self._assert_no_agent_package_telemetry_emitted(mock_telemetry, version=version)
# Now we shouldn't check for download if update not allowed(GS not updated).This run should not add new logs
agent_update_handler.run(agent_update_handler._protocol.get_goal_state(), False)
self._assert_agent_rsm_version_in_goal_state(mock_telemetry, inc=2, version=version)
self._assert_no_agent_package_telemetry_emitted(mock_telemetry, version=version)
def test_it_should_not_downgrade_below_daemon_version(self):
data_file = DATA_FILE.copy()
data_file["ext_conf"] = "wire/ext_conf_rsm_version.xml"
# Set the test environment by adding 20 random agents to the agent directory
self.prepare_agents()
self.assertEqual(20, self.agent_count(), "Agent directories not set properly")
downgraded_version = "1.2.0"
with self._get_agent_update_handler(test_data=data_file) as (agent_update_handler, _):
agent_update_handler._protocol.mock_wire_data.set_version_in_agent_family(downgraded_version)
agent_update_handler._protocol.mock_wire_data.set_incarnation(2)
agent_update_handler._protocol.client.update_goal_state()
agent_update_handler.run(agent_update_handler._protocol.get_goal_state(), True)
self.assertFalse(os.path.exists(self.agent_dir(downgraded_version)),
"New agent directory should not be found")
def test_it_should_update_to_largest_version_if_vm_not_enabled_for_rsm_upgrades(self):
self.prepare_agents(count=1)
data_file = DATA_FILE.copy()
data_file['ext_conf'] = "wire/ext_conf_vm_not_enabled_for_rsm_upgrades.xml"
with self._get_agent_update_handler(test_data=data_file) as (agent_update_handler, mock_telemetry):
with self.assertRaises(AgentUpgradeExitException) as context:
agent_update_handler.run(agent_update_handler._protocol.get_goal_state(), True)
self._assert_update_discovered_from_agent_manifest(mock_telemetry, version="99999.0.0.0")
self._assert_agent_directories_exist_and_others_dont_exist(versions=[str(CURRENT_VERSION), "99999.0.0.0"])
self._assert_agent_exit_process_telemetry_emitted(ustr(context.exception.reason))
def test_it_should_not_update_to_version_if_version_not_from_rsm(self):
self.prepare_agents(count=1)
data_file = DATA_FILE.copy()
data_file["ext_conf"] = "wire/ext_conf_version_not_from_rsm.xml"
downgraded_version = "2.5.0"
with self._get_agent_update_handler(test_data=data_file) as (agent_update_handler, _):
agent_update_handler._protocol.mock_wire_data.set_version_in_agent_family(downgraded_version)
agent_update_handler._protocol.mock_wire_data.set_incarnation(2)
agent_update_handler._protocol.client.update_goal_state()
agent_update_handler.run(agent_update_handler._protocol.get_goal_state(), True)
self._assert_agent_directories_exist_and_others_dont_exist(
versions=[str(CURRENT_VERSION)])
self.assertFalse(os.path.exists(self.agent_dir(downgraded_version)),
"New agent directory should not be found")
def test_handles_if_rsm_version_not_found_in_pkgs_to_download(self):
data_file = DATA_FILE.copy()
data_file["ext_conf"] = "wire/ext_conf_rsm_version.xml"
# Set the test environment by adding 20 random agents to the agent directory
self.prepare_agents()
self.assertEqual(20, self.agent_count(), "Agent directories not set properly")
version = "5.2.0.4"
with self._get_agent_update_handler(test_data=data_file) as (agent_update_handler, mock_telemetry):
agent_update_handler._protocol.mock_wire_data.set_version_in_agent_family(version)
agent_update_handler._protocol.mock_wire_data.set_incarnation(2)
agent_update_handler._protocol.client.update_goal_state()
agent_update_handler.run(agent_update_handler._protocol.get_goal_state(), True)
self._assert_agent_rsm_version_in_goal_state(mock_telemetry, inc=2, version=version)
self.assertFalse(os.path.exists(self.agent_dir(version)),
"New agent directory should not be found")
self._assert_no_agent_package_telemetry_emitted(mock_telemetry, version=version)
def test_handles_missing_agent_family(self):
data_file = DATA_FILE.copy()
data_file["ext_conf"] = "wire/ext_conf_missing_family.xml"
# Set the test environment by adding 20 random agents to the agent directory
self.prepare_agents()
self.assertEqual(20, self.agent_count(), "Agent directories not set properly")
with self._get_agent_update_handler(test_data=data_file) as (agent_update_handler, mock_telemetry):
agent_update_handler.run(agent_update_handler._protocol.get_goal_state(), True)
self.assertFalse(os.path.exists(self.agent_dir("99999.0.0.0")),
"New agent directory should not be found")
self.assertEqual(1, len([kwarg['message'] for _, kwarg in mock_telemetry.call_args_list if
"No manifest links found for agent family" in kwarg[
'message'] and kwarg[
'op'] == WALAEventOperation.AgentUpgrade]), "Agent manifest should not be in GS")
# making multiple agent update attempts and assert only one time logged
agent_update_handler.run(agent_update_handler._protocol.get_goal_state(), False)
agent_update_handler.run(agent_update_handler._protocol.get_goal_state(), False)
self.assertEqual(1, len([kwarg['message'] for _, kwarg in mock_telemetry.call_args_list if
"No manifest links found for agent family" in kwarg[
'message'] and kwarg[
'op'] == WALAEventOperation.AgentUpgrade]),
"Agent manifest error should be logged once if it's same goal state")
def test_it_should_report_update_status_with_success(self):
data_file = DATA_FILE.copy()
data_file["ext_conf"] = "wire/ext_conf_rsm_version.xml"
with self._get_agent_update_handler(test_data=data_file) as (agent_update_handler, _):
agent_update_handler._protocol.mock_wire_data.set_version_in_agent_family(
str(CURRENT_VERSION))
agent_update_handler._protocol.mock_wire_data.set_incarnation(2)
agent_update_handler._protocol.client.update_goal_state()
agent_update_handler.run(agent_update_handler._protocol.get_goal_state(), True)
vm_agent_update_status = agent_update_handler.get_vmagent_update_status()
self.assertEqual(VMAgentUpdateStatuses.Success, vm_agent_update_status.status)
self.assertEqual(0, vm_agent_update_status.code)
self.assertEqual(str(CURRENT_VERSION), vm_agent_update_status.expected_version)
def test_it_should_report_update_status_with_error_on_download_fail(self):
data_file = DATA_FILE.copy()
data_file["ext_conf"] = "wire/ext_conf_rsm_version.xml"
with self._get_agent_update_handler(test_data=data_file, protocol_get_error=True) as (agent_update_handler, _):
agent_update_handler.run(agent_update_handler._protocol.get_goal_state(), True)
vm_agent_update_status = agent_update_handler.get_vmagent_update_status()
self.assertEqual(VMAgentUpdateStatuses.Error, vm_agent_update_status.status)
self.assertEqual(1, vm_agent_update_status.code)
self.assertEqual("9.9.9.10", vm_agent_update_status.expected_version)
self.assertIn("Failed to download agent package from all URIs", vm_agent_update_status.message)
def test_it_should_not_report_error_status_if_new_rsm_version_is_same_as_current_after_last_update_attempt_failed(self):
data_file = DATA_FILE.copy()
data_file["ext_conf"] = "wire/ext_conf_rsm_version.xml"
with self._get_agent_update_handler(test_data=data_file, protocol_get_error=True) as (agent_update_handler, _):
agent_update_handler.run(agent_update_handler._protocol.get_goal_state(), True)
vm_agent_update_status = agent_update_handler.get_vmagent_update_status()
self.assertEqual(VMAgentUpdateStatuses.Error, vm_agent_update_status.status)
self.assertEqual(1, vm_agent_update_status.code)
self.assertEqual("9.9.9.10", vm_agent_update_status.expected_version)
self.assertIn("Failed to download agent package from all URIs", vm_agent_update_status.message)
# Send same version GS after last update attempt failed
agent_update_handler._protocol.mock_wire_data.set_version_in_agent_family(
str(CURRENT_VERSION))
agent_update_handler._protocol.mock_wire_data.set_incarnation(2)
agent_update_handler._protocol.client.update_goal_state()
agent_update_handler.run(agent_update_handler._protocol.get_goal_state(), True)
vm_agent_update_status = agent_update_handler.get_vmagent_update_status()
self.assertEqual(VMAgentUpdateStatuses.Success, vm_agent_update_status.status)
self.assertEqual(0, vm_agent_update_status.code)
self.assertEqual(str(CURRENT_VERSION), vm_agent_update_status.expected_version)
def test_it_should_report_update_status_with_missing_rsm_version_error(self):
data_file = DATA_FILE.copy()
data_file['ext_conf'] = "wire/ext_conf_version_missing_in_agent_family.xml"
with self._get_agent_update_handler(test_data=data_file, protocol_get_error=True) as (agent_update_handler, _):
agent_update_handler.run(agent_update_handler._protocol.get_goal_state(), True)
vm_agent_update_status = agent_update_handler.get_vmagent_update_status()
self.assertEqual(VMAgentUpdateStatuses.Error, vm_agent_update_status.status)
self.assertEqual(1, vm_agent_update_status.code)
self.assertIn("missing version property. So, skipping agent update", vm_agent_update_status.message)
def test_it_should_not_log_same_error_next_hours(self):
data_file = DATA_FILE.copy()
data_file["ext_conf"] = "wire/ext_conf_missing_family.xml"
# Set the test environment by adding 20 random agents to the agent directory
self.prepare_agents()
self.assertEqual(20, self.agent_count(), "Agent directories not set properly")
with self._get_agent_update_handler(test_data=data_file) as (agent_update_handler, mock_telemetry):
agent_update_handler.run(agent_update_handler._protocol.get_goal_state(), True)
self.assertFalse(os.path.exists(self.agent_dir("99999.0.0.0")),
"New agent directory should not be found")
self.assertEqual(1, len([kwarg['message'] for _, kwarg in mock_telemetry.call_args_list if
"No manifest links found for agent family" in kwarg[
'message'] and kwarg[
'op'] == WALAEventOperation.AgentUpgrade]), "Agent manifest should not be in GS")
agent_update_handler.run(agent_update_handler._protocol.get_goal_state(), True)
self.assertEqual(1, len([kwarg['message'] for _, kwarg in mock_telemetry.call_args_list if
"No manifest links found for agent family" in kwarg[
'message'] and kwarg[
'op'] == WALAEventOperation.AgentUpgrade]), "Agent manifest should not be in GS")
def test_it_should_save_rsm_state_of_the_most_recent_goal_state(self):
data_file = DATA_FILE.copy()
data_file["ext_conf"] = "wire/ext_conf_rsm_version.xml"
with self._get_agent_update_handler(test_data=data_file) as (agent_update_handler, _):
with self.assertRaises(AgentUpgradeExitException):
agent_update_handler.run(agent_update_handler._protocol.get_goal_state(), True)
state_file = os.path.join(conf.get_lib_dir(), RSM_UPDATE_STATE_FILE)
self.assertTrue(os.path.exists(state_file), "The rsm state file was not saved (can't find {0})".format(state_file))
# check if state gets updated if most recent goal state has different values
agent_update_handler._protocol.mock_wire_data.set_extension_config_is_vm_enabled_for_rsm_upgrades("False")
agent_update_handler._protocol.mock_wire_data.set_incarnation(2)
agent_update_handler._protocol.client.update_goal_state()
with self.assertRaises(AgentUpgradeExitException):
agent_update_handler.run(agent_update_handler._protocol.get_goal_state(), True)
self.assertFalse(os.path.exists(state_file), "The rsm file should be removed (file: {0})".format(state_file))
def test_it_should_not_update_to_latest_if_flag_is_disabled(self):
self.prepare_agents(count=1)
data_file = DATA_FILE.copy()
data_file['ext_conf'] = "wire/ext_conf.xml"
with self._get_agent_update_handler(test_data=data_file) as (agent_update_handler, _):
with patch("azurelinuxagent.common.conf.get_auto_update_to_latest_version", return_value=False):
agent_update_handler.run(agent_update_handler._protocol.get_goal_state(), True)
self._assert_agent_directories_exist_and_others_dont_exist(versions=[str(CURRENT_VERSION)])
def test_it_should_continue_with_update_if_number_of_update_attempts_less_than_3(self):
data_file = DATA_FILE.copy()
data_file["ext_conf"] = "wire/ext_conf_rsm_version.xml"
latest_version = self.prepare_agents(count=2)
self.expand_agents()
latest_path = os.path.join(self.tmp_dir, "{0}-{1}".format(AGENT_NAME, latest_version))
agent = GuestAgent.from_installed_agent(latest_path)
# marking agent as bad agent on first attempt
agent.mark_failure(is_fatal=True)
agent.inc_update_attempt_count()
self.assertTrue(agent.is_blacklisted, "Agent should be blacklisted")
self.assertEqual(1, agent.get_update_attempt_count(), "Agent update attempts should be 1")
with self._get_agent_update_handler(test_data=data_file) as (agent_update_handler, mock_telemetry):
# Rest 2 attempts it should continue with update even agent is marked as bad agent in first attempt
for i in range(2):
with self.assertRaises(AgentUpgradeExitException):
agent_update_handler._protocol.mock_wire_data.set_version_in_agent_family(
str(latest_version))
agent_update_handler._protocol.mock_wire_data.set_version_in_ga_manifest(str(latest_version))
agent_update_handler._protocol.mock_wire_data.set_incarnation(i+2)
agent_update_handler._protocol.client.update_goal_state()
agent_update_handler.run(agent_update_handler._protocol.get_goal_state(), True)
self._assert_agent_directories_exist_and_others_dont_exist(versions=[str(CURRENT_VERSION), str(latest_version)])
agent = GuestAgent.from_installed_agent(latest_path)
self.assertFalse(agent.is_blacklisted, "Agent should not be blacklisted")
self.assertEqual(i+2, agent.get_update_attempt_count(), "Agent update attempts should be {0}".format(i+2))
# check if next update is not attempted
agent.mark_failure(is_fatal=True)
agent_update_handler.run(agent_update_handler._protocol.get_goal_state(), True)
agent = GuestAgent.from_installed_agent(latest_path)
self.assertTrue(agent.is_blacklisted, "Agent should be blacklisted")
self.assertEqual(3, agent.get_update_attempt_count(), "Agent update attempts should be 3")
self.assertEqual(1, len([kwarg['message'] for _, kwarg in mock_telemetry.call_args_list if
"Attempted enough update retries for version: {0} but still agent not recovered from bad state".format(latest_version) in kwarg[
'message'] and kwarg[
'op'] == WALAEventOperation.AgentUpgrade]),
"Update is not allowed after 3 attempts")
def test_it_should_fail_the_update_if_agent_pkg_is_invalid(self):
agent_uri = 'https://foo.blob.core.windows.net/bar/OSTCExtensions.WALinuxAgent__9.9.9.10'
def http_get_handler(uri, *_, **__):
if uri in (agent_uri, 'http://168.63.129.16:32526/extensionArtifact'):
response = load_bin_data("ga/WALinuxAgent-9.9.9.10-no_manifest.zip")
return MockHttpResponse(status=httpclient.OK, body=response)
return None
self.prepare_agents(count=1)
data_file = DATA_FILE.copy()
data_file["ext_conf"] = "wire/ext_conf_rsm_version.xml"
with self._get_agent_update_handler(test_data=data_file, mock_get_header=http_get_handler) as (agent_update_handler, mock_telemetry):
agent_update_handler._protocol.mock_wire_data.set_version_in_agent_family("9.9.9.10")
agent_update_handler._protocol.mock_wire_data.set_incarnation(2)
agent_update_handler._protocol.client.update_goal_state()
agent_update_handler.run(agent_update_handler._protocol.get_goal_state(), True)
self._assert_agent_directories_exist_and_others_dont_exist(versions=[str(CURRENT_VERSION)])
self.assertEqual(1, len([kwarg['message'] for _, kwarg in mock_telemetry.call_args_list if
"Downloaded agent package: WALinuxAgent-9.9.9.10 is missing agent handler manifest file" in kwarg['message'] and kwarg[
'op'] == WALAEventOperation.AgentUpgrade]), "Agent update should fail")
def test_it_should_use_self_update_for_first_update_always(self):
self.prepare_agents(count=1)
# mock the goal state as vm enrolled into RSM
data_file = DATA_FILE.copy()
data_file['ext_conf'] = "wire/ext_conf_rsm_version.xml"
with self._get_agent_update_handler(test_data=data_file, initial_update_attempted=False) as (agent_update_handler, mock_telemetry):
with self.assertRaises(AgentUpgradeExitException) as context:
agent_update_handler.run(agent_update_handler._protocol.get_goal_state(), True)
# Verifying agent used self-update for initial update
self._assert_update_discovered_from_agent_manifest(mock_telemetry, version="99999.0.0.0")
self._assert_agent_directories_exist_and_others_dont_exist(versions=[str(CURRENT_VERSION), "99999.0.0.0"])
self._assert_agent_exit_process_telemetry_emitted(ustr(context.exception.reason))
state_file = os.path.join(conf.get_lib_dir(), INITIAL_UPDATE_STATE_FILE)
self.assertTrue(os.path.exists(state_file),
"The first update state file was not saved (can't find {0})".format(state_file))
def test_it_should_honor_any_update_type_after_first_update(self):
self.prepare_agents(count=1)
data_file = DATA_FILE.copy()
data_file['ext_conf'] = "wire/ext_conf_rsm_version.xml"
# mocking initial update attempt as true
with self._get_agent_update_handler(test_data=data_file, initial_update_attempted=True) as (agent_update_handler, mock_telemetry):
with self.assertRaises(AgentUpgradeExitException) as context:
agent_update_handler.run(agent_update_handler._protocol.get_goal_state(), True)
# Verifying agent honored RSM update
self._assert_agent_rsm_version_in_goal_state(mock_telemetry, version="9.9.9.10")
self._assert_agent_directories_exist_and_others_dont_exist(versions=["9.9.9.10", str(CURRENT_VERSION)])
self._assert_agent_exit_process_telemetry_emitted(ustr(context.exception.reason))
|
