[tarantool-patches] [PATCH v2 1/2] Refactoring in string validation of log parameters

  • From: Olga Arkhangelskaia <arkholga@xxxxxxxxxxxxx>
  • To: tarantool-patches@xxxxxxxxxxxxx
  • Date: Thu, 19 Jul 2018 13:54:48 +0300

Removed unnecessary double check of log configuration string.
Instead all log configuration checks were moved to separate function.
---
Branch: https://github.com/tarantool/tarantool/tree/OKriw/refactor-log-cfg

v1:
https://www.freelists.org/post/tarantool-patches/PATCH-Refactoring-in-string-validation-of-log-parametrs

Changes in v2:
- exceptions transfered to box.cc
- say_parse_logger_type traansfered to say_ckeck_cfg


 src/box/box.cc | 40 ++++++++--------------------------------
 src/say.c      | 34 +++++++++++++++++++++++++---------
 src/say.h      |  8 ++++----
 3 files changed, 37 insertions(+), 45 deletions(-)

diff --git a/src/box/box.cc b/src/box/box.cc
index 7c6312d78..db598957a 100644
--- a/src/box/box.cc
+++ b/src/box/box.cc
@@ -356,41 +356,17 @@ box_check_say()
        const char *log = cfg_gets("log");
        if (log == NULL)
                return;
-       enum say_logger_type type;
-       if (say_parse_logger_type(&log, &type) < 0) {
-               tnt_raise(ClientError, ER_CFG, "log",
-                         diag_last_error(diag_get())->errmsg);
-       }
-
-       if (say_check_init_str(log) == -1) {
-
-               diag_raise();
-       }
-
-       if (type == SAY_LOGGER_SYSLOG) {
-               struct say_syslog_opts opts;
-               if (say_parse_syslog_opts(log, &opts) < 0) {
-                       if (diag_last_error(diag_get())->type ==
-                           &type_IllegalParams) {
-                               tnt_raise(ClientError, ER_CFG, "log",
-                                         diag_last_error(diag_get())->errmsg);
-                       }
-               }
-               say_free_syslog_opts(&opts);
-               diag_raise();
-       }
 
        const char *log_format = cfg_gets("log_format");
-       enum say_format format = say_format_by_name(log_format);
-       if (format == say_format_MAX)
-               diag_set(ClientError, ER_CFG, "log_format",
-                        "expected 'plain' or 'json'");
-       if (type == SAY_LOGGER_SYSLOG && format == SF_JSON) {
-               tnt_raise(ClientError, ER_ILLEGAL_PARAMS, "log, log_format");
-       }
        int log_nonblock = cfg_getb("log_nonblock");
-       if (log_nonblock == 1 && type == SAY_LOGGER_FILE) {
-               tnt_raise(ClientError, ER_ILLEGAL_PARAMS, "log, log_nonblock");
+       if (say_check_cfg(log, log_format, log_nonblock) < 0) {
+               if (diag_last_error(diag_get())->type ==
+                   &type_IllegalParams) {
+                       tnt_raise(ClientError, ER_CFG,
+                                 "log, log_format or log_nonblock",
+                                 diag_last_error(diag_get())->errmsg);
+               }
+
        }
 }
 
diff --git a/src/say.c b/src/say.c
index 43124083c..92e0e6d9f 100644
--- a/src/say.c
+++ b/src/say.c
@@ -952,25 +952,41 @@ write_to_syslog(struct log *log, int total)
 /** Loggers }}} */
 
 /*
- * Init string parser(s)
+ * Checks in logger configuration
  */
 
 int
-say_check_init_str(const char *str)
+say_check_cfg(const char *log, const char *log_format, int log_nonblock)
 {
+       int res = 0;
        enum say_logger_type type;
-       if (say_parse_logger_type(&str, &type)) {
-               diag_set(IllegalParams, logger_syntax_reminder);
-               return -1;
+       if (say_parse_logger_type(&log, &type) < 0) {
+               diag_set(IllegalParams, "Unrecognised logger type '%s'", log);
+               res = -1;
        }
        if (type == SAY_LOGGER_SYSLOG) {
                struct say_syslog_opts opts;
-
-               if (say_parse_syslog_opts(str, &opts) < 0)
-                       return -1;
+               int ret = say_parse_syslog_opts(log, &opts);
                say_free_syslog_opts(&opts);
+               if (ret < 0) {
+                       diag_set(IllegalParams, "Incorrect option '%s'", log);
+                       res = -1;
+               }
        }
-       return 0;
+       enum say_format format = say_format_by_name(log_format);
+       if (format == say_format_MAX) {
+               diag_set(IllegalParams,
+                       "for log_format expected 'plain' or 'json'");
+       }
+       if (type == SAY_LOGGER_SYSLOG && format == SF_JSON) {
+               diag_set(IllegalParams, "Illegal parametrs log, log_format");
+               res = -1;
+       }
+       if (log_nonblock == 1 && type == SAY_LOGGER_FILE) {
+               diag_set(IllegalParams, "Illegal parametrs log, log_nonblock");
+               res = -1;
+       }
+       return res;
 }
 
 /**
diff --git a/src/say.h b/src/say.h
index ad3ba3417..d14ae8b45 100644
--- a/src/say.h
+++ b/src/say.h
@@ -371,12 +371,12 @@ CFORMAT(printf, 5, 0) extern sayfunc_t _say;
        log_say_level(log, S_SYSERROR, strerror(errno), format, ##__VA_ARGS__)
 
 /**
- * validates logger init string;
- * @returns 0 if validation passed or -1
- *           with an error message written to diag
+ * Validates logger configuration
+ * @retval -1 check is failed, invalid parameters
+ * @retval 0 check is successful
  */
 int
-say_check_init_str(const char *str);
+say_check_cfg(const char *log, const char *log_format, int log_nonblock);
 
 /* internals, for unit testing */
 
-- 
2.14.3 (Apple Git-98)


Other related posts: