mbligh | dcd57a8 | 2007-07-11 23:06:47 +0000 | [diff] [blame] | 1 | #!/usr/bin/python |
| 2 | # |
| 3 | # Copyright 2007 Google Inc. Released under the GPL v2 |
| 4 | |
mbligh | dc735a2 | 2007-08-02 16:54:37 +0000 | [diff] [blame] | 5 | """ |
| 6 | Miscellaneous small functions. |
mbligh | dcd57a8 | 2007-07-11 23:06:47 +0000 | [diff] [blame] | 7 | """ |
| 8 | |
mbligh | dc735a2 | 2007-08-02 16:54:37 +0000 | [diff] [blame] | 9 | __author__ = """ |
| 10 | mbligh@google.com (Martin J. Bligh), |
mbligh | dcd57a8 | 2007-07-11 23:06:47 +0000 | [diff] [blame] | 11 | poirier@google.com (Benjamin Poirier), |
mbligh | dc735a2 | 2007-08-02 16:54:37 +0000 | [diff] [blame] | 12 | stutsman@google.com (Ryan Stutsman) |
| 13 | """ |
mbligh | dcd57a8 | 2007-07-11 23:06:47 +0000 | [diff] [blame] | 14 | |
mbligh | f1c5284 | 2007-10-16 15:21:38 +0000 | [diff] [blame] | 15 | import atexit, os, select, shutil, signal, StringIO, subprocess, tempfile |
mbligh | c9f342d | 2007-11-28 22:29:23 +0000 | [diff] [blame] | 16 | import time, types, urllib, re, sys, textwrap |
mbligh | 03f4fc7 | 2007-11-29 20:56:14 +0000 | [diff] [blame] | 17 | import hosts |
mbligh | f31b0c0 | 2007-11-29 18:19:22 +0000 | [diff] [blame] | 18 | from common.error import * |
mbligh | dcd57a8 | 2007-07-11 23:06:47 +0000 | [diff] [blame] | 19 | |
mbligh | bea5682 | 2007-08-31 08:53:40 +0000 | [diff] [blame] | 20 | # A dictionary of pid and a list of tmpdirs for that pid |
| 21 | __tmp_dirs = {} |
mbligh | dcd57a8 | 2007-07-11 23:06:47 +0000 | [diff] [blame] | 22 | |
| 23 | |
| 24 | def sh_escape(command): |
mbligh | dc735a2 | 2007-08-02 16:54:37 +0000 | [diff] [blame] | 25 | """ |
| 26 | Escape special characters from a command so that it can be passed |
mbligh | c8949b8 | 2007-07-23 16:33:58 +0000 | [diff] [blame] | 27 | as a double quoted (" ") string in a (ba)sh command. |
mbligh | dc735a2 | 2007-08-02 16:54:37 +0000 | [diff] [blame] | 28 | |
mbligh | dcd57a8 | 2007-07-11 23:06:47 +0000 | [diff] [blame] | 29 | Args: |
| 30 | command: the command string to escape. |
mbligh | dc735a2 | 2007-08-02 16:54:37 +0000 | [diff] [blame] | 31 | |
mbligh | dcd57a8 | 2007-07-11 23:06:47 +0000 | [diff] [blame] | 32 | Returns: |
| 33 | The escaped command string. The required englobing double |
| 34 | quotes are NOT added and so should be added at some point by |
| 35 | the caller. |
mbligh | dc735a2 | 2007-08-02 16:54:37 +0000 | [diff] [blame] | 36 | |
mbligh | dcd57a8 | 2007-07-11 23:06:47 +0000 | [diff] [blame] | 37 | See also: http://www.tldp.org/LDP/abs/html/escapingsection.html |
| 38 | """ |
| 39 | command= command.replace("\\", "\\\\") |
| 40 | command= command.replace("$", r'\$') |
| 41 | command= command.replace('"', r'\"') |
| 42 | command= command.replace('`', r'\`') |
| 43 | return command |
| 44 | |
| 45 | |
| 46 | def scp_remote_escape(filename): |
mbligh | dc735a2 | 2007-08-02 16:54:37 +0000 | [diff] [blame] | 47 | """ |
| 48 | Escape special characters from a filename so that it can be passed |
mbligh | dcd57a8 | 2007-07-11 23:06:47 +0000 | [diff] [blame] | 49 | to scp (within double quotes) as a remote file. |
mbligh | dc735a2 | 2007-08-02 16:54:37 +0000 | [diff] [blame] | 50 | |
mbligh | dcd57a8 | 2007-07-11 23:06:47 +0000 | [diff] [blame] | 51 | Bis-quoting has to be used with scp for remote files, "bis-quoting" |
| 52 | as in quoting x 2 |
| 53 | scp does not support a newline in the filename |
mbligh | dc735a2 | 2007-08-02 16:54:37 +0000 | [diff] [blame] | 54 | |
mbligh | dcd57a8 | 2007-07-11 23:06:47 +0000 | [diff] [blame] | 55 | Args: |
| 56 | filename: the filename string to escape. |
mbligh | dc735a2 | 2007-08-02 16:54:37 +0000 | [diff] [blame] | 57 | |
mbligh | dcd57a8 | 2007-07-11 23:06:47 +0000 | [diff] [blame] | 58 | Returns: |
| 59 | The escaped filename string. The required englobing double |
| 60 | quotes are NOT added and so should be added at some point by |
| 61 | the caller. |
| 62 | """ |
| 63 | escape_chars= r' !"$&' "'" r'()*,:;<=>?[\]^`{|}' |
mbligh | dc735a2 | 2007-08-02 16:54:37 +0000 | [diff] [blame] | 64 | |
mbligh | dcd57a8 | 2007-07-11 23:06:47 +0000 | [diff] [blame] | 65 | new_name= [] |
| 66 | for char in filename: |
| 67 | if char in escape_chars: |
| 68 | new_name.append("\\%s" % (char,)) |
| 69 | else: |
| 70 | new_name.append(char) |
mbligh | dc735a2 | 2007-08-02 16:54:37 +0000 | [diff] [blame] | 71 | |
mbligh | dcd57a8 | 2007-07-11 23:06:47 +0000 | [diff] [blame] | 72 | return sh_escape("".join(new_name)) |
| 73 | |
| 74 | |
mbligh | 6e18dab | 2007-10-24 21:27:18 +0000 | [diff] [blame] | 75 | def get(location, local_copy = False): |
mbligh | dcd57a8 | 2007-07-11 23:06:47 +0000 | [diff] [blame] | 76 | """Get a file or directory to a local temporary directory. |
mbligh | dc735a2 | 2007-08-02 16:54:37 +0000 | [diff] [blame] | 77 | |
mbligh | dcd57a8 | 2007-07-11 23:06:47 +0000 | [diff] [blame] | 78 | Args: |
| 79 | location: the source of the material to get. This source may |
| 80 | be one of: |
| 81 | * a local file or directory |
| 82 | * a URL (http or ftp) |
| 83 | * a python file-like object |
mbligh | dc735a2 | 2007-08-02 16:54:37 +0000 | [diff] [blame] | 84 | |
mbligh | dcd57a8 | 2007-07-11 23:06:47 +0000 | [diff] [blame] | 85 | Returns: |
| 86 | The location of the file or directory where the requested |
| 87 | content was saved. This will be contained in a temporary |
mbligh | c8949b8 | 2007-07-23 16:33:58 +0000 | [diff] [blame] | 88 | directory on the local host. If the material to get was a |
| 89 | directory, the location will contain a trailing '/' |
mbligh | dcd57a8 | 2007-07-11 23:06:47 +0000 | [diff] [blame] | 90 | """ |
| 91 | tmpdir = get_tmp_dir() |
mbligh | dc735a2 | 2007-08-02 16:54:37 +0000 | [diff] [blame] | 92 | |
mbligh | dcd57a8 | 2007-07-11 23:06:47 +0000 | [diff] [blame] | 93 | # location is a file-like object |
| 94 | if hasattr(location, "read"): |
| 95 | tmpfile = os.path.join(tmpdir, "file") |
| 96 | tmpfileobj = file(tmpfile, 'w') |
| 97 | shutil.copyfileobj(location, tmpfileobj) |
| 98 | tmpfileobj.close() |
| 99 | return tmpfile |
mbligh | dc735a2 | 2007-08-02 16:54:37 +0000 | [diff] [blame] | 100 | |
mbligh | dcd57a8 | 2007-07-11 23:06:47 +0000 | [diff] [blame] | 101 | if isinstance(location, types.StringTypes): |
| 102 | # location is a URL |
| 103 | if location.startswith('http') or location.startswith('ftp'): |
| 104 | tmpfile = os.path.join(tmpdir, os.path.basename(location)) |
| 105 | urllib.urlretrieve(location, tmpfile) |
| 106 | return tmpfile |
| 107 | # location is a local path |
| 108 | elif os.path.exists(os.path.abspath(location)): |
mbligh | 6e18dab | 2007-10-24 21:27:18 +0000 | [diff] [blame] | 109 | if not local_copy: |
mbligh | 59f70aa | 2007-10-25 14:44:38 +0000 | [diff] [blame] | 110 | if os.path.isdir(location): |
| 111 | return location.rstrip('/') + '/' |
| 112 | else: |
| 113 | return location |
mbligh | dcd57a8 | 2007-07-11 23:06:47 +0000 | [diff] [blame] | 114 | tmpfile = os.path.join(tmpdir, os.path.basename(location)) |
| 115 | if os.path.isdir(location): |
| 116 | tmpfile += '/' |
| 117 | shutil.copytree(location, tmpfile, symlinks=True) |
| 118 | return tmpfile |
| 119 | shutil.copyfile(location, tmpfile) |
| 120 | return tmpfile |
| 121 | # location is just a string, dump it to a file |
| 122 | else: |
| 123 | tmpfd, tmpfile = tempfile.mkstemp(dir=tmpdir) |
| 124 | tmpfileobj = os.fdopen(tmpfd, 'w') |
| 125 | tmpfileobj.write(location) |
| 126 | tmpfileobj.close() |
| 127 | return tmpfile |
| 128 | |
| 129 | |
mbligh | c9f342d | 2007-11-28 22:29:23 +0000 | [diff] [blame] | 130 | def __nuke_subprocess(subproc): |
| 131 | # the process has not terminated within timeout, |
| 132 | # kill it via an escalating series of signals. |
| 133 | signal_queue = [signal.SIGTERM, signal.SIGKILL] |
| 134 | for sig in signal_queue: |
| 135 | try: |
| 136 | os.kill(subproc.pid, sig) |
| 137 | # The process may have died before we could kill it. |
| 138 | except OSError: |
| 139 | pass |
| 140 | |
| 141 | for i in range(5): |
| 142 | rc = subproc.poll() |
| 143 | if rc != None: |
| 144 | return |
| 145 | time.sleep(1) |
| 146 | |
| 147 | |
mbligh | 0e4613b | 2007-10-29 16:55:07 +0000 | [diff] [blame] | 148 | def _process_output(pipe, fbuffer, teefile=None, use_os_read=True): |
| 149 | if use_os_read: |
| 150 | data = os.read(pipe.fileno(), 1024) |
| 151 | else: |
| 152 | data = pipe.read() |
| 153 | fbuffer.write(data) |
| 154 | if teefile: |
| 155 | teefile.write(data) |
| 156 | teefile.flush() |
| 157 | |
| 158 | |
| 159 | def _wait_for_command(subproc, start_time, timeout, stdout_file, stderr_file, |
| 160 | stdout_tee, stderr_tee): |
| 161 | if timeout: |
| 162 | stop_time = start_time + timeout |
| 163 | time_left = stop_time - time.time() |
| 164 | else: |
| 165 | time_left = None # so that select never times out |
| 166 | while not timeout or time_left > 0: |
| 167 | # select will return when stdout is ready (including when it is |
| 168 | # EOF, that is the process has terminated). |
| 169 | ready, _, _ = select.select([subproc.stdout, subproc.stderr], |
| 170 | [], [], time_left) |
| 171 | # os.read() has to be used instead of |
| 172 | # subproc.stdout.read() which will otherwise block |
| 173 | if subproc.stdout in ready: |
| 174 | _process_output(subproc.stdout, stdout_file, |
| 175 | stdout_tee) |
| 176 | if subproc.stderr in ready: |
| 177 | _process_output(subproc.stderr, stderr_file, |
| 178 | stderr_tee) |
| 179 | |
| 180 | pid, exit_status_indication = os.waitpid(subproc.pid, |
| 181 | os.WNOHANG) |
| 182 | if pid: |
mbligh | c9f342d | 2007-11-28 22:29:23 +0000 | [diff] [blame] | 183 | return exit_status_indication |
mbligh | 0e4613b | 2007-10-29 16:55:07 +0000 | [diff] [blame] | 184 | if timeout: |
| 185 | time_left = stop_time - time.time() |
| 186 | |
| 187 | # the process has not terminated within timeout, |
| 188 | # kill it via an escalating series of signals. |
| 189 | if not pid: |
mbligh | c9f342d | 2007-11-28 22:29:23 +0000 | [diff] [blame] | 190 | __nuke_subprocess(subproc) |
mbligh | ff6b402 | 2008-01-10 16:20:51 +0000 | [diff] [blame] | 191 | raise AutoservRunError('Command not complete within %s seconds' |
mbligh | 6a2a2df | 2008-01-16 17:41:55 +0000 | [diff] [blame^] | 192 | % timeout, None) |
mbligh | 0e4613b | 2007-10-29 16:55:07 +0000 | [diff] [blame] | 193 | |
| 194 | |
| 195 | def run(command, timeout=None, ignore_status=False, |
| 196 | stdout_tee=None, stderr_tee=None): |
mbligh | dc735a2 | 2007-08-02 16:54:37 +0000 | [diff] [blame] | 197 | """ |
| 198 | Run a command on the host. |
| 199 | |
mbligh | dcd57a8 | 2007-07-11 23:06:47 +0000 | [diff] [blame] | 200 | Args: |
| 201 | command: the command line string |
mbligh | 0e4613b | 2007-10-29 16:55:07 +0000 | [diff] [blame] | 202 | timeout: time limit in seconds before attempting to |
mbligh | dcd57a8 | 2007-07-11 23:06:47 +0000 | [diff] [blame] | 203 | kill the running process. The run() function |
| 204 | will take a few seconds longer than 'timeout' |
| 205 | to complete if it has to kill the process. |
mbligh | 8b85dfb | 2007-08-28 09:50:31 +0000 | [diff] [blame] | 206 | ignore_status: do not raise an exception, no matter what |
| 207 | the exit code of the command is. |
mbligh | 0e4613b | 2007-10-29 16:55:07 +0000 | [diff] [blame] | 208 | stdout_tee: optional file-like object to which stdout data |
| 209 | will be written as it is generated (data will still |
| 210 | be stored in result.stdout) |
| 211 | stderr_tee: likewise for stderr |
| 212 | |
mbligh | dcd57a8 | 2007-07-11 23:06:47 +0000 | [diff] [blame] | 213 | Returns: |
mbligh | c9f342d | 2007-11-28 22:29:23 +0000 | [diff] [blame] | 214 | a CmdResult object |
mbligh | dc735a2 | 2007-08-02 16:54:37 +0000 | [diff] [blame] | 215 | |
mbligh | dcd57a8 | 2007-07-11 23:06:47 +0000 | [diff] [blame] | 216 | Raises: |
mbligh | 0e4613b | 2007-10-29 16:55:07 +0000 | [diff] [blame] | 217 | AutoservRunError: the exit code of the command |
mbligh | dcd57a8 | 2007-07-11 23:06:47 +0000 | [diff] [blame] | 218 | execution was not 0 |
mbligh | dcd57a8 | 2007-07-11 23:06:47 +0000 | [diff] [blame] | 219 | """ |
mbligh | c9f342d | 2007-11-28 22:29:23 +0000 | [diff] [blame] | 220 | result = CmdResult(command) |
mbligh | 0e4613b | 2007-10-29 16:55:07 +0000 | [diff] [blame] | 221 | sp = subprocess.Popen(command, stdout=subprocess.PIPE, |
| 222 | stderr=subprocess.PIPE, close_fds=True, |
| 223 | shell=True, executable="/bin/bash") |
| 224 | stdout_file = StringIO.StringIO() |
| 225 | stderr_file = StringIO.StringIO() |
mbligh | 0dd2ae0 | 2007-08-01 17:31:10 +0000 | [diff] [blame] | 226 | |
| 227 | try: |
| 228 | # We are holding ends to stdin, stdout pipes |
| 229 | # hence we need to be sure to close those fds no mater what |
mbligh | 0e4613b | 2007-10-29 16:55:07 +0000 | [diff] [blame] | 230 | start_time = time.time() |
mbligh | c9f342d | 2007-11-28 22:29:23 +0000 | [diff] [blame] | 231 | result.exit_status = _wait_for_command(sp, start_time, timeout, |
| 232 | stdout_file, stderr_file, stdout_tee, stderr_tee) |
mbligh | 0dd2ae0 | 2007-08-01 17:31:10 +0000 | [diff] [blame] | 233 | |
| 234 | result.duration = time.time() - start_time |
mbligh | 0e4613b | 2007-10-29 16:55:07 +0000 | [diff] [blame] | 235 | # don't use os.read now, so we get all the rest of the output |
| 236 | _process_output(sp.stdout, stdout_file, stdout_tee, |
| 237 | use_os_read=False) |
| 238 | _process_output(sp.stderr, stderr_file, stderr_tee, |
| 239 | use_os_read=False) |
mbligh | 0dd2ae0 | 2007-08-01 17:31:10 +0000 | [diff] [blame] | 240 | finally: |
| 241 | # close our ends of the pipes to the sp no matter what |
| 242 | sp.stdout.close() |
| 243 | sp.stderr.close() |
mbligh | cf965b0 | 2007-07-25 16:49:45 +0000 | [diff] [blame] | 244 | |
mbligh | 0e4613b | 2007-10-29 16:55:07 +0000 | [diff] [blame] | 245 | result.stdout = stdout_file.getvalue() |
| 246 | result.stderr = stderr_file.getvalue() |
| 247 | |
mbligh | cf965b0 | 2007-07-25 16:49:45 +0000 | [diff] [blame] | 248 | if not ignore_status and result.exit_status > 0: |
mbligh | 03f4fc7 | 2007-11-29 20:56:14 +0000 | [diff] [blame] | 249 | raise AutoservRunError("command execution error", result) |
mbligh | 0dd2ae0 | 2007-08-01 17:31:10 +0000 | [diff] [blame] | 250 | |
mbligh | dcd57a8 | 2007-07-11 23:06:47 +0000 | [diff] [blame] | 251 | return result |
| 252 | |
| 253 | |
mbligh | 5f876ad | 2007-10-12 23:59:53 +0000 | [diff] [blame] | 254 | def system(command, timeout=None, ignore_status=False): |
mbligh | 10b3a08 | 2008-01-10 16:35:29 +0000 | [diff] [blame] | 255 | return run(command, timeout, ignore_status, |
| 256 | stdout_tee=sys.stdout, stderr_tee=sys.stderr).exit_status |
mbligh | 5f876ad | 2007-10-12 23:59:53 +0000 | [diff] [blame] | 257 | |
| 258 | |
| 259 | def system_output(command, timeout=None, ignore_status=False): |
| 260 | return run(command, timeout, ignore_status).stdout |
| 261 | |
| 262 | |
mbligh | dcd57a8 | 2007-07-11 23:06:47 +0000 | [diff] [blame] | 263 | def get_tmp_dir(): |
| 264 | """Return the pathname of a directory on the host suitable |
| 265 | for temporary file storage. |
mbligh | dc735a2 | 2007-08-02 16:54:37 +0000 | [diff] [blame] | 266 | |
mbligh | dcd57a8 | 2007-07-11 23:06:47 +0000 | [diff] [blame] | 267 | The directory and its content will be deleted automatically |
| 268 | at the end of the program execution if they are still present. |
| 269 | """ |
| 270 | global __tmp_dirs |
mbligh | dc735a2 | 2007-08-02 16:54:37 +0000 | [diff] [blame] | 271 | |
mbligh | dcd57a8 | 2007-07-11 23:06:47 +0000 | [diff] [blame] | 272 | dir_name= tempfile.mkdtemp(prefix="autoserv-") |
mbligh | bea5682 | 2007-08-31 08:53:40 +0000 | [diff] [blame] | 273 | pid = os.getpid() |
| 274 | if not pid in __tmp_dirs: |
| 275 | __tmp_dirs[pid] = [] |
| 276 | __tmp_dirs[pid].append(dir_name) |
mbligh | dcd57a8 | 2007-07-11 23:06:47 +0000 | [diff] [blame] | 277 | return dir_name |
| 278 | |
| 279 | |
| 280 | @atexit.register |
| 281 | def __clean_tmp_dirs(): |
| 282 | """Erase temporary directories that were created by the get_tmp_dir() |
| 283 | function and that are still present. |
| 284 | """ |
| 285 | global __tmp_dirs |
mbligh | dc735a2 | 2007-08-02 16:54:37 +0000 | [diff] [blame] | 286 | |
mbligh | bea5682 | 2007-08-31 08:53:40 +0000 | [diff] [blame] | 287 | pid = os.getpid() |
| 288 | if pid not in __tmp_dirs: |
| 289 | return |
| 290 | for dir in __tmp_dirs[pid]: |
| 291 | try: |
| 292 | shutil.rmtree(dir) |
| 293 | except OSError, e: |
| 294 | if e.errno == 2: |
| 295 | pass |
| 296 | __tmp_dirs[pid] = [] |
mbligh | c8949b8 | 2007-07-23 16:33:58 +0000 | [diff] [blame] | 297 | |
| 298 | |
| 299 | def unarchive(host, source_material): |
| 300 | """Uncompress and untar an archive on a host. |
mbligh | dc735a2 | 2007-08-02 16:54:37 +0000 | [diff] [blame] | 301 | |
mbligh | c8949b8 | 2007-07-23 16:33:58 +0000 | [diff] [blame] | 302 | If the "source_material" is compresses (according to the file |
| 303 | extension) it will be uncompressed. Supported compression formats |
| 304 | are gzip and bzip2. Afterwards, if the source_material is a tar |
| 305 | archive, it will be untarred. |
mbligh | dc735a2 | 2007-08-02 16:54:37 +0000 | [diff] [blame] | 306 | |
mbligh | c8949b8 | 2007-07-23 16:33:58 +0000 | [diff] [blame] | 307 | Args: |
| 308 | host: the host object on which the archive is located |
| 309 | source_material: the path of the archive on the host |
mbligh | dc735a2 | 2007-08-02 16:54:37 +0000 | [diff] [blame] | 310 | |
mbligh | c8949b8 | 2007-07-23 16:33:58 +0000 | [diff] [blame] | 311 | Returns: |
| 312 | The file or directory name of the unarchived source material. |
| 313 | If the material is a tar archive, it will be extracted in the |
| 314 | directory where it is and the path returned will be the first |
| 315 | entry in the archive, assuming it is the topmost directory. |
| 316 | If the material is not an archive, nothing will be done so this |
| 317 | function is "harmless" when it is "useless". |
| 318 | """ |
| 319 | # uncompress |
| 320 | if (source_material.endswith(".gz") or |
| 321 | source_material.endswith(".gzip")): |
| 322 | host.run('gunzip "%s"' % (sh_escape(source_material))) |
| 323 | source_material= ".".join(source_material.split(".")[:-1]) |
| 324 | elif source_material.endswith("bz2"): |
| 325 | host.run('bunzip2 "%s"' % (sh_escape(source_material))) |
| 326 | source_material= ".".join(source_material.split(".")[:-1]) |
mbligh | dc735a2 | 2007-08-02 16:54:37 +0000 | [diff] [blame] | 327 | |
mbligh | c8949b8 | 2007-07-23 16:33:58 +0000 | [diff] [blame] | 328 | # untar |
| 329 | if source_material.endswith(".tar"): |
| 330 | retval= host.run('tar -C "%s" -xvf "%s"' % ( |
| 331 | sh_escape(os.path.dirname(source_material)), |
| 332 | sh_escape(source_material),)) |
| 333 | source_material= os.path.join(os.path.dirname(source_material), |
| 334 | retval.stdout.split()[0]) |
mbligh | dc735a2 | 2007-08-02 16:54:37 +0000 | [diff] [blame] | 335 | |
mbligh | c8949b8 | 2007-07-23 16:33:58 +0000 | [diff] [blame] | 336 | return source_material |
mbligh | f1c5284 | 2007-10-16 15:21:38 +0000 | [diff] [blame] | 337 | |
| 338 | |
| 339 | def write_keyval(dirname, dictionary): |
| 340 | keyval = open(os.path.join(dirname, 'keyval'), 'w') |
| 341 | for key in dictionary.keys(): |
| 342 | value = '%s' % dictionary[key] # convert numbers to strings |
| 343 | if re.search(r'\W', key): |
mbligh | 4d6feff | 2008-01-14 16:48:56 +0000 | [diff] [blame] | 344 | raise ValueError('Invalid key: %s' % key) |
mbligh | f1c5284 | 2007-10-16 15:21:38 +0000 | [diff] [blame] | 345 | keyval.write('%s=%s\n' % (key, str(value))) |
| 346 | keyval.close() |
| 347 | |
mbligh | 0526936 | 2007-10-16 16:58:11 +0000 | [diff] [blame] | 348 | |
| 349 | def update_version(srcdir, preserve_srcdir, new_version, install, *args, **dargs): |
| 350 | """ |
| 351 | Make sure srcdir is version new_version |
| 352 | |
| 353 | If not, delete it and install() the new version. |
| 354 | |
| 355 | In the preserve_srcdir case, we just check it's up to date, |
| 356 | and if not, we rerun install, without removing srcdir |
| 357 | """ |
| 358 | versionfile = srcdir + '/.version' |
| 359 | install_needed = True |
| 360 | |
| 361 | if os.path.exists(srcdir): |
| 362 | if os.path.exists(versionfile): |
| 363 | old_version = pickle.load(open(versionfile, 'r')) |
| 364 | if (old_version == new_version): |
| 365 | install_needed = False |
| 366 | |
| 367 | if install_needed: |
| 368 | if not preserve_srcdir: |
| 369 | system('rm -rf ' + srcdir) |
| 370 | install(*args, **dargs) |
| 371 | if os.path.exists(srcdir): |
| 372 | pickle.dump(new_version, open(versionfile, 'w')) |
mbligh | 9708f73 | 2007-10-18 03:18:54 +0000 | [diff] [blame] | 373 | |
| 374 | |
| 375 | def get_server_dir(): |
| 376 | path = os.path.dirname(sys.modules['utils'].__file__) |
| 377 | return os.path.abspath(path) |
mbligh | 40f122a | 2007-11-03 23:08:46 +0000 | [diff] [blame] | 378 | |
| 379 | |
mbligh | 34a3fd7 | 2007-12-10 17:16:22 +0000 | [diff] [blame] | 380 | def find_pid(command): |
| 381 | for line in system_output('ps -eo pid,cmd').rstrip().split('\n'): |
| 382 | (pid, cmd) = line.split(None, 1) |
| 383 | if re.search(command, cmd): |
| 384 | return int(pid) |
| 385 | return None |
| 386 | |
| 387 | |
| 388 | def nohup(command, stdout='/dev/null', stderr='/dev/null', background=True, |
| 389 | env = {}): |
| 390 | cmd = ' '.join(key+'='+val for key, val in env.iteritems()) |
| 391 | cmd += ' nohup ' + command |
| 392 | cmd += ' > %s' % stdout |
| 393 | if stdout == stderr: |
| 394 | cmd += ' 2>&1' |
| 395 | else: |
| 396 | cmd += ' 2> %s' % stderr |
| 397 | if background: |
| 398 | cmd += ' &' |
| 399 | system(cmd) |
| 400 | |
| 401 | |
mbligh | 40f122a | 2007-11-03 23:08:46 +0000 | [diff] [blame] | 402 | class AutoservOptionParser: |
| 403 | """Custom command-line options parser for autoserv. |
| 404 | |
| 405 | We can't use the general getopt methods here, as there will be unknown |
| 406 | extra arguments that we pass down into the control file instead. |
| 407 | Thus we process the arguments by hand, for which we are duly repentant. |
| 408 | Making a single function here just makes it harder to read. Suck it up. |
| 409 | """ |
| 410 | |
| 411 | def __init__(self, args): |
| 412 | self.args = args |
| 413 | |
| 414 | |
| 415 | def parse_opts(self, flag): |
| 416 | if self.args.count(flag): |
| 417 | idx = self.args.index(flag) |
| 418 | self.args[idx : idx+1] = [] |
| 419 | return True |
| 420 | else: |
| 421 | return False |
| 422 | |
| 423 | |
| 424 | def parse_opts_param(self, flag, default = None, split = False): |
| 425 | if self.args.count(flag): |
| 426 | idx = self.args.index(flag) |
| 427 | ret = self.args[idx+1] |
| 428 | self.args[idx : idx+2] = [] |
| 429 | if split: |
| 430 | return ret.split(split) |
| 431 | else: |
| 432 | return ret |
| 433 | else: |
| 434 | return default |
mbligh | c9f342d | 2007-11-28 22:29:23 +0000 | [diff] [blame] | 435 | |
| 436 | |
| 437 | class CmdResult(object): |
| 438 | """ |
| 439 | Command execution result. |
| 440 | |
| 441 | command: String containing the command line itself |
| 442 | exit_status: Integer exit code of the process |
| 443 | stdout: String containing stdout of the process |
| 444 | stderr: String containing stderr of the process |
| 445 | duration: Elapsed wall clock time running the process |
| 446 | """ |
| 447 | |
| 448 | def __init__(self, command = None): |
| 449 | self.command = command |
| 450 | self.exit_status = None |
| 451 | self.stdout = "" |
| 452 | self.stderr = "" |
| 453 | self.duration = 0 |
| 454 | |
| 455 | |
| 456 | def __repr__(self): |
| 457 | wrapper = textwrap.TextWrapper(width = 78, |
| 458 | initial_indent="\n ", |
| 459 | subsequent_indent=" ") |
| 460 | |
| 461 | stdout = self.stdout.rstrip() |
| 462 | if stdout: |
| 463 | stdout = "\nstdout:\n%s" % stdout |
| 464 | |
| 465 | stderr = self.stderr.rstrip() |
| 466 | if stderr: |
| 467 | stderr = "\nstderr:\n%s" % stderr |
| 468 | |
| 469 | return ("* Command: %s\n" |
| 470 | "Exit status: %s\n" |
| 471 | "Duration: %s\n" |
| 472 | "%s" |
| 473 | "%s" |
| 474 | % (wrapper.fill(self.command), self.exit_status, |
| 475 | self.duration, stdout, stderr)) |