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
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
|
# Microsoft Azure Linux Agent
#
# Copyright 2014 Microsoft Corporation
#
# 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.
#
# Requires Python 2.4+ and Openssl 1.0+
#
import os
import zipfile
import time
import json
import subprocess
import shutil
import azurelinuxagent.logger as logger
from azurelinuxagent.future import text
from azurelinuxagent.utils.osutil import OSUTIL
import azurelinuxagent.protocol as prot
from azurelinuxagent.metadata import AGENT_VERSION
from azurelinuxagent.event import add_event, WALAEventOperation
from azurelinuxagent.exception import ExtensionError
import azurelinuxagent.utils.fileutil as fileutil
import azurelinuxagent.utils.restutil as restutil
import azurelinuxagent.utils.shellutil as shellutil
from azurelinuxagent.utils.textutil import Version
#HandlerEnvironment.json schema version
HANDLER_ENVIRONMENT_VERSION = 1.0
VALID_EXTENSION_STATUS = ['transitioning', 'error', 'success', 'warning']
VALID_HANDLER_STATUS = ['Ready', 'NotReady', "Installing", "Unresponsive"]
def handler_state_to_status(handler_state):
if handler_state == "Enabled":
return "Ready"
elif handler_state in VALID_HANDLER_STATUS:
return handler_state
else:
return "NotReady"
def validate_has_key(obj, key, fullname):
if key not in obj:
raise ExtensionError("Missing: {0}".format(fullname))
def validate_in_range(val, valid_range, name):
if val not in valid_range:
raise ExtensionError("Invalid {0}: {1}".format(name, val))
def parse_formatted_message(formatted_message):
if formatted_message is None:
return None
validate_has_key(formatted_message, 'lang', 'formattedMessage/lang')
validate_has_key(formatted_message, 'message', 'formattedMessage/message')
return formatted_message.get('message')
def parse_ext_substatus(substatus):
#Check extension sub status format
validate_has_key(substatus, 'status', 'substatus/status')
validate_in_range(substatus['status'], VALID_EXTENSION_STATUS,
'substatus/status')
status = prot.ExtensionSubStatus()
status.name = substatus.get('name')
status.status = substatus.get('status')
status.code = substatus.get('code', 0)
formatted_message = substatus.get('formattedMessage')
status.message = parse_formatted_message(formatted_message)
return status
def parse_ext_status(ext_status, data):
if data is None or len(data) is None:
return
#Currently, only the first status will be reported
data = data[0]
#Check extension status format
validate_has_key(data, 'status', 'status')
status_data = data['status']
validate_has_key(status_data, 'status', 'status/status')
validate_in_range(status_data['status'], VALID_EXTENSION_STATUS,
'status/status')
applied_time = status_data.get('configurationAppliedTime')
ext_status.configurationAppliedTime = applied_time
ext_status.operation = status_data.get('operation')
ext_status.status = status_data.get('status')
ext_status.code = status_data.get('code', 0)
formatted_message = status_data.get('formattedMessage')
ext_status.message = parse_formatted_message(formatted_message)
substatus_list = status_data.get('substatus')
if substatus_list is None:
return
for substatus in substatus_list:
ext_status.substatusList.append(parse_ext_substatus(substatus))
def parse_extension_dirname(dirname):
"""
Parse installed extension dir name. Sample: ExtensionName-Version/
"""
seprator = dirname.rfind('-')
if seprator < 0:
raise ExtensionError("Invalid extenation dir name")
return dirname[0:seprator], dirname[seprator + 1:]
def get_installed_version(target_name):
"""
Return the highest version instance with the same name
"""
installed_version = None
lib_dir = OSUTIL.get_lib_dir()
for dir_name in os.listdir(lib_dir):
path = os.path.join(lib_dir, dir_name)
if os.path.isdir(path) and dir_name.startswith(target_name):
name, version = parse_extension_dirname(dir_name)
#Here we need to ensure names are exactly the same.
if name == target_name:
if installed_version is None or \
Version(installed_version) < Version(version):
installed_version = version
return installed_version
class ExtHandlerState(object):
Enabled = "Enabled"
Disabled = "Disabled"
Failed = "Failed"
class ExtHandlersHandler(object):
def process(self):
try:
protocol = prot.FACTORY.get_default_protocol()
ext_handlers = protocol.get_ext_handlers()
except prot.ProtocolError as e:
add_event(name="WALA", is_success=False, message = text(e))
return
vm_status = prot.VMStatus()
vm_status.vmAgent.version = AGENT_VERSION
vm_status.vmAgent.status = "Ready"
vm_status.vmAgent.message = "Guest Agent is running"
if ext_handlers.extHandlers is None or \
len(ext_handlers.extHandlers) == 0:
logger.verb("No extensions to handle")
else:
for ext_handler in ext_handlers.extHandlers:
#TODO handle extension in parallel
try:
pkg_list = protocol.get_ext_handler_pkgs(ext_handler)
except prot.ProtocolError as e:
add_event(name="WALA", is_success=False, message=text(e))
continue
handler_status = self.process_extension(ext_handler, pkg_list)
if handler_status is not None:
vm_status.vmAgent.extensionHandlers.append(handler_status)
try:
logger.verb("Report vm agent status")
protocol.report_vm_status(vm_status)
except prot.ProtocolError as e:
add_event(name="WALA", is_success=False, message = text(e))
def process_extension(self, ext_handler, pkg_list):
installed_version = get_installed_version(ext_handler.name)
if installed_version is not None:
handler = ExtHandlerInstance(ext_handler, pkg_list,
installed_version, installed=True)
else:
handler = ExtHandlerInstance(ext_handler, pkg_list,
ext_handler.properties.version)
handler.handle()
if handler.ext_status is not None:
try:
protocol = prot.FACTORY.get_default_protocol()
protocol.report_ext_status(handler.name, handler.ext.name,
handler.ext_status)
except prot.ProtocolError as e:
add_event(name="WALA", is_success=False, message=text(e))
return handler.handler_status
class ExtHandlerInstance(object):
def __init__(self, ext_handler, pkg_list, curr_version, installed=False):
self.ext_handler = ext_handler
self.name = ext_handler.name
self.version = ext_handler.properties.version
self.pkg_list = pkg_list
self.state = ext_handler.properties.state
self.update_policy = ext_handler.properties.upgradePolicy
self.curr_version = curr_version
self.installed = installed
self.handler_state = None
self.lib_dir = OSUTIL.get_lib_dir()
self.ext_status = prot.ExtensionStatus()
self.handler_status = prot.ExtHandlerStatus()
self.handler_status.name = self.name
self.handler_status.version = self.curr_version
#Currently, extension settings will have no more than 1 instance
if len(ext_handler.properties.extensions) > 0:
self.ext = ext_handler.properties.extensions[0]
self.handler_status.extensions = [self.ext.name]
else:
#When no extension settings, set sequenceNumber to 0
self.ext = prot.Extension(sequenceNumber=0)
self.ext_status.sequenceNumber = self.ext.sequenceNumber
prefix = "[{0}]".format(self.get_full_name())
self.logger = logger.Logger(logger.DEFAULT_LOGGER, prefix)
def init_logger(self):
#Init logger appender for extension
fileutil.mkdir(self.get_log_dir(), mode=0o644)
log_file = os.path.join(self.get_log_dir(), "CommandExecution.log")
self.logger.add_appender(logger.AppenderType.FILE,
logger.LogLevel.INFO, log_file)
def handle(self):
self.init_logger()
self.logger.verb("Start processing extension handler")
try:
self.handle_state()
except ExtensionError as e:
self.set_state_err(text(e))
self.report_event(is_success=False, message=text(e))
self.logger.error("Failed to process extension handler")
return
try:
if self.installed:
self.collect_ext_status()
self.collect_handler_status()
except ExtensionError as e:
self.report_event(is_success=False, message=text(e))
self.logger.error("Failed to get extension handler status")
return
self.logger.verb("Finished processing extension handler")
def handle_state(self):
if self.installed:
self.handler_state = self.get_state()
self.handler_status.status = handler_state_to_status(self.handler_state)
self.logger.verb("Handler state: {0}", self.handler_state)
self.logger.verb("Sequence number: {0}", self.ext.sequenceNumber)
if self.state == 'enabled':
if self.handler_state == ExtHandlerState.Failed:
self.logger.verb("Found previous failure, quit handle_enable")
return
if self.handler_state == ExtHandlerState.Enabled:
self.logger.verb("Already enabled with sequenceNumber: {0}",
self.ext.sequenceNumber)
self.logger.verb("Quit handle_enable")
return
try:
new = self.handle_enable()
if new is not None:
#Upgrade happened
new.set_state(ExtHandlerState.Enabled)
else:
self.set_state(ExtHandlerState.Enabled)
except ExtensionError as e:
self.set_state(ExtHandlerState.Failed)
raise e
elif self.state == 'disabled':
if self.handler_state == ExtHandlerState.Failed:
self.logger.verb("Found previous failure, quit handle_disable")
return
if self.handler_state == ExtHandlerState.Disabled:
self.logger.verb("Already disabled with sequenceNumber: {0}",
self.ext.sequenceNumber)
self.logger.verb("Quit handle_disable")
return
try:
self.handle_disable()
self.set_state(ExtHandlerState.Disabled)
except ExtensionError as e:
self.set_state(ExtHandlerState.Failed)
raise e
elif self.state == 'uninstall':
try:
self.handle_uninstall()
except ExtensionError as e:
self.set_state(ExtHandlerState.Failed)
raise e
else:
raise ExtensionError("Unknown state:{0}".format(self.state))
def handle_enable(self):
target_version = self.get_target_version()
self.logger.info("Target version: {0}", target_version)
if self.installed:
if Version(target_version) > Version(self.curr_version):
return self.upgrade(target_version)
elif Version(target_version) == Version(self.curr_version):
self.enable()
else:
raise ExtensionError("A newer version is already installed")
else:
if Version(target_version) > Version(self.version):
#This will happen when auto upgrade policy is enabled
self.logger.info("Auto upgrade to new version:{0}",
target_version)
self.curr_version = target_version
self.download()
self.init_dir()
self.install()
self.enable()
def handle_disable(self):
if not self.installed:
self.logger.verb("Not installed, quit disable")
return
self.disable()
def handle_uninstall(self):
if not self.installed:
self.logger.verb("Not installed, quit unistall")
self.handler_status = None
self.ext_status = None
return
self.disable()
self.uninstall()
def report_event(self, is_success=True, message=""):
if self.ext_status is not None:
if not is_success:
self.ext_status.status = "error"
self.ext_status.code = -1
if self.handler_status is not None:
self.handler_status.message = message
if not is_success:
self.handler_status.status = "NotReady"
add_event(name=self.name, op=self.ext_status.operation,
is_success=is_success, message=message)
def set_operation(self, operation):
if self.ext_status.operation != WALAEventOperation.Upgrade:
self.ext_status.operation = operation
def upgrade(self, target_version):
self.logger.info("Upgrade from: {0} to {1}", self.curr_version,
target_version)
self.set_operation(WALAEventOperation.Upgrade)
old = self
new = ExtHandlerInstance(self.ext_handler, self.pkg_list,
target_version)
self.logger.info("Download new extension package")
new.init_logger()
new.download()
self.logger.info("Initialize new extension directory")
new.init_dir()
old.disable()
self.logger.info("Update new extension")
new.update()
old.uninstall()
man = new.load_manifest()
if man.is_update_with_install():
self.logger.info("Install new extension")
new.install()
self.logger.info("Enable new extension")
new.enable()
return new
def download(self):
self.logger.info("Download extension package")
self.set_operation(WALAEventOperation.Download)
uris = self.get_package_uris()
package = None
for uri in uris:
try:
resp = restutil.http_get(uri.uri, chk_proxy=True)
if resp.status == restutil.httpclient.OK:
package = resp.read()
break
except restutil.HttpError as e:
self.logger.warn("Failed download extension from: {0}", uri.uri)
if package is None:
raise ExtensionError("Download extension failed")
self.logger.info("Unpack extension package")
pkg_file = os.path.join(self.lib_dir, os.path.basename(uri.uri) + ".zip")
fileutil.write_file(pkg_file, bytearray(package), asbin=True)
zipfile.ZipFile(pkg_file).extractall(self.get_base_dir())
chmod = "find {0} -type f | xargs chmod u+x".format(self.get_base_dir())
shellutil.run(chmod)
self.report_event(message="Download succeeded")
def init_dir(self):
self.logger.info("Initialize extension directory")
#Save HandlerManifest.json
man_file = fileutil.search_file(self.get_base_dir(),
'HandlerManifest.json')
man = fileutil.read_file(man_file, remove_bom=True)
fileutil.write_file(self.get_manifest_file(), man)
#Create status and config dir
status_dir = self.get_status_dir()
fileutil.mkdir(status_dir, mode=0o700)
conf_dir = self.get_conf_dir()
fileutil.mkdir(conf_dir, mode=0o700)
self.make_handler_state_dir()
#Save HandlerEnvironment.json
self.create_handler_env()
def enable(self):
self.logger.info("Enable extension.")
self.set_operation(WALAEventOperation.Enable)
man = self.load_manifest()
self.launch_command(man.get_enable_command())
def disable(self):
self.logger.info("Disable extension.")
self.set_operation(WALAEventOperation.Disable)
man = self.load_manifest()
self.launch_command(man.get_disable_command(), timeout=900)
def install(self):
self.logger.info("Install extension.")
self.set_operation(WALAEventOperation.Install)
man = self.load_manifest()
self.launch_command(man.get_install_command(), timeout=900)
self.installed = True
def uninstall(self):
self.logger.info("Uninstall extension.")
self.set_operation(WALAEventOperation.UnInstall)
man = self.load_manifest()
self.launch_command(man.get_uninstall_command())
self.logger.info("Remove ext handler dir: {0}", self.get_base_dir())
try:
shutil.rmtree(self.get_base_dir())
except IOError as e:
raise ExtensionError("Failed to rm ext handler dir: {0}".format(e))
self.installed = False
self.handler_status = None
self.ext_status = None
def update(self):
self.logger.info("Update extension.")
self.set_operation(WALAEventOperation.Update)
man = self.load_manifest()
self.launch_command(man.get_update_command(), timeout=900)
def collect_handler_status(self):
self.logger.verb("Collect extension handler status")
if self.handler_status is None:
return
handler_state = self.get_state()
self.handler_status.status = handler_state_to_status(handler_state)
self.handler_status.message = self.get_state_err()
man = self.load_manifest()
if man.is_report_heartbeat():
heartbeat = self.collect_heartbeat()
if heartbeat is not None:
self.handler_status.status = heartbeat['status']
def collect_ext_status(self):
self.logger.verb("Collect extension status")
if self.handler_status is None:
return
if self.ext is None:
return
ext_status_file = self.get_status_file()
try:
data_str = fileutil.read_file(ext_status_file)
data = json.loads(data_str)
parse_ext_status(self.ext_status, data)
except IOError as e:
raise ExtensionError("Failed to get status file: {0}".format(e))
except ValueError as e:
raise ExtensionError("Malformed status file: {0}".format(e))
def make_handler_state_dir(self):
handler_state_dir = self.get_handler_state_dir()
fileutil.mkdir(handler_state_dir, 0o600)
if not os.path.exists(handler_state_dir):
os.makedirs(handler_state_dir)
def get_state(self):
handler_state_file = self.get_handler_state_file()
if not os.path.isfile(handler_state_file):
return None
try:
handler_state = fileutil.read_file(handler_state_file)
if handler_state is not None:
handler_state = handler_state.rstrip()
return handler_state
except IOError as e:
err = "Failed to get handler state: {0}".format(e)
add_event(name=self.name, is_success=False, message=err)
def set_state(self, state):
handler_state_file = self.get_handler_state_file()
if not os.path.isfile(handler_state_file):
self.make_handler_state_dir()
try:
fileutil.write_file(handler_state_file, state)
except IOError as e:
err = "Failed to set handler state: {0}".format(e)
add_event(name=self.name, is_success=False, message=err)
def get_state_err(self):
"""Get handler error message"""
handler_state_err_file= self.get_handler_state_err_file()
if not os.path.isfile(handler_state_err_file):
return None
try:
message = fileutil.read_file(handler_state_err_file)
return message
except IOError as e:
err = "Failed to get handler state message: {0}".format(e)
add_event(name=self.name, is_success=False, message=err)
def set_state_err(self, message):
"""Set handler error message"""
handler_state_err_file = self.get_handler_state_err_file()
if not os.path.isfile(handler_state_err_file):
self.make_handler_state_dir()
try:
fileutil.write_file(handler_state_err_file, message)
except IOError as e:
err = "Failed to set handler state message: {0}".format(e)
add_event(name=self.name, is_success=False, message=err)
def collect_heartbeat(self):
self.logger.info("Collect heart beat")
heartbeat_file = os.path.join(OSUTIL.get_lib_dir(),
self.get_heartbeat_file())
if not os.path.isfile(heartbeat_file):
raise ExtensionError("Failed to get heart beat file")
if not self.is_responsive(heartbeat_file):
return {
"status": "Unresponsive",
"code": -1,
"message": "Extension heartbeat is not responsive"
}
try:
heartbeat_json = fileutil.read_file(heartbeat_file)
heartbeat = json.loads(heartbeat_json)[0]['heartbeat']
except IOError as e:
raise ExtensionError("Failed to get heartbeat file:{0}".format(e))
except ValueError as e:
raise ExtensionError("Malformed heartbeat file: {0}".format(e))
return heartbeat
def is_responsive(self, heartbeat_file):
last_update=int(time.time() - os.stat(heartbeat_file).st_mtime)
return last_update > 600 # not updated for more than 10 min
def launch_command(self, cmd, timeout=300):
self.logger.info("Launch command:{0}", cmd)
base_dir = self.get_base_dir()
self.update_settings()
try:
devnull = open(os.devnull, 'w')
child = subprocess.Popen(base_dir + "/" + cmd, shell=True,
cwd=base_dir, stdout=devnull)
except Exception as e:
#TODO do not catch all exception
raise ExtensionError("Failed to launch: {0}, {1}".format(cmd, e))
retry = timeout / 5
while retry > 0 and child.poll == None:
time.sleep(5)
retry -= 1
if retry == 0:
os.kill(child.pid, 9)
raise ExtensionError("Timeout({0}): {1}".format(timeout, cmd))
ret = child.wait()
if ret == None or ret != 0:
raise ExtensionError("Non-zero exit code: {0}, {1}".format(ret, cmd))
self.report_event(message="Launch command succeeded: {0}".format(cmd))
def load_manifest(self):
man_file = self.get_manifest_file()
try:
data = json.loads(fileutil.read_file(man_file))
except IOError as e:
raise ExtensionError('Failed to load manifest file.')
except ValueError as e:
raise ExtensionError('Malformed manifest file.')
return HandlerManifest(data[0])
def update_settings(self):
if self.ext is None:
self.logger.verb("Extension has no settings")
return
settings = {
'publicSettings': self.ext.publicSettings,
'protectedSettings': self.ext.privateSettings,
'protectedSettingsCertThumbprint': self.ext.certificateThumbprint
}
ext_settings = {
"runtimeSettings":[{
"handlerSettings": settings
}]
}
fileutil.write_file(self.get_settings_file(), json.dumps(ext_settings))
def create_handler_env(self):
env = [{
"name": self.name,
"version" : HANDLER_ENVIRONMENT_VERSION,
"handlerEnvironment" : {
"logFolder" : self.get_log_dir(),
"configFolder" : self.get_conf_dir(),
"statusFolder" : self.get_status_dir(),
"heartbeatFile" : self.get_heartbeat_file()
}
}]
fileutil.write_file(self.get_env_file(),
json.dumps(env))
def get_target_version(self):
version = self.version
update_policy = self.update_policy
if update_policy is None or update_policy.lower() != 'auto':
return version
major = version.split('.')[0]
if major is None:
raise ExtensionError("Wrong version format: {0}".format(version))
packages = [x for x in self.pkg_list.versions \
if x.version.startswith(major + ".")]
packages = sorted(packages, key=lambda x: Version(x.version),
reverse=True)
if len(packages) <= 0:
raise ExtensionError("Can't find version: {0}.*".format(major))
return packages[0].version
def get_package_uris(self):
version = self.curr_version
packages = self.pkg_list.versions
if packages is None:
raise ExtensionError("Package uris is None.")
for package in packages:
if Version(package.version) == Version(version):
return package.uris
raise ExtensionError("Can't get package uris for {0}.".format(version))
def get_full_name(self):
return "{0}-{1}".format(self.name, self.curr_version)
def get_base_dir(self):
return os.path.join(OSUTIL.get_lib_dir(), self.get_full_name())
def get_status_dir(self):
return os.path.join(self.get_base_dir(), "status")
def get_status_file(self):
return os.path.join(self.get_status_dir(),
"{0}.status".format(self.ext.sequenceNumber))
def get_conf_dir(self):
return os.path.join(self.get_base_dir(), 'config')
def get_settings_file(self):
return os.path.join(self.get_conf_dir(),
"{0}.settings".format(self.ext.sequenceNumber))
def get_handler_state_dir(self):
return os.path.join(OSUTIL.get_lib_dir(), "handler_state",
self.get_full_name())
def get_handler_state_file(self):
return os.path.join(self.get_handler_state_dir(),
'{0}.state'.format(self.ext.sequenceNumber))
def get_handler_state_err_file(self):
return os.path.join(self.get_handler_state_dir(),
'{0}.error'.format(self.ext.sequenceNumber))
def get_heartbeat_file(self):
return os.path.join(self.get_base_dir(), 'heartbeat.log')
def get_manifest_file(self):
return os.path.join(self.get_base_dir(), 'HandlerManifest.json')
def get_env_file(self):
return os.path.join(self.get_base_dir(), 'HandlerEnvironment.json')
def get_log_dir(self):
return os.path.join(OSUTIL.get_ext_log_dir(), self.name,
self.curr_version)
class HandlerEnvironment(object):
def __init__(self, data):
self.data = data
def get_version(self):
return self.data["version"]
def get_log_dir(self):
return self.data["handlerEnvironment"]["logFolder"]
def get_conf_dir(self):
return self.data["handlerEnvironment"]["configFolder"]
def get_status_dir(self):
return self.data["handlerEnvironment"]["statusFolder"]
def get_heartbeat_file(self):
return self.data["handlerEnvironment"]["heartbeatFile"]
class HandlerManifest(object):
def __init__(self, data):
if data is None or data['handlerManifest'] is None:
raise ExtensionError('Malformed manifest file.')
self.data = data
def get_name(self):
return self.data["name"]
def get_version(self):
return self.data["version"]
def get_install_command(self):
return self.data['handlerManifest']["installCommand"]
def get_uninstall_command(self):
return self.data['handlerManifest']["uninstallCommand"]
def get_update_command(self):
return self.data['handlerManifest']["updateCommand"]
def get_enable_command(self):
return self.data['handlerManifest']["enableCommand"]
def get_disable_command(self):
return self.data['handlerManifest']["disableCommand"]
def is_reboot_after_install(self):
#TODO handle reboot after install
if "rebootAfterInstall" not in self.data['handlerManifest']:
return False
return self.data['handlerManifest']["rebootAfterInstall"]
def is_report_heartbeat(self):
if "reportHeartbeat" not in self.data['handlerManifest']:
return False
return self.data['handlerManifest']["reportHeartbeat"]
def is_update_with_install(self):
if "updateMode" not in self.data['handlerManifest']:
return False
if "updateMode" in self.data:
return self.data['handlerManifest']["updateMode"].lower() == "updatewithinstall"
return False
|