ENH: Replace log_path with log_dir

Log files are saved according to the port where qiita is running.

Fixes qiita-spots#1982

Author: ElDeveloper

qiita_core/configuration_manager.py

@@ -17,7 +17,7 @@
 from .exceptions import MissingConfigSection
 
 with standard_library.hooks():
-    from configparser import ConfigParser
+    from configparser import ConfigParser, Error, NoOptionError
 
 
 class ConfigurationManager(object):
@@ -35,7 +35,9 @@ class ConfigurationManager(object):
     base_url: str
         base URL for the website, in the form http://SOMETHING.com
     base_data_dir : str
-        Path to the base directorys where all data file are stored
+        Path to the base directory where all data files are stored.
+    log_dir : str
+        Path to the directory where the log files are saved.
     working_dir : str
         Path to the working directory
     max_upload_size : int
@@ -118,6 +120,11 @@ class ConfigurationManager(object):
         The script used to start the plugins
     plugin_dir : str
         The path to the directory containing the plugin configuration files
+
+    Raises
+    ------
+    Error
+        When an option is no longer available.
     """
     def __init__(self):
         # If conf_fp is None, we default to the test configuration file
@@ -157,7 +164,21 @@ def _get_main(self, config):
         self.base_data_dir = config.get('main', 'BASE_DATA_DIR') or \
             default_base_data_dir
 
-        self.log_path = config.get('main', 'LOG_PATH')
+        try:
+            log_path = config.get('main', 'LOG_PATH')
+            if log_path:
+                raise Error('The option LOG_PATH in the main section is no '
+                            'longer supported, use LOG_DIR instead.')
+        except NoOptionError:
+            pass
+
+        self.log_dir = config.get('main', 'LOG_DIR')
+        if self.log_dir:
+            # if the option is a directory, it will exist
+            if not isdir(self.log_dir):
+                raise ValueError("The LOG_DIR (%s) option is required to be a "
+                                 "directory." % self.log_dir)
+
         self.base_url = config.get('main', 'BASE_URL')
 
         if not isdir(self.base_data_dir):

qiita_core/support_files/config_test.cfg

@@ -15,8 +15,9 @@
 # Change to FALSE in a production system
 TEST_ENVIRONMENT = TRUE
 
-# Absolute path to write log file to. If not given, no log file will be created
-LOG_PATH =
+# Absolute path to the directory where log files are saved. If not given, no
+# log file will be created
+LOG_DIR =
 
 # Whether studies require admin approval to be made available
 REQUIRE_APPROVAL = True

qiita_core/tests/test_configuration_manager.py

@@ -44,7 +44,7 @@ def test_init(self):
         self.assertEqual(obs.conf_fp, self.conf_fp)
         self.assertTrue(obs.test_environment)
         self.assertEqual(obs.base_data_dir, "/tmp/")
-        self.assertEqual(obs.log_path, "/tmp/qiita.log")
+        self.assertEqual(obs.log_dir, "/tmp/")
         self.assertEqual(obs.base_url, "https://localhost")
         self.assertEqual(obs.max_upload_size, 100)
         self.assertTrue(obs.require_approval)
@@ -201,7 +201,7 @@ def test_get_portal(self):
 TEST_ENVIRONMENT = TRUE
 
 # Absolute path to write log file to. If not given, no log file will be created
-LOG_PATH = /tmp/qiita.log
+LOG_DIR = /tmp/
 
 # Whether studies require admin approval to be made available
 REQUIRE_APPROVAL = True

scripts/qiita

@@ -418,8 +418,9 @@ def start(port, master):
     r_client.delete('qiita-usernames')
     r_client.zadd('qiita-usernames', **{u: 0 for u in qdb.user.User.iter()})
 
-    if qiita_config.log_path:
-        options.log_file_prefix = qiita_config.log_path
+    if qiita_config.log_dir:
+        options.log_file_prefix = join(qiita_config.log_dir,
+                                       'qiita_%d.log' % port)
         options.logging = 'debug'
         parse_command_line()
     ssl_options = {"certfile": qiita_config.certificate_file,