BUG#35112454 mysqlsh: unknown option --loose-default-character-set

This patch adds supports for the --loose prefix in the command line options.
Prints a WARNING instead of throwing error when the an unsupported command
line option is prefixed with --loose.

Change-Id: I3f3d1841862425aec1fa5d61e76d298c4f5b5d8d

Author: rennox

mysqlshdk/libs/utils/options.cc

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017, 2022, Oracle and/or its affiliates.
+ * Copyright (c) 2017, 2023, Oracle and/or its affiliates.
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License, version 2.0,
@@ -415,10 +415,19 @@ void Options::handle_cmdline_options(
                                       it->first + " requires an argument");
         }
       }
-    } else if (!allow_unregistered_options) {
+    } else if (!allow_unregistered_options && !iterator.is_loose()) {
       throw std::invalid_argument(argv[0] + std::string(": unknown option ") +
                                   opt);
     } else {
+      if (iterator.is_loose()) {
+        auto loose_option = iterator.option();
+        loose_option.insert(2, "loose-");
+        if (Iterator::Type::LONG == iterator.type()) {
+          loose_option.append("=").append(iterator.value());
+        }
+        m_invalid_loose_options.push_back(std::move(loose_option));
+      }
+
       if (Iterator::Type::LONG == iterator.type()) {
         iterator.next();
       } else {
@@ -617,7 +626,6 @@ void Options::Iterator::get_data() {
       if (data[1] == '-') {
         // long option
         const auto pos = data.find('=');
-
         if (std::string::npos == pos) {
           m_option = std::move(data);
           get_separate_value();
@@ -626,6 +634,11 @@ void Options::Iterator::get_data() {
           m_option = data.substr(0, pos);
           m_value = m_iterator.peek() + pos + 1;
         }
+
+        if (shcore::str_beginswith(m_option, "--loose-")) {
+          m_loose = true;
+          m_option.replace(2, 6, "");
+        }
       } else {
         // short option
         if (data.length() > 2) {

mysqlshdk/libs/utils/options.h

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017, 2022, Oracle and/or its affiliates.
+ * Copyright (c) 2017, 2023, Oracle and/or its affiliates.
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License, version 2.0,
@@ -505,6 +505,11 @@ class Options {
      */
     void next();
 
+    /**
+     * Returns true if the option is loose, i.e. --loose-option
+     */
+    bool is_loose() const { return m_loose; }
+
    private:
     void get_data();
 
@@ -515,6 +520,7 @@ class Options {
     const char *m_value;
     Type m_type;
     size_t m_short_value_pos = 0;
+    bool m_loose = false;
   };
 
   using Custom_cmdline_handler = std::function<bool(Iterator *)>;
@@ -584,6 +590,10 @@ class Options {
                              std::size_t output_width = 80,
                              std::size_t front_padding = 0);
 
+  const std::vector<std::string> &get_invalid_loose_options() const {
+    return m_invalid_loose_options;
+  }
+
  protected:
   struct Command_line_comparator {
     bool operator()(const std::string &lhs, const std::string &rhs) const;
@@ -597,6 +607,7 @@ class Options {
   std::map<std::string, opts::Generic_option *, Command_line_comparator>
       cmdline_options;
   std::string config_file;
+  std::vector<std::string> m_invalid_loose_options;
 };
 
 } /* namespace shcore */

src/mysqlsh/main.cc

@@ -798,6 +798,14 @@ int main(int argc, char **argv) {
     log_debug("Using color mode %i",
               static_cast<int>(mysqlshdk::textui::get_color_capability()));
 
+    if (options.quiet_start !=
+        mysqlsh::Shell_options::Quiet_start::SUPRESS_INFO) {
+      for (const auto &option : shell_options->get_invalid_loose_options()) {
+        mysqlsh::current_console()->print_warning(
+            shcore::str_format("unknown option: %s", option.c_str()));
+      }
+    }
+
     if (shell_options->action_print_version()) {
       std::string version_msg =
           version_string(argv[0], shell_options->action_print_version_extra());

unittest/scripts/auto/py_shell/scripts/loose_options_norecord.py

@@ -0,0 +1,44 @@
+#@<> Warnins on unknown loose options
+testutil.call_mysqlsh(["--loose-whatever", "-e", "print('done')"], "", ["MYSQLSH_TERM_COLOR_MODE=nocolor"])
+EXPECT_STDOUT_CONTAINS("WARNING: unknown option: --loose-whatever")
+WIPE_OUTPUT()
+
+#@<> Warnins on unknown loose options with --quiet-start=1
+testutil.call_mysqlsh(["--quiet-start=1", "--loose-whatever", "-e", "print('done')"], "", ["MYSQLSH_TERM_COLOR_MODE=nocolor"])
+EXPECT_STDOUT_CONTAINS("WARNING: unknown option: --loose-whatever")
+WIPE_OUTPUT()
+
+#@<> No warnins on unknown loose options with --quiet-start=2
+testutil.call_mysqlsh(["--quiet-start=2", "--loose-whatever", "-e", "print('done')"], "", ["MYSQLSH_TERM_COLOR_MODE=nocolor"])
+EXPECT_STDOUT_NOT_CONTAINS("WARNING: unknown option: --loose-whatever")
+WIPE_OUTPUT()
+
+#@<> Existing options can be prefixed with --loose
+testutil.call_mysqlsh(["--loose-quiet-start=1", "--loose-whatever", "-e", "print('done')"], "", ["MYSQLSH_TERM_COLOR_MODE=nocolor"])
+EXPECT_STDOUT_NOT_CONTAINS("WARNING: unknown option: --loose-quiet-start")
+EXPECT_STDOUT_CONTAINS("WARNING: unknown option: --loose-whatever")
+WIPE_OUTPUT()
+
+#@<> Unknown loose option with URI value as --loose-option=URI ignores value
+testutil.call_mysqlsh([f"--loose-whatever={__mysqluripwd}", "-e", "print(session)"], "", ["MYSQLSH_TERM_COLOR_MODE=nocolor"])
+EXPECT_STDOUT_CONTAINS(f"WARNING: unknown option: --loose-whatever={__mysqluripwd}")
+EXPECT_STDOUT_NOT_CONTAINS(f"<ClassicSession:{__mysql_uri}>")
+EXPECT_STDOUT_CONTAINS("null")
+WIPE_OUTPUT()
+
+#@<> Unknown loose option with URI value as --loose-option URI uses value
+testutil.call_mysqlsh([f"--loose-whatever", __mysqluripwd, "-e", "print(session)"], "", ["MYSQLSH_TERM_COLOR_MODE=nocolor"])
+EXPECT_STDOUT_CONTAINS("WARNING: unknown option: --loose-whatever")
+EXPECT_STDOUT_CONTAINS(f"<ClassicSession:{__mysql_uri}>")
+EXPECT_STDOUT_NOT_CONTAINS("null")
+WIPE_OUTPUT()
+
+#@<> Warns unsupported loose options from options file
+testutil.create_file("my_options.cnf", """
+[client]
+loose-unknown=whatever
+""")
+testutil.call_mysqlsh(["--defaults-file=my_options.cnf", "-e", "print('done')"], "", ["MYSQLSH_TERM_COLOR_MODE=nocolor"])
+EXPECT_STDOUT_CONTAINS("WARNING: unknown option: --loose-unknown")
+WIPE_OUTPUT()
+testutil.rmfile("my_options.cnf")