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 [-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 echo "xremote: remote forced to ${ARG_HOST}"
101 echo "xremote: remote dir set to ${ARG_DIR}"
105 echo "Unknown option $1"
112 ######################################################################
114 [[ -a "$1" ]] || (help && exit 1)
116 main="$(basename "$1")"
117 main_config="${main}.xremote"
119 if [[ ! -f "${main}.xremote" ]]
121 main_config="${main}"
128 trap cleanup_remote_tmp EXIT
130 ######################################################################
135 if [[ "${line}" =~ '@XREMOTE' ]]
138 label=$(echo "${line}" | sed -e 's/^.*@XREMOTE_\([^:]*\):.*$/\1/')
139 value=$(echo "${line}" | sed -e 's/^.*@XREMOTE_[^:]*: *\(.*\)$/\1/')
144 check_remote_is_defined
145 [[ "${REMOTE_EXEC}" ]] && (exit "Remote executable already defined!" >&2 && exit 1)
146 REMOTE_EXEC="${value}"
150 check_remote_is_defined
151 echo "xremote: ${value}"
152 ssh < /dev/null "${REMOTE_HOST}" "cd \"${REMOTE_DIR}\" && ${value}"
156 check_remote_is_defined
157 echo "xremote: -- sending files --------------------------------------------"
158 tar ch ${value} | ssh "${REMOTE_HOST}" "cd \"${REMOTE_DIR}\" && tar mxv"
162 [[ "${REMOTE_DIR}" ]] && (exit "Remote host already defined!" >&2 && exit 1)
163 REMOTE_HOST="${ARG_HOST}" # Host given in argument has priority
164 [[ "${REMOTE_HOST}" ]] || REMOTE_HOST="${value}"
165 [[ "${REMOTE_HOST}" ]] || REMOTE_HOST="${XREMOTE_HOST}"
166 [[ "${REMOTE_HOST}" ]] || (echo "xremote: No remote host specified." >&2 && exit 1)
167 if [[ "${ARG_DIR}" ]]
169 ssh </dev/null "${REMOTE_HOST}" "mkdir -p \"${ARG_DIR}\""
170 REMOTE_DIR="${ARG_DIR}"
172 REMOTE_DIR="$(ssh </dev/null "${REMOTE_HOST}" mktemp -d /tmp/xremote_\$\(whoami\)_from_"$(hostname)_$(date +%Y%m%d_%H%M%S)".XXXXXX)"
174 echo "xremote: target is ${REMOTE_HOST}"
179 done < "${main_config}"
181 ######################################################################
183 check_remote_is_defined
185 tar c "${main}" | ssh "${REMOTE_HOST}" "cd \"${REMOTE_DIR}\" && tar mx"
187 if [[ "${ARG_DIR}" ]]
189 echo "xremote: everything has been set up in ${REMOTE_HOST}:${ARG_DIR}"
193 echo "xremote: -- running the executable -----------------------------------"
195 if [[ "${REMOTE_EXEC}" ]]
197 REMOTE_COMMAND="${REMOTE_EXEC} ${main}"
199 REMOTE_COMMAND="./${main}"
202 ######################################################################
204 # I find this slightly ugly ...
207 quoted_args="${quoted_args} \"${s}\""
210 ssh </dev/null "${REMOTE_HOST}" "cd \"${REMOTE_DIR}\" && ${REMOTE_COMMAND} ${quoted_args}"
212 ######################################################################
214 # Disable globbing to keep wildcards for the remote side
216 echo "xremote: -- retrieving files -----------------------------------------"
222 if [[ "${line}" =~ '@XREMOTE' ]]
224 label=$(echo "${line}" | sed -e 's/^.*@XREMOTE_\([^:]*\):.*$/\1/')
225 value=$(echo "${line}" | sed -e 's/^.*@XREMOTE_[^:]*: *\(.*\)$/\1/')
228 check_remote_is_defined
229 echo "xremote: ${value}"
230 ssh < /dev/null "${REMOTE_HOST}" "cd \"${REMOTE_DIR}\" && ${value}"
234 check_remote_is_defined
235 ssh </dev/null "${REMOTE_HOST}" "cd \"${REMOTE_DIR}\" && tar 2>/dev/null c ${value}" | tar mxv
239 done < "${main_config}"
243 echo "xremote: -- finished -------------------------------------------------"
245 ######################################################################