#!/usr/bin/env python # License: GPLv3 Copyright: 2022, Kovid Goyal import os import shlex import shutil import tempfile import unittest from contextlib import contextmanager from functools import partial from kitty.constants import is_macos, kitty_base_dir, terminfo_dir from kitty.fast_data_types import CURSOR_BEAM from kitty.shell_integration import setup_bash_env, setup_zsh_env from . import BaseTest def basic_shell_env(home_dir): ans = { 'PATH': os.environ['PATH'], 'HOME': home_dir, 'TERM': 'xterm-kitty', 'TERMINFO': terminfo_dir, 'KITTY_SHELL_INTEGRATION': 'enabled', 'KITTY_INSTALLATION_DIR': kitty_base_dir, } for x in ('USER', 'LANG'): if os.environ.get(x): ans[x] = os.environ[x] return ans def safe_env_for_running_shell(argv, home_dir, rc='', shell='zsh'): ans = basic_shell_env(home_dir) if shell == 'zsh': ans['ZLE_RPROMPT_INDENT'] = '0' with open(os.path.join(home_dir, '.zshenv'), 'w') as f: print('unset GLOBAL_RCS', file=f) with open(os.path.join(home_dir, '.zshrc'), 'w') as f: print(rc + '\n', file=f) setup_zsh_env(ans, argv) elif shell == 'bash': setup_bash_env(ans, argv) ans['KITTY_BASH_INJECT'] += ' posix' ans['KITTY_BASH_POSIX_ENV'] = os.path.join(home_dir, '.bashrc') with open(ans['KITTY_BASH_POSIX_ENV'], 'w') as f: # ensure LINES and COLUMNS are kept up to date print('shopt -s checkwinsize', file=f) if rc: print(rc, file=f) return ans class ShellIntegration(BaseTest): @contextmanager def run_shell(self, shell='zsh', rc='', cmd='', setup_env=None): home_dir = os.path.realpath(tempfile.mkdtemp()) cmd = cmd or shell cmd = shlex.split(cmd.format(**locals())) env = (setup_env or safe_env_for_running_shell)(cmd, home_dir, rc=rc, shell=shell) try: pty = self.create_pty(cmd, cwd=home_dir, env=env) i = 10 while i > 0 and not pty.screen_contents().strip(): pty.process_input_from_child() i -= 1 yield pty finally: if os.path.exists(home_dir): shutil.rmtree(home_dir) @unittest.skipUnless(shutil.which('zsh'), 'zsh not installed') def test_zsh_integration(self): ps1, rps1 = 'left>', ' ', 'line1\nprompt> ', 'line1\\nprompt> ',): with self.subTest(ps1=ps1), self.run_shell( shell='bash', rc=f''' PS1="{ps1}" ''') as pty: ps1 = ps1.replace('\\n', '\n') pty.wait_till(lambda: pty.screen_contents().count(ps1) == 1) pty.send_cmd_to_child('echo test') pty.wait_till(lambda: pty.screen_contents().count(ps1) == 2) self.ae(pty.screen_contents(), f'{ps1}echo test\ntest\n{ps1}') pty.write_to_child(r'echo $COLUMNS') pty.set_window_size(rows=20, columns=40) pty.process_input_from_child() pty.wait_till(redrawn) self.ae(ps1.splitlines()[-1] + 'echo $COLUMNS', str(pty.screen.line(pty.screen.cursor.y))) pty.write_to_child('\r') pty.wait_till(lambda: pty.screen_contents().count(ps1) == 3) self.ae('40', str(pty.screen.line(pty.screen.cursor.y - len(ps1.splitlines())))) self.ae(ps1.splitlines()[-1] + 'echo $COLUMNS', str(pty.screen.line(pty.screen.cursor.y - 1 - len(ps1.splitlines())))) # test startup file sourcing def setup_env(excluded, argv, home_dir, rc='', shell='bash'): ans = basic_shell_env(home_dir) setup_bash_env(ans, argv) for x in {'profile', 'bash.bashrc', '.bash_profile', '.bash_login', '.profile', '.bashrc'} - excluded: with open(os.path.join(home_dir, x), 'w') as f: print(f'echo {x}', file=f) ans['KITTY_BASH_ETC_LOCATION'] = home_dir return ans def run_test(argv, *expected, excluded=()): with self.subTest(argv=argv), self.run_shell(shell='bash', setup_env=partial(setup_env, set(excluded)), cmd=argv) as pty: pty.wait_till(lambda: '$' in pty.screen_contents()) q = pty.screen_contents() for x in expected: self.assertIn(x, q) run_test('bash', 'bash.bashrc', '.bashrc') run_test('bash -l', 'profile', '.bash_profile') run_test('bash -l', 'profile', '.bash_login', excluded=('.bash_profile',)) run_test('bash -l', 'profile', '.profile', excluded=('.bash_profile', '.bash_login'))