def _parse_extensions_config(self, xml_text):
xml_doc = parse_doc(xml_text)
ga_families_list = find(xml_doc, "GAFamilies")
ga_families = findall(ga_families_list, "GAFamily")
for ga_family in ga_families:
family = findtext(ga_family, "Name")
uris_list = find(ga_family, "Uris")
uris = findall(uris_list, "Uri")
manifest = VMAgentManifest()
manifest.family = family
for uri in uris:
manifest_uri = VMAgentManifestUri(uri=gettext(uri))
manifest.versionsManifestUris.append(manifest_uri)
self.vmagent_manifests.vmAgentManifests.append(manifest)
self.__parse_plugins_and_settings_and_populate_ext_handlers(xml_doc)
required_features_list = find(xml_doc, "RequiredFeatures")
if required_features_list is not None:
self._parse_required_features(required_features_list)
self._status_upload_blob = findtext(xml_doc, "StatusUploadBlob")
self.artifacts_profile_blob = findtext(xml_doc,
"InVMArtifactsProfileBlob")
status_upload_node = find(xml_doc, "StatusUploadBlob")
self._status_upload_blob_type = getattrib(status_upload_node,
"statusBlobType")
logger.verbose("Extension config shows status blob type as [{0}]",
self._status_upload_blob_type)
self.in_vm_gs_metadata.parse_node(
find(xml_doc, "InVMGoalStateMetaData"))
def parse(self, xml_text):
"""
Write configuration to file ExtensionsConfig.xml.
"""
xml_doc = parse_doc(xml_text)
ga_families_list = find(xml_doc, "GAFamilies")
ga_families = findall(ga_families_list, "GAFamily")
for ga_family in ga_families:
family = findtext(ga_family, "Name")
uris_list = find(ga_family, "Uris")
uris = findall(uris_list, "Uri")
manifest = VMAgentManifest()
manifest.family = family
for uri in uris:
manifestUri = VMAgentManifestUri(uri=gettext(uri))
manifest.versionsManifestUris.append(manifestUri)
self.vmagent_manifests.vmAgentManifests.append(manifest)
plugins_list = find(xml_doc, "Plugins")
plugins = findall(plugins_list, "Plugin")
plugin_settings_list = find(xml_doc, "PluginSettings")
plugin_settings = findall(plugin_settings_list, "Plugin")
for plugin in plugins:
ext_handler = self.parse_plugin(plugin)
self.ext_handlers.extHandlers.append(ext_handler)
self.parse_plugin_settings(ext_handler, plugin_settings)
self.status_upload_blob = findtext(xml_doc, "StatusUploadBlob")
def parse(self, xml_text):
"""
Write configuration to file ExtensionsConfig.xml.
"""
xml_doc = parse_doc(xml_text)
ga_families_list = find(xml_doc, "GAFamilies")
ga_families = findall(ga_families_list, "GAFamily")
for ga_family in ga_families:
family = findtext(ga_family, "Name")
uris_list = find(ga_family, "Uris")
uris = findall(uris_list, "Uri")
manifest = VMAgentManifest()
manifest.family = family
for uri in uris:
manifestUri = VMAgentManifestUri(uri=gettext(uri))
manifest.versionsManifestUris.append(manifestUri)
self.vmagent_manifests.vmAgentManifests.append(manifest)
plugins_list = find(xml_doc, "Plugins")
plugins = findall(plugins_list, "Plugin")
plugin_settings_list = find(xml_doc, "PluginSettings")
plugin_settings = findall(plugin_settings_list, "Plugin")
for plugin in plugins:
ext_handler = self.parse_plugin(plugin)
self.ext_handlers.extHandlers.append(ext_handler)
self.parse_plugin_settings(ext_handler, plugin_settings)
self.status_upload_blob = findtext(xml_doc, "StatusUploadBlob")
def get_no_of_extensions_in_config(self):
if self.ext_conf is None:
return 0
ext_config_doc = parse_doc(self.ext_conf)
plugin_settings = find(ext_config_doc, "PluginSettings")
return len(findall(plugin_settings, "ExtensionRuntimeSettings")) + len(
findall(plugin_settings, "RuntimeSettings"))
def parse(self, xml_text):
"""
Parse xml tree, retreiving user and ssh key information.
Return self.
"""
wans = WA_NAME_SPACE
ovfns = OVF_NAME_SPACE
xml_doc = parse_doc(xml_text)
environment = find(xml_doc, "Environment", namespace=ovfns)
_validate_ovf(environment, "Environment not found")
section = find(environment, "ProvisioningSection", namespace=wans)
_validate_ovf(section, "ProvisioningSection not found")
version = findtext(environment, "Version", namespace=wans)
_validate_ovf(version, "Version not found")
if version > OVF_VERSION:
logger.warn("Newer provisioning configuration detected. "
"Please consider updating waagent")
conf_set = find(section,
"LinuxProvisioningConfigurationSet",
namespace=wans)
_validate_ovf(conf_set, "LinuxProvisioningConfigurationSet not found")
self.hostname = findtext(conf_set, "HostName", namespace=wans)
_validate_ovf(self.hostname, "HostName not found")
self.username = findtext(conf_set, "UserName", namespace=wans)
_validate_ovf(self.username, "UserName not found")
self.user_password = findtext(conf_set, "UserPassword", namespace=wans)
self.customdata = findtext(conf_set, "CustomData", namespace=wans)
auth_option = findtext(conf_set,
"DisableSshPasswordAuthentication",
namespace=wans)
if auth_option is not None and auth_option.lower() == "true":
self.disable_ssh_password_auth = True
else:
self.disable_ssh_password_auth = False
public_keys = findall(conf_set, "PublicKey", namespace=wans)
for public_key in public_keys:
path = findtext(public_key, "Path", namespace=wans)
fingerprint = findtext(public_key, "Fingerprint", namespace=wans)
value = findtext(public_key, "Value", namespace=wans)
self.ssh_pubkeys.append((path, fingerprint, value))
keypairs = findall(conf_set, "KeyPair", namespace=wans)
for keypair in keypairs:
path = findtext(keypair, "Path", namespace=wans)
fingerprint = findtext(keypair, "Fingerprint", namespace=wans)
self.ssh_keypairs.append((path, fingerprint))
def parse(self, xml_text):
"""
Parse xml tree, retreiving user and ssh key information.
Return self.
"""
wans = WA_NAME_SPACE
ovfns = OVF_NAME_SPACE
xml_doc = parse_doc(xml_text)
environment = find(xml_doc, "Environment", namespace=ovfns)
_validate_ovf(environment, "Environment not found")
section = find(environment, "ProvisioningSection", namespace=wans)
_validate_ovf(section, "ProvisioningSection not found")
version = findtext(environment, "Version", namespace=wans)
_validate_ovf(version, "Version not found")
if version > OVF_VERSION:
logger.warn("Newer provisioning configuration detected. "
"Please consider updating waagent")
conf_set = find(section, "LinuxProvisioningConfigurationSet",
namespace=wans)
_validate_ovf(conf_set, "LinuxProvisioningConfigurationSet not found")
self.hostname = findtext(conf_set, "HostName", namespace=wans)
_validate_ovf(self.hostname, "HostName not found")
self.username = findtext(conf_set, "UserName", namespace=wans)
_validate_ovf(self.username, "UserName not found")
self.user_password = findtext(conf_set, "UserPassword", namespace=wans)
self.customdata = findtext(conf_set, "CustomData", namespace=wans)
auth_option = findtext(conf_set, "DisableSshPasswordAuthentication",
namespace=wans)
if auth_option is not None and auth_option.lower() == "true":
self.disable_ssh_password_auth = True
else:
self.disable_ssh_password_auth = False
public_keys = findall(conf_set, "PublicKey", namespace=wans)
for public_key in public_keys:
path = findtext(public_key, "Path", namespace=wans)
fingerprint = findtext(public_key, "Fingerprint", namespace=wans)
value = findtext(public_key, "Value", namespace=wans)
self.ssh_pubkeys.append((path, fingerprint, value))
keypairs = findall(conf_set, "KeyPair", namespace=wans)
for keypair in keypairs:
path = findtext(keypair, "Path", namespace=wans)
fingerprint = findtext(keypair, "Fingerprint", namespace=wans)
self.ssh_keypairs.append((path, fingerprint))
def parse(self, xml_text):
xml_doc = parse_doc(xml_text)
self._handle_packages(findall(find(xml_doc,
"Plugins"),
"Plugin"),
False)
self._handle_packages(findall(find(xml_doc,
"InternalPlugins"),
"Plugin"),
True)
def parse(self, xml_text):
xml_doc = parse_doc(xml_text)
self._handle_packages(findall(find(xml_doc,
"Plugins"),
"Plugin"),
False)
self._handle_packages(findall(find(xml_doc,
"InternalPlugins"),
"Plugin"),
True)
def __parse_plugins_and_settings_and_populate_ext_handlers(self, xml_doc):
"""
Sample ExtensionConfig Plugin and PluginSettings:
<Plugins>
<Plugin name="Microsoft.CPlat.Core.NullSeqB" version="2.0.1" location="https://zrdfepirv2cbn04prdstr01a.blob.core.windows.net/f72653efd9e349ed9842c8b99e4c1712/Microsoft.CPlat.Core_NullSeqB_useast2euap_manifest.xml" state="enabled" autoUpgrade="false" failoverlocation="https://zrdfepirv2cbz06prdstr01a.blob.core.windows.net/f72653efd9e349ed9842c8b99e4c1712/Microsoft.CPlat.Core_NullSeqB_useast2euap_manifest.xml" runAsStartupTask="false" isJson="true" useExactVersion="true" />
<Plugin name="Microsoft.CPlat.Core.NullSeqA" version="2.0.1" location="https://zrdfepirv2cbn04prdstr01a.blob.core.windows.net/f72653efd9e349ed9842c8b99e4c1712/Microsoft.CPlat.Core_NullSeqA_useast2euap_manifest.xml" state="enabled" autoUpgrade="false" failoverlocation="https://zrdfepirv2cbn06prdstr01a.blob.core.windows.net/f72653efd9e349ed9842c8b99e4c1712/Microsoft.CPlat.Core_NullSeqA_useast2euap_manifest.xml" runAsStartupTask="false" isJson="true" useExactVersion="true" />
</Plugins>
<PluginSettings>
<Plugin name="Microsoft.CPlat.Core.NullSeqA" version="2.0.1">
<DependsOn dependencyLevel="1">
<DependsOnExtension handler="Microsoft.CPlat.Core.NullSeqB" />
</DependsOn>
<RuntimeSettings seqNo="0">{
"runtimeSettings": [
{
"handlerSettings": {
"publicSettings": {"01_add_extensions_with_dependency":"ff2a3da6-8e12-4ab6-a4ca-4e3a473ab385"}
}
}
]
}
</RuntimeSettings>
</Plugin>
<Plugin name="Microsoft.CPlat.Core.NullSeqB" version="2.0.1">
<RuntimeSettings seqNo="0">{
"runtimeSettings": [
{
"handlerSettings": {
"publicSettings": {"01_add_extensions_with_dependency":"2e837740-cf7e-4528-b3a4-241002618f05"}
}
}
]
}
</RuntimeSettings>
</Plugin>
</PluginSettings>
"""
plugins_list = find(xml_doc, "Plugins")
plugins = findall(plugins_list, "Plugin")
plugin_settings_list = find(xml_doc, "PluginSettings")
plugin_settings = findall(plugin_settings_list, "Plugin")
for plugin in plugins:
ext_handler = ExtHandler()
try:
_ExtensionsGoalStateFromExtensionsConfig._parse_plugin(
ext_handler, plugin)
_ExtensionsGoalStateFromExtensionsConfig._parse_plugin_settings(
ext_handler, plugin_settings)
except ExtensionsConfigError as error:
ext_handler.invalid_setting_reason = ustr(error)
self.ext_handlers.extHandlers.append(ext_handler)
def __parse_runtime_settings(plugin_settings_node, runtime_settings_node, handler_name, ext_handler):
"""
Sample Plugin in PluginSettings containing DependsOn and RuntimeSettings (single settings per extension) -
<Plugin name="Microsoft.Compute.VMAccessAgent" version="2.4.7">
<DependsOn dependencyLevel="2">
<DependsOnExtension extension="firstRunCommand" handler="Microsoft.CPlat.Core.RunCommandHandlerWindows" />
<DependsOnExtension handler="Microsoft.Compute.CustomScriptExtension" />
</DependsOn>
<RuntimeSettings seqNo="1">{
"runtimeSettings": [
{
"handlerSettings": {
"protectedSettingsCertThumbprint": "<Redacted>",
"protectedSettings": "<Redacted>",
"publicSettings": {"UserName":"******"}
}
}
]
}
</RuntimeSettings>
</Plugin>
"""
depends_on_nodes = findall(plugin_settings_node, "DependsOn")
if len(depends_on_nodes) > 1:
msg = "Extension Handler can only have a single dependsOn node for Single config extensions. Found: {0}".format(
len(depends_on_nodes))
raise ExtensionConfigError(msg)
depends_on_node = depends_on_nodes[0] if depends_on_nodes else None
depends_on_level = ExtensionsConfig.__get_dependency_level_from_node(depends_on_node, handler_name)
ExtensionsConfig.__parse_and_add_extension_settings(runtime_settings_node, handler_name, ext_handler,
depends_on_level)
def __init__(self, xml_text):
self.xml_text = xml_text
self.ext_handlers = ExtHandlerList()
self.vmagent_manifests = VMAgentManifestList()
self.status_upload_blob = None
self.status_upload_blob_type = None
self.artifacts_profile_blob = None
if xml_text is None:
return
xml_doc = parse_doc(self.xml_text)
ga_families_list = find(xml_doc, "GAFamilies")
ga_families = findall(ga_families_list, "GAFamily")
for ga_family in ga_families:
family = findtext(ga_family, "Name")
uris_list = find(ga_family, "Uris")
uris = findall(uris_list, "Uri")
manifest = VMAgentManifest()
manifest.family = family
for uri in uris:
manifestUri = VMAgentManifestUri(uri=gettext(uri))
manifest.versionsManifestUris.append(manifestUri)
self.vmagent_manifests.vmAgentManifests.append(manifest)
plugins_list = find(xml_doc, "Plugins")
plugins = findall(plugins_list, "Plugin")
plugin_settings_list = find(xml_doc, "PluginSettings")
plugin_settings = findall(plugin_settings_list, "Plugin")
for plugin in plugins:
ext_handler = ExtensionsConfig._parse_plugin(plugin)
self.ext_handlers.extHandlers.append(ext_handler)
ExtensionsConfig._parse_plugin_settings(ext_handler,
plugin_settings)
self.status_upload_blob = findtext(xml_doc, "StatusUploadBlob")
self.artifacts_profile_blob = findtext(xml_doc,
"InVMArtifactsProfileBlob")
status_upload_node = find(xml_doc, "StatusUploadBlob")
self.status_upload_blob_type = getattrib(status_upload_node,
"statusBlobType")
logger.verbose("Extension config shows status blob type as [{0}]",
self.status_upload_blob_type)
def _parse_plugin(ext_handler, plugin):
"""
Sample config:
<Plugins>
<Plugin name="Microsoft.CPlat.Core.NullSeqB" version="2.0.1" location="https://zrdfepirv2cbn04prdstr01a.blob.core.windows.net/f72653efd9e349ed9842c8b99e4c1712/Microsoft.CPlat.Core_NullSeqB_useast2euap_manifest.xml" state="enabled" autoUpgrade="false" failoverlocation="https://zrdfepirv2cbz06prdstr01a.blob.core.windows.net/f72653efd9e349ed9842c8b99e4c1712/Microsoft.CPlat.Core_NullSeqB_useast2euap_manifest.xml" runAsStartupTask="false" isJson="true" useExactVersion="true"><Plugin name="Microsoft.Azure.Extensions.CustomScript" version="1.0" location="https://rdfecurrentuswestcache.blob.core.test-cint.azure-test.net/0e53c53ef0be4178bacb0a1fecf12a74/Microsoft.Azure.Extensions_CustomScript_usstagesc_manifest.xml" state="enabled" autoUpgrade="false" failoverlocation="https://rdfecurrentuswestcache2.blob.core.test-cint.azure-test.net/0e53c53ef0be4178bacb0a1fecf12a74/Microsoft.Azure.Extensions_CustomScript_usstagesc_manifest.xml" runAsStartupTask="false" isJson="true" useExactVersion="true">
<additionalLocations>
<additionalLocation>https://rdfecurrentuswestcache3.blob.core.test-cint.azure-test.net/0e53c53ef0be4178bacb0a1fecf12a74/Microsoft.Azure.Extensions_CustomScript_usstagesc_manifest.xml</additionalLocation>
<additionalLocation>https://rdfecurrentuswestcache4.blob.core.test-cint.azure-test.net/0e53c53ef0be4178bacb0a1fecf12a74/Microsoft.Azure.Extensions_CustomScript_usstagesc_manifest.xml</additionalLocation>
</additionalLocations>
</Plugin>
<Plugin name="Microsoft.CPlat.Core.NullSeqA" version="2.0.1" location="https://zrdfepirv2cbn04prdstr01a.blob.core.windows.net/f72653efd9e349ed9842c8b99e4c1712/Microsoft.CPlat.Core_NullSeqA_useast2euap_manifest.xml" state="enabled" autoUpgrade="false" failoverlocation="https://zrdfepirv2cbn06prdstr01a.blob.core.windows.net/f72653efd9e349ed9842c8b99e4c1712/Microsoft.CPlat.Core_NullSeqA_useast2euap_manifest.xml" runAsStartupTask="false" isJson="true" useExactVersion="true" />
</Plugins>
Note that the `additionalLocations` subnode is populated with links
generated by PIR for resiliency. In regions with this feature enabled,
CRP will provide any extra links in the format above. If no extra links
are provided, the subnode will not exist.
"""
def _log_error_if_none(attr_name, value):
# Plugin Name and Version are very essential fields, without them we wont be able to even report back to CRP
# about that handler. For those cases we need to fail the GoalState completely but currently we dont support
# reporting status at a GoalState level (we only report at a handler level).
# Once that functionality is added to the GA, we would raise here rather than just report error in our logs.
if value in (None, ""):
add_event(AGENT_NAME, op=WALAEventOperation.InvalidExtensionConfig,
message="{0} is None for ExtensionConfig, logging error".format(attr_name),
log_event=True, is_success=False)
return value
ext_handler.name = _log_error_if_none("Extensions.Plugins.Plugin.name", getattrib(plugin, "name"))
ext_handler.properties.version = _log_error_if_none("Extensions.Plugins.Plugin.version",
getattrib(plugin, "version"))
ext_handler.properties.state = getattrib(plugin, "state")
if ext_handler.properties.state in (None, ""):
raise ExtensionConfigError("Received empty Extensions.Plugins.Plugin.state, failing Handler")
def getattrib_wrapped_in_list(node, attr_name):
attr = getattrib(node, attr_name)
return [attr] if attr not in (None, "") else []
location = getattrib_wrapped_in_list(plugin, "location")
failover_location = getattrib_wrapped_in_list(plugin, "failoverlocation")
locations = location + failover_location
additional_location_node = find(plugin, "additionalLocations")
if additional_location_node is not None:
nodes_list = findall(additional_location_node, "additionalLocation")
locations += [gettext(node) for node in nodes_list]
for uri in locations:
version_uri = ExtHandlerVersionUri()
version_uri.uri = uri
ext_handler.versionUris.append(version_uri)
def parse_xml_event(data_str):
try:
xml_doc = parse_doc(data_str)
event_id = getattrib(find(xml_doc, "Event"), 'id')
provider_id = getattrib(find(xml_doc, "Provider"), 'id')
event = TelemetryEvent(event_id, provider_id)
param_nodes = findall(xml_doc, 'Param')
for param_node in param_nodes:
event.parameters.append(parse_xml_param(param_node))
return event
except Exception as e:
raise ValueError(ustr(e))
def parse(self, xml_text):
xml_doc = parse_doc(xml_text)
preferred = find(xml_doc, "Preferred")
self.preferred = findtext(preferred, "Version")
logger.info("Fabric preferred wire protocol version:{0}", self.preferred)
self.supported = []
supported = find(xml_doc, "Supported")
supported_version = findall(supported, "Version")
for node in supported_version:
version = gettext(node)
logger.verbose("Fabric supported wire protocol version:{0}", version)
self.supported.append(version)
def parse(self, xml_text):
xml_doc = parse_doc(xml_text)
preferred = find(xml_doc, "Preferred")
self.preferred = findtext(preferred, "Version")
logger.info("Fabric preferred wire protocol version:{0}",
self.preferred)
self.supported = []
supported = find(xml_doc, "Supported")
supported_version = findall(supported, "Version")
for node in supported_version:
version = gettext(node)
logger.verbose("Fabric supported wire protocol version:{0}",
version)
self.supported.append(version)
def __init__(self, xml_text):
self.xml_text = xml_text
self.version = None
self.incarnation = None
self.user_list = RemoteAccessUsersList()
if self.xml_text is None or len(self.xml_text) == 0:
return
xml_doc = parse_doc(self.xml_text)
self.version = findtext(xml_doc, "Version")
self.incarnation = findtext(xml_doc, "Incarnation")
user_collection = find(xml_doc, "Users")
users = findall(user_collection, "User")
for user in users:
remote_access_user = RemoteAccess._parse_user(user)
self.user_list.users.append(remote_access_user)
def _handle_packages(self, packages, isinternal):
for package in packages:
version = findtext(package, "Version")
disallow_major_upgrade = findtext(package, "DisallowMajorVersionUpgrade")
if disallow_major_upgrade is None:
disallow_major_upgrade = ''
disallow_major_upgrade = disallow_major_upgrade.lower() == "true"
uris = find(package, "Uris")
uri_list = findall(uris, "Uri")
uri_list = [gettext(x) for x in uri_list]
pkg = ExtHandlerPackage()
pkg.version = version
pkg.disallow_major_upgrade = disallow_major_upgrade
for uri in uri_list:
pkg_uri = ExtHandlerVersionUri()
pkg_uri.uri = uri
pkg.uris.append(pkg_uri)
pkg.isinternal = isinternal
self.pkg_list.versions.append(pkg)
def _handle_packages(self, packages, isinternal):
for package in packages:
version = findtext(package, "Version")
disallow_major_upgrade = findtext(package,
"DisallowMajorVersionUpgrade")
if disallow_major_upgrade is None:
disallow_major_upgrade = ''
disallow_major_upgrade = disallow_major_upgrade.lower() == "true"
uris = find(package, "Uris")
uri_list = findall(uris, "Uri")
uri_list = [gettext(x) for x in uri_list]
pkg = ExtHandlerPackage()
pkg.version = version
pkg.disallow_major_upgrade = disallow_major_upgrade
for uri in uri_list:
pkg_uri = ExtHandlerVersionUri()
pkg_uri.uri = uri
pkg.uris.append(pkg_uri)
pkg.isinternal = isinternal
self.pkg_list.versions.append(pkg)
def __parse_extension_runtime_settings(plugin_settings_node, extension_runtime_settings_nodes, ext_handler):
"""
Sample PluginSettings containing DependsOn and ExtensionRuntimeSettings -
<Plugin name="Microsoft.CPlat.Core.RunCommandHandlerWindows" version="2.0.2">
<DependsOn dependencyLevel="3" name="secondRunCommand">
<DependsOnExtension extension="firstRunCommand" handler="Microsoft.CPlat.Core.RunCommandHandlerWindows" />
<DependsOnExtension handler="Microsoft.Compute.CustomScriptExtension" />
<DependsOnExtension handler="Microsoft.Compute.VMAccessAgent" />
</DependsOn>
<DependsOn dependencyLevel="4" name="thirdRunCommand">
<DependsOnExtension extension="firstRunCommand" handler="Microsoft.CPlat.Core.RunCommandHandlerWindows" />
<DependsOnExtension extension="secondRunCommand" handler="Microsoft.CPlat.Core.RunCommandHandlerWindows" />
<DependsOnExtension handler="Microsoft.Compute.CustomScriptExtension" />
<DependsOnExtension handler="Microsoft.Compute.VMAccessAgent" />
</DependsOn>
<ExtensionRuntimeSettings seqNo="2" name="firstRunCommand" state="enabled">
{
"runtimeSettings": [
{
"handlerSettings": {
"publicSettings": {"source":{"script":"Write-Host First: Hello World 1234!"}}
}
}
]
}
</ExtensionRuntimeSettings>
<ExtensionRuntimeSettings seqNo="2" name="secondRunCommand" state="enabled">
{
"runtimeSettings": [
{
"handlerSettings": {
"publicSettings": {"source":{"script":"Write-Host First: Hello World 1234!"}}
}
}
]
}
</ExtensionRuntimeSettings>
<ExtensionRuntimeSettings seqNo="1" name="thirdRunCommand" state="enabled">
{
"runtimeSettings": [
{
"handlerSettings": {
"publicSettings": {"source":{"script":"Write-Host Third: Hello World 3!"}}
}
}
]
}
</ExtensionRuntimeSettings>
</Plugin>
"""
# Parse and cache the Dependencies for each extension first
dependency_levels = defaultdict(int)
for depends_on_node in findall(plugin_settings_node, "DependsOn"):
extension_name = getattrib(depends_on_node, "name")
if extension_name in (None, ""):
raise ExtensionConfigError("No Name not specified for DependsOn object in ExtensionRuntimeSettings for MultiConfig!")
dependency_level = ExtensionsConfig.__get_dependency_level_from_node(depends_on_node, extension_name)
dependency_levels[extension_name] = dependency_level
ext_handler.supports_multi_config = True
for extension_runtime_setting_node in extension_runtime_settings_nodes:
# Name and State will only be set for ExtensionRuntimeSettings for Multi-Config
extension_name = getattrib(extension_runtime_setting_node, "name")
if extension_name in (None, ""):
raise ExtensionConfigError("Extension Name not specified for ExtensionRuntimeSettings for MultiConfig!")
# State can either be `ExtensionState.Enabled` (default) or `ExtensionState.Disabled`
state = getattrib(extension_runtime_setting_node, "state")
state = ustr(state.lower()) if state not in (None, "") else ExtensionState.Enabled
ExtensionsConfig.__parse_and_add_extension_settings(extension_runtime_setting_node, extension_name,
ext_handler, dependency_levels[extension_name],
state=state)
def get_no_of_plugins_in_extension_config(self):
if self.ext_conf is None:
return 0
ext_config_doc = parse_doc(self.ext_conf)
plugins_list = find(ext_config_doc, "Plugins")
return len(findall(plugins_list, "Plugin"))
def _parse_plugin_settings(ext_handler, plugin_settings):
"""
Sample config:
<PluginSettings>
<Plugin name="Microsoft.CPlat.Core.NullSeqA" version="2.0.1">
<DependsOn dependencyLevel="1">
<DependsOnExtension handler="Microsoft.CPlat.Core.NullSeqB" />
</DependsOn>
<RuntimeSettings seqNo="0">{
"runtimeSettings": [
{
"handlerSettings": {
"publicSettings": {"01_add_extensions_with_dependency":"ff2a3da6-8e12-4ab6-a4ca-4e3a473ab385"}
}
}
]
}
</RuntimeSettings>
</Plugin>
<Plugin name="Microsoft.CPlat.Core.RunCommandHandlerWindows" version="2.0.2">
<ExtensionRuntimeSettings seqNo="4" name="firstRunCommand" state="enabled">{
"runtimeSettings": [
{
"handlerSettings": {
"publicSettings": {"source":{"script":"Write-Host First: Hello World TestTry2!"},"parameters":[{"name":"extensionName","value":"firstRunCommand"}],"timeoutInSeconds":120}
}
}
]
}
</ExtensionRuntimeSettings>
</Plugin>
</PluginSettings>
"""
if plugin_settings is None:
return
handler_name = ext_handler.name
version = ext_handler.properties.version
def to_lower(str_to_change): return str_to_change.lower() if str_to_change is not None else None
ext_handler_plugin_settings = [x for x in plugin_settings if to_lower(getattrib(x, "name")) == to_lower(handler_name)]
if not ext_handler_plugin_settings:
return
settings = [x for x in ext_handler_plugin_settings if getattrib(x, "version") == version]
if len(settings) != len(ext_handler_plugin_settings):
msg = "ExtHandler PluginSettings Version Mismatch! Expected PluginSettings version: {0} for Handler: {1} but found versions: ({2})".format(
version, handler_name, ', '.join(set([getattrib(x, "version") for x in ext_handler_plugin_settings])))
add_event(AGENT_NAME, op=WALAEventOperation.PluginSettingsVersionMismatch, message=msg, log_event=True,
is_success=False)
raise ExtensionConfigError(msg)
if len(settings) > 1:
msg = "Multiple plugin settings found for the same handler: {0} and version: {1} (Expected: 1; Available: {2})".format(
handler_name, version, len(settings))
raise ExtensionConfigError(msg)
plugin_settings_node = settings[0]
runtime_settings_nodes = findall(plugin_settings_node, "RuntimeSettings")
extension_runtime_settings_nodes = findall(plugin_settings_node, "ExtensionRuntimeSettings")
if any(runtime_settings_nodes) and any(extension_runtime_settings_nodes):
# There can only be a single RuntimeSettings node or multiple ExtensionRuntimeSettings nodes per Plugin
msg = "Both RuntimeSettings and ExtensionRuntimeSettings found for the same handler: {0} and version: {1}".format(
handler_name, version)
raise ExtensionConfigError(msg)
if runtime_settings_nodes:
if len(runtime_settings_nodes) > 1:
msg = "Multiple RuntimeSettings found for the same handler: {0} and version: {1} (Expected: 1; Available: {2})".format(
handler_name, version, len(runtime_settings_nodes))
raise ExtensionConfigError(msg)
# Only Runtime settings available, parse that
ExtensionsConfig.__parse_runtime_settings(plugin_settings_node, runtime_settings_nodes[0], handler_name,
ext_handler)
elif extension_runtime_settings_nodes:
# Parse the ExtensionRuntime settings for the given extension
ExtensionsConfig.__parse_extension_runtime_settings(plugin_settings_node, extension_runtime_settings_nodes,
ext_handler)
def _parse_required_features(self, required_features_list):
for required_feature in findall(required_features_list, "RequiredFeature"):
feature_name = findtext(required_feature, "Name")
feature_value = findtext(required_feature, "Value")
self.required_features.append(RequiredFeature(name=feature_name, value=feature_value))
def _parse_required_features(self, required_features_list):
for required_feature in findall(required_features_list,
"RequiredFeature"):
feature_name = findtext(required_feature, "Name")
# per the documentation, RequiredFeatures also have a "Value" attribute but currently it is not being populated
self._required_features.append(feature_name)