def setUp(self):
AgentTestCase.setUp(self)
ext_handler_properties = ExtHandlerProperties()
ext_handler_properties.version = "1.0.0"
ext_handler = ExtHandler(name='Microsoft.CPlat.Core.RunCommandLinux')
ext_handler.properties = ext_handler_properties
protocol = WireProtocol("http://Microsoft.CPlat.Core.RunCommandLinux/foo-bar")
self.pkg = ExtHandlerPackage()
self.pkg.uris = [ ExtHandlerVersionUri(), ExtHandlerVersionUri(), ExtHandlerVersionUri(), ExtHandlerVersionUri(), ExtHandlerVersionUri() ]
self.pkg.uris[0].uri = 'https://zrdfepirv2cy4prdstr00a.blob.core.windows.net/f72653efd9e349ed9842c8b99e4c1712-foobar/Microsoft.CPlat.Core__RunCommandLinux__1.0.0'
self.pkg.uris[1].uri = 'https://zrdfepirv2cy4prdstr01a.blob.core.windows.net/f72653efd9e349ed9842c8b99e4c1712-foobar/Microsoft.CPlat.Core__RunCommandLinux__1.0.0'
self.pkg.uris[2].uri = 'https://zrdfepirv2cy4prdstr02a.blob.core.windows.net/f72653efd9e349ed9842c8b99e4c1712-foobar/Microsoft.CPlat.Core__RunCommandLinux__1.0.0'
self.pkg.uris[3].uri = 'https://zrdfepirv2cy4prdstr03a.blob.core.windows.net/f72653efd9e349ed9842c8b99e4c1712-foobar/Microsoft.CPlat.Core__RunCommandLinux__1.0.0'
self.pkg.uris[4].uri = 'https://zrdfepirv2cy4prdstr04a.blob.core.windows.net/f72653efd9e349ed9842c8b99e4c1712-foobar/Microsoft.CPlat.Core__RunCommandLinux__1.0.0'
self.ext_handler_instance = ExtHandlerInstance(ext_handler=ext_handler, protocol=protocol)
self.ext_handler_instance.pkg = self.pkg
self.extension_dir = os.path.join(self.tmp_dir, "Microsoft.CPlat.Core.RunCommandLinux-1.0.0")
self.mock_get_base_dir = patch("azurelinuxagent.ga.exthandlers.ExtHandlerInstance.get_base_dir", return_value=self.extension_dir)
self.mock_get_base_dir.start()
self.mock_get_log_dir = patch("azurelinuxagent.ga.exthandlers.ExtHandlerInstance.get_log_dir", return_value=self.tmp_dir)
self.mock_get_log_dir.start()
self.agent_dir = self.tmp_dir
self.mock_get_lib_dir = patch("azurelinuxagent.ga.exthandlers.conf.get_lib_dir", return_value=self.agent_dir)
self.mock_get_lib_dir.start()
def setUp(self):
AgentTestCase.setUp(self)
ext_handler_properties = ExtHandlerProperties()
ext_handler_properties.version = "1.0.0"
ext_handler = ExtHandler(name='Microsoft.CPlat.Core.RunCommandLinux')
ext_handler.properties = ext_handler_properties
protocol = WireProtocol("http://Microsoft.CPlat.Core.RunCommandLinux/foo-bar")
self.pkg = ExtHandlerPackage()
self.pkg.uris = [ ExtHandlerVersionUri(), ExtHandlerVersionUri(), ExtHandlerVersionUri(), ExtHandlerVersionUri(), ExtHandlerVersionUri() ]
self.pkg.uris[0].uri = 'https://zrdfepirv2cy4prdstr00a.blob.core.windows.net/f72653efd9e349ed9842c8b99e4c1712-foobar/Microsoft.CPlat.Core__RunCommandLinux__1.0.0'
self.pkg.uris[1].uri = 'https://zrdfepirv2cy4prdstr01a.blob.core.windows.net/f72653efd9e349ed9842c8b99e4c1712-foobar/Microsoft.CPlat.Core__RunCommandLinux__1.0.0'
self.pkg.uris[2].uri = 'https://zrdfepirv2cy4prdstr02a.blob.core.windows.net/f72653efd9e349ed9842c8b99e4c1712-foobar/Microsoft.CPlat.Core__RunCommandLinux__1.0.0'
self.pkg.uris[3].uri = 'https://zrdfepirv2cy4prdstr03a.blob.core.windows.net/f72653efd9e349ed9842c8b99e4c1712-foobar/Microsoft.CPlat.Core__RunCommandLinux__1.0.0'
self.pkg.uris[4].uri = 'https://zrdfepirv2cy4prdstr04a.blob.core.windows.net/f72653efd9e349ed9842c8b99e4c1712-foobar/Microsoft.CPlat.Core__RunCommandLinux__1.0.0'
self.ext_handler_instance = ExtHandlerInstance(ext_handler=ext_handler, protocol=protocol)
self.ext_handler_instance.pkg = self.pkg
self.extension_dir = os.path.join(self.tmp_dir, "Microsoft.CPlat.Core.RunCommandLinux-1.0.0")
self.mock_get_base_dir = patch("azurelinuxagent.ga.exthandlers.ExtHandlerInstance.get_base_dir", return_value=self.extension_dir)
self.mock_get_base_dir.start()
self.mock_get_log_dir = patch("azurelinuxagent.ga.exthandlers.ExtHandlerInstance.get_log_dir", return_value=self.tmp_dir)
self.mock_get_log_dir.start()
self.agent_dir = self.tmp_dir
self.mock_get_lib_dir = patch("azurelinuxagent.ga.exthandlers.conf.get_lib_dir", return_value=self.agent_dir)
self.mock_get_lib_dir.start()
def cleanup_outdated_handlers(self):
handlers = []
pkgs = []
# Build a collection of uninstalled handlers and orphaned packages
# Note:
# -- An orphaned package is one without a corresponding handler
# directory
for item in os.listdir(conf.get_lib_dir()):
path = os.path.join(conf.get_lib_dir(), item)
if version.is_agent_package(path) or version.is_agent_path(path):
continue
if os.path.isdir(path):
if re.match(HANDLER_NAME_PATTERN, item) is None:
continue
try:
eh = ExtHandler()
separator = item.rfind('-')
eh.name = item[0:separator]
eh.properties.version = str(FlexibleVersion(item[separator+1:]))
handler = ExtHandlerInstance(eh, self.protocol)
except Exception:
continue
if handler.get_handler_state() != ExtHandlerState.NotInstalled:
continue
handlers.append(handler)
elif os.path.isfile(path) and \
not os.path.isdir(path[0:-len(HANDLER_PKG_EXT)]):
if not re.match(HANDLER_PKG_PATTERN, item):
continue
pkgs.append(path)
# Then, remove the orphaned packages
for pkg in pkgs:
try:
os.remove(pkg)
logger.verbose("Removed orphaned extension package {0}".format(pkg))
except OSError as e:
logger.warn("Failed to remove orphaned package {0}: {1}".format(pkg, e.strerror))
# Finally, remove the directories and packages of the
# uninstalled handlers
for handler in handlers:
handler.rm_ext_handler_dir()
pkg = os.path.join(conf.get_lib_dir(), handler.get_full_name() + HANDLER_PKG_EXT)
if os.path.isfile(pkg):
try:
os.remove(pkg)
logger.verbose("Removed extension package {0}".format(pkg))
except OSError as e:
logger.warn("Failed to remove extension package {0}: {1}".format(pkg, e.strerror))
def cleanup_outdated_handlers(self):
handlers = []
pkgs = []
# Build a collection of uninstalled handlers and orphaned packages
# Note:
# -- An orphaned package is one without a corresponding handler
# directory
for item in os.listdir(conf.get_lib_dir()):
path = os.path.join(conf.get_lib_dir(), item)
if version.is_agent_package(path) or version.is_agent_path(path):
continue
if os.path.isdir(path):
if re.match(HANDLER_NAME_PATTERN, item) is None:
continue
try:
eh = ExtHandler()
separator = item.rfind('-')
eh.name = item[0:separator]
eh.properties.version = str(FlexibleVersion(item[separator+1:]))
handler = ExtHandlerInstance(eh, self.protocol)
except Exception:
continue
if handler.get_handler_state() != ExtHandlerState.NotInstalled:
continue
handlers.append(handler)
elif os.path.isfile(path) and \
not os.path.isdir(path[0:-len(HANDLER_PKG_EXT)]):
if not re.match(HANDLER_PKG_PATTERN, item):
continue
pkgs.append(path)
# Then, remove the orphaned packages
for pkg in pkgs:
try:
os.remove(pkg)
logger.verbose("Removed orphaned extension package {0}".format(pkg))
except OSError as e:
logger.warn("Failed to remove orphaned package {0}: {1}".format(pkg, e.strerror))
# Finally, remove the directories and packages of the
# uninstalled handlers
for handler in handlers:
handler.rm_ext_handler_dir()
pkg = os.path.join(conf.get_lib_dir(), handler.get_full_name() + HANDLER_PKG_EXT)
if os.path.isfile(pkg):
try:
os.remove(pkg)
logger.verbose("Removed extension package {0}".format(pkg))
except OSError as e:
logger.warn("Failed to remove extension package {0}: {1}".format(pkg, e.strerror))
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 setUp(self):
AgentTestCase.setUp(self)
ext_handler_properties = ExtHandlerProperties()
ext_handler_properties.version = "1.2.3"
ext_handler = ExtHandler(name='foo')
ext_handler.properties = ext_handler_properties
self.ext_handler_instance = ExtHandlerInstance(ext_handler=ext_handler, protocol=None)
self.extension_directory = os.path.join(self.tmp_dir, "extension_directory")
self.mock_get_base_dir = patch.object(self.ext_handler_instance, "get_base_dir", return_value=self.extension_directory)
self.mock_get_base_dir.start()
def _parse_plugin(plugin):
ext_handler = ExtHandler()
ext_handler.name = getattrib(plugin, "name")
ext_handler.properties.version = getattrib(plugin, "version")
ext_handler.properties.state = getattrib(plugin, "state")
location = getattrib(plugin, "location")
failover_location = getattrib(plugin, "failoverlocation")
for uri in [location, failover_location]:
version_uri = ExtHandlerVersionUri()
version_uri.uri = uri
ext_handler.versionUris.append(version_uri)
return ext_handler
def setUp(self):
AgentTestCase.setUp(self)
ext_handler_properties = ExtHandlerProperties()
ext_handler_properties.version = "1.2.3"
ext_handler = ExtHandler(name='foo')
ext_handler.properties = ext_handler_properties
self.ext_handler_instance = ExtHandlerInstance(ext_handler=ext_handler, protocol=None)
self.mock_get_base_dir = patch("azurelinuxagent.ga.exthandlers.ExtHandlerInstance.get_base_dir", lambda *_: self.tmp_dir)
self.mock_get_base_dir.start()
log_dir = os.path.join(self.tmp_dir, "log")
self.mock_get_log_dir = patch("azurelinuxagent.ga.exthandlers.ExtHandlerInstance.get_log_dir", lambda *_: self.log_dir)
self.mock_get_log_dir.start()
def setUp(self):
AgentTestCase.setUp(self)
ext_handler_properties = ExtHandlerProperties()
ext_handler_properties.version = "1.2.3"
self.ext_handler = ExtHandler(name='foo')
self.ext_handler.properties = ext_handler_properties
self.ext_handler_instance = ExtHandlerInstance(
ext_handler=self.ext_handler, protocol=None)
self.mock_get_base_dir = patch(
"azurelinuxagent.ga.exthandlers.ExtHandlerInstance.get_base_dir",
lambda *_: self.tmp_dir)
self.mock_get_base_dir.start()
self.log_dir = os.path.join(self.tmp_dir, "log")
self.mock_get_log_dir = patch(
"azurelinuxagent.ga.exthandlers.ExtHandlerInstance.get_log_dir",
lambda *_: self.log_dir)
self.mock_get_log_dir.start()
self.mock_sleep = patch("time.sleep", lambda *_: mock_sleep(0.01))
self.mock_sleep.start()
self.cgroups_enabled = CGroupConfigurator.get_instance().enabled()
CGroupConfigurator.get_instance().disable()
def setUp(self):
AgentTestCase.setUp(self)
ext_handler_properties = ExtHandlerProperties()
ext_handler_properties.version = "1.2.3"
self.ext_handler = ExtHandler(name='foo')
self.ext_handler.properties = ext_handler_properties
self.ext_handler_instance = ExtHandlerInstance(
ext_handler=self.ext_handler, protocol=None)
self.base_cgroups = os.path.join(self.tmp_dir, "cgroup")
os.mkdir(self.base_cgroups)
os.mkdir(os.path.join(self.base_cgroups, "cpu"))
os.mkdir(os.path.join(self.base_cgroups, "memory"))
self.mock__base_cgroups = patch(
"azurelinuxagent.common.cgroups.BASE_CGROUPS", self.base_cgroups)
self.mock__base_cgroups.start()
self.mock_get_base_dir = patch(
"azurelinuxagent.ga.exthandlers.ExtHandlerInstance.get_base_dir",
lambda *_: self.tmp_dir)
self.mock_get_base_dir.start()
log_dir = os.path.join(self.tmp_dir, "log")
self.mock_get_log_dir = patch(
"azurelinuxagent.ga.exthandlers.ExtHandlerInstance.get_log_dir",
lambda *_: self.log_dir)
self.mock_get_log_dir.start()
def setUp(self):
AgentTestCase.setUp(self)
ext_handler_properties = ExtHandlerProperties()
ext_handler_properties.version = "1.2.3"
ext_handler = ExtHandler(name='foo')
ext_handler.properties = ext_handler_properties
self.ext_handler_instance = ExtHandlerInstance(ext_handler=ext_handler, protocol=None)
pkg_uri = ExtHandlerVersionUri()
pkg_uri.uri = "http://bar/foo__1.2.3"
self.ext_handler_instance.pkg = ExtHandlerPackage(ext_handler_properties.version)
self.ext_handler_instance.pkg.uris.append(pkg_uri)
self.base_dir = self.tmp_dir
self.extension_directory = os.path.join(self.tmp_dir, "extension_directory")
self.mock_get_base_dir = patch.object(self.ext_handler_instance, "get_base_dir", return_value=self.extension_directory)
self.mock_get_base_dir.start()
def get_installed_ext_handler(self):
lastest_version = self.get_installed_version()
if lastest_version is None:
return None
installed_handler = ExtHandler()
set_properties("ExtHandler", installed_handler, get_properties(self.ext_handler))
installed_handler.properties.version = lastest_version
return ExtHandlerInstance(installed_handler, self.protocol)
def assert_extension_sequence_number(
self, # pylint: disable=too-many-arguments
patch_get_largest_seq,
patch_add_event,
goal_state_sequence_number,
disk_sequence_number,
expected_sequence_number):
ext = Extension()
ext.sequenceNumber = goal_state_sequence_number
patch_get_largest_seq.return_value = disk_sequence_number
ext_handler_props = ExtHandlerProperties()
ext_handler_props.version = "1.2.3"
ext_handler = ExtHandler(name='foo')
ext_handler.properties = ext_handler_props
instance = ExtHandlerInstance(ext_handler=ext_handler, protocol=None)
seq, path = instance.get_status_file_path(ext)
try:
gs_seq_int = int(goal_state_sequence_number)
gs_int = True
except ValueError:
gs_int = False
if gs_int and gs_seq_int != disk_sequence_number:
self.assertEqual(1, patch_add_event.call_count)
args, kw_args = patch_add_event.call_args # pylint: disable=unused-variable
self.assertEqual('SequenceNumberMismatch', kw_args['op'])
self.assertEqual(False, kw_args['is_success'])
self.assertEqual(
'Goal state: {0}, disk: {1}'.format(gs_seq_int,
disk_sequence_number),
kw_args['message'])
else:
self.assertEqual(0, patch_add_event.call_count)
self.assertEqual(expected_sequence_number, seq)
if seq > -1:
self.assertTrue(
path.endswith('/foo-1.2.3/status/{0}.status'.format(
expected_sequence_number)))
else:
self.assertIsNone(path)
def setUp(self):
AgentTestCase.setUp(self)
ext_handler_properties = ExtHandlerProperties()
ext_handler_properties.version = "1.2.3"
ext_handler = ExtHandler(name='foo')
ext_handler.properties = ext_handler_properties
self.ext_handler_instance = ExtHandlerInstance(ext_handler=ext_handler,
protocol=None)
self.mock_get_base_dir = patch(
"azurelinuxagent.ga.exthandlers.ExtHandlerInstance.get_base_dir",
lambda *_: self.tmp_dir)
self.mock_get_base_dir.start()
log_dir = os.path.join(self.tmp_dir, "log")
self.mock_get_log_dir = patch(
"azurelinuxagent.ga.exthandlers.ExtHandlerInstance.get_log_dir",
lambda *_: self.log_dir)
self.mock_get_log_dir.start()
def assert_extension_sequence_number(self, patch_get_largest_seq=None,
goal_state_sequence_number=None,
disk_sequence_number=None,
expected_sequence_number=None):
ext = Extension()
ext.sequenceNumber = goal_state_sequence_number
patch_get_largest_seq.return_value = disk_sequence_number
ext_handler_props = ExtHandlerProperties()
ext_handler_props.version = "1.2.3"
ext_handler = ExtHandler(name='foo')
ext_handler.properties = ext_handler_props
instance = ExtHandlerInstance(ext_handler=ext_handler, protocol=None)
seq, path = instance.get_status_file_path(ext)
self.assertEqual(expected_sequence_number, seq)
if seq > -1:
self.assertTrue(path.endswith('/foo-1.2.3/status/{0}.status'.format(expected_sequence_number)))
else:
self.assertIsNone(path)
def _install_handlers(self, start=0, count=1,
handler_state=ExtHandlerState.Installed):
src = os.path.join(data_dir, "ext", "sample_ext-1.3.0.zip")
version = FlexibleVersion("1.3.0")
version += start - version.patch
for i in range(start, start+count):
eh = ExtHandler()
eh.name = "sample_ext"
eh.properties.version = str(version)
handler = ExtHandlerInstance(eh, "unused")
dst = os.path.join(self.lib_dir,
handler.get_full_name()+HANDLER_PKG_EXT)
shutil.copy(src, dst)
if not handler_state is None:
zipfile.ZipFile(dst).extractall(handler.get_base_dir())
handler.set_handler_state(handler_state)
version += 1
def _install_handlers(self, start=0, count=1,
handler_state=ExtHandlerState.Installed):
src = os.path.join(data_dir, "ext", "sample_ext-1.2.0.zip")
version = FlexibleVersion("1.2.0")
version += start - version.patch
for i in range(start, start+count):
eh = ExtHandler()
eh.name = "sample_ext"
eh.properties.version = str(version)
handler = ExtHandlerInstance(eh, "unused")
dst = os.path.join(self.lib_dir,
handler.get_full_name()+HANDLER_PKG_EXT)
shutil.copy(src, dst)
if not handler_state is None:
zipfile.ZipFile(dst).extractall(handler.get_base_dir())
handler.set_handler_state(handler_state)
version += 1
def assert_extension_sequence_number(self,
patch_get_largest_seq,
patch_add_event,
goal_state_sequence_number,
disk_sequence_number,
expected_sequence_number):
ext = Extension()
ext.sequenceNumber = goal_state_sequence_number
patch_get_largest_seq.return_value = disk_sequence_number
ext_handler_props = ExtHandlerProperties()
ext_handler_props.version = "1.2.3"
ext_handler = ExtHandler(name='foo')
ext_handler.properties = ext_handler_props
instance = ExtHandlerInstance(ext_handler=ext_handler, protocol=None)
seq, path = instance.get_status_file_path(ext)
try:
gs_seq_int = int(goal_state_sequence_number)
gs_int = True
except ValueError:
gs_int = False
if gs_int and gs_seq_int != disk_sequence_number:
self.assertEqual(1, patch_add_event.call_count)
args, kw_args = patch_add_event.call_args
self.assertEqual('SequenceNumberMismatch', kw_args['op'])
self.assertEqual(False, kw_args['is_success'])
self.assertEqual('Goal state: {0}, disk: {1}'
.format(gs_seq_int, disk_sequence_number),
kw_args['message'])
else:
self.assertEqual(0, patch_add_event.call_count)
self.assertEqual(expected_sequence_number, seq)
if seq > -1:
self.assertTrue(path.endswith('/foo-1.2.3/status/{0}.status'.format(expected_sequence_number)))
else:
self.assertIsNone(path)
def test_command_extension_log_truncates_correctly(self, mock_log_dir):
log_dir_path = os.path.join(self.tmp_dir, "log_directory")
mock_log_dir.return_value = log_dir_path
ext_handler_props = ExtHandlerProperties()
ext_handler_props.version = "1.2.3"
ext_handler = ExtHandler(name='foo')
ext_handler.properties = ext_handler_props
first_line = "This is the first line!"
second_line = "This is the second line."
old_logfile_contents = "{first_line}\n{second_line}\n".format(first_line=first_line, second_line=second_line)
log_file_path = os.path.join(log_dir_path, "foo", "CommandExecution.log")
fileutil.mkdir(os.path.join(log_dir_path, "foo"), mode=0o755)
with open(log_file_path, "a") as log_file:
log_file.write(old_logfile_contents)
_ = ExtHandlerInstance(ext_handler=ext_handler, protocol=None,
execution_log_max_size=(len(first_line)+len(second_line)//2))
with open(log_file_path) as truncated_log_file:
self.assertEqual(truncated_log_file.read(), "{second_line}\n".format(second_line=second_line))
def setUp(self):
AgentTestCase.setUp(self)
handler_name = "Not.A.Real.Extension"
handler_version = "1.2.3"
self.ext_handler = ExtHandler(handler_name)
self.ext_handler.properties.version = handler_version
self.ext_handler_i = ExtHandlerInstance(self.ext_handler,
"dummy protocol")
self.handler_state = "Enabled"
self.handler_status = ExtHandlerStatus(name=handler_name,
version=handler_version,
status="Ready",
message="Uninteresting message")
return
def setUp(self):
AgentTestCase.setUp(self)
ext_handler_properties = ExtHandlerProperties()
ext_handler_properties.version = "1.2.3"
self.ext_handler = ExtHandler(name='foo')
self.ext_handler.properties = ext_handler_properties
self.ext_handler_instance = ExtHandlerInstance(ext_handler=self.ext_handler, protocol=WireProtocol("1.2.3.4"))
self.mock_get_base_dir = patch("azurelinuxagent.ga.exthandlers.ExtHandlerInstance.get_base_dir", lambda *_: self.tmp_dir)
self.mock_get_base_dir.start()
self.log_dir = os.path.join(self.tmp_dir, "log")
self.mock_get_log_dir = patch("azurelinuxagent.ga.exthandlers.ExtHandlerInstance.get_log_dir", lambda *_: self.log_dir)
self.mock_get_log_dir.start()
self.mock_sleep = patch("time.sleep", lambda *_: mock_sleep(0.01))
self.mock_sleep.start()
def test_telemetry_with_tracked_cgroup(self):
self.assertTrue(i_am_root(), "Test does not run when non-root")
# This test has some timing issues when systemd is managing cgroups, so we force the file system API
# by creating a new instance of the CGroupConfigurator
with patch("azurelinuxagent.common.cgroupapi.CGroupsApi._is_systemd", return_value=False):
cgroup_configurator_instance = CGroupConfigurator._instance
CGroupConfigurator._instance = None
try:
max_num_polls = 30
time_to_wait = 3
extn_name = "foobar-1.0.0"
num_summarization_values = 7
cgs = make_new_cgroup(extn_name)
self.assertEqual(len(cgs), 2)
ext_handler_properties = ExtHandlerProperties()
ext_handler_properties.version = "1.0.0"
self.ext_handler = ExtHandler(name='foobar')
self.ext_handler.properties = ext_handler_properties
self.ext_handler_instance = ExtHandlerInstance(ext_handler=self.ext_handler, protocol=None)
command = self.create_script("keep_cpu_busy_and_consume_memory_for_5_seconds", '''
nohup python -c "import time
for i in range(5):
x = [1, 2, 3, 4, 5] * (i * 1000)
time.sleep({0})
x *= 0
print('Test loop')" &
'''.format(time_to_wait))
self.log_dir = os.path.join(self.tmp_dir, "log")
with patch("azurelinuxagent.ga.exthandlers.ExtHandlerInstance.get_base_dir", lambda *_: self.tmp_dir) as \
patch_get_base_dir:
with patch("azurelinuxagent.ga.exthandlers.ExtHandlerInstance.get_log_dir", lambda *_: self.log_dir) as \
patch_get_log_dir:
self.ext_handler_instance.launch_command(command)
#
# If the test is made to run using the systemd API, then the paths of the cgroups need to be checked differently:
#
# self.assertEquals(len(CGroupsTelemetry._tracked), 2)
# cpu = os.path.join(BASE_CGROUPS, "cpu", "system.slice", r"foobar_1.0.0_.*\.scope")
# self.assertTrue(any(re.match(cpu, tracked.path) for tracked in CGroupsTelemetry._tracked))
# memory = os.path.join(BASE_CGROUPS, "memory", "system.slice", r"foobar_1.0.0_.*\.scope")
# self.assertTrue(any(re.match(memory, tracked.path) for tracked in CGroupsTelemetry._tracked))
#
self.assertTrue(CGroupsTelemetry.is_tracked(os.path.join(
BASE_CGROUPS, "cpu", "walinuxagent.extensions", "foobar_1.0.0")))
self.assertTrue(CGroupsTelemetry.is_tracked(os.path.join(
BASE_CGROUPS, "memory", "walinuxagent.extensions", "foobar_1.0.0")))
for i in range(max_num_polls):
CGroupsTelemetry.poll_all_tracked()
time.sleep(0.5)
collected_metrics = CGroupsTelemetry.report_all_tracked()
self.assertIn("memory", collected_metrics[extn_name])
self.assertIn("cur_mem", collected_metrics[extn_name]["memory"])
self.assertIn("max_mem", collected_metrics[extn_name]["memory"])
self.assertEqual(len(collected_metrics[extn_name]["memory"]["cur_mem"]), num_summarization_values)
self.assertEqual(len(collected_metrics[extn_name]["memory"]["max_mem"]), num_summarization_values)
self.assertIsInstance(collected_metrics[extn_name]["memory"]["cur_mem"][5], str)
self.assertIsInstance(collected_metrics[extn_name]["memory"]["cur_mem"][6], str)
self.assertIsInstance(collected_metrics[extn_name]["memory"]["max_mem"][5], str)
self.assertIsInstance(collected_metrics[extn_name]["memory"]["max_mem"][6], str)
self.assertIn("cpu", collected_metrics[extn_name])
self.assertIn("cur_cpu", collected_metrics[extn_name]["cpu"])
self.assertEqual(len(collected_metrics[extn_name]["cpu"]["cur_cpu"]), num_summarization_values)
self.assertIsInstance(collected_metrics[extn_name]["cpu"]["cur_cpu"][5], str)
self.assertIsInstance(collected_metrics[extn_name]["cpu"]["cur_cpu"][6], str)
for i in range(5):
self.assertGreater(collected_metrics[extn_name]["memory"]["cur_mem"][i], 0)
self.assertGreater(collected_metrics[extn_name]["memory"]["max_mem"][i], 0)
self.assertGreaterEqual(collected_metrics[extn_name]["cpu"]["cur_cpu"][i], 0)
# Equal because CPU could be zero for minimum value.
finally:
CGroupConfigurator._instance = cgroup_configurator_instance
def test_telemetry_with_tracked_cgroup(self, *_):
self.assertTrue(i_am_root(), "Test does not run when non-root")
CGroupConfigurator._instance = None
max_num_polls = 30
time_to_wait = 3
extn_name = "foobar-1.0.0"
num_summarization_values = 7
cgs = make_new_cgroup(extn_name)
self.assertEqual(len(cgs), 2)
ext_handler_properties = ExtHandlerProperties()
ext_handler_properties.version = "1.0.0"
self.ext_handler = ExtHandler(name='foobar')
self.ext_handler.properties = ext_handler_properties
self.ext_handler_instance = ExtHandlerInstance(
ext_handler=self.ext_handler, protocol=None)
command = self.create_script(
"keep_cpu_busy_and_consume_memory_for_5_seconds", '''
nohup python -c "import time
for i in range(5):
x = [1, 2, 3, 4, 5] * (i * 1000)
time.sleep({0})
x *= 0
print('Test loop')" &
'''.format(time_to_wait))
self.log_dir = os.path.join(self.tmp_dir, "log")
with patch("azurelinuxagent.ga.exthandlers.ExtHandlerInstance.get_base_dir", lambda *_: self.tmp_dir) as \
patch_get_base_dir:
with patch("azurelinuxagent.ga.exthandlers.ExtHandlerInstance.get_log_dir", lambda *_: self.log_dir) as \
patch_get_log_dir:
self.ext_handler_instance.launch_command(command)
self.assertTrue(
CGroupsTelemetry.is_tracked(
os.path.join(BASE_CGROUPS, "cpu", "walinuxagent.extensions",
"foobar_1.0.0")))
self.assertTrue(
CGroupsTelemetry.is_tracked(
os.path.join(BASE_CGROUPS, "memory", "walinuxagent.extensions",
"foobar_1.0.0")))
for i in range(max_num_polls):
CGroupsTelemetry.poll_all_tracked()
time.sleep(0.5)
collected_metrics = CGroupsTelemetry.report_all_tracked()
self.assertIn("memory", collected_metrics[extn_name])
self.assertIn("cur_mem", collected_metrics[extn_name]["memory"])
self.assertIn("max_mem", collected_metrics[extn_name]["memory"])
self.assertEqual(
len(collected_metrics[extn_name]["memory"]["cur_mem"]),
num_summarization_values)
self.assertEqual(
len(collected_metrics[extn_name]["memory"]["max_mem"]),
num_summarization_values)
self.assertIsInstance(
collected_metrics[extn_name]["memory"]["cur_mem"][5], str)
self.assertIsInstance(
collected_metrics[extn_name]["memory"]["cur_mem"][6], str)
self.assertIsInstance(
collected_metrics[extn_name]["memory"]["max_mem"][5], str)
self.assertIsInstance(
collected_metrics[extn_name]["memory"]["max_mem"][6], str)
self.assertIn("cpu", collected_metrics[extn_name])
self.assertIn("cur_cpu", collected_metrics[extn_name]["cpu"])
self.assertEqual(len(collected_metrics[extn_name]["cpu"]["cur_cpu"]),
num_summarization_values)
self.assertIsInstance(
collected_metrics[extn_name]["cpu"]["cur_cpu"][5], str)
self.assertIsInstance(
collected_metrics[extn_name]["cpu"]["cur_cpu"][6], str)
for i in range(5):
self.assertGreater(
collected_metrics[extn_name]["memory"]["cur_mem"][i], 0)
self.assertGreater(
collected_metrics[extn_name]["memory"]["max_mem"][i], 0)
self.assertGreaterEqual(
collected_metrics[extn_name]["cpu"]["cur_cpu"][i], 0)