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>] [-d <remote_dir>] [-r <local_result_dir>] [-i] <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 -d option is provided, the provided directory is used and
66 kept, instead of a temporary one
68 If the -i option is provided, all the files are installed and
69 scripts run in the specified directory on the remote host, but the
70 main executable and post-run commands are ignored
72 If the -r option is provided, the result files specified with
73 @XREMOTE_GET will be downloaded there instead of the current
76 If no argument is provided to @XREMOTE_HOST, and the -h option is
77 not specified, the environment variable \$XREMOTE_HOST is used
80 Contact <francois@fleuret.org> for comments.
86 function cleanup_remote_tmp () {
87 if [[ "${REMOTE_HOST}" ]] && [[ "${REMOTE_DIR}" ]]
91 echo "xremote: Keeping remote workdir."
93 echo "xremote: Cleaning up temporary remote workdir."
94 ssh "${REMOTE_HOST}" rm -rf "${REMOTE_DIR}"
99 ######################################################################
101 while [[ "$1" =~ ^- ]]
108 [[ ${ARG_HOST} ]] || (echo "xremote: Hostname missing." && exit 1)
109 echo "xremote: remote forced to ${ARG_HOST}"
115 [[ ${ARG_DIR} ]] || (echo "xremote: Directory missing." && exit 1)
116 echo "xremote: remote dir set to ${ARG_DIR}"
121 echo "xremote: no run"
127 [[ ${ARG_RESULT_DIR} ]] || (echo "xremote: Directory missing." && exit 1)
128 echo "xremote: result dir set to ${ARG_RESULT_DIR}"
137 echo "xremote: Unknown option $1"
144 ######################################################################
146 [[ "$1" ]] || (echo "xremote: Script name missing" && exit 1)
148 [[ -a "$1" ]] || (help && echo >&2 "xremote: Cannot find script \`$1'" && exit 1)
152 main="$(basename "$1")"
153 main_config="${main}.xremote"
155 if [[ -f "${main_config}" ]]
157 echo "xremote: found ${main_config}"
159 main_config="${main}"
164 trap cleanup_remote_tmp EXIT
166 ######################################################################
171 if [[ "${line}" =~ '@XREMOTE' ]]
174 label=$(sed -e 's/^.*@XREMOTE_\([^:]*\):.*$/\1/' <<<"${line}")
175 value=$(sed -e 's/^.*@XREMOTE_[^:]*: *\(.*\)$/\1/' <<<"${line}")
180 check_remote_is_defined
181 [[ "${REMOTE_EXEC}" ]] && (exit "Remote executable already defined!" >&2 && exit 1)
182 REMOTE_EXEC="${value}"
186 check_remote_is_defined
187 echo "xremote: ${value}"
188 ssh < /dev/null "${REMOTE_HOST}" "cd \"${REMOTE_DIR}\" && ${value}"
192 check_remote_is_defined
193 echo "xremote: -- sending files --------------------------------------------"
194 tar ch ${value} | ssh "${REMOTE_HOST}" "cd \"${REMOTE_DIR}\" && tar mxv"
198 [[ "${REMOTE_DIR}" ]] && (exit "Remote host already defined!" >&2 && exit 1)
199 REMOTE_HOST="${ARG_HOST}" # Host given in argument has priority
200 [[ "${REMOTE_HOST}" ]] || REMOTE_HOST="${value}"
201 [[ "${REMOTE_HOST}" ]] || REMOTE_HOST="${XREMOTE_HOST}"
202 [[ "${REMOTE_HOST}" ]] || (echo "xremote: No remote host specified." >&2 && exit 1)
203 if [[ "${ARG_DIR}" ]]
205 ssh </dev/null "${REMOTE_HOST}" "mkdir -p \"${ARG_DIR}\""
206 REMOTE_DIR="${ARG_DIR}"
208 REMOTE_DIR="$(ssh </dev/null "${REMOTE_HOST}" mktemp -d /tmp/xremote_\$\(whoami\)_from_"$(hostname)_$(date +%Y%m%d_%H%M%S)".XXXXXX)"
210 echo "xremote: target is ${REMOTE_HOST}"
215 done < "${main_config}"
217 ######################################################################
219 check_remote_is_defined
221 tar c "${main}" | ssh "${REMOTE_HOST}" "cd \"${REMOTE_DIR}\" && tar mx"
225 echo "xremote: everything has been set up in ${REMOTE_HOST}:${ARG_DIR}"
229 echo "xremote: -- running the executable -----------------------------------"
231 if [[ "${REMOTE_EXEC}" ]]
233 REMOTE_COMMAND="${REMOTE_EXEC} ${main}"
235 REMOTE_COMMAND="./${main}"
238 ######################################################################
240 # I find this slightly ugly ...
244 quoted_args="${quoted_args} \"${s}\""
247 ssh </dev/null "${REMOTE_HOST}" "cd \"${REMOTE_DIR}\" && ${REMOTE_COMMAND} ${quoted_args}"
249 ######################################################################
251 # Disable globbing to keep wildcards for the remote side
253 echo "xremote: -- retrieving files -----------------------------------------"
257 if [[ "${ARG_RESULT_DIR}" ]]
259 RESULT_DIR="${ARG_RESULT_DIR}"
264 [[ "${ARG_RESULT_DIR}" ]] && mkdir -p "${ARG_RESULT_DIR}"
268 if [[ "${line}" =~ '@XREMOTE' ]]
270 label=$(sed -e 's/^.*@XREMOTE_\([^:]*\):.*$/\1/' <<<"${line}")
271 value=$(sed -e 's/^.*@XREMOTE_[^:]*: *\(.*\)$/\1/' <<<"${line}")
274 check_remote_is_defined
275 echo "xremote: ${value}"
276 ssh < /dev/null "${REMOTE_HOST}" "cd \"${REMOTE_DIR}\" && ${value}"
280 check_remote_is_defined
281 ssh </dev/null "${REMOTE_HOST}" "cd \"${REMOTE_DIR}\" && tar 2>/dev/null c ${value}" | tar mxv -C "${RESULT_DIR}"
286 done < "${main_config}"
290 echo "xremote: -- finished -------------------------------------------------"
292 ######################################################################