1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
|
#!/usr/bin/env python3
"""Scenario-based pilot suite for the TUI (replaces the monolithic test_tui.py).
python3 tests/test_scenarios.py --db <session_id>
python3 tests/test_scenarios.py --db <session_id> --only hex,retype
python3 tests/test_scenarios.py --db <session_id> --list
One app/session is booted once; every ``@scenario`` runs against it in isolation:
the runner resets a known baseline before each (dismiss modals, hide the names
pane, clear the filter, focus a code view) and catches per-scenario exceptions,
so a broken/flaky scenario fails *alone* instead of cascading. Add a test = write
a small self-contained scenario that opens its own function via ``c.open(...)``.
Uses ~/ida-venv python (has textual).
--only <substr[,substr]> run only matching scenarios
--stop-after <substr> stop once a check whose name contains <substr> ran
--list print scenario names and exit
"""
import asyncio
import fnmatch
import os
import re
import sys
import traceback
sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
from idatui.app import ( # noqa: E402
ConfirmScreen, DecompView, DisasmView, FunctionsPanel, HexView, IdaTui,
HelpScreen, ListingView, QuitScreen, StringsPalette, StructEditor,
SymbolPalette, XrefsScreen, _str_display, _word_occurrences,
)
from textual.widgets import ( # noqa: E402
DataTable, Input, OptionList, Static, TextArea,
)
from rich.text import Text # noqa: E402
from idatui._sync import wait_for # noqa: E402
PASS = FAIL = 0
STOP_AFTER = None
SCENARIOS: list[tuple[str, object]] = []
class _StopSuite(Exception):
pass
def scenario(name):
def deco(fn):
SCENARIOS.append((name, fn))
return fn
return deco
# --------------------------------------------------------------------------- #
# Shared context + helpers
# --------------------------------------------------------------------------- #
class Ctx:
def __init__(self, app, pilot):
self.app = app
self.pilot = pilot
self.scenario = ""
self._biggest = None
self._pick = None
# -- assertions / primitives ------------------------------------------ #
def check(self, name, cond, detail=""):
global PASS, FAIL
tag = f"[{self.scenario}] " if self.scenario else ""
if cond:
PASS += 1
print(f" ok {tag}{name}")
else:
FAIL += 1
print(f" FAIL {tag}{name} {detail}")
if STOP_AFTER and STOP_AFTER in name:
raise _StopSuite
async def wait(self, pred, t=20.0, step=0.02):
return await wait_for(pred, self.pilot.pause, t, step)
async def press(self, *keys):
for k in keys:
await self.pilot.press(k)
async def pause(self, d=0.05):
await self.pilot.pause(d)
async def type(self, text):
for ch in text:
await self.pilot.press(ch)
def status(self):
return str(self.app.query_one("#status", Static).render())
# -- shorthands ------------------------------------------------------- #
@property
def dis(self):
return self.app.query_one(ListingView) # unified code view (was DisasmView)
@property
def dec(self):
return self.app.query_one(DecompView)
@property
def lst(self):
return self.app.query_one(ListingView)
@property
def hex(self):
return self.app.query_one(HexView)
@property
def table(self):
return self.app.query_one("#func-table", DataTable)
@property
def prog(self):
return self.app.program
# -- discovery -------------------------------------------------------- #
def all_funcs(self):
idx = self.prog.functions()
if len(idx) == 0 and not idx.complete:
idx.load_all() # a prior bump_items() cleared the index cache
return idx.all_loaded()
def find_func(self, pred, limit=400):
for f in self.all_funcs()[:limit]:
if pred(f):
return f
return None
def biggest(self):
if self._biggest is None:
self._biggest = max(self.all_funcs(), key=lambda f: f.size)
return self._biggest
def pick_decomp_ref(self):
"""(fn, line, col, sym): a decompilable function whose pseudocode (past
line 8) references a *different* sub_ function. Cached."""
if self._pick is not None:
return self._pick
for fn in self.all_funcs()[:500]:
d = self.prog.decompile(fn.addr)
if d.failed or not d.code:
continue
dl = d.code.split("\n")
if len(dl) < 12:
continue
for i, txt in enumerate(dl):
if i < 8:
continue
m = re.search(r"\b(sub_[0-9A-Fa-f]+)", txt)
if m and m.group(1) != fn.name:
self._pick = (fn, i, m.start(1), m.group(1))
return self._pick
return None
# -- navigation (setup; fast internal path) --------------------------- #
async def open(self, target, view="listing", t=25):
"""Open a function (name or ea) at its entry in the unified listing. With
``view='decomp'`` it then F5s into the pseudocode. Returns the Func."""
ea = self.prog.resolve(target) if isinstance(target, str) else int(target)
fn = self.prog.function_of(ea)
if fn is None:
raise RuntimeError(f"no function for {target!r}")
self.app._open_function(fn.addr, fn.name)
await self.wait(lambda: self.app._cur and self.app._cur.ea == fn.addr, t)
# Wait for the cursor to actually LAND on the target, not merely for
# _cur.ea to match: re-opening a function we already navigated to (its
# _cur.ea is stale-true) schedules an async re-navigation, and proceeding
# before it lands would leave the cursor parked wherever we last were.
await self.wait(lambda: self.lst.total > 0
and self.lst._cursor_ea() == fn.addr, t)
if view == "decomp":
# F5/Tab only decompiles from a focused code pane, and the listing
# may still be settling from the open above — a swallowed Tab used to
# surface much later as "pseudocode view shows: active=listing".
# Retry rather than assume the first one takes.
for _ in range(3):
self.lst.focus()
await self.pause(0.05)
await self.press("tab")
if await self.wait(lambda: self.app._active == "decomp"
and self.dec.loaded_ea == fn.addr, max(t / 3, 5)):
break
return fn
async def open_biggest(self, view="listing"):
return await self.open(self.biggest().addr, view)
async def goto_ui(self, target):
"""Navigate via the 'g' goto prompt (exercises the real UI path)."""
await self.press("g")
await self.pause(0.1)
await self.type(str(target))
await self.press("enter")
async def reveal_pane(self):
left = self.app.query_one("#left", FunctionsPanel)
if not left.display:
await self.press("ctrl+b")
await self.wait(lambda: left.display, 5)
# -- lifecycle -------------------------------------------------------- #
async def boot(self):
app = self.app
await self.wait(lambda: self.table.row_count > 0, 60)
# Load is done when the index is complete (robust vs the status line,
# which startup auto-land immediately overwrites with the landed fn).
await self.wait(
lambda: app._func_index is not None and app._func_index.complete, 60)
if app._func_index is not None and not app._func_index.complete:
app._func_index.load_all()
async def reset(self):
"""Baseline before each scenario: dismiss modals, hide inputs + the names
pane, clear the filter, default to pseudocode, focus a code view."""
app = self.app
for _ in range(4):
if len(app.screen_stack) <= 1:
break
app.pop_screen()
await self.pause(0.05)
for iid in ("search", "rename", "comment", "retype", "goto", "func-filter"):
inp = app.query_one(f"#{iid}", Input)
if inp.display:
inp.display = False
inp.can_focus = False
app.query_one("#status", Static).display = True
if app._filter_term:
app.clear_filter()
left = app.query_one("#left", FunctionsPanel)
if left.display:
left.display = False
app._pref = "decomp"
if app._active == "hex":
app._active = "decomp"
app._split = False
await self.pause(0.02)
# --------------------------------------------------------------------------- #
# Scenarios
# --------------------------------------------------------------------------- #
@scenario("startup")
async def s_startup(c: Ctx):
c.check("function list populated", c.table.row_count > 0, f"rows={c.table.row_count}")
left = c.app.query_one("#left")
c.check("names pane starts hidden (overlay-first)", not left.display,
f"display={left.display}")
await c.reveal_pane()
c.check("function pane width is capped (doesn't eat the screen)",
left.size.width <= 44, f"width={left.size.width}")
c.check("function load completed (index complete)",
c.app._func_index is not None and c.app._func_index.complete, c.status())
print(f" {c.table.row_count} functions loaded")
@scenario("auto_land")
async def s_auto_land(c: Ctx):
"""Startup lands on main()/an entry function when present, else pops the
symbol picker — never a blank pane."""
app = c.app
# simulate a fresh startup landing
for _ in range(3):
if len(app.screen_stack) > 1:
app.pop_screen()
await c.pause(0.05)
app._cur = None
app._did_auto_land = False
fn = app._entry_func()
app._auto_land()
await c.pause(0.2)
if fn is not None:
await c.wait(lambda: app._cur is not None and app._cur.ea == fn.addr, 20)
c.check("auto-land jumps to the entry function (main) when present",
app._cur is not None and app._cur.ea == fn.addr,
f"entry={fn.name}@{fn.addr:#x} cur={app._cur}")
else:
await c.wait(lambda: isinstance(app.screen, SymbolPalette), 10)
c.check("auto-land pops the symbol picker when there's no entry fn",
isinstance(app.screen, SymbolPalette), f"screen={app.screen}")
app.pop_screen()
# guard fires once: a second call is a no-op
prev = app._cur
app._auto_land()
c.check("auto-land is idempotent (guarded)", app._cur is prev)
@scenario("palette")
async def s_palette(c: Ctx):
app, pilot = c.app, c.pilot
await c.press("ctrl+n")
pal_open = await c.wait(lambda: isinstance(app.screen, SymbolPalette), 10)
c.check("Ctrl+N opens the symbol palette", pal_open,
f"screen={type(app.screen).__name__}")
if not pal_open:
return
pal = app.screen
pinp = pal.query_one(Input)
pinp.value = "main"
await c.wait(lambda: pal._results and pal._results[0][2] == "main", 10)
c.check("palette fuzzy-finds (top result matches the query)",
bool(pal._results) and pal._results[0][2] == "main",
f"top={pal._results[0][2] if pal._results else None}")
pinp.value = "eror" # scattered subsequence of 'error'
await c.wait(lambda: any(n == "error" for _, _, n in pal._results), 10)
c.check("palette matches a fuzzy subsequence",
any(n == "error" for _, _, n in pal._results),
f"results={[n for _, _, n in pal._results[:4]]}")
# Every other query here is lowercase, which is how a case bug hid for so
# long: the name was lowered but the query wasn't, so ONE capital matched
# nothing. Invisible on lowercase C symbols, fatal on a library that
# capitalises (PEM_read_bio found 0 of 10093 functions in libcrypto).
pinp.value = "MAIN"
await c.wait(lambda: any(n == "main" for _, _, n in pal._results), 10)
c.check("palette matching is case-insensitive in BOTH directions",
any(n == "main" for _, _, n in pal._results),
f"results={[n for _, _, n in pal._results[:4]]}")
pinp.value = "main"
await c.wait(lambda: pal._results and pal._results[0][2] == "main", 10)
want = pal._results[0][1]
await c.press("enter")
await c.wait(lambda: not isinstance(app.screen, SymbolPalette), 10)
await c.wait(lambda: app._cur and app._cur.ea == want, 20)
c.check("selecting a palette entry opens that function",
bool(app._cur) and app._cur.ea == want,
f"cur={app._cur.ea if app._cur else None}")
# Re-open the function we are ALREADY standing on. That used to append an
# identical nav entry, and the extra Esc it bought popped the stack without
# changing anything on screen — a dead keypress, which is precisely what
# "back is broken" feels like from the keyboard.
depth = len(app._nav)
await c.press("ctrl+n")
await c.wait(lambda: isinstance(app.screen, SymbolPalette), 10)
pal2 = app.screen
pal2.query_one(Input).value = "main"
await c.wait(lambda: pal2._results and pal2._results[0][2] == "main", 10)
await c.press("enter")
await c.wait(lambda: not isinstance(app.screen, SymbolPalette), 10)
await c.pause(0.4)
c.check("re-opening the current function doesn't stack a duplicate",
len(app._nav) == depth, f"nav {depth} -> {len(app._nav)}")
await c.press("ctrl+n")
await c.wait(lambda: isinstance(app.screen, SymbolPalette), 10)
await c.press("escape")
await c.wait(lambda: not isinstance(app.screen, SymbolPalette), 10)
c.check("Esc closes the palette", not isinstance(app.screen, SymbolPalette))
@scenario("load_options")
async def s_load_options(c: Ctx):
"""The dialog must never appear for a file IDA can load itself — the whole
suite runs on an ELF, so a false positive here would block every run."""
from idatui.app import LoadOptionsScreen
app = c.app
c.check("no load dialog for a recognised binary",
not isinstance(app.screen, LoadOptionsScreen),
f"screen={type(app.screen).__name__}")
c.check("and the app agrees it shouldn't ask",
not app._should_ask_load_options())
# The dialog itself, driven directly: it has to come back with switches the
# worker can use, and -b has to be paragraphs.
from idatui.formats import load_args, needs_load_options, sniff
c.check("the running target sniffs as a real format",
sniff(app._open_path) is not None and not needs_load_options(app._open_path),
f"{sniff(app._open_path)}")
c.check("dialog output converts a base to paragraphs",
load_args("arm", 0x8000000) == "-parm -b800000")
@scenario("command_palette")
async def s_command_palette(c: Ctx):
app = c.app
await c.open_biggest("listing")
await c.press("ctrl+p")
opened = await c.wait(
lambda: type(app.screen).__name__ == "CommandPalette", 10)
c.check("Ctrl+P opens the command palette", opened,
f"screen={type(app.screen).__name__}")
if not opened:
return
inp = app.screen.query_one(Input)
inp.value = "hex" # filter to the 'Hex view' command
await c.pause(0.5) # let the async search + option list settle
await c.press("enter")
landed = await c.wait(lambda: app._active == "hex", 10)
c.check("a palette command executes (Hex view opens)", landed,
f"active={app._active}")
if landed:
await c.press("backslash") # leave hex
await c.wait(lambda: app._active != "hex", 5)
@scenario("quit_guard")
async def s_quit_guard(c: Ctx):
app = c.app
c.check("a clean database reports nothing unsaved", app._dirty_labels() == [],
f"{app._dirty_labels()}")
app._dirty = True # as an edit would
c.check("an edited database is reported unsaved",
len(app._dirty_labels()) == 1, f"{app._dirty_labels()}")
await c.press("q")
asked = await c.wait(lambda: isinstance(app.screen, QuitScreen), 10)
c.check("quitting with unsaved changes asks first", asked and app.is_running,
f"screen={type(app.screen).__name__} running={app.is_running}")
if not asked:
return
await c.press("escape")
await c.wait(lambda: not isinstance(app.screen, QuitScreen), 10)
c.check("Esc cancels the quit and stays put",
app.is_running and not isinstance(app.screen, QuitScreen))
# leave it clean so the rest of the suite (and teardown) isn't affected
app._dirty = False
app._save_on_exit = False
@scenario("help")
async def s_help(c: Ctx):
app = c.app
st = app.query_one("#status", Static)
c.check("the status line owns the bottom row (no footer cheatsheet)",
st.region.y + st.region.height == app.size.height,
f"status={st.region} screen={app.size}")
await c.press("f1")
opened = await c.wait(lambda: isinstance(app.screen, HelpScreen), 10)
c.check("F1 opens the key cheatsheet", opened,
f"screen={type(app.screen).__name__}")
if not opened:
return
cards = app.screen.query(".help-card")
titles = {str(w.border_title) for w in cards}
txt = " ".join(str(w.render()) for w in cards)
c.check("each key group gets its own card",
titles == {"Navigate", "Views", "Move", "Edit", "Search"}, f"{titles}")
c.check("it documents real bindings",
"set type" in txt and "split view" in txt and "cross-references" in txt)
body = app.screen.query_one("#help-body")
c.check("the cards fit without a scrollbar at a normal size",
body.virtual_size.height <= body.size.height,
f"content={body.virtual_size.height} view={body.size.height}")
await c.press("escape")
await c.wait(lambda: not isinstance(app.screen, HelpScreen), 10)
c.check("Esc closes it", not isinstance(app.screen, HelpScreen))
@scenario("strings")
async def s_strings(c: Ctx):
app = c.app
await c.open_biggest("listing")
items = app.program.strings()
c.check("program.strings() lists the binary's literals", len(items) > 3,
f"n={len(items)}")
if not items:
return
c.check("strings carry addr/text/length",
all(s.addr > 0 and s.text and s.length > 0 for s in items[:5]),
f"first={items[0]}")
await c.press("quotation_mark")
opened = await c.wait(lambda: isinstance(app.screen, StringsPalette), 25)
c.check('\'"\' opens the strings browser', opened,
f"screen={type(app.screen).__name__}")
if not opened:
return
pal = app.screen
c.check("the browser lists strings", len(pal._results) > 0,
f"results={len(pal._results)}")
# filter on a fragment of a real (unescaped) literal
target = next((s for s in items
if len(s.text) >= 6 and _str_display(s.text) == s.text), None)
if target is not None:
frag = target.text[:6]
pal.query_one(Input).value = frag
await c.pause(0.2)
ok = (pal._results
and all(frag.lower() in t.lower() for _, _, t in pal._results))
c.check("filtering narrows to matching strings", bool(ok),
f"frag={frag!r} n={len(pal._results)}")
want = pal._results[0][1]
await c.press("enter")
await c.wait(lambda: not isinstance(app.screen, StringsPalette), 10)
landed = await c.wait(lambda: c.lst._cursor_ea() == want, 20)
c.check("Enter jumps to the string in the unified listing", landed,
f"cursor={c.lst._cursor_ea()} want={want:#x}")
else:
await c.press("escape")
@scenario("split_view")
async def s_split_view(c: Ctx):
app, lst, dec = c.app, c.lst, c.dec
await c.open_biggest("listing")
await c.press("s")
shown = await c.wait(lambda: app._split and lst.display and dec.display, 20)
c.check("'s' enters split view (both panes shown)", shown,
f"split={app._split} lst={lst.display} dec={dec.display}")
loaded = await c.wait(lambda: dec.loaded_ea == app._cur.ea, 25)
c.check("split loads the pseudocode alongside the listing", loaded,
f"loaded={dec.loaded_ea} cur={app._cur.ea if app._cur else None}")
await c.wait(lambda: "[split" in c.status(), 5)
c.check("split view shows a split-aware status", "[split" in c.status(),
f"status={c.status()!r}")
# phase 3: the rich per-line instruction map (decomp_map tool, run on the
# pilot's real worker) — verify it returns, aligns with the markers, and
# bands a whole region for a multi-instruction C line.
m = app.program.decomp_map(app._cur.ea)
c.check("decomp_map returns per-line ea sets", len(m) > 5, f"lines={len(m)}")
aligned = sum(1 for i in range(min(len(m), len(dec._line_eas)))
if m[i] and dec._line_eas[i] is not None
and dec._line_eas[i] in m[i])
c.check("decomp_map aligns with the pseudocode markers", aligned >= 3,
f"aligned={aligned}/{len(dec._line_eas)}")
multi = next((i for i, eas in enumerate(m) if len(eas) > 1), None)
if multi is not None:
app._split_eamap = m
dec.focus() # the decomp must BE the driver for a decomp-driven
app._active = "decomp" # sync (else its align() re-syncs listing-driven)
dec.cursor = multi
dec._scroll_cursor_into_view() # key-nav always does; the anchor needs it
await c.pause(0.1)
app._sync_split("decomp")
await c.pause(0.1)
c.check("a multi-instruction C line bands a region (>1 listing row)",
len(lst._link_rows) > 1,
f"line={multi} eas={len(m[multi])} rows={sorted(lst._link_rows)[:8]}")
lst.focus()
app._active = "listing"
await c.pause(0.05)
else:
c.check("a multi-instruction C line bands a region (>1 listing row)",
True, "no multi-instruction line in this function (skipped)")
# listing drives: move it, the decomp band must track the covering C line
lst.focus()
for _ in range(6):
await c.press("j")
await c.pause(0.2)
lea = lst._cursor_ea()
dl = dec._link_line
c.check("listing cursor links the covering pseudocode line",
dl is not None and lea is not None and dec._line_eas[dl] is not None
and dec._line_eas[dl] <= lea,
f"link_line={dl} lea={hex(lea) if lea else None}")
# the companion pane sits LEVEL with the driver's cursor (visual coherence):
# the linked row lands at the same viewport offset, not merely on-screen.
deep = [i for i, eas in enumerate(m) if eas][10:]
row = lst.model.ensure_ea(m[deep[0]][0]) if (deep and lst.model) else None
if row is not None and row > 12:
lst.scroll_to(y=row - 10, animate=False)
await c.pause(0.2) # let the deferred scroll land
lst.cursor = row # driver cursor now at viewport offset 10
app._sync_split("listing")
await c.pause(0.2) # let the companion's scroll land
drv = lst.cursor - round(lst.scroll_offset.y)
link, top = dec._link_line, round(dec.scroll_offset.y)
# exact, modulo the unavoidable clamps (can't scroll above line 0, nor
# past the end when the pseudocode is shorter than the viewport)
want = min(max(0, (link or 0) - drv),
max(0, dec.total - dec._visible_height()))
c.check("the companion pane sits level with the driver's cursor",
link is not None and top == want,
f"driver_row={drv} link={link} dec_top={top} want={want}")
# a PURE scroll (wheel/scrollbar) moves no cursor — it must still drag
# the companion along (anchors on the viewport once the cursor is gone)
before_cur, before_dec = lst.cursor, round(dec.scroll_offset.y)
lst.scroll_to(y=round(lst.scroll_offset.y) + 30, animate=False)
await c.pause(0.35)
c.check("a pure scroll in the driver drags the companion along",
lst.cursor == before_cur
and round(dec.scroll_offset.y) != before_dec,
f"cursor {before_cur}->{lst.cursor} "
f"dec_top {before_dec}->{round(dec.scroll_offset.y)}")
await c.press("tab")
await c.pause(0.1)
c.check("Tab in split focuses the pseudocode pane", app._active == "decomp",
f"active={app._active}")
# decomp drives: put the cursor on an addressed pseudocode line (past the
# variable decls); the listing band must track the covering instruction row.
target = next((i for i, e in enumerate(dec._line_eas) if e is not None), None)
c.check("pseudocode has addressed lines", target is not None,
"no /*0xEA*/ markers in the pseudocode")
if target is not None:
dec.cursor = target
dec._scroll_cursor_into_view()
await c.pause(0.1)
app._sync_split("decomp")
await c.pause(0.1)
want = lst.model.ensure_ea(dec._line_eas[target])
c.check("decomp cursor links the instruction row in the listing",
want in lst._link_rows,
f"link_rows={sorted(lst._link_rows)[:6]} want={want}")
# and that linked row actually paints a background band (base rows have
# no bg; `want` is a deep code row, never the listing's own cursor row)
lst.reveal(want)
await c.pause(0.05)
y = want - round(lst.scroll_offset.y)
banded = (0 <= y < lst.size.height and any(
s.style and s.style.bgcolor is not None for s in lst.render_line(y)))
c.check("the linked instruction row renders a highlight band", banded,
f"y={y} cursor_row={lst.cursor}")
await c.press("tab")
await c.pause(0.1)
c.check("Tab again focuses the listing pane", app._active == "listing",
f"active={app._active}")
# a mouse click on the other pane also makes it the driver (not just Tab)
await c.pilot.click(DecompView, offset=(10, 5))
await c.pause(0.15)
c.check("clicking the pseudocode pane makes it the driver",
app._active == "decomp", f"active={app._active}")
await c.press("tab") # restore listing as the driver
await c.pause(0.1)
# cross-function follow: the listing cursor leaving the decompiled function
# re-points the decomp pane to whatever function it's now in.
await c.wait(lambda: app._split_range is not None, 10)
other = c.find_func(lambda f: f.addr != app._cur.ea and f.size > 40)
row = lst.model.ensure_ea(other.addr) if other is not None else None
if other is not None and row is not None and row >= 0:
lst.focus()
app._active = "listing"
lst.cursor = row
lst._scroll_cursor_into_view()
await c.pause(0.1)
app._sync_split("listing") # cursor now outside the decompiled fn
followed = await c.wait(lambda: dec.loaded_ea == other.addr, 25)
c.check("listing cursor crossing into another function re-syncs the decomp",
followed, f"dec={dec.loaded_ea} want={other.addr}")
# navigation in split keeps BOTH panes on the (new) function
nf = c.find_func(lambda f: f.addr != app._cur.ea and f.size > 80)
if nf is not None:
await c.press("g")
await c.type(hex(nf.addr))
await c.press("enter")
nav = await c.wait(lambda: app._cur and app._cur.ea == nf.addr, 15)
c.check("goto in split navigates", nav,
f"cur={app._cur.ea if app._cur else None} want={nf.addr}")
both = await c.wait(lambda: dec.loaded_ea == nf.addr and app._split
and lst.display and dec.display, 25)
c.check("split reloads both panes on navigation", both,
f"dec={dec.loaded_ea} split={app._split}")
await c.press("s")
gone = await c.wait(lambda: not app._split and lst.display
and not dec.display, 10)
c.check("'s' exits split back to a single view", gone,
f"split={app._split} lst={lst.display} dec={dec.display}")
c.check("exiting split clears the link bands",
not lst._link_rows and dec._link_line is None,
f"rows={lst._link_rows} line={dec._link_line}")
@scenario("decomp_fallback")
async def s_fallback(c: Ctx):
app = c.app
failing = next((f for f in reversed(c.all_funcs())
if c.prog.decompile(f.addr).failed), None)
if failing is None:
c.check("found a decompile-failing function", False)
return
# Open the failing function in the listing, then F5: decompile fails -> the
# view stays on the linear listing (no error panel).
await c.open(failing.addr, "listing")
c.dis.focus()
await c.press("tab")
await c.wait(lambda: app._active == "listing"
and "fail" in c.status().lower(), 25)
c.check("F5/Tab on an undecompilable function falls back to the listing",
app._active == "listing" and c.dis.display,
f"active={app._active} status={c.status()!r}")
# a decompilable function F5s into pseudocode
await c.open("main", "decomp")
c.check("a decompilable function F5s into pseudocode",
app._active == "decomp" and c.dec.display, f"active={app._active}")
@scenario("structs")
async def s_structs(c: Ctx):
app = c.app
await c.press("ctrl+t")
se_open = await c.wait(lambda: isinstance(app.screen, StructEditor), 10)
c.check("Ctrl+T opens the struct editor", se_open,
f"screen={type(app.screen).__name__}")
if not se_open:
return
se = app.screen
await c.wait(lambda: bool(se._structs), 15)
c.check("struct editor lists existing structs", len(se._structs) > 0,
f"n={len(se._structs)}")
ta = se.query_one(TextArea)
tname = next((s.name for s in se._structs if s.name == "timespec"),
se._structs[0].name)
idx = next(i for i, s in enumerate(se._structs) if s.name == tname)
se.query_one(OptionList).highlighted = idx
se.on_option_list_option_selected(type("E", (), {"option_index": idx})())
await c.wait(lambda: tname in ta.text and "{" in ta.text, 15)
c.check("selecting a struct shows its C definition",
tname in ta.text and "{" in ta.text, f"text={ta.text[:40]!r}")
app._clipboard = ""
se.query_one(TextArea).focus()
await c.press("ctrl+y")
await c.wait(lambda: app._clipboard == ta.text, 10)
c.check("Ctrl+Y copies the struct definition to the clipboard",
bool(app._clipboard) and app._clipboard == ta.text,
f"clip_len={len(app._clipboard)}")
sname = "TuiEdTest"
await c.press("ctrl+n")
await c.pause(0.05)
ta.text = f"struct {sname} {{ int a; char b[8]; }};"
await c.press("ctrl+s")
await c.wait(lambda: any(s.name == sname for s in se._structs), 15)
c.check("Ctrl+S declares a new struct",
any(s.name == sname for s in se._structs), "not created")
await c.wait(lambda: "\n" in ta.text, 10)
c.check("save auto-formats the definition in the editor",
ta.text.count("\n") >= 3 and f"struct {sname}" in ta.text
and not se._is_dirty(), f"text={ta.text[:50]!r}")
idx = next(i for i, s in enumerate(se._structs) if s.name == sname)
se.on_option_list_option_selected(type("E", (), {"option_index": idx})())
await c.wait(lambda: sname in ta.text, 10)
ta.text = f"struct {sname} {{ int a; char b[8]; long c; }};"
await c.press("ctrl+s")
await c.wait(lambda: next((s.members for s in se._structs if s.name == sname), 0) == 3, 15)
c.check("Ctrl+S updates an existing struct in place",
next((s.members for s in se._structs if s.name == sname), 0) == 3,
"member count not 3")
ta.text = f"struct {sname} {{ int a; char b[8]; long c; int __unused; }};"
await c.press("ctrl+s")
await c.wait(lambda: "save failed" in str(se.query_one("#se-status").render()), 15)
st = str(se.query_one("#se-status").render())
c.check("a rejected save fails loudly, naming the reserved field",
"save failed" in st and "__unused" in st, f"status={st!r}")
c.check("a rejected save leaves the struct unchanged",
next((s.members for s in se._structs if s.name == sname), 0) == 3, "changed")
c.check("a rejected save keeps your edited text", "__unused" in ta.text)
other = next(i for i, s in enumerate(se._structs) if s.name != sname)
se.on_option_list_option_selected(type("E", (), {"option_index": other})())
guard = await c.wait(lambda: isinstance(app.screen, ConfirmScreen), 10)
c.check("unsaved edits prompt before switching structs", guard,
f"screen={type(app.screen).__name__}")
await c.press("enter")
await c.wait(lambda: isinstance(app.screen, StructEditor) and not se._is_dirty(), 15)
idx = next(i for i, s in enumerate(se._structs) if s.name == sname)
se.query_one(OptionList).focus()
se.query_one(OptionList).highlighted = idx
await c.press("d")
confirmed = await c.wait(lambda: isinstance(app.screen, ConfirmScreen), 10)
c.check("delete asks for confirmation", confirmed,
f"screen={type(app.screen).__name__}")
await c.press("enter")
await c.wait(lambda: isinstance(app.screen, StructEditor), 10)
await c.wait(lambda: not any(s.name == sname for s in se._structs)
or "del_type" in str(se.query_one("#se-status").render()), 15)
st = str(se.query_one("#se-status").render())
gone = not any(s.name == sname for s in se._structs)
c.check("confirming delete removes the struct (or reports missing tool)",
gone or "del_type" in st, f"gone={gone} status={st!r}")
se.query_one(OptionList).focus()
await c.press("escape")
await c.wait(lambda: not isinstance(app.screen, StructEditor), 10)
c.check("Esc closes the struct editor", not isinstance(app.screen, StructEditor))
@scenario("open_default_view")
async def s_open(c: Ctx):
app = c.app
fn = c.biggest()
app._open_function(fn.addr, fn.name)
await c.wait(lambda: app._cur and app._cur.ea == fn.addr, 20)
await c.wait(lambda: c.lst.total > 0, 30)
c.check("opening a function shows the linear listing by default",
app._active == "listing" and c.lst.display and c.lst.total > 0,
f"active={app._active} total={c.lst.total}")
print(f" biggest = {fn.name} ({c.lst.total} listing rows)")
@scenario("disasm_nav")
async def s_disasm_nav(c: Ctx):
app, view = c.app, c.dis
await c.open_biggest("listing")
view.focus()
c.check("first instruction cached",
view.model is not None and view.model.cached_line(0) is not None)
for _ in range(5):
await c.press("pagedown")
await c.pause(0.025)
c.check("pagedown moved the cursor", view.cursor > 0, f"cursor={view.cursor}")
await c.wait(lambda: view.model.cached_line(view.cursor) is not None, 15)
c.check("cursor line eventually cached (bg fetch)",
view.model.cached_line(view.cursor) is not None)
c.check("status shows an address", "@ 0x" in c.status(), c.status())
# Ctrl+Y copies the current code line.
view.focus()
cur_line = view._line_plain(view.cursor)
app._clipboard = ""
await c.press("ctrl+y")
await c.wait(lambda: app._clipboard == cur_line, 10)
c.check("Ctrl+Y copies the current code line to the clipboard",
bool(cur_line) and app._clipboard == cur_line, f"clip={app._clipboard!r}")
# goto-bottom must not hang on a huge function (ctrl+end; plain 'end' now
# moves the cursor to end-of-line).
await c.press("ctrl+end")
await c.pause(0.05)
c.check("goto-bottom lands near end", view.cursor >= view.total - 1,
f"cursor={view.cursor}/{view.total}")
@scenario("hex")
async def s_hex(c: Ctx):
app, view = c.app, c.dis
await c.open_biggest("listing")
view.focus()
view.cursor = 4 # a non-entry instruction
await c.pause(0.05)
code_ea = view._cursor_ea()
await c.press("backslash")
await c.wait(lambda: app._active == "hex", 10)
hx = c.hex
await c.wait(lambda: hx.model is not None
and hx.model.row(hx.cursor // 16)[1] is not None, 20)
c.check("backslash opens the hex view synced to the code cursor",
app._active == "hex" and code_ea is not None and hx.cursor_va() == code_ea,
f"active={app._active} hexva={hx.cursor_va():#x} ea={code_ea}")
want = app.program.read_bytes(code_ea, 1)
_, rb = hx.model.row(hx.cursor // 16)
c.check("hex shows the actual byte at that address",
rb is not None and rb[hx.cursor % 16] == want[0],
f"got={rb[hx.cursor % 16] if rb else None} want={want[0]}")
await c.press("l")
await c.pause(0.1)
c.check("hex cursor steps one byte", hx.cursor_va() == code_ea + 1,
f"va={hx.cursor_va():#x}")
fo = app.program.file_offset(hx.cursor_va())
c.check("hex carries a file offset for a mapped (.text) address",
fo is not None and hx.model.file_offset(hx.cursor_va()) == fo, f"fo={fo}")
rng = app.program.image_range()
target_va = rng[0] + (rng[1] - rng[0]) // 2
await c.press("g")
await c.pause(0.1)
await c.type(hex(target_va))
await c.press("enter")
await c.wait(lambda: hx.cursor_va() == target_va, 15)
c.check("'g' in the hex view jumps the cursor to an address",
hx.cursor_va() == target_va, f"va={hx.cursor_va():#x} want={target_va:#x}")
# -- a user scroll freezes the cursor's screen row (points at a new byte) --
await c.press("g")
await c.type(hex(rng[0]))
await c.press("enter")
await c.wait(lambda: hx.cursor_va() == rng[0], 10)
for _ in range(8): # cursor to viewport row 8 (top still 0)
await c.press("j")
await c.pause(0.1)
top0 = round(hx.scroll_offset.y)
screen_row = hx.cursor // 16 - top0
hx.scroll_to(y=top0 + 30, animate=False) # user scroll down 30 rows
await c.pause(0.15)
top1 = round(hx.scroll_offset.y)
c.check("hex viewport scrolled", top1 >= top0 + 20, f"top0={top0} top1={top1}")
c.check("hex cursor's screen row stays frozen on scroll",
hx.cursor // 16 - top1 == screen_row,
f"screen_row={screen_row} now={hx.cursor // 16 - top1} top1={top1}")
PAD = 1 # HexView { padding: 0 1 } -> content is inset one col
await c.pilot.click(HexView, offset=(PAD + 19 + 3 * 3, 5)) # hex byte 3, row 5
await c.pause(0.1)
c.check("clicking the hex pane moves the cursor to the clicked byte",
hx.cursor == (top1 + 5) * 16 + 3,
f"cursor={hx.cursor} want={(top1 + 5) * 16 + 3} top1={top1}")
await c.pilot.click(HexView, offset=(PAD + 70 + 10, 7)) # ascii byte 10, row 7
await c.pause(0.1)
c.check("clicking the ascii pane maps to the right byte",
hx.cursor == (top1 + 7) * 16 + 10,
f"cursor={hx.cursor} want={(top1 + 7) * 16 + 10}")
await c.press("backslash")
await c.wait(lambda: app._active != "hex", 10)
c.check("backslash returns from hex to the code view",
app._active == "listing", f"active={app._active}")
@scenario("filter")
async def s_filter(c: Ctx):
app, table = c.app, c.table
await c.reveal_pane()
nfuncs = table.row_count
# row selection opens a function
fn = c.biggest()
ridx = next((i for i in range(nfuncs)
if int(str(table.get_row_at(i)[0]), 16) == fn.addr), 0)
table.move_cursor(row=ridx)
table.focus()
await c.press("enter")
await c.wait(lambda: app._cur and app._cur.ea == fn.addr, 20)
c.check("selecting a table row opens that function",
bool(app._cur) and app._cur.ea == fn.addr, f"cur={app._cur.ea if app._cur else None}")
# filter round-trip. Derive the glob from real names: this used to hardcode
# 'sub_1*', which matches NOTHING in a binary whose code never reaches
# 0x1xxx (echo's functions are sub_2xxx..sub_7xxx) — a deterministic failure
# that looked like a flake, and left the table empty for the next scenario.
subs = sorted(f.name for f in c.all_funcs() if f.name.startswith("sub_"))
term = (subs[0][:5] + "*") if subs else ""
want = sum(1 for f in c.all_funcs()
if fnmatch.fnmatch(f.name.lower(), term.lower())) if term else 0
c.check("picked a glob that actually matches (test self-check)",
0 < want < nfuncs, f"term={term!r} want={want} of {nfuncs}")
table.focus()
await c.press("slash")
await c.pause(0.05)
for ch in term:
await c.press(ch if ch != "*" else "asterisk")
await c.press("enter")
filtered = await c.wait(lambda: table.row_count == want, 15)
c.check("filter narrowed the list to exactly the matches", filtered,
f"term={term!r} rows={table.row_count} want={want} of {nfuncs}")
# pane toggle
left = app.query_one("#left", FunctionsPanel)
await c.press("ctrl+b")
await c.pause(0.05)
c.check("ctrl+b hides functions pane + focuses the code view",
not left.display and isinstance(app.focused, (ListingView, DecompView)),
f"display={left.display} focus={type(app.focused).__name__}")
await c.press("ctrl+b")
await c.pause(0.05)
c.check("ctrl+b again restores pane + focuses table",
left.display and isinstance(app.focused, DataTable),
f"display={left.display} focus={type(app.focused).__name__}")
@scenario("view_toggle")
async def s_view_toggle(c: Ctx):
app, dis, dec = c.app, c.dis, c.dec
await c.open_biggest("decomp")
pc = await c.wait(lambda: dec.display and dec.loaded_ea is not None
and app._active == "decomp", 25)
c.check("pseudocode view shows", pc, f"active={app._active}")
c.check("pseudocode has many lines", dec.total > 20, f"lines={dec.total}")
styled = any(seg.style is not None and seg.style.color is not None
for strip in dec._strips[:min(dec.total, 200)] for seg in strip)
c.check("pseudocode is syntax-highlighted", styled)
# Cancelling a prompt must hand focus back to the pane you were READING.
# _code_view() used to choose on _pref, which was only ever "listing", so it
# focused the hidden listing and the pseudocode stopped answering the
# keyboard — arrows did nothing at all until you clicked.
dec.focus()
await c.pause(0.05)
line0 = dec.cursor
await c.press("g")
await c.wait(lambda: app.query_one("#goto", Input).display, 10)
await c.press("escape")
await c.wait(lambda: not app.query_one("#goto", Input).display, 10)
await c.press("down")
await c.press("down")
await c.pause(0.2)
c.check("cancelling goto leaves focus in the pseudocode (arrows still work)",
dec.cursor > line0,
f"cursor {line0} -> {dec.cursor} focus={type(app.focused).__name__}")
dec.focus() # Tab only toggles the view from a code pane; elsewhere it's
await c.pause(0.05) # focus-next, which would silently leave us in decomp
await c.press("tab")
# decomp -> listing runs through _toggle_to_listing, a background worker, so
# _active only flips once the listing model has loaded. A fixed pause held in
# a short run and lost the race in a full one.
switched = await c.wait(lambda: app._active == "listing" and dis.display
and not dec.display, 20)
c.check("tab switches to disassembly", switched,
f"active={app._active} split={app._split} "
f"focus={type(app.focused).__name__} "
f"lst={dis.display} dec={dec.display}")
# _toggle_to_listing repositions asynchronously; F5 below reads the listing
# cursor's ea and no-ops if it isn't on an addressed row yet.
await c.wait(lambda: c.lst._cursor_ea() is not None, 10)
# F5/Tab from the listing must raise the 'decompiling…' overlay synchronously,
# BEFORE the background decompile runs (regression: it used to decompile first
# in _decomp_from_listing, so the overlay only flashed once cached).
dec.loaded_ea = None
app.action_toggle_view()
cover = dec._cover_widget
c.check("F5 from the listing raises the 'decompiling…' overlay",
dec.loading and cover is not None and "decomp-loading" in cover.classes
and "decompiling" in str(cover.render()),
f"loading={dec.loading} cover={cover!r}")
await c.wait(lambda: app._active == "decomp" and not dec.loading
and dec._cover_widget is None, 25)
c.check("overlay clears when the decompile finishes",
not dec.loading and dec._cover_widget is None)
# F5 on an ALREADY-loaded function must still clear the overlay (regression:
# the F5-raised overlay had nothing to clear it in the 'already loaded' branch
# -> spinner stuck forever).
await c.press("tab") # -> listing
await c.wait(lambda: app._active == "listing", 10)
app.action_toggle_view() # F5 the same, cached function again
cleared = await c.wait(lambda: app._active == "decomp" and not dec.loading
and dec._cover_widget is None, 15)
c.check("re-decompiling an already-loaded function clears the overlay", cleared,
f"loading={dec.loading} cover={dec._cover_widget!r}")
# line-number gutter
dec.scroll_to(0, 0, animate=False)
await c.pause(0.025)
row0 = "".join(seg.text for seg in dec.render_line(0))
c.check("pseudocode has a numbered gutter (line 1 first)",
dec._gutter > 0 and row0[:dec._gutter].strip() == "1",
f"gutter={dec._gutter} row0={row0[:10]!r}")
# Home/End move along the line here too (they used to scroll to top/bottom).
line = next((i for i, t in enumerate(dec._texts)
if t.startswith(" ") and t.strip()), None)
if line is not None:
text = dec._texts[line]
dec.focus()
dec.cursor, dec.cursor_x = line, 0
dec.refresh()
await c.pause(0.05)
top = round(dec.scroll_offset.y)
await c.press("end")
await c.pause(0.05)
c.check("<end> in pseudocode goes to end-of-line, not the bottom",
dec.cursor == line and dec.cursor_x == max(len(text) - 1, 0)
and round(dec.scroll_offset.y) == top,
f"line={dec.cursor} col={dec.cursor_x} len={len(text)}")
await c.press("home")
await c.pause(0.05)
c.check("<home> in pseudocode goes to start-of-line",
dec.cursor == line and dec.cursor_x == 0,
f"line={dec.cursor} col={dec.cursor_x}")
await c.press("shift+home")
await c.pause(0.05)
c.check("<shift+home> skips the indentation",
dec.cursor_x == len(text) - len(text.lstrip()),
f"col={dec.cursor_x} indent={len(text) - len(text.lstrip())}")
await c.press("ctrl+end")
await c.pause(0.1)
c.check("<ctrl+end> still goes to the bottom",
dec.cursor >= dec.total - 1, f"{dec.cursor}/{dec.total}")
await c.press("ctrl+home")
await c.pause(0.1)
c.check("<ctrl+home> still goes to the top", dec.cursor == 0,
f"{dec.cursor}")
@scenario("search")
async def s_search(c: Ctx):
app, dis = c.app, c.dis
await c.open_biggest("listing")
dis.focus()
# derive the term from the instruction at the cursor (the function entry),
# not segment head 0 (which may still be streaming in)
line0 = dis.model.cached_line(dis.cursor)
raw = (line0.text.split() or ["push"])[0] if line0 else "push"
term = "".join(ch for ch in raw if ch.isalnum())[:4] or "push"
await c.press("slash")
await c.pause(0.1)
await c.type(term)
await c.press("enter")
# the unified listing searches the whole segment (load_all) -> allow time
await c.wait(lambda: bool(dis._matches), 45)
c.check("search finds matches", len(dis._matches) > 0, f"term={term!r}")
c.check("cursor sits on a match", dis.cursor in dis._matches, f"cursor={dis.cursor}")
c.check("match substring highlighted",
bool(dis._ranges.get(dis.cursor)), str(dis._ranges.get(dis.cursor)))
c.check("search cursor lands on the match's starting column",
bool(dis._ranges.get(dis.cursor))
and dis.cursor_x == dis._ranges[dis.cursor][0][0],
f"cursor_x={dis.cursor_x} ranges={dis._ranges.get(dis.cursor)}")
prev = dis.cursor
await c.press("slash")
await c.pause(0.05)
await c.press("enter")
await c.pause(0.05)
c.check("'/' repeats to next match",
dis.cursor != prev and dis.cursor in dis._matches, f"cursor={dis.cursor}")
await c.press("question_mark")
await c.pause(0.05)
await c.press("enter")
await c.pause(0.05)
c.check("'?' repeats to previous match", dis.cursor in dis._matches,
f"cursor={dis.cursor}")
# incremental preview + visible bar + Esc cancel
si = app.query_one("#search", Input)
status = app.query_one("#status", Static)
await c.press("slash")
await c.pause(0.1)
c.check("search bar visible, status hidden (no overlap)",
si.display and not status.display, f"si={si.display} status={status.display}")
c.check("search input owns the bottom row (nothing overlaps it)",
si.region.height >= 1
and si.region.y + si.region.height == app.size.height,
f"search={si.region} screen={app.size}")
for ch in term:
await c.press(ch)
await c.pause(0.05)
c.check("matches highlight incrementally (before Enter)",
len(dis._matches) > 0 and si.value == term, f"val={si.value!r}")
await c.press("escape")
await c.pause(0.1)
c.check("Esc cancels: status restored, matches cleared",
status.display and not si.display and not dis._matches,
f"status={status.display} si={si.display} m={len(dis._matches)}")
@scenario("incr_filter")
async def s_incr_filter(c: Ctx):
app, table = c.app, c.table
await c.reveal_pane()
table.focus()
full = table.row_count
await c.press("slash")
await c.pause(0.1)
for ch in "sub_":
await c.press(ch)
await c.pause(0.05)
await c.pause(0.1)
c.check("filter narrows incrementally as you type",
0 < table.row_count < full, f"{table.row_count}/{full}")
cell = table.get_row_at(0)[1]
c.check("filter highlights matched substring in name",
isinstance(cell, Text) and any(s.style for s in cell.spans), repr(str(cell)))
await c.press("enter")
await c.pause(0.1)
c.check("Enter keeps filter + focuses table",
isinstance(app.focused, DataTable) and table.row_count < full)
await c.press("escape")
await c.pause(0.15)
c.check("Esc on the list clears the filter", table.row_count == full,
f"{table.row_count}/{full}")
@scenario("follow_xrefs")
async def s_follow_xrefs(c: Ctx):
app, dis, dec = c.app, c.dis, c.dec
await c.open_biggest("listing")
dis.focus()
lines = dis.model.lines(0, 400, prefetch=False)
call_idx = next((i for i, ln in enumerate(lines)
if ln.text.startswith("call ")), None)
if call_idx is None:
c.check("found a call line to exercise follow/xrefs", False, "no call in first 400")
return
dis.cursor = call_idx
dis.refresh()
orig = app._cur.ea
orig_name = app._cur.name
depth = len(app._nav)
await c.press("enter")
await c.wait(lambda: len(app._nav) > depth, 25)
c.check("Enter follows the call into another function",
app._cur.ea != orig and len(app._nav) > depth, f"cur={app._cur.ea:#x}")
await c.press("escape")
await c.pause(0.1)
c.check("Esc returns from the follow", app._cur.ea == orig, f"cur={app._cur.ea:#x}")
dis.cursor = call_idx
dis.refresh()
await c.press("x")
opened = await c.wait(lambda: isinstance(app.screen, XrefsScreen), 25)
c.check("'x' opens the xrefs popup", opened, f"screen={type(app.screen).__name__}")
if opened:
c.check("xrefs popup has entries",
app.screen.query_one(OptionList).option_count >= 1)
await c.press("escape")
await c.pause(0.1)
c.check("Esc closes the xrefs popup", not isinstance(app.screen, XrefsScreen))
xf = None
for cand in c.all_funcs()[:600]:
codex = [x for x in app.program.xrefs_to(cand.addr) if x.type == "code" and x.frm]
if codex:
xf = (cand, codex[0])
break
if xf is None:
c.check("found a function with a code xref", False)
else:
xfn, xref = xf
await c.goto_ui(xfn.name)
await c.wait(lambda: c.lst.total > 0 and app._cur.ea == xfn.addr, 20)
c.lst.focus()
await c.press("x")
await c.wait(lambda: isinstance(app.screen, XrefsScreen), 25)
app.screen.query_one(OptionList).highlighted = 0
await c.press("enter")
await c.wait(lambda: not isinstance(app.screen, XrefsScreen), 25)
# xref-select lands the listing cursor on the referencing SITE (frm)
await c.wait(lambda: c.lst._cursor_ea() == xref.frm, 25)
c.check("xref-select lands the cursor on the referencing site",
c.lst._cursor_ea() == xref.frm,
f"cur_ea={c.lst._cursor_ea()} want={xref.frm:#x}")
# F5 at the site decompiles the referencing function
c.lst.focus()
await c.press("tab")
landed = await c.wait(
lambda: (app._active == "decomp" and dec.loaded_ea == xref.fn_addr)
or (app._active == "listing" and "fail" in c.status().lower()), 25)
if app._active == "decomp":
c.check("F5 at the xref site decompiles the referencing function",
dec.loaded_ea == xref.fn_addr, f"loaded={dec.loaded_ea}")
await c.press("tab")
await c.wait(lambda: app._active == "listing", 20)
app._open_function(orig, orig_name)
await c.wait(lambda: dis.total > 0 and app._cur.ea == orig, 20)
dis.model.lines(0, 400, prefetch=False)
dis.focus()
dis.cursor = call_idx
dis.cursor_x = 5
dis.refresh()
await c.pause(0.025)
await c.press("h")
c.check("h moves the column cursor left", dis.cursor_x == 4, f"x={dis.cursor_x}")
await c.press("l", "l")
c.check("l moves the column cursor right", dis.cursor_x == 6, f"x={dis.cursor_x}")
plain = dis._line_plain(call_idx) or ""
m = re.search(r"\b(sub_[0-9A-Fa-f]+)", plain)
if m:
dis.cursor = call_idx
dis.cursor_x = m.start(1) + 1
dis.refresh()
await c.pause(0.05)
c.check("word-under-cursor is the operand symbol",
dis.word_under_cursor() == m.group(1),
f"{dis.word_under_cursor()!r} vs {m.group(1)!r}")
depth = len(app._nav)
want = app.program.resolve(m.group(1))
await c.press("enter")
await c.wait(lambda: len(app._nav) > depth, 25)
c.check("follows the symbol under the cursor",
app._cur.ea == want, f"cur={app._cur.ea:#x} want={want:#x}")
@scenario("xref_labels")
async def s_xref_labels(c: Ctx):
from collections import Counter, defaultdict
app, dis, dec = c.app, c.dis, c.dec
multi = None
for cand in c.all_funcs()[:200]:
callers = Counter(x.fn_addr for x in app.program.xrefs_to(cand.addr) if x.fn_name)
if any(n >= 2 for n in callers.values()):
multi = cand
break
if multi is None:
c.check("found a function with multiple same-caller xrefs", False)
return
await c.open(multi.addr, "listing")
dis.focus()
dis.cursor = max(dis.model.index_of_ea(multi.addr), 0) # segment head at fn
dis.cursor_x = 0
dis.refresh()
await c.press("x")
await c.wait(lambda: isinstance(app.screen, XrefsScreen), 25)
labels = [t for _, t in app.screen._items]
locs = [l.split("[")[0].split(None, 1)[1].strip() for l in labels]
byfn = defaultdict(set)
for x in locs:
if "+0x" in x:
nm, off = x.split("+0x", 1)
byfn[nm].add(off)
c.check("xref labels distinguish multiple sites in a function by offset",
any(len(offs) >= 2 for offs in byfn.values()), f"locs={locs[:8]}")
c.check("no xref label is a bare '?'", all(x != "?" for x in locs), f"locs={locs[:8]}")
await c.press("escape")
await c.wait(lambda: not isinstance(app.screen, XrefsScreen), 25)
# pre-selection: 'x' at a call site highlights that site in the dialog
bycaller = defaultdict(list)
for x in app.program.xrefs_to(multi.addr):
if x.fn_name and x.type == "code":
bycaller[x.fn_addr].append(x)
csites = next((sorted(v, key=lambda x: x.frm)
for v in bycaller.values() if len(v) >= 2), None)
if not csites:
c.check("found a caller with multiple sites for preselect", False)
return
site = csites[len(csites) // 2]
await c.open(site.fn_addr, "decomp")
li = app._decomp_line_for(site.fn_addr, site.frm)
col = dec._texts[li].find(multi.name) if 0 <= li < len(dec._texts) else -1
if col < 0:
c.check("found the callee token for preselect", False)
return
dec.focus()
dec.cursor, dec.cursor_x = li, col + 1
dec.refresh()
await c.pause(0.05)
await c.press("x")
await c.wait(lambda: isinstance(app.screen, XrefsScreen), 25)
hl = app.screen.query_one(OptionList).highlighted
it = app.screen._items
c.check("xref dialog pre-selects the site it was invoked from",
hl is not None and it[hl][0] == site.frm,
f"hl={hl} frm={hex(it[hl][0]) if hl is not None else None} want={hex(site.frm)}")
await c.press("escape")
await c.wait(lambda: not isinstance(app.screen, XrefsScreen), 25)
@scenario("mouse")
async def s_mouse(c: Ctx):
app, dis = c.app, c.dis
await c.open_biggest("listing")
dis.focus()
await c.pause(0.1)
mrow = mcol = msym = mline = None
for _ in range(40):
top = round(dis.scroll_offset.y)
dis.model.lines(top, dis.size.height + 2, prefetch=False)
for r in range(min(dis.size.height, dis.total - top)):
plain = dis._line_plain(top + r)
if plain and "call" in plain:
mm = re.search(r"\b(sub_[0-9A-Fa-f]+)", plain)
if mm:
mrow, mcol, msym, mline = r, mm.start(1), mm.group(1), top + r
break
if mrow is not None:
break
await c.press("pagedown")
await c.pause(0.025)
if mrow is None:
c.check("found a call line for the mouse test", False, "no visible call sub_")
return
await c.pilot.click(dis, offset=(mcol + 1, mrow))
await c.pause(0.05)
c.check("single click places the cursor on the clicked token",
dis.cursor == mline and dis.word_under_cursor() == msym,
f"cursor={dis.cursor} (want {mline}) word={dis.word_under_cursor()!r}")
depth = len(app._nav)
want = app.program.resolve(msym)
await c.pilot.click(dis, offset=(mcol + 1, mrow), times=2)
await c.wait(lambda: len(app._nav) > depth, 25)
c.check("double-click follows the symbol", app._cur.ea == want,
f"cur={app._cur.ea:#x} want={want:#x}")
await c.press("escape")
await c.wait(lambda: app._cur.ea != want, 20)
await c.wait(lambda: dis.total > 0 and dis.cursor == mline, 20)
c.check("back restores the exact line + column",
dis.cursor == mline and dis.word_under_cursor() == msym,
f"cursor={dis.cursor} (want {mline}) word={dis.word_under_cursor()!r}")
@scenario("decomp_nav")
async def s_decomp_nav(c: Ctx):
app, dis, dec = c.app, c.dis, c.dec
pick = c.pick_decomp_ref()
if pick is None:
c.check("found a pseudocode line to test decomp nav", False)
return
fn, drow, dcol, dsym = pick
await c.open(fn.addr, "decomp")
dec.focus()
dec.cursor, dec.cursor_x = drow, dcol
dec._after_cursor_move()
await c.pause(0.05)
depth = len(app._nav)
await c.press("enter") # follow the sym under the pseudocode cursor
await c.wait(lambda: len(app._nav) > depth, 25)
await c.press("escape")
await c.wait(lambda: dec.loaded_ea == fn.addr, 25)
await c.pause(0.1)
c.check("pseudocode-view position restored after jump+back",
dec.cursor == drow and dec.word_under_cursor() == dsym,
f"cursor={dec.cursor} (want {drow}) word={dec.word_under_cursor()!r}")
# follow works with a STALE name (post-rename): ea-marker fallback
dstale = app.program.resolve(dsym)
old_line = dec._texts[drow] if drow < len(dec._texts) else ""
old_ea = dec._line_ea(drow)
if old_ea is not None and dsym in old_line:
tmp = f"stale_{os.getpid()}"
app.program.client.call("rename", batch={"func": {"addr": hex(dstale), "name": tmp}})
app.program.bump_names()
d2 = len(app._nav)
app._follow_decomp(old_line, dsym, old_ea)
await c.wait(lambda: len(app._nav) > d2, 25)
c.check("decomp follow works with a stale name (ea-marker fallback)",
app._cur.ea == dstale, f"cur={app._cur.ea:#x} want={dstale:#x}")
app.program.client.call("rename", batch={"func": {"addr": hex(dstale), "name": dsym}})
app.program.bump_names()
@scenario("decomp_follow_self")
async def s_decomp_follow_self(c: Ctx):
# Follow a name NOT in refs (the function's own name at line 0): the
# resolve() fallback still navigates. Isolated so no stale decompile
# worker from another jump can race the view back.
app, dec = c.app, c.dec
pick = c.pick_decomp_ref()
if pick is None:
c.check("found a function to test self-follow", False)
return
fn = pick[0]
await c.open(fn.addr, "decomp")
nx = dec._texts[0].find(fn.name) if dec._texts else -1
if nx < 0:
c.check("found the function name on line 0", False)
return
dec.focus()
dec.cursor, dec.cursor_x = 0, nx + 1
dec.refresh()
await c.pause(0.05)
depth = len(app._nav)
await c.press("enter")
moved = await c.wait(lambda: len(app._nav) > depth, 25)
c.check("decompiler follows a name not in refs (resolve fallback)",
moved and app._cur.ea == fn.addr,
f"moved={moved} cur={hex(app._cur.ea)} want={hex(fn.addr)}")
@scenario("sort")
async def s_sort(c: Ctx):
app, table = c.app, c.table
await c.reveal_pane()
await c.pilot.click(table, offset=(15, 0)) # Function header
await c.pause(0.15)
snames = [str(table.get_row_at(i)[1]) for i in range(min(20, table.row_count))]
c.check("click Function header sorts by name",
app._sort_col == 1 and snames == sorted(snames, key=str.lower),
f"sort_col={app._sort_col}")
first_asc = str(table.get_row_at(0)[1])
await c.pilot.click(table, offset=(15, 0)) # reverse
await c.pause(0.15)
c.check("click again reverses the sort",
app._sort_reverse and str(table.get_row_at(0)[1]) != first_asc)
await c.pilot.click(table, offset=(3, 0)) # Address header
await c.pause(0.15)
saddrs = [int(str(table.get_row_at(i)[0]), 16) for i in range(min(20, table.row_count))]
c.check("click Address header sorts by address",
app._sort_col == 0 and saddrs == sorted(saddrs), f"sort_col={app._sort_col}")
@scenario("rename")
async def s_rename(c: Ctx):
app, dec = c.app, c.dec
pick = c.pick_decomp_ref()
if pick is None:
c.check("found a pseudocode ref to rename", False)
return
fn, drow, dcol, dsym = pick
dtarget = app.program.resolve(dsym)
await c.open(fn.addr, "decomp")
dec.focus()
dec.cursor, dec.cursor_x = drow, dcol + 1
dec.refresh()
await c.pause(0.05)
newname = f"ren_{os.getpid()}"
await c.press("n")
await c.pause(0.1)
ri = app.query_one("#rename", Input)
c.check("'n' opens the rename prompt prefilled with the symbol",
ri.display and ri.value == dsym, f"val={ri.value!r}")
ri.value = newname
await c.press("enter")
await c.wait(lambda: app._func_index.by_addr(dtarget)
and app._func_index.by_addr(dtarget).name == newname, 25)
c.check("rename updates the function name",
app._func_index.by_addr(dtarget).name == newname,
app._func_index.by_addr(dtarget).name)
rr = app.program.client.call("rename", batch={"func": {"addr": hex(dtarget), "name": dsym}})
c.check("rename reverted cleanly",
rr.get("summary", {}).get("ok", 0) == 1, str(rr.get("summary")))
# goto label refuse
def _find_label():
for i, t in enumerate(dec._texts):
mm = re.search(r"\bLABEL_\d+\b", t)
if mm:
return i, mm.start(), mm.group(0)
return None
lab = _find_label()
if lab is None:
await c.open("main", "decomp")
lab = _find_label()
if lab is not None:
li, lc, _ = lab
dec.focus()
dec.cursor, dec.cursor_x = li, lc + 1
dec.refresh()
await c.pause(0.05)
await c.press("n")
await c.pause(0.1)
ri2 = app.query_one("#rename", Input)
c.check("renaming a pseudocode label is refused with a clear message",
(not ri2.display) and "label" in c.status().lower(),
f"display={ri2.display} status={c.status()!r}")
else:
c.check("found a pseudocode label to test", False, "no LABEL_ found")
# comment via ';'
cline = next((i for i in range(len(dec._texts))
if i > 5 and dec._line_ea(i) is not None
and dec._texts[i].strip() and "//" not in dec._texts[i]), None)
if cline is not None:
cea = dec._line_ea(cline)
dec.focus()
dec.cursor, dec.cursor_x = cline, 2
dec.refresh()
await c.pause(0.05)
await c.press("semicolon")
await c.pause(0.1)
ci = app.query_one("#comment", Input)
cnote = f"note_{os.getpid()}"
c.check("';' opens the comment prompt on the current line", ci.display,
f"display={ci.display}")
ci.value = cnote
await c.press("enter")
await c.wait(lambda: dec.loaded_ea == app._cur.ea
and any(cnote in t for t in dec._texts), 25)
c.check("comment appears in the pseudocode after ';'",
any(cnote in t for t in dec._texts), "comment not shown")
app.program.client.call("set_comments", items=[{"addr": hex(cea), "comment": ""}])
else:
c.check("found a pseudocode line to comment", False, "no marker line")
@scenario("comment_func")
async def s_comment_func(c: Ctx):
# Commenting the signature/declaration line (which carries no address) falls
# back to a function-level comment at the entry ea instead of being refused.
app, dec = c.app, c.dec
pick = c.pick_decomp_ref()
if pick is None:
c.check("found a function for the comment test", False)
return
fn = pick[0]
await c.open(fn.addr, "decomp")
dec.focus()
dec.cursor, dec.cursor_x = 0, 2 # the signature line
dec.refresh()
await c.pause(0.05)
c.check("signature line has no address of its own", dec._line_ea(0) is None,
f"ea={dec._line_ea(0)}")
await c.press("semicolon")
await c.pause(0.1)
ci = app.query_one("#comment", Input)
note = f"fn_note_{os.getpid()}"
c.check("';' on the signature line opens a function-comment prompt",
ci.display and "function comment" in str(ci.placeholder).lower(),
f"display={ci.display} ph={ci.placeholder!r}")
# literal '\n' in the comment becomes a real newline -> multi-line render
a, b = f"{note}_A", f"{note}_B"
ci.value = f"{a}\\n{b}"
await c.press("enter")
await c.wait(lambda: dec.loaded_ea == fn.addr
and any(a in t for t in dec._texts)
and any(b in t for t in dec._texts), 25)
la = next((i for i, t in enumerate(dec._texts) if a in t), None)
lb = next((i for i, t in enumerate(dec._texts) if b in t), None)
c.check("multi-line function comment renders on separate lines",
la is not None and lb is not None and lb > la
and a not in dec._texts[lb],
f"la={la} lb={lb}")
app.program.client.call("set_comments", items=[{"addr": hex(fn.addr), "comment": ""}])
@scenario("retype")
async def s_retype(c: Ctx):
app, dec = c.app, c.dec
cf = await c.open("main", "decomp")
fts = app.program.func_types(cf.addr)
if fts is None or not fts.prototype:
c.check("got structured function types (func_types tool)", False)
return
old_proto = fts.prototype
nm_col = dec._texts[0].find(cf.name)
dec.focus()
dec.cursor, dec.cursor_x = 0, (nm_col + 1 if nm_col >= 0 else 0)
dec.refresh()
await c.pause(0.05)
await c.press("y")
await c.wait(lambda: app.query_one("#retype", Input).display, 10)
ri = app.query_one("#retype", Input)
c.check("'y' on a function prefills its prototype",
ri.display and ri.value == old_proto, f"val={ri.value!r} want={old_proto!r}")
ri.value = f"void __fastcall {cf.name}(int zz_retype_arg)"
await c.press("enter")
await c.wait(lambda: (lambda f: bool(f) and "zz_retype_arg" in f.prototype)(
app.program.func_types(cf.addr)), 20)
after = app.program.func_types(cf.addr)
c.check("applying a retype changes the function prototype",
after is not None and "zz_retype_arg" in after.prototype,
f"proto={after.prototype if after else None!r}")
app.program.set_function_type(cf.addr, old_proto) # restore
# the retype above kicked off a recompile+reload; let it land before we start
# placing the cursor, or the reload resets it under us.
app.program.bump_names()
await c.wait(lambda: not dec.loading and dec.loaded_ea == cf.addr
and bool(dec._texts), 25)
await c.pause(0.3)
# -- 'y' on a LOCAL variable retypes that variable, not the prototype --- #
fts = app.program.func_types(cf.addr)
lv = next((v for v in (fts.lvars if fts else []) if not v.is_arg), None)
if lv is not None:
line = next((i for i, t in enumerate(dec._texts)
if _word_occurrences(t, lv.name)), None)
if line is not None:
col = _word_occurrences(dec._texts[line], lv.name)[0][0]
dec.focus()
dec.cursor, dec.cursor_x = line, col + 1 # inside the word
dec.refresh()
await c.pause(0.05)
await c.press("y")
await c.wait(lambda: app.query_one("#retype", Input).display, 10)
ri = app.query_one("#retype", Input)
c.check("'y' on a local variable prefills that variable's type",
ri.value == lv.type and lv.name in str(ri.placeholder),
f"val={ri.value!r} want={lv.type!r} ph={ri.placeholder!r}")
ri.value = "unsigned __int64"
await c.press("enter")
changed = await c.wait(lambda: (lambda f: bool(f) and any(
v.name == lv.name and v.type == "unsigned __int64"
for v in f.lvars))(app.program.func_types(cf.addr)), 25)
c.check("applying it retypes the local variable", changed,
f"{lv.name}: wanted unsigned __int64")
after = app.program.func_types(cf.addr)
c.check("retyping a local leaves the prototype alone",
after is not None and after.prototype == old_proto,
f"proto={after.prototype if after else None!r}")
# -- 'y' on a GLOBAL retypes the global, not the enclosing function ----- #
# The lvar retype above recompiled too — settle again, or the scan below
# indexes into pseudocode that's about to be replaced.
await c.wait(lambda: not dec.loading and dec.loaded_ea == cf.addr
and bool(dec._texts), 25)
await c.pause(0.3)
# Pick a global that actually appears as a word in the pseudocode — a symbol
# from decompile().refs often doesn't (a string ref renders as its literal).
lvnames = {v.name for v in (fts.lvars if fts else [])}
glob = None
for i, t in enumerate(dec._texts):
for w in re.findall(r"[A-Za-z_][A-Za-z0-9_]*", t):
if w in lvnames or w == cf.name:
continue
try:
a = app.program.resolve(w)
except Exception: # noqa: BLE001
continue
if app.program.func_types(a) is not None:
continue
d = app.program.data_type(a) or {}
if (d.get("name") and not d.get("is_func")
and "(" not in (d.get("type") or "")):
glob = (w, a, d, i)
break
if glob:
break
if glob is not None:
gname, gaddr, dt, line = glob
glob = type("G", (), {"addr": gaddr})() # keep the checks below readable
if line is not None:
col = _word_occurrences(dec._texts[line], gname)[0][0]
dec.focus()
dec.cursor, dec.cursor_x = line, col + 1 # inside the word
dec.refresh()
await c.pause(0.05)
c.check("the cursor sits on the global",
dec.word_under_cursor() == gname,
f"word={dec.word_under_cursor()!r} want={gname!r} "
f"line={line} col={col} text={dec._texts[line][:60]!r}")
await c.press("y")
await c.wait(lambda: app.query_one("#retype", Input).display, 10)
ri = app.query_one("#retype", Input)
c.check("'y' on a global prefills the global's type (not the proto)",
ri.value != old_proto and gname in str(ri.placeholder),
f"val={ri.value!r} ph={ri.placeholder!r}")
ri.value = "unsigned __int64"
await c.press("enter")
retyped = await c.wait(
lambda: (app.program.data_type(glob.addr) or {}).get("type")
== "unsigned __int64", 25)
c.check("applying it retypes the global", retyped,
f"type={(app.program.data_type(glob.addr) or {}).get('type')!r}")
after = app.program.func_types(cf.addr)
c.check("retyping a global leaves the prototype alone",
after is not None and after.prototype == old_proto,
f"proto={after.prototype if after else None!r}")
if dt.get("type"): # restore
app.program.set_data_type(glob.addr, dt["type"])
@scenario("scroll_restore")
async def s_scroll_restore(c: Ctx):
app, dis = c.app, c.dis
big = sorted(c.all_funcs(), key=lambda f: f.size, reverse=True)
fa = next((f for f in big if f.size > 0x400), big[0])
fb = next((f for f in big if f.addr != fa.addr), big[-1])
await c.goto_ui(fa.name)
await c.wait(lambda: dis.total > 40 and app._cur.ea == fa.addr, 20)
if app._active != "listing":
await c.press("tab")
await c.pause(0.1)
for _ in range(4):
await c.press("ctrl+d")
await c.pause(0.1)
base = round(dis.scroll_offset.y)
mid = base + min(dis.size.height // 2, max(dis.total - base - 1, 0))
dis.cursor, dis.cursor_x = mid, 0
dis.refresh()
dis._after_cursor_move()
await c.pause(0.05)
want_sy, want_cur = round(dis.scroll_offset.y), dis.cursor
want_rel = want_cur - want_sy
await c.goto_ui(fb.name)
await c.wait(lambda: app._cur.ea == fb.addr, 20)
renders: list[int] = []
_orig_rl = dis.render_line
def _traced(y, _o=_orig_rl):
if y == 0:
renders.append(round(dis.scroll_offset.y))
return _o(y)
dis.render_line = _traced
await c.press("escape")
await c.wait(lambda: app._cur.ea == fa.addr, 20)
await c.wait(lambda: dis.total > 40, 20)
await c.pause(0.25)
c.check("disasm scroll + cursor restored on back (mid-viewport)",
round(dis.scroll_offset.y) == want_sy and dis.cursor == want_cur and want_rel > 0,
f"scroll={round(dis.scroll_offset.y)} (want {want_sy}) "
f"cursor={dis.cursor} (want {want_cur}) rel_before={want_rel}")
c.check("pane is repainted at the restored scroll (no stale top frame)",
bool(renders) and renders[-1] == want_sy,
f"last repaint scroll={renders[-1] if renders else None} (want {want_sy})")
dis.render_line = _orig_rl
@scenario("paging")
async def s_paging(c: Ctx):
app, dis = c.app, c.dis
big = sorted(c.all_funcs(), key=lambda f: f.size, reverse=True)
fa = next((f for f in big if f.size > 0x400), big[0])
await c.goto_ui(fa.name)
await c.wait(lambda: dis.total > 100 and app._cur.ea == fa.addr, 20)
if app._active != "listing":
await c.press("tab")
await c.pause(0.1)
for _ in range(6):
await c.press("j")
await c.pause(0.05)
rel = dis.cursor - round(dis.scroll_offset.y)
await c.press("pagedown")
await c.pause(0.05)
c.check("PageDown preserves the viewport-relative row",
dis.cursor - round(dis.scroll_offset.y) == rel,
f"rel={dis.cursor - round(dis.scroll_offset.y)} want={rel}")
await c.press("pageup")
await c.pause(0.05)
c.check("PageUp preserves the viewport-relative row",
dis.cursor - round(dis.scroll_offset.y) == rel,
f"rel={dis.cursor - round(dis.scroll_offset.y)} want={rel}")
@scenario("rename_history")
async def s_rename_history(c: Ctx):
app, dis, dec = c.app, c.dis, c.dec
await c.open_biggest("listing")
bea = app._cur.ea
await c.press("tab") # warm the caller's pseudocode too
await c.wait(lambda: dec.loaded_ea == bea, 20)
await c.press("tab")
dis.focus()
await c.pause(0.1)
hrow = hsym = None
for _ in range(40):
top = round(dis.scroll_offset.y)
dis.model.lines(top, dis.size.height + 2, prefetch=False)
for r in range(min(dis.size.height, dis.total - top)):
p = dis._line_plain(top + r)
if p and "call sub_" in p:
mm = re.search(r"\bcall (sub_[0-9A-Fa-f]+)", p)
if mm:
hrow, hsym = top + r, mm.group(1)
break
if hrow is not None:
break
await c.press("pagedown")
await c.pause(0.025)
if hrow is None:
c.check("found a call sub_ for the rename-history test", False)
return
htarget = app.program.resolve(hsym)
await c.goto_ui(hsym)
await c.wait(lambda: app._cur.ea == htarget, 20)
if app._active != "decomp":
await c.press("tab")
await c.wait(lambda: dec.loaded_ea == htarget, 20)
nx = dec._texts[0].find(hsym) if dec._texts else -1
if nx < 0:
c.check("found the callee name in its pseudocode", False)
return
dec.focus()
dec.cursor, dec.cursor_x = 0, nx + 1
dec.refresh()
await c.pause(0.05)
hnew = f"h_{os.getpid()}"
await c.press("n")
await c.pause(0.1)
app.query_one("#rename", Input).value = hnew
await c.press("enter")
await c.wait(lambda: app._func_index.by_addr(htarget)
and app._func_index.by_addr(htarget).name == hnew, 25)
if app._active != "listing":
await c.press("tab")
await c.press("escape")
await c.wait(lambda: dis.total > 0 and app._cur.ea != htarget, 25)
await c.pause(0.2)
dis.model.lines(hrow, 4, prefetch=False)
await c.pause(0.1)
hline = dis._line_plain(hrow)
c.check("caller disasm shows renamed callee after 'back'",
hline is not None and hnew in hline, f"line={hline!r}")
await c.press("tab")
await c.wait(lambda: dec.loaded_ea == bea, 25)
await c.pause(0.15)
c.check("caller pseudocode shows renamed callee after 'back'",
any(hnew in tx for tx in dec._texts), "pseudocode still stale")
app.program.client.call("rename", batch={"func": {"addr": hex(htarget), "name": hsym}})
@scenario("region_define")
async def s_region_define(c: Ctx):
"""A non-function address opens a flat listing (region) instead of being
refused, and 'p' there creates a function and upgrades the view."""
app = c.app
fn = c.find_func(lambda f: 0x10 <= f.size <= 0x60 and f.name.startswith("sub_"))
if fn is None:
c.check("found a small sub_ function for the region test", False)
return
addr, size = fn.addr, fn.size
try:
# setup: undefine the whole function so [addr, addr+size) is a bare region
c.prog.undefine(addr, size=size)
c.prog.bump_items()
c.check("function removed by undefine",
c.prog.function_of(addr) is None, "still a function")
# navigate there via the real 'g' prompt -> opens the flat LISTING view
# (a non-function region), not refused
await c.goto_ui(hex(addr))
await c.wait(lambda: app._cur is not None and app._cur.ea == addr, 25)
c.check("goto to a non-function address opens the listing view (not refused)",
app._cur is not None and app._cur.is_region
and app._active == "listing" and c.lst.display,
f"cur={app._cur} active={app._active} status={c.status()!r}")
await c.wait(lambda: c.lst.total > 0 and c.lst._cursor_ea() is not None, 25)
c.check("listing renders heads and the cursor sits on the target address",
c.lst.total > 0 and c.lst._cursor_ea() == addr,
f"total={c.lst.total} cur_ea={c.lst._cursor_ea()}")
# the flat listing spans the whole segment, not just this function
seg = c.prog.segment_bounds(addr)
c.check("listing spans the whole segment (more heads than one function)",
seg is not None and c.lst.total > 1, f"total={c.lst.total} seg={seg}")
# 'p' on the entry head (re)creates the function and UPGRADES to DisasmView
c.lst.focus()
c.lst.cursor, c.lst.cursor_x = c.lst.model.index_of_ea(addr), 0
await c.pause(0.05)
await c.press("p")
await c.wait(lambda: c.prog.function_of(addr) is not None
and app._cur is not None and not app._cur.is_region, 25)
c.check("'p' creates a function and upgrades the listing to a function view",
c.prog.function_of(addr) is not None and not app._cur.is_region
and app._cur.ea == addr and app._active in ("listing", "decomp"),
f"fn={c.prog.function_of(addr)} cur={app._cur} active={app._active}")
finally:
# idempotency: guarantee the function is back even if a check failed
if c.prog.function_of(addr) is None:
try:
c.prog.define_func(addr)
except Exception: # noqa: BLE001
pass
c.prog.bump_items()
@scenario("listing_view")
async def s_listing_view(c: Ctx):
"""The flat listing view over a data segment: renders code AND data heads,
navigates, and reaches hex — without any function in play."""
app = c.app
# find a data segment (has a non-code head somewhere) via the listing itself
data_ea = None
for start, end, name in c.prog.sections():
if start >= end:
continue
lm = c.prog.listing(start)
if lm is None:
continue
lm.ensure(40)
if any(h.kind == "data" for h in lm.window(0, 40)):
data_ea = start
break
if data_ea is None:
c.check("found a segment with data items", False)
return
await c.goto_ui(hex(data_ea))
await c.wait(lambda: app._cur is not None and app._active == "listing"
and c.lst.total > 0, 25)
c.check("navigating to a data segment opens the listing view",
app._active == "listing" and c.lst.display and c.lst.total > 0,
f"active={app._active} total={c.lst.total}")
kinds = {h.kind for h in c.lst.model.window(0, 40)}
c.check("listing shows data heads (not just code)", "data" in kinds, str(kinds))
# a rendered data line carries the item text (e.g. db/dd/string)
c.lst.focus()
first_data = next((i for i in range(min(c.lst.total, 60))
if c.lst.model.get(i) and c.lst.model.get(i).kind == "data"), None)
c.check("a data head exists in the first screenful", first_data is not None,
f"total={c.lst.total}")
if first_data is not None:
c.lst.cursor = first_data
await c.pause(0.05)
plain = c.lst._line_plain(first_data)
c.check("data line renders its item text", bool(plain and plain.strip()),
f"plain={plain!r}")
c.check("listing cursor reports the head address",
c.lst._cursor_ea() == c.lst.model.get(first_data).ea, str(c.lst._cursor_ea()))
# backslash from the listing opens hex at the cursor address; and back
cur_ea = c.lst._cursor_ea()
await c.press("backslash")
await c.wait(lambda: app._active == "hex" and c.hex.display, 15)
c.check("backslash from the listing opens the hex view", app._active == "hex",
f"active={app._active}")
await c.press("backslash")
await c.wait(lambda: app._active == "listing", 15)
c.check("returning from hex lands back on the listing (not a func view)",
app._active == "listing" and c.lst.display, f"active={app._active}")
# 'd' defines typed data over an undefined run. Synthesize the run
# deterministically: undefine a data head, then re-type it via the prompt.
dhead = next((c.lst.model.get(i) for i in range(min(c.lst.total, 200))
if c.lst.model.get(i) and c.lst.model.get(i).kind == "data"
and (c.lst.model.get(i).size or 0) >= 4), None)
if dhead is None:
c.check("found a data head to re-type", False)
return
dea = dhead.ea
try:
c.prog.undefine(dea, size=4)
c.prog.bump_items()
# reopen the listing so the model reflects the new undefined run
await c.goto_ui(hex(dea))
await c.wait(lambda: app._active == "listing" and c.lst.total > 0
and c.lst.model.index_of_ea(dea) >= 0, 25)
ui = c.lst.model.index_of_ea(dea)
c.check("undefining a data head yields an unknown run in the listing",
ui >= 0 and c.lst.model.get(ui).kind == "unknown",
f"kind={c.lst.model.get(ui).kind if ui>=0 else None}")
c.lst.focus()
c.lst.cursor = ui
await c.pause(0.05)
await c.press("d")
await c.pause(0.1)
mdi = app.query_one("#makedata", Input)
c.check("'d' opens the make-data prompt prefilled with a type",
mdi.display and bool(mdi.value), f"display={mdi.display} val={mdi.value!r}")
mdi.value = "char[4]"
await c.press("enter")
await c.wait(lambda: app._active == "listing"
and c.lst.model.index_of_ea(dea) >= 0
and c.lst.model.get(c.lst.model.index_of_ea(dea)) is not None
and c.lst.model.get(c.lst.model.index_of_ea(dea)).kind == "data", 25)
di = c.lst.model.index_of_ea(dea)
c.check("'d' turns the undefined run into a typed data item",
di >= 0 and c.lst.model.get(di).kind == "data",
f"kind={c.lst.model.get(di).kind if di>=0 else None}")
finally:
c.prog.bump_items()
@scenario("listing_name_addr")
async def s_listing_name_addr(c: Ctx):
"""In the listing, 'n' names the ADDRESS under the cursor — so you can name a
bare/undefined byte (e.g. the free byte at addr+1 after shrinking a u16 to a
u8), which the symbol-by-name rename path can't do."""
app = c.app
# pick a data segment and a >=2-byte data head to shrink
data_ea = None
for start, end, name in c.prog.sections():
if start >= end:
continue
lm = c.prog.listing(start)
if lm is None:
continue
lm.ensure(60)
if any(h.kind == "data" and (h.size or 0) >= 2 for h in lm.window(0, 60)):
data_ea = start
break
if data_ea is None:
c.check("found a data segment with a >=2-byte item", False)
return
dh = next(h for h in c.prog.listing(data_ea).window(0, 60)
if h.kind == "data" and (h.size or 0) >= 2)
A = dh.ea
newname = f"after_{os.getpid()}"
try:
# shrink the >=2-byte item to a single byte -> A+1 becomes undefined
c.prog.make_data(A, "unsigned __int8")
c.prog.bump_items()
await c.goto_ui(hex(A + 1))
await c.wait(lambda: app._active == "listing" and app._cur is not None
and app._cur.ea == A + 1, 25)
head = c.lst.cur_head()
c.check("cursor lands on the now-undefined byte at addr+1",
head is not None and head.ea == A + 1 and head.kind == "unknown",
f"head={head}")
# 'n' opens the address-name prompt (even though there's no symbol)
c.lst.focus()
await c.press("n")
await c.pause(0.1)
ri = app.query_one("#rename", Input)
c.check("'n' opens the name prompt on an unnamed byte",
ri.display, f"display={ri.display}")
ri.value = newname
await c.press("enter")
await c.wait(lambda: app._active == "listing"
and c.lst.model.index_of_ea(A + 1) >= 0
and c.lst.model.get(c.lst.model.index_of_ea(A + 1)) is not None
and c.lst.model.get(c.lst.model.index_of_ea(A + 1)).name == newname, 25)
hi = c.lst.model.index_of_ea(A + 1)
c.check("naming a bare byte at addr+1 sticks",
hi >= 0 and c.lst.model.get(hi).name == newname,
f"name={c.lst.model.get(hi).name if hi>=0 else None}")
finally:
# revert: drop the label and restore raw bytes at A
try:
c.prog.client.call("rename", batch={"data": {"addr": hex(A + 1), "new": ""}})
except Exception: # noqa: BLE001
pass
c.prog.undefine(A, size=8)
c.prog.bump_items()
@scenario("listing_make_string")
async def s_listing_make_string(c: Ctx):
"""'a' in the listing makes a string literal at the cursor (IDA's 'A')."""
app = c.app
target = None
for start, end, name in c.prog.sections():
if start >= end:
continue
lm = c.prog.listing(start)
if lm is None:
continue
lm.ensure(80)
h = next((h for h in lm.window(0, 80)
if h.kind == "data" and "'" in h.text), None)
if h is not None:
target = h.ea
break
if target is None:
c.check("found a string data item to remake", False)
return
A = target
try:
c.prog.undefine(A, size=8)
c.prog.bump_items()
await c.goto_ui(hex(A))
await c.wait(lambda: app._active == "listing" and app._cur is not None
and app._cur.ea == A, 25)
c.check("target is undefined before 'a'",
c.lst.cur_head() is not None and c.lst.cur_head().kind == "unknown",
f"head={c.lst.cur_head()}")
c.lst.focus()
await c.press("a")
await c.wait(lambda: c.lst.model.index_of_ea(A) >= 0
and c.lst.model.get(c.lst.model.index_of_ea(A)) is not None
and c.lst.model.get(c.lst.model.index_of_ea(A)).kind == "data"
and "'" in c.lst.model.get(c.lst.model.index_of_ea(A)).text, 25)
hi = c.lst.model.index_of_ea(A)
c.check("'a' creates a string literal at the cursor",
hi >= 0 and c.lst.model.get(hi).kind == "data"
and "'" in c.lst.model.get(hi).text,
f"head={c.lst.model.get(hi) if hi >= 0 else None}")
finally:
try:
c.prog.make_string(A) # restore the original string
except Exception: # noqa: BLE001
pass
c.prog.bump_items()
@scenario("listing_struct_expand")
async def s_listing_struct_expand(c: Ctx):
"""A struct-typed global expands into indented member rows in the listing."""
app = c.app
# a writable data address: reuse a data segment's first data head
A = None
for start, end, name in c.prog.sections():
if start >= end:
continue
lm = c.prog.listing(start)
if lm is None:
continue
lm.ensure(60)
h = next((h for h in lm.window(0, 60) if h.kind == "data"), None)
if h is not None:
A = h.ea
break
if A is None:
c.check("found a data address for the struct test", False)
return
try:
c.prog.client.call(
"declare_type",
decls=["struct TuiExpandS { int a; char b[4]; short c; };"])
c.prog.make_data(A, "TuiExpandS")
c.prog.bump_items()
await c.goto_ui(hex(A))
await c.wait(lambda: app._active == "listing" and app._cur is not None
and app._cur.ea == A and c.lst.total > 0, 25)
# the summary head, then member rows for a/b/c
si = c.lst.model.index_of_ea(A)
members = [c.lst.model.get(si + 1 + k) for k in range(3)]
names = [m.text for m in members if m is not None]
c.check("struct global expands into member rows",
all(m is not None and m.kind == "member" for m in members)
and any("a" in t for t in names) and any("b" in t for t in names),
f"members={names}")
c.check("member rows carry field addresses",
members[1] is not None and members[1].ea == A + 4,
f"ea={members[1].ea if members[1] else None:#x} want={A+4:#x}")
finally:
try:
c.prog.undefine(A, size=16)
except Exception: # noqa: BLE001
pass
c.prog.bump_items()
@scenario("continuous_view")
async def s_continuous_view(c: Ctx):
"""The default code view is ONE continuous listing: opening a function shows
the whole segment (functions + data interleaved, with opcodes); F5/Tab
decompiles the function at the cursor and back."""
app = c.app
fn = await c.open_biggest("listing")
fn_ea = fn.addr
await c.wait(lambda: app._active == "listing" and c.lst.display, 10)
c.check("a function opens in the continuous listing by default",
app._active == "listing" and c.lst.display
and c.lst._cursor_ea() == fn_ea,
f"active={app._active} disp={c.lst.display} cur_ea={c.lst._cursor_ea()}")
# the listing spans the whole segment, not just the function
c.lst.model.load_all()
seg = c.prog.segment_bounds(fn_ea)
seg_rows = len(c.lst.model)
# a function's own instruction count is far smaller than the segment
fdis = c.prog.disasm(fn_ea, fn.name)
c.check("the continuous listing extends past the function's bounds",
seg_rows > fdis.total(), f"listing={seg_rows} func={fdis.total()}")
kinds = {c.lst.model.get(i).kind for i in range(seg_rows)}
c.check("continuous listing interleaves code with data/undefined",
"code" in kinds and ("data" in kinds or "unknown" in kinds), str(kinds))
# rendering parity with disasm: code lines carry opcode bytes
cidx = next((i for i in range(seg_rows)
if c.lst.model.get(i).kind == "code"), None)
c.check("continuous listing renders opcode bytes (parity with disasm)",
cidx is not None and c.lst.model.get(cidx).raw
and c.lst._op_field(c.lst.model.get(cidx)).strip() != "",
f"raw={c.lst.model.get(cidx).raw if cidx is not None else None!r}")
# F5/Tab at the function -> decompiler, and back to the same spot
c.lst.focus()
await c.press("tab")
await c.wait(lambda: (app._active == "decomp" and c.dec.loaded_ea == fn_ea)
or (app._active == "listing" and "fail" in c.status().lower()), 25)
if app._active == "decomp":
c.check("F5/Tab decompiles the function under the cursor",
c.dec.loaded_ea == fn_ea, f"loaded={c.dec.loaded_ea}")
await c.press("tab")
await c.wait(lambda: app._active == "listing", 25)
c.check("F5/Tab in the decompiler returns to the listing at the same ea",
app._active == "listing" and c.lst._cursor_ea() == fn_ea,
f"active={app._active} cur_ea={c.lst._cursor_ea()}")
else:
c.check("undecompilable function falls back to the listing",
app._active == "listing", f"active={app._active}")
@scenario("func_banners")
async def s_func_banners(c: Ctx):
"""The unified listing shows IDA-style function boundary banners: a
SUBROUTINE separator + 'name proc near' header and a 'name endp' footer,
and those banner rows are display-only (navigation lands on real code)."""
app = c.app
fn = await c.open_biggest("listing")
c.lst.model.load_all()
heads = [c.lst.model.get(i) for i in range(len(c.lst.model))]
ci = c.lst.model.index_of_ea(fn.addr)
c.check("navigation to a function lands on its code head, not a banner",
ci >= 0 and c.lst.model.get(ci).kind == "code",
f"kind={c.lst.model.get(ci).kind if ci >= 0 else None}")
c.check("a SUBROUTINE separator banner is present",
any(h.kind == "sep" and "S U B R O U T I N E" in h.text for h in heads))
c.check("a 'name proc' header is present",
any(h.kind == "funchdr" and h.text.endswith(" proc") for h in heads))
c.check("a 'name endp' footer is present",
any(h.kind == "funchdr" and h.text.endswith("endp") for h in heads))
# the proc header for the origin function carries its name
hdr = next((h for h in heads if h.kind == "funchdr"
and h.text == f"{fn.name} proc"), None)
c.check("the proc header names the function", hdr is not None, f"fn={fn.name}")
# --------------------------------------------------------------------------- #
# Runner
# --------------------------------------------------------------------------- #
async def run(binary, only=None):
# Own idalib worker: opens the binary in-process over a unix socket.
app = IdaTui(open_path=binary, keepalive=False)
async with app.run_test(size=(140, 44)) as pilot:
c = Ctx(app, pilot)
await c.boot()
for name, fn in SCENARIOS:
if only and not any(o in name for o in only):
continue
c.scenario = name
_t0 = asyncio.get_event_loop().time()
try:
await c.reset()
await fn(c)
print(f"── {name} ({asyncio.get_event_loop().time() - _t0:.1f}s)")
except _StopSuite:
raise
except Exception as e: # noqa: BLE001 — isolate: one scenario's crash
print(f"── {name} ({asyncio.get_event_loop().time() - _t0:.1f}s) CRASHED")
c.check("scenario did not crash", False, f"{type(e).__name__}: {e}")
traceback.print_exc()
def main(argv):
global STOP_AFTER
only = None
binary = None
it = iter(argv)
for a in it:
if a == "--only":
only = next(it).split(",")
elif a == "--stop-after":
STOP_AFTER = next(it)
elif a in ("--worker", "--binary"):
binary = os.path.abspath(os.path.expanduser(next(it)))
elif a == "--list":
for name, _ in SCENARIOS:
print(name)
return 0
elif not a.startswith("-"):
binary = os.path.abspath(os.path.expanduser(a))
if binary is None: # default target for the pilot
binary = os.path.join(
os.path.dirname(os.path.dirname(os.path.abspath(__file__))),
"targets", "echo")
try:
asyncio.run(run(binary, only))
except _StopSuite:
print(f" … stopped after '{STOP_AFTER}'")
print(f"\n{PASS} passed, {FAIL} failed")
return 1 if FAIL else 0
if __name__ == "__main__":
raise SystemExit(main(sys.argv[1:]))
|