Merge pull request #1100 from akusei/remove_overwrite

Remove hardcoded file loader from test_rule.py

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## Breaking changes
 - [Alerta] All matches will now be sent with the alert - [#1068](https://github.com/jertel/elastalert2/pull/1068) - @dakotacody
+- Renamed the `overwrites` parameter to `overrides` in the load_conf method of config.py - [#1100](https://github.com/jertel/elastalert2/pull/1100) - @akusei
 
 ## New features
 - [Graylog GELF] Alerter added. [#1050](https://github.com/jertel/elastalert2/pull/1050) - @malinkinsa

Makefile

@@ -1,5 +1,10 @@
 .PHONY: all production test docs clean
 
+COMPOSE = "-compose"
+ifeq ($(shell docker$(COMPOSE) 2> /dev/null),)
+	COMPOSE = " compose"
+endif
+
 all: production
 
 production:
@@ -20,9 +25,9 @@ test-elasticsearch:
 	tox -c tests/tox.ini -- --runelasticsearch
 
 test-docker:
-	docker-compose -f tests/docker-compose.yml --project-name elastalert build tox
-	docker-compose -f tests/docker-compose.yml --project-name elastalert run --rm tox \
-        tox -c tests/tox.ini -- $(filter-out $@,$(MAKECMDGOALS))
+	$(shell echo docker$(COMPOSE)) -f tests/docker-compose.yml --project-name elastalert build tox
+	$(shell echo docker$(COMPOSE)) -f tests/docker-compose.yml --project-name elastalert run --rm tox \
+		tox -c tests/tox.ini -- $(filter-out $@,$(MAKECMDGOALS))
 
 clean:
 	make -C docs clean

elastalert/config.py

@@ -35,13 +35,13 @@
 }
 
 
-def load_conf(args, defaults=None, overwrites=None):
+def load_conf(args, defaults=None, overrides=None):
     """ Creates a conf dictionary for ElastAlerter. Loads the global
         config file and then each rule found in rules_folder.
 
         :param args: The parsed arguments to ElastAlert
         :param defaults: Dictionary of default conf values
-        :param overwrites: Dictionary of conf values to override
+        :param overrides: Dictionary of conf values to override
         :return: The global configuration, a dictionary.
         """
     filename = args.config
@@ -65,7 +65,7 @@ def load_conf(args, defaults=None, overwrites=None):
         if key not in conf:
             conf[key] = value
 
-    for key, value in (iter(overwrites.items()) if overwrites is not None else []):
+    for key, value in (iter(overrides.items()) if overrides is not None else []):
         conf[key] = value
 
     # Make sure we have all required globals

elastalert/test_rule.py

@@ -440,11 +440,8 @@ def run_rule_test(self):
             'buffer_time': {'minutes': 45},
             'scroll_keepalive': '30s'
         }
-        overwrites = {
-            'rules_loader': 'file',
-        }
 
-        conf = load_conf(self.args, defaults, overwrites)
+        conf = load_conf(self.args, defaults)
         rule_yaml = conf['rules_loader'].load_yaml(self.args.file)
         conf['rules_loader'].load_options(rule_yaml, conf, self.args.file)
 

tests/config_test.py

@@ -37,6 +37,48 @@ def test_config_loads():
     assert conf['alert_time_limit'] == datetime.timedelta(days=2)
 
 
+def test_config_defaults():
+    dir_path = os.path.dirname(os.path.realpath(__file__))
+
+    test_args = mock.Mock()
+    test_args.config = dir_path + '/example.config.yaml'
+    test_args.rule = None
+    test_args.debug = False
+    test_args.es_debug_trace = None
+
+    conf = load_conf(
+        test_args,
+        defaults={
+            'new_key': 'new_value',
+            'rules_folder': '/new/rules/folder'
+        }
+    )
+
+    assert conf['new_key'] == 'new_value'
+    assert conf['rules_folder'] == '/opt/elastalert/rules'
+
+
+def test_config_overrides():
+    dir_path = os.path.dirname(os.path.realpath(__file__))
+
+    test_args = mock.Mock()
+    test_args.config = dir_path + '/example.config.yaml'
+    test_args.rule = None
+    test_args.debug = False
+    test_args.es_debug_trace = None
+
+    conf = load_conf(
+        test_args,
+        overrides={
+            'new_key': 'new_value',
+            'rules_folder': '/new/rules/folder'
+        }
+    )
+
+    assert conf['new_key'] == 'new_value'
+    assert conf['rules_folder'] == '/new/rules/folder'
+
+
 def test_config_loads_ea_execption():
     with pytest.raises(EAException) as ea:
         os.environ['ELASTIC_PASS'] = 'password_from_env'