BUG#26393614: ADDING AN INSTANCE USING 'LOCALHOST' (SANDBOX) SHOULD THROW A WARNING

This patch adds warnings regarding the limitations using MySQL
sandboxes with InnoDB Cluster.  New warnings are now shown in the log
file after the cluster.addInstance and dba.deploySandboxInstance
operations. Furthermore, the deploySandboxInstance command also got a
new warning when using the interactive mode.

New tests were added to verify all of the above changes.

Author: Nelson Goncalves

interactive/interactive_global_dba.cc

@@ -30,6 +30,7 @@
 #include "modules/mysqlxtest_utils.h"
 #include "utils/utils_general.h"
 #include "utils/utils_file.h"
+#include "utils/utils_path.h"
 #include "utils/utils_help.h"
 #include <boost/format.hpp>
 
@@ -137,13 +138,21 @@ shcore::Value Global_dba::deploy_sandbox_instance(const shcore::Argument_list &a
 
     std::string message;
     if (prompt_password) {
+      std::vector<std::string> paths {sandbox_dir, std::to_string(port)};
+      std::string path = shcore::join_path(paths);
       if (deploying) {
-        message = "A new MySQL sandbox instance will be created on this host in \n"\
-          "" + sandbox_dir + "/" + std::to_string(port) + "\n\n"
+        message = "A new MySQL sandbox instance will be created on this host "
+          "in \n" + path + "\n\n"
+          "Warning: Sandbox instances are only suitable for deploying and \n"
+          "running on your local machine for testing purposes and are not \n"
+          "accessible from external networks.\n\n"
           "Please enter a MySQL root password for the new instance: ";
       } else {
         message = "The MySQL sandbox instance on this host in \n"\
-          "" + sandbox_dir + "/" + std::to_string(port) + " will be started\n\n"
+          "" + path + " will be started\n\n"
+          "Warning: Sandbox instances are only suitable for deploying and \n"
+          "running on your local machine for testing purposes and are not \n"
+          "accessible from external networks.\n\n"
           "Please enter the MySQL root password of the instance: ";
       }
 
@@ -197,8 +206,10 @@ shcore::Value Global_dba::perform_instance_operation(const shcore::Argument_list
   auto options = valid_args.map_at(1);
 
   std::string sandboxDir {options->get_string("sandboxDir")};
+  std::vector<std::string> paths {sandboxDir, std::to_string(port)};
+  std::string path = shcore::join_path(paths);
   std::string message = "The MySQL sandbox instance on this host in \n"\
-    "" + sandboxDir + "/" + std::to_string(port) + " will be " + past + "\n";
+    "" + path + " will be " + past + "\n";
 
   println(message);
 

modules/adminapi/mod_dba.cc

@@ -1042,7 +1042,6 @@ shcore::Value Dba::deploy_sandbox_instance(const shcore::Argument_list &args, co
           auto session = std::dynamic_pointer_cast<mysqlsh::mysql::ClassicSession>(
                 mysqlsh::connect_session(uri, password, mysqlsh::SessionType::Classic));
           assert(session);
-
           log_info("Creating root@%s account for sandbox %i", remote_root.c_str(), port);
           session->execute_sql("SET sql_log_bin = 0");
           {
@@ -1062,6 +1061,10 @@ shcore::Value Dba::deploy_sandbox_instance(const shcore::Argument_list &args, co
           session->close(shcore::Argument_list());
         }
       }
+      log_warning(
+          "Sandbox instances are only suitable for deploying and running on "
+          "your local machine for testing purposes and are not accessible from "
+          "external networks.");
     }
   }
   CATCH_AND_TRANSLATE_FUNCTION_EXCEPTION(get_function_name(fname));

modules/adminapi/mod_dba_replicaset.cc

@@ -269,7 +269,11 @@ void ReplicaSet::validate_instance_address(std::shared_ptr<mysqlsh::mysql::Class
          "To add an instance to the cluster, please use a valid, non-local hostname or IP. "
          + hostname + " can only be used with sandbox MySQL instances.");
     } else {
-      log_info("'%s' (%s) detected as local sandbox", hostname.c_str(), datadir.c_str());
+      log_warning(
+          "'%s' (%s) detected as local sandbox. Sandbox instances are only "
+          "suitable for deploying and running on your local machine for "
+          "testing purposes and are not accessible from external networks.",
+          hostname.c_str(), datadir.c_str());
     }
   } else {
     auto result = session->execute_sql("select @@report_host, @@hostname");

shellcore/CMakeLists.txt

@@ -56,6 +56,7 @@ file(GLOB libmysqlshcore_SRC
     "${CMAKE_SOURCE_DIR}/utils/utils_time.cc"
     "${CMAKE_SOURCE_DIR}/utils/utils_file.h"
     "${CMAKE_SOURCE_DIR}/utils/utils_file.cc"
+    "${CMAKE_SOURCE_DIR}/utils/utils_path.h"
     "${CMAKE_SOURCE_DIR}/utils/utils_json.h"
     "${CMAKE_SOURCE_DIR}/utils/utils_json.cc"
     "${CMAKE_SOURCE_DIR}/utils/utils_general.h"
@@ -90,6 +91,13 @@ file(GLOB libmysqlshcore_SRC
     "${BOOST_SOURCE_CODE}"
 )
 
+# platform dependent implementations
+IF(UNIX)
+  LIST(APPEND libmysqlshcore_SRC "${CMAKE_SOURCE_DIR}/utils/utils_path_unix.cc")
+ELSEIF(WIN32)
+  LIST(APPEND libmysqlshcore_SRC "${CMAKE_SOURCE_DIR}/utils/utils_path_win32.cc")
+ENDIF()
+
 #if(NOT WINDOWS_RUNTIME_MD)
   list(APPEND libmysqlshcore_SRC "${CMAKE_SOURCE_DIR}/types/ishell_core.cc")
   list(APPEND libmysqlshcore_SRC "${CMAKE_SOURCE_DIR}/common/logger/logger.cc")

unittest/scripts/js_devapi/scripts/dba_deploy_sandbox.js

@@ -0,0 +1,13 @@
+// Assumptions: smart deployment routines available
+//@ Initialization
+var connected = connect_to_sandbox([__mysql_sandbox_port1]);
+if (connected)
+    cleanup_sandbox(__mysql_sandbox_port1);
+
+//@<OUT> Deploy sandbox
+dba.deploySandboxInstance(__mysql_sandbox_port1, {sandboxDir:__sandbox_dir});
+
+//@ Finalization
+if (!connected)
+    // if sandbox was not available when test start, clean it
+    cleanup_sandbox(__mysql_sandbox_port1);

unittest/scripts/js_devapi/validation/dba_deploy_sandbox.js

@@ -0,0 +1,18 @@
+//@ Initialization
+||
+
+//@<OUT> Deploy sandbox
+A new MySQL sandbox instance will be created on this host in
+<<<__sandbox_dir>>><<<__mysql_sandbox_port1>>>
+
+Warning: Sandbox instances are only suitable for deploying and
+running on your local machine for testing purposes and are not
+accessible from external networks.
+
+Please enter a MySQL root password for the new instance: Deploying new MySQL instance...
+
+Instance <<<localhost>>>:<<<__mysql_sandbox_port1>>> successfully deployed and started.
+Use shell.connect('root@localhost:<<<__mysql_sandbox_port1>>>'); to connect to the instance.
+
+//@ Finalization
+||

unittest/shell_js_dba_t.cc

@@ -201,7 +201,7 @@ TEST_F(Shell_js_dba_tests, no_active_session_error) {
 TEST_F(Shell_js_dba_tests, no_interactive_sandboxes) {
   _options->wizards = false;
   reset_shell();
-
+  output_handler.set_log_level(ngcommon::Logger::LOG_WARNING);
   execute("dba.verbose = true;");
 
   // Create directory with space and quotes in name to test.
@@ -226,6 +226,12 @@ TEST_F(Shell_js_dba_tests, no_interactive_sandboxes) {
   // Remove previously created directories.
   shcore::remove_directory(dir);
   shcore::remove_directory(dir_long);
+  // BUG#26393614
+  std::vector<std::string> log{
+      "Warning: Sandbox instances are only suitable for deploying and "
+      "running on your local machine for testing purposes and are not "
+      "accessible from external networks."};
+  MY_EXPECT_LOG_CONTAINS(log);
 }
 
 TEST_F(Shell_js_dba_tests, dba_help) {
@@ -252,6 +258,22 @@ TEST_F(Shell_js_dba_tests, no_interactive_deploy_instances) {
   validate_interactive("dba_reset_or_deploy.js");
 }
 
+TEST_F(Shell_js_dba_tests, interactive_deploy_instance) {
+  _options->interactive = true;
+  reset_shell();
+  output_handler.set_log_level(ngcommon::Logger::LOG_WARNING);
+  // BUG 26830224
+  // Please enter a MySQL root password for the new instance:
+  output_handler.passwords.push_back("root");
+  validate_interactive("dba_deploy_sandbox.js");
+  // BUG#26393614
+  std::vector<std::string> log{
+      "Warning: Sandbox instances are only suitable for deploying and "
+          "running on your local machine for testing purposes and are not "
+          "accessible from external networks."};
+  MY_EXPECT_LOG_CONTAINS(log);
+}
+
 TEST_F(Shell_js_dba_tests, no_interactive_classic_global_dba) {
   std::string bad_config = "[mysqld]\ngtid_mode = OFF\n";
   create_file("mybad.cnf", bad_config);
@@ -582,7 +604,18 @@ TEST_F(Shell_js_dba_tests, function_preconditions_interactive) {
 TEST_F(Shell_js_dba_tests, dba_cluster_add_instance) {
   _options->wizards = false;
   reset_shell();
+  output_handler.set_log_level(ngcommon::Logger::LOG_WARNING);
+
   validate_interactive("dba_cluster_add_instance.js");
+  // BUG#26393614
+  std::vector<std::string> log{
+      "'localhost' (" + _sandbox_dir + _path_splitter + _mysql_sandbox_port2 +
+      _path_splitter +
+      "sandboxdata) detected as local sandbox. "
+      "Sandbox instances are only suitable for deploying and "
+      "running on your local machine for testing purposes and are not "
+      "accessible from external networks."};
+  MY_EXPECT_LOG_CONTAINS(log);
 }
 
 TEST_F(Shell_js_dba_tests, dba_cluster_remove_instance) {

unittest/test_utils.cc

@@ -262,12 +262,6 @@ void Shell_core_test_wrapper::SetUp() {
   set_options();
   output_handler.debug = debug;
 
-#ifdef _WIN32
-  std::string _path_splitter = "\\";
-#else
-  std::string _path_splitter = "/";
-#endif
-
   // Initializes the interactive shell
   reset_shell();
 

unittest/test_utils/admin_api_test.cc

@@ -23,16 +23,6 @@
 namespace tests {
 void Admin_api_test::SetUp() {
   Shell_core_test_wrapper::SetUp();
-
-  std::vector<std::string> path_components = {_sandbox_dir,
-    _mysql_sandbox_port1, "my.cnf"};
-  _sandbox_cnf_1 = shcore::join_strings(path_components, _path_splitter);
-
-  path_components[1] = _mysql_sandbox_port2;
-  _sandbox_cnf_2 = shcore::join_strings(path_components, _path_splitter);
-
-  path_components[1] = _mysql_sandbox_port3;
-  _sandbox_cnf_3 = shcore::join_strings(path_components, _path_splitter);
 }
 
 void Admin_api_test::add_instance_type_queries

unittest/test_utils/shell_base_test.cc

@@ -25,6 +25,12 @@ namespace tests {
 
 void Shell_base_test::SetUp() {
   const char *uri = getenv("MYSQL_URI");
+#ifdef _WIN32
+  _path_splitter = "\\";
+#else
+  _path_splitter = "/";
+#endif
+
   if (uri) {
     // Creates connection data and recreates URI, this will fix URI if no
     // password is defined So the UT don't prompt for password ever
@@ -95,6 +101,16 @@ void Shell_base_test::SetUp() {
     }
   }
 
+  std::vector<std::string> path_components = {_sandbox_dir,
+                                              _mysql_sandbox_port1, "my.cnf"};
+  _sandbox_cnf_1 = shcore::join_strings(path_components, _path_splitter);
+
+  path_components[1] = _mysql_sandbox_port2;
+  _sandbox_cnf_2 = shcore::join_strings(path_components, _path_splitter);
+
+  path_components[1] = _mysql_sandbox_port3;
+  _sandbox_cnf_3 = shcore::join_strings(path_components, _path_splitter);
+
   _new_line_char = "\n";
 #ifdef WIN32
   _new_line_char = "\r\n";