|
| 1 | +""" |
| 2 | +Pexpect-based tests for uipath debug command with LlamaIndex workflows. |
| 3 | +
|
| 4 | +Tests the interactive debugger functionality including: |
| 5 | +- Single breakpoint |
| 6 | +- Multiple breakpoints |
| 7 | +- Step mode (s command) |
| 8 | +- Quit debugger (q command) |
| 9 | +
|
| 10 | +Regression test for: ContextStateError when using wait_for_event in |
| 11 | +breakpoint wrapper (the wrapper must use an InternalContext, not the |
| 12 | +workflow-level ExternalContext). |
| 13 | +
|
| 14 | +See: https://github.com/UiPath/uipath-integrations-python/pull/274 |
| 15 | +""" |
| 16 | + |
| 17 | +import re |
| 18 | +import sys |
| 19 | +from pathlib import Path |
| 20 | +from typing import Optional |
| 21 | + |
| 22 | +import pexpect |
| 23 | +import pytest |
| 24 | + |
| 25 | + |
| 26 | +# --------------------------------------------------------------------------- |
| 27 | +# Minimal PromptTest helper (mirrors uipath-langchain-python/testcases/common) |
| 28 | +# --------------------------------------------------------------------------- |
| 29 | + |
| 30 | +def strip_ansi(text: str) -> str: |
| 31 | + return re.compile(r'\x1B(?:[@-Z\\-_]|\[[0-?]*[ -/]*[@-~])').sub('', text) |
| 32 | + |
| 33 | + |
| 34 | +class PromptTest: |
| 35 | + def __init__(self, command: str, test_name: str, prompt: str = "> ", timeout: int = 60): |
| 36 | + self.command = command |
| 37 | + self.test_name = test_name |
| 38 | + self.prompt = prompt |
| 39 | + self.timeout = timeout |
| 40 | + self.child: Optional[pexpect.spawn] = None |
| 41 | + self._log_handle = None |
| 42 | + self._log_path = Path(f"{test_name}.log") |
| 43 | + |
| 44 | + def start(self): |
| 45 | + self.child = pexpect.spawn(self.command, encoding="utf-8", timeout=self.timeout) |
| 46 | + self._log_handle = open(self._log_path, "w") |
| 47 | + self.child.logfile_read = self._log_handle |
| 48 | + |
| 49 | + def send_command(self, command: str, expect: Optional[str] = None): |
| 50 | + self.child.expect(self.prompt) |
| 51 | + self.child.sendline(command) |
| 52 | + if expect: |
| 53 | + self.child.expect(expect) |
| 54 | + |
| 55 | + def expect_eof(self): |
| 56 | + self.child.expect(pexpect.EOF, timeout=self.timeout) |
| 57 | + |
| 58 | + def get_output(self) -> str: |
| 59 | + if self._log_path.exists(): |
| 60 | + if self._log_handle: |
| 61 | + self._log_handle.flush() |
| 62 | + with open(self._log_path, "r", encoding="utf-8") as f: |
| 63 | + return strip_ansi(f.read()) |
| 64 | + return "" |
| 65 | + |
| 66 | + @property |
| 67 | + def before(self) -> str: |
| 68 | + return self.child.before if self.child else "" |
| 69 | + |
| 70 | + def close(self): |
| 71 | + if self._log_handle: |
| 72 | + self._log_handle.close() |
| 73 | + self._log_handle = None |
| 74 | + if self.child: |
| 75 | + self.child.close() |
| 76 | + self.child = None |
| 77 | + |
| 78 | + |
| 79 | +# --------------------------------------------------------------------------- |
| 80 | +# Test configuration |
| 81 | +# --------------------------------------------------------------------------- |
| 82 | + |
| 83 | +COMMAND = "uv run uipath debug agent --file input.json" |
| 84 | +PROMPT = r"> " |
| 85 | +TIMEOUT = 60 |
| 86 | + |
| 87 | + |
| 88 | +# --------------------------------------------------------------------------- |
| 89 | +# Tests |
| 90 | +# --------------------------------------------------------------------------- |
| 91 | + |
| 92 | +def test_single_breakpoint(): |
| 93 | + """Test setting and hitting a single breakpoint.""" |
| 94 | + test = PromptTest(command=COMMAND, test_name="debug_single_breakpoint", prompt=PROMPT, timeout=TIMEOUT) |
| 95 | + try: |
| 96 | + test.start() |
| 97 | + |
| 98 | + test.send_command("b classify_category", expect=r"Breakpoint set at: classify_category") |
| 99 | + test.send_command("c", expect=r"BREAKPOINT.*classify_category.*before") |
| 100 | + test.send_command("c", expect=r"Debug session completed") |
| 101 | + |
| 102 | + test.expect_eof() |
| 103 | + |
| 104 | + output = test.get_output() |
| 105 | + assert "ticket_id" in output, "Expected ticket_id in output" |
| 106 | + |
| 107 | + except (pexpect.exceptions.TIMEOUT, pexpect.exceptions.EOF) as e: |
| 108 | + print(f"\nERROR: {type(e).__name__}", file=sys.stderr) |
| 109 | + print(f"\n--- Output before failure ---\n{test.before}", file=sys.stderr) |
| 110 | + pytest.fail(f"Test failed: {e}") |
| 111 | + finally: |
| 112 | + test.close() |
| 113 | + |
| 114 | + |
| 115 | +def test_multiple_breakpoints(): |
| 116 | + """Test setting and hitting multiple breakpoints.""" |
| 117 | + test = PromptTest(command=COMMAND, test_name="debug_multiple_breakpoints", prompt=PROMPT, timeout=TIMEOUT) |
| 118 | + try: |
| 119 | + test.start() |
| 120 | + |
| 121 | + test.send_command("b analyze_sentiment", expect=r"Breakpoint set at: analyze_sentiment") |
| 122 | + test.send_command("b determine_priority", expect=r"Breakpoint set at: determine_priority") |
| 123 | + test.send_command("c", expect=r"BREAKPOINT.*analyze_sentiment.*before") |
| 124 | + test.send_command("c", expect=r"BREAKPOINT.*determine_priority.*before") |
| 125 | + test.send_command("c", expect=r"Debug session completed") |
| 126 | + |
| 127 | + test.expect_eof() |
| 128 | + |
| 129 | + output = test.get_output() |
| 130 | + breakpoint_count = output.count("BREAKPOINT") |
| 131 | + assert breakpoint_count >= 2, f"Expected at least 2 breakpoints hit, got {breakpoint_count}" |
| 132 | + |
| 133 | + except (pexpect.exceptions.TIMEOUT, pexpect.exceptions.EOF) as e: |
| 134 | + print(f"\nERROR: {type(e).__name__}", file=sys.stderr) |
| 135 | + print(f"\n--- Output before failure ---\n{test.before}", file=sys.stderr) |
| 136 | + pytest.fail(f"Test failed: {e}") |
| 137 | + finally: |
| 138 | + test.close() |
| 139 | + |
| 140 | + |
| 141 | +def test_step_mode(): |
| 142 | + """Test step mode - breaks on every node.""" |
| 143 | + test = PromptTest(command=COMMAND, test_name="debug_step_mode", prompt=PROMPT, timeout=TIMEOUT) |
| 144 | + try: |
| 145 | + test.start() |
| 146 | + |
| 147 | + # Step through all 9 workflow steps |
| 148 | + test.send_command("s", expect=r"BREAKPOINT.*analyze_sentiment.*before") |
| 149 | + test.send_command("s", expect=r"BREAKPOINT.*classify_category.*before") |
| 150 | + test.send_command("s", expect=r"BREAKPOINT.*check_urgency.*before") |
| 151 | + test.send_command("s", expect=r"BREAKPOINT.*determine_priority.*before") |
| 152 | + test.send_command("s", expect=r"BREAKPOINT.*check_escalation.*before") |
| 153 | + test.send_command("s", expect=r"BREAKPOINT.*route_to_department.*before") |
| 154 | + test.send_command("s", expect=r"BREAKPOINT.*assign_queue.*before") |
| 155 | + test.send_command("s", expect=r"BREAKPOINT.*generate_response.*before") |
| 156 | + test.send_command("s", expect=r"BREAKPOINT.*finalize_ticket.*before") |
| 157 | + test.send_command("s", expect=r"Debug session completed") |
| 158 | + |
| 159 | + test.expect_eof() |
| 160 | + |
| 161 | + output = test.get_output() |
| 162 | + breakpoint_count = output.count("BREAKPOINT") |
| 163 | + assert breakpoint_count >= 9, f"Expected at least 9 breakpoints in step mode, got {breakpoint_count}" |
| 164 | + |
| 165 | + except (pexpect.exceptions.TIMEOUT, pexpect.exceptions.EOF) as e: |
| 166 | + print(f"\nERROR: {type(e).__name__}", file=sys.stderr) |
| 167 | + print(f"\n--- Output before failure ---\n{test.before}", file=sys.stderr) |
| 168 | + pytest.fail(f"Test failed: {e}") |
| 169 | + finally: |
| 170 | + test.close() |
| 171 | + |
| 172 | + |
| 173 | +def test_quit_debugger(): |
| 174 | + """Test quitting the debugger early with 'q' command.""" |
| 175 | + test = PromptTest(command=COMMAND, test_name="debug_quit", prompt=PROMPT, timeout=TIMEOUT) |
| 176 | + try: |
| 177 | + test.start() |
| 178 | + |
| 179 | + test.send_command("b check_urgency", expect=r"Breakpoint set at: check_urgency") |
| 180 | + test.send_command("c", expect=r"BREAKPOINT.*check_urgency.*before") |
| 181 | + test.send_command("q") |
| 182 | + |
| 183 | + test.expect_eof() |
| 184 | + |
| 185 | + except (pexpect.exceptions.TIMEOUT, pexpect.exceptions.EOF) as e: |
| 186 | + print(f"\nERROR: {type(e).__name__}", file=sys.stderr) |
| 187 | + print(f"\n--- Output before failure ---\n{test.before}", file=sys.stderr) |
| 188 | + pytest.fail(f"Test failed: {e}") |
| 189 | + finally: |
| 190 | + test.close() |
| 191 | + |
| 192 | + |
| 193 | +if __name__ == "__main__": |
| 194 | + pytest.main([__file__, "-v"]) |
0 commit comments