def test_mandatory_instance_values(self):
"""
Test existence of mandatory instance values
"""
tests = [{
'instance': {
'user': '******',
'password': '******'
},
'error': '{"url": ["This field is required."]}'
}, {
'instance': {
'user': '******',
'url': "https://website.com"
},
'error': '{"password": ["This field is required."]}'
}, {
'instance': {
'password': '******',
'url': "https://website.com"
},
'error': '{"user": ["This field is required."]}'
}]
for test in tests:
check = ServicenowCheck('servicenow', {}, {}, [test['instance']])
result = json.loads(check.run())
self.assertEqual(test['error'], result[0]['message'])
def setUp(self):
"""
Initialize and patch the check, i.e.
"""
self.check = ServicenowCheck('servicenow', {}, {}, [self.instance])
topology.reset()
aggregator.reset()
telemetry.reset()
self.check.commit_state(None)
def test_get_json_timeout(self, mock_request_get):
"""
Test timeout exception exception gets critical service check
"""
mock_request_get.side_effect = requests.exceptions.Timeout
check = ServicenowCheck('servicenow', {}, {}, [mock_instance])
check.run()
service_checks = aggregator.service_checks(
self.check.SERVICE_CHECK_NAME)
self.assertEqual(1, len(service_checks))
self.assertEqual(self.check.SERVICE_CHECK_NAME, service_checks[0].name)
self.assertEqual(AgentCheck.CRITICAL, service_checks[0].status)
self.assertEqual('Timeout: ', service_checks[0].message)
self.check.commit_state(None)
def test_batch_size(self):
"""
Test max batch size value
"""
instance = {
'user': '******',
'password': '******',
'url': "https://website.com",
'batch_size': 20000
}
check = ServicenowCheck('servicenow', {}, {}, [instance])
result = json.loads(check.run())
self.assertEqual(
'{"batch_size": ["Int value should be less than or equal to 10000."]}',
result[0]['message'])
def test_custom_cmdb_ci_field(self):
"""
Read from the custom field.
"""
custom_field_instance = {
'url': "https://instance.service-now.com",
'user': '******',
'password': '******',
'custom_cmdb_ci_field': 'u_configuration_item'
}
check = ServicenowCheck('servicenow', {}, {}, [custom_field_instance])
check._collect_relation_types = mock_collect_process
check._batch_collect_components = mock_collect_process
check._batch_collect_relations = mock_collect_process
check._collect_change_requests = mock.MagicMock()
response = self._read_data('CHG0000003.json')
self.assertEqual(
to_string('Sales © Force Automation'),
to_string(response['result'][0]['u_configuration_item']
['display_value']))
self.assertEqual(
to_string(
'Service Management Tools Portal - AXA WINTERTHUR - Production - Standard'
), response['result'][0]['cmdb_ci']['display_value'])
check._collect_change_requests.return_value = response
check.run()
topology_events = telemetry._topology_events
service_checks = aggregator.service_checks(
'servicenow.cmdb.topology_information')
self.assertEqual(AgentCheck.OK, service_checks[0].status)
self.assertEqual(1, len(topology_events))
self.assertEqual(to_string('CHG0000003: Rollback Oracle ® Version'),
topology_events[0]['msg_title'])
host_identifier = [
e for e in topology_events[0]['context']['element_identifiers']
if 'urn:host:/' in e
][0]
self.assertEqual(to_string('urn:host:/Sales © Force Automation'),
host_identifier)
self.check.commit_state(None)
class TestServicenow(unittest.TestCase):
"""Basic Test for servicenow integration."""
def setUp(self):
"""
Initialize and patch the check, i.e.
"""
self.check = ServicenowCheck('servicenow', {}, {}, [self.instance])
topology.reset()
aggregator.reset()
telemetry.reset()
self.check.commit_state(None)
def test_check(self):
"""
Testing Servicenow check.
"""
self.check._collect_relation_types = mock_collect_process
self.check._batch_collect = mock_collect_process
self.check.run()
topo_instances = topology.get_snapshot(self.check.check_id)
self.assertEqual(len(topo_instances['components']), 0)
self.assertEqual(len(topo_instances['relations']), 0)
self.assertEqual(
self.check._get_instance_key(),
TopologyInstance('servicenow_cmdb',
'https://instance.service-now.com'))
AgentIntegrationTestUtil.assert_integration_snapshot(
self.check, 'servicenow_cmdb:https://instance.service-now.com')
def test_when_check_has_exception_stop_snapshot_is_false(self):
"""
Test to raise a check exception when collecting components
"""
self.check._get_json = mock.MagicMock()
self.check._get_json.side_effect = Exception("Test exception occurred")
self.check.run()
# since the check raised exception, the topology snapshot is not completed
topo_instance = topology.get_snapshot(self.check.check_id)
self.assertEqual(topo_instance.get("start_snapshot"), True)
self.assertEqual(topo_instance.get("stop_snapshot"), False)
# Service Checks should be generated
service_checks = aggregator.service_checks(
self.check.SERVICE_CHECK_NAME)
self.assertEqual(len(service_checks), 1)
self.assertEqual(service_checks[0].name, self.check.SERVICE_CHECK_NAME)
self.assertEqual(service_checks[0].status, AgentCheck.CRITICAL)
def test_process_components(self):
"""
Test _process_components to return topology for components
"""
self.check._batch_collect_components = mock.MagicMock()
self.check._batch_collect_components.return_value = mock_collect_components
self.check._batch_collect_components.__name__ = 'mock_batch_collect_components'
self.check._batch_collect(self.check._batch_collect_components,
instance_info)
self.check._process_components(instance_info)
topo_instances = topology.get_snapshot(self.check.check_id)
self.assertEqual(len(topo_instances['components']), 1)
self.assertEqual(len(topo_instances['relations']), 0)
self.assertEqual(topo_instances['components'][0]['type'],
'cmdb_ci_computer')
self.assertEqual(
topo_instances['components'][0]['data']['identifiers'], [
"urn:host:/MacBook Pro 15", "00a96c0d3790200044e0bfc8bcbe5db4",
"urn:host:/macbook pro 15", "lupulus"
])
self.assertIn('stackstate-identifier:lupulus',
topo_instances['components'][0]['data']['tags'])
self.assertIn('stackstate',
topo_instances['components'][0]['data']['tags'])
def test_collect_relations(self):
"""
Test to raise a check Exception while collecting component relations from ServiceNow API
"""
self.assertRaises(Exception, self.check._batch_collect_relations,
instance_info, 10, 0, 100)
def test_process_relations(self):
"""
Test to collect the component relations and process it as a topology
"""
self.check._batch_collect_relations = mock.MagicMock()
self.check._batch_collect_relations.return_value = mock_relation_components
self.check._batch_collect_relations.__name__ = 'mock_batch_collect_relations'
self.check._process_relations(instance_info)
topo_instances = topology.get_snapshot(self.check.check_id)
self.assertEqual(len(topo_instances['components']), 0)
self.assertEqual(topo_instances['relations'][0]['type'], 'Cools')
@mock.patch('requests.get')
def test_get_json_ok_status(self, mock_req_get):
"""
Test to check the method _get_json with positive response and get a OK service check
"""
url, auth = self._get_url_auth()
example = {'key': 'value'}
mock_req_get.return_value = mock.MagicMock(status_code=200,
text=json.dumps(example))
result = self.check._get_json(url, timeout=10, params={}, auth=auth)
self.assertEqual(example, result)
@mock.patch('requests.get')
def test_get_json_error_status(self, mock_req_get):
"""
Test for Check Exception if response code is not 200
"""
url, auth = self._get_url_auth()
mock_req_get.return_value = mock.MagicMock(status_code=300,
text=json.dumps(
{'key': 'value'}))
self.assertRaises(CheckException, self.check._get_json, url, 10, auth)
@mock.patch('requests.get')
def test_get_json_ok_status_with_error_in_response(self, mock_req_get):
"""
Test for situation when we get error in json and request status is OK
"""
url, auth = self._get_url_auth()
response_txt = json.dumps({'error': {'message': 'test error'}})
mock_req_get.return_value = mock.MagicMock(status_code=200,
text=response_txt)
self.assertRaises(CheckException, self.check._get_json, url, 10, auth)
def test_get_sys_class_component_filter_query(self):
"""
Test to check if the method creates the proper param query
"""
sys_class_filter = self.instance.get('include_resource_types')
self.assertEqual(len(sys_class_filter), 3)
query = self.check._get_sys_class_component_filter_query(
sys_class_filter)
expected_query = "sys_class_nameINcmdb_ci_netgear,cmdb_ci_cluster,cmdb_ci_app_server"
self.assertEqual(expected_query, query)
def test_get_sys_class_component_filter_query_only_one_element(self):
"""
Test to check if the method creates the proper param query for only one element
"""
sys_class_filter = ['cmdb_ci_app_server_java']
query = self.check._get_sys_class_component_filter_query(
sys_class_filter)
expected_query = 'sys_class_nameINcmdb_ci_app_server_java'
self.assertEqual(expected_query, query)
def test_get_sys_class_relation_filter_query(self):
"""
Test to check if the method creates the proper param query
"""
sys_class_filter = self.instance.get('include_resource_types')
self.assertEqual(len(sys_class_filter), 3)
query = self.check._get_sys_class_relation_filter_query(
sys_class_filter)
expected_query = 'parent.sys_class_nameINcmdb_ci_netgear,cmdb_ci_cluster,cmdb_ci_app_server' \
'^child.sys_class_nameINcmdb_ci_netgear,cmdb_ci_cluster,cmdb_ci_app_server'
self.assertEqual(expected_query, query)
def test_get_sys_class_relation_filter_query_only_one_element(self):
"""
Test to check if the method creates the proper param query for only one
"""
sys_class_filter = ['cmdb_ci_app_server_java']
query = self.check._get_sys_class_relation_filter_query(
sys_class_filter)
expected_query = 'parent.sys_class_nameINcmdb_ci_app_server_java^child.sys_class_nameINcmdb_ci_app_server_java'
self.assertEqual(expected_query, query)
def test_process_components_with_sys_filter_change(self):
"""
Test _process_components to return whole topology when query changed in between
"""
sys_class_filter = self.instance.get('include_resource_types')
instance_info.sys_class_filter = sys_class_filter
query_filter = self.check._get_sys_class_component_filter_query(
sys_class_filter)
expected_query = 'sys_class_nameINcmdb_ci_netgear,cmdb_ci_cluster,cmdb_ci_app_server'
# asserting the actual query
self.assertEqual(expected_query, query_filter)
self.check._get_sys_class_component_filter_query = mock.MagicMock()
# changing the query in between and returning with incorrect query
self.check._get_sys_class_component_filter_query.return_value = "sys_class_namecmdb_ci_netgear" \
"%2Ccmdb_ci_cluster%2Ccmdb_ci_app_server"
self.check._get_json = mock.MagicMock()
self.check._get_json.return_value = mock_collect_components
self.check._process_components(instance_info)
topo_instances = topology.get_snapshot(self.check.check_id)
self.assertEqual(len(topo_instances['components']), 1)
self.assertEqual(len(topo_instances['relations']), 0)
self.assertEqual(topo_instances['components'][0]['type'],
'cmdb_ci_computer')
def test_process_component_relations_with_sys_filter_change(self):
"""
Test _process_components to return whole topology when query changed in between
"""
sys_class_filter = self.instance.get('include_resource_types')
instance_info.sys_class_filter = sys_class_filter
query_filter = self.check._get_sys_class_relation_filter_query(
sys_class_filter)
expected_query = 'parent.sys_class_nameINcmdb_ci_netgear,cmdb_ci_cluster,cmdb_ci_app_server' \
'^child.sys_class_nameINcmdb_ci_netgear,cmdb_ci_cluster,cmdb_ci_app_server'
# asserting the actual query
self.assertEqual(expected_query, query_filter)
self.check._get_sys_class_relation_filter_query = mock.MagicMock()
# changing the query in between and returning with incorrect query
self.check._get_sys_class_relation_filter_query.return_value = "parent.sys_class_nameN" \
"cmdb_ci_netgear%5Echild.sys_class_nameIN" \
"cmdb_ci_netgear"
self.check._get_json = mock.MagicMock()
self.check._get_json.return_value = mock_relation_components
self.check._process_relations(instance_info)
topo_instances = topology.get_snapshot(self.check.check_id)
self.assertEqual(len(topo_instances['components']), 0)
self.assertEqual(len(topo_instances['relations']), 1)
self.assertEqual(topo_instances['relations'][0]['type'], 'Cools')
def test_process_components_without_sys_filter_change(self):
"""
Test _process_components to return whole topology when query changed in between
"""
sys_class_filter = self.instance.get('include_resource_types')
instance_info.sys_class_filter = sys_class_filter
query_filter = self.check._get_sys_class_component_filter_query(
sys_class_filter)
expected_query = 'sys_class_nameINcmdb_ci_netgear,cmdb_ci_cluster,cmdb_ci_app_server'
# asserting the actual query
self.assertEqual(expected_query, query_filter)
self.check._get_json = mock.MagicMock()
self.check._get_json.return_value = mock_collect_filter_components
self.check._process_components(instance_info)
topo_instances = topology.get_snapshot(self.check.check_id)
self.assertEqual(len(topo_instances['components']), 1)
self.assertEqual(len(topo_instances['relations']), 0)
# Since the filter gets specific component types only so returned one component
self.assertEqual(topo_instances['components'][0]['type'],
'cmdb_ci_cluster')
def test_process_relations_without_sys_filter_change(self):
"""
Test _process_components to return whole topology when query changed in between
"""
sys_class_filter = self.instance.get('include_resource_types')
instance_info.sys_class_filter = sys_class_filter
query_filter = self.check._get_sys_class_relation_filter_query(
sys_class_filter)
expected_query = 'parent.sys_class_nameINcmdb_ci_netgear,cmdb_ci_cluster,cmdb_ci_app_server' \
'^child.sys_class_nameINcmdb_ci_netgear,cmdb_ci_cluster,cmdb_ci_app_server'
# asserting the actual query
self.assertEqual(expected_query, query_filter)
self.check._get_json = mock.MagicMock()
self.check._get_json.return_value = mock_relation_with_filter
self.check._process_relations(instance_info)
topo_instances = topology.get_snapshot(self.check.check_id)
self.assertEqual(len(topo_instances['components']), 0)
# Since the filter gets specific relation only so returned one relation for filtered resource types
self.assertEqual(len(topo_instances['relations']), 1)
self.assertEqual(topo_instances['relations'][0]['type'], 'Cools')
def test_batch_collect(self):
"""
Test batch collecting components
"""
self.check._batch_collect_components = mock.MagicMock()
self.check._batch_collect_components.side_effect = [
mock_collect_components_batch, mock_collect_components
]
self.check._batch_collect_components.__name__ = 'mock_batch_collect_components'
new_inst_conf = copy(instance_info)
new_inst_conf.batch_size = 5
self.check._process_components(new_inst_conf)
topology_instance = topology.get_snapshot(self.check.check_id)
self.assertEqual(len(topology_instance['components']), 6)
def test_mandatory_instance_values(self):
"""
Test existence of mandatory instance values
"""
tests = [{
'instance': {
'user': '******',
'password': '******'
},
'error': '{"url": ["This field is required."]}'
}, {
'instance': {
'user': '******',
'url': "https://website.com"
},
'error': '{"password": ["This field is required."]}'
}, {
'instance': {
'password': '******',
'url': "https://website.com"
},
'error': '{"user": ["This field is required."]}'
}]
for test in tests:
check = ServicenowCheck('servicenow', {}, {}, [test['instance']])
result = json.loads(check.run())
self.assertEqual(test['error'], result[0]['message'])
def test_append_to_sysparm_query(self):
"""
Test append of sysparm_query to params dict and creation of new empty dict if we don't pass one as parameter.
"""
params = self.check._params_append_to_sysparm_query(
add_to_query='first_one')
self.assertEqual({'sysparm_query': 'first_one'}, params)
params = self.check._params_append_to_sysparm_query(
params=params, add_to_query='second_one')
self.assertEqual({'sysparm_query': 'first_one^second_one'}, params)
params = self.check._params_append_to_sysparm_query(add_to_query='')
self.assertEqual({}, params)
def test_json_batch_params(self):
"""
Test json batch params
"""
offset = 10
batch_size = 200
params = self.check._prepare_json_batch_params(params={},
offset=offset,
batch_size=batch_size)
self.assertEqual(offset, params.get('sysparm_offset'))
self.assertEqual(batch_size, params.get('sysparm_limit'))
self.assertEqual('ORDERBYsys_created_on', params.get('sysparm_query'))
def test_json_batch_adding_param(self):
"""
Test batch path construction adding to sysparm_query
"""
offset = 10
batch_size = 200
params = self.check._prepare_json_batch_params(
params={'sysparm_query': 'company.nameSTARTSWITHaxa'},
offset=offset,
batch_size=batch_size)
self.assertEqual(offset, params.get('sysparm_offset'))
self.assertEqual(batch_size, params.get('sysparm_limit'))
self.assertEqual('company.nameSTARTSWITHaxa^ORDERBYsys_created_on',
params.get('sysparm_query'))
def test_collect_components_returns_no_result(self):
"""Test if collect component returns no result or its not list"""
self.check._batch_collect_components = mock.MagicMock()
self.check._batch_collect_components.return_value = {}
self.assertRaises(CheckException, self.check._batch_collect,
self.check._batch_collect_components, instance_info)
def test_collect_components_returns_empty_result(self):
"""Test if collect component returns no result or its not list"""
self.check._batch_collect_components = mock.MagicMock()
self.check._batch_collect_components.return_value = mock_empty_result
self.check._batch_collect_components.__name__ = 'mock_batch_collect_components'
self.check._batch_collect(self.check._batch_collect_components,
instance_info)
# no snapshot is created
self.assertRaises(KeyError, topology.get_snapshot, self.check.check_id)
def test_batch_collect_exact_result_as_batch_size(self):
"""
Test batch collecting components
"""
self.check._batch_collect_components = mock.MagicMock()
self.check._batch_collect_components.side_effect = [
mock_collect_components_batch, mock_empty_result
]
self.check._batch_collect_components.__name__ = 'mock_batch_collect_components'
new_inst_conf = copy(instance_info)
new_inst_conf.batch_size = 5
self.check._process_components(new_inst_conf)
topology_instance = topology.get_snapshot(self.check.check_id)
self.assertEqual(len(topology_instance['components']), 5)
@mock.patch('requests.get')
def test_get_json_utf_encoding(self, mock_req_get):
"""
Test to check the method _get_json response with unicode character in name
"""
url, auth = self._get_url_auth()
mock_req_get.return_value = mock.MagicMock(
status_code=200, text=json.dumps(mock_result_with_utf8))
response = self.check._get_json(url, timeout=10, params={}, auth=auth)
self.assertEqual(u'Avery® Wizard 2.1 forMicrosoft® Word 2000',
response.get('result').get('name'))
@mock.patch('requests.get')
def test_get_json_malformed_json(self, mock_request_get):
"""
Test just malformed json
"""
url, auth = self._get_url_auth()
mock_request_get.return_value = mock.MagicMock(
status_code=200, text=mock_result_with_malformed_str)
self.assertRaises(CheckException, self.check._get_json, url, 10, auth)
@mock.patch('requests.get')
def test_get_json_malformed_json_and_execution_time_exceeded_error(
self, mock_request_get):
"""
Test malformed json that sometimes happens with
ServiceNow error 'Transaction cancelled: maximum execution time exceeded'
"""
url, auth = self._get_url_auth()
mock_request_get.return_value = mock.MagicMock(
status_code=200, text=mock_result_malformed_str_with_error_msg)
self.assertRaises(CheckException, self.check._get_json, url, 10, auth)
def test_batch_size(self):
"""
Test max batch size value
"""
instance = {
'user': '******',
'password': '******',
'url': "https://website.com",
'batch_size': 20000
}
check = ServicenowCheck('servicenow', {}, {}, [instance])
result = json.loads(check.run())
self.assertEqual(
'{"batch_size": ["Int value should be less than or equal to 10000."]}',
result[0]['message'])
@mock.patch('requests.get')
def test_get_json_timeout(self, mock_request_get):
"""
Test timeout exception exception gets critical service check
"""
mock_request_get.side_effect = requests.exceptions.Timeout
check = ServicenowCheck('servicenow', {}, {}, [mock_instance])
check.run()
service_checks = aggregator.service_checks(
self.check.SERVICE_CHECK_NAME)
self.assertEqual(1, len(service_checks))
self.assertEqual(self.check.SERVICE_CHECK_NAME, service_checks[0].name)
self.assertEqual(AgentCheck.CRITICAL, service_checks[0].status)
self.assertEqual('Timeout: ', service_checks[0].message)
self.check.commit_state(None)
@mock.patch('requests.get')
def test_get_json_error_msg(self, mock_request_get):
"""
Test malformed json error message
"""
url, auth = self._get_url_auth()
mock_request_get.return_value = mock.MagicMock(
status_code=200,
text=mock_result_with_malformed_str,
url='http:/test.org')
msg_py3 = 'Json parse error: "Expecting property name enclosed in double quotes: ' \
'line 11 column 5 (char 232)" in response from url http:/test.org'
msg_py2 = 'Json parse error: "Expecting property name: ' \
'line 11 column 5 (char 232)" in response from url http:/test.org'
expected_msg = msg_py3 if PY3 else msg_py2
with self.assertRaises(CheckException) as context:
self.check._get_json(url, 10, {}, auth)
self.assertEqual(expected_msg, str(context.exception))
def test_process_components_encoding_errors(self):
"""
This would provoke following error with py27:
"UnicodeEncodeError: 'ascii' codec can't encode character u'\xeb' in position 4: ordinal not in range(128)"
in the function stackstate_checks.base.Identifiers.create_host_identifier
"""
collect_components_with_fqdn_umlaut = {
'result': [{
'sys_class_name': {
'display_value': 'cmdb_ci_computer',
'value': 'Computer'
},
'sys_id': {
'display_value': '00a96c0d3790200044e0bfc8bcbe5db4',
'value': '00a96c0d3790200044e0bfc8bcbe5db4'
},
'sys_created_on': {
'display_value': '2012-02-18 08:14:21',
'value': '2012-02-18 08:14:21'
},
'name': {
'display_value': 'Some computer',
'value': 'Some computer'
},
'fqdn': {
'display_value': u'abcdë.com',
'value': u'abcdë.com'
}
}]
}
self.check._batch_collect_components = mock.MagicMock()
self.check._batch_collect_components.return_value = collect_components_with_fqdn_umlaut
self.check._batch_collect_components.__name__ = 'mock_batch_collect_components'
self.check._batch_collect(self.check._batch_collect_components,
instance_info)
self.check._process_components(instance_info)
topo_instances = topology.get_snapshot(self.check.check_id)
self.assertEqual([
'urn:host:/abcdë.com', 'urn:host:/Some computer',
'00a96c0d3790200044e0bfc8bcbe5db4', 'urn:host:/some computer'
], topo_instances['components'][0]['data']['identifiers'])
def test_creating_event_from_change_request(self):
"""
Test creating event from SNOW Change Request
"""
self.check._collect_relation_types = mock_collect_process
self.check._batch_collect_components = mock_collect_process
self.check._batch_collect_relations = mock_collect_process
self.check._collect_change_requests = mock.MagicMock()
self.check._collect_change_requests.return_value = self._read_data(
'CHG0000001.json')
self.check.run()
topology_events = telemetry._topology_events
service_checks = aggregator.service_checks(
'servicenow.cmdb.topology_information')
self.assertEqual(AgentCheck.OK, service_checks[0].status)
self.assertEqual(1, len(topology_events))
self.assertEqual(to_string('CHG0000001: Rollback Oracle ® Version'),
topology_events[0]['msg_title'])
self.check.commit_state(None)
def test_creating_event_from_change_request_when_field_has_null_value(
self):
"""
SNOW CR Field can have null for display_value
"category": { "display_value": null, "value": "" }
"""
self.check._collect_relation_types = mock_collect_process
self.check._batch_collect_components = mock_collect_process
self.check._batch_collect_relations = mock_collect_process
self.check._collect_change_requests = mock.MagicMock()
self.check._collect_change_requests.return_value = self._read_data(
'CHG0000002.json')
self.check.run()
topology_events = telemetry._topology_events
service_checks = aggregator.service_checks(
'servicenow.cmdb.topology_information')
self.assertEqual(AgentCheck.OK, service_checks[0].status)
self.assertEqual(1, len(topology_events))
self.assertEqual('CHG0000002: Rollback Oracle Version',
topology_events[0]['msg_title'])
category_tag = [
e for e in topology_events[0]['tags'] if 'category' in e
][0]
self.assertEqual('category:None', category_tag)
self.check.commit_state(None)
def test_batch_collect_components_sys_filter_with_query_filter(self):
"""
Test the query filter with resource types while collecting components batch
"""
self.check._get_json = mock_get_json
instance_info['cmdb_ci_sysparm_query'] = "company.nameSTARTSWITHaxa"
instance_info['include_resource_types'] = ['cmdb_ci_netgear']
instance_info.batch_size = 100
params = self.check._batch_collect_components(instance_info, 0)
self.assertEqual(params.get("sysparm_offset"), 0)
self.assertEqual(params.get('sysparm_limit'), 100)
self.assertEqual(
params.get('sysparm_query'),
"sys_class_nameINcmdb_ci_netgear^company.nameSTARTSWITHaxa"
"^ORDERBYsys_created_on")
def test_batch_collect_relations_sys_filter_with_query_filter(self):
"""
Test the query filter with resource types while collecting relations batch
"""
self.check._get_json = mock_get_json
instance_info['cmdb_ci_sysparm_query'] = None
instance_info['cmdb_rel_ci_sysparm_query'] = "parent.company.nameSTARTSWITHaxa^" \
"ORchild.company.nameSTARTSWITHaxa"
instance_info['include_resource_types'] = ['cmdb_ci_netgear']
instance_info.batch_size = 100
params = self.check._batch_collect_relations(instance_info, 0)
self.assertEqual(params.get("sysparm_offset"), 0)
self.assertEqual(params.get('sysparm_limit'), 100)
self.assertEqual(
params.get('sysparm_query'),
"parent.sys_class_nameINcmdb_ci_netgear^child.sys_class_nameIN"
"cmdb_ci_netgear^parent.company.nameSTARTSWITHaxa"
"^ORchild.company.nameSTARTSWITHaxa^ORDERBYsys_created_on")
def test_collect_change_requests_sys_filter_with_query_filter(self):
"""
Test the query filter with resource types while collecting change requests
"""
self.check._get_json = mock_get_json
instance_info[
'change_request_sysparm_query'] = "company.nameSTARTSWITHaxa"
instance_info['include_resource_types'] = ['cmdb_ci_netgear']
instance_info['state'] = state
params = self.check._collect_change_requests(instance_info)
self.assertEqual(params.get("sysparm_display_value"), 'all')
self.assertEqual(params.get("sysparm_exclude_reference_link"), 'true')
self.assertEqual(params.get('sysparm_limit'), 1000)
self.assertEqual(
params.get('sysparm_query'),
"sys_updated_on>javascript:gs.dateGenerate('2017-06-29', "
"'11:03:27')^company.nameSTARTSWITHaxa")
def test_custom_cmdb_ci_field(self):
"""
Read from the custom field.
"""
custom_field_instance = {
'url': "https://instance.service-now.com",
'user': '******',
'password': '******',
'custom_cmdb_ci_field': 'u_configuration_item'
}
check = ServicenowCheck('servicenow', {}, {}, [custom_field_instance])
check._collect_relation_types = mock_collect_process
check._batch_collect_components = mock_collect_process
check._batch_collect_relations = mock_collect_process
check._collect_change_requests = mock.MagicMock()
response = self._read_data('CHG0000003.json')
self.assertEqual(
to_string('Sales © Force Automation'),
to_string(response['result'][0]['u_configuration_item']
['display_value']))
self.assertEqual(
to_string(
'Service Management Tools Portal - AXA WINTERTHUR - Production - Standard'
), response['result'][0]['cmdb_ci']['display_value'])
check._collect_change_requests.return_value = response
check.run()
topology_events = telemetry._topology_events
service_checks = aggregator.service_checks(
'servicenow.cmdb.topology_information')
self.assertEqual(AgentCheck.OK, service_checks[0].status)
self.assertEqual(1, len(topology_events))
self.assertEqual(to_string('CHG0000003: Rollback Oracle ® Version'),
topology_events[0]['msg_title'])
host_identifier = [
e for e in topology_events[0]['context']['element_identifiers']
if 'urn:host:/' in e
][0]
self.assertEqual(to_string('urn:host:/Sales © Force Automation'),
host_identifier)
self.check.commit_state(None)
def _get_url_auth(self):
url = "{}/api/now/table/cmdb_ci".format(self.instance.get('url'))
auth = (self.instance.get('user'), self.instance.get('password'))
return url, auth
@staticmethod
def _read_data(filename):
path_to_file = os.path.join(
os.path.dirname(os.path.realpath(__file__)), 'samples', filename)
with open(path_to_file, "r") as f:
return json.load(f)
