scripts/cross-test-ssh.sh

   1 #!/bin/bash
   2 # Run a testcase on a remote system, via ssh.
   3 # Copyright (C) 2012-2024 Free Software Foundation, Inc.
   4 # This file is part of the GNU C Library.
   5
   6 # The GNU C Library is free software; you can redistribute it and/or
   7 # modify it under the terms of the GNU Lesser General Public
   8 # License as published by the Free Software Foundation; either
   9 # version 2.1 of the License, or (at your option) any later version.
  10
  11 # The GNU C Library is distributed in the hope that it will be useful,
  12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 # Lesser General Public License for more details.
  15
  16 # You should have received a copy of the GNU Lesser General Public
  17 # License along with the GNU C Library; if not, see
  18 # <https://www.gnu.org/licenses/>.
  19
  20 # usage: cross-test-ssh.sh [--ssh SSH] HOST COMMAND ...
  21 # Run with --help flag to get more detailed help.
  22
  23 progname="$(basename $0)"
  24
  25 usage="usage: ${progname} [--ssh SSH] [--allow-time-setting] HOST COMMAND ..."
  26 help="Run a glibc test COMMAND on the remote machine HOST, via ssh,
  27 preserving the current working directory, and respecting quoting.
  28
  29 If the '--ssh SSH' flag is present, use SSH as the SSH command,
  30 instead of ordinary 'ssh'.
  31
  32 If the '--timeoutfactor FACTOR' flag is present, set TIMEOUTFACTOR on
  33 the remote machine to the specified FACTOR.
  34
  35 If the '--allow-time-setting' flag is present, set
  36 GLIBC_TEST_ALLOW_TIME_SETTING on the remote machine to indicate that
  37 time can be safely adjusted (e.g. on a virtual machine).
  38
  39 To use this to run glibc tests, invoke the tests as follows:
  40
  41   $ make test-wrapper='ABSPATH/cross-test-ssh.sh HOST' tests
  42
  43 where ABSPATH is the absolute path to this script, and HOST is the
  44 name of the machine to connect to via ssh.
  45
  46 If you need to connect to the test machine as a different user, you
  47 may specify that just as you would to SSH:
  48
  49   $ make test-wrapper='ABSPATH/cross-test-ssh.sh USER@HOST' tests
  50
  51 Naturally, the remote user must have an appropriate public key, and
  52 you will want to ensure that SSH does not prompt interactively for a
  53 password on each connection.
  54
  55 HOST and the build machines (on which 'make check' is being run) must
  56 share a filesystem; all files needed by the tests must be visible at
  57 the same paths on both machines.
  58
  59 ${progname} runs COMMAND in the same directory on the HOST that
  60 ${progname} itself is run in on the build machine.
  61
  62 The command and arguments are passed to the remote host in a way that
  63 avoids any further shell substitution or expansion, on the assumption
  64 that the shell on the build machine has already done them
  65 appropriately."
  66
  67 ssh='ssh'
  68 timeoutfactor=$TIMEOUTFACTOR
  69 while [ $# -gt 0 ]; do
  70   case "$1" in
  71
  72     "--ssh")
  73       shift
  74       if [ $# -lt 1 ]; then
  75         break
  76       fi
  77       ssh="$1"
  78       ;;
  79
  80     "--timeoutfactor")
  81       shift
  82       if [ $# -lt 1 ]; then
  83         break
  84       fi
  85       timeoutfactor="$1"
  86       ;;
  87
  88     "--allow-time-setting")
  89       settimeallowed="1"
  90       ;;
  91
  92     "--help")
  93       echo "$usage"
  94       echo "$help"
  95       exit 0
  96       ;;
  97
  98     *)
  99       break
 100       ;;
 101   esac
 102   shift
 103 done
 104
 105 if [ $# -lt 1 ]; then
 106   echo "$usage" >&2
 107   echo "Type '${progname} --help' for more detailed help." >&2
 108   exit 1
 109 fi
 110
 111 host="$1"; shift
 112
 113 # Print the sequence of arguments as strings properly quoted for the
 114 # Bourne shell, separated by spaces.
 115 bourne_quote ()
 116 {
 117   local arg qarg
 118   for arg in "$@"; do
 119     qarg=${arg//\'/\'\\\'\'}
 120     echo -n "'$qarg' "
 121   done
 122 }
 123
 124 # Transform the current argument list into a properly quoted Bourne shell
 125 # command string.
 126 command="$(bourne_quote "$@")"
 127
 128 # Add command to set the current directory.
 129 command="cd $(bourne_quote "$PWD")
 130 ${command}"
 131
 132 # Add command to set the timeout factor, if required.
 133 if [ "$timeoutfactor" ]; then
 134   command="export TIMEOUTFACTOR=$(bourne_quote "$timeoutfactor")
 135 ${command}"
 136 fi
 137
 138 # Add command to set the info that time on target can be adjusted,
 139 # if required.
 140 # Serialize execution of this script on target to prevent from unintended
 141 # change of target time.
 142 FLOCK_PATH="${FLOCK_PATH:-/var/lock/clock_settime}"
 143 FLOCK_TIMEOUT="${FLOCK_TIMEOUT:-20}"
 144 FLOCK_FD="${FLOCK_FD:-99}"
 145 if [ "$settimeallowed" ]; then
 146   command="exec ${FLOCK_FD}<>${FLOCK_PATH}
 147 flock -w ${FLOCK_TIMEOUT} ${FLOCK_FD}
 148 if [ $? -ne 0 ]; then exit 1; fi
 149 export GLIBC_TEST_ALLOW_TIME_SETTING=1
 150 ${command}"
 151 fi
 152
 153 # HOST's sshd simply concatenates its arguments with spaces and
 154 # passes them to some shell.  We want to force the use of /bin/sh,
 155 # so we need to re-quote the whole command to ensure it appears as
 156 # the sole argument of the '-c' option.
 157 full_command="$(bourne_quote "${command}")"
 158 $ssh "$host" /bin/sh -c "$full_command"