Coverage for src/lcdoc/lp_session.py: 76.81%

1import os 1 ctxlp|task_runner.md

2import sys 1 ctxlp|task_runner.md

3import time 1 ctxlp|task_runner.md

4from functools import partial as p 1 ctxlp|task_runner.md

6from lcdoc import lp 1 ctxlp|task_runner.md

7from lcdoc.tools import write_file 1 ctxlp|task_runner.md

9env = os.environ 1 ctxlp|task_runner.md

10wait = time.sleep 1 ctxlp|task_runner.md

11now = time.time 1 ctxlp|task_runner.md

12exists = lp.exists 1 ctxlp|task_runner.md

13I = lp.I 1 ctxlp|task_runner.md

14L = lp.L 1 ctxlp|task_runner.md

16dbg = lp.dbg 1 ctxlp|task_runner.md

18is_lprunner = lp.is_lprunner 1 ctxlp|task_runner.md

21def tmux_ver_check(checked=[0]): 1 ctxlp|task_runner.md

22 """tmux -H only from 3.0"""

25 msg = 'Please install tmux, version >= 3.0' 1 ctxlp|features/lp/examples.md

26 t = os.popen('tmux -V').read().replace(' ', '') 1 ctxlp|features/lp/examples.md

27 if not t or 'tmux2' in t or 'tmux1' in t: 27 ↛ 28line 27 didn't jump to line 28, because the condition on line 27 was never true1 ctxlp|features/lp/examples.md

28 lp.app.die(msg)

29 checked[0] = 1 1 ctxlp|features/lp/examples.md

32def init_prompt(n, kw): 1 ctxlp|task_runner.md

33 """run before each command"""

45 dbg('waiting for prompt...', have=r, want=p)

46 wait(0.1)

47 raise Exception('No Prompt; Have so far: %s' % r)

50def get_cwd(session_name): 1 ctxlp|task_runner.md

51 res = srun_in_tmux('echo "::$(pwd)::"', session_name=session_name)

52 res = res.rsplit('::')[-2]

53 assert os.path.exists(res)

54 return res

57def get(session_name, **kw): 1 ctxlp|task_runner.md

58 """

59 Starts tmux if not running and delivers a srun_in_tmux function,

60 parametrized for that session.

61 """

66 global lprunner

67 from lcdoc import lprunner

69 lprunner.show_tmux(session_name)

75# :docs:configure_tmux_base_index_1

76def configure_tmux_base_index_1(session_name): 1 ctxlp|task_runner.md

77 """

78 Seems everybody really using it has 1 (on normal keyboards 0 is far away)

79 and its a hard to detect or change, especially when the messed with it outside of

80 our control.

82 On clean systems it will be just missing or: the user / runner does not care.

84 => Lets create it - when it is NOT present, so that we can have automatic CI/CD.

85 While for a normal user (who is using it) we fail if not configured correctly.

86 """

87 fn = env.get('HOME', '') + '/.tmux.conf'

88 if exists(fn):

89 return

91 lp.app.warning('!!! Writing %s to set base index to 1 !!' % fn)

92 r = [

93 'set-option -g base-index 1',

94 'set-window-option -g pane-base-index 1',

95 '',

96 ]

97 write_file(fn, '\n'.join(r))

98 lp.sprun('tmux source-file "%s"' % fn)

99 wait(0.5)

100 tmux_kill_session(session_name)

101 wait(0.5)

102 tmux_start(session_name)

103 wait(0.5)

104

105

106# :docs:configure_tmux_base_index_1

107

108

109def prompt(kw): 1 ctxlp|task_runner.md

111

112

113def tmux_start(session_name): 1 ctxlp|task_runner.md

114 # path is set new. bash (if executing user's shell is fish we'd be screwed)

117

118

119def create(session_name, kw): 1 ctxlp|task_runner.md

120 # new session:

124 # all lp vars into the session, maybe of use:

129

130 b = {'prompt': prompt(kw), 'session': s, 'lp_env': lp_env} 8 ctxlp|features/lp/bash/sessions.mdlp|features/lp/examples.mdlp|features/lp/examples.mdlp|features/lp/parameters.mdlp|features/lp/parameters.mdlp|features/lp/sessions.mdlp|features/lp/syntax.mdlp|features/lp/syntax.md

134 # the reset in init prompt needs thate time before

135 # otherwise you have the command 2 times in

138 except Exception as ex:

139 if try_nr == 1:

140 configure_tmux_base_index_1(session_name)

141 continue

142

143 msg = 'tmux session start failed. Do you have tmux, configured with'

144 msg += 'base index 1? 0 is default but will NOT work!!'

145 raise Exception(msg)

146

149 lp.sprun('tmux send-keys -t %s "sudo bash" Enter' % s)

150 wait(0.1)

151

152

153def handle_cwd_pre_post(cpp_mode, spec, session_name, timeout=1, **kw): 1 ctxlp|task_runner.md

157 cmd = t % cmd 2 ctxlp|features/lp/parameters.mdlp|features/lp/parameters.md

158 sn = session_name 2 ctxlp|features/lp/parameters.mdlp|features/lp/parameters.md

159 srun_in_tmux(cmd, session_name=sn, timeout=0.1) 2 ctxlp|features/lp/parameters.mdlp|features/lp/parameters.md

160

161

162def srun(cmds, session_name, **kw): 1 ctxlp|task_runner.md

165 for e in 'PATH', 'PYTHONPATH':

166 S('export %s="%s"' % (e, os.environ.get(e, '')), **kw)

173 tmux_kill_session(session_name) 1 ctxlp|features/lp/parameters.md

175

176

177def srun_in_tmux(cmd, session_name, expect=None, timeout=1, **kw): 1 ctxlp|task_runner.md

179

180 # TODO: clean up

183 # undocumented

185

191 do_post = p(h, 'post', cmd, session_name, **kw) 1 ctxlp|features/lp/parameters.md

192

193 # fmt:off

200 # fmt:on

201

203 time.sleep(float(cmd.split()[1]))

204 return 'silent'

205

208 cmd = cmd.split('#', 1)[0] 1 ctxlp|features/lp/parameters.md

209 lp.spresc('tmux send-keys -t %s:1 %s' % (n, cmd.split(sk, 1)[1].strip())) 1 ctxlp|features/lp/parameters.md

210 # at ci seen delays after C-c:

211 wait(0.1) 1 ctxlp|features/lp/parameters.md

212 return 'silent' 1 ctxlp|features/lp/parameters.md

213

217 # we do NOT fail on exit codes, just want to know if the command completed,

218 # by scraping the tmux output for a string:

219 # if you want the first send set -e

221 # here docs can't have ';echo -n... at last line:

222 # not match on the issuing cmd

226

228 expectb = b'des soid ned bassian - we want timeout' 1 ctxlp|features/lp/parameters.md

229 else:

233 # send the sequence as hex (-H):

235 lprunner.confirm(cmd)

238 # if is_multiline:

239 # breakpoint() # FIXME BREAKPOINT

240 # for line in cmd.splitlines():

241 # spresc("tmux send-keys -t %s:1 '%s' Enter" % (n, line))

242 # else:

243 # spresc("tmux send-keys -t %s:1 '%s' Enter" % (n, cmd))

249

254

260 dt = now() - t0 4 ctxlp|features/lp/parameters.mdlp|features/lp/parameters.mdlp|features/lp/parameters.mdlp|features/lp/sessions.md

261 if dt > timeout: 4 ctxlp|features/lp/parameters.mdlp|features/lp/parameters.mdlp|features/lp/parameters.mdlp|features/lp/sessions.md

262 if expect is False: 262 ↛ 265line 262 didn't jump to line 265, because the condition on line 262 was never false1 ctxlp|features/lp/parameters.md

263 # wanted then:

264 break 1 ctxlp|features/lp/parameters.md

265 raise Exception(

266 'Command %s: Timeout (> %s sec) expecting "%s"'

267 % (cmd, timeout, expectb.decode('utf-8'))

268 )

269

270 if now() - last_msg > 5: 270 ↛ 273line 270 didn't jump to line 273, because the condition on line 270 was never false4 ctxlp|features/lp/parameters.mdlp|features/lp/parameters.mdlp|features/lp/parameters.mdlp|features/lp/sessions.md

271 dbg('%ss[%s] Inspect: tmux att -t %s' % (round(dt, 1), timeout, n)) 4 ctxlp|features/lp/parameters.mdlp|features/lp/parameters.mdlp|features/lp/parameters.mdlp|features/lp/sessions.md

272 lst_msg = now() 4 ctxlp|features/lp/parameters.mdlp|features/lp/parameters.mdlp|features/lp/parameters.mdlp|features/lp/sessions.md

273 wait(wait_dt) # fast first 4 ctxlp|features/lp/parameters.mdlp|features/lp/parameters.mdlp|features/lp/parameters.mdlp|features/lp/sessions.md

274 wait_dt = min(timeout / 10.0, max_wait) 4 ctxlp|features/lp/parameters.mdlp|features/lp/parameters.mdlp|features/lp/parameters.mdlp|features/lp/sessions.md

275 max_wait = min(5, max_wait + 2) 4 ctxlp|features/lp/parameters.mdlp|features/lp/parameters.mdlp|features/lp/parameters.mdlp|features/lp/sessions.md

276

279 # when expect was given we include it (expect="Ready to accept Connections")

280 # expect_echo_out_cmd is empty then

285 else:

286 # the tmux window contains a lot of white space after the last output when

287 # short cmd

290 time.sleep(float(wait_after))

294 do_post() 1 ctxlp|features/lp/parameters.md

296

297

298def find_output_range(res, between, ls=b'\n'): 1 ctxlp|task_runner.md

299 """default: parse out last range in res between begin and end of between"""

300 # todo: regex

301 pre, post = res.rsplit(between[0], 1)

302 r = pre.rsplit(ls, 1)[-1] + between[0]

303 body, post = post.split(between[1], 1)

304 r += body

305 r += between[1] + post.split(ls, 1)[0]

306 return r

307

308

309def tmux_kill_session(session_name): 1 ctxlp|task_runner.md