Function test_debuggee_filename_with_space

tests/debugpy/test_args.py:120–203

Test that a debuggee filename with a space gets properly quoted in runInTerminal.

(tmpdir, run, expansion)

@pytest.mark.parametrize("run", runners.all_launch_terminal)
@pytest.mark.parametrize("expansion", ["preserve", "expand"])
def test_debuggee_filename_with_space(tmpdir, run, expansion):
    """Test that a debuggee filename with a space gets properly quoted in runInTerminal."""
    
    # Create a script file with a space in both directory and filename
    
    # Create a Python script with a space in the filename
    script_dir = tmpdir / "test dir"
    script_dir.mkdir()
    script_file = script_dir / "script with space.py"
    
    script_content = """import sys
import debuggee
from debuggee import backchannel

debuggee.setup()
backchannel.send(sys.argv)

import time
time.sleep(2)
"""
    script_file.write(script_content)
    
    captured_run_in_terminal_request = []
    captured_run_in_terminal_args = []
    
    class Session(debug.Session):
        def _process_request(self, request):
            if request.command == "runInTerminal":
                # Capture the raw runInTerminal request before any processing
                args_from_request = list(request.arguments.get("args", []))
                captured_run_in_terminal_request.append({
                    "args": args_from_request,
                    "argsCanBeInterpretedByShell": request.arguments.get("argsCanBeInterpretedByShell", False)
                })
            return super()._process_request(request)
        
        def run_in_terminal(self, args, cwd, env):
            # Capture the processed args after the framework has handled them
            captured_run_in_terminal_args.append(args[:])
            return super().run_in_terminal(args, cwd, env)
    
    argslist = ["arg1", "arg2"]
    args = argslist if expansion == "preserve" else " ".join(argslist)
    
    with Session() as session:
        backchannel = session.open_backchannel()
        target = targets.Program(script_file, args=args)
        with run(session, target):
            pass
        
        argv = backchannel.receive()
    
    assert argv == [some.str] + argslist
    
    # Verify that runInTerminal was called
    assert captured_run_in_terminal_request, "Expected runInTerminal request to be sent"
    request_data = captured_run_in_terminal_request[0]
    terminal_request_args = request_data["args"]