def test_annotations(self):
"""
L{ComputerInfo} sends extra meta data from the annotations.d directory
if it's present.
Each file name is used as a key in the meta-data dict and the file's
contents are used as values.
This allows system administrators to add extra per-computer information
into Landscape which makes sense to them.
"""
annotations_dir = self.monitor.config.annotations_path
os.mkdir(annotations_dir)
create_text_file(os.path.join(annotations_dir, "annotation1"),
"value1")
create_text_file(os.path.join(annotations_dir, "annotation2"),
"value2")
self.mstore.set_accepted_types(["computer-info"])
plugin = ComputerInfo()
plugin._cloud_meta_data = {}
self.monitor.add(plugin)
plugin.exchange()
messages = self.mstore.get_pending_messages()
self.assertEqual(1, len(messages))
meta_data = messages[0]["annotations"]
self.assertEqual(2, len(meta_data))
self.assertEqual("value1", meta_data["annotation1"])
self.assertEqual("value2", meta_data["annotation2"])
def test_get_fqdn(self):
self.mstore.set_accepted_types(["computer-info"])
plugin = ComputerInfo(get_fqdn=get_fqdn, fetch_async=self.fetch_func)
self.monitor.add(plugin)
plugin.exchange()
messages = self.mstore.get_pending_messages()
self.assertEqual(len(messages), 1)
self.assertEqual(messages[0]["type"], "computer-info")
self.assertEqual(messages[0]["hostname"], "ooga.local")
def test_get_real_total_memory(self):
self.mstore.set_accepted_types(["computer-info"])
self.makeFile(self.sample_memory_info)
plugin = ComputerInfo(fetch_async=self.fetch_func)
self.monitor.add(plugin)
plugin.exchange()
message = self.mstore.get_pending_messages()[0]
self.assertEqual(message["type"], "computer-info")
self.assertTrue(isinstance(message["total-memory"], int))
self.assertTrue(isinstance(message["total-swap"], int))
def test_get_real_hostname(self):
self.mstore.set_accepted_types(["computer-info"])
plugin = ComputerInfo(fetch_async=self.fetch_func)
self.monitor.add(plugin)
plugin.exchange()
messages = self.mstore.get_pending_messages()
self.assertEqual(len(messages), 1)
self.assertEqual(messages[0]["type"], "computer-info")
self.assertNotEquals(len(messages[0]["hostname"]), 0)
self.assertTrue(re.search("\w", messages[0]["hostname"]))
def test_get_total_memory(self):
self.mstore.set_accepted_types(["computer-info"])
meminfo_filename = self.makeFile(self.sample_memory_info)
plugin = ComputerInfo(meminfo_filename=meminfo_filename,
fetch_async=self.fetch_func)
self.monitor.add(plugin)
plugin.exchange()
messages = self.mstore.get_pending_messages()
message = messages[0]
self.assertEqual(message["type"], "computer-info")
self.assertEqual(message["total-memory"], 1510)
self.assertEqual(message["total-swap"], 1584)
def test_no_fetch_ec2_meta_data_when_cloud_retries_is_max(self):
"""
Do not fetch EC2 info when C{_cloud_retries} is C{METADATA_RETRY_MAX}
"""
self.config.cloud = True
self.mstore.set_accepted_types(["cloud-instance-metadata"])
plugin = ComputerInfo(fetch_async=self.fetch_func)
plugin._cloud_retries = METADATA_RETRY_MAX
self.monitor.add(plugin)
plugin.exchange()
messages = self.mstore.get_pending_messages()
self.assertEqual(0, len(messages))
def test_fetch_ec2_meta_data_bad_result_max_retry(self):
"""
L{_fetch_ec2_meta_data} returns C{None} and logs an error when
crossing the retry threshold C{METADATA_RETRY_MAX}.
"""
self.log_helper.ignore_errors(HTTPCodeError)
self.add_query_result("ami-id", HTTPCodeError(404, "notfound"))
plugin = ComputerInfo(fetch_async=self.fetch_func)
plugin._cloud_retries = METADATA_RETRY_MAX
result = yield plugin._fetch_ec2_meta_data()
self.assertIn(
"INFO: No cloud meta-data available. Server returned "
"HTTP code 404", self.logfile.getvalue())
self.assertEqual(None, result)
def test_fetch_ec2_meta_data_no_cloud_api_max_retry(self):
"""
L{_fetch_ec2_meta_data} returns C{None} when faced with no EC2 cloud
API service and reports the specific C{PyCurlError} upon message
exchange when L{_cloud_retries} equals C{METADATA_RETRY_MAX}.
"""
self.log_helper.ignore_errors(PyCurlError)
self.add_query_result("instance-id", PyCurlError(60, "pycurl error"))
plugin = ComputerInfo(fetch_async=self.fetch_func)
plugin._cloud_retries = METADATA_RETRY_MAX
result = yield plugin._fetch_ec2_meta_data()
self.assertIn(
"INFO: No cloud meta-data available. "
"Error 60: pycurl error\n", self.logfile.getvalue())
self.assertEqual(None, result)
def test_fetch_cloud_metadata(self):
"""
Fetch cloud information and insert it in a cloud-instance-metadata
message.
"""
self.config.cloud = True
self.mstore.set_accepted_types(["cloud-instance-metadata"])
plugin = ComputerInfo(fetch_async=self.fetch_func)
self.monitor.add(plugin)
plugin.exchange()
messages = self.mstore.get_pending_messages()
self.assertEqual(1, len(messages))
self.assertEqual(u"i00001", messages[0]["instance-id"])
self.assertEqual(u"ami-00002", messages[0]["ami-id"])
self.assertEqual(u"hs1.8xlarge", messages[0]["instance-type"])
def test_fetch_ec2_meta_data(self):
"""
L{_fetch_ec2_meta_data} retrieves instance information from the
EC2 api.
"""
plugin = ComputerInfo(fetch_async=self.fetch_func)
result = yield plugin._fetch_ec2_meta_data()
self.assertEqual(
{
"instance-id": u"i00001",
"ami-id": u"ami-00002",
"instance-type": u"hs1.8xlarge"
}, result)
self.assertEqual(
" INFO: Querying cloud meta-data.\n"
" INFO: Acquired cloud meta-data.\n", self.logfile.getvalue())
def test_get_sample_distribution(self):
"""
Sample data is used to ensure that expected values end up in
the distribution data reported by the plugin.
"""
self.mstore.set_accepted_types(["distribution-info"])
plugin = ComputerInfo(lsb_release_filename=self.lsb_release_filename)
self.monitor.add(plugin)
plugin.exchange()
message = self.mstore.get_pending_messages()[0]
self.assertEqual(message["type"], "distribution-info")
self.assertEqual(message["distributor-id"], "Ubuntu")
self.assertEqual(message["description"], "Ubuntu 6.06.1 LTS")
self.assertEqual(message["release"], "6.06")
self.assertEqual(message["code-name"], "dapper")
def test_get_distribution(self):
"""
Various details about the distribution should be reported by
the plugin. This test ensures that the right kinds of details
end up in messages produced by the plugin.
"""
self.mstore.set_accepted_types(["distribution-info"])
plugin = ComputerInfo()
self.monitor.add(plugin)
plugin.exchange()
message = self.mstore.get_pending_messages()[0]
self.assertEqual(message["type"], "distribution-info")
self.assertTrue("distributor-id" in message)
self.assertTrue("description" in message)
self.assertTrue("release" in message)
self.assertTrue("code-name" in message)
def test_wb_report_changed_distribution(self):
"""
When distribution data changes, the new data should be sent to
the server.
"""
self.mstore.set_accepted_types(["distribution-info"])
plugin = ComputerInfo(lsb_release_filename=self.lsb_release_filename)
self.monitor.add(plugin)
plugin.exchange()
message = self.mstore.get_pending_messages()[0]
self.assertEqual(message["type"], "distribution-info")
self.assertEqual(message["distributor-id"], "Ubuntu")
self.assertEqual(message["description"], "Ubuntu 6.06.1 LTS")
self.assertEqual(message["release"], "6.06")
self.assertEqual(message["code-name"], "dapper")
plugin._lsb_release_filename = self.makeFile("""\
DISTRIB_ID=Ubuntu
DISTRIB_RELEASE=6.10
DISTRIB_CODENAME=edgy
DISTRIB_DESCRIPTION="Ubuntu 6.10"
""")
plugin.exchange()
message = self.mstore.get_pending_messages()[1]
self.assertEqual(message["type"], "distribution-info")
self.assertEqual(message["distributor-id"], "Ubuntu")
self.assertEqual(message["description"], "Ubuntu 6.10")
self.assertEqual(message["release"], "6.10")
self.assertEqual(message["code-name"], "edgy")
def test_unknown_distribution_key(self):
self.mstore.set_accepted_types(["distribution-info"])
lsb_release_filename = self.makeFile("""\
DISTRIB_ID=Ubuntu
DISTRIB_RELEASE=6.10
DISTRIB_CODENAME=edgy
DISTRIB_DESCRIPTION="Ubuntu 6.10"
DISTRIB_NEW_UNEXPECTED_KEY=ooga
""")
plugin = ComputerInfo(lsb_release_filename=lsb_release_filename)
self.monitor.add(plugin)
plugin.exchange()
message = self.mstore.get_pending_messages()[0]
self.assertEqual(message["type"], "distribution-info")
self.assertEqual(message["distributor-id"], "Ubuntu")
self.assertEqual(message["description"], "Ubuntu 6.10")
self.assertEqual(message["release"], "6.10")
self.assertEqual(message["code-name"], "edgy")
def test_computer_info_call_on_accepted(self):
plugin = ComputerInfo(fetch_async=self.fetch_func)
self.monitor.add(plugin)
self.mstore.set_accepted_types(["computer-info"])
with mock.patch.object(self.remote, "send_message"):
self.reactor.fire(
("message-type-acceptance-changed", "computer-info"), True)
self.remote.send_message.assert_called_once_with(mock.ANY,
mock.ANY,
urgent=True)
def test_message_if_not_accepted(self):
"""
Don't add any messages at all if the broker isn't currently
accepting their type.
"""
plugin = ComputerInfo()
self.monitor.add(plugin)
self.reactor.advance(self.monitor.step_size * 2)
self.monitor.exchange()
self.mstore.set_accepted_types(["distribution-info", "computer-info"])
self.assertMessages(list(self.mstore.get_pending_messages()), [])
def test_resynchronize(self):
"""
If a reactor event "resynchronize" is received, messages for
all computer info should be generated.
"""
self.mstore.set_accepted_types(["distribution-info", "computer-info"])
meminfo_filename = self.makeFile(self.sample_memory_info)
plugin = ComputerInfo(get_fqdn=get_fqdn,
meminfo_filename=meminfo_filename,
lsb_release_filename=self.lsb_release_filename,
root_path=self.makeDir(),
fetch_async=self.fetch_func)
self.monitor.add(plugin)
plugin.exchange()
self.reactor.fire("resynchronize", scopes=["computer"])
plugin.exchange()
computer_info = {
"type": "computer-info",
"hostname": "ooga.local",
"timestamp": 0,
"total-memory": 1510,
"total-swap": 1584
}
dist_info = {
"type": "distribution-info",
"code-name": "dapper",
"description": "Ubuntu 6.06.1 LTS",
"distributor-id": "Ubuntu",
"release": "6.06"
}
self.assertMessages(
self.mstore.get_pending_messages(),
[computer_info, dist_info, computer_info, dist_info])
def test_fetch_ec2_meta_data_bad_result_retry(self):
"""
L{_fetch_ec2_meta_data} returns C{None} when faced with spurious
errors from the EC2 api. The method increments L{_cloud_retries}
counter which allows L{_fetch_ec2_meta_data} to run again next
message exchange.
"""
self.log_helper.ignore_errors(HTTPCodeError)
self.add_query_result("ami-id", HTTPCodeError(404, "notfound"))
plugin = ComputerInfo(fetch_async=self.fetch_func)
result = yield plugin._fetch_ec2_meta_data()
self.assertEqual(1, plugin._cloud_retries)
self.assertEqual(None, result)
# Fix the error condition for the retry.
self.add_query_result("ami-id", b"ami-00002")
result = yield plugin._fetch_ec2_meta_data()
self.assertEqual(
{
"instance-id": u"i00001",
"ami-id": u"ami-00002",
"instance-type": u"hs1.8xlarge"
}, result)
def test_wb_report_changed_total_swap(self):
self.mstore.set_accepted_types(["computer-info"])
plugin = ComputerInfo(fetch_async=self.fetch_func)
self.monitor.add(plugin)
plugin._get_memory_info = lambda: (1510, 1584)
plugin.exchange()
message = self.mstore.get_pending_messages()[0]
self.assertEqual(message["total-swap"], 1584)
self.assertTrue("total-memory" in message)
plugin._get_memory_info = lambda: (1510, 2048)
plugin.exchange()
message = self.mstore.get_pending_messages()[1]
self.assertEqual(message["total-swap"], 2048)
self.assertTrue("total-memory" not in message)
def test_only_report_changed_hostnames(self):
self.mstore.set_accepted_types(["computer-info"])
plugin = ComputerInfo(get_fqdn=get_fqdn, fetch_async=self.fetch_func)
self.monitor.add(plugin)
plugin.exchange()
messages = self.mstore.get_pending_messages()
self.assertEqual(len(messages), 1)
plugin.exchange()
messages = self.mstore.get_pending_messages()
self.assertEqual(len(messages), 1)
def test_send_cloud_instance_metadata_only_once(self):
"""Only send the cloud information once per client restart."""
self.config.cloud = True
self.mstore.set_accepted_types(["cloud-instance-metadata"])
plugin = ComputerInfo(fetch_async=self.fetch_func)
self.monitor.add(plugin)
plugin.exchange()
messages = self.mstore.get_pending_messages()
self.assertEqual(1, len(messages))
plugin.exchange()
messages = self.mstore.get_pending_messages()
self.assertEqual(1, len(messages))
def test_distribution_reported_only_once(self):
"""
Distribution data shouldn't be reported unless it's changed
since the last time it was reported.
"""
self.mstore.set_accepted_types(["distribution-info"])
plugin = ComputerInfo()
self.monitor.add(plugin)
plugin.exchange()
messages = self.mstore.get_pending_messages()
self.assertEqual(len(messages), 1)
self.assertEqual(messages[0]["type"], "distribution-info")
plugin.exchange()
messages = self.mstore.get_pending_messages()
self.assertEqual(len(messages), 1)
def test_report_changed_hostnames(self):
def hostname_factory(hostnames=["ooga", "wubble", "wubble"]):
i = 0
while i < len(hostnames):
yield hostnames[i]
i = i + 1
self.mstore.set_accepted_types(["computer-info"])
hostname_fact = hostname_factory()
plugin = ComputerInfo(get_fqdn=lambda: next(hostname_fact),
fetch_async=self.fetch_func)
self.monitor.add(plugin)
plugin.exchange()
messages = self.mstore.get_pending_messages()
self.assertEqual(len(messages), 1)
self.assertEqual(messages[0]["hostname"], "ooga")
plugin.exchange()
messages = self.mstore.get_pending_messages()
self.assertEqual(len(messages), 2)
self.assertEqual(messages[1]["hostname"], "wubble")