MDEV-18565: Galera mtr-suite fails if galera library is not installed (…

…#1243)

* MDEV-18565: Galera mtr-suite fails if galera library is not installed

Currently, running mtr with an incorrect (for example, new or
obsolete) version of wsrep_provider (for example, with the 26
version of libgalera_smm.so) leads to the failure of tests in
several suites with vague error diagnostics.

As for the galera_3nodes suite, the mtr also does not effectively
check all the prerequisites after merge with MDEV-18426 fixes.
For example, tests that using mariabackup do not check for presence
of ss and socat/nc. This is due to improper handling of relative
paths in mtr scripts.

In addition, some tests in different suites can be run without
setting the environment variables such as MTR_GALERA_TFMT, XBSTREAM,
and so on.

To eliminate all these issues, this patch makes the following changes:

1. Added auxiliary wsrep_mtr_check utility (which located in the
mysql-test/lib/My/SafeProcess subdirectory), which compares the
versions of the wsrep API that used by the server and by the wsrep
provider library, and it does this comparison safely, without
accessing the API if the versions do not match.

2. All checks related to the presence of mariabackup and utilities
that necessary for its operation transferred from the local directories
of different mtr suites (from the suite.pm files) to the main suite.pm
file. This not only reduces the amount of code and eliminates duplication
of identical code fragments, but also avoids problems due to the inability
of mtr to consider relative paths to include files when checking skip
combinations.

3. Setting the values of auxiliary environment variables that
are necessary for Galera, SST scripts and mariabackup (to work
properly) is moved to the main mysql-test-run.pl script, so as
not to duplicate this code in different suites, and to avoid
partial corrections of the same errors for different suites
(while other suites remain uncorrected).

4. Fixed duplication of the have_file_key_management.inc and
have_filekeymanagement.inc files between different suites,
these checks are also transferred to the top level.

https://jira.mariadb.org/browse/MDEV-18565

* Build without additional utility in configurations without wsrep support

mysql-test/include/have_mariabackup.inc

@@ -0,0 +1,4 @@
+#
+# suite.pm will make sure that all tests including this file
+# will be skipped as needed
+#

mysql-test/lib/My/SafeProcess.pm

@@ -100,6 +100,8 @@ else
   $bindir = getcwd();
 }
 
+our $wsrep_check_version;
+
 # Find the safe process binary or script
 sub find_bin {
   if (IS_WIN32PERL or IS_CYGWIN)
@@ -119,6 +121,10 @@ sub find_bin {
 			 "my_safe_process");
     push(@safe_process_cmd, $exe);
   }
+  # Wsrep version check utility:
+  $wsrep_check_version=
+    my_find_bin($bindir, "lib/My/SafeProcess", "wsrep_check_version",
+                NOT_REQUIRED);
 }
 
 

mysql-test/lib/My/SafeProcess/CMakeLists.txt

@@ -14,14 +14,19 @@
 # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1335 USA
 
 
- IF (WIN32)
+IF (WIN32)
   ADD_EXECUTABLE(my_safe_process safe_process_win.cc)
   ADD_EXECUTABLE(my_safe_kill safe_kill_win.cc)
   TARGET_LINK_LIBRARIES(my_safe_kill dbghelp psapi)
 ELSE()
   ADD_EXECUTABLE(my_safe_process safe_process.cc)
 ENDIF()
 
+IF(WITH_WSREP)
+  ADD_EXECUTABLE(wsrep_check_version wsrep_check_version.c)
+  TARGET_LINK_LIBRARIES(wsrep_check_version ${LIBDL})
+ENDIF()
+
 IF(NOT INSTALL_MYSQLTESTDIR)
   RETURN()
 ENDIF()

mysql-test/lib/My/SafeProcess/wsrep_check_version.c

@@ -0,0 +1,123 @@
+/* Copyright (c) 2009, 2019, MariaDB
+
+   This program is free software; you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation; version 2 of the License.
+
+   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 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 Street, Fifth Floor, Boston, MA 02111-1301 USA
+ */
+
+#include <stdlib.h>
+#include <stdio.h>
+#include <string.h>
+#include <errno.h>
+
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
+#ifdef _WIN32
+#include <windows.h>
+#define dlsym(lib, name) GetProcAddress((HMODULE)lib, name)
+#define dlopen(libname, unused) LoadLibraryEx(libname, NULL, 0)
+#define dlclose(lib) FreeLibrary((HMODULE)lib)
+#elif defined(HAVE_DLFCN_H)
+#include <dlfcn.h>
+#else
+#define NO_DLL
+#endif
+
+#ifndef NO_DLL
+
+#include "../../../../wsrep/wsrep_api.h"
+
+/**************************************************************************
+ * Library loader
+ **************************************************************************/
+
+static int wsrep_check_iface_version(const char *found, const char *iface_ver)
+{
+    if (strcmp(found, iface_ver)) {
+        return ERANGE;
+    }
+    return 0;
+}
+
+typedef int (*wsrep_loader_fun)(wsrep_t*);
+
+static wsrep_loader_fun wsrep_dlf(void *dlh, const char *sym)
+{
+    union {
+        wsrep_loader_fun dlfun;
+        void *obj;
+    } alias;
+    alias.obj = dlsym(dlh, sym);
+    return alias.dlfun;
+}
+
+static int wsrep_check_version_symbol(void *dlh)
+{
+    char** dlversion = NULL;
+    dlversion = (char**) dlsym(dlh, "wsrep_interface_version");
+    if (dlversion == NULL)
+        return EINVAL;
+    return wsrep_check_iface_version(*dlversion, WSREP_INTERFACE_VERSION);
+}
+
+static int wsrep_print_version(void *dlh)
+{
+    char** dlversion = NULL;
+    dlversion = (char**) dlsym(dlh, "wsrep_interface_version");
+    if (dlversion == NULL)
+        return EINVAL;
+    printf("found: %s, need: %s\n", *dlversion, WSREP_INTERFACE_VERSION);
+    return 0;
+}
+
+int main(int argc, char **argv)
+{
+    int rc = EINVAL;
+    void *dlh;
+    wsrep_loader_fun dlfun;
+
+    if (!(dlh = dlopen(getenv("WSREP_PROVIDER"), RTLD_NOW | RTLD_LOCAL))) {
+       goto err;
+    }
+
+    if (!(dlfun = wsrep_dlf(dlh, "wsrep_loader"))) {
+       goto err;
+    }
+
+    if (argc < 2 || strcmp(argv[1], "-p")) {
+        rc = wsrep_check_version_symbol(dlh);
+    }
+    else {
+        rc = wsrep_print_version(dlh);
+    }
+
+err:
+    if (dlh) dlclose(dlh);
+
+    if (rc == 0)
+        return 0;
+    else if (rc == ERANGE)
+        return 2;
+    else
+        return 1;
+}
+
+#else
+
+int main(void)
+{
+    return 1;
+}
+
+#endif

mysql-test/mysql-test-run.pl

@@ -137,6 +137,10 @@ BEGIN
 my $opt_start_exit;
 my $start_only;
 my $file_wsrep_provider;
+my $extra_path;
+my $mariabackup_path;
+my $mariabackup_exe;
+my $garbd_exe;
 
 our @global_suppressions;
 
@@ -369,6 +373,147 @@ ($)
 
 main();
 
+sub have_wsrep() {
+  my $wsrep_on= $mysqld_variables{'wsrep-on'};
+  return defined $wsrep_on
+}
+
+sub have_wsrep_provider() {
+  return $file_wsrep_provider ne "";
+}
+
+sub have_mariabackup() {
+  return $mariabackup_path ne "";
+}
+
+sub have_garbd() {
+  return $garbd_exe ne "";
+}
+
+sub check_wsrep_version() {
+  if ($My::SafeProcess::wsrep_check_version ne "") {
+    system($My::SafeProcess::wsrep_check_version);
+    return ($? >> 8) == 0;
+  }
+  else {
+    return 0;
+  }
+}
+
+sub wsrep_version_message() {
+  my $output= `$My::SafeProcess::wsrep_check_version -p`;
+  $output =~ s/\s+\z//;
+  return "Wsrep provider version mismatch (".$output.")";
+}
+
+sub which($) { return `sh -c "command -v $_[0]"` }
+
+sub check_garbd_support() {
+  if (defined $ENV{'MTR_GARBD_EXE'}) {
+    if (mtr_file_exists($ENV{'MTR_GARBD_EXE'}) ne "") {
+      $garbd_exe= $ENV{'MTR_GARBD_EXE'};
+    } else {
+      mtr_error("MTR_GARBD_EXE env set to an invalid path");
+    }
+  }
+  else {
+    my $wsrep_path= dirname($file_wsrep_provider);
+    $garbd_exe=
+      mtr_file_exists($wsrep_path."/garb/garbd",
+                      $wsrep_path."/../../bin/garb/garbd");
+    if ($garbd_exe ne "") {
+      $ENV{MTR_GARBD_EXE}= $garbd_exe;
+    }
+  }
+}
+
+sub check_wsrep_support() {
+  if (have_wsrep()) {
+    mtr_report(" - binaries built with wsrep patch");
+
+    # ADD scripts to $PATH to that wsrep_sst_* can be found
+    my ($spath) = grep { -f "$_/wsrep_sst_rsync"; } "$bindir/scripts", $path_client_bindir;
+    mtr_error("No SST scripts") unless $spath;
+    $ENV{PATH}="$spath:$ENV{PATH}";
+
+    # ADD mysql client library path to path so that wsrep_notify_cmd can find mysql
+    # client for loading the tables. (Don't assume each machine has mysql install)
+    my ($cpath) = grep { -f "$_/mysql"; } "$bindir/scripts", $path_client_bindir;
+    mtr_error("No scritps") unless $cpath;
+    $ENV{PATH}="$cpath:$ENV{PATH}" unless $cpath eq $spath;
+
+    # ADD my_print_defaults script path to path so that SST scripts can find it
+    my ($epath) = grep { -f "$_/my_print_defaults"; } "$bindir/extra", $path_client_bindir;
+    mtr_error("No my_print_defaults") unless $epath;
+    $ENV{PATH}="$epath:$ENV{PATH}" unless ($epath eq $spath) or
+                                          ($epath eq $cpath);
+
+    $extra_path= $epath;
+
+    if (which("socat")) {
+      $ENV{MTR_GALERA_TFMT}="socat";
+    } elsif (which("nc")) {
+      $ENV{MTR_GALERA_TFMT}="nc";
+    }
+
+    # Check whether WSREP_PROVIDER environment variable is set.
+    if (defined $ENV{'WSREP_PROVIDER'}) {
+      $file_wsrep_provider= "";
+      if ($ENV{'WSREP_PROVIDER'} ne "none") {
+        if (mtr_file_exists($ENV{'WSREP_PROVIDER'}) ne "") {
+          $file_wsrep_provider= $ENV{'WSREP_PROVIDER'};
+        } else {
+          mtr_error("WSREP_PROVIDER env set to an invalid path");
+        }
+        check_garbd_support();
+      }
+      # WSREP_PROVIDER is valid; set to a valid path or "none").
+      mtr_verbose("WSREP_PROVIDER env set to $ENV{'WSREP_PROVIDER'}");
+    } else {
+      # WSREP_PROVIDER env not defined. Lets try to locate the wsrep provider
+      # library.
+      $file_wsrep_provider=
+        mtr_file_exists("/usr/lib64/galera-3/libgalera_smm.so",
+                        "/usr/lib64/galera/libgalera_smm.so",
+                        "/usr/lib/galera-3/libgalera_smm.so",
+                        "/usr/lib/galera/libgalera_smm.so");
+      if ($file_wsrep_provider ne "") {
+        # wsrep provider library found !
+        mtr_verbose("wsrep provider library found : $file_wsrep_provider");
+        $ENV{'WSREP_PROVIDER'}= $file_wsrep_provider;
+        check_garbd_support();
+      } else {
+        mtr_verbose("Could not find wsrep provider library, setting it to 'none'");
+        $ENV{'WSREP_PROVIDER'}= "none";
+      }
+    }
+  } else {
+    $file_wsrep_provider= "";
+    $extra_path= "";
+  }
+}
+
+sub check_mariabackup_support() {
+  $mariabackup_path= "";
+  $mariabackup_exe=
+    mtr_exe_maybe_exists(
+      "$bindir/extra/mariabackup$opt_vs_config/mariabackup",
+      "$path_client_bindir/mariabackup");
+  if ($mariabackup_exe ne "") {
+    my ($bpath) = grep { -f "$_/mariabackup"; } "$bindir/extra/mariabackup$opt_vs_config", $path_client_bindir;
+    $ENV{PATH}="$bpath:$ENV{PATH}" unless $bpath eq $extra_path;
+
+    $mariabackup_path= $bpath;
+
+    $ENV{XTRABACKUP}= $mariabackup_exe;
+
+    $ENV{XBSTREAM}= mtr_exe_maybe_exists(
+      "$bindir/extra/mariabackup/$opt_vs_config/mbstream",
+      "$path_client_bindir/mbstream");
+
+    $ENV{INNOBACKUPEX}= "$mariabackup_exe --innobackupex";
+  }
+}
 
 sub main {
   $ENV{MTR_PERL}=$^X;
@@ -414,6 +559,8 @@ sub main {
   }
   check_ssl_support();
   check_debug_support();
+  check_wsrep_support();
+  check_mariabackup_support();
 
   if (!$opt_suites) {
     $opt_suites= join ',', collect_default_suites(@DEFAULT_SUITES);

mysql-test/suite.pm

@@ -51,6 +51,21 @@ sub skip_combinations {
   $skip{'main/plugin_loaderr.test'} = 'needs compiled-in innodb'
             unless $::mysqld_variables{'innodb'} eq "ON";
 
+  $skip{'include/have_mariabackup.inc'} = 'Need mariabackup'
+            unless ::have_mariabackup();
+
+  $skip{'include/have_mariabackup.inc'} = 'Need ss'
+            unless ::which("ss");
+
+  $skip{'include/have_mariabackup.inc'} = 'Need socat or nc'
+            unless $ENV{MTR_GALERA_TFMT};
+
+  $skip{'include/have_garbd.inc'} = 'Need garbd'
+            unless ::have_garbd();
+
+  $skip{'include/have_file_key_management.inc'} = 'Needs file_key_management plugin'
+            unless $ENV{FILE_KEY_MANAGEMENT_SO};
+
   # disable tests that use ipv6, if unsupported
   sub ipv6_ok() {
     use Socket;