95 lines
3.3 KiB
Python
95 lines
3.3 KiB
Python
#
|
|
# 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.
|
|
|
|
"""
|
|
Common functionalities shared between different DRAC modules.
|
|
"""
|
|
|
|
NS_XMLSchema_Instance = 'http://www.w3.org/2001/XMLSchema-instance'
|
|
|
|
# ReturnValue constants
|
|
RET_SUCCESS = '0'
|
|
RET_ERROR = '2'
|
|
RET_CREATED = '4096'
|
|
|
|
|
|
def find_xml(doc, item, namespace, find_all=False):
|
|
"""Find the first or all elements in an ElementTree object.
|
|
|
|
:param doc: the element tree object.
|
|
:param item: the element name.
|
|
:param namespace: the namespace of the element.
|
|
:param find_all: Boolean value, if True find all elements, if False
|
|
find only the first one. Defaults to False.
|
|
:returns: if find_all is False the element object will be returned
|
|
if found, None if not found. If find_all is True a list of
|
|
element objects will be returned or an empty list if no
|
|
elements were found.
|
|
|
|
"""
|
|
query = ('.//{%(namespace)s}%(item)s' % {'namespace': namespace,
|
|
'item': item})
|
|
if find_all:
|
|
return doc.findall(query)
|
|
return doc.find(query)
|
|
|
|
|
|
def get_wsman_resource_attr(doc, resource_uri, attr_name, nullable=False):
|
|
"""Find an attribute of a resource in an ElementTree object.
|
|
|
|
:param doc: the element tree object.
|
|
:param resource_uri: the resource URI of the namespace.
|
|
:param attr_name: the name of the attribute.
|
|
:param: nullable: enables checking if the element contains an
|
|
XMLSchema-instance namespaced nil attribute that has a
|
|
value of True. In this case, it will return None.
|
|
:returns: value of the attribute
|
|
"""
|
|
item = find_xml(doc, attr_name, resource_uri)
|
|
|
|
if not nullable:
|
|
return item.text.strip()
|
|
else:
|
|
nil_attr = item.attrib.get('{%s}nil' % NS_XMLSchema_Instance)
|
|
if nil_attr != 'true':
|
|
return item.text.strip()
|
|
|
|
|
|
def is_reboot_required(doc, resource_uri):
|
|
"""Check the response document if reboot is requested.
|
|
|
|
RebootRequired attribute in the response indicates whether a config job
|
|
needs to be created and the node needs to be rebooted, so that the
|
|
Lifecycle controller can commit the pending changes.
|
|
|
|
:param doc: the element tree object.
|
|
:param resource_uri: the resource URI of the namespace.
|
|
:returns: a boolean value indicating reboot was requested or not.
|
|
"""
|
|
|
|
reboot_required = find_xml(doc, 'RebootRequired', resource_uri)
|
|
return reboot_required.text.lower() == 'yes'
|
|
|
|
|
|
def validate_integer_value(value, attr_name, error_msgs):
|
|
"""Validate integer value"""
|
|
|
|
if value is None:
|
|
error_msgs.append("'%s' is not supplied" % attr_name)
|
|
return
|
|
|
|
try:
|
|
int(value)
|
|
except ValueError:
|
|
error_msgs.append("'%s' is not an integer value" % attr_name)
|