Merge pull request YelpArchive#2467 from JeffAshton/non-compound-query-key-arrays

Handling non-compound query keys defined as an array

Author: Qmando

elastalert/loaders.py

@@ -328,9 +328,15 @@ def _dt_to_ts_with_format(dt):
         if 'include' in rule and type(rule['include']) != list:
             raise EAException('include option must be a list')
 
-        if isinstance(rule.get('query_key'), list):
-            rule['compound_query_key'] = rule['query_key']
-            rule['query_key'] = ','.join(rule['query_key'])
+        raw_query_key = rule.get('query_key')
+        if isinstance(raw_query_key, list):
+            if len(raw_query_key) > 1:
+                rule['compound_query_key'] = raw_query_key
+                rule['query_key'] = ','.join(raw_query_key)
+            elif len(raw_query_key) == 1:
+                rule['query_key'] = raw_query_key[0]
+            else:
+                del(rule['query_key'])
 
         if isinstance(rule.get('aggregation_key'), list):
             rule['compound_aggregation_key'] = rule['aggregation_key']

tests/loaders_test.py

@@ -358,6 +358,29 @@ def test_compound_query_key():
     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)