/usr/share/pyshared/twisted/web/test/test_webclient.py is in python-twisted-web 12.0.0-1.
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 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 | # Copyright (c) Twisted Matrix Laboratories.
# See LICENSE for details.
"""
Tests for L{twisted.web.client}.
"""
import cookielib
import os
from errno import ENOSPC
import zlib
from StringIO import StringIO
from urlparse import urlparse
from zope.interface.verify import verifyObject
from twisted.trial import unittest
from twisted.web import server, static, client, error, util, resource, http_headers
from twisted.internet import reactor, defer, interfaces, task
from twisted.python.failure import Failure
from twisted.python.filepath import FilePath
from twisted.python.log import msg
from twisted.python.components import proxyForInterface
from twisted.protocols.policies import WrappingFactory
from twisted.test.proto_helpers import StringTransport
from twisted.test.proto_helpers import MemoryReactor
from twisted.internet.address import IPv4Address
from twisted.internet.task import Clock
from twisted.internet.error import ConnectionRefusedError
from twisted.internet.protocol import Protocol
from twisted.internet.defer import Deferred, succeed
from twisted.internet.endpoints import TCP4ClientEndpoint
from twisted.web.client import FileBodyProducer, Request
from twisted.web.iweb import UNKNOWN_LENGTH, IBodyProducer, IResponse
from twisted.web._newclient import HTTP11ClientProtocol, Response
from twisted.web.error import SchemeNotSupported
try:
from twisted.internet import ssl
except:
ssl = None
else:
from OpenSSL.SSL import ContextType
class ExtendedRedirect(resource.Resource):
"""
Redirection resource.
The HTTP status code is set according to the C{code} query parameter.
@type lastMethod: C{str}
@ivar lastMethod: Last handled HTTP request method
"""
isLeaf = 1
lastMethod = None
def __init__(self, url):
resource.Resource.__init__(self)
self.url = url
def render(self, request):
if self.lastMethod:
self.lastMethod = request.method
return "OK Thnx!"
else:
self.lastMethod = request.method
code = int(request.args['code'][0])
return self.redirectTo(self.url, request, code)
def getChild(self, name, request):
return self
def redirectTo(self, url, request, code):
request.setResponseCode(code)
request.setHeader("location", url)
return "OK Bye!"
class ForeverTakingResource(resource.Resource):
"""
L{ForeverTakingResource} is a resource which never finishes responding
to requests.
"""
def __init__(self, write=False):
resource.Resource.__init__(self)
self._write = write
def render(self, request):
if self._write:
request.write('some bytes')
return server.NOT_DONE_YET
class CookieMirrorResource(resource.Resource):
def render(self, request):
l = []
for k,v in request.received_cookies.items():
l.append((k, v))
l.sort()
return repr(l)
class RawCookieMirrorResource(resource.Resource):
def render(self, request):
return repr(request.getHeader('cookie'))
class ErrorResource(resource.Resource):
def render(self, request):
request.setResponseCode(401)
if request.args.get("showlength"):
request.setHeader("content-length", "0")
return ""
class NoLengthResource(resource.Resource):
def render(self, request):
return "nolength"
class HostHeaderResource(resource.Resource):
"""
A testing resource which renders itself as the value of the host header
from the request.
"""
def render(self, request):
return request.received_headers['host']
class PayloadResource(resource.Resource):
"""
A testing resource which renders itself as the contents of the request body
as long as the request body is 100 bytes long, otherwise which renders
itself as C{"ERROR"}.
"""
def render(self, request):
data = request.content.read()
contentLength = request.received_headers['content-length']
if len(data) != 100 or int(contentLength) != 100:
return "ERROR"
return data
class BrokenDownloadResource(resource.Resource):
def render(self, request):
# only sends 3 bytes even though it claims to send 5
request.setHeader("content-length", "5")
request.write('abc')
return ''
class CountingRedirect(util.Redirect):
"""
A L{util.Redirect} resource that keeps track of the number of times the
resource has been accessed.
"""
def __init__(self, *a, **kw):
util.Redirect.__init__(self, *a, **kw)
self.count = 0
def render(self, request):
self.count += 1
return util.Redirect.render(self, request)
class CountingResource(resource.Resource):
"""
A resource that keeps track of the number of times it has been accessed.
"""
def __init__(self):
resource.Resource.__init__(self)
self.count = 0
def render(self, request):
self.count += 1
return "Success"
class ParseUrlTestCase(unittest.TestCase):
"""
Test URL parsing facility and defaults values.
"""
def test_parse(self):
"""
L{client._parse} correctly parses a URL into its various components.
"""
# The default port for HTTP is 80.
self.assertEqual(
client._parse('http://127.0.0.1/'),
('http', '127.0.0.1', 80, '/'))
# The default port for HTTPS is 443.
self.assertEqual(
client._parse('https://127.0.0.1/'),
('https', '127.0.0.1', 443, '/'))
# Specifying a port.
self.assertEqual(
client._parse('http://spam:12345/'),
('http', 'spam', 12345, '/'))
# Weird (but commonly accepted) structure uses default port.
self.assertEqual(
client._parse('http://spam:/'),
('http', 'spam', 80, '/'))
# Spaces in the hostname are trimmed, the default path is /.
self.assertEqual(
client._parse('http://foo '),
('http', 'foo', 80, '/'))
def test_externalUnicodeInterference(self):
"""
L{client._parse} should return C{str} for the scheme, host, and path
elements of its return tuple, even when passed an URL which has
previously been passed to L{urlparse} as a C{unicode} string.
"""
badInput = u'http://example.com/path'
goodInput = badInput.encode('ascii')
urlparse(badInput)
scheme, host, port, path = client._parse(goodInput)
self.assertIsInstance(scheme, str)
self.assertIsInstance(host, str)
self.assertIsInstance(path, str)
class HTTPPageGetterTests(unittest.TestCase):
"""
Tests for L{HTTPPagerGetter}, the HTTP client protocol implementation
used to implement L{getPage}.
"""
def test_earlyHeaders(self):
"""
When a connection is made, L{HTTPPagerGetter} sends the headers from
its factory's C{headers} dict. If I{Host} or I{Content-Length} is
present in this dict, the values are not sent, since they are sent with
special values before the C{headers} dict is processed. If
I{User-Agent} is present in the dict, it overrides the value of the
C{agent} attribute of the factory. If I{Cookie} is present in the
dict, its value is added to the values from the factory's C{cookies}
attribute.
"""
factory = client.HTTPClientFactory(
'http://foo/bar',
agent="foobar",
cookies={'baz': 'quux'},
postdata="some data",
headers={
'Host': 'example.net',
'User-Agent': 'fooble',
'Cookie': 'blah blah',
'Content-Length': '12981',
'Useful': 'value'})
transport = StringTransport()
protocol = client.HTTPPageGetter()
protocol.factory = factory
protocol.makeConnection(transport)
self.assertEqual(
transport.value(),
"GET /bar HTTP/1.0\r\n"
"Host: example.net\r\n"
"User-Agent: foobar\r\n"
"Content-Length: 9\r\n"
"Useful: value\r\n"
"connection: close\r\n"
"Cookie: blah blah; baz=quux\r\n"
"\r\n"
"some data")
class WebClientTestCase(unittest.TestCase):
def _listen(self, site):
return reactor.listenTCP(0, site, interface="127.0.0.1")
def setUp(self):
self.cleanupServerConnections = 0
name = self.mktemp()
os.mkdir(name)
FilePath(name).child("file").setContent("0123456789")
r = static.File(name)
r.putChild("redirect", util.Redirect("/file"))
self.infiniteRedirectResource = CountingRedirect("/infiniteRedirect")
r.putChild("infiniteRedirect", self.infiniteRedirectResource)
r.putChild("wait", ForeverTakingResource())
r.putChild("write-then-wait", ForeverTakingResource(write=True))
r.putChild("error", ErrorResource())
r.putChild("nolength", NoLengthResource())
r.putChild("host", HostHeaderResource())
r.putChild("payload", PayloadResource())
r.putChild("broken", BrokenDownloadResource())
r.putChild("cookiemirror", CookieMirrorResource())
self.afterFoundGetCounter = CountingResource()
r.putChild("afterFoundGetCounter", self.afterFoundGetCounter)
r.putChild("afterFoundGetRedirect", util.Redirect("/afterFoundGetCounter"))
miscasedHead = static.Data("miscased-head GET response content", "major/minor")
miscasedHead.render_Head = lambda request: "miscased-head content"
r.putChild("miscased-head", miscasedHead)
self.extendedRedirect = ExtendedRedirect('/extendedRedirect')
r.putChild("extendedRedirect", self.extendedRedirect)
self.site = server.Site(r, timeout=None)
self.wrapper = WrappingFactory(self.site)
self.port = self._listen(self.wrapper)
self.portno = self.port.getHost().port
def tearDown(self):
# If the test indicated it might leave some server-side connections
# around, clean them up.
connections = self.wrapper.protocols.keys()
# If there are fewer server-side connections than requested,
# that's okay. Some might have noticed that the client closed
# the connection and cleaned up after themselves.
for n in range(min(len(connections), self.cleanupServerConnections)):
proto = connections.pop()
msg("Closing %r" % (proto,))
proto.transport.loseConnection()
if connections:
msg("Some left-over connections; this test is probably buggy.")
return self.port.stopListening()
def getURL(self, path):
return "http://127.0.0.1:%d/%s" % (self.portno, path)
def testPayload(self):
s = "0123456789" * 10
return client.getPage(self.getURL("payload"), postdata=s
).addCallback(self.assertEqual, s
)
def test_getPageBrokenDownload(self):
"""
If the connection is closed before the number of bytes indicated by
I{Content-Length} have been received, the L{Deferred} returned by
L{getPage} fails with L{PartialDownloadError}.
"""
d = client.getPage(self.getURL("broken"))
d = self.assertFailure(d, client.PartialDownloadError)
d.addCallback(lambda exc: self.assertEqual(exc.response, "abc"))
return d
def test_downloadPageBrokenDownload(self):
"""
If the connection is closed before the number of bytes indicated by
I{Content-Length} have been received, the L{Deferred} returned by
L{downloadPage} fails with L{PartialDownloadError}.
"""
# test what happens when download gets disconnected in the middle
path = FilePath(self.mktemp())
d = client.downloadPage(self.getURL("broken"), path.path)
d = self.assertFailure(d, client.PartialDownloadError)
def checkResponse(response):
"""
The HTTP status code from the server is propagated through the
C{PartialDownloadError}.
"""
self.assertEqual(response.status, "200")
self.assertEqual(response.message, "OK")
return response
d.addCallback(checkResponse)
def cbFailed(ignored):
self.assertEqual(path.getContent(), "abc")
d.addCallback(cbFailed)
return d
def test_downloadPageLogsFileCloseError(self):
"""
If there is an exception closing the file being written to after the
connection is prematurely closed, that exception is logged.
"""
class BrokenFile:
def write(self, bytes):
pass
def close(self):
raise IOError(ENOSPC, "No file left on device")
d = client.downloadPage(self.getURL("broken"), BrokenFile())
d = self.assertFailure(d, client.PartialDownloadError)
def cbFailed(ignored):
self.assertEqual(len(self.flushLoggedErrors(IOError)), 1)
d.addCallback(cbFailed)
return d
def testHostHeader(self):
# if we pass Host header explicitly, it should be used, otherwise
# it should extract from url
return defer.gatherResults([
client.getPage(self.getURL("host")).addCallback(self.assertEqual, "127.0.0.1:%s" % (self.portno,)),
client.getPage(self.getURL("host"), headers={"Host": "www.example.com"}).addCallback(self.assertEqual, "www.example.com")])
def test_getPage(self):
"""
L{client.getPage} returns a L{Deferred} which is called back with
the body of the response if the default method B{GET} is used.
"""
d = client.getPage(self.getURL("file"))
d.addCallback(self.assertEqual, "0123456789")
return d
def test_getPageHEAD(self):
"""
L{client.getPage} returns a L{Deferred} which is called back with
the empty string if the method is I{HEAD} and there is a successful
response code.
"""
d = client.getPage(self.getURL("file"), method="HEAD")
d.addCallback(self.assertEqual, "")
return d
def test_getPageNotQuiteHEAD(self):
"""
If the request method is a different casing of I{HEAD} (ie, not all
capitalized) then it is not a I{HEAD} request and the response body
is returned.
"""
d = client.getPage(self.getURL("miscased-head"), method='Head')
d.addCallback(self.assertEqual, "miscased-head content")
return d
def test_timeoutNotTriggering(self):
"""
When a non-zero timeout is passed to L{getPage} and the page is
retrieved before the timeout period elapses, the L{Deferred} is
called back with the contents of the page.
"""
d = client.getPage(self.getURL("host"), timeout=100)
d.addCallback(self.assertEqual, "127.0.0.1:%s" % (self.portno,))
return d
def test_timeoutTriggering(self):
"""
When a non-zero timeout is passed to L{getPage} and that many
seconds elapse before the server responds to the request. the
L{Deferred} is errbacked with a L{error.TimeoutError}.
"""
# This will probably leave some connections around.
self.cleanupServerConnections = 1
return self.assertFailure(
client.getPage(self.getURL("wait"), timeout=0.000001),
defer.TimeoutError)
def testDownloadPage(self):
downloads = []
downloadData = [("file", self.mktemp(), "0123456789"),
("nolength", self.mktemp(), "nolength")]
for (url, name, data) in downloadData:
d = client.downloadPage(self.getURL(url), name)
d.addCallback(self._cbDownloadPageTest, data, name)
downloads.append(d)
return defer.gatherResults(downloads)
def _cbDownloadPageTest(self, ignored, data, name):
bytes = file(name, "rb").read()
self.assertEqual(bytes, data)
def testDownloadPageError1(self):
class errorfile:
def write(self, data):
raise IOError, "badness happened during write"
def close(self):
pass
ef = errorfile()
return self.assertFailure(
client.downloadPage(self.getURL("file"), ef),
IOError)
def testDownloadPageError2(self):
class errorfile:
def write(self, data):
pass
def close(self):
raise IOError, "badness happened during close"
ef = errorfile()
return self.assertFailure(
client.downloadPage(self.getURL("file"), ef),
IOError)
def testDownloadPageError3(self):
# make sure failures in open() are caught too. This is tricky.
# Might only work on posix.
tmpfile = open("unwritable", "wb")
tmpfile.close()
os.chmod("unwritable", 0) # make it unwritable (to us)
d = self.assertFailure(
client.downloadPage(self.getURL("file"), "unwritable"),
IOError)
d.addBoth(self._cleanupDownloadPageError3)
return d
def _cleanupDownloadPageError3(self, ignored):
os.chmod("unwritable", 0700)
os.unlink("unwritable")
return ignored
def _downloadTest(self, method):
dl = []
for (url, code) in [("nosuchfile", "404"), ("error", "401"),
("error?showlength=1", "401")]:
d = method(url)
d = self.assertFailure(d, error.Error)
d.addCallback(lambda exc, code=code: self.assertEqual(exc.args[0], code))
dl.append(d)
return defer.DeferredList(dl, fireOnOneErrback=True)
def testServerError(self):
return self._downloadTest(lambda url: client.getPage(self.getURL(url)))
def testDownloadServerError(self):
return self._downloadTest(lambda url: client.downloadPage(self.getURL(url), url.split('?')[0]))
def testFactoryInfo(self):
url = self.getURL('file')
scheme, host, port, path = client._parse(url)
factory = client.HTTPClientFactory(url)
reactor.connectTCP(host, port, factory)
return factory.deferred.addCallback(self._cbFactoryInfo, factory)
def _cbFactoryInfo(self, ignoredResult, factory):
self.assertEqual(factory.status, '200')
self.assert_(factory.version.startswith('HTTP/'))
self.assertEqual(factory.message, 'OK')
self.assertEqual(factory.response_headers['content-length'][0], '10')
def test_followRedirect(self):
"""
By default, L{client.getPage} follows redirects and returns the content
of the target resource.
"""
d = client.getPage(self.getURL("redirect"))
d.addCallback(self.assertEqual, "0123456789")
return d
def test_noFollowRedirect(self):
"""
If C{followRedirect} is passed a false value, L{client.getPage} does not
follow redirects and returns a L{Deferred} which fails with
L{error.PageRedirect} when it encounters one.
"""
d = self.assertFailure(
client.getPage(self.getURL("redirect"), followRedirect=False),
error.PageRedirect)
d.addCallback(self._cbCheckLocation)
return d
def _cbCheckLocation(self, exc):
self.assertEqual(exc.location, "/file")
def test_infiniteRedirection(self):
"""
When more than C{redirectLimit} HTTP redirects are encountered, the
page request fails with L{InfiniteRedirection}.
"""
def checkRedirectCount(*a):
self.assertEqual(f._redirectCount, 13)
self.assertEqual(self.infiniteRedirectResource.count, 13)
f = client._makeGetterFactory(
self.getURL('infiniteRedirect'),
client.HTTPClientFactory,
redirectLimit=13)
d = self.assertFailure(f.deferred, error.InfiniteRedirection)
d.addCallback(checkRedirectCount)
return d
def test_isolatedFollowRedirect(self):
"""
C{client.HTTPPagerGetter} instances each obey the C{followRedirect}
value passed to the L{client.getPage} call which created them.
"""
d1 = client.getPage(self.getURL('redirect'), followRedirect=True)
d2 = client.getPage(self.getURL('redirect'), followRedirect=False)
d = self.assertFailure(d2, error.PageRedirect
).addCallback(lambda dummy: d1)
return d
def test_afterFoundGet(self):
"""
Enabling unsafe redirection behaviour overwrites the method of
redirected C{POST} requests with C{GET}.
"""
url = self.getURL('extendedRedirect?code=302')
f = client.HTTPClientFactory(url, followRedirect=True, method="POST")
self.assertFalse(
f.afterFoundGet,
"By default, afterFoundGet must be disabled")
def gotPage(page):
self.assertEqual(
self.extendedRedirect.lastMethod,
"GET",
"With afterFoundGet, the HTTP method must change to GET")
d = client.getPage(
url, followRedirect=True, afterFoundGet=True, method="POST")
d.addCallback(gotPage)
return d
def test_downloadAfterFoundGet(self):
"""
Passing C{True} for C{afterFoundGet} to L{client.downloadPage} invokes
the same kind of redirect handling as passing that argument to
L{client.getPage} invokes.
"""
url = self.getURL('extendedRedirect?code=302')
def gotPage(page):
self.assertEqual(
self.extendedRedirect.lastMethod,
"GET",
"With afterFoundGet, the HTTP method must change to GET")
d = client.downloadPage(url, "downloadTemp",
followRedirect=True, afterFoundGet=True, method="POST")
d.addCallback(gotPage)
return d
def test_afterFoundGetMakesOneRequest(self):
"""
When C{afterFoundGet} is C{True}, L{client.getPage} only issues one
request to the server when following the redirect. This is a regression
test, see #4760.
"""
def checkRedirectCount(*a):
self.assertEqual(self.afterFoundGetCounter.count, 1)
url = self.getURL('afterFoundGetRedirect')
d = client.getPage(
url, followRedirect=True, afterFoundGet=True, method="POST")
d.addCallback(checkRedirectCount)
return d
def testPartial(self):
name = self.mktemp()
f = open(name, "wb")
f.write("abcd")
f.close()
partialDownload = [(True, "abcd456789"),
(True, "abcd456789"),
(False, "0123456789")]
d = defer.succeed(None)
for (partial, expectedData) in partialDownload:
d.addCallback(self._cbRunPartial, name, partial)
d.addCallback(self._cbPartialTest, expectedData, name)
return d
testPartial.skip = "Cannot test until webserver can serve partial data properly"
def _cbRunPartial(self, ignored, name, partial):
return client.downloadPage(self.getURL("file"), name, supportPartial=partial)
def _cbPartialTest(self, ignored, expectedData, filename):
bytes = file(filename, "rb").read()
self.assertEqual(bytes, expectedData)
def test_downloadTimeout(self):
"""
If the timeout indicated by the C{timeout} parameter to
L{client.HTTPDownloader.__init__} elapses without the complete response
being received, the L{defer.Deferred} returned by
L{client.downloadPage} fires with a L{Failure} wrapping a
L{defer.TimeoutError}.
"""
self.cleanupServerConnections = 2
# Verify the behavior if no bytes are ever written.
first = client.downloadPage(
self.getURL("wait"),
self.mktemp(), timeout=0.01)
# Verify the behavior if some bytes are written but then the request
# never completes.
second = client.downloadPage(
self.getURL("write-then-wait"),
self.mktemp(), timeout=0.01)
return defer.gatherResults([
self.assertFailure(first, defer.TimeoutError),
self.assertFailure(second, defer.TimeoutError)])
def test_downloadHeaders(self):
"""
After L{client.HTTPDownloader.deferred} fires, the
L{client.HTTPDownloader} instance's C{status} and C{response_headers}
attributes are populated with the values from the response.
"""
def checkHeaders(factory):
self.assertEqual(factory.status, '200')
self.assertEqual(factory.response_headers['content-type'][0], 'text/html')
self.assertEqual(factory.response_headers['content-length'][0], '10')
os.unlink(factory.fileName)
factory = client._makeGetterFactory(
self.getURL('file'),
client.HTTPDownloader,
fileOrName=self.mktemp())
return factory.deferred.addCallback(lambda _: checkHeaders(factory))
def test_downloadCookies(self):
"""
The C{cookies} dict passed to the L{client.HTTPDownloader}
initializer is used to populate the I{Cookie} header included in the
request sent to the server.
"""
output = self.mktemp()
factory = client._makeGetterFactory(
self.getURL('cookiemirror'),
client.HTTPDownloader,
fileOrName=output,
cookies={'foo': 'bar'})
def cbFinished(ignored):
self.assertEqual(
FilePath(output).getContent(),
"[('foo', 'bar')]")
factory.deferred.addCallback(cbFinished)
return factory.deferred
def test_downloadRedirectLimit(self):
"""
When more than C{redirectLimit} HTTP redirects are encountered, the
page request fails with L{InfiniteRedirection}.
"""
def checkRedirectCount(*a):
self.assertEqual(f._redirectCount, 7)
self.assertEqual(self.infiniteRedirectResource.count, 7)
f = client._makeGetterFactory(
self.getURL('infiniteRedirect'),
client.HTTPDownloader,
fileOrName=self.mktemp(),
redirectLimit=7)
d = self.assertFailure(f.deferred, error.InfiniteRedirection)
d.addCallback(checkRedirectCount)
return d
class WebClientSSLTestCase(WebClientTestCase):
def _listen(self, site):
from twisted import test
return reactor.listenSSL(0, site,
contextFactory=ssl.DefaultOpenSSLContextFactory(
FilePath(test.__file__).sibling('server.pem').path,
FilePath(test.__file__).sibling('server.pem').path,
),
interface="127.0.0.1")
def getURL(self, path):
return "https://127.0.0.1:%d/%s" % (self.portno, path)
def testFactoryInfo(self):
url = self.getURL('file')
scheme, host, port, path = client._parse(url)
factory = client.HTTPClientFactory(url)
reactor.connectSSL(host, port, factory, ssl.ClientContextFactory())
# The base class defines _cbFactoryInfo correctly for this
return factory.deferred.addCallback(self._cbFactoryInfo, factory)
class WebClientRedirectBetweenSSLandPlainText(unittest.TestCase):
def getHTTPS(self, path):
return "https://127.0.0.1:%d/%s" % (self.tlsPortno, path)
def getHTTP(self, path):
return "http://127.0.0.1:%d/%s" % (self.plainPortno, path)
def setUp(self):
plainRoot = static.Data('not me', 'text/plain')
tlsRoot = static.Data('me neither', 'text/plain')
plainSite = server.Site(plainRoot, timeout=None)
tlsSite = server.Site(tlsRoot, timeout=None)
from twisted import test
self.tlsPort = reactor.listenSSL(0, tlsSite,
contextFactory=ssl.DefaultOpenSSLContextFactory(
FilePath(test.__file__).sibling('server.pem').path,
FilePath(test.__file__).sibling('server.pem').path,
),
interface="127.0.0.1")
self.plainPort = reactor.listenTCP(0, plainSite, interface="127.0.0.1")
self.plainPortno = self.plainPort.getHost().port
self.tlsPortno = self.tlsPort.getHost().port
plainRoot.putChild('one', util.Redirect(self.getHTTPS('two')))
tlsRoot.putChild('two', util.Redirect(self.getHTTP('three')))
plainRoot.putChild('three', util.Redirect(self.getHTTPS('four')))
tlsRoot.putChild('four', static.Data('FOUND IT!', 'text/plain'))
def tearDown(self):
ds = map(defer.maybeDeferred,
[self.plainPort.stopListening, self.tlsPort.stopListening])
return defer.gatherResults(ds)
def testHoppingAround(self):
return client.getPage(self.getHTTP("one")
).addCallback(self.assertEqual, "FOUND IT!"
)
class FakeTransport:
disconnecting = False
def __init__(self):
self.data = []
def write(self, stuff):
self.data.append(stuff)
class CookieTestCase(unittest.TestCase):
def _listen(self, site):
return reactor.listenTCP(0, site, interface="127.0.0.1")
def setUp(self):
root = static.Data('El toro!', 'text/plain')
root.putChild("cookiemirror", CookieMirrorResource())
root.putChild("rawcookiemirror", RawCookieMirrorResource())
site = server.Site(root, timeout=None)
self.port = self._listen(site)
self.portno = self.port.getHost().port
def tearDown(self):
return self.port.stopListening()
def getHTTP(self, path):
return "http://127.0.0.1:%d/%s" % (self.portno, path)
def testNoCookies(self):
return client.getPage(self.getHTTP("cookiemirror")
).addCallback(self.assertEqual, "[]"
)
def testSomeCookies(self):
cookies = {'foo': 'bar', 'baz': 'quux'}
return client.getPage(self.getHTTP("cookiemirror"), cookies=cookies
).addCallback(self.assertEqual, "[('baz', 'quux'), ('foo', 'bar')]"
)
def testRawNoCookies(self):
return client.getPage(self.getHTTP("rawcookiemirror")
).addCallback(self.assertEqual, "None"
)
def testRawSomeCookies(self):
cookies = {'foo': 'bar', 'baz': 'quux'}
return client.getPage(self.getHTTP("rawcookiemirror"), cookies=cookies
).addCallback(self.assertEqual, "'foo=bar; baz=quux'"
)
def testCookieHeaderParsing(self):
factory = client.HTTPClientFactory('http://foo.example.com/')
proto = factory.buildProtocol('127.42.42.42')
proto.transport = FakeTransport()
proto.connectionMade()
for line in [
'200 Ok',
'Squash: yes',
'Hands: stolen',
'Set-Cookie: CUSTOMER=WILE_E_COYOTE; path=/; expires=Wednesday, 09-Nov-99 23:12:40 GMT',
'Set-Cookie: PART_NUMBER=ROCKET_LAUNCHER_0001; path=/',
'Set-Cookie: SHIPPING=FEDEX; path=/foo',
'',
'body',
'more body',
]:
proto.dataReceived(line + '\r\n')
self.assertEqual(proto.transport.data,
['GET / HTTP/1.0\r\n',
'Host: foo.example.com\r\n',
'User-Agent: Twisted PageGetter\r\n',
'\r\n'])
self.assertEqual(factory.cookies,
{
'CUSTOMER': 'WILE_E_COYOTE',
'PART_NUMBER': 'ROCKET_LAUNCHER_0001',
'SHIPPING': 'FEDEX',
})
class TestHostHeader(unittest.TestCase):
"""
Test that L{HTTPClientFactory} includes the port in the host header
if needed.
"""
def _getHost(self, bytes):
"""
Retrieve the value of the I{Host} header from the serialized
request given by C{bytes}.
"""
for line in bytes.splitlines():
try:
name, value = line.split(':', 1)
if name.strip().lower() == 'host':
return value.strip()
except ValueError:
pass
def test_HTTPDefaultPort(self):
"""
No port should be included in the host header when connecting to the
default HTTP port.
"""
factory = client.HTTPClientFactory('http://foo.example.com/')
proto = factory.buildProtocol('127.42.42.42')
proto.makeConnection(StringTransport())
self.assertEqual(self._getHost(proto.transport.value()),
'foo.example.com')
def test_HTTPPort80(self):
"""
No port should be included in the host header when connecting to the
default HTTP port even if it is in the URL.
"""
factory = client.HTTPClientFactory('http://foo.example.com:80/')
proto = factory.buildProtocol('127.42.42.42')
proto.makeConnection(StringTransport())
self.assertEqual(self._getHost(proto.transport.value()),
'foo.example.com')
def test_HTTPNotPort80(self):
"""
The port should be included in the host header when connecting to the
a non default HTTP port.
"""
factory = client.HTTPClientFactory('http://foo.example.com:8080/')
proto = factory.buildProtocol('127.42.42.42')
proto.makeConnection(StringTransport())
self.assertEqual(self._getHost(proto.transport.value()),
'foo.example.com:8080')
def test_HTTPSDefaultPort(self):
"""
No port should be included in the host header when connecting to the
default HTTPS port.
"""
factory = client.HTTPClientFactory('https://foo.example.com/')
proto = factory.buildProtocol('127.42.42.42')
proto.makeConnection(StringTransport())
self.assertEqual(self._getHost(proto.transport.value()),
'foo.example.com')
def test_HTTPSPort443(self):
"""
No port should be included in the host header when connecting to the
default HTTPS port even if it is in the URL.
"""
factory = client.HTTPClientFactory('https://foo.example.com:443/')
proto = factory.buildProtocol('127.42.42.42')
proto.makeConnection(StringTransport())
self.assertEqual(self._getHost(proto.transport.value()),
'foo.example.com')
def test_HTTPSNotPort443(self):
"""
The port should be included in the host header when connecting to the
a non default HTTPS port.
"""
factory = client.HTTPClientFactory('http://foo.example.com:8080/')
proto = factory.buildProtocol('127.42.42.42')
proto.makeConnection(StringTransport())
self.assertEqual(self._getHost(proto.transport.value()),
'foo.example.com:8080')
class StubHTTPProtocol(Protocol):
"""
A protocol like L{HTTP11ClientProtocol} but which does not actually know
HTTP/1.1 and only collects requests in a list.
@ivar requests: A C{list} of two-tuples. Each time a request is made, a
tuple consisting of the request and the L{Deferred} returned from the
request method is appended to this list.
"""
def __init__(self):
self.requests = []
def request(self, request):
"""
Capture the given request for later inspection.
@return: A L{Deferred} which this code will never fire.
"""
result = Deferred()
self.requests.append((request, result))
return result
class FileConsumer(object):
def __init__(self, outputFile):
self.outputFile = outputFile
def write(self, bytes):
self.outputFile.write(bytes)
class FileBodyProducerTests(unittest.TestCase):
"""
Tests for the L{FileBodyProducer} which reads bytes from a file and writes
them to an L{IConsumer}.
"""
_NO_RESULT = object()
def _resultNow(self, deferred):
"""
Return the current result of C{deferred} if it is not a failure. If it
has no result, return C{self._NO_RESULT}. If it is a failure, raise an
exception.
"""
result = []
failure = []
deferred.addCallbacks(result.append, failure.append)
if len(result) == 1:
return result[0]
elif len(failure) == 1:
raise Exception(
"Deferred had failure instead of success: %r" % (failure[0],))
return self._NO_RESULT
def _failureNow(self, deferred):
"""
Return the current result of C{deferred} if it is a failure. If it has
no result, return C{self._NO_RESULT}. If it is not a failure, raise an
exception.
"""
result = []
failure = []
deferred.addCallbacks(result.append, failure.append)
if len(result) == 1:
raise Exception(
"Deferred had success instead of failure: %r" % (result[0],))
elif len(failure) == 1:
return failure[0]
return self._NO_RESULT
def _termination(self):
"""
This method can be used as the C{terminationPredicateFactory} for a
L{Cooperator}. It returns a predicate which immediately returns
C{False}, indicating that no more work should be done this iteration.
This has the result of only allowing one iteration of a cooperative
task to be run per L{Cooperator} iteration.
"""
return lambda: True
def setUp(self):
"""
Create a L{Cooperator} hooked up to an easily controlled, deterministic
scheduler to use with L{FileBodyProducer}.
"""
self._scheduled = []
self.cooperator = task.Cooperator(
self._termination, self._scheduled.append)
def test_interface(self):
"""
L{FileBodyProducer} instances provide L{IBodyProducer}.
"""
self.assertTrue(verifyObject(
IBodyProducer, FileBodyProducer(StringIO(""))))
def test_unknownLength(self):
"""
If the L{FileBodyProducer} is constructed with a file-like object
without either a C{seek} or C{tell} method, its C{length} attribute is
set to C{UNKNOWN_LENGTH}.
"""
class HasSeek(object):
def seek(self, offset, whence):
pass
class HasTell(object):
def tell(self):
pass
producer = FileBodyProducer(HasSeek())
self.assertEqual(UNKNOWN_LENGTH, producer.length)
producer = FileBodyProducer(HasTell())
self.assertEqual(UNKNOWN_LENGTH, producer.length)
def test_knownLength(self):
"""
If the L{FileBodyProducer} is constructed with a file-like object with
both C{seek} and C{tell} methods, its C{length} attribute is set to the
size of the file as determined by those methods.
"""
inputBytes = "here are some bytes"
inputFile = StringIO(inputBytes)
inputFile.seek(5)
producer = FileBodyProducer(inputFile)
self.assertEqual(len(inputBytes) - 5, producer.length)
self.assertEqual(inputFile.tell(), 5)
def test_defaultCooperator(self):
"""
If no L{Cooperator} instance is passed to L{FileBodyProducer}, the
global cooperator is used.
"""
producer = FileBodyProducer(StringIO(""))
self.assertEqual(task.cooperate, producer._cooperate)
def test_startProducing(self):
"""
L{FileBodyProducer.startProducing} starts writing bytes from the input
file to the given L{IConsumer} and returns a L{Deferred} which fires
when they have all been written.
"""
expectedResult = "hello, world"
readSize = 3
output = StringIO()
consumer = FileConsumer(output)
producer = FileBodyProducer(
StringIO(expectedResult), self.cooperator, readSize)
complete = producer.startProducing(consumer)
for i in range(len(expectedResult) / readSize + 1):
self._scheduled.pop(0)()
self.assertEqual([], self._scheduled)
self.assertEqual(expectedResult, output.getvalue())
self.assertEqual(None, self._resultNow(complete))
def test_inputClosedAtEOF(self):
"""
When L{FileBodyProducer} reaches end-of-file on the input file given to
it, the input file is closed.
"""
readSize = 4
inputBytes = "some friendly bytes"
inputFile = StringIO(inputBytes)
producer = FileBodyProducer(inputFile, self.cooperator, readSize)
consumer = FileConsumer(StringIO())
producer.startProducing(consumer)
for i in range(len(inputBytes) / readSize + 2):
self._scheduled.pop(0)()
self.assertTrue(inputFile.closed)
def test_failedReadWhileProducing(self):
"""
If a read from the input file fails while producing bytes to the
consumer, the L{Deferred} returned by
L{FileBodyProducer.startProducing} fires with a L{Failure} wrapping
that exception.
"""
class BrokenFile(object):
def read(self, count):
raise IOError("Simulated bad thing")
producer = FileBodyProducer(BrokenFile(), self.cooperator)
complete = producer.startProducing(FileConsumer(StringIO()))
self._scheduled.pop(0)()
self._failureNow(complete).trap(IOError)
def test_stopProducing(self):
"""
L{FileBodyProducer.stopProducing} stops the underlying L{IPullProducer}
and the cooperative task responsible for calling C{resumeProducing} and
closes the input file but does not cause the L{Deferred} returned by
C{startProducing} to fire.
"""
expectedResult = "hello, world"
readSize = 3
output = StringIO()
consumer = FileConsumer(output)
inputFile = StringIO(expectedResult)
producer = FileBodyProducer(
inputFile, self.cooperator, readSize)
complete = producer.startProducing(consumer)
producer.stopProducing()
self.assertTrue(inputFile.closed)
self._scheduled.pop(0)()
self.assertEqual("", output.getvalue())
self.assertIdentical(self._NO_RESULT, self._resultNow(complete))
def test_pauseProducing(self):
"""
L{FileBodyProducer.pauseProducing} temporarily suspends writing bytes
from the input file to the given L{IConsumer}.
"""
expectedResult = "hello, world"
readSize = 5
output = StringIO()
consumer = FileConsumer(output)
producer = FileBodyProducer(
StringIO(expectedResult), self.cooperator, readSize)
complete = producer.startProducing(consumer)
self._scheduled.pop(0)()
self.assertEqual(output.getvalue(), expectedResult[:5])
producer.pauseProducing()
# Sort of depends on an implementation detail of Cooperator: even
# though the only task is paused, there's still a scheduled call. If
# this were to go away because Cooperator became smart enough to cancel
# this call in this case, that would be fine.
self._scheduled.pop(0)()
# Since the producer is paused, no new data should be here.
self.assertEqual(output.getvalue(), expectedResult[:5])
self.assertEqual([], self._scheduled)
self.assertIdentical(self._NO_RESULT, self._resultNow(complete))
def test_resumeProducing(self):
"""
L{FileBodyProducer.resumeProducing} re-commences writing bytes from the
input file to the given L{IConsumer} after it was previously paused
with L{FileBodyProducer.pauseProducing}.
"""
expectedResult = "hello, world"
readSize = 5
output = StringIO()
consumer = FileConsumer(output)
producer = FileBodyProducer(
StringIO(expectedResult), self.cooperator, readSize)
producer.startProducing(consumer)
self._scheduled.pop(0)()
self.assertEqual(expectedResult[:readSize], output.getvalue())
producer.pauseProducing()
producer.resumeProducing()
self._scheduled.pop(0)()
self.assertEqual(expectedResult[:readSize * 2], output.getvalue())
class FakeReactorAndConnectMixin:
"""
A test mixin providing a testable C{Reactor} class and a dummy
C{Agent._connect} method.
"""
class Reactor(MemoryReactor, Clock):
def __init__(self):
MemoryReactor.__init__(self)
Clock.__init__(self)
def _dummyConnect(self, scheme, host, port):
"""
Fake implementation of L{Agent._connect} which synchronously
succeeds with an instance of L{StubHTTPProtocol} for ease of
testing.
"""
protocol = StubHTTPProtocol()
protocol.makeConnection(None)
self.protocol = protocol
return succeed(protocol)
class AgentTests(unittest.TestCase, FakeReactorAndConnectMixin):
"""
Tests for the new HTTP client API provided by L{Agent}.
"""
def setUp(self):
"""
Create an L{Agent} wrapped around a fake reactor.
"""
self.reactor = self.Reactor()
self.agent = client.Agent(self.reactor)
def completeConnection(self):
"""
Do whitebox stuff to finish any outstanding connection attempts the
agent may have initiated.
This spins the fake reactor clock just enough to get L{ClientCreator},
which agent is implemented in terms of, to fire its Deferreds.
"""
self.reactor.advance(0)
def test_unsupportedScheme(self):
"""
L{Agent.request} returns a L{Deferred} which fails with
L{SchemeNotSupported} if the scheme of the URI passed to it is not
C{'http'}.
"""
return self.assertFailure(
self.agent.request('GET', 'mailto:alice@example.com'),
SchemeNotSupported)
def test_connectionFailed(self):
"""
The L{Deferred} returned by L{Agent.request} fires with a L{Failure} if
the TCP connection attempt fails.
"""
result = self.agent.request('GET', 'http://foo/')
# Cause the connection to be refused
host, port, factory = self.reactor.tcpClients.pop()[:3]
factory.clientConnectionFailed(None, Failure(ConnectionRefusedError()))
self.completeConnection()
return self.assertFailure(result, ConnectionRefusedError)
def test_connectHTTP(self):
"""
L{Agent._connect} uses C{connectTCP} to set up a connection to
a server when passed a scheme of C{'http'} and returns a
L{Deferred} which fires (when that connection is established)
with the protocol associated with that connection.
"""
expectedHost = 'example.com'
expectedPort = 1234
d = self.agent._connect('http', expectedHost, expectedPort)
host, port, factory = self.reactor.tcpClients.pop()[:3]
self.assertEqual(host, expectedHost)
self.assertEqual(port, expectedPort)
protocol = factory.buildProtocol(IPv4Address('TCP', '10.0.0.1', port))
self.assertIsInstance(protocol, HTTP11ClientProtocol)
self.completeConnection()
d.addCallback(self.assertIdentical, protocol)
return d
def test_connectHTTPS(self):
"""
L{Agent._connect} uses C{connectSSL} to set up a connection to
a server when passed a scheme of C{'https'} and returns a
L{Deferred} which fires (when that connection is established)
with the protocol associated with that connection.
"""
expectedHost = 'example.com'
expectedPort = 4321
d = self.agent._connect('https', expectedHost, expectedPort)
host, port, factory, contextFactory = self.reactor.sslClients.pop()[:4]
self.assertEqual(host, expectedHost)
self.assertEqual(port, expectedPort)
context = contextFactory.getContext()
# This is a pretty weak assertion. It's true that the context must be
# an instance of OpenSSL.SSL.Context, Unfortunately these are pretty
# opaque and there's not much more than checking its type that we could
# do here. It would be nice if the SSL APIs involved more testable (ie,
# inspectable) objects.
self.assertIsInstance(context, ContextType)
protocol = factory.buildProtocol(IPv4Address('TCP', '10.0.0.1', port))
self.assertIsInstance(protocol, HTTP11ClientProtocol)
self.completeConnection()
d.addCallback(self.assertIdentical, protocol)
return d
if ssl is None:
test_connectHTTPS.skip = "OpenSSL not present"
def test_connectHTTPSCustomContextFactory(self):
"""
If a context factory is passed to L{Agent.__init__} it will be used to
determine the SSL parameters for HTTPS requests. When an HTTPS request
is made, the hostname and port number of the request URL will be passed
to the context factory's C{getContext} method. The resulting context
object will be used to establish the SSL connection.
"""
expectedHost = 'example.org'
expectedPort = 20443
expectedContext = object()
contextArgs = []
class StubWebContextFactory(object):
def getContext(self, hostname, port):
contextArgs.append((hostname, port))
return expectedContext
agent = client.Agent(self.reactor, StubWebContextFactory())
d = agent._connect('https', expectedHost, expectedPort)
host, port, factory, contextFactory = self.reactor.sslClients.pop()[:4]
context = contextFactory.getContext()
self.assertEqual(context, expectedContext)
self.assertEqual(contextArgs, [(expectedHost, expectedPort)])
protocol = factory.buildProtocol(IPv4Address('TCP', '10.0.0.1', port))
self.assertIsInstance(protocol, HTTP11ClientProtocol)
self.completeConnection()
d.addCallback(self.assertIdentical, protocol)
return d
def test_request(self):
"""
L{Agent.request} establishes a new connection to the host indicated by
the host part of the URI passed to it and issues a request using the
method, the path portion of the URI, the headers, and the body producer
passed to it. It returns a L{Deferred} which fires with an
L{IResponse} from the server.
"""
self.agent._connect = self._dummyConnect
headers = http_headers.Headers({'foo': ['bar']})
# Just going to check the body for identity, so it doesn't need to be
# real.
body = object()
self.agent.request(
'GET', 'http://example.com:1234/foo?bar', headers, body)
protocol = self.protocol
# The request should be issued.
self.assertEqual(len(protocol.requests), 1)
req, res = protocol.requests.pop()
self.assertIsInstance(req, Request)
self.assertEqual(req.method, 'GET')
self.assertEqual(req.uri, '/foo?bar')
self.assertEqual(
req.headers,
http_headers.Headers({'foo': ['bar'],
'host': ['example.com:1234']}))
self.assertIdentical(req.bodyProducer, body)
def test_hostProvided(self):
"""
If C{None} is passed to L{Agent.request} for the C{headers}
parameter, a L{Headers} instance is created for the request and a
I{Host} header added to it.
"""
self.agent._connect = self._dummyConnect
self.agent.request('GET', 'http://example.com/foo')
protocol = self.protocol
# The request should have been issued with a host header based on
# the request URL.
self.assertEqual(len(protocol.requests), 1)
req, res = protocol.requests.pop()
self.assertEqual(req.headers.getRawHeaders('host'), ['example.com'])
def test_hostOverride(self):
"""
If the headers passed to L{Agent.request} includes a value for the
I{Host} header, that value takes precedence over the one which would
otherwise be automatically provided.
"""
self.agent._connect = self._dummyConnect
headers = http_headers.Headers({'foo': ['bar'], 'host': ['quux']})
body = object()
self.agent.request(
'GET', 'http://example.com/baz', headers, body)
protocol = self.protocol
# The request should have been issued with the host header specified
# above, not one based on the request URI.
self.assertEqual(len(protocol.requests), 1)
req, res = protocol.requests.pop()
self.assertEqual(req.headers.getRawHeaders('host'), ['quux'])
def test_headersUnmodified(self):
"""
If a I{Host} header must be added to the request, the L{Headers}
instance passed to L{Agent.request} is not modified.
"""
self.agent._connect = self._dummyConnect
headers = http_headers.Headers()
body = object()
self.agent.request(
'GET', 'http://example.com/foo', headers, body)
protocol = self.protocol
# The request should have been issued.
self.assertEqual(len(protocol.requests), 1)
# And the headers object passed in should not have changed.
self.assertEqual(headers, http_headers.Headers())
def test_hostValueStandardHTTP(self):
"""
When passed a scheme of C{'http'} and a port of C{80},
L{Agent._computeHostValue} returns a string giving just the
host name passed to it.
"""
self.assertEqual(
self.agent._computeHostValue('http', 'example.com', 80),
'example.com')
def test_hostValueNonStandardHTTP(self):
"""
When passed a scheme of C{'http'} and a port other than C{80},
L{Agent._computeHostValue} returns a string giving the host
passed to it joined together with the port number by C{":"}.
"""
self.assertEqual(
self.agent._computeHostValue('http', 'example.com', 54321),
'example.com:54321')
def test_hostValueStandardHTTPS(self):
"""
When passed a scheme of C{'https'} and a port of C{443},
L{Agent._computeHostValue} returns a string giving just the
host name passed to it.
"""
self.assertEqual(
self.agent._computeHostValue('https', 'example.com', 443),
'example.com')
def test_hostValueNonStandardHTTPS(self):
"""
When passed a scheme of C{'https'} and a port other than
C{443}, L{Agent._computeHostValue} returns a string giving the
host passed to it joined together with the port number by
C{":"}.
"""
self.assertEqual(
self.agent._computeHostValue('https', 'example.com', 54321),
'example.com:54321')
def test_connectTimeout(self):
"""
L{Agent} takes a C{connectTimeout} argument which is forwarded to the
following C{connectTCP} call.
"""
agent = client.Agent(self.reactor, connectTimeout=5)
agent.request('GET', 'http://foo/')
timeout = self.reactor.tcpClients.pop()[3]
self.assertEqual(5, timeout)
def test_connectSSLTimeout(self):
"""
L{Agent} takes a C{connectTimeout} argument which is forwarded to the
following C{connectSSL} call.
"""
agent = client.Agent(self.reactor, connectTimeout=5)
agent.request('GET', 'https://foo/')
timeout = self.reactor.sslClients.pop()[4]
self.assertEqual(5, timeout)
def test_bindAddress(self):
"""
L{Agent} takes a C{bindAddress} argument which is forwarded to the
following C{connectTCP} call.
"""
agent = client.Agent(self.reactor, bindAddress='192.168.0.1')
agent.request('GET', 'http://foo/')
address = self.reactor.tcpClients.pop()[4]
self.assertEqual('192.168.0.1', address)
def test_bindAddressSSL(self):
"""
L{Agent} takes a C{bindAddress} argument which is forwarded to the
following C{connectSSL} call.
"""
agent = client.Agent(self.reactor, bindAddress='192.168.0.1')
agent.request('GET', 'https://foo/')
address = self.reactor.sslClients.pop()[5]
self.assertEqual('192.168.0.1', address)
class CookieTestsMixin(object):
"""
Mixin for unit tests dealing with cookies.
"""
def addCookies(self, cookieJar, uri, cookies):
"""
Add a cookie to a cookie jar.
"""
response = client._FakeUrllib2Response(
client.Response(
('HTTP', 1, 1),
200,
'OK',
client.Headers({'Set-Cookie': cookies}),
None))
request = client._FakeUrllib2Request(uri)
cookieJar.extract_cookies(response, request)
return request, response
class CookieJarTests(unittest.TestCase, CookieTestsMixin):
"""
Tests for L{twisted.web.client._FakeUrllib2Response} and
L{twisted.web.client._FakeUrllib2Request}'s interactions with
C{cookielib.CookieJar} instances.
"""
def makeCookieJar(self):
"""
Create a C{cookielib.CookieJar} with some sample cookies.
"""
cookieJar = cookielib.CookieJar()
reqres = self.addCookies(
cookieJar,
'http://example.com:1234/foo?bar',
['foo=1; cow=moo; Path=/foo; Comment=hello',
'bar=2; Comment=goodbye'])
return cookieJar, reqres
def test_extractCookies(self):
"""
L{cookielib.CookieJar.extract_cookies} extracts cookie information from
fake urllib2 response instances.
"""
jar = self.makeCookieJar()[0]
cookies = dict([(c.name, c) for c in jar])
cookie = cookies['foo']
self.assertEqual(cookie.version, 0)
self.assertEqual(cookie.name, 'foo')
self.assertEqual(cookie.value, '1')
self.assertEqual(cookie.path, '/foo')
self.assertEqual(cookie.comment, 'hello')
self.assertEqual(cookie.get_nonstandard_attr('cow'), 'moo')
cookie = cookies['bar']
self.assertEqual(cookie.version, 0)
self.assertEqual(cookie.name, 'bar')
self.assertEqual(cookie.value, '2')
self.assertEqual(cookie.path, '/')
self.assertEqual(cookie.comment, 'goodbye')
self.assertIdentical(cookie.get_nonstandard_attr('cow'), None)
def test_sendCookie(self):
"""
L{cookielib.CookieJar.add_cookie_header} adds a cookie header to a fake
urllib2 request instance.
"""
jar, (request, response) = self.makeCookieJar()
self.assertIdentical(
request.get_header('Cookie', None),
None)
jar.add_cookie_header(request)
self.assertEqual(
request.get_header('Cookie', None),
'foo=1; bar=2')
class CookieAgentTests(unittest.TestCase, CookieTestsMixin,
FakeReactorAndConnectMixin):
"""
Tests for L{twisted.web.client.CookieAgent}.
"""
def setUp(self):
self.reactor = self.Reactor()
def test_emptyCookieJarRequest(self):
"""
L{CookieAgent.request} does not insert any C{'Cookie'} header into the
L{Request} object if there is no cookie in the cookie jar for the URI
being requested. Cookies are extracted from the response and stored in
the cookie jar.
"""
cookieJar = cookielib.CookieJar()
self.assertEqual(list(cookieJar), [])
agent = client.Agent(self.reactor)
agent._connect = self._dummyConnect
cookieAgent = client.CookieAgent(agent, cookieJar)
d = cookieAgent.request(
'GET', 'http://example.com:1234/foo?bar')
def _checkCookie(ignored):
cookies = list(cookieJar)
self.assertEqual(len(cookies), 1)
self.assertEqual(cookies[0].name, 'foo')
self.assertEqual(cookies[0].value, '1')
d.addCallback(_checkCookie)
req, res = self.protocol.requests.pop()
self.assertIdentical(req.headers.getRawHeaders('cookie'), None)
resp = client.Response(
('HTTP', 1, 1),
200,
'OK',
client.Headers({'Set-Cookie': ['foo=1',]}),
None)
res.callback(resp)
return d
def test_requestWithCookie(self):
"""
L{CookieAgent.request} inserts a C{'Cookie'} header into the L{Request}
object when there is a cookie matching the request URI in the cookie
jar.
"""
uri = 'http://example.com:1234/foo?bar'
cookie = 'foo=1'
cookieJar = cookielib.CookieJar()
self.addCookies(cookieJar, uri, [cookie])
self.assertEqual(len(list(cookieJar)), 1)
agent = client.Agent(self.reactor)
agent._connect = self._dummyConnect
cookieAgent = client.CookieAgent(agent, cookieJar)
cookieAgent.request('GET', uri)
req, res = self.protocol.requests.pop()
self.assertEqual(req.headers.getRawHeaders('cookie'), [cookie])
def test_secureCookie(self):
"""
L{CookieAgent} is able to handle secure cookies, ie cookies which
should only be handled over https.
"""
uri = 'https://example.com:1234/foo?bar'
cookie = 'foo=1;secure'
cookieJar = cookielib.CookieJar()
self.addCookies(cookieJar, uri, [cookie])
self.assertEqual(len(list(cookieJar)), 1)
agent = client.Agent(self.reactor)
agent._connect = self._dummyConnect
cookieAgent = client.CookieAgent(agent, cookieJar)
cookieAgent.request('GET', uri)
req, res = self.protocol.requests.pop()
self.assertEqual(req.headers.getRawHeaders('cookie'), ['foo=1'])
def test_secureCookieOnInsecureConnection(self):
"""
If a cookie is setup as secure, it won't be sent with the request if
it's not over HTTPS.
"""
uri = 'http://example.com/foo?bar'
cookie = 'foo=1;secure'
cookieJar = cookielib.CookieJar()
self.addCookies(cookieJar, uri, [cookie])
self.assertEqual(len(list(cookieJar)), 1)
agent = client.Agent(self.reactor)
agent._connect = self._dummyConnect
cookieAgent = client.CookieAgent(agent, cookieJar)
cookieAgent.request('GET', uri)
req, res = self.protocol.requests.pop()
self.assertIdentical(None, req.headers.getRawHeaders('cookie'))
def test_portCookie(self):
"""
L{CookieAgent} supports cookies which enforces the port number they
need to be transferred upon.
"""
uri = 'https://example.com:1234/foo?bar'
cookie = 'foo=1;port=1234'
cookieJar = cookielib.CookieJar()
self.addCookies(cookieJar, uri, [cookie])
self.assertEqual(len(list(cookieJar)), 1)
agent = client.Agent(self.reactor)
agent._connect = self._dummyConnect
cookieAgent = client.CookieAgent(agent, cookieJar)
cookieAgent.request('GET', uri)
req, res = self.protocol.requests.pop()
self.assertEqual(req.headers.getRawHeaders('cookie'), ['foo=1'])
def test_portCookieOnWrongPort(self):
"""
When creating a cookie with a port directive, it won't be added to the
L{cookie.CookieJar} if the URI is on a different port.
"""
uri = 'https://example.com:4567/foo?bar'
cookie = 'foo=1;port=1234'
cookieJar = cookielib.CookieJar()
self.addCookies(cookieJar, uri, [cookie])
self.assertEqual(len(list(cookieJar)), 0)
class Decoder1(proxyForInterface(IResponse)):
"""
A test decoder to be used by L{client.ContentDecoderAgent} tests.
"""
class Decoder2(Decoder1):
"""
A test decoder to be used by L{client.ContentDecoderAgent} tests.
"""
class ContentDecoderAgentTests(unittest.TestCase, FakeReactorAndConnectMixin):
"""
Tests for L{client.ContentDecoderAgent}.
"""
def setUp(self):
"""
Create an L{Agent} wrapped around a fake reactor.
"""
self.reactor = self.Reactor()
self.agent = client.Agent(self.reactor)
self.agent._connect = self._dummyConnect
def test_acceptHeaders(self):
"""
L{client.ContentDecoderAgent} sets the I{Accept-Encoding} header to the
names of the available decoder objects.
"""
agent = client.ContentDecoderAgent(
self.agent, [('decoder1', Decoder1), ('decoder2', Decoder2)])
agent.request('GET', 'http://example.com/foo')
protocol = self.protocol
self.assertEqual(len(protocol.requests), 1)
req, res = protocol.requests.pop()
self.assertEqual(req.headers.getRawHeaders('accept-encoding'),
['decoder1,decoder2'])
def test_existingHeaders(self):
"""
If there are existing I{Accept-Encoding} fields,
L{client.ContentDecoderAgent} creates a new field for the decoders it
knows about.
"""
headers = http_headers.Headers({'foo': ['bar'],
'accept-encoding': ['fizz']})
agent = client.ContentDecoderAgent(
self.agent, [('decoder1', Decoder1), ('decoder2', Decoder2)])
agent.request('GET', 'http://example.com/foo', headers=headers)
protocol = self.protocol
self.assertEqual(len(protocol.requests), 1)
req, res = protocol.requests.pop()
self.assertEqual(
list(req.headers.getAllRawHeaders()),
[('Host', ['example.com']),
('Foo', ['bar']),
('Accept-Encoding', ['fizz', 'decoder1,decoder2'])])
def test_plainEncodingResponse(self):
"""
If the response is not encoded despited the request I{Accept-Encoding}
headers, L{client.ContentDecoderAgent} simply forwards the response.
"""
agent = client.ContentDecoderAgent(
self.agent, [('decoder1', Decoder1), ('decoder2', Decoder2)])
deferred = agent.request('GET', 'http://example.com/foo')
req, res = self.protocol.requests.pop()
response = Response(('HTTP', 1, 1), 200, 'OK', http_headers.Headers(),
None)
res.callback(response)
return deferred.addCallback(self.assertIdentical, response)
def test_unsupportedEncoding(self):
"""
If an encoding unknown to the L{client.ContentDecoderAgent} is found,
the response is unchanged.
"""
agent = client.ContentDecoderAgent(
self.agent, [('decoder1', Decoder1), ('decoder2', Decoder2)])
deferred = agent.request('GET', 'http://example.com/foo')
req, res = self.protocol.requests.pop()
headers = http_headers.Headers({'foo': ['bar'],
'content-encoding': ['fizz']})
response = Response(('HTTP', 1, 1), 200, 'OK', headers, None)
res.callback(response)
return deferred.addCallback(self.assertIdentical, response)
def test_unknownEncoding(self):
"""
When L{client.ContentDecoderAgent} encounters a decoder it doesn't know
about, it stops decoding even if another encoding is known afterwards.
"""
agent = client.ContentDecoderAgent(
self.agent, [('decoder1', Decoder1), ('decoder2', Decoder2)])
deferred = agent.request('GET', 'http://example.com/foo')
req, res = self.protocol.requests.pop()
headers = http_headers.Headers({'foo': ['bar'],
'content-encoding':
['decoder1,fizz,decoder2']})
response = Response(('HTTP', 1, 1), 200, 'OK', headers, None)
res.callback(response)
def check(result):
self.assertNotIdentical(response, result)
self.assertIsInstance(result, Decoder2)
self.assertEqual(['decoder1,fizz'],
result.headers.getRawHeaders('content-encoding'))
return deferred.addCallback(check)
class SimpleAgentProtocol(Protocol):
"""
A L{Protocol} to be used with an L{client.Agent} to receive data.
@ivar finished: L{Deferred} firing when C{connectionLost} is called.
@ivar made: L{Deferred} firing when C{connectionMade} is called.
@ivar received: C{list} of received data.
"""
def __init__(self):
self.made = Deferred()
self.finished = Deferred()
self.received = []
def connectionMade(self):
self.made.callback(None)
def connectionLost(self, reason):
self.finished.callback(None)
def dataReceived(self, data):
self.received.append(data)
class ContentDecoderAgentWithGzipTests(unittest.TestCase,
FakeReactorAndConnectMixin):
def setUp(self):
"""
Create an L{Agent} wrapped around a fake reactor.
"""
self.reactor = self.Reactor()
agent = client.Agent(self.reactor)
agent._connect = self._dummyConnect
self.agent = client.ContentDecoderAgent(
agent, [("gzip", client.GzipDecoder)])
def test_gzipEncodingResponse(self):
"""
If the response has a C{gzip} I{Content-Encoding} header,
L{GzipDecoder} wraps the response to return uncompressed data to the
user.
"""
deferred = self.agent.request('GET', 'http://example.com/foo')
req, res = self.protocol.requests.pop()
headers = http_headers.Headers({'foo': ['bar'],
'content-encoding': ['gzip']})
transport = StringTransport()
response = Response(('HTTP', 1, 1), 200, 'OK', headers, transport)
response.length = 12
res.callback(response)
compressor = zlib.compressobj(2, zlib.DEFLATED, 16 + zlib.MAX_WBITS)
data = (compressor.compress('x' * 6) + compressor.compress('y' * 4) +
compressor.flush())
def checkResponse(result):
self.assertNotIdentical(result, response)
self.assertEqual(result.version, ('HTTP', 1, 1))
self.assertEqual(result.code, 200)
self.assertEqual(result.phrase, 'OK')
self.assertEqual(list(result.headers.getAllRawHeaders()),
[('Foo', ['bar'])])
self.assertEqual(result.length, UNKNOWN_LENGTH)
self.assertRaises(AttributeError, getattr, result, 'unknown')
response._bodyDataReceived(data[:5])
response._bodyDataReceived(data[5:])
response._bodyDataFinished()
protocol = SimpleAgentProtocol()
result.deliverBody(protocol)
self.assertEqual(protocol.received, ['x' * 6 + 'y' * 4])
return defer.gatherResults([protocol.made, protocol.finished])
deferred.addCallback(checkResponse)
return deferred
def test_brokenContent(self):
"""
If the data received by the L{GzipDecoder} isn't valid gzip-compressed
data, the call to C{deliverBody} fails with a C{zlib.error}.
"""
deferred = self.agent.request('GET', 'http://example.com/foo')
req, res = self.protocol.requests.pop()
headers = http_headers.Headers({'foo': ['bar'],
'content-encoding': ['gzip']})
transport = StringTransport()
response = Response(('HTTP', 1, 1), 200, 'OK', headers, transport)
response.length = 12
res.callback(response)
data = "not gzipped content"
def checkResponse(result):
response._bodyDataReceived(data)
result.deliverBody(Protocol())
deferred.addCallback(checkResponse)
self.assertFailure(deferred, client.ResponseFailed)
def checkFailure(error):
error.reasons[0].trap(zlib.error)
self.assertIsInstance(error.response, Response)
return deferred.addCallback(checkFailure)
def test_flushData(self):
"""
When the connection with the server is lost, the gzip protocol calls
C{flush} on the zlib decompressor object to get uncompressed data which
may have been buffered.
"""
class decompressobj(object):
def __init__(self, wbits):
pass
def decompress(self, data):
return 'x'
def flush(self):
return 'y'
oldDecompressObj = zlib.decompressobj
zlib.decompressobj = decompressobj
self.addCleanup(setattr, zlib, 'decompressobj', oldDecompressObj)
deferred = self.agent.request('GET', 'http://example.com/foo')
req, res = self.protocol.requests.pop()
headers = http_headers.Headers({'content-encoding': ['gzip']})
transport = StringTransport()
response = Response(('HTTP', 1, 1), 200, 'OK', headers, transport)
res.callback(response)
def checkResponse(result):
response._bodyDataReceived('data')
response._bodyDataFinished()
protocol = SimpleAgentProtocol()
result.deliverBody(protocol)
self.assertEqual(protocol.received, ['x', 'y'])
return defer.gatherResults([protocol.made, protocol.finished])
deferred.addCallback(checkResponse)
return deferred
def test_flushError(self):
"""
If the C{flush} call in C{connectionLost} fails, the C{zlib.error}
exception is caught and turned into a L{ResponseFailed}.
"""
class decompressobj(object):
def __init__(self, wbits):
pass
def decompress(self, data):
return 'x'
def flush(self):
raise zlib.error()
oldDecompressObj = zlib.decompressobj
zlib.decompressobj = decompressobj
self.addCleanup(setattr, zlib, 'decompressobj', oldDecompressObj)
deferred = self.agent.request('GET', 'http://example.com/foo')
req, res = self.protocol.requests.pop()
headers = http_headers.Headers({'content-encoding': ['gzip']})
transport = StringTransport()
response = Response(('HTTP', 1, 1), 200, 'OK', headers, transport)
res.callback(response)
def checkResponse(result):
response._bodyDataReceived('data')
response._bodyDataFinished()
protocol = SimpleAgentProtocol()
result.deliverBody(protocol)
self.assertEqual(protocol.received, ['x', 'y'])
return defer.gatherResults([protocol.made, protocol.finished])
deferred.addCallback(checkResponse)
self.assertFailure(deferred, client.ResponseFailed)
def checkFailure(error):
error.reasons[1].trap(zlib.error)
self.assertIsInstance(error.response, Response)
return deferred.addCallback(checkFailure)
class ProxyAgentTests(unittest.TestCase, FakeReactorAndConnectMixin):
"""
Tests for L{client.ProxyAgent}.
"""
def setUp(self):
self.reactor = self.Reactor()
self.agent = client.ProxyAgent(
TCP4ClientEndpoint(self.reactor, "bar", 5678))
self._oldConnect = self.agent._connect
self.agent._connect = self._dummyConnect
def _dummyConnect(self, scheme, host, port):
self._oldConnect(scheme, host, port)
return FakeReactorAndConnectMixin._dummyConnect(
self, scheme, host, port)
def test_proxyRequest(self):
"""
L{client.ProxyAgent} issues an HTTP request against the proxy, with the
full URI as path, when C{request} is called.
"""
headers = http_headers.Headers({'foo': ['bar']})
# Just going to check the body for identity, so it doesn't need to be
# real.
body = object()
self.agent.request(
'GET', 'http://example.com:1234/foo?bar', headers, body)
host, port, factory = self.reactor.tcpClients.pop()[:3]
self.assertEqual(host, "bar")
self.assertEqual(port, 5678)
self.assertIsInstance(factory._wrappedFactory,
client._HTTP11ClientFactory)
protocol = self.protocol
# The request should be issued.
self.assertEqual(len(protocol.requests), 1)
req, res = protocol.requests.pop()
self.assertIsInstance(req, Request)
self.assertEqual(req.method, 'GET')
self.assertEqual(req.uri, 'http://example.com:1234/foo?bar')
self.assertEqual(
req.headers,
http_headers.Headers({'foo': ['bar'],
'host': ['example.com:1234']}))
self.assertIdentical(req.bodyProducer, body)
class RedirectAgentTests(unittest.TestCase, FakeReactorAndConnectMixin):
"""
Tests for L{client.RedirectAgent}.
"""
def setUp(self):
self.reactor = self.Reactor()
agent = client.Agent(self.reactor)
self._oldConnect = agent._connect
agent._connect = self._dummyConnect
self.agent = client.RedirectAgent(agent)
def _dummyConnect(self, scheme, host, port):
self._oldConnect(scheme, host, port)
return FakeReactorAndConnectMixin._dummyConnect(
self, scheme, host, port)
def test_noRedirect(self):
"""
L{client.RedirectAgent} behaves like L{client.Agent} if the response
doesn't contain a redirect.
"""
deferred = self.agent.request('GET', 'http://example.com/foo')
req, res = self.protocol.requests.pop()
headers = http_headers.Headers()
response = Response(('HTTP', 1, 1), 200, 'OK', headers, None)
res.callback(response)
self.assertEqual(0, len(self.protocol.requests))
def checkResponse(result):
self.assertIdentical(result, response)
return deferred.addCallback(checkResponse)
def _testRedirectDefault(self, code):
"""
When getting a redirect, L{RedirectAgent} follows the URL specified in
the L{Location} header field and make a new request.
"""
self.agent.request('GET', 'http://example.com/foo')
host, port = self.reactor.tcpClients.pop()[:2]
self.assertEqual("example.com", host)
self.assertEqual(80, port)
req, res = self.protocol.requests.pop()
headers = http_headers.Headers(
{'location': ['https://example.com/bar']})
response = Response(('HTTP', 1, 1), code, 'OK', headers, None)
res.callback(response)
req2, res2 = self.protocol.requests.pop()
self.assertEqual('GET', req2.method)
self.assertEqual('/bar', req2.uri)
host, port = self.reactor.sslClients.pop()[:2]
self.assertEqual("example.com", host)
self.assertEqual(443, port)
def test_redirect301(self):
"""
L{RedirectAgent} follows redirects on status code 301.
"""
self._testRedirectDefault(301)
def test_redirect302(self):
"""
L{RedirectAgent} follows redirects on status code 302.
"""
self._testRedirectDefault(302)
def test_redirect307(self):
"""
L{RedirectAgent} follows redirects on status code 307.
"""
self._testRedirectDefault(307)
def test_redirect303(self):
"""
L{RedirectAgent} changes the methods to C{GET} when getting a redirect
on a C{POST} request.
"""
self.agent.request('POST', 'http://example.com/foo')
req, res = self.protocol.requests.pop()
headers = http_headers.Headers(
{'location': ['http://example.com/bar']})
response = Response(('HTTP', 1, 1), 303, 'OK', headers, None)
res.callback(response)
req2, res2 = self.protocol.requests.pop()
self.assertEqual('GET', req2.method)
self.assertEqual('/bar', req2.uri)
def test_noLocationField(self):
"""
If no L{Location} header field is found when getting a redirect,
L{RedirectAgent} fails with a L{ResponseFailed} error wrapping a
L{error.RedirectWithNoLocation} exception.
"""
deferred = self.agent.request('GET', 'http://example.com/foo')
req, res = self.protocol.requests.pop()
headers = http_headers.Headers()
response = Response(('HTTP', 1, 1), 301, 'OK', headers, None)
res.callback(response)
self.assertFailure(deferred, client.ResponseFailed)
def checkFailure(fail):
fail.reasons[0].trap(error.RedirectWithNoLocation)
self.assertEqual('http://example.com/foo',
fail.reasons[0].value.uri)
self.assertEqual(301, fail.response.code)
return deferred.addCallback(checkFailure)
def test_307OnPost(self):
"""
When getting a 307 redirect on a C{POST} request, L{RedirectAgent} fais
with a L{ResponseFailed} error wrapping a L{error.PageRedirect}
exception.
"""
deferred = self.agent.request('POST', 'http://example.com/foo')
req, res = self.protocol.requests.pop()
headers = http_headers.Headers()
response = Response(('HTTP', 1, 1), 307, 'OK', headers, None)
res.callback(response)
self.assertFailure(deferred, client.ResponseFailed)
def checkFailure(fail):
fail.reasons[0].trap(error.PageRedirect)
self.assertEqual('http://example.com/foo',
fail.reasons[0].value.location)
self.assertEqual(307, fail.response.code)
return deferred.addCallback(checkFailure)
def test_redirectLimit(self):
"""
If the limit of redirects specified to L{RedirectAgent} is reached, the
deferred fires with L{ResponseFailed} error wrapping a
L{InfiniteRedirection} exception.
"""
agent = client.Agent(self.reactor)
self._oldConnect = agent._connect
agent._connect = self._dummyConnect
redirectAgent = client.RedirectAgent(agent, 1)
deferred = redirectAgent.request('GET', 'http://example.com/foo')
req, res = self.protocol.requests.pop()
headers = http_headers.Headers(
{'location': ['http://example.com/bar']})
response = Response(('HTTP', 1, 1), 302, 'OK', headers, None)
res.callback(response)
req2, res2 = self.protocol.requests.pop()
response2 = Response(('HTTP', 1, 1), 302, 'OK', headers, None)
res2.callback(response2)
self.assertFailure(deferred, client.ResponseFailed)
def checkFailure(fail):
fail.reasons[0].trap(error.InfiniteRedirection)
self.assertEqual('http://example.com/foo',
fail.reasons[0].value.location)
self.assertEqual(302, fail.response.code)
return deferred.addCallback(checkFailure)
if ssl is None or not hasattr(ssl, 'DefaultOpenSSLContextFactory'):
for case in [WebClientSSLTestCase, WebClientRedirectBetweenSSLandPlainText]:
case.skip = "OpenSSL not present"
if not interfaces.IReactorSSL(reactor, None):
for case in [WebClientSSLTestCase, WebClientRedirectBetweenSSLandPlainText]:
case.skip = "Reactor doesn't support SSL"
|