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.
75 If no argument is provided to @XREMOTE_HOST, and the -h option is
76 not specified, the environment variable \$XREMOTE_HOST is used
79 Contact <francois@fleuret.org> for comments.
85 function cleanup_remote_tmp () {
86 if [[ "${REMOTE_HOST}" ]] && [[ "${REMOTE_DIR}" ]]
90 echo "xremote: Keeping remote workdir."
92 echo "xremote: Cleaning up temporary remote workdir."
93 ssh "${REMOTE_HOST}" rm -rf "${REMOTE_DIR}"
98 ######################################################################
100 while [[ "$1" =~ ^- ]]
107 [[ ${ARG_HOST} ]] || (echo "xremote: Hostname missing." && exit 1)
108 echo "xremote: remote forced to ${ARG_HOST}"
114 [[ ${ARG_DIR} ]] || (echo "xremote: Directory missing." && exit 1)
115 echo "xremote: remote dir set to ${ARG_DIR}"
120 echo "xremote: no run"
126 [[ ${ARG_RESULT_DIR} ]] || (echo "xremote: Directory missing." && exit 1)
127 echo "xremote: result dir set to ${ARG_RESULT_DIR}"
136 echo "xremote: Unknown option $1"
143 ######################################################################
145 [[ "$1" ]] || (echo "xremote: Script name missing" && exit 1)
147 [[ -a "$1" ]] || (help && echo >&2 "xremote: Cannot find script \`$1'" && exit 1)
151 main="$(basename "$1")"
152 main_config="${main}.xremote"
154 if [[ -f "${main_config}" ]]
156 echo "xremote: found ${main_config}"
158 main_config="${main}"
163 trap cleanup_remote_tmp EXIT
165 ######################################################################
170 if [[ "${line}" =~ '@XREMOTE' ]]
173 label=$(echo "${line}" | sed -e 's/^.*@XREMOTE_\([^:]*\):.*$/\1/')
174 value=$(echo "${line}" | sed -e 's/^.*@XREMOTE_[^:]*: *\(.*\)$/\1/')
179 check_remote_is_defined
180 [[ "${REMOTE_EXEC}" ]] && (exit "Remote executable already defined!" >&2 && exit 1)
181 REMOTE_EXEC="${value}"
185 check_remote_is_defined
186 echo "xremote: ${value}"
187 ssh < /dev/null "${REMOTE_HOST}" "cd \"${REMOTE_DIR}\" && ${value}"
191 check_remote_is_defined
192 echo "xremote: -- sending files --------------------------------------------"
193 tar ch ${value} | ssh "${REMOTE_HOST}" "cd \"${REMOTE_DIR}\" && tar mxv"
197 [[ "${REMOTE_DIR}" ]] && (exit "Remote host already defined!" >&2 && exit 1)
198 REMOTE_HOST="${ARG_HOST}" # Host given in argument has priority
199 [[ "${REMOTE_HOST}" ]] || REMOTE_HOST="${value}"
200 [[ "${REMOTE_HOST}" ]] || REMOTE_HOST="${XREMOTE_HOST}"
201 [[ "${REMOTE_HOST}" ]] || (echo "xremote: No remote host specified." >&2 && exit 1)
202 if [[ "${ARG_DIR}" ]]
204 ssh </dev/null "${REMOTE_HOST}" "mkdir -p \"${ARG_DIR}\""
205 REMOTE_DIR="${ARG_DIR}"
207 REMOTE_DIR="$(ssh </dev/null "${REMOTE_HOST}" mktemp -d /tmp/xremote_\$\(whoami\)_from_"$(hostname)_$(date +%Y%m%d_%H%M%S)".XXXXXX)"
209 echo "xremote: target is ${REMOTE_HOST}"
214 done < "${main_config}"
216 ######################################################################
218 check_remote_is_defined
220 tar c "${main}" | ssh "${REMOTE_HOST}" "cd \"${REMOTE_DIR}\" && tar mx"
224 echo "xremote: everything has been set up in ${REMOTE_HOST}:${ARG_DIR}"
228 echo "xremote: -- running the executable -----------------------------------"
230 if [[ "${REMOTE_EXEC}" ]]
232 REMOTE_COMMAND="${REMOTE_EXEC} ${main}"
234 REMOTE_COMMAND="./${main}"
237 ######################################################################
239 # I find this slightly ugly ...
243 quoted_args="${quoted_args} \"${s}\""
246 ssh </dev/null "${REMOTE_HOST}" "cd \"${REMOTE_DIR}\" && ${REMOTE_COMMAND} ${quoted_args}"
248 ######################################################################
250 # Disable globbing to keep wildcards for the remote side
252 echo "xremote: -- retrieving files -----------------------------------------"
256 if [[ "${ARG_RESULT_DIR}" ]]
258 RESULT_DIR="${ARG_RESULT_DIR}"
265 if [[ "${line}" =~ '@XREMOTE' ]]
267 label=$(echo "${line}" | sed -e 's/^.*@XREMOTE_\([^:]*\):.*$/\1/')
268 value=$(echo "${line}" | sed -e 's/^.*@XREMOTE_[^:]*: *\(.*\)$/\1/')
271 check_remote_is_defined
272 echo "xremote: ${value}"
273 ssh < /dev/null "${REMOTE_HOST}" "cd \"${REMOTE_DIR}\" && ${value}"
277 check_remote_is_defined
278 ssh </dev/null "${REMOTE_HOST}" "cd \"${REMOTE_DIR}\" && tar 2>/dev/null c ${value}" | tar mxv -C "${RESULT_DIR}"
283 done < "${main_config}"
287 echo "xremote: -- finished -------------------------------------------------"
289 ######################################################################