1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440
|
# -*- coding: utf-8 -*-
import copy
import datetime
import os
import mock
import pytest
import elastalert.alerts
import elastalert.ruletypes
from elastalert.config import load_conf
from elastalert.loaders import FileRulesLoader
from elastalert.util import EAException
test_config = {'rules_folder': 'test_folder',
'run_every': {'minutes': 10},
'buffer_time': {'minutes': 10},
'es_host': 'elasticsearch.test',
'es_port': 12345,
'writeback_index': 'test_index',
'writeback_alias': 'test_alias'}
test_rule = {'es_host': 'test_host',
'es_port': 12345,
'name': 'testrule',
'type': 'spike',
'spike_height': 2,
'spike_type': 'up',
'timeframe': {'minutes': 10},
'index': 'test_index',
'query_key': 'testkey',
'compare_key': 'comparekey',
'filter': [{'term': {'key': 'value'}}],
'alert': 'email',
'use_count_query': True,
'doc_type': 'blsh',
'email': 'test@test.test',
'aggregation': {'hours': 2},
'include': ['comparekey', '@timestamp']}
test_args = mock.Mock()
test_args.config = 'test_config'
test_args.rule = None
test_args.debug = False
test_args.es_debug_trace = None
def test_import_rules():
rules_loader = FileRulesLoader(test_config)
test_rule_copy = copy.deepcopy(test_rule)
test_rule_copy['type'] = 'testing.test.RuleType'
with mock.patch.object(rules_loader, 'load_yaml') as mock_open:
mock_open.return_value = test_rule_copy
# Test that type is imported
with mock.patch('builtins.__import__') as mock_import:
mock_import.return_value = elastalert.ruletypes
rules_loader.load_configuration('test_config', test_config)
assert mock_import.call_args_list[0][0][0] == 'testing.test'
assert mock_import.call_args_list[0][0][3] == ['RuleType']
# Test that alerts are imported
test_rule_copy = copy.deepcopy(test_rule)
mock_open.return_value = test_rule_copy
test_rule_copy['alert'] = 'testing2.test2.Alerter'
with mock.patch('builtins.__import__') as mock_import:
mock_import.return_value = elastalert.alerts
rules_loader.load_configuration('test_config', test_config)
assert mock_import.call_args_list[0][0][0] == 'testing2.test2'
assert mock_import.call_args_list[0][0][3] == ['Alerter']
def test_import_import():
rules_loader = FileRulesLoader(test_config)
import_rule = copy.deepcopy(test_rule)
del(import_rule['es_host'])
del(import_rule['es_port'])
import_rule['import'] = 'importme.ymlt'
import_me = {
'es_host': 'imported_host',
'es_port': 12349,
'email': 'ignored@email', # overwritten by the email in import_rule
}
with mock.patch.object(rules_loader, 'get_yaml') as mock_open:
mock_open.side_effect = [import_rule, import_me]
rules = rules_loader.load_configuration('blah.yaml', test_config)
assert mock_open.call_args_list[0][0] == ('blah.yaml',)
assert mock_open.call_args_list[1][0] == ('importme.ymlt',)
assert len(mock_open.call_args_list) == 2
assert rules['es_port'] == 12349
assert rules['es_host'] == 'imported_host'
assert rules['email'] == ['test@test.test']
assert rules['filter'] == import_rule['filter']
# check global import_rule dependency
assert rules_loader.import_rules == {'blah.yaml': ['importme.ymlt']}
def test_import_absolute_import():
rules_loader = FileRulesLoader(test_config)
import_rule = copy.deepcopy(test_rule)
del(import_rule['es_host'])
del(import_rule['es_port'])
import_rule['import'] = '/importme.ymlt'
import_me = {
'es_host': 'imported_host',
'es_port': 12349,
'email': 'ignored@email', # overwritten by the email in import_rule
}
with mock.patch.object(rules_loader, 'get_yaml') as mock_open:
mock_open.side_effect = [import_rule, import_me]
rules = rules_loader.load_configuration('blah.yaml', test_config)
assert mock_open.call_args_list[0][0] == ('blah.yaml',)
assert mock_open.call_args_list[1][0] == ('/importme.ymlt',)
assert len(mock_open.call_args_list) == 2
assert rules['es_port'] == 12349
assert rules['es_host'] == 'imported_host'
assert rules['email'] == ['test@test.test']
assert rules['filter'] == import_rule['filter']
def test_import_filter():
# Check that if a filter is specified the rules are merged:
rules_loader = FileRulesLoader(test_config)
import_rule = copy.deepcopy(test_rule)
del(import_rule['es_host'])
del(import_rule['es_port'])
import_rule['import'] = 'importme.ymlt'
import_me = {
'es_host': 'imported_host',
'es_port': 12349,
'filter': [{'term': {'ratchet': 'clank'}}],
}
with mock.patch.object(rules_loader, 'get_yaml') as mock_open:
mock_open.side_effect = [import_rule, import_me]
rules = rules_loader.load_configuration('blah.yaml', test_config)
assert rules['filter'] == [{'term': {'ratchet': 'clank'}}, {'term': {'key': 'value'}}]
def test_load_inline_alert_rule():
rules_loader = FileRulesLoader(test_config)
test_rule_copy = copy.deepcopy(test_rule)
test_rule_copy['alert'] = [
{
'email': {
'email': 'foo@bar.baz'
}
},
{
'email': {
'email': 'baz@foo.bar'
}
}
]
test_config_copy = copy.deepcopy(test_config)
with mock.patch.object(rules_loader, 'get_yaml') as mock_open:
mock_open.side_effect = [test_config_copy, test_rule_copy]
rules_loader.load_modules(test_rule_copy)
assert isinstance(test_rule_copy['alert'][0], elastalert.alerts.EmailAlerter)
assert isinstance(test_rule_copy['alert'][1], elastalert.alerts.EmailAlerter)
assert 'foo@bar.baz' in test_rule_copy['alert'][0].rule['email']
assert 'baz@foo.bar' in test_rule_copy['alert'][1].rule['email']
def test_file_rules_loader_get_names_recursive():
conf = {'scan_subdirectories': True, 'rules_folder': 'root'}
rules_loader = FileRulesLoader(conf)
walk_paths = (('root', ('folder_a', 'folder_b'), ('rule.yaml',)),
('root/folder_a', (), ('a.yaml', 'ab.yaml')),
('root/folder_b', (), ('b.yaml',)))
with mock.patch('os.walk') as mock_walk:
mock_walk.return_value = walk_paths
paths = rules_loader.get_names(conf)
paths = [p.replace(os.path.sep, '/') for p in paths]
assert 'root/rule.yaml' in paths
assert 'root/folder_a/a.yaml' in paths
assert 'root/folder_a/ab.yaml' in paths
assert 'root/folder_b/b.yaml' in paths
assert len(paths) == 4
def test_file_rules_loader_get_names():
# Check for no subdirectory
conf = {'scan_subdirectories': False, 'rules_folder': 'root'}
rules_loader = FileRulesLoader(conf)
files = ['badfile', 'a.yaml', 'b.yaml']
with mock.patch('os.listdir') as mock_list:
with mock.patch('os.path.isfile') as mock_path:
mock_path.return_value = True
mock_list.return_value = files
paths = rules_loader.get_names(conf)
paths = [p.replace(os.path.sep, '/') for p in paths]
assert 'root/a.yaml' in paths
assert 'root/b.yaml' in paths
assert len(paths) == 2
def test_load_rules():
test_rule_copy = copy.deepcopy(test_rule)
test_config_copy = copy.deepcopy(test_config)
with mock.patch('elastalert.config.yaml_loader') as mock_conf_open:
mock_conf_open.return_value = test_config_copy
with mock.patch('elastalert.loaders.yaml_loader') as mock_rule_open:
mock_rule_open.return_value = test_rule_copy
with mock.patch('os.walk') as mock_ls:
mock_ls.return_value = [('', [], ['testrule.yaml'])]
rules = load_conf(test_args)
rules['rules'] = rules['rules_loader'].load(rules)
assert isinstance(rules['rules'][0]['type'], elastalert.ruletypes.RuleType)
assert isinstance(rules['rules'][0]['alert'][0], elastalert.alerts.Alerter)
assert isinstance(rules['rules'][0]['timeframe'], datetime.timedelta)
assert isinstance(rules['run_every'], datetime.timedelta)
for included_key in ['comparekey', 'testkey', '@timestamp']:
assert included_key in rules['rules'][0]['include']
# Assert include doesn't contain duplicates
assert rules['rules'][0]['include'].count('@timestamp') == 1
assert rules['rules'][0]['include'].count('comparekey') == 1
def test_load_default_host_port():
test_rule_copy = copy.deepcopy(test_rule)
test_rule_copy.pop('es_host')
test_rule_copy.pop('es_port')
test_config_copy = copy.deepcopy(test_config)
with mock.patch('elastalert.config.yaml_loader') as mock_conf_open:
mock_conf_open.return_value = test_config_copy
with mock.patch('elastalert.loaders.yaml_loader') as mock_rule_open:
mock_rule_open.return_value = test_rule_copy
with mock.patch('os.walk') as mock_ls:
mock_ls.return_value = [('', [], ['testrule.yaml'])]
rules = load_conf(test_args)
rules['rules'] = rules['rules_loader'].load(rules)
# Assert include doesn't contain duplicates
assert rules['es_port'] == 12345
assert rules['es_host'] == 'elasticsearch.test'
def test_load_ssl_env_false():
test_rule_copy = copy.deepcopy(test_rule)
test_rule_copy.pop('es_host')
test_rule_copy.pop('es_port')
test_config_copy = copy.deepcopy(test_config)
with mock.patch('elastalert.config.yaml_loader') as mock_conf_open:
mock_conf_open.return_value = test_config_copy
with mock.patch('elastalert.loaders.yaml_loader') as mock_rule_open:
mock_rule_open.return_value = test_rule_copy
with mock.patch('os.listdir') as mock_ls:
with mock.patch.dict(os.environ, {'ES_USE_SSL': 'false'}):
mock_ls.return_value = ['testrule.yaml']
rules = load_conf(test_args)
rules['rules'] = rules['rules_loader'].load(rules)
assert rules['use_ssl'] is False
def test_load_ssl_env_true():
test_rule_copy = copy.deepcopy(test_rule)
test_rule_copy.pop('es_host')
test_rule_copy.pop('es_port')
test_config_copy = copy.deepcopy(test_config)
with mock.patch('elastalert.config.yaml_loader') as mock_conf_open:
mock_conf_open.return_value = test_config_copy
with mock.patch('elastalert.loaders.yaml_loader') as mock_rule_open:
mock_rule_open.return_value = test_rule_copy
with mock.patch('os.listdir') as mock_ls:
with mock.patch.dict(os.environ, {'ES_USE_SSL': 'true'}):
mock_ls.return_value = ['testrule.yaml']
rules = load_conf(test_args)
rules['rules'] = rules['rules_loader'].load(rules)
assert rules['use_ssl'] is True
def test_load_url_prefix_env():
test_rule_copy = copy.deepcopy(test_rule)
test_rule_copy.pop('es_host')
test_rule_copy.pop('es_port')
test_config_copy = copy.deepcopy(test_config)
with mock.patch('elastalert.config.yaml_loader') as mock_conf_open:
mock_conf_open.return_value = test_config_copy
with mock.patch('elastalert.loaders.yaml_loader') as mock_rule_open:
mock_rule_open.return_value = test_rule_copy
with mock.patch('os.listdir') as mock_ls:
with mock.patch.dict(os.environ, {'ES_URL_PREFIX': 'es/'}):
mock_ls.return_value = ['testrule.yaml']
rules = load_conf(test_args)
rules['rules'] = rules['rules_loader'].load(rules)
assert rules['es_url_prefix'] == 'es/'
def test_load_disabled_rules():
test_rule_copy = copy.deepcopy(test_rule)
test_rule_copy['is_enabled'] = False
test_config_copy = copy.deepcopy(test_config)
with mock.patch('elastalert.config.yaml_loader') as mock_conf_open:
mock_conf_open.return_value = test_config_copy
with mock.patch('elastalert.loaders.yaml_loader') as mock_rule_open:
mock_rule_open.return_value = test_rule_copy
with mock.patch('os.listdir') as mock_ls:
mock_ls.return_value = ['testrule.yaml']
rules = load_conf(test_args)
rules['rules'] = rules['rules_loader'].load(rules)
# The rule is not loaded for it has "is_enabled=False"
assert len(rules['rules']) == 0
def test_raises_on_missing_config():
optional_keys = ('aggregation', 'use_count_query', 'query_key', 'compare_key', 'filter', 'include', 'es_host', 'es_port', 'name')
test_rule_copy = copy.deepcopy(test_rule)
for key in list(test_rule_copy.keys()):
test_rule_copy = copy.deepcopy(test_rule)
test_config_copy = copy.deepcopy(test_config)
test_rule_copy.pop(key)
# Non required keys
if key in optional_keys:
continue
with mock.patch('elastalert.config.yaml_loader') as mock_conf_open:
mock_conf_open.return_value = test_config_copy
with mock.patch('elastalert.loaders.yaml_loader') as mock_rule_open:
mock_rule_open.return_value = test_rule_copy
with mock.patch('os.walk') as mock_walk:
mock_walk.return_value = [('', [], ['testrule.yaml'])]
with pytest.raises(EAException, match=r'(Invalid Rule|Error loading) file'):
rules = load_conf(test_args)
rules['rules'] = rules['rules_loader'].load(rules)
def test_compound_query_key():
test_config_copy = copy.deepcopy(test_config)
rules_loader = FileRulesLoader(test_config_copy)
test_rule_copy = copy.deepcopy(test_rule)
test_rule_copy.pop('use_count_query')
test_rule_copy['query_key'] = ['field1', 'field2']
rules_loader.load_options(test_rule_copy, test_config, 'filename.yaml')
assert 'field1' in test_rule_copy['include']
assert 'field2' in test_rule_copy['include']
assert test_rule_copy['query_key'] == 'field1,field2'
assert test_rule_copy['compound_query_key'] == ['field1', 'field2']
def test_query_key_with_single_value():
test_config_copy = copy.deepcopy(test_config)
rules_loader = FileRulesLoader(test_config_copy)
test_rule_copy = copy.deepcopy(test_rule)
test_rule_copy.pop('use_count_query')
test_rule_copy['query_key'] = ['field1']
rules_loader.load_options(test_rule_copy, test_config, 'filename.yaml')
assert 'field1' in test_rule_copy['include']
assert test_rule_copy['query_key'] == 'field1'
assert 'compound_query_key' not in test_rule_copy
def test_query_key_with_no_values():
test_config_copy = copy.deepcopy(test_config)
rules_loader = FileRulesLoader(test_config_copy)
test_rule_copy = copy.deepcopy(test_rule)
test_rule_copy.pop('use_count_query')
test_rule_copy['query_key'] = []
rules_loader.load_options(test_rule_copy, test_config, 'filename.yaml')
assert 'query_key' not in test_rule_copy
assert 'compound_query_key' not in test_rule_copy
def test_name_inference():
test_config_copy = copy.deepcopy(test_config)
rules_loader = FileRulesLoader(test_config_copy)
test_rule_copy = copy.deepcopy(test_rule)
test_rule_copy.pop('name')
rules_loader.load_options(test_rule_copy, test_config, 'msmerc woz ere.yaml')
assert test_rule_copy['name'] == 'msmerc woz ere'
def test_raises_on_bad_generate_kibana_filters():
test_rule['generate_kibana_link'] = True
bad_filters = [[{'not': {'terms': {'blah': 'blah'}}}],
[{'terms': {'blah': 'blah'}}],
[{'query': {'not_querystring': 'this:that'}}],
[{'query': {'wildcard': 'this*that'}}],
[{'blah': 'blah'}]]
good_filters = [[{'term': {'field': 'value'}}],
[{'not': {'term': {'this': 'that'}}}],
[{'not': {'query': {'query_string': {'query': 'this:that'}}}}],
[{'query': {'query_string': {'query': 'this:that'}}}],
[{'range': {'blah': {'from': 'a', 'to': 'b'}}}],
[{'not': {'range': {'blah': {'from': 'a', 'to': 'b'}}}}]]
# Test that all the good filters work, but fail with a bad filter added
for good in good_filters:
test_config_copy = copy.deepcopy(test_config)
rules_loader = FileRulesLoader(test_config_copy)
test_rule_copy = copy.deepcopy(test_rule)
test_rule_copy['filter'] = good
with mock.patch.object(rules_loader, 'get_yaml') as mock_open:
mock_open.return_value = test_rule_copy
rules_loader.load_configuration('blah', test_config)
for bad in bad_filters:
test_rule_copy['filter'] = good + bad
with pytest.raises(EAException):
rules_loader.load_configuration('blah', test_config)
def test_kibana_discover_from_timedelta():
test_config_copy = copy.deepcopy(test_config)
rules_loader = FileRulesLoader(test_config_copy)
test_rule_copy = copy.deepcopy(test_rule)
test_rule_copy['kibana_discover_from_timedelta'] = {'minutes': 2}
rules_loader.load_options(test_rule_copy, test_config, 'filename.yaml')
assert isinstance(test_rule_copy['kibana_discover_from_timedelta'], datetime.timedelta)
assert test_rule_copy['kibana_discover_from_timedelta'] == datetime.timedelta(minutes=2)
def test_kibana_discover_to_timedelta():
test_config_copy = copy.deepcopy(test_config)
rules_loader = FileRulesLoader(test_config_copy)
test_rule_copy = copy.deepcopy(test_rule)
test_rule_copy['kibana_discover_to_timedelta'] = {'minutes': 2}
rules_loader.load_options(test_rule_copy, test_config, 'filename.yaml')
assert isinstance(test_rule_copy['kibana_discover_to_timedelta'], datetime.timedelta)
assert test_rule_copy['kibana_discover_to_timedelta'] == datetime.timedelta(minutes=2)
|