/usr/lib/python3/dist-packages/twisted/test/test_defer.py is in python3-twisted-experimental 13.2.0-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 | # Copyright (c) Twisted Matrix Laboratories.
# See LICENSE for details.
"""
Test cases for L{twisted.internet.defer}.
"""
from __future__ import division, absolute_import
import warnings
import gc, traceback
import re
from twisted.python import failure, log
from twisted.python.compat import _PY3
from twisted.internet import defer, reactor
from twisted.internet.task import Clock
from twisted.trial import unittest
class GenericError(Exception):
pass
def getDivisionFailure(*args, **kwargs):
"""
Make a L{failure.Failure} of a divide-by-zero error.
@param args: Any C{*args} are passed to Failure's constructor.
@param kwargs: Any C{**kwargs} are passed to Failure's constructor.
"""
try:
1/0
except:
f = failure.Failure(*args, **kwargs)
return f
def fakeCallbackCanceller(deferred):
"""
A fake L{defer.Deferred} canceller which callbacks the L{defer.Deferred}
with C{str} "Callback Result" when cancelling it.
@param deferred: The cancelled L{defer.Deferred}.
"""
deferred.callback("Callback Result")
class ImmediateFailureMixin(object):
"""
Add additional assertion methods.
"""
def assertImmediateFailure(self, deferred, exception):
"""
Assert that the given Deferred current result is a Failure with the
given exception.
@return: The exception instance in the Deferred.
"""
failures = []
deferred.addErrback(failures.append)
self.assertEqual(len(failures), 1)
self.assertTrue(failures[0].check(exception))
return failures[0].value
class DeferredTestCase(unittest.SynchronousTestCase, ImmediateFailureMixin):
def setUp(self):
self.callbackResults = None
self.errbackResults = None
self.callback2Results = None
# Restore the debug flag to its original state when done.
self.addCleanup(defer.setDebugging, defer.getDebugging())
def _callback(self, *args, **kw):
self.callbackResults = args, kw
return args[0]
def _callback2(self, *args, **kw):
self.callback2Results = args, kw
def _errback(self, *args, **kw):
self.errbackResults = args, kw
def testCallbackWithoutArgs(self):
deferred = defer.Deferred()
deferred.addCallback(self._callback)
deferred.callback("hello")
self.assertEqual(self.errbackResults, None)
self.assertEqual(self.callbackResults, (('hello',), {}))
def testCallbackWithArgs(self):
deferred = defer.Deferred()
deferred.addCallback(self._callback, "world")
deferred.callback("hello")
self.assertEqual(self.errbackResults, None)
self.assertEqual(self.callbackResults, (('hello', 'world'), {}))
def testCallbackWithKwArgs(self):
deferred = defer.Deferred()
deferred.addCallback(self._callback, world="world")
deferred.callback("hello")
self.assertEqual(self.errbackResults, None)
self.assertEqual(self.callbackResults,
(('hello',), {'world': 'world'}))
def testTwoCallbacks(self):
deferred = defer.Deferred()
deferred.addCallback(self._callback)
deferred.addCallback(self._callback2)
deferred.callback("hello")
self.assertEqual(self.errbackResults, None)
self.assertEqual(self.callbackResults,
(('hello',), {}))
self.assertEqual(self.callback2Results,
(('hello',), {}))
def testDeferredList(self):
defr1 = defer.Deferred()
defr2 = defer.Deferred()
defr3 = defer.Deferred()
dl = defer.DeferredList([defr1, defr2, defr3])
result = []
def cb(resultList, result=result):
result.extend(resultList)
def catch(err):
return None
dl.addCallbacks(cb, cb)
defr1.callback("1")
defr2.addErrback(catch)
# "catch" is added to eat the GenericError that will be passed on by
# the DeferredList's callback on defr2. If left unhandled, the
# Failure object would cause a log.err() warning about "Unhandled
# error in Deferred". Twisted's pyunit watches for log.err calls and
# treats them as failures. So "catch" must eat the error to prevent
# it from flunking the test.
defr2.errback(GenericError("2"))
defr3.callback("3")
self.assertEqual([result[0],
#result[1][1] is now a Failure instead of an Exception
(result[1][0], str(result[1][1].value)),
result[2]],
[(defer.SUCCESS, "1"),
(defer.FAILURE, "2"),
(defer.SUCCESS, "3")])
def testEmptyDeferredList(self):
result = []
def cb(resultList, result=result):
result.append(resultList)
dl = defer.DeferredList([])
dl.addCallbacks(cb)
self.assertEqual(result, [[]])
result[:] = []
dl = defer.DeferredList([], fireOnOneCallback=1)
dl.addCallbacks(cb)
self.assertEqual(result, [])
def testDeferredListFireOnOneError(self):
defr1 = defer.Deferred()
defr2 = defer.Deferred()
defr3 = defer.Deferred()
dl = defer.DeferredList([defr1, defr2, defr3], fireOnOneErrback=1)
result = []
dl.addErrback(result.append)
# consume errors after they pass through the DeferredList (to avoid
# 'Unhandled error in Deferred'.
def catch(err):
return None
defr2.addErrback(catch)
# fire one Deferred's callback, no result yet
defr1.callback("1")
self.assertEqual(result, [])
# fire one Deferred's errback -- now we have a result
defr2.errback(GenericError("from def2"))
self.assertEqual(len(result), 1)
# extract the result from the list
aFailure = result[0]
# the type of the failure is a FirstError
self.failUnless(issubclass(aFailure.type, defer.FirstError),
'issubclass(aFailure.type, defer.FirstError) failed: '
"failure's type is %r" % (aFailure.type,)
)
firstError = aFailure.value
# check that the GenericError("2") from the deferred at index 1
# (defr2) is intact inside failure.value
self.assertEqual(firstError.subFailure.type, GenericError)
self.assertEqual(firstError.subFailure.value.args, ("from def2",))
self.assertEqual(firstError.index, 1)
def testDeferredListDontConsumeErrors(self):
d1 = defer.Deferred()
dl = defer.DeferredList([d1])
errorTrap = []
d1.addErrback(errorTrap.append)
result = []
dl.addCallback(result.append)
d1.errback(GenericError('Bang'))
self.assertEqual('Bang', errorTrap[0].value.args[0])
self.assertEqual(1, len(result))
self.assertEqual('Bang', result[0][0][1].value.args[0])
def testDeferredListConsumeErrors(self):
d1 = defer.Deferred()
dl = defer.DeferredList([d1], consumeErrors=True)
errorTrap = []
d1.addErrback(errorTrap.append)
result = []
dl.addCallback(result.append)
d1.errback(GenericError('Bang'))
self.assertEqual([], errorTrap)
self.assertEqual(1, len(result))
self.assertEqual('Bang', result[0][0][1].value.args[0])
def testDeferredListFireOnOneErrorWithAlreadyFiredDeferreds(self):
# Create some deferreds, and errback one
d1 = defer.Deferred()
d2 = defer.Deferred()
d1.errback(GenericError('Bang'))
# *Then* build the DeferredList, with fireOnOneErrback=True
dl = defer.DeferredList([d1, d2], fireOnOneErrback=True)
result = []
dl.addErrback(result.append)
self.assertEqual(1, len(result))
d1.addErrback(lambda e: None) # Swallow error
def testDeferredListWithAlreadyFiredDeferreds(self):
# Create some deferreds, and err one, call the other
d1 = defer.Deferred()
d2 = defer.Deferred()
d1.errback(GenericError('Bang'))
d2.callback(2)
# *Then* build the DeferredList
dl = defer.DeferredList([d1, d2])
result = []
dl.addCallback(result.append)
self.assertEqual(1, len(result))
d1.addErrback(lambda e: None) # Swallow error
def test_cancelDeferredList(self):
"""
When cancelling an unfired L{defer.DeferredList}, cancel every
L{defer.Deferred} in the list.
"""
deferredOne = defer.Deferred()
deferredTwo = defer.Deferred()
deferredList = defer.DeferredList([deferredOne, deferredTwo])
deferredList.cancel()
self.failureResultOf(deferredOne, defer.CancelledError)
self.failureResultOf(deferredTwo, defer.CancelledError)
def test_cancelDeferredListCallback(self):
"""
When cancelling an unfired L{defer.DeferredList} without the
C{fireOnOneCallback} and C{fireOnOneErrback} flags set, the
L{defer.DeferredList} will be callback with a C{list} of
(success, result) C{tuple}s.
"""
deferredOne = defer.Deferred(fakeCallbackCanceller)
deferredTwo = defer.Deferred()
deferredList = defer.DeferredList([deferredOne, deferredTwo])
deferredList.cancel()
self.failureResultOf(deferredTwo, defer.CancelledError)
result = self.successResultOf(deferredList)
self.assertTrue(result[0][0])
self.assertEqual(result[0][1], "Callback Result")
self.assertFalse(result[1][0])
self.assertTrue(result[1][1].check(defer.CancelledError))
def test_cancelDeferredListWithFireOnOneCallback(self):
"""
When cancelling an unfired L{defer.DeferredList} with the flag
C{fireOnOneCallback} set, cancel every L{defer.Deferred} in the list.
"""
deferredOne = defer.Deferred()
deferredTwo = defer.Deferred()
deferredList = defer.DeferredList([deferredOne, deferredTwo],
fireOnOneCallback=True)
deferredList.cancel()
self.failureResultOf(deferredOne, defer.CancelledError)
self.failureResultOf(deferredTwo, defer.CancelledError)
def test_cancelDeferredListWithFireOnOneCallbackAndDeferredCallback(self):
"""
When cancelling an unfired L{defer.DeferredList} with the flag
C{fireOnOneCallback} set, if one of the L{defer.Deferred} callbacks
in its canceller, the L{defer.DeferredList} will callback with the
result and the index of the L{defer.Deferred} in a C{tuple}.
"""
deferredOne = defer.Deferred(fakeCallbackCanceller)
deferredTwo = defer.Deferred()
deferredList = defer.DeferredList([deferredOne, deferredTwo],
fireOnOneCallback=True)
deferredList.cancel()
self.failureResultOf(deferredTwo, defer.CancelledError)
result = self.successResultOf(deferredList)
self.assertEqual(result, ("Callback Result", 0))
def test_cancelDeferredListWithFireOnOneErrback(self):
"""
When cancelling an unfired L{defer.DeferredList} with the flag
C{fireOnOneErrback} set, cancel every L{defer.Deferred} in the list.
"""
deferredOne = defer.Deferred()
deferredTwo = defer.Deferred()
deferredList = defer.DeferredList([deferredOne, deferredTwo],
fireOnOneErrback=True)
deferredList.cancel()
self.failureResultOf(deferredOne, defer.CancelledError)
self.failureResultOf(deferredTwo, defer.CancelledError)
deferredListFailure = self.failureResultOf(deferredList,
defer.FirstError)
firstError = deferredListFailure.value
self.assertTrue(firstError.subFailure.check(defer.CancelledError))
def test_cancelDeferredListWithFireOnOneErrbackAllDeferredsCallback(self):
"""
When cancelling an unfired L{defer.DeferredList} with the flag
C{fireOnOneErrback} set, if all the L{defer.Deferred} callbacks
in its canceller, the L{defer.DeferredList} will callback with a
C{list} of (success, result) C{tuple}s.
"""
deferredOne = defer.Deferred(fakeCallbackCanceller)
deferredTwo = defer.Deferred(fakeCallbackCanceller)
deferredList = defer.DeferredList([deferredOne, deferredTwo],
fireOnOneErrback=True)
deferredList.cancel()
result = self.successResultOf(deferredList)
self.assertTrue(result[0][0])
self.assertEqual(result[0][1], "Callback Result")
self.assertTrue(result[1][0])
self.assertEqual(result[1][1], "Callback Result")
def test_cancelDeferredListWithOriginalDeferreds(self):
"""
Cancelling a L{defer.DeferredList} will cancel the original
L{defer.Deferred}s passed in.
"""
deferredOne = defer.Deferred()
deferredTwo = defer.Deferred()
argumentList = [deferredOne, deferredTwo]
deferredList = defer.DeferredList(argumentList)
deferredThree = defer.Deferred()
argumentList.append(deferredThree)
deferredList.cancel()
self.failureResultOf(deferredOne, defer.CancelledError)
self.failureResultOf(deferredTwo, defer.CancelledError)
self.assertNoResult(deferredThree)
def test_cancelDeferredListWithException(self):
"""
Cancelling a L{defer.DeferredList} will cancel every L{defer.Deferred}
in the list even exceptions raised from the C{cancel} method of the
L{defer.Deferred}s.
"""
def cancellerRaisesException(deferred):
"""
A L{defer.Deferred} canceller that raises an exception.
@param deferred: The cancelled L{defer.Deferred}.
"""
raise RuntimeError("test")
deferredOne = defer.Deferred(cancellerRaisesException)
deferredTwo = defer.Deferred()
deferredList = defer.DeferredList([deferredOne, deferredTwo])
deferredList.cancel()
self.failureResultOf(deferredTwo, defer.CancelledError)
errors = self.flushLoggedErrors(RuntimeError)
self.assertEqual(len(errors), 1)
def test_cancelFiredOnOneCallbackDeferredList(self):
"""
When a L{defer.DeferredList} has fired because one L{defer.Deferred} in
the list fired with a non-failure result, the cancellation will do
nothing instead of cancelling the rest of the L{defer.Deferred}s.
"""
deferredOne = defer.Deferred()
deferredTwo = defer.Deferred()
deferredList = defer.DeferredList([deferredOne, deferredTwo],
fireOnOneCallback=True)
deferredOne.callback(None)
deferredList.cancel()
self.assertNoResult(deferredTwo)
def test_cancelFiredOnOneErrbackDeferredList(self):
"""
When a L{defer.DeferredList} has fired because one L{defer.Deferred} in
the list fired with a failure result, the cancellation will do
nothing instead of cancelling the rest of the L{defer.Deferred}s.
"""
deferredOne = defer.Deferred()
deferredTwo = defer.Deferred()
deferredList = defer.DeferredList([deferredOne, deferredTwo],
fireOnOneErrback=True)
deferredOne.errback(GenericError("test"))
deferredList.cancel()
self.assertNoResult(deferredTwo)
self.failureResultOf(deferredOne, GenericError)
self.failureResultOf(deferredList, defer.FirstError)
def testImmediateSuccess(self):
l = []
d = defer.succeed("success")
d.addCallback(l.append)
self.assertEqual(l, ["success"])
def testImmediateFailure(self):
l = []
d = defer.fail(GenericError("fail"))
d.addErrback(l.append)
self.assertEqual(str(l[0].value), "fail")
def testPausedFailure(self):
l = []
d = defer.fail(GenericError("fail"))
d.pause()
d.addErrback(l.append)
self.assertEqual(l, [])
d.unpause()
self.assertEqual(str(l[0].value), "fail")
def testCallbackErrors(self):
l = []
d = defer.Deferred().addCallback(lambda _: 1 // 0).addErrback(l.append)
d.callback(1)
self.assert_(isinstance(l[0].value, ZeroDivisionError))
l = []
d = defer.Deferred().addCallback(
lambda _: failure.Failure(ZeroDivisionError())).addErrback(l.append)
d.callback(1)
self.assert_(isinstance(l[0].value, ZeroDivisionError))
def testUnpauseBeforeCallback(self):
d = defer.Deferred()
d.pause()
d.addCallback(self._callback)
d.unpause()
def testReturnDeferred(self):
d = defer.Deferred()
d2 = defer.Deferred()
d2.pause()
d.addCallback(lambda r, d2=d2: d2)
d.addCallback(self._callback)
d.callback(1)
assert self.callbackResults is None, "Should not have been called yet."
d2.callback(2)
assert self.callbackResults is None, "Still should not have been called yet."
d2.unpause()
assert self.callbackResults[0][0] == 2, "Result should have been from second deferred:%s" % (self.callbackResults,)
def test_chainedPausedDeferredWithResult(self):
"""
When a paused Deferred with a result is returned from a callback on
another Deferred, the other Deferred is chained to the first and waits
for it to be unpaused.
"""
expected = object()
paused = defer.Deferred()
paused.callback(expected)
paused.pause()
chained = defer.Deferred()
chained.addCallback(lambda ignored: paused)
chained.callback(None)
result = []
chained.addCallback(result.append)
self.assertEqual(result, [])
paused.unpause()
self.assertEqual(result, [expected])
def test_pausedDeferredChained(self):
"""
A paused Deferred encountered while pushing a result forward through a
chain does not prevent earlier Deferreds from continuing to execute
their callbacks.
"""
first = defer.Deferred()
second = defer.Deferred()
first.addCallback(lambda ignored: second)
first.callback(None)
first.pause()
second.callback(None)
result = []
second.addCallback(result.append)
self.assertEqual(result, [None])
def test_gatherResults(self):
# test successful list of deferreds
l = []
defer.gatherResults([defer.succeed(1), defer.succeed(2)]).addCallback(l.append)
self.assertEqual(l, [[1, 2]])
# test failing list of deferreds
l = []
dl = [defer.succeed(1), defer.fail(ValueError())]
defer.gatherResults(dl).addErrback(l.append)
self.assertEqual(len(l), 1)
self.assert_(isinstance(l[0], failure.Failure))
# get rid of error
dl[1].addErrback(lambda e: 1)
def test_gatherResultsWithConsumeErrors(self):
"""
If a L{Deferred} in the list passed to L{gatherResults} fires with a
failure and C{consumerErrors} is C{True}, the failure is converted to a
C{None} result on that L{Deferred}.
"""
# test successful list of deferreds
dgood = defer.succeed(1)
dbad = defer.fail(RuntimeError("oh noes"))
d = defer.gatherResults([dgood, dbad], consumeErrors=True)
unconsumedErrors = []
dbad.addErrback(unconsumedErrors.append)
gatheredErrors = []
d.addErrback(gatheredErrors.append)
self.assertEqual((len(unconsumedErrors), len(gatheredErrors)),
(0, 1))
self.assertIsInstance(gatheredErrors[0].value, defer.FirstError)
firstError = gatheredErrors[0].value.subFailure
self.assertIsInstance(firstError.value, RuntimeError)
def test_cancelGatherResults(self):
"""
When cancelling the L{defer.gatherResults} call, all the
L{defer.Deferred}s in the list will be cancelled.
"""
deferredOne = defer.Deferred()
deferredTwo = defer.Deferred()
result = defer.gatherResults([deferredOne, deferredTwo])
result.cancel()
self.failureResultOf(deferredOne, defer.CancelledError)
self.failureResultOf(deferredTwo, defer.CancelledError)
gatherResultsFailure = self.failureResultOf(result, defer.FirstError)
firstError = gatherResultsFailure.value
self.assertTrue(firstError.subFailure.check(defer.CancelledError))
def test_cancelGatherResultsWithAllDeferredsCallback(self):
"""
When cancelling the L{defer.gatherResults} call, if all the
L{defer.Deferred}s callback in their canceller, the L{defer.Deferred}
returned by L{defer.gatherResults} will be callbacked with the C{list}
of the results.
"""
deferredOne = defer.Deferred(fakeCallbackCanceller)
deferredTwo = defer.Deferred(fakeCallbackCanceller)
result = defer.gatherResults([deferredOne, deferredTwo])
result.cancel()
callbackResult = self.successResultOf(result)
self.assertEqual(callbackResult[0], "Callback Result")
self.assertEqual(callbackResult[1], "Callback Result")
def test_maybeDeferredSync(self):
"""
L{defer.maybeDeferred} should retrieve the result of a synchronous
function and pass it to its resulting L{defer.Deferred}.
"""
S, E = [], []
d = defer.maybeDeferred((lambda x: x + 5), 10)
d.addCallbacks(S.append, E.append)
self.assertEqual(E, [])
self.assertEqual(S, [15])
def test_maybeDeferredSyncError(self):
"""
L{defer.maybeDeferred} should catch exception raised by a synchronous
function and errback its resulting L{defer.Deferred} with it.
"""
S, E = [], []
try:
'10' + 5
except TypeError as e:
expected = str(e)
d = defer.maybeDeferred((lambda x: x + 5), '10')
d.addCallbacks(S.append, E.append)
self.assertEqual(S, [])
self.assertEqual(len(E), 1)
self.assertEqual(str(E[0].value), expected)
def test_maybeDeferredAsync(self):
"""
L{defer.maybeDeferred} should let L{defer.Deferred} instance pass by
so that original result is the same.
"""
d = defer.Deferred()
d2 = defer.maybeDeferred(lambda: d)
d.callback('Success')
result = []
d2.addCallback(result.append)
self.assertEqual(result, ['Success'])
def test_maybeDeferredAsyncError(self):
"""
L{defer.maybeDeferred} should let L{defer.Deferred} instance pass by
so that L{failure.Failure} returned by the original instance is the
same.
"""
d = defer.Deferred()
d2 = defer.maybeDeferred(lambda: d)
d.errback(failure.Failure(RuntimeError()))
self.assertImmediateFailure(d2, RuntimeError)
def test_innerCallbacksPreserved(self):
"""
When a L{Deferred} encounters a result which is another L{Deferred}
which is waiting on a third L{Deferred}, the middle L{Deferred}'s
callbacks are executed after the third L{Deferred} fires and before the
first receives a result.
"""
results = []
failures = []
inner = defer.Deferred()
def cb(result):
results.append(('start-of-cb', result))
d = defer.succeed('inner')
def firstCallback(result):
results.append(('firstCallback', 'inner'))
return inner
def secondCallback(result):
results.append(('secondCallback', result))
return result * 2
d.addCallback(firstCallback).addCallback(secondCallback)
d.addErrback(failures.append)
return d
outer = defer.succeed('outer')
outer.addCallback(cb)
inner.callback('orange')
outer.addCallback(results.append)
inner.addErrback(failures.append)
outer.addErrback(failures.append)
self.assertEqual([], failures)
self.assertEqual(
results,
[('start-of-cb', 'outer'),
('firstCallback', 'inner'),
('secondCallback', 'orange'),
'orangeorange'])
def test_continueCallbackNotFirst(self):
"""
The continue callback of a L{Deferred} waiting for another L{Deferred}
is not necessarily the first one. This is somewhat a whitebox test
checking that we search for that callback among the whole list of
callbacks.
"""
results = []
failures = []
a = defer.Deferred()
def cb(result):
results.append(('cb', result))
d = defer.Deferred()
def firstCallback(ignored):
results.append(('firstCallback', ignored))
return defer.gatherResults([a])
def secondCallback(result):
results.append(('secondCallback', result))
d.addCallback(firstCallback)
d.addCallback(secondCallback)
d.addErrback(failures.append)
d.callback(None)
return d
outer = defer.succeed('outer')
outer.addCallback(cb)
outer.addErrback(failures.append)
self.assertEqual([('cb', 'outer'), ('firstCallback', None)], results)
a.callback('withers')
self.assertEqual([], failures)
self.assertEqual(
results,
[('cb', 'outer'),
('firstCallback', None),
('secondCallback', ['withers'])])
def test_callbackOrderPreserved(self):
"""
A callback added to a L{Deferred} after a previous callback attached
another L{Deferred} as a result is run after the callbacks of the other
L{Deferred} are run.
"""
results = []
failures = []
a = defer.Deferred()
def cb(result):
results.append(('cb', result))
d = defer.Deferred()
def firstCallback(ignored):
results.append(('firstCallback', ignored))
return defer.gatherResults([a])
def secondCallback(result):
results.append(('secondCallback', result))
d.addCallback(firstCallback)
d.addCallback(secondCallback)
d.addErrback(failures.append)
d.callback(None)
return d
outer = defer.Deferred()
outer.addCallback(cb)
outer.addCallback(lambda x: results.append('final'))
outer.addErrback(failures.append)
outer.callback('outer')
self.assertEqual([('cb', 'outer'), ('firstCallback', None)], results)
a.callback('withers')
self.assertEqual([], failures)
self.assertEqual(
results,
[('cb', 'outer'),
('firstCallback', None),
('secondCallback', ['withers']), 'final'])
def test_reentrantRunCallbacks(self):
"""
A callback added to a L{Deferred} by a callback on that L{Deferred}
should be added to the end of the callback chain.
"""
deferred = defer.Deferred()
called = []
def callback3(result):
called.append(3)
def callback2(result):
called.append(2)
def callback1(result):
called.append(1)
deferred.addCallback(callback3)
deferred.addCallback(callback1)
deferred.addCallback(callback2)
deferred.callback(None)
self.assertEqual(called, [1, 2, 3])
def test_nonReentrantCallbacks(self):
"""
A callback added to a L{Deferred} by a callback on that L{Deferred}
should not be executed until the running callback returns.
"""
deferred = defer.Deferred()
called = []
def callback2(result):
called.append(2)
def callback1(result):
called.append(1)
deferred.addCallback(callback2)
self.assertEqual(called, [1])
deferred.addCallback(callback1)
deferred.callback(None)
self.assertEqual(called, [1, 2])
def test_reentrantRunCallbacksWithFailure(self):
"""
After an exception is raised by a callback which was added to a
L{Deferred} by a callback on that L{Deferred}, the L{Deferred} should
call the first errback with a L{Failure} wrapping that exception.
"""
exceptionMessage = "callback raised exception"
deferred = defer.Deferred()
def callback2(result):
raise Exception(exceptionMessage)
def callback1(result):
deferred.addCallback(callback2)
deferred.addCallback(callback1)
deferred.callback(None)
exception = self.assertImmediateFailure(deferred, Exception)
self.assertEqual(exception.args, (exceptionMessage,))
def test_synchronousImplicitChain(self):
"""
If a first L{Deferred} with a result is returned from a callback on a
second L{Deferred}, the result of the second L{Deferred} becomes the
result of the first L{Deferred} and the result of the first L{Deferred}
becomes C{None}.
"""
result = object()
first = defer.succeed(result)
second = defer.Deferred()
second.addCallback(lambda ign: first)
second.callback(None)
results = []
first.addCallback(results.append)
self.assertIdentical(results[0], None)
second.addCallback(results.append)
self.assertIdentical(results[1], result)
def test_asynchronousImplicitChain(self):
"""
If a first L{Deferred} without a result is returned from a callback on
a second L{Deferred}, the result of the second L{Deferred} becomes the
result of the first L{Deferred} as soon as the first L{Deferred} has
one and the result of the first L{Deferred} becomes C{None}.
"""
first = defer.Deferred()
second = defer.Deferred()
second.addCallback(lambda ign: first)
second.callback(None)
firstResult = []
first.addCallback(firstResult.append)
secondResult = []
second.addCallback(secondResult.append)
self.assertEqual(firstResult, [])
self.assertEqual(secondResult, [])
result = object()
first.callback(result)
self.assertEqual(firstResult, [None])
self.assertEqual(secondResult, [result])
def test_synchronousImplicitErrorChain(self):
"""
If a first L{Deferred} with a L{Failure} result is returned from a
callback on a second L{Deferred}, the first L{Deferred}'s result is
converted to L{None} and no unhandled error is logged when it is
garbage collected.
"""
first = defer.fail(RuntimeError("First Deferred's Failure"))
second = defer.Deferred()
second.addCallback(lambda ign, first=first: first)
second.callback(None)
firstResult = []
first.addCallback(firstResult.append)
self.assertIdentical(firstResult[0], None)
self.assertImmediateFailure(second, RuntimeError)
def test_asynchronousImplicitErrorChain(self):
"""
Let C{a} and C{b} be two L{Deferred}s.
If C{a} has no result and is returned from a callback on C{b} then when
C{a} fails, C{b}'s result becomes the L{Failure} that was C{a}'s result,
the result of C{a} becomes C{None} so that no unhandled error is logged
when it is garbage collected.
"""
first = defer.Deferred()
second = defer.Deferred()
second.addCallback(lambda ign: first)
second.callback(None)
secondError = []
second.addErrback(secondError.append)
firstResult = []
first.addCallback(firstResult.append)
secondResult = []
second.addCallback(secondResult.append)
self.assertEqual(firstResult, [])
self.assertEqual(secondResult, [])
first.errback(RuntimeError("First Deferred's Failure"))
self.assertTrue(secondError[0].check(RuntimeError))
self.assertEqual(firstResult, [None])
self.assertEqual(len(secondResult), 1)
def test_doubleAsynchronousImplicitChaining(self):
"""
L{Deferred} chaining is transitive.
In other words, let A, B, and C be Deferreds. If C is returned from a
callback on B and B is returned from a callback on A then when C fires,
A fires.
"""
first = defer.Deferred()
second = defer.Deferred()
second.addCallback(lambda ign: first)
third = defer.Deferred()
third.addCallback(lambda ign: second)
thirdResult = []
third.addCallback(thirdResult.append)
result = object()
# After this, second is waiting for first to tell it to continue.
second.callback(None)
# And after this, third is waiting for second to tell it to continue.
third.callback(None)
# Still waiting
self.assertEqual(thirdResult, [])
# This will tell second to continue which will tell third to continue.
first.callback(result)
self.assertEqual(thirdResult, [result])
def test_nestedAsynchronousChainedDeferreds(self):
"""
L{Deferred}s can have callbacks that themselves return L{Deferred}s.
When these "inner" L{Deferred}s fire (even asynchronously), the
callback chain continues.
"""
results = []
failures = []
# A Deferred returned in the inner callback.
inner = defer.Deferred()
def cb(result):
results.append(('start-of-cb', result))
d = defer.succeed('inner')
def firstCallback(result):
results.append(('firstCallback', 'inner'))
# Return a Deferred that definitely has not fired yet, so we
# can fire the Deferreds out of order.
return inner
def secondCallback(result):
results.append(('secondCallback', result))
return result * 2
d.addCallback(firstCallback).addCallback(secondCallback)
d.addErrback(failures.append)
return d
# Create a synchronous Deferred that has a callback 'cb' that returns
# a Deferred 'd' that has fired but is now waiting on an unfired
# Deferred 'inner'.
outer = defer.succeed('outer')
outer.addCallback(cb)
outer.addCallback(results.append)
# At this point, the callback 'cb' has been entered, and the first
# callback of 'd' has been called.
self.assertEqual(
results, [('start-of-cb', 'outer'), ('firstCallback', 'inner')])
# Once the inner Deferred is fired, processing of the outer Deferred's
# callback chain continues.
inner.callback('orange')
# Make sure there are no errors.
inner.addErrback(failures.append)
outer.addErrback(failures.append)
self.assertEqual(
[], failures, "Got errbacks but wasn't expecting any.")
self.assertEqual(
results,
[('start-of-cb', 'outer'),
('firstCallback', 'inner'),
('secondCallback', 'orange'),
'orangeorange'])
def test_nestedAsynchronousChainedDeferredsWithExtraCallbacks(self):
"""
L{Deferred}s can have callbacks that themselves return L{Deferred}s.
These L{Deferred}s can have other callbacks added before they are
returned, which subtly changes the callback chain. When these "inner"
L{Deferred}s fire (even asynchronously), the outer callback chain
continues.
"""
results = []
failures = []
# A Deferred returned in the inner callback after a callback is
# added explicitly and directly to it.
inner = defer.Deferred()
def cb(result):
results.append(('start-of-cb', result))
d = defer.succeed('inner')
def firstCallback(ignored):
results.append(('firstCallback', ignored))
# Return a Deferred that definitely has not fired yet with a
# result-transforming callback so we can fire the Deferreds
# out of order and see how the callback affects the ultimate
# results.
return inner.addCallback(lambda x: [x])
def secondCallback(result):
results.append(('secondCallback', result))
return result * 2
d.addCallback(firstCallback)
d.addCallback(secondCallback)
d.addErrback(failures.append)
return d
# Create a synchronous Deferred that has a callback 'cb' that returns
# a Deferred 'd' that has fired but is now waiting on an unfired
# Deferred 'inner'.
outer = defer.succeed('outer')
outer.addCallback(cb)
outer.addCallback(results.append)
# At this point, the callback 'cb' has been entered, and the first
# callback of 'd' has been called.
self.assertEqual(
results, [('start-of-cb', 'outer'), ('firstCallback', 'inner')])
# Once the inner Deferred is fired, processing of the outer Deferred's
# callback chain continues.
inner.callback('withers')
# Make sure there are no errors.
outer.addErrback(failures.append)
inner.addErrback(failures.append)
self.assertEqual(
[], failures, "Got errbacks but wasn't expecting any.")
self.assertEqual(
results,
[('start-of-cb', 'outer'),
('firstCallback', 'inner'),
('secondCallback', ['withers']),
['withers', 'withers']])
def test_chainDeferredRecordsExplicitChain(self):
"""
When we chain a L{Deferred}, that chaining is recorded explicitly.
"""
a = defer.Deferred()
b = defer.Deferred()
b.chainDeferred(a)
self.assertIdentical(a._chainedTo, b)
def test_explicitChainClearedWhenResolved(self):
"""
Any recorded chaining is cleared once the chaining is resolved, since
it no longer exists.
In other words, if one L{Deferred} is recorded as depending on the
result of another, and I{that} L{Deferred} has fired, then the
dependency is resolved and we no longer benefit from recording it.
"""
a = defer.Deferred()
b = defer.Deferred()
b.chainDeferred(a)
b.callback(None)
self.assertIdentical(a._chainedTo, None)
def test_chainDeferredRecordsImplicitChain(self):
"""
We can chain L{Deferred}s implicitly by adding callbacks that return
L{Deferred}s. When this chaining happens, we record it explicitly as
soon as we can find out about it.
"""
a = defer.Deferred()
b = defer.Deferred()
a.addCallback(lambda ignored: b)
a.callback(None)
self.assertIdentical(a._chainedTo, b)
def test_circularChainWarning(self):
"""
When a Deferred is returned from a callback directly attached to that
same Deferred, a warning is emitted.
"""
d = defer.Deferred()
def circularCallback(result):
return d
d.addCallback(circularCallback)
d.callback("foo")
circular_warnings = self.flushWarnings([circularCallback])
self.assertEqual(len(circular_warnings), 1)
warning = circular_warnings[0]
self.assertEqual(warning['category'], DeprecationWarning)
pattern = "Callback returned the Deferred it was attached to"
self.assertTrue(
re.search(pattern, warning['message']),
"\nExpected match: %r\nGot: %r" % (pattern, warning['message']))
def test_circularChainException(self):
"""
If the deprecation warning for circular deferred callbacks is
configured to be an error, the exception will become the failure
result of the Deferred.
"""
self.addCleanup(setattr, warnings, "filters", warnings.filters)
warnings.filterwarnings("error", category=DeprecationWarning)
d = defer.Deferred()
def circularCallback(result):
return d
d.addCallback(circularCallback)
d.callback("foo")
failure = self.failureResultOf(d)
failure.trap(DeprecationWarning)
def test_repr(self):
"""
The C{repr()} of a L{Deferred} contains the class name and a
representation of the internal Python ID.
"""
d = defer.Deferred()
address = id(d)
self.assertEqual(
repr(d), '<Deferred at 0x%x>' % (address,))
def test_reprWithResult(self):
"""
If a L{Deferred} has been fired, then its C{repr()} contains its
result.
"""
d = defer.Deferred()
d.callback('orange')
self.assertEqual(
repr(d), "<Deferred at 0x%x current result: 'orange'>" % (
id(d),))
def test_reprWithChaining(self):
"""
If a L{Deferred} C{a} has been fired, but is waiting on another
L{Deferred} C{b} that appears in its callback chain, then C{repr(a)}
says that it is waiting on C{b}.
"""
a = defer.Deferred()
b = defer.Deferred()
b.chainDeferred(a)
self.assertEqual(
repr(a), "<Deferred at 0x%x waiting on Deferred at 0x%x>" % (
id(a), id(b)))
def test_boundedStackDepth(self):
"""
The depth of the call stack does not grow as more L{Deferred} instances
are chained together.
"""
def chainDeferreds(howMany):
stack = []
def recordStackDepth(ignored):
stack.append(len(traceback.extract_stack()))
top = defer.Deferred()
innerDeferreds = [defer.Deferred() for ignored in range(howMany)]
originalInners = innerDeferreds[:]
last = defer.Deferred()
inner = innerDeferreds.pop()
top.addCallback(lambda ign, inner=inner: inner)
top.addCallback(recordStackDepth)
while innerDeferreds:
newInner = innerDeferreds.pop()
inner.addCallback(lambda ign, inner=newInner: inner)
inner = newInner
inner.addCallback(lambda ign: last)
top.callback(None)
for inner in originalInners:
inner.callback(None)
# Sanity check - the record callback is not intended to have
# fired yet.
self.assertEqual(stack, [])
# Now fire the last thing and return the stack depth at which the
# callback was invoked.
last.callback(None)
return stack[0]
# Callbacks should be invoked at the same stack depth regardless of
# how many Deferreds are chained.
self.assertEqual(chainDeferreds(1), chainDeferreds(2))
def test_resultOfDeferredResultOfDeferredOfFiredDeferredCalled(self):
"""
Given three Deferreds, one chained to the next chained to the next,
callbacks on the middle Deferred which are added after the chain is
created are called once the last Deferred fires.
This is more of a regression-style test. It doesn't exercise any
particular code path through the current implementation of Deferred, but
it does exercise a broken codepath through one of the variations of the
implementation proposed as a resolution to ticket #411.
"""
first = defer.Deferred()
second = defer.Deferred()
third = defer.Deferred()
first.addCallback(lambda ignored: second)
second.addCallback(lambda ignored: third)
second.callback(None)
first.callback(None)
third.callback(None)
L = []
second.addCallback(L.append)
self.assertEqual(L, [None])
def test_errbackWithNoArgsNoDebug(self):
"""
C{Deferred.errback()} creates a failure from the current Python
exception. When Deferred.debug is not set no globals or locals are
captured in that failure.
"""
defer.setDebugging(False)
d = defer.Deferred()
l = []
exc = GenericError("Bang")
try:
raise exc
except:
d.errback()
d.addErrback(l.append)
fail = l[0]
self.assertEqual(fail.value, exc)
localz, globalz = fail.frames[0][-2:]
self.assertEqual([], localz)
self.assertEqual([], globalz)
def test_errbackWithNoArgs(self):
"""
C{Deferred.errback()} creates a failure from the current Python
exception. When Deferred.debug is set globals and locals are captured
in that failure.
"""
defer.setDebugging(True)
d = defer.Deferred()
l = []
exc = GenericError("Bang")
try:
raise exc
except:
d.errback()
d.addErrback(l.append)
fail = l[0]
self.assertEqual(fail.value, exc)
localz, globalz = fail.frames[0][-2:]
self.assertNotEquals([], localz)
self.assertNotEquals([], globalz)
def test_errorInCallbackDoesNotCaptureVars(self):
"""
An error raised by a callback creates a Failure. The Failure captures
locals and globals if and only if C{Deferred.debug} is set.
"""
d = defer.Deferred()
d.callback(None)
defer.setDebugging(False)
def raiseError(ignored):
raise GenericError("Bang")
d.addCallback(raiseError)
l = []
d.addErrback(l.append)
fail = l[0]
localz, globalz = fail.frames[0][-2:]
self.assertEqual([], localz)
self.assertEqual([], globalz)
def test_errorInCallbackCapturesVarsWhenDebugging(self):
"""
An error raised by a callback creates a Failure. The Failure captures
locals and globals if and only if C{Deferred.debug} is set.
"""
d = defer.Deferred()
d.callback(None)
defer.setDebugging(True)
def raiseError(ignored):
raise GenericError("Bang")
d.addCallback(raiseError)
l = []
d.addErrback(l.append)
fail = l[0]
localz, globalz = fail.frames[0][-2:]
self.assertNotEquals([], localz)
self.assertNotEquals([], globalz)
def test_inlineCallbacksTracebacks(self):
"""
L{defer.inlineCallbacks} that re-raise tracebacks into their deferred
should not lose their tracebacks.
"""
f = getDivisionFailure()
d = defer.Deferred()
try:
f.raiseException()
except:
d.errback()
def ic(d):
yield d
ic = defer.inlineCallbacks(ic)
newFailure = self.failureResultOf(d)
tb = traceback.extract_tb(newFailure.getTracebackObject())
self.assertEqual(len(tb), 2)
self.assertIn('test_defer', tb[0][0])
self.assertEqual('test_inlineCallbacksTracebacks', tb[0][2])
self.assertEqual('f.raiseException()', tb[0][3])
self.assertIn('test_defer', tb[1][0])
self.assertEqual('getDivisionFailure', tb[1][2])
self.assertEqual('1/0', tb[1][3])
if _PY3:
test_inlineCallbacksTracebacks.todo = (
"Python 3 support to be fixed in #5949")
# Remove this line in #6008 (unittest todo support):
del test_inlineCallbacksTracebacks
class FirstErrorTests(unittest.SynchronousTestCase):
"""
Tests for L{FirstError}.
"""
def test_repr(self):
"""
The repr of a L{FirstError} instance includes the repr of the value of
the sub-failure and the index which corresponds to the L{FirstError}.
"""
exc = ValueError("some text")
try:
raise exc
except:
f = failure.Failure()
error = defer.FirstError(f, 3)
self.assertEqual(
repr(error),
"FirstError[#3, %s]" % (repr(exc),))
def test_str(self):
"""
The str of a L{FirstError} instance includes the str of the
sub-failure and the index which corresponds to the L{FirstError}.
"""
exc = ValueError("some text")
try:
raise exc
except:
f = failure.Failure()
error = defer.FirstError(f, 5)
self.assertEqual(
str(error),
"FirstError[#5, %s]" % (str(f),))
def test_comparison(self):
"""
L{FirstError} instances compare equal to each other if and only if
their failure and index compare equal. L{FirstError} instances do not
compare equal to instances of other types.
"""
try:
1 // 0
except:
firstFailure = failure.Failure()
one = defer.FirstError(firstFailure, 13)
anotherOne = defer.FirstError(firstFailure, 13)
try:
raise ValueError("bar")
except:
secondFailure = failure.Failure()
another = defer.FirstError(secondFailure, 9)
self.assertTrue(one == anotherOne)
self.assertFalse(one == another)
self.assertTrue(one != another)
self.assertFalse(one != anotherOne)
self.assertFalse(one == 10)
class AlreadyCalledTestCase(unittest.SynchronousTestCase):
def setUp(self):
self._deferredWasDebugging = defer.getDebugging()
defer.setDebugging(True)
def tearDown(self):
defer.setDebugging(self._deferredWasDebugging)
def _callback(self, *args, **kw):
pass
def _errback(self, *args, **kw):
pass
def _call_1(self, d):
d.callback("hello")
def _call_2(self, d):
d.callback("twice")
def _err_1(self, d):
d.errback(failure.Failure(RuntimeError()))
def _err_2(self, d):
d.errback(failure.Failure(RuntimeError()))
def testAlreadyCalled_CC(self):
d = defer.Deferred()
d.addCallbacks(self._callback, self._errback)
self._call_1(d)
self.failUnlessRaises(defer.AlreadyCalledError, self._call_2, d)
def testAlreadyCalled_CE(self):
d = defer.Deferred()
d.addCallbacks(self._callback, self._errback)
self._call_1(d)
self.failUnlessRaises(defer.AlreadyCalledError, self._err_2, d)
def testAlreadyCalled_EE(self):
d = defer.Deferred()
d.addCallbacks(self._callback, self._errback)
self._err_1(d)
self.failUnlessRaises(defer.AlreadyCalledError, self._err_2, d)
def testAlreadyCalled_EC(self):
d = defer.Deferred()
d.addCallbacks(self._callback, self._errback)
self._err_1(d)
self.failUnlessRaises(defer.AlreadyCalledError, self._call_2, d)
def _count(self, linetype, func, lines, expected):
count = 0
for line in lines:
if (line.startswith(' %s:' % linetype) and
line.endswith(' %s' % func)):
count += 1
self.failUnless(count == expected)
def _check(self, e, caller, invoker1, invoker2):
# make sure the debugging information is vaguely correct
lines = e.args[0].split("\n")
# the creator should list the creator (testAlreadyCalledDebug) but not
# _call_1 or _call_2 or other invokers
self._count('C', caller, lines, 1)
self._count('C', '_call_1', lines, 0)
self._count('C', '_call_2', lines, 0)
self._count('C', '_err_1', lines, 0)
self._count('C', '_err_2', lines, 0)
# invoker should list the first invoker but not the second
self._count('I', invoker1, lines, 1)
self._count('I', invoker2, lines, 0)
def testAlreadyCalledDebug_CC(self):
d = defer.Deferred()
d.addCallbacks(self._callback, self._errback)
self._call_1(d)
try:
self._call_2(d)
except defer.AlreadyCalledError as e:
self._check(e, "testAlreadyCalledDebug_CC", "_call_1", "_call_2")
else:
self.fail("second callback failed to raise AlreadyCalledError")
def testAlreadyCalledDebug_CE(self):
d = defer.Deferred()
d.addCallbacks(self._callback, self._errback)
self._call_1(d)
try:
self._err_2(d)
except defer.AlreadyCalledError as e:
self._check(e, "testAlreadyCalledDebug_CE", "_call_1", "_err_2")
else:
self.fail("second errback failed to raise AlreadyCalledError")
def testAlreadyCalledDebug_EC(self):
d = defer.Deferred()
d.addCallbacks(self._callback, self._errback)
self._err_1(d)
try:
self._call_2(d)
except defer.AlreadyCalledError as e:
self._check(e, "testAlreadyCalledDebug_EC", "_err_1", "_call_2")
else:
self.fail("second callback failed to raise AlreadyCalledError")
def testAlreadyCalledDebug_EE(self):
d = defer.Deferred()
d.addCallbacks(self._callback, self._errback)
self._err_1(d)
try:
self._err_2(d)
except defer.AlreadyCalledError as e:
self._check(e, "testAlreadyCalledDebug_EE", "_err_1", "_err_2")
else:
self.fail("second errback failed to raise AlreadyCalledError")
def testNoDebugging(self):
defer.setDebugging(False)
d = defer.Deferred()
d.addCallbacks(self._callback, self._errback)
self._call_1(d)
try:
self._call_2(d)
except defer.AlreadyCalledError as e:
self.failIf(e.args)
else:
self.fail("second callback failed to raise AlreadyCalledError")
def testSwitchDebugging(self):
# Make sure Deferreds can deal with debug state flipping
# around randomly. This is covering a particular fixed bug.
defer.setDebugging(False)
d = defer.Deferred()
d.addBoth(lambda ign: None)
defer.setDebugging(True)
d.callback(None)
defer.setDebugging(False)
d = defer.Deferred()
d.callback(None)
defer.setDebugging(True)
d.addBoth(lambda ign: None)
class DeferredCancellerTest(unittest.SynchronousTestCase):
def setUp(self):
self.callbackResults = None
self.errbackResults = None
self.callback2Results = None
self.cancellerCallCount = 0
def tearDown(self):
# Sanity check that the canceller was called at most once.
self.assertTrue(self.cancellerCallCount in (0, 1))
def _callback(self, data):
self.callbackResults = data
return data
def _callback2(self, data):
self.callback2Results = data
def _errback(self, data):
self.errbackResults = data
def test_noCanceller(self):
"""
A L{defer.Deferred} without a canceller must errback with a
L{defer.CancelledError} and not callback.
"""
d = defer.Deferred()
d.addCallbacks(self._callback, self._errback)
d.cancel()
self.assertEqual(self.errbackResults.type, defer.CancelledError)
self.assertEqual(self.callbackResults, None)
def test_raisesAfterCancelAndCallback(self):
"""
A L{defer.Deferred} without a canceller, when cancelled must allow
a single extra call to callback, and raise
L{defer.AlreadyCalledError} if callbacked or errbacked thereafter.
"""
d = defer.Deferred()
d.addCallbacks(self._callback, self._errback)
d.cancel()
# A single extra callback should be swallowed.
d.callback(None)
# But a second call to callback or errback is not.
self.assertRaises(defer.AlreadyCalledError, d.callback, None)
self.assertRaises(defer.AlreadyCalledError, d.errback, Exception())
def test_raisesAfterCancelAndErrback(self):
"""
A L{defer.Deferred} without a canceller, when cancelled must allow
a single extra call to errback, and raise
L{defer.AlreadyCalledError} if callbacked or errbacked thereafter.
"""
d = defer.Deferred()
d.addCallbacks(self._callback, self._errback)
d.cancel()
# A single extra errback should be swallowed.
d.errback(Exception())
# But a second call to callback or errback is not.
self.assertRaises(defer.AlreadyCalledError, d.callback, None)
self.assertRaises(defer.AlreadyCalledError, d.errback, Exception())
def test_noCancellerMultipleCancelsAfterCancelAndCallback(self):
"""
A L{Deferred} without a canceller, when cancelled and then
callbacked, ignores multiple cancels thereafter.
"""
d = defer.Deferred()
d.addCallbacks(self._callback, self._errback)
d.cancel()
currentFailure = self.errbackResults
# One callback will be ignored
d.callback(None)
# Cancel should have no effect.
d.cancel()
self.assertIdentical(currentFailure, self.errbackResults)
def test_noCancellerMultipleCancelsAfterCancelAndErrback(self):
"""
A L{defer.Deferred} without a canceller, when cancelled and then
errbacked, ignores multiple cancels thereafter.
"""
d = defer.Deferred()
d.addCallbacks(self._callback, self._errback)
d.cancel()
self.assertEqual(self.errbackResults.type, defer.CancelledError)
currentFailure = self.errbackResults
# One errback will be ignored
d.errback(GenericError())
# I.e., we should still have a CancelledError.
self.assertEqual(self.errbackResults.type, defer.CancelledError)
d.cancel()
self.assertIdentical(currentFailure, self.errbackResults)
def test_noCancellerMultipleCancel(self):
"""
Calling cancel multiple times on a deferred with no canceller
results in a L{defer.CancelledError}. Subsequent calls to cancel
do not cause an error.
"""
d = defer.Deferred()
d.addCallbacks(self._callback, self._errback)
d.cancel()
self.assertEqual(self.errbackResults.type, defer.CancelledError)
currentFailure = self.errbackResults
d.cancel()
self.assertIdentical(currentFailure, self.errbackResults)
def test_cancellerMultipleCancel(self):
"""
Verify that calling cancel multiple times on a deferred with a
canceller that does not errback results in a
L{defer.CancelledError} and that subsequent calls to cancel do not
cause an error and that after all that, the canceller was only
called once.
"""
def cancel(d):
self.cancellerCallCount += 1
d = defer.Deferred(canceller=cancel)
d.addCallbacks(self._callback, self._errback)
d.cancel()
self.assertEqual(self.errbackResults.type, defer.CancelledError)
currentFailure = self.errbackResults
d.cancel()
self.assertIdentical(currentFailure, self.errbackResults)
self.assertEqual(self.cancellerCallCount, 1)
def test_simpleCanceller(self):
"""
Verify that a L{defer.Deferred} calls its specified canceller when
it is cancelled, and that further call/errbacks raise
L{defer.AlreadyCalledError}.
"""
def cancel(d):
self.cancellerCallCount += 1
d = defer.Deferred(canceller=cancel)
d.addCallbacks(self._callback, self._errback)
d.cancel()
self.assertEqual(self.cancellerCallCount, 1)
self.assertEqual(self.errbackResults.type, defer.CancelledError)
# Test that further call/errbacks are *not* swallowed
self.assertRaises(defer.AlreadyCalledError, d.callback, None)
self.assertRaises(defer.AlreadyCalledError, d.errback, Exception())
def test_cancellerArg(self):
"""
Verify that a canceller is given the correct deferred argument.
"""
def cancel(d1):
self.assertIdentical(d1, d)
d = defer.Deferred(canceller=cancel)
d.addCallbacks(self._callback, self._errback)
d.cancel()
def test_cancelAfterCallback(self):
"""
Test that cancelling a deferred after it has been callbacked does
not cause an error.
"""
def cancel(d):
self.cancellerCallCount += 1
d.errback(GenericError())
d = defer.Deferred(canceller=cancel)
d.addCallbacks(self._callback, self._errback)
d.callback('biff!')
d.cancel()
self.assertEqual(self.cancellerCallCount, 0)
self.assertEqual(self.errbackResults, None)
self.assertEqual(self.callbackResults, 'biff!')
def test_cancelAfterErrback(self):
"""
Test that cancelling a L{Deferred} after it has been errbacked does
not result in a L{defer.CancelledError}.
"""
def cancel(d):
self.cancellerCallCount += 1
d.errback(GenericError())
d = defer.Deferred(canceller=cancel)
d.addCallbacks(self._callback, self._errback)
d.errback(GenericError())
d.cancel()
self.assertEqual(self.cancellerCallCount, 0)
self.assertEqual(self.errbackResults.type, GenericError)
self.assertEqual(self.callbackResults, None)
def test_cancellerThatErrbacks(self):
"""
Test a canceller which errbacks its deferred.
"""
def cancel(d):
self.cancellerCallCount += 1
d.errback(GenericError())
d = defer.Deferred(canceller=cancel)
d.addCallbacks(self._callback, self._errback)
d.cancel()
self.assertEqual(self.cancellerCallCount, 1)
self.assertEqual(self.errbackResults.type, GenericError)
def test_cancellerThatCallbacks(self):
"""
Test a canceller which calls its deferred.
"""
def cancel(d):
self.cancellerCallCount += 1
d.callback('hello!')
d = defer.Deferred(canceller=cancel)
d.addCallbacks(self._callback, self._errback)
d.cancel()
self.assertEqual(self.cancellerCallCount, 1)
self.assertEqual(self.callbackResults, 'hello!')
self.assertEqual(self.errbackResults, None)
def test_cancelNestedDeferred(self):
"""
Verify that a Deferred, a, which is waiting on another Deferred, b,
returned from one of its callbacks, will propagate
L{defer.CancelledError} when a is cancelled.
"""
def innerCancel(d):
self.cancellerCallCount += 1
def cancel(d):
self.assert_(False)
b = defer.Deferred(canceller=innerCancel)
a = defer.Deferred(canceller=cancel)
a.callback(None)
a.addCallback(lambda data: b)
a.cancel()
a.addCallbacks(self._callback, self._errback)
# The cancel count should be one (the cancellation done by B)
self.assertEqual(self.cancellerCallCount, 1)
# B's canceller didn't errback, so defer.py will have called errback
# with a CancelledError.
self.assertEqual(self.errbackResults.type, defer.CancelledError)
class LogTestCase(unittest.SynchronousTestCase):
"""
Test logging of unhandled errors.
"""
def setUp(self):
"""
Add a custom observer to observer logging.
"""
self.c = []
log.addObserver(self.c.append)
def tearDown(self):
"""
Remove the observer.
"""
log.removeObserver(self.c.append)
def _loggedErrors(self):
return [e for e in self.c if e["isError"]]
def _check(self):
"""
Check the output of the log observer to see if the error is present.
"""
c2 = self._loggedErrors()
self.assertEqual(len(c2), 2)
c2[1]["failure"].trap(ZeroDivisionError)
self.flushLoggedErrors(ZeroDivisionError)
def test_errorLog(self):
"""
Verify that when a L{Deferred} with no references to it is fired,
and its final result (the one not handled by any callback) is an
exception, that exception will be logged immediately.
"""
defer.Deferred().addCallback(lambda x: 1 // 0).callback(1)
gc.collect()
self._check()
def test_errorLogWithInnerFrameRef(self):
"""
Same as L{test_errorLog}, but with an inner frame.
"""
def _subErrorLogWithInnerFrameRef():
d = defer.Deferred()
d.addCallback(lambda x: 1 // 0)
d.callback(1)
_subErrorLogWithInnerFrameRef()
gc.collect()
self._check()
def test_errorLogWithInnerFrameCycle(self):
"""
Same as L{test_errorLogWithInnerFrameRef}, plus create a cycle.
"""
def _subErrorLogWithInnerFrameCycle():
d = defer.Deferred()
d.addCallback(lambda x, d=d: 1 // 0)
d._d = d
d.callback(1)
_subErrorLogWithInnerFrameCycle()
gc.collect()
self._check()
def test_chainedErrorCleanup(self):
"""
If one Deferred with an error result is returned from a callback on
another Deferred, when the first Deferred is garbage collected it does
not log its error.
"""
d = defer.Deferred()
d.addCallback(lambda ign: defer.fail(RuntimeError("zoop")))
d.callback(None)
# Sanity check - this isn't too interesting, but we do want the original
# Deferred to have gotten the failure.
results = []
errors = []
d.addCallbacks(results.append, errors.append)
self.assertEqual(results, [])
self.assertEqual(len(errors), 1)
errors[0].trap(Exception)
# Get rid of any references we might have to the inner Deferred (none of
# these should really refer to it, but we're just being safe).
del results, errors, d
# Force a collection cycle so that there's a chance for an error to be
# logged, if it's going to be logged.
gc.collect()
# And make sure it is not.
self.assertEqual(self._loggedErrors(), [])
def test_errorClearedByChaining(self):
"""
If a Deferred with a failure result has an errback which chains it to
another Deferred, the initial failure is cleared by the errback so it is
not logged.
"""
# Start off with a Deferred with a failure for a result
bad = defer.fail(Exception("oh no"))
good = defer.Deferred()
# Give it a callback that chains it to another Deferred
bad.addErrback(lambda ignored: good)
# That's all, clean it up. No Deferred here still has a failure result,
# so nothing should be logged.
good = bad = None
gc.collect()
self.assertEqual(self._loggedErrors(), [])
class DeferredTestCaseII(unittest.SynchronousTestCase):
def setUp(self):
self.callbackRan = 0
def testDeferredListEmpty(self):
"""Testing empty DeferredList."""
dl = defer.DeferredList([])
dl.addCallback(self.cb_empty)
def cb_empty(self, res):
self.callbackRan = 1
self.assertEqual([], res)
def tearDown(self):
self.failUnless(self.callbackRan, "Callback was never run.")
class OtherPrimitives(unittest.SynchronousTestCase, ImmediateFailureMixin):
def _incr(self, result):
self.counter += 1
def setUp(self):
self.counter = 0
def testLock(self):
lock = defer.DeferredLock()
lock.acquire().addCallback(self._incr)
self.failUnless(lock.locked)
self.assertEqual(self.counter, 1)
lock.acquire().addCallback(self._incr)
self.failUnless(lock.locked)
self.assertEqual(self.counter, 1)
lock.release()
self.failUnless(lock.locked)
self.assertEqual(self.counter, 2)
lock.release()
self.failIf(lock.locked)
self.assertEqual(self.counter, 2)
self.assertRaises(TypeError, lock.run)
firstUnique = object()
secondUnique = object()
controlDeferred = defer.Deferred()
def helper(self, b):
self.b = b
return controlDeferred
resultDeferred = lock.run(helper, self=self, b=firstUnique)
self.failUnless(lock.locked)
self.assertEqual(self.b, firstUnique)
resultDeferred.addCallback(lambda x: setattr(self, 'result', x))
lock.acquire().addCallback(self._incr)
self.failUnless(lock.locked)
self.assertEqual(self.counter, 2)
controlDeferred.callback(secondUnique)
self.assertEqual(self.result, secondUnique)
self.failUnless(lock.locked)
self.assertEqual(self.counter, 3)
d = lock.acquire().addBoth(lambda x: setattr(self, 'result', x))
d.cancel()
self.assertEqual(self.result.type, defer.CancelledError)
lock.release()
self.failIf(lock.locked)
def test_cancelLockAfterAcquired(self):
"""
When canceling a L{Deferred} from a L{DeferredLock} that already
has the lock, the cancel should have no effect.
"""
def _failOnErrback(_):
self.fail("Unexpected errback call!")
lock = defer.DeferredLock()
d = lock.acquire()
d.addErrback(_failOnErrback)
d.cancel()
def test_cancelLockBeforeAcquired(self):
"""
When canceling a L{Deferred} from a L{DeferredLock} that does not
yet have the lock (i.e., the L{Deferred} has not fired), the cancel
should cause a L{defer.CancelledError} failure.
"""
lock = defer.DeferredLock()
lock.acquire()
d = lock.acquire()
d.cancel()
self.assertImmediateFailure(d, defer.CancelledError)
def testSemaphore(self):
N = 13
sem = defer.DeferredSemaphore(N)
controlDeferred = defer.Deferred()
def helper(self, arg):
self.arg = arg
return controlDeferred
results = []
uniqueObject = object()
resultDeferred = sem.run(helper, self=self, arg=uniqueObject)
resultDeferred.addCallback(results.append)
resultDeferred.addCallback(self._incr)
self.assertEqual(results, [])
self.assertEqual(self.arg, uniqueObject)
controlDeferred.callback(None)
self.assertEqual(results.pop(), None)
self.assertEqual(self.counter, 1)
self.counter = 0
for i in range(1, 1 + N):
sem.acquire().addCallback(self._incr)
self.assertEqual(self.counter, i)
success = []
def fail(r):
success.append(False)
def succeed(r):
success.append(True)
d = sem.acquire().addCallbacks(fail, succeed)
d.cancel()
self.assertEqual(success, [True])
sem.acquire().addCallback(self._incr)
self.assertEqual(self.counter, N)
sem.release()
self.assertEqual(self.counter, N + 1)
for i in range(1, 1 + N):
sem.release()
self.assertEqual(self.counter, N + 1)
def test_semaphoreInvalidTokens(self):
"""
If the token count passed to L{DeferredSemaphore} is less than one
then L{ValueError} is raised.
"""
self.assertRaises(ValueError, defer.DeferredSemaphore, 0)
self.assertRaises(ValueError, defer.DeferredSemaphore, -1)
def test_cancelSemaphoreAfterAcquired(self):
"""
When canceling a L{Deferred} from a L{DeferredSemaphore} that
already has the semaphore, the cancel should have no effect.
"""
def _failOnErrback(_):
self.fail("Unexpected errback call!")
sem = defer.DeferredSemaphore(1)
d = sem.acquire()
d.addErrback(_failOnErrback)
d.cancel()
def test_cancelSemaphoreBeforeAcquired(self):
"""
When canceling a L{Deferred} from a L{DeferredSemaphore} that does
not yet have the semaphore (i.e., the L{Deferred} has not fired),
the cancel should cause a L{defer.CancelledError} failure.
"""
sem = defer.DeferredSemaphore(1)
sem.acquire()
d = sem.acquire()
d.cancel()
self.assertImmediateFailure(d, defer.CancelledError)
def testQueue(self):
N, M = 2, 2
queue = defer.DeferredQueue(N, M)
gotten = []
for i in range(M):
queue.get().addCallback(gotten.append)
self.assertRaises(defer.QueueUnderflow, queue.get)
for i in range(M):
queue.put(i)
self.assertEqual(gotten, list(range(i + 1)))
for i in range(N):
queue.put(N + i)
self.assertEqual(gotten, list(range(M)))
self.assertRaises(defer.QueueOverflow, queue.put, None)
gotten = []
for i in range(N):
queue.get().addCallback(gotten.append)
self.assertEqual(gotten, list(range(N, N + i + 1)))
queue = defer.DeferredQueue()
gotten = []
for i in range(N):
queue.get().addCallback(gotten.append)
for i in range(N):
queue.put(i)
self.assertEqual(gotten, list(range(N)))
queue = defer.DeferredQueue(size=0)
self.assertRaises(defer.QueueOverflow, queue.put, None)
queue = defer.DeferredQueue(backlog=0)
self.assertRaises(defer.QueueUnderflow, queue.get)
def test_cancelQueueAfterSynchronousGet(self):
"""
When canceling a L{Deferred} from a L{DeferredQueue} that already has
a result, the cancel should have no effect.
"""
def _failOnErrback(_):
self.fail("Unexpected errback call!")
queue = defer.DeferredQueue()
d = queue.get()
d.addErrback(_failOnErrback)
queue.put(None)
d.cancel()
def test_cancelQueueAfterGet(self):
"""
When canceling a L{Deferred} from a L{DeferredQueue} that does not
have a result (i.e., the L{Deferred} has not fired), the cancel
causes a L{defer.CancelledError} failure. If the queue has a result
later on, it doesn't try to fire the deferred.
"""
queue = defer.DeferredQueue()
d = queue.get()
d.cancel()
self.assertImmediateFailure(d, defer.CancelledError)
def cb(ignore):
# If the deferred is still linked with the deferred queue, it will
# fail with an AlreadyCalledError
queue.put(None)
return queue.get().addCallback(self.assertIdentical, None)
d.addCallback(cb)
done = []
d.addCallback(done.append)
self.assertEqual(len(done), 1)
class DeferredFilesystemLockTestCase(unittest.TestCase):
"""
Test the behavior of L{DeferredFilesystemLock}
"""
def setUp(self):
self.clock = Clock()
self.lock = defer.DeferredFilesystemLock(self.mktemp(),
scheduler=self.clock)
def test_waitUntilLockedWithNoLock(self):
"""
Test that the lock can be acquired when no lock is held
"""
d = self.lock.deferUntilLocked(timeout=1)
return d
def test_waitUntilLockedWithTimeoutLocked(self):
"""
Test that the lock can not be acquired when the lock is held
for longer than the timeout.
"""
self.failUnless(self.lock.lock())
d = self.lock.deferUntilLocked(timeout=5.5)
self.assertFailure(d, defer.TimeoutError)
self.clock.pump([1] * 10)
return d
def test_waitUntilLockedWithTimeoutUnlocked(self):
"""
Test that a lock can be acquired while a lock is held
but the lock is unlocked before our timeout.
"""
def onTimeout(f):
f.trap(defer.TimeoutError)
self.fail("Should not have timed out")
self.failUnless(self.lock.lock())
self.clock.callLater(1, self.lock.unlock)
d = self.lock.deferUntilLocked(timeout=10)
d.addErrback(onTimeout)
self.clock.pump([1] * 10)
return d
def test_defaultScheduler(self):
"""
Test that the default scheduler is set up properly.
"""
lock = defer.DeferredFilesystemLock(self.mktemp())
self.assertEqual(lock._scheduler, reactor)
def test_concurrentUsage(self):
"""
Test that an appropriate exception is raised when attempting
to use deferUntilLocked concurrently.
"""
self.lock.lock()
self.clock.callLater(1, self.lock.unlock)
d = self.lock.deferUntilLocked()
d2 = self.lock.deferUntilLocked()
self.assertFailure(d2, defer.AlreadyTryingToLockError)
self.clock.advance(1)
return d
def test_multipleUsages(self):
"""
Test that a DeferredFilesystemLock can be used multiple times
"""
def lockAquired(ign):
self.lock.unlock()
d = self.lock.deferUntilLocked()
return d
self.lock.lock()
self.clock.callLater(1, self.lock.unlock)
d = self.lock.deferUntilLocked()
d.addCallback(lockAquired)
self.clock.advance(1)
return d
|