3 #########################################################################
4 # This program is free software: you can redistribute it and/or modify #
5 # it under the terms of the version 3 of the GNU General Public License #
6 # as published by the Free Software Foundation. #
8 # This program is distributed in the hope that it will be useful, but #
9 # WITHOUT ANY WARRANTY; without even the implied warranty of #
10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU #
11 # General Public License for more details. #
13 # You should have received a copy of the GNU General Public License #
14 # along with this program. If not, see <http://www.gnu.org/licenses/>. #
16 # Written by and Copyright (C) Francois Fleuret #
17 # Contact <francois@fleuret.org> for comments & bug reports #
18 #########################################################################
24 ######################################################################
26 function check_remote_is_defined () {
27 if [[ "${REMOTE_HOST}" ]] && [[ "${REMOTE_DIR}" ]]
31 echo "@XREMOTE_HOST should come first." >&2
38 xremote.sh [--help] [-h <remote_host>] [-i <remote_dir>] <script> [script arguments]
40 This script takes a script as argument and executes it remotely in a
41 temporary directory on a ssh-accessible server.
43 It parses the script first to find embedded arguments which define
44 the hostname on which to run, the files to send, the files to get
45 back when the execution is over, and commands to execute before
46 running the executable remotely.
48 These arguments can appear multiple times, except the one that
49 specifies the remote host.
53 @XREMOTE_HOST: elk.fleuret.org
54 @XREMOTE_EXEC: python3
55 @XREMOTE_SEND: main.cf
57 @XREMOTE_PRE: ln -s /home/fleuret/data/pytorch ./data
59 If a file with the same name as the script with the .xremote
60 extension appended to it exists, arguments will be read from it by
63 If the -h option is provided @XREMOTE_HOST is ignored.
65 If the -i option is provided, all the files are installed and
66 scripts run in the specified directory on the remote host, but the
67 main executable and post-run commands are ignored
69 If no argument is provided to @XREMOTE_HOST, and the -h option is
70 not specified, the environment variable \$XREMOTE_HOST is used
73 Contact <francois@fleuret.org> for comments.
79 function cleanup_remote_tmp () {
80 if [[ "${REMOTE_HOST}" ]] && [[ "${REMOTE_DIR}" ]] && [[ ! "${ARG_DIR}" ]]
82 echo "xremote: Clean up remote workdir."
86 ######################################################################
88 while [[ "$1" =~ ^- ]]
95 [[ ${ARG_HOST} ]] || (echo "xremote: Hostname missing." && exit 1)
96 echo "xremote: remote forced to ${ARG_HOST}"
102 [[ ${ARG_DIR} ]] || (echo "xremote: Directory missing." && exit 1)
103 echo "xremote: remote dir set to ${ARG_DIR}"
112 echo "xremote: Unknown option $1"
119 ######################################################################
121 [[ "$1" ]] || (echo "xremote: Script name missing" && exit 1)
123 [[ -a "$1" ]] || (help && echo >&2 "xremote: Cannot find script \`$1'" && exit 1)
127 main="$(basename "$1")"
128 main_config="${main}.xremote"
130 if [[ -f "${main_config}" ]]
132 echo "xremote: found ${main_config}"
134 main_config="${main}"
139 trap cleanup_remote_tmp EXIT
141 ######################################################################
146 if [[ "${line}" =~ '@XREMOTE' ]]
149 label=$(echo "${line}" | sed -e 's/^.*@XREMOTE_\([^:]*\):.*$/\1/')
150 value=$(echo "${line}" | sed -e 's/^.*@XREMOTE_[^:]*: *\(.*\)$/\1/')
155 check_remote_is_defined
156 [[ "${REMOTE_EXEC}" ]] && (exit "Remote executable already defined!" >&2 && exit 1)
157 REMOTE_EXEC="${value}"
161 check_remote_is_defined
162 echo "xremote: ${value}"
163 ssh < /dev/null "${REMOTE_HOST}" "cd \"${REMOTE_DIR}\" && ${value}"
167 check_remote_is_defined
168 echo "xremote: -- sending files --------------------------------------------"
169 tar ch ${value} | ssh "${REMOTE_HOST}" "cd \"${REMOTE_DIR}\" && tar mxv"
173 [[ "${REMOTE_DIR}" ]] && (exit "Remote host already defined!" >&2 && exit 1)
174 REMOTE_HOST="${ARG_HOST}" # Host given in argument has priority
175 [[ "${REMOTE_HOST}" ]] || REMOTE_HOST="${value}"
176 [[ "${REMOTE_HOST}" ]] || REMOTE_HOST="${XREMOTE_HOST}"
177 [[ "${REMOTE_HOST}" ]] || (echo "xremote: No remote host specified." >&2 && exit 1)
178 if [[ "${ARG_DIR}" ]]
180 ssh </dev/null "${REMOTE_HOST}" "mkdir -p \"${ARG_DIR}\""
181 REMOTE_DIR="${ARG_DIR}"
183 REMOTE_DIR="$(ssh </dev/null "${REMOTE_HOST}" mktemp -d /tmp/xremote_\$\(whoami\)_from_"$(hostname)_$(date +%Y%m%d_%H%M%S)".XXXXXX)"
185 echo "xremote: target is ${REMOTE_HOST}"
190 done < "${main_config}"
192 ######################################################################
194 check_remote_is_defined
196 tar c "${main}" | ssh "${REMOTE_HOST}" "cd \"${REMOTE_DIR}\" && tar mx"
198 if [[ "${ARG_DIR}" ]]
200 echo "xremote: everything has been set up in ${REMOTE_HOST}:${ARG_DIR}"
204 echo "xremote: -- running the executable -----------------------------------"
206 if [[ "${REMOTE_EXEC}" ]]
208 REMOTE_COMMAND="${REMOTE_EXEC} ${main}"
210 REMOTE_COMMAND="./${main}"
213 ######################################################################
215 # I find this slightly ugly ...
219 quoted_args="${quoted_args} \"${s}\""
222 ssh </dev/null "${REMOTE_HOST}" "cd \"${REMOTE_DIR}\" && ${REMOTE_COMMAND} ${quoted_args}"
224 ######################################################################
226 # Disable globbing to keep wildcards for the remote side
228 echo "xremote: -- retrieving files -----------------------------------------"
234 if [[ "${line}" =~ '@XREMOTE' ]]
236 label=$(echo "${line}" | sed -e 's/^.*@XREMOTE_\([^:]*\):.*$/\1/')
237 value=$(echo "${line}" | sed -e 's/^.*@XREMOTE_[^:]*: *\(.*\)$/\1/')
240 check_remote_is_defined
241 echo "xremote: ${value}"
242 ssh < /dev/null "${REMOTE_HOST}" "cd \"${REMOTE_DIR}\" && ${value}"
246 check_remote_is_defined
247 ssh </dev/null "${REMOTE_HOST}" "cd \"${REMOTE_DIR}\" && tar 2>/dev/null c ${value}" | tar mxv
252 done < "${main_config}"
256 echo "xremote: -- finished -------------------------------------------------"
258 ######################################################################