BUG#35830920 mysqlsh util.loadDump should exclude the same tables as util.dumpInstance

When loading (or copying) a dump, and the target is an MHS instance,
mysql_audit and mysql_firewall schemas are automatically excluded,

Change-Id: Iabdbe2a8d08bc4ba72e47a096c4456b522dd457f
(cherry picked from commit 9ae5b4c82491bcdf402f5acf8421b3e6c5a6f560)

Author: Paweł Andruszkiewicz

modules/util/common/dump/constants.h

@@ -0,0 +1,61 @@
+/*
+ * Copyright (c) 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,
+ * as published by the Free Software Foundation.
+ *
+ * This program is also distributed with certain software (including
+ * but not limited to OpenSSL) that is licensed under separate terms, as
+ * designated in a particular file or component or in included license
+ * documentation.  The authors of MySQL hereby grant you an additional
+ * permission to link the program and your derivative works with the
+ * separately licensed software that they have included with MySQL.
+ * This program is distributed in the hope that it will be useful,  but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See
+ * the GNU General Public License, version 2.0, for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+ */
+
+#ifndef MODULES_UTIL_COMMON_DUMP_CONSTANTS_H_
+#define MODULES_UTIL_COMMON_DUMP_CONSTANTS_H_
+
+#include <array>
+
+namespace mysqlsh {
+namespace dump {
+namespace common {
+
+constexpr inline std::array k_excluded_users = {
+    "mysql.infoschema",
+    "mysql.session",
+    "mysql.sys",
+};
+
+constexpr inline std::array k_mhs_excluded_users = {
+    "administrator",
+    "ociadmin",
+    "ocimonitor",
+    "ocirpl",
+};
+
+constexpr inline std::array k_excluded_schemas = {
+    "information_schema", "mysql", "ndbinfo", "performance_schema", "sys",
+};
+
+constexpr inline std::array k_mhs_excluded_schemas = {
+    // stores the audit plugin's configuration
+    "mysql_audit",
+    // stores the firewall's configuration
+    "mysql_firewall",
+};
+
+}  // namespace common
+}  // namespace dump
+}  // namespace mysqlsh
+
+#endif  // MODULES_UTIL_COMMON_DUMP_CONSTANTS_H_

modules/util/dump/dump_instance_options.cc

@@ -26,6 +26,7 @@
 #include <utility>
 #include <vector>
 
+#include "modules/util/common/dump/constants.h"
 #include "modules/util/common/dump/utils.h"
 
 #include "mysqlshdk/include/scripting/type_info/custom.h"
@@ -35,22 +36,12 @@
 namespace mysqlsh {
 namespace dump {
 
-namespace {
-
-const char *k_excluded_users[] = {"mysql.infoschema", "mysql.session",
-                                  "mysql.sys"};
-
-const char *k_excluded_schemas[] = {"information_schema", "mysql", "ndbinfo",
-                                    "performance_schema", "sys"};
-
-}  // namespace
-
 Dump_instance_options::Dump_instance_options() {
   // some users are always excluded
-  filters().users().exclude(k_excluded_users);
+  filters().users().exclude(common::k_excluded_users);
 
   // some schemas are always excluded
-  filters().schemas().exclude(k_excluded_schemas);
+  filters().schemas().exclude(common::k_excluded_schemas);
 }
 
 const shcore::Option_pack_def<Dump_instance_options>
@@ -71,8 +62,7 @@ const shcore::Option_pack_def<Dump_instance_options>
 
 void Dump_instance_options::on_unpacked_options() {
   if (!m_dump_users) {
-    if (filters().users().excluded().size() >
-        shcore::array_size(k_excluded_users)) {
+    if (filters().users().excluded().size() > common::k_excluded_users.size()) {
       throw std::invalid_argument(
           "The 'excludeUsers' option cannot be used if the 'users' option is "
           "set to false.");
@@ -86,13 +76,9 @@ void Dump_instance_options::on_unpacked_options() {
   }
 
   if (mds_compatibility()) {
-    auto &schemas = filters().schemas();
-    // if MDS compatibility option is set, the following schemas should be
-    // excluded automatically:
-    //  - stores the audit plugin's configuration
-    schemas.exclude("mysql_audit");
-    //  - stores the firewall's configuration
-    schemas.exclude("mysql_firewall");
+    // if MHS compatibility option is set, some schemas should be excluded
+    // automatically
+    filters().schemas().exclude(common::k_mhs_excluded_schemas);
   }
 
   m_filter_conflicts |= filters().schemas().error_on_conflicts();

modules/util/load/load_dump_options.cc

@@ -31,6 +31,7 @@
 #include <utility>
 
 #include "modules/mod_utils.h"
+#include "modules/util/common/dump/constants.h"
 #include "modules/util/common/dump/utils.h"
 #include "modules/util/dump/dump_manifest_config.h"
 #include "modules/util/load/load_errors.h"
@@ -51,11 +52,6 @@ namespace {
 
 using Version = mysqlshdk::utils::Version;
 
-const char *k_excluded_users[] = {"mysql.infoschema", "mysql.session",
-                                  "mysql.sys"};
-const char *k_oci_excluded_users[] = {"administrator", "ociadmin", "ocimonitor",
-                                      "ocirpl"};
-
 constexpr auto k_minimum_max_bytes_per_transaction = 4096;
 
 }  // namespace
@@ -247,10 +243,10 @@ void Load_dump_options::set_session(
 
   if (m_load_users) {
     // some users are always excluded
-    filters().users().exclude(k_excluded_users);
+    filters().users().exclude(dump::common::k_excluded_users);
 
     if (is_mds()) {
-      filters().users().exclude(k_oci_excluded_users);
+      filters().users().exclude(dump::common::k_mhs_excluded_users);
     }
 
     shcore::Account account;
@@ -260,6 +256,10 @@ void Load_dump_options::set_session(
     filters().users().exclude(std::move(account));
   }
 
+  if (is_mds()) {
+    filters().schemas().exclude(dump::common::k_mhs_excluded_schemas);
+  }
+
   if (m_target_server_version >= Version(8, 0, 27)) {
     // adding indexes in parallel was added in 8.0.27,
     // innodb_parallel_read_threads threads are used during the first stage,

unittest/scripts/auto/py_shell/scripts/util_dump_and_load_norecord.py

@@ -3043,6 +3043,41 @@ def TEST_BOOL_OPTION(option):
 shell.connect(__sandbox_uri1)
 session.run_sql("DROP SCHEMA IF EXISTS !;", [schema_name])
 
+#@<> BUG#35830920 mysql_audit and mysql_firewall schemas should be automatically excluded when loading a dump into MHS - setup {not __dbug_off}
+# create schemas
+schema_names = [ "mysql_audit", "mysql_firewall" ]
+
+def create_mhs_schemas(s):
+    for schema_name in schema_names:
+        s.run_sql("DROP SCHEMA IF EXISTS !", [schema_name])
+        s.run_sql("CREATE SCHEMA !", [schema_name])
+        s.run_sql("CREATE TABLE !.! (a int)", [schema_name, "test_table"])
+
+create_mhs_schemas(session1)
+wipeout_server(session2)
+create_mhs_schemas(session2)
+
+# create a MHS-compatible dump but without 'ocimds' option
+shell.connect(__sandbox_uri1)
+dump_dir = os.path.join(outdir, "bug_35830920")
+EXPECT_NO_THROWS(lambda: util.dump_schemas(schema_names, dump_dir, { "ddlOnly": True, "showProgress": False }), "Dumping the instance should not fail")
+
+#@<> BUG#35830920 - test {not __dbug_off}
+shell.connect(__sandbox_uri2)
+
+# loading into non-MHS should fail, because schemas already exist
+EXPECT_THROWS(lambda: util.load_dump(dump_dir, { "showProgress": False }), "Duplicate objects found in destination database")
+testutil.rmfile(os.path.join(dump_dir, "load-progress*.json"))
+
+# loading into MHS should automatically exclude the schemas and operation should succeed
+testutil.dbug_set("+d,dump_loader_force_mds")
+EXPECT_NO_THROWS(lambda: util.load_dump(dump_dir, { "ignoreVersion": True, "showProgress": False }), "Loading should not fail")
+testutil.dbug_set("")
+
+#@<> BUG#35830920 - cleanup {not __dbug_off}
+for schema_name in schema_names:
+    session.run_sql("DROP SCHEMA !;", [schema_name])
+
 #@<> Cleanup
 testutil.destroy_sandbox(__mysql_sandbox_port1)
 testutil.destroy_sandbox(__mysql_sandbox_port2)