re-enable deprecated ES_{SEARCH,LOG}_{HOST,PORT} settings

ES settings disabled in settings.py. The README already instructs users
to create a local_settings.py. If they forget to configure Elasticsearch,
they get an exception rather than AVRXL trying to connect to localhost.

Author: larsmans

avresearcher/app.py

@@ -26,6 +26,7 @@ def create_app(package_name='avresearcher', settings_override=None):
 
     app.config.from_object('avresearcher.settings')
     app.config.from_object(settings_override)
+    _check_es_config(app.config)
     _validate(app.config)
 
     if app.config['DEBUG'] and app.config['SENTRY_DSN']:
@@ -57,6 +58,25 @@ def load_user(user_id):
     return app
 
 
+def _check_es_config(config):
+    # Check whether we have ES_SEARCH_CONFIG and ES_LOG_CONFIG.
+    # If not, set it from the deprecated ES_{SEARCH,LOG}_{HOST,PORT} settings.
+
+    for estype in ["SEARCH", "LOG"]:
+        es_config = "ES_%s_CONFIG" % estype
+        if es_config not in config:
+            host = "ES_%s_HOST" % estype
+            port = "ES_%s_PORT" % estype
+            if host not in config or port not in config:
+                raise ValueError("need either %s setting or %s and %s"
+                                 % (es_config, host, port))
+
+            config[es_config] = {
+                "hosts": [config[host]],
+                "port": config[port],
+            }
+
+
 def _validate(config):
     # Settings validation: should catch common settings.py/local_settings.py
     # mistakes. Add rules as needed.

avresearcher/settings.py

@@ -3,7 +3,7 @@
 SECRET_KEY = ''
 
 # ElasticSearch instance that contains the document collection(s).
-ES_SEARCH_CONFIG = {'hosts': ['localhost'], 'port': 9200}
+#ES_SEARCH_CONFIG = {'hosts': ['localhost'], 'port': 9200}
 
 # To connect to an Elasticsearch instance via a secure (HTTPS) connection,
 # use a setting like the following. This works for ES_LOG_CONFIG, too.
@@ -15,10 +15,12 @@
 #                    'verify_certs': True, 'ca_certs': certifi.where()}
 
 # ElasticSearch instance used to store usage logs (clicks, queries, etc.).
+# This has the same format as ES_SEARCH_CONFIG; use the following to use the
+# same host for logging:
+#ES_LOG_CONFIG = ES_SEARCH_CONFIG
+#ES_LOG_INDEX = 'avresearcherxl_logs'
 # To disable logs, use:
-# ES_LOG_CONFIG = None
-ES_LOG_CONFIG = ES_SEARCH_CONFIG    # Same instance that holds the collections.
-ES_LOG_INDEX = 'avresearcherxl_logs'
+#ES_LOG_CONFIG = None
 
 # User database URI
 SQLALCHEMY_DATABASE_URI = 'mysql://user:pass@host/db'

avresearcher/tests/test_app.py

@@ -1,8 +1,8 @@
-from avresearcher.app import _validate
+from avresearcher.app import _check_es_config, _validate
 
 from copy import deepcopy
 
-from nose.tools import assert_raises
+from nose.tools import assert_equal, assert_in, assert_raises
 
 
 config = {
@@ -24,6 +24,26 @@
 }
 
 
+def test_check_es_config():
+    assert_raises(ValueError, _check_es_config, config)
+
+    c = deepcopy(config)
+    c["ES_SEARCH_HOST"] = "localhost"
+    c["ES_SEARCH_PORT"] = 9200
+    c["ES_LOG_HOST"] = "loghost"
+    c["ES_LOG_PORT"] = 9200
+    _check_es_config(c)
+
+    assert_in("ES_SEARCH_CONFIG", c)
+    assert_equal(c["ES_SEARCH_CONFIG"], {"hosts": ["localhost"], "port": 9200})
+    assert_in("ES_LOG_CONFIG", c)
+    assert_equal(c["ES_LOG_CONFIG"], {"hosts": ["loghost"], "port": 9200})
+
+    # Allow ES_LOG_CONFIG = None
+    c["ES_LOG_CONFIG"] = None
+    _check_es_config(c)
+
+
 def test_validate():
     _validate(config)