Neels Hofmeyr | dae3d3c | 2017-03-28 12:16:58 +0200 | [diff] [blame] | 1 | # osmo_gsm_tester: process management |
| 2 | # |
| 3 | # Copyright (C) 2016-2017 by sysmocom - s.f.m.c. GmbH |
| 4 | # |
| 5 | # Author: Neels Hofmeyr <neels@hofmeyr.de> |
| 6 | # |
| 7 | # This program is free software: you can redistribute it and/or modify |
Harald Welte | 2720534 | 2017-06-03 09:51:45 +0200 | [diff] [blame] | 8 | # it under the terms of the GNU General Public License as |
Neels Hofmeyr | dae3d3c | 2017-03-28 12:16:58 +0200 | [diff] [blame] | 9 | # published by the Free Software Foundation, either version 3 of the |
| 10 | # License, or (at your option) any later version. |
| 11 | # |
| 12 | # This program is distributed in the hope that it will be useful, |
| 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
Harald Welte | 2720534 | 2017-06-03 09:51:45 +0200 | [diff] [blame] | 15 | # GNU General Public License for more details. |
Neels Hofmeyr | dae3d3c | 2017-03-28 12:16:58 +0200 | [diff] [blame] | 16 | # |
Harald Welte | 2720534 | 2017-06-03 09:51:45 +0200 | [diff] [blame] | 17 | # You should have received a copy of the GNU General Public License |
Neels Hofmeyr | dae3d3c | 2017-03-28 12:16:58 +0200 | [diff] [blame] | 18 | # along with this program. If not, see <http://www.gnu.org/licenses/>. |
| 19 | |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 20 | import os |
| 21 | import time |
| 22 | import subprocess |
| 23 | import signal |
Pau Espin Pedrol | 0d8deec | 2017-06-23 11:43:38 +0200 | [diff] [blame] | 24 | from datetime import datetime |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 25 | |
Pau Espin Pedrol | 9a4631c | 2018-03-28 19:17:34 +0200 | [diff] [blame] | 26 | from . import log |
| 27 | from .event_loop import MainLoop |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 28 | from .util import Dir |
| 29 | |
| 30 | class Process(log.Origin): |
| 31 | |
| 32 | process_obj = None |
| 33 | outputs = None |
| 34 | result = None |
| 35 | killed = None |
| 36 | |
| 37 | def __init__(self, name, run_dir, popen_args, **popen_kwargs): |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 38 | super().__init__(log.C_RUN, name) |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 39 | self.name_str = name |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 40 | self.run_dir = run_dir |
| 41 | self.popen_args = popen_args |
| 42 | self.popen_kwargs = popen_kwargs |
| 43 | self.outputs = {} |
| 44 | if not isinstance(self.run_dir, Dir): |
| 45 | self.run_dir = Dir(os.path.abspath(str(self.run_dir))) |
| 46 | |
| 47 | def set_env(self, key, value): |
| 48 | env = self.popen_kwargs.get('env') or {} |
| 49 | env[key] = value |
| 50 | self.popen_kwargs['env'] = env |
| 51 | |
| 52 | def make_output_log(self, name): |
| 53 | ''' |
| 54 | create a non-existing log output file in run_dir to pipe stdout and |
| 55 | stderr from this process to. |
| 56 | ''' |
| 57 | path = self.run_dir.new_child(name) |
| 58 | f = open(path, 'w') |
| 59 | self.dbg(path) |
Pau Espin Pedrol | 0d8deec | 2017-06-23 11:43:38 +0200 | [diff] [blame] | 60 | f.write('(launched: %s)\n' % datetime.now().strftime(log.LONG_DATEFMT)) |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 61 | f.flush() |
| 62 | self.outputs[name] = (path, f) |
| 63 | return f |
| 64 | |
| 65 | def launch(self): |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 66 | log.dbg('cd %r; %s %s' % ( |
| 67 | os.path.abspath(str(self.run_dir)), |
| 68 | ' '.join(['%s=%r'%(k,v) for k,v in self.popen_kwargs.get('env', {}).items()]), |
| 69 | ' '.join(self.popen_args))) |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 70 | |
Neels Hofmeyr | 1a7a3f0 | 2017-06-10 01:18:27 +0200 | [diff] [blame] | 71 | self.process_obj = subprocess.Popen( |
| 72 | self.popen_args, |
| 73 | stdout=self.make_output_log('stdout'), |
| 74 | stderr=self.make_output_log('stderr'), |
| 75 | stdin=subprocess.PIPE, |
| 76 | shell=False, |
| 77 | cwd=self.run_dir.path, |
| 78 | **self.popen_kwargs) |
| 79 | self.set_name(self.name_str, pid=self.process_obj.pid) |
| 80 | self.log('Launched') |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 81 | |
| 82 | def _poll_termination(self, time_to_wait_for_term=5): |
| 83 | wait_step = 0.001 |
| 84 | waited_time = 0 |
| 85 | while True: |
| 86 | # poll returns None if proc is still running |
| 87 | self.result = self.process_obj.poll() |
| 88 | if self.result is not None: |
| 89 | return True |
| 90 | waited_time += wait_step |
| 91 | # make wait_step approach 1.0 |
| 92 | wait_step = (1. + 5. * wait_step) / 6. |
| 93 | if waited_time >= time_to_wait_for_term: |
| 94 | break |
| 95 | time.sleep(wait_step) |
| 96 | return False |
| 97 | |
| 98 | def terminate(self): |
| 99 | if self.process_obj is None: |
| 100 | return |
| 101 | if self.result is not None: |
| 102 | return |
| 103 | |
| 104 | while True: |
| 105 | # first try SIGINT to allow stdout+stderr flushing |
| 106 | self.log('Terminating (SIGINT)') |
| 107 | os.kill(self.process_obj.pid, signal.SIGINT) |
| 108 | self.killed = signal.SIGINT |
| 109 | if self._poll_termination(): |
| 110 | break |
| 111 | |
| 112 | # SIGTERM maybe? |
| 113 | self.log('Terminating (SIGTERM)') |
| 114 | self.process_obj.terminate() |
| 115 | self.killed = signal.SIGTERM |
| 116 | if self._poll_termination(): |
| 117 | break |
| 118 | |
| 119 | # out of patience |
| 120 | self.log('Terminating (SIGKILL)') |
| 121 | self.process_obj.kill() |
| 122 | self.killed = signal.SIGKILL |
| 123 | break; |
| 124 | |
| 125 | self.process_obj.wait() |
| 126 | self.cleanup() |
| 127 | |
| 128 | def cleanup(self): |
| 129 | self.close_output_logs() |
| 130 | if self.result == 0: |
| 131 | self.log('Terminated: ok', rc=self.result) |
| 132 | elif self.killed: |
| 133 | self.log('Terminated', rc=self.result) |
| 134 | else: |
| 135 | self.err('Terminated: ERROR', rc=self.result) |
Neels Hofmeyr | 85eb324 | 2017-04-09 22:01:16 +0200 | [diff] [blame] | 136 | #self.log_stdout_tail() |
| 137 | self.log_stderr_tail() |
| 138 | |
| 139 | def log_stdout_tail(self): |
| 140 | m = self.get_stdout_tail(prefix='| ') |
| 141 | if not m: |
| 142 | return |
| 143 | self.log('stdout:\n', m, '\n') |
| 144 | |
| 145 | def log_stderr_tail(self): |
| 146 | m = self.get_stderr_tail(prefix='| ') |
| 147 | if not m: |
| 148 | return |
| 149 | self.log('stderr:\n', m, '\n') |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 150 | |
| 151 | def close_output_logs(self): |
| 152 | self.dbg('Cleanup') |
| 153 | for k, v in self.outputs.items(): |
| 154 | path, f = v |
| 155 | if f: |
| 156 | f.flush() |
| 157 | f.close() |
| 158 | self.outputs[k] = (path, None) |
| 159 | |
| 160 | def poll(self): |
| 161 | if self.process_obj is None: |
| 162 | return |
| 163 | if self.result is not None: |
| 164 | return |
| 165 | self.result = self.process_obj.poll() |
| 166 | if self.result is not None: |
| 167 | self.cleanup() |
| 168 | |
Neels Hofmeyr | 5356d0a | 2017-04-10 03:45:30 +0200 | [diff] [blame] | 169 | def is_running(self, poll_first=True): |
| 170 | if poll_first: |
| 171 | self.poll() |
Neels Hofmeyr | 85eb324 | 2017-04-09 22:01:16 +0200 | [diff] [blame] | 172 | return self.process_obj is not None and self.result is None |
| 173 | |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 174 | def get_output(self, which): |
| 175 | v = self.outputs.get(which) |
| 176 | if not v: |
| 177 | return None |
| 178 | path, f = v |
| 179 | with open(path, 'r') as f2: |
| 180 | return f2.read() |
| 181 | |
| 182 | def get_output_tail(self, which, tail=10, prefix=''): |
Neels Hofmeyr | 5356d0a | 2017-04-10 03:45:30 +0200 | [diff] [blame] | 183 | out = self.get_output(which) |
| 184 | if not out: |
| 185 | return None |
| 186 | out = out.splitlines() |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 187 | tail = min(len(out), tail) |
Neels Hofmeyr | 5356d0a | 2017-04-10 03:45:30 +0200 | [diff] [blame] | 188 | return prefix + ('\n' + prefix).join(out[-tail:]) |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 189 | |
| 190 | def get_stdout(self): |
| 191 | return self.get_output('stdout') |
| 192 | |
| 193 | def get_stderr(self): |
| 194 | return self.get_output('stderr') |
| 195 | |
| 196 | def get_stdout_tail(self, tail=10, prefix=''): |
| 197 | return self.get_output_tail('stdout', tail, prefix) |
| 198 | |
| 199 | def get_stderr_tail(self, tail=10, prefix=''): |
| 200 | return self.get_output_tail('stderr', tail, prefix) |
| 201 | |
Neels Hofmeyr | 5356d0a | 2017-04-10 03:45:30 +0200 | [diff] [blame] | 202 | def terminated(self, poll_first=True): |
| 203 | if poll_first: |
| 204 | self.poll() |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 205 | return self.result is not None |
| 206 | |
Neels Hofmeyr | 5356d0a | 2017-04-10 03:45:30 +0200 | [diff] [blame] | 207 | def wait(self, timeout=300): |
Pau Espin Pedrol | 9a4631c | 2018-03-28 19:17:34 +0200 | [diff] [blame] | 208 | MainLoop.wait(self, self.terminated, timeout=timeout) |
Neels Hofmeyr | dae3d3c | 2017-03-28 12:16:58 +0200 | [diff] [blame] | 209 | |
| 210 | |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 211 | class RemoteProcess(Process): |
| 212 | |
Pau Espin Pedrol | 3895fec | 2017-04-28 16:13:03 +0200 | [diff] [blame] | 213 | def __init__(self, name, run_dir, remote_user, remote_host, remote_cwd, popen_args, **popen_kwargs): |
Neels Hofmeyr | 5356d0a | 2017-04-10 03:45:30 +0200 | [diff] [blame] | 214 | super().__init__(name, run_dir, popen_args, **popen_kwargs) |
Pau Espin Pedrol | 3895fec | 2017-04-28 16:13:03 +0200 | [diff] [blame] | 215 | self.remote_user = remote_user |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 216 | self.remote_host = remote_host |
| 217 | self.remote_cwd = remote_cwd |
| 218 | |
| 219 | # hacky: instead of just prepending ssh, i.e. piping stdout and stderr |
| 220 | # over the ssh link, we should probably run on the remote side, |
| 221 | # monitoring the process remotely. |
Neels Hofmeyr | 5356d0a | 2017-04-10 03:45:30 +0200 | [diff] [blame] | 222 | if self.remote_cwd: |
| 223 | cd = 'cd "%s"; ' % self.remote_cwd |
| 224 | else: |
| 225 | cd = '' |
Pau Espin Pedrol | 3895fec | 2017-04-28 16:13:03 +0200 | [diff] [blame] | 226 | self.popen_args = ['ssh', self.remote_user+'@'+self.remote_host, |
Neels Hofmeyr | 5356d0a | 2017-04-10 03:45:30 +0200 | [diff] [blame] | 227 | '%s%s' % (cd, |
| 228 | ' '.join(self.popen_args))] |
Neels Hofmeyr | 3531a19 | 2017-03-28 14:30:28 +0200 | [diff] [blame] | 229 | self.dbg(self.popen_args, dir=self.run_dir, conf=self.popen_kwargs) |
Neels Hofmeyr | dae3d3c | 2017-03-28 12:16:58 +0200 | [diff] [blame] | 230 | |
| 231 | # vim: expandtab tabstop=4 shiftwidth=4 |