summaryrefslogtreecommitdiff
path: root/azurelinuxagent/protocol/common.py
blob: 77247ab72822ecf8e4729c0aac1d39c032883883 (plain)
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
# Windows 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 copy
import re
import json
import xml.dom.minidom
import azurelinuxagent.logger as logger
import azurelinuxagent.utils.fileutil as fileutil

class ProtocolError(Exception):
    pass

class ProtocolNotFound(Exception):
    pass

def validata_param(name, val, expected_type):
    if val is None:
        raise ProtocolError("Param {0} is None".format(name))
    if not isinstance(val, expected_type):
        raise ProtocolError("Param {0} type should be {1}".format(name,
                                                                  expected_type))

def set_properties(obj, data):
    validata_param("obj", obj, DataContract)
    validata_param("data", data, dict)

    props = vars(obj)
    for name, val in list(props.items()):
        try:
            new_val = data[name]
        except KeyError:
            continue

        if isinstance(new_val, dict):
            set_properties(val, new_val)
        elif isinstance(new_val, list):
            validata_param("list", val, DataContractList)
            for data_item in new_val:
               item = val.item_cls()
               set_properties(item, data_item)
               val.append(item)
        else:
            setattr(obj, name, new_val)

def get_properties(obj):
    validata_param("obj", obj, DataContract)

    data = {}
    props = vars(obj)
    for name, val in list(props.items()):
        if isinstance(val, DataContract):
            data[name] = get_properties(val)
        elif isinstance(val, DataContractList):
            if len(val) == 0:
                continue
            data[name] = []
            for item in val:
                date_item = get_properties(item)
                data[name].append(date_item)
        elif val is not None:
            data[name] = val
    return data

class DataContract(object):
    pass

class DataContractList(list):
    def __init__(self, item_cls):
        self.item_cls = item_cls

class VMInfo(DataContract):
    def __init__(self, subscriptionId=None, vmName=None):
        self.subscriptionId = subscriptionId
        self.vmName = vmName

class Cert(DataContract):
    def __init__(self, name=None, thumbprint=None, certificateDataUri=None):
        self.name = name
        self.thumbprint = thumbprint
        self.certificateDataUri = certificateDataUri

class CertList(DataContract):
    def __init__(self):
        self.certificates = DataContractList(Cert)

class ExtensionSettings(DataContract):
    def __init__(self, name=None, sequenceNumber=None, publicSettings=None,
                 privateSettings=None, certificateThumbprint=None):
        self.name = name
        self.sequenceNumber = sequenceNumber
        self.publicSettings = publicSettings
        self.privateSettings = privateSettings
        self.certificateThumbprint = certificateThumbprint

class ExtensionProperties(DataContract):
    def __init__(self):
        self.version = None
        self.upgradePolicy = None
        self.state = None
        self.extensions = DataContractList(ExtensionSettings)

class ExtensionVersionUri(DataContract):
    def __init__(self):
        self.uri = None

class Extension(DataContract):
    def __init__(self, name=None):
        self.name = name
        self.properties = ExtensionProperties()
        self.version_uris = DataContractList(ExtensionVersionUri)

class ExtensionList(DataContract):
    def __init__(self):
        self.extensions = DataContractList(Extension)

class ExtensionPackageUri(DataContract):
    def __init__(self, uri=None):
        self.uri = uri

class ExtensionPackage(DataContract):
    def __init__(self, version = None):
        self.version = version
        self.uris = DataContractList(ExtensionPackageUri)

class ExtensionPackageList(DataContract):
    def __init__(self):
        self.versions = DataContractList(ExtensionPackage)

class InstanceMetadata(DataContract):
    def __init__(self, deploymentName=None, roleName=None, roleInstanceId=None,
                 containerId=None):
        self.deploymentName = deploymentName
        self.roleName = roleName
        self.roleInstanceId = roleInstanceId
        self.containerId = containerId

class VMProperties(DataContract):
    def __init__(self, certificateThumbprint=None):
        #TODO need to confirm the property name
        self.certificateThumbprint = certificateThumbprint

class ProvisionStatus(DataContract):
    def __init__(self, status=None, subStatus=None, description=None):
        self.status = status
        self.subStatus = subStatus
        self.description = description
        self.properties = VMProperties()

class VMAgentStatus(DataContract):
    def __init__(self, agentVersion=None, status=None, message=None):
        self.agentVersion = agentVersion
        self.status = status
        self.message = message

class ExtensionSubStatus(DataContract):
    def __init__(self, name=None, status=None, code=None, message=None):
        self.name = name
        self.status = status
        self.code = code
        self.message = message

class ExtensionStatus(DataContract):
    def __init__(self, name=None, configurationAppliedTime=None, operation=None,
                 status=None, code=None, message=None, seq_no=None):
        self.name = name
        self.configurationAppliedTime = configurationAppliedTime
        self.operation = operation
        self.status = status
        self.code = code
        self.message = message
        self.sequenceNumber = seq_no
        self.substatusList = DataContractList(ExtensionSubStatus)

class ExtensionHandlerStatus(DataContract):
    def __init__(self, handlerName=None, handlerVersion=None, status=None,
                 message=None):
        self.handlerName = handlerName
        self.handlerVersion = handlerVersion
        self.status = status
        self.message = message
        self.extensionStatusList = DataContractList(ExtensionStatus)

class VMStatus(DataContract):
    def __init__(self):
        self.vmAgent = VMAgentStatus()
        self.extensionHandlers = DataContractList(ExtensionHandlerStatus)

class TelemetryEventParam(DataContract):
    def __init__(self, name=None, value=None):
        self.name = name
        self.value = value

class TelemetryEvent(DataContract):
    def __init__(self, eventId=None, providerId=None):
        self.eventId = eventId
        self.providerId = providerId
        self.parameters = DataContractList(TelemetryEventParam)

class TelemetryEventList(DataContract):
    def __init__(self):
        self.events = DataContractList(TelemetryEvent)

class Protocol(DataContract):

    def initialize(self):
        raise NotImplementedError()

    def get_vminfo(self):
        raise NotImplementedError()

    def get_certs(self):
        raise NotImplementedError()

    def get_extensions(self):
        raise NotImplementedError()

    def get_extension_pkgs(self, extension):
        raise NotImplementedError()

    def report_provision_status(self, status):
        raise NotImplementedError()

    def report_status(self, status):
        raise NotImplementedError()

    def report_event(self, event):
        raise NotImplementedError()