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 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646
|
# -*- coding: utf-8 -*-
# The MIT License (MIT)
# Copyright (c) 2022 Microsoft Corporation
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
"""End to end test.
"""
import json
import logging
import os.path
import unittest
import time
from typing import Mapping
import test_config
import urllib.parse as urllib
import uuid
import pytest
from azure.core import MatchConditions
from azure.core.exceptions import AzureError, ServiceResponseError
from azure.core.pipeline.transport import RequestsTransport, RequestsTransportResponse
import azure.cosmos.documents as documents
import azure.cosmos.exceptions as exceptions
from azure.cosmos.http_constants import HttpHeaders, StatusCodes
import azure.cosmos._base as base
from azure.cosmos.aio import CosmosClient, _retry_utility_async
from azure.cosmos.diagnostics import RecordDiagnostics
from azure.cosmos.partition_key import PartitionKey
import requests
from urllib3.util.retry import Retry
pytestmark = pytest.mark.cosmosEmulator
# IMPORTANT NOTES:
# Most test cases in this file create collections in your Azure Cosmos account.
# Collections are billing entities. By running these test cases, you may incur monetary costs on your account.
# To Run the test, replace the two member fields (masterKey and host) with values
# associated with your Azure Cosmos account.
class TimeoutTransport(RequestsTransport):
def __init__(self, response):
self._response = response
super(TimeoutTransport, self).__init__()
async def send(self, *args, **kwargs):
if kwargs.pop("passthrough", False):
return super(TimeoutTransport, self).send(*args, **kwargs)
time.sleep(5)
if isinstance(self._response, Exception):
raise self._response
output = requests.Response()
output.status_code = self._response
response = RequestsTransportResponse(None, output)
return response
@pytest.mark.usefixtures("teardown")
class CRUDTests(unittest.TestCase):
"""Python CRUD Tests.
"""
last_headers = []
async def __AssertHTTPFailureWithStatus(self, status_code, func, *args, **kwargs):
"""Assert HTTP failure with status.
:Parameters:
- `status_code`: int
- `func`: function
"""
try:
await func(*args, **kwargs)
self.assertFalse(True, 'function should fail.')
except exceptions.CosmosHttpResponseError as inst:
self.assertEqual(inst.status_code, status_code)
@classmethod
async def setUpClass(cls):
cls.client = CosmosClient(cls.host, cls.masterKey, consistency_level="Session", connection_policy=cls.connectionPolicy)
cls.databaseForTest = await cls.client.create_database_if_not_exists(test_config._test_config.TEST_DATABASE_ID)
async def test_database_crud(self):
# read databases.
databases = [database async for database in self.client.list_databases()]
# create a database.
before_create_databases_count = len(databases)
database_id = str(uuid.uuid4())
created_db = await self.client.create_database(database_id)
self.assertEqual(created_db.id, database_id)
# Read databases after creation.
databases = [database async for database in self.client.list_databases()]
self.assertEqual(len(databases),
before_create_databases_count + 1,
'create should increase the number of databases')
# query databases.
databases = [database async for database in self.client.query_databases(
query='SELECT * FROM root r WHERE r.id=@id',
parameters=[
{'name': '@id', 'value': database_id}
]
)]
self.assertTrue(len(databases) > 0)
# read database.
self.client.get_database_client(created_db.id)
# delete database.
await self.client.delete_database(created_db.id)
# read database after deletion
read_db = self.client.get_database_client(created_db.id)
await self.__AssertHTTPFailureWithStatus(StatusCodes.NOT_FOUND,
read_db.read)
database_proxy = await self.client.create_database_if_not_exists(id=database_id, offer_throughput=10000)
self.assertEqual(database_id, database_proxy.id)
self.assertEqual(10000, await database_proxy.get_throughput().offer_throughput)
database_proxy = await self.client.create_database_if_not_exists(id=database_id, offer_throughput=9000)
self.assertEqual(database_id, database_proxy.id)
self.assertEqual(10000, await database_proxy.get_throughput().offer_throughput)
await self.client.delete_database(database_id)
@pytest.mark.skip("skipping as the TestResources subscription doesn't support this offer")
async def test_database_level_offer_throughput(self):
# Create a database with throughput
offer_throughput = 1000
database_id = str(uuid.uuid4())
created_db = await self.client.create_database(
id=database_id,
offer_throughput=offer_throughput
)
self.assertEqual(created_db.id, database_id)
# Verify offer throughput for database
offer = await created_db.get_throughput()
self.assertEqual(offer.offer_throughput, offer_throughput)
# Update database offer throughput
new_offer_throughput = 2000
offer = await created_db.replace_throughput(new_offer_throughput)
self.assertEqual(offer.offer_throughput, new_offer_throughput)
await self.client.delete_database(created_db.id)
async def test_sql_query_crud(self):
# create two databases.
db1 = await self.client.create_database('database 1' + str(uuid.uuid4()))
db2 = await self.client.create_database('database 2' + str(uuid.uuid4()))
# query with parameters.
databases = [database async for database in self.client.query_databases(
query='SELECT * FROM root r WHERE r.id=@id',
parameters=[
{'name': '@id', 'value': db1.id}
]
)]
self.assertEqual(1, len(databases), 'Unexpected number of query results.')
# query without parameters.
databases = [database async for database in self.client.query_databases(
query='SELECT * FROM root r WHERE r.id="database non-existing"'
)]
self.assertEqual(0, len(databases), 'Unexpected number of query results.')
# query with a string.
databases = [database async for database in
self.client.query_databases('SELECT * FROM root r WHERE r.id="' + db2.id + '"')] # nosec
self.assertEqual(1, len(databases), 'Unexpected number of query results.')
await self.client.delete_database(db1.id)
await self.client.delete_database(db2.id)
async def test_collection_crud(self):
created_db = self.databaseForTest
collections = [collection async for collection in created_db.list_containers()]
# create a collection
before_create_collections_count = len(collections)
collection_id = 'test_collection_crud ' + str(uuid.uuid4())
collection_indexing_policy = {'indexingMode': 'consistent'}
created_recorder = RecordDiagnostics()
created_collection = await created_db.create_container(id=collection_id,
indexing_policy=collection_indexing_policy,
partition_key=PartitionKey(path="/pk", kind="Hash"),
response_hook=created_recorder)
self.assertEqual(collection_id, created_collection.id)
assert isinstance(created_recorder.headers, Mapping)
assert 'Content-Type' in created_recorder.headers
assert isinstance(created_recorder.body, Mapping)
assert 'id' in created_recorder.body
created_properties = await created_collection.read()
self.assertEqual('consistent', created_properties['indexingPolicy']['indexingMode'])
# read collections after creation
collections = [collection async for collection in created_db.list_containers()]
self.assertEqual(len(collections),
before_create_collections_count + 1,
'create should increase the number of collections')
# query collections
collections = [collection async for collection in created_db.query_containers(
query='SELECT * FROM root r WHERE r.id=@id',
parameters=[
{'name': '@id', 'value': collection_id}
]
)]
self.assertTrue(collections)
# delete collection
await created_db.delete_container(created_collection.id)
# read collection after deletion
created_container = created_db.get_container_client(created_collection.id)
await self.__AssertHTTPFailureWithStatus(StatusCodes.NOT_FOUND,
created_container.read)
container_proxy = await created_db.create_container_if_not_exists(id=created_collection.id,
partition_key=PartitionKey(path='/id', kind='Hash'))
self.assertEqual(created_collection.id, container_proxy.id)
self.assertDictEqual(PartitionKey(path='/id', kind='Hash'), container_proxy._properties['partitionKey'])
container_proxy = await created_db.create_container_if_not_exists(id=created_collection.id,
partition_key=created_properties['partitionKey'])
self.assertEqual(created_container.id, container_proxy.id)
self.assertDictEqual(PartitionKey(path='/id', kind='Hash'), container_proxy._properties['partitionKey'])
await created_db.delete_container(created_collection.id)
async def test_partitioned_collection(self):
created_db = self.databaseForTest
collection_definition = {'id': 'test_partitioned_collection ' + str(uuid.uuid4()),
'partitionKey':
{
'paths': ['/id'],
'kind': documents.PartitionKind.Hash
}
}
offer_throughput = 10100
created_collection = await created_db.create_container(id=collection_definition['id'],
partition_key=collection_definition['partitionKey'],
offer_throughput=offer_throughput)
self.assertEqual(collection_definition.get('id'), created_collection.id)
created_collection_properties = await created_collection.read()
self.assertEqual(collection_definition.get('partitionKey').get('paths')[0],
created_collection_properties['partitionKey']['paths'][0])
self.assertEqual(collection_definition.get('partitionKey').get('kind'),
created_collection_properties['partitionKey']['kind'])
expected_offer = await created_collection.get_throughput()
self.assertIsNotNone(expected_offer)
self.assertEqual(expected_offer.offer_throughput, offer_throughput)
await created_db.delete_container(created_collection.id)
async def test_partitioned_collection_quota(self):
created_db = self.databaseForTest
created_collection = await self.databaseForTest.create_container(test_config._test_config.TEST_COLLECTION_MULTI_PARTITION)
retrieved_collection = created_db.get_container_client(
container=created_collection.id
)
retrieved_collection_properties = await retrieved_collection.read(
populate_partition_key_range_statistics=True,
populate_quota_info=True)
self.assertIsNotNone(retrieved_collection_properties.get("statistics"))
self.assertIsNotNone(created_db.client_connection.last_response_headers.get("x-ms-resource-usage"))
async def test_partitioned_collection_partition_key_extraction(self):
created_db = self.databaseForTest
collection_id = 'test_partitioned_collection_partition_key_extraction ' + str(uuid.uuid4())
created_collection = await created_db.create_container(
id=collection_id,
partition_key=PartitionKey(path='/address/state', kind=documents.PartitionKind.Hash)
)
document_definition = {'id': 'document1',
'address': {'street': '1 Microsoft Way',
'city': 'Redmond',
'state': 'WA',
'zip code': 98052
}
}
self.OriginalExecuteFunction = _retry_utility_async.ExecuteFunctionAsync
_retry_utility_async.ExecuteFunctionAsync = self._MockExecuteFunction
# create document without partition key being specified
created_document = await created_collection.create_item(body=document_definition)
_retry_utility_async.ExecuteFunctionAsync = self.OriginalExecuteFunction
self.assertEqual(self.last_headers[1], '["WA"]')
del self.last_headers[:]
self.assertEqual(created_document.get('id'), document_definition.get('id'))
self.assertEqual(created_document.get('address').get('state'), document_definition.get('address').get('state'))
collection_id = 'test_partitioned_collection_partition_key_extraction1 ' + str(uuid.uuid4())
created_collection1 = await created_db.create_container(
id=collection_id,
partition_key=PartitionKey(path='/address', kind=documents.PartitionKind.Hash)
)
self.OriginalExecuteFunction = _retry_utility_async.ExecuteFunctionAsync
_retry_utility_async.ExecuteFunctionAsync = self._MockExecuteFunction
# Create document with partitionkey not present as a leaf level property but a dict
created_document = await created_collection1.create_item(document_definition)
_retry_utility_async.ExecuteFunctionAsync = self.OriginalExecuteFunction
self.assertEqual(self.last_headers[1], [{}])
del self.last_headers[:]
collection_id = 'test_partitioned_collection_partition_key_extraction2 ' + str(uuid.uuid4())
created_collection2 = await created_db.create_container(
id=collection_id,
partition_key=PartitionKey(path='/address/state/city', kind=documents.PartitionKind.Hash)
)
self.OriginalExecuteFunction = _retry_utility_async.ExecuteFunctionAsync
_retry_utility_async.ExecuteFunctionAsync = self._MockExecuteFunction
# Create document with partitionkey not present in the document
created_document = await created_collection2.create_item(document_definition)
_retry_utility_async.ExecuteFunctionAsync = self.OriginalExecuteFunction
self.assertEqual(self.last_headers[1], [{}])
del self.last_headers[:]
# self.assertEqual(options['partitionKey'], documents.Undefined)
await created_db.delete_container(created_collection.id)
await created_db.delete_container(created_collection1.id)
await created_db.delete_container(created_collection2.id)
async def test_partitioned_collection_partition_key_extraction_special_chars(self):
created_db = self.databaseForTest
collection_id = 'test_partitioned_collection_partition_key_extraction_special_chars1 ' + str(uuid.uuid4())
created_collection1 = await created_db.create_container(
id=collection_id,
partition_key=PartitionKey(path='/\"level\' 1*()\"/\"le/vel2\"', kind=documents.PartitionKind.Hash)
)
document_definition = {'id': 'document1',
"level' 1*()": {"le/vel2": 'val1'}
}
self.OriginalExecuteFunction = _retry_utility_async.ExecuteFunctionAsync
_retry_utility_async.ExecuteFunctionAsync = self._MockExecuteFunction
created_document = await created_collection1.create_item(body=document_definition)
_retry_utility_async.ExecuteFunctionAsync = self.OriginalExecuteFunction
self.assertEqual(self.last_headers[1], '["val1"]')
del self.last_headers[:]
collection_id = 'test_partitioned_collection_partition_key_extraction_special_chars2 ' + str(uuid.uuid4())
created_collection2 = await created_db.create_container(
id=collection_id,
partition_key=PartitionKey(path='/\'level\" 1*()\'/\'le/vel2\'', kind=documents.PartitionKind.Hash)
)
document_definition = {'id': 'document2',
'level\" 1*()': {'le/vel2': 'val2'}
}
self.OriginalExecuteFunction = _retry_utility_async.ExecuteFunctionAsync
_retry_utility_async.ExecuteFunctionAsync = self._MockExecuteFunction
# create document without partition key being specified
created_document = await created_collection2.create_item(body=document_definition)
_retry_utility_async.ExecuteFunctionAsync = self.OriginalExecuteFunction
self.assertEqual(self.last_headers[1], '["val2"]')
del self.last_headers[:]
await created_db.delete_container(created_collection1.id)
await created_db.delete_container(created_collection2.id)
async def test_partitioned_collection_path_parser(self):
test_dir = os.path.dirname(os.path.abspath(__file__))
with open(os.path.join(test_dir, "BaselineTest.PathParser.json")) as json_file:
entries = json.loads(json_file.read())
for entry in entries:
parts = base.ParsePaths([entry['path']])
self.assertEqual(parts, entry['parts'])
paths = ["/\"Ke \\ \\\" \\\' \\? \\a \\\b \\\f \\\n \\\r \\\t \\v y1\"/*"]
parts = ["Ke \\ \\\" \\\' \\? \\a \\\b \\\f \\\n \\\r \\\t \\v y1", "*"]
self.assertEqual(parts, base.ParsePaths(paths))
paths = ["/'Ke \\ \\\" \\\' \\? \\a \\\b \\\f \\\n \\\r \\\t \\v y1'/*"]
parts = ["Ke \\ \\\" \\\' \\? \\a \\\b \\\f \\\n \\\r \\\t \\v y1", "*"]
self.assertEqual(parts, base.ParsePaths(paths))
async def test_partitioned_collection_document_crud_and_query(self):
created_db = self.databaseForTest
created_collection = await self.databaseForTest.create_container(test_config._test_config.TEST_COLLECTION_MULTI_PARTITION, PartitionKey(path="/id"))
document_definition = {'id': 'document',
'key': 'value'}
created_document = await created_collection.create_item(body=document_definition)
self.assertEqual(created_document.get('id'), document_definition.get('id'))
self.assertEqual(created_document.get('key'), document_definition.get('key'))
# read document
read_document = await created_collection.read_item(
item=created_document.get('id'),
partition_key=created_document.get('id')
)
self.assertEqual(read_document.get('id'), created_document.get('id'))
self.assertEqual(read_document.get('key'), created_document.get('key'))
# Read document feed doesn't require partitionKey as it's always a cross partition query
documentlist = [document async for document in created_collection.read_all_items()]
self.assertEqual(1, len(documentlist))
# replace document
document_definition['key'] = 'new value'
replaced_document = await created_collection.replace_item(
item=read_document,
body=document_definition
)
self.assertEqual(replaced_document.get('key'), document_definition.get('key'))
# upsert document(create scenario)
document_definition['id'] = 'document2'
document_definition['key'] = 'value2'
upserted_document = await created_collection.upsert_item(body=document_definition)
self.assertEqual(upserted_document.get('id'), document_definition.get('id'))
self.assertEqual(upserted_document.get('key'), document_definition.get('key'))
documentlist = [document async for document in created_collection.read_all_items()]
self.assertEqual(2, len(documentlist))
# delete document
await created_collection.delete_item(item=upserted_document, partition_key=upserted_document.get('id'))
# query document on the partition key specified in the predicate will pass even without setting enableCrossPartitionQuery or passing in the partitionKey value
documentlist = [document async for document in created_collection.query_items(
query='SELECT * FROM root r WHERE r.id=\'' + replaced_document.get('id') + '\'' # nosec
)]
self.assertEqual(1, len(documentlist))
# query document on any property other than partitionKey will fail without setting enableCrossPartitionQuery or passing in the partitionKey value
try:
[document async for document in created_collection.query_items(
query='SELECT * FROM root r WHERE r.key=\'' + replaced_document.get('key') + '\'' # nosec
)]
except Exception:
pass
# cross partition query
documentlist = [document async for document in created_collection.query_items(
query='SELECT * FROM root r WHERE r.key=\'' + replaced_document.get('key') + '\'', # nosec
enable_cross_partition_query=True
)]
self.assertEqual(1, len(documentlist))
# query document by providing the partitionKey value
documentlist = [document async for document in created_collection.query_items(
query='SELECT * FROM root r WHERE r.key=\'' + replaced_document.get('key') + '\'', # nosec
partition_key=replaced_document.get('id')
)]
self.assertEqual(1, len(documentlist))
async def test_partitioned_collection_permissions(self):
created_db = self.databaseForTest
collection_id = 'test_partitioned_collection_permissions all collection' + str(uuid.uuid4())
all_collection = await created_db.create_container(
id=collection_id,
partition_key=PartitionKey(path='/key', kind=documents.PartitionKind.Hash)
)
collection_id = 'test_partitioned_collection_permissions read collection' + str(uuid.uuid4())
read_collection = await created_db.create_container(
id=collection_id,
partition_key=PartitionKey(path='/key', kind=documents.PartitionKind.Hash)
)
user = await created_db.create_user(body={'id': 'user' + str(uuid.uuid4())})
permission_definition = {
'id': 'all permission',
'permissionMode': documents.PermissionMode.All,
'resource': all_collection.container_link,
'resourcePartitionKey': [1]
}
all_permission = await user.create_permission(body=permission_definition)
permission_definition = {
'id': 'read permission',
'permissionMode': documents.PermissionMode.Read,
'resource': read_collection.container_link,
'resourcePartitionKey': [1]
}
read_permission = await user.create_permission(body=permission_definition)
resource_tokens = {}
# storing the resource tokens based on Resource IDs
resource_tokens["dbs/" + created_db.id + "/colls/" + all_collection.id] = (all_permission.properties['_token'])
resource_tokens["dbs/" + created_db.id + "/colls/" + read_collection.id] = (read_permission.properties['_token'])
async with CosmosClient(
CRUDTests.host, resource_tokens, consistency_level="Session", connection_policy=CRUDTests.connectionPolicy) as restricted_client:
print('Async Initialization')
document_definition = {'id': 'document1',
'key': 1
}
all_collection.client_connection = restricted_client.client_connection
read_collection.client_connection = restricted_client.client_connection
# Create document in all_collection should succeed since the partitionKey is 1 which is what specified as resourcePartitionKey in permission object and it has all permissions
created_document = await all_collection.create_item(body=document_definition)
# Create document in read_collection should fail since it has only read permissions for this collection
await self.__AssertHTTPFailureWithStatus(
StatusCodes.FORBIDDEN,
read_collection.create_item,
document_definition)
document_definition['key'] = 2
# Create document should fail since the partitionKey is 2 which is different that what is specified as resourcePartitionKey in permission object
await self.__AssertHTTPFailureWithStatus(
StatusCodes.FORBIDDEN,
all_collection.create_item,
document_definition)
document_definition['key'] = 1
# Delete document should succeed since the partitionKey is 1 which is what specified as resourcePartitionKey in permission object
created_document = await all_collection.delete_item(item=created_document['id'],
partition_key=document_definition['key'])
# Delete document in read_collection should fail since it has only read permissions for this collection
await self.__AssertHTTPFailureWithStatus(
StatusCodes.FORBIDDEN,
read_collection.delete_item,
document_definition['id'],
document_definition['id']
)
await created_db.delete_container(all_collection)
await created_db.delete_container(read_collection)
async def test_partitioned_collection_execute_stored_procedure(self):
created_db = self.databaseForTest
created_collection = await self.databaseForTest.create_container(test_config._test_config.TEST_COLLECTION_MULTI_PARTITION_WITH_CUSTOM_PK_PARTITION_KEY, PartitionKey(path="/pk"))
sproc = {
'id': 'storedProcedure' + str(uuid.uuid4()),
'body': (
'function () {' +
' var client = getContext().getCollection();' +
' client.createDocument(client.getSelfLink(), { id: \'testDoc\', pk : 2}, {}, function(err, docCreated, options) { ' +
' if(err) throw new Error(\'Error while creating document: \' + err.message);' +
' else {' +
' getContext().getResponse().setBody(1);' +
' }' +
' });}')
}
created_sproc = await created_collection.scripts.create_stored_procedure(body=sproc)
# Partiton Key value same as what is specified in the stored procedure body
result = await created_collection.scripts.execute_stored_procedure(sproc=created_sproc['id'], partition_key=2)
self.assertEqual(result, 1)
# Partiton Key value different than what is specified in the stored procedure body will cause a bad request(400) error
await self.__AssertHTTPFailureWithStatus(
StatusCodes.BAD_REQUEST,
created_collection.scripts.execute_stored_procedure,
created_sproc['id'],
3)
async def test_partitioned_collection_partition_key_value_types(self):
created_db = self.databaseForTest
created_collection = await created_db.create_container(
id='test_partitioned_collection_partition_key_value_types ' + str(uuid.uuid4()),
partition_key=PartitionKey(path='/pk', kind='Hash')
)
document_definition = {'id': 'document1' + str(uuid.uuid4()),
'pk': None,
'spam': 'eggs'}
# create document with partitionKey set as None here
await created_collection.create_item(body=document_definition)
document_definition = {'id': 'document1' + str(uuid.uuid4()),
'spam': 'eggs'}
# create document with partitionKey set as Undefined here
await created_collection.create_item(body=document_definition)
document_definition = {'id': 'document1' + str(uuid.uuid4()),
'pk': True,
'spam': 'eggs'}
# create document with bool partitionKey
await created_collection.create_item(body=document_definition)
document_definition = {'id': 'document1' + str(uuid.uuid4()),
'pk': 'value',
'spam': 'eggs'}
# create document with string partitionKey
await created_collection.create_item(body=document_definition)
document_definition = {'id': 'document1' + str(uuid.uuid4()),
'pk': 100,
'spam': 'eggs'}
# create document with int partitionKey
await created_collection.create_item(body=document_definition)
document_definition = {'id': 'document1' + str(uuid.uuid4()),
'pk': 10.50,
'spam': 'eggs'}
# create document with float partitionKey
await created_collection.create_item(body=document_definition)
document_definition = {'name': 'sample document',
'spam': 'eggs',
'pk': 'value'}
# Should throw an error because automatic id generation is disabled always.
await self.__AssertHTTPFailureWithStatus(
StatusCodes.BAD_REQUEST,
created_collection.create_item,
document_definition
)
await created_db.delete_container(created_collection)
async def test_partitioned_collection_conflict_crud_and_query(self):
created_db = self.databaseForTest
created_collection = await self.databaseForTest.create_container(test_config._test_config.TEST_COLLECTION_MULTI_PARTITION)
conflict_definition = {'id': 'new conflict',
'resourceId': 'doc1',
'operationType': 'create',
'resourceType': 'document'
}
# read conflict here will return resource not found(404) since there is no conflict here
await self.__AssertHTTPFailureWithStatus(
StatusCodes.NOT_FOUND,
created_collection.read_conflict,
conflict_definition['id'],
conflict_definition['id']
)
# Read conflict feed doesn't requires partitionKey to be specified as it's a cross partition thing
conflictlist = [conflict async for conflict in created_collection.list_conflicts()]
self.assertEqual(0, len(conflictlist))
# delete conflict here will return resource not found(404) since there is no conflict here
await self.__AssertHTTPFailureWithStatus(
StatusCodes.NOT_FOUND,
created_collection.delete_conflict,
conflict_definition['id'],
conflict_definition['id']
)
# query conflicts on any property other than partitionKey will fail without setting enableCrossPartitionQuery or passing in the partitionKey value
try:
[conflict async for conflict in created_collection.query_conflicts(
query='SELECT * FROM root r WHERE r.resourceType=\'' + conflict_definition.get( # nosec
'resourceType') + '\''
)]
except Exception:
pass
conflictlist = [conflict async for conflict in created_collection.query_conflicts(
query='SELECT * FROM root r WHERE r.resourceType=\'' + conflict_definition.get('resourceType') + '\'',
# nosec
enable_cross_partition_query=True
)]
self.assertEqual(0, len(conflictlist))
# query conflicts by providing the partitionKey value
options = {'partitionKey': conflict_definition.get('id')}
conflictlist = [conflict async for conflict in created_collection.query_conflicts(
query='SELECT * FROM root r WHERE r.resourceType=\'' + conflict_definition.get('resourceType') + '\'',
# nosec
partition_key=conflict_definition['id']
)]
self.assertEqual(0, len(conflictlist))
async def test_document_crud(self):
# create database
created_db = self.databaseForTest
# create collection
created_collection = await self.databaseForTest.create_container(test_config._test_config.TEST_COLLECTION_MULTI_PARTITION)
# read documents
documents = [document async for document in created_collection.read_all_items()]
# create a document
before_create_documents_count = len(documents)
# create a document with auto ID generation
document_definition = {'name': 'sample document',
'spam': 'eggs',
'key': 'value'}
created_document = await created_collection.create_item(body=document_definition, enable_automatic_id_generation=True)
self.assertEqual(created_document.get('name'),
document_definition['name'])
document_definition = {'name': 'sample document',
'spam': 'eggs',
'key': 'value',
'id': str(uuid.uuid4())}
created_document = await created_collection.create_item(body=document_definition)
self.assertEqual(created_document.get('name'),
document_definition['name'])
self.assertEqual(created_document.get('id'),
document_definition['id'])
# duplicated documents are not allowed when 'id' is provided.
duplicated_definition_with_id = document_definition.copy()
await self.__AssertHTTPFailureWithStatus(StatusCodes.CONFLICT,
created_collection.create_item,
duplicated_definition_with_id)
# read documents after creation
documents = [document async for document in created_collection.read_all_items()]
self.assertEqual(
len(documents),
before_create_documents_count + 2,
'create should increase the number of documents')
# query documents
documents = [document async for document in created_collection.query_items(
query='SELECT * FROM root r WHERE r.name=@name',
parameter=[
{'name': '@name', 'value': document_definition['name']}
]
, enable_cross_partition_query=True
)]
self.assertTrue(documents)
documents = [document async for document in created_collection.query_items(
query='SELECT * FROM root r WHERE r.name=@name',
parameter=[
{'name': '@name', 'value': document_definition['name']}
]
, enable_cross_partition_query=True,
enable_scan_in_query=True
)]
self.assertTrue(documents)
# replace document.
created_document['name'] = 'replaced document'
created_document['spam'] = 'not eggs'
old_etag = created_document['_etag']
replaced_document = await created_collection.replace_item(
item=created_document['id'],
body=created_document
)
self.assertEqual(replaced_document['name'],
'replaced document',
'document id property should change')
self.assertEqual(replaced_document['spam'],
'not eggs',
'property should have changed')
self.assertEqual(created_document['id'],
replaced_document['id'],
'document id should stay the same')
# replace document based on condition
replaced_document['name'] = 'replaced document based on condition'
replaced_document['spam'] = 'new spam field'
# should fail for stale etag
await self.__AssertHTTPFailureWithStatus(
StatusCodes.PRECONDITION_FAILED,
created_collection.replace_item,
replaced_document['id'],
replaced_document,
if_match=old_etag,
)
# should fail if only etag specified
with self.assertRaises(ValueError):
await created_collection.replace_item(
etag=replaced_document['_etag'],
item=replaced_document['id'],
body=replaced_document
)
# should fail if only match condition specified
with self.assertRaises(ValueError):
await created_collection.replace_item(
match_condition=MatchConditions.IfNotModified,
item=replaced_document['id'],
body=replaced_document
)
with self.assertRaises(ValueError):
await created_collection.replace_item(
match_condition=MatchConditions.IfModified,
item=replaced_document['id'],
body=replaced_document
)
# should fail if invalid match condition specified
with self.assertRaises(TypeError):
await created_collection.replace_item(
match_condition=replaced_document['_etag'],
item=replaced_document['id'],
body=replaced_document
)
# should pass for most recent etag
replaced_document_conditional = await created_collection.replace_item(
match_condition=MatchConditions.IfNotModified,
etag=replaced_document['_etag'],
item=replaced_document['id'],
body=replaced_document
)
self.assertEqual(replaced_document_conditional['name'],
'replaced document based on condition',
'document id property should change')
self.assertEqual(replaced_document_conditional['spam'],
'new spam field',
'property should have changed')
self.assertEqual(replaced_document_conditional['id'],
replaced_document['id'],
'document id should stay the same')
# read document
one_document_from_read = await created_collection.read_item(
item=replaced_document['id'],
partition_key=replaced_document['id']
)
self.assertEqual(replaced_document['id'],
one_document_from_read['id'])
# delete document
await created_collection.delete_item(
item=replaced_document,
partition_key=replaced_document['id']
)
# read documents after deletion
await self.__AssertHTTPFailureWithStatus(StatusCodes.NOT_FOUND,
created_collection.read_item,
replaced_document['id'],
replaced_document['id'])
async def test_document_upsert(self):
# create database
created_db = self.databaseForTest
# create collection
created_collection = await self.databaseForTest.create_container(test_config._test_config.TEST_COLLECTION_MULTI_PARTITION)
# read documents and check count
documents = [document async for document in created_collection.read_all_items()]
before_create_documents_count = len(documents)
# create document definition
document_definition = {'id': 'doc',
'name': 'sample document',
'spam': 'eggs',
'key': 'value'}
# create document using Upsert API
created_document = await created_collection.upsert_item(body=document_definition)
# verify id property
self.assertEqual(created_document['id'],
document_definition['id'])
# test error for non-string id
with pytest.raises(TypeError):
document_definition['id'] = 7
await created_collection.upsert_item(body=document_definition)
# read documents after creation and verify updated count
documents = [document async for document in created_collection.read_all_items()]
self.assertEqual(
len(documents),
before_create_documents_count + 1,
'create should increase the number of documents')
# update document
created_document['name'] = 'replaced document'
created_document['spam'] = 'not eggs'
# should replace document since it already exists
upserted_document = await created_collection.upsert_item(body=created_document)
# verify the changed properties
self.assertEqual(upserted_document['name'],
created_document['name'],
'document name property should change')
self.assertEqual(upserted_document['spam'],
created_document['spam'],
'property should have changed')
# verify id property
self.assertEqual(upserted_document['id'],
created_document['id'],
'document id should stay the same')
# read documents after upsert and verify count doesn't increases again
documents = [document async for document in created_collection.read_all_items()]
self.assertEqual(
len(documents),
before_create_documents_count + 1,
'number of documents should remain same')
created_document['id'] = 'new id'
# Upsert should create new document since the id is different
new_document = await created_collection.upsert_item(body=created_document)
# Test modified access conditions
created_document['spam'] = 'more eggs'
await created_collection.upsert_item(body=created_document)
with pytest.raises(exceptions.CosmosHttpResponseError):
await created_collection.upsert_item(
body=created_document,
match_condition=MatchConditions.IfNotModified,
etag=new_document['_etag'])
# verify id property
self.assertEqual(created_document['id'],
new_document['id'],
'document id should be same')
# read documents after upsert and verify count increases
documents = [document async for document in created_collection.read_all_items()]
self.assertEqual(
len(documents),
before_create_documents_count + 2,
'upsert should increase the number of documents')
# delete documents
await created_collection.delete_item(item=upserted_document, partition_key=upserted_document['id'])
await created_collection.delete_item(item=new_document, partition_key=new_document['id'])
# read documents after delete and verify count is same as original
documents = [document async for document in created_collection.read_all_items()]
self.assertEqual(
len(documents),
before_create_documents_count,
'number of documents should remain same')
async def _test_spatial_index(self):
db = self.databaseForTest
# partial policy specified
collection = await db.create_container(
id='collection with spatial index ' + str(uuid.uuid4()),
indexing_policy={
'includedPaths': [
{
'path': '/"Location"/?',
'indexes': [
{
'kind': 'Spatial',
'dataType': 'Point'
}
]
},
{
'path': '/'
}
]
},
partition_key=PartitionKey(path='/id', kind='Hash')
)
await collection.create_item(
body={
'id': 'loc1',
'Location': {
'type': 'Point',
'coordinates': [20.0, 20.0]
}
}
)
await collection.create_item(
body={
'id': 'loc2',
'Location': {
'type': 'Point',
'coordinates': [100.0, 100.0]
}
}
)
results = [result async for result in collection.query_items(
query="SELECT * FROM root WHERE (ST_DISTANCE(root.Location, {type: 'Point', coordinates: [20.1, 20]}) < 20000)",
enable_cross_partition_query=True
)]
self.assertEqual(1, len(results))
self.assertEqual('loc1', results[0]['id'])
await db.delete_container(container=collection)
# CRUD test for User resource
async def test_user_crud(self):
# Should do User CRUD operations successfully.
# create database
db = self.databaseForTest
# list users
users = [user async for user in db.list_users()]
before_create_count = len(users)
# create user
user_id = 'new user' + str(uuid.uuid4())
user = await db.create_user(body={'id': user_id})
self.assertEqual(user.id, user_id, 'user id error')
# list users after creation
users = [user async for user in db.list_users()]
self.assertEqual(len(users), before_create_count + 1)
# query users
results = [user async for user in db.query_users(
query='SELECT * FROM root r WHERE r.id=@id',
parameters=[
{'name': '@id', 'value': user_id}
]
)]
self.assertTrue(results)
# replace user
replaced_user_id = 'replaced user' + str(uuid.uuid4())
user_properties = await user.read()
user_properties['id'] = replaced_user_id
replaced_user = await db.replace_user(user_id, user_properties)
self.assertEqual(replaced_user.id,
replaced_user_id,
'user id should change')
self.assertEqual(user_properties['id'],
replaced_user.id,
'user id should stay the same')
# read user
user = db.get_user_client(replaced_user.id)
self.assertEqual(replaced_user.id, user.id)
# delete user
await db.delete_user(user.id)
# read user after deletion
deleted_user = db.get_user_client(user.id)
await self.__AssertHTTPFailureWithStatus(StatusCodes.NOT_FOUND,
deleted_user.read)
async def test_user_upsert(self):
# create database
db = self.databaseForTest
# read users and check count
users = [user async for user in db.list_users()]
before_create_count = len(users)
# create user using Upsert API
user_id = 'user' + str(uuid.uuid4())
user = await db.upsert_user(body={'id': user_id})
# verify id property
self.assertEqual(user.id, user_id, 'user id error')
# read users after creation and verify updated count
users = [user async for user in db.list_users()]
self.assertEqual(len(users), before_create_count + 1)
# Should replace the user since it already exists, there is no public property to change here
user_properties = await user.read()
upserted_user = await db.upsert_user(user_properties)
# verify id property
self.assertEqual(upserted_user.id,
user.id,
'user id should remain same')
# read users after upsert and verify count doesn't increases again
users = [user async for user in db.list_users()]
self.assertEqual(len(users), before_create_count + 1)
user_properties = await user.read()
user_properties['id'] = 'new user' + str(uuid.uuid4())
user.id = user_properties['id']
# Upsert should create new user since id is different
new_user = await db.upsert_user(user_properties)
# verify id property
self.assertEqual(new_user.id, user.id, 'user id error')
# read users after upsert and verify count increases
users = [user async for user in db.list_users()]
self.assertEqual(len(users), before_create_count + 2)
# delete users
await db.delete_user(upserted_user.id)
await db.delete_user(new_user.id)
# read users after delete and verify count remains the same
users = [user async for user in db.list_users()]
self.assertEqual(len(users), before_create_count)
async def test_permission_crud(self):
# Should do Permission CRUD operations successfully
# create database
db = self.databaseForTest
# create user
user = await db.create_user(body={'id': 'new user' + str(uuid.uuid4())})
# list permissions
permissions = [permission async for permission in user.list_permissions()]
before_create_count = len(permissions)
permission = {
'id': 'new permission',
'permissionMode': documents.PermissionMode.Read,
'resource': 'dbs/AQAAAA==/colls/AQAAAJ0fgTc=' # A random one.
}
# create permission
permission = await user.create_permission(permission)
self.assertEqual(permission.id,
'new permission',
'permission id error')
# list permissions after creation
permissions = [permission async for permission in user.list_permissions()]
self.assertEqual(len(permissions), before_create_count + 1)
# query permissions
results = [permission async for permission in user.query_permissions(
query='SELECT * FROM root r WHERE r.id=@id',
parameters=[
{'name': '@id', 'value': permission.id}
]
)]
self.assertTrue(results)
# replace permission
change_permission = permission.properties.copy()
permission.properties['id'] = 'replaced permission'
permission.id = permission.properties['id']
replaced_permission = user.replace_permission(change_permission['id'], permission.properties)
self.assertEqual(replaced_permission.id,
'replaced permission',
'permission id should change')
self.assertEqual(permission.id,
replaced_permission.id,
'permission id should stay the same')
# read permission
permission = await user.get_permission(replaced_permission.id)
self.assertEqual(replaced_permission.id, permission.id)
# delete permission
await user.delete_permission(replaced_permission.id)
# read permission after deletion
await self.__AssertHTTPFailureWithStatus(StatusCodes.NOT_FOUND,
user.get_permission,
permission.id)
async def test_permission_upsert(self):
# create database
db = self.databaseForTest
# create user
user = await db.create_user(body={'id': 'new user' + str(uuid.uuid4())})
# read permissions and check count
permissions = [permission async for permission in user.list_permissions()]
before_create_count = len(permissions)
permission_definition = {
'id': 'permission',
'permissionMode': documents.PermissionMode.Read,
'resource': 'dbs/AQAAAA==/colls/AQAAAJ0fgTc=' # A random one.
}
# create permission using Upsert API
created_permission = await user.upsert_permission(permission_definition)
# verify id property
self.assertEqual(created_permission.id,
permission_definition['id'],
'permission id error')
# read permissions after creation and verify updated count
permissions = [permission async for permission in user.list_permissions()]
self.assertEqual(len(permissions), before_create_count + 1)
# update permission mode
permission_definition['permissionMode'] = documents.PermissionMode.All
# should repace the permission since it already exists
upserted_permission = await user.upsert_permission(permission_definition)
# verify id property
self.assertEqual(upserted_permission.id,
created_permission.id,
'permission id should remain same')
# verify changed property
self.assertEqual(upserted_permission.permission_mode,
permission_definition['permissionMode'],
'permissionMode should change')
# read permissions and verify count doesn't increases again
permissions = [permission async for permission in user.list_permissions()]
self.assertEqual(len(permissions), before_create_count + 1)
# update permission id
created_permission.properties['id'] = 'new permission'
created_permission.id = created_permission.properties['id']
# resource needs to be changed along with the id in order to create a new permission
created_permission.properties['resource'] = 'dbs/N9EdAA==/colls/N9EdAIugXgA='
created_permission.resource_link = created_permission.properties['resource']
# should create new permission since id has changed
new_permission = await user.upsert_permission(created_permission.properties)
# verify id and resource property
self.assertEqual(new_permission.id,
created_permission.id,
'permission id should be same')
self.assertEqual(new_permission.resource_link,
created_permission.resource_link,
'permission resource should be same')
# read permissions and verify count increases
permissions = [permission async for permission in user.list_permissions()]
self.assertEqual(len(permissions), before_create_count + 2)
# delete permissions
await user.delete_permission(upserted_permission.id)
await user.delete_permission(new_permission.id)
# read permissions and verify count remains the same
permissions = [permission async for permission in user.list_permissions()]
self.assertEqual(len(permissions), before_create_count)
async def test_authorization(self):
async def __SetupEntities(client):
"""
Sets up entities for this test.
:Parameters:
- `client`: cosmos_client_connection.CosmosClientConnection
:Returns:
dict
"""
# create database
db = self.databaseForTest
# create collection
collection = await db.create_container(
id='test_authorization' + str(uuid.uuid4()),
partition_key=PartitionKey(path='/id', kind='Hash')
)
# create document1
document = await collection.create_item(
body={'id': 'doc1',
'spam': 'eggs',
'key': 'value'},
)
# create user
user = await db.create_user(body={'id': 'user' + str(uuid.uuid4())})
# create permission for collection
permission = {
'id': 'permission On Coll',
'permissionMode': documents.PermissionMode.Read,
'resource': "dbs/" + db.id + "/colls/" + collection.id
}
permission_on_coll = await user.create_permission(body=permission)
self.assertIsNotNone(permission_on_coll.properties['_token'],
'permission token is invalid')
# create permission for document
permission = {
'id': 'permission On Doc',
'permissionMode': documents.PermissionMode.All,
'resource': "dbs/" + db.id + "/colls/" + collection.id + "/docs/" + document["id"]
}
permission_on_doc = await user.create_permission(body=permission)
self.assertIsNotNone(permission_on_doc.properties['_token'],
'permission token is invalid')
entities = {
'db': db,
'coll': collection,
'doc': document,
'user': user,
'permissionOnColl': permission_on_coll,
'permissionOnDoc': permission_on_doc,
}
return entities
# Client without any authorization will fail.
async with CosmosClient(CRUDTests.host, {}, consistency_level="Session", connection_policy=CRUDTests.connectionPolicy) as client:
try:
db_list = [db async for db in client.list_databases()]
except exceptions.CosmosHttpResponseError as e:
assert e.status_code == 401
# Client with master key.
async with CosmosClient(CRUDTests.host,
CRUDTests.masterKey,
consistency_level="Session",
connection_policy=CRUDTests.connectionPolicy) as client:
# setup entities
entities = await __SetupEntities(client)
resource_tokens = {"dbs/" + entities['db'].id + "/colls/" + entities['coll'].id:
entities['permissionOnColl'].properties['_token']}
async with CosmosClient(
CRUDTests.host, resource_tokens, consistency_level="Session", connection_policy=CRUDTests.connectionPolicy) as col_client:
db = entities['db']
old_client_connection = db.client_connection
db.client_connection = col_client.client_connection
# 1. Success-- Use Col Permission to Read
success_coll = db.get_container_client(container=entities['coll'])
# 2. Failure-- Use Col Permission to delete
await self.__AssertHTTPFailureWithStatus(StatusCodes.FORBIDDEN,
db.delete_container,
success_coll)
# 3. Success-- Use Col Permission to Read All Docs
success_documents = [document async for document in success_coll.read_all_items()]
self.assertTrue(success_documents != None,
'error reading documents')
self.assertEqual(len(success_documents),
1,
'Expected 1 Document to be successfully read')
# 4. Success-- Use Col Permission to Read Doc
docId = entities['doc']['id']
success_doc = await success_coll.read_item(
item=docId,
partition_key=docId
)
self.assertTrue(success_doc != None, 'error reading document')
self.assertEqual(
success_doc['id'],
entities['doc']['id'],
'Expected to read children using parent permissions')
# 5. Failure-- Use Col Permission to Delete Doc
await self.__AssertHTTPFailureWithStatus(StatusCodes.FORBIDDEN,
success_coll.delete_item,
docId, docId)
resource_tokens = {"dbs/" + entities['db'].id + "/colls/" + entities['coll'].id + "/docs/" + docId:
entities['permissionOnDoc'].properties['_token']}
async with CosmosClient(
CRUDTests.host, resource_tokens, consistency_level="Session", connection_policy=CRUDTests.connectionPolicy) as doc_client:
# 6. Success-- Use Doc permission to read doc
read_doc = await doc_client.get_database_client(db.id).get_container_client(success_coll.id).read_item(docId, docId)
self.assertEqual(read_doc["id"], docId)
# 6. Success-- Use Doc permission to delete doc
await doc_client.get_database_client(db.id).get_container_client(success_coll.id).delete_item(docId, docId)
self.assertEqual(read_doc["id"], docId)
db.client_connection = old_client_connection
await db.delete_container(entities['coll'])
async def test_trigger_crud(self):
# create database
db = self.databaseForTest
# create collection
collection = await self.databaseForTest.create_container(test_config._test_config.TEST_COLLECTION_MULTI_PARTITION)
# read triggers
triggers = [trigger async for trigger in collection.scripts.list_triggers()]
# create a trigger
before_create_triggers_count = len(triggers)
trigger_definition = {
'id': 'sample trigger',
'serverScript': 'function() {var x = 10;}',
'triggerType': documents.TriggerType.Pre,
'triggerOperation': documents.TriggerOperation.All
}
trigger = await collection.scripts.create_trigger(body=trigger_definition)
for property in trigger_definition:
if property != "serverScript":
self.assertEqual(
trigger[property],
trigger_definition[property],
'property {property} should match'.format(property=property))
else:
self.assertEqual(trigger['body'],
'function() {var x = 10;}')
# read triggers after creation
triggers = [trigger async for trigger in collection.scripts.list_triggers()]
self.assertEqual(len(triggers),
before_create_triggers_count + 1,
'create should increase the number of triggers')
# query triggers
triggers = [trigger async for trigger in collection.scripts.query_triggers(
query='SELECT * FROM root r WHERE r.id=@id',
parameters=[
{'name': '@id', 'value': trigger_definition['id']}
]
)]
self.assertTrue(triggers)
# replace trigger
change_trigger = trigger.copy()
trigger['body'] = 'function() {var x = 20;}'
replaced_trigger = await collection.scripts.replace_trigger(change_trigger['id'], trigger)
for property in trigger_definition:
if property != "serverScript":
self.assertEqual(
replaced_trigger[property],
trigger[property],
'property {property} should match'.format(property=property))
else:
self.assertEqual(replaced_trigger['body'],
'function() {var x = 20;}')
# read trigger
trigger = await collection.scripts.get_trigger(replaced_trigger['id'])
self.assertEqual(replaced_trigger['id'], trigger['id'])
# delete trigger
await collection.scripts.delete_trigger(replaced_trigger['id'])
# read triggers after deletion
await self.__AssertHTTPFailureWithStatus(StatusCodes.NOT_FOUND,
collection.scripts.delete_trigger,
replaced_trigger['id'])
async def test_udf_crud(self):
# create database
db = self.databaseForTest
# create collection
collection = await self.databaseForTest.create_container(test_config._test_config.TEST_COLLECTION_MULTI_PARTITION)
# read udfs
udfs = [udf async for udf in collection.scripts.list_user_defined_functions()]
# create a udf
before_create_udfs_count = len(udfs)
udf_definition = {
'id': 'sample udf',
'body': 'function() {var x = 10;}'
}
udf = await collection.scripts.create_user_defined_function(body=udf_definition)
for property in udf_definition:
self.assertEqual(
udf[property],
udf_definition[property],
'property {property} should match'.format(property=property))
# read udfs after creation
udfs = [udf async for udf in collection.scripts.list_user_defined_functions()]
self.assertEqual(len(udfs),
before_create_udfs_count + 1,
'create should increase the number of udfs')
# query udfs
results = [udf async for udf in collection.scripts.query_user_defined_functions(
query='SELECT * FROM root r WHERE r.id=@id',
parameters=[
{'name': '@id', 'value': udf_definition['id']}
]
)]
self.assertTrue(results)
# replace udf
change_udf = udf.copy()
udf['body'] = 'function() {var x = 20;}'
replaced_udf = await collection.scripts.replace_user_defined_function(udf=udf['id'], body=udf)
for property in udf_definition:
self.assertEqual(
replaced_udf[property],
udf[property],
'property {property} should match'.format(property=property))
# read udf
udf = await collection.scripts.get_user_defined_function(replaced_udf['id'])
self.assertEqual(replaced_udf['id'], udf['id'])
# delete udf
await collection.scripts.delete_user_defined_function(replaced_udf['id'])
# read udfs after deletion
await self.__AssertHTTPFailureWithStatus(StatusCodes.NOT_FOUND,
collection.scripts.get_user_defined_function,
replaced_udf['id'])
async def test_sproc_crud(self):
# create database
db = self.databaseForTest
# create collection
collection = await self.databaseForTest.create_container(test_config._test_config.TEST_COLLECTION_MULTI_PARTITION)
# read sprocs
sprocs = [sproc async for sproc in collection.scripts.list_stored_procedures()]
# create a sproc
before_create_sprocs_count = len(sprocs)
sproc_definition = {
'id': 'sample sproc',
'serverScript': 'function() {var x = 10;}'
}
sproc = await collection.scripts.create_stored_procedure(body=sproc_definition)
for property in sproc_definition:
if property != "serverScript":
self.assertEqual(
sproc[property],
sproc_definition[property],
'property {property} should match'.format(property=property))
else:
self.assertEqual(sproc['body'], 'function() {var x = 10;}')
# read sprocs after creation
sprocs = [sproc async for sproc in collection.scripts.list_stored_procedures()]
self.assertEqual(len(sprocs),
before_create_sprocs_count + 1,
'create should increase the number of sprocs')
# query sprocs
sprocs = [sproc async for sproc in collection.scripts.query_stored_procedures(
query='SELECT * FROM root r WHERE r.id=@id',
parameters=[
{'name': '@id', 'value': sproc_definition['id']}
]
)]
self.assertIsNotNone(sprocs)
# replace sproc
change_sproc = sproc.copy()
sproc['body'] = 'function() {var x = 20;}'
replaced_sproc = await collection.scripts.replace_stored_procedure(sproc=change_sproc['id'], body=sproc)
for property in sproc_definition:
if property != 'serverScript':
self.assertEqual(
replaced_sproc[property],
sproc[property],
'property {property} should match'.format(property=property))
else:
self.assertEqual(replaced_sproc['body'],
"function() {var x = 20;}")
# read sproc
sproc = await collection.scripts.get_stored_procedure(replaced_sproc['id'])
self.assertEqual(replaced_sproc['id'], sproc['id'])
# delete sproc
await collection.scripts.delete_stored_procedure(replaced_sproc['id'])
# read sprocs after deletion
await self.__AssertHTTPFailureWithStatus(StatusCodes.NOT_FOUND,
collection.scripts.get_stored_procedure,
replaced_sproc['id'])
async def test_script_logging_execute_stored_procedure(self):
created_db = self.databaseForTest
created_collection = await self.databaseForTest.create_container(test_config._test_config.TEST_COLLECTION_MULTI_PARTITION)
sproc = {
'id': 'storedProcedure' + str(uuid.uuid4()),
'body': (
'function () {' +
' var mytext = \'x\';' +
' var myval = 1;' +
' try {' +
' console.log(\'The value of %s is %s.\', mytext, myval);' +
' getContext().getResponse().setBody(\'Success!\');' +
' }' +
' catch (err) {' +
' getContext().getResponse().setBody(\'inline err: [\' + err.number + \'] \' + err);' +
' }'
'}')
}
created_sproc = await created_collection.scripts.create_stored_procedure(body=sproc)
result = await created_collection.scripts.execute_stored_procedure(
sproc=created_sproc['id'],
partition_key=1
)
self.assertEqual(result, 'Success!')
self.assertFalse(
HttpHeaders.ScriptLogResults in created_collection.scripts.client_connection.last_response_headers)
result = await created_collection.scripts.execute_stored_procedure(
sproc=created_sproc['id'],
enable_script_logging=True,
partition_key=1
)
self.assertEqual(result, 'Success!')
self.assertEqual(urllib.quote('The value of x is 1.'),
created_collection.scripts.client_connection.last_response_headers.get(
HttpHeaders.ScriptLogResults))
result = await created_collection.scripts.execute_stored_procedure(
sproc=created_sproc['id'],
enable_script_logging=False,
partition_key=1
)
self.assertEqual(result, 'Success!')
self.assertFalse(
HttpHeaders.ScriptLogResults in created_collection.scripts.client_connection.last_response_headers)
async def test_collection_indexing_policy(self):
# create database
db = self.databaseForTest
# create collection
collection = await db.create_container(
id='test_collection_indexing_policy default policy' + str(uuid.uuid4()),
partition_key=PartitionKey(path='/id', kind='Hash')
)
collection_properties = await collection.read()
self.assertEqual(collection_properties['indexingPolicy']['indexingMode'],
documents.IndexingMode.Consistent,
'default indexing mode should be consistent')
await db.delete_container(container=collection)
consistent_collection = await db.create_container(
id='test_collection_indexing_policy consistent collection ' + str(uuid.uuid4()),
indexing_policy={
'indexingMode': documents.IndexingMode.Consistent
},
partition_key=PartitionKey(path='/id', kind='Hash')
)
consistent_collection_properties = await consistent_collection.read()
self.assertEqual(consistent_collection_properties['indexingPolicy']['indexingMode'],
documents.IndexingMode.Consistent,
'indexing mode should be consistent')
await db.delete_container(container=consistent_collection)
collection_with_indexing_policy = await db.create_container(
id='CollectionWithIndexingPolicy ' + str(uuid.uuid4()),
indexing_policy={
'automatic': True,
'indexingMode': documents.IndexingMode.Consistent,
'includedPaths': [
{
'path': '/',
'indexes': [
{
'kind': documents.IndexKind.Hash,
'dataType': documents.DataType.Number,
'precision': 2
}
]
}
],
'excludedPaths': [
{
'path': '/"systemMetadata"/*'
}
]
},
partition_key=PartitionKey(path='/id', kind='Hash')
)
collection_with_indexing_policy_properties = await collection_with_indexing_policy.read()
self.assertEqual(1,
len(collection_with_indexing_policy_properties['indexingPolicy']['includedPaths']),
'Unexpected includedPaths length')
self.assertEqual(2,
len(collection_with_indexing_policy_properties['indexingPolicy']['excludedPaths']),
'Unexpected excluded path count')
await db.delete_container(container=collection_with_indexing_policy)
async def test_create_default_indexing_policy(self):
# create database
db = self.databaseForTest
# no indexing policy specified
collection = await db.create_container(
id='test_create_default_indexing_policy TestCreateDefaultPolicy01' + str(uuid.uuid4()),
partition_key=PartitionKey(path='/id', kind='Hash')
)
collection_properties = await collection.read()
await self._check_default_indexing_policy_paths(collection_properties['indexingPolicy'])
await db.delete_container(container=collection)
# partial policy specified
collection = await db.create_container(
id='test_create_default_indexing_policy TestCreateDefaultPolicy01' + str(uuid.uuid4()),
indexing_policy={
'indexingMode': documents.IndexingMode.Consistent, 'automatic': True
},
partition_key=PartitionKey(path='/id', kind='Hash')
)
collection_properties = await collection.read()
await self._check_default_indexing_policy_paths(collection_properties['indexingPolicy'])
await db.delete_container(container=collection)
# default policy
collection = await db.create_container(
id='test_create_default_indexing_policy TestCreateDefaultPolicy03' + str(uuid.uuid4()),
indexing_policy={},
partition_key=PartitionKey(path='/id', kind='Hash')
)
collection_properties = await collection.read()
await self._check_default_indexing_policy_paths(collection_properties['indexingPolicy'])
await db.delete_container(container=collection)
# missing indexes
collection = await db.create_container(
id='test_create_default_indexing_policy TestCreateDefaultPolicy04' + str(uuid.uuid4()),
indexing_policy={
'includedPaths': [
{
'path': '/*'
}
]
},
partition_key=PartitionKey(path='/id', kind='Hash')
)
collection_properties = await collection.read()
await self._check_default_indexing_policy_paths(collection_properties['indexingPolicy'])
await db.delete_container(container=collection)
# missing precision
collection = await db.create_container(
id='test_create_default_indexing_policy TestCreateDefaultPolicy05' + str(uuid.uuid4()),
indexing_policy={
'includedPaths': [
{
'path': '/*',
'indexes': [
{
'kind': documents.IndexKind.Hash,
'dataType': documents.DataType.String
},
{
'kind': documents.IndexKind.Range,
'dataType': documents.DataType.Number
}
]
}
]
},
partition_key=PartitionKey(path='/id', kind='Hash')
)
collection_properties = await collection.read()
await self._check_default_indexing_policy_paths(collection_properties['indexingPolicy'])
await db.delete_container(container=collection)
async def test_create_indexing_policy_with_composite_and_spatial_indexes(self):
# create database
db = self.databaseForTest
indexing_policy = {
"spatialIndexes": [
{
"path": "/path0/*",
"types": [
"Point",
"LineString",
"Polygon",
"MultiPolygon"
]
},
{
"path": "/path1/*",
"types": [
"Point",
"LineString",
"Polygon",
"MultiPolygon"
]
}
],
"compositeIndexes": [
[
{
"path": "/path1",
"order": "ascending"
},
{
"path": "/path2",
"order": "descending"
},
{
"path": "/path3",
"order": "ascending"
}
],
[
{
"path": "/path4",
"order": "ascending"
},
{
"path": "/path5",
"order": "descending"
},
{
"path": "/path6",
"order": "ascending"
}
]
]
}
custom_logger = logging.getLogger("CustomLogger")
created_container = await db.create_container(
id='composite_index_spatial_index' + str(uuid.uuid4()),
indexing_policy=indexing_policy,
partition_key=PartitionKey(path='/id', kind='Hash'),
headers={"Foo": "bar"},
user_agent="blah",
user_agent_overwrite=True,
logging_enable=True,
logger=custom_logger,
)
created_properties = await created_container.read(logger=custom_logger)
read_indexing_policy = created_properties['indexingPolicy']
if 'localhost' in self.host or '127.0.0.1' in self.host: # TODO: Differing result between live and emulator
self.assertListEqual(indexing_policy['spatialIndexes'], read_indexing_policy['spatialIndexes'])
else:
# All types are returned for spatial Indexes
self.assertListEqual(indexing_policy['spatialIndexes'], read_indexing_policy['spatialIndexes'])
self.assertListEqual(indexing_policy['compositeIndexes'], read_indexing_policy['compositeIndexes'])
await db.delete_container(container=created_container)
async def _check_default_indexing_policy_paths(self, indexing_policy):
def __get_first(array):
if array:
return array[0]
else:
return None
# '/_etag' is present in excluded paths by default
self.assertEqual(1, len(indexing_policy['excludedPaths']))
# included paths should be 1: '/'.
self.assertEqual(1, len(indexing_policy['includedPaths']))
root_included_path = __get_first([included_path for included_path in indexing_policy['includedPaths']
if included_path['path'] == '/*'])
self.assertFalse(root_included_path.get('indexes'))
async def test_client_request_timeout(self):
# Test is flaky on Emulator
if not ('localhost' in self.host or '127.0.0.1' in self.host):
connection_policy = documents.ConnectionPolicy()
# making timeout 0 ms to make sure it will throw
connection_policy.RequestTimeout = 0.000000000001
with self.assertRaises(Exception):
# client does a getDatabaseAccount on initialization, which will time out
async with CosmosClient(CRUDTests.host, CRUDTests.masterKey, consistency_level="Session",
connection_policy=connection_policy) as client:
print('Async initialization')
async def test_client_request_timeout_when_connection_retry_configuration_specified(self):
connection_policy = documents.ConnectionPolicy()
# making timeout 0 ms to make sure it will throw
connection_policy.RequestTimeout = 0.000000000001
connection_policy.ConnectionRetryConfiguration = Retry(
total=3,
read=3,
connect=3,
backoff_factor=0.3,
status_forcelist=(500, 502, 504)
)
with self.assertRaises(AzureError):
# client does a getDatabaseAccount on initialization, which will time out
async with CosmosClient(CRUDTests.host, CRUDTests.masterKey, consistency_level="Session",
connection_policy=connection_policy) as client:
print('Async Initialization')
async def test_client_connection_retry_configuration(self):
total_time_for_two_retries = await self.initialize_client_with_connection_urllib_retry_config(2)
total_time_for_three_retries = await self.initialize_client_with_connection_urllib_retry_config(3)
self.assertGreater(total_time_for_three_retries, total_time_for_two_retries)
total_time_for_two_retries = await self.initialize_client_with_connection_core_retry_config(2)
total_time_for_three_retries = await self.initialize_client_with_connection_core_retry_config(3)
self.assertGreater(total_time_for_three_retries, total_time_for_two_retries)
async def initialize_client_with_connection_urllib_retry_config(self, retries):
retry_policy = Retry(
total=retries,
read=retries,
connect=retries,
backoff_factor=0.3,
status_forcelist=(500, 502, 504)
)
start_time = time.time()
try:
async with CosmosClient(
"https://localhost:9999",
CRUDTests.masterKey,
consistency_level="Session",
connection_retry_policy=retry_policy) as client: print('Async initialization')
self.fail()
except AzureError as e:
end_time = time.time()
return end_time - start_time
async def initialize_client_with_connection_core_retry_config(self, retries):
start_time = time.time()
try:
async with CosmosClient(
"https://localhost:9999",
CRUDTests.masterKey,
consistency_level="Session",
retry_total=retries,
retry_read=retries,
retry_connect=retries,
retry_status=retries) as client: print('Async initialization')
self.fail()
except AzureError as e:
end_time = time.time()
return end_time - start_time
async def test_absolute_client_timeout(self):
with self.assertRaises(exceptions.CosmosClientTimeoutError):
async with CosmosClient(
"https://localhost:9999",
CRUDTests.masterKey,
consistency_level="Session",
retry_total=3,
timeout=1)as client: print('Async initialization')
error_response = ServiceResponseError("Read timeout")
timeout_transport = TimeoutTransport(error_response)
async with CosmosClient(
self.host, self.masterKey, consistency_level="Session", transport=timeout_transport, passthrough=True) as client: print('Async initialization')
with self.assertRaises(exceptions.CosmosClientTimeoutError):
await client.create_database_if_not_exists("test", timeout=2)
status_response = 500 # Users connection level retry
timeout_transport = TimeoutTransport(status_response)
async with CosmosClient(
self.host, self.masterKey, consistency_level="Session", transport=timeout_transport, passthrough=True) as client: print(
'Async initialization')
with self.assertRaises(exceptions.CosmosClientTimeoutError):
await client.create_database("test", timeout=2)
databases = client.list_databases(timeout=2)
with self.assertRaises(exceptions.CosmosClientTimeoutError):
databases = [database async for database in databases]
status_response = 429 # Uses Cosmos custom retry
timeout_transport = TimeoutTransport(status_response)
async with CosmosClient(
self.host, self.masterKey, consistency_level="Session", transport=timeout_transport, passthrough=True) as client: print(
'Async initialization')
with self.assertRaises(exceptions.CosmosClientTimeoutError):
await client.create_database_if_not_exists("test", timeout=2)
databases = client.list_databases(timeout=2)
with self.assertRaises(exceptions.CosmosClientTimeoutError):
databases = [database async for database in databases]
async def test_query_iterable_functionality(self):
async def __create_resources(client):
"""Creates resources for this test.
:Parameters:
- `client`: cosmos_client_connection.CosmosClientConnection
:Returns:
dict
"""
collection = await self.databaseForTest.create_container(test_config._test_config.TEST_COLLECTION_MULTI_PARTITION_WITH_CUSTOM_PK_PARTITION_KEY, PartitionKey(path="/pk"))
doc1 = await collection.create_item(body={'id': 'doc1', 'prop1': 'value1'})
doc2 = await collection.create_item(body={'id': 'doc2', 'prop1': 'value2'})
doc3 = await collection.create_item(body={'id': 'doc3', 'prop1': 'value3'})
resources = {
'coll': collection,
'doc1': doc1,
'doc2': doc2,
'doc3': doc3
}
return resources
# Validate QueryIterable by converting it to a list.
resources = await __create_resources(self.client)
results = resources['coll'].read_all_items(max_item_count=2)
docs = [doc async for doc in results]
self.assertEqual(3,
len(docs),
'QueryIterable should return all documents' +
' using continuation')
self.assertEqual(resources['doc1']['id'], docs[0]['id'])
self.assertEqual(resources['doc2']['id'], docs[1]['id'])
self.assertEqual(resources['doc3']['id'], docs[2]['id'])
# Validate QueryIterable iterator with 'for'.
results = resources['coll'].read_all_items(max_item_count=2)
counter = 0
# test QueryIterable with 'for'.
async for doc in results:
counter += 1
if counter == 1:
self.assertEqual(resources['doc1']['id'],
doc['id'],
'first document should be doc1')
elif counter == 2:
self.assertEqual(resources['doc2']['id'],
doc['id'],
'second document should be doc2')
elif counter == 3:
self.assertEqual(resources['doc3']['id'],
doc['id'],
'third document should be doc3')
self.assertEqual(counter, 3)
# Get query results page by page.
results = resources['coll'].read_all_items(max_item_count=2)
page_iter = results.by_page()
first_block = [page async for page in next(page_iter)]
self.assertEqual(2, len(first_block), 'First block should have 2 entries.')
self.assertEqual(resources['doc1']['id'], first_block[0]['id'])
self.assertEqual(resources['doc2']['id'], first_block[1]['id'])
self.assertEqual(1, len([page async for page in next(page_iter)]), 'Second block should have 1 entry.')
with self.assertRaises(StopIteration):
next(page_iter)
async def test_trigger_functionality(self):
triggers_in_collection1 = [
{
'id': 't1',
'body': (
'function() {' +
' var item = getContext().getRequest().getBody();' +
' item.id = item.id.toUpperCase() + \'t1\';' +
' getContext().getRequest().setBody(item);' +
'}'),
'triggerType': documents.TriggerType.Pre,
'triggerOperation': documents.TriggerOperation.All
},
{
'id': 'response1',
'body': (
'function() {' +
' var prebody = getContext().getRequest().getBody();' +
' if (prebody.id != \'TESTING POST TRIGGERt1\')'
' throw \'id mismatch\';' +
' var postbody = getContext().getResponse().getBody();' +
' if (postbody.id != \'TESTING POST TRIGGERt1\')'
' throw \'id mismatch\';'
'}'),
'triggerType': documents.TriggerType.Post,
'triggerOperation': documents.TriggerOperation.All
},
{
'id': 'response2',
# can't be used because setValue is currently disabled
'body': (
'function() {' +
' var predoc = getContext().getRequest().getBody();' +
' var postdoc = getContext().getResponse().getBody();' +
' getContext().getResponse().setValue(' +
' \'predocname\', predoc.id + \'response2\');' +
' getContext().getResponse().setValue(' +
' \'postdocname\', postdoc.id + \'response2\');' +
'}'),
'triggerType': documents.TriggerType.Post,
'triggerOperation': documents.TriggerOperation.All,
}]
triggers_in_collection2 = [
{
'id': "t2",
'body': "function() { }", # trigger already stringified
'triggerType': documents.TriggerType.Pre,
'triggerOperation': documents.TriggerOperation.All
},
{
'id': "t3",
'body': (
'function() {' +
' var item = getContext().getRequest().getBody();' +
' item.id = item.id.toLowerCase() + \'t3\';' +
' getContext().getRequest().setBody(item);' +
'}'),
'triggerType': documents.TriggerType.Pre,
'triggerOperation': documents.TriggerOperation.All
}]
triggers_in_collection3 = [
{
'id': 'triggerOpType',
'body': 'function() { }',
'triggerType': documents.TriggerType.Post,
'triggerOperation': documents.TriggerOperation.Delete,
}]
async def __CreateTriggers(collection, triggers):
"""Creates triggers.
:Parameters:
- `client`: cosmos_client_connection.CosmosClientConnection
- `collection`: dict
"""
async for trigger_i in triggers:
trigger = await collection.scripts.create_trigger(body=trigger_i)
async for property in trigger_i:
self.assertEqual(
trigger[property],
trigger_i[property],
'property {property} should match'.format(property=property))
# create database
db = self.databaseForTest
# create collections
pkd = PartitionKey(path='/id', kind='Hash')
collection1 = await db.create_container(id='test_trigger_functionality 1 ' + str(uuid.uuid4()),
partition_key=PartitionKey(path='/key', kind='Hash'))
collection2 = await db.create_container(id='test_trigger_functionality 2 ' + str(uuid.uuid4()),
partition_key=PartitionKey(path='/key', kind='Hash'))
collection3 = await db.create_container(id='test_trigger_functionality 3 ' + str(uuid.uuid4()),
partition_key=PartitionKey(path='/key', kind='Hash'))
# create triggers
await __CreateTriggers(collection1, triggers_in_collection1)
await __CreateTriggers(collection2, triggers_in_collection2)
await __CreateTriggers(collection3, triggers_in_collection3)
# create document
triggers_1 = [trigger async for trigger in collection1.scripts.list_triggers()]
self.assertEqual(len(triggers_1), 3)
document_1_1 = collection1.create_item(
body={'id': 'doc1',
'key': 'value'},
pre_trigger_include='t1'
)
self.assertEqual(document_1_1['id'],
'DOC1t1',
'id should be capitalized')
document_1_2 = await collection1.create_item(
body={'id': 'testing post trigger', 'key': 'value'},
pre_trigger_include='t1',
post_trigger_include='response1',
)
self.assertEqual(document_1_2['id'], 'TESTING POST TRIGGERt1')
document_1_3 = await collection1.create_item(
body={'id': 'responseheaders', 'key': 'value'},
pre_trigger_include='t1'
)
self.assertEqual(document_1_3['id'], "RESPONSEHEADERSt1")
triggers_2 = [trigger async for trigger in collection2.scripts.list_triggers()]
self.assertEqual(len(triggers_2), 2)
document_2_1 = await collection2.create_item(
body={'id': 'doc2',
'key': 'value2'},
pre_trigger_include='t2'
)
self.assertEqual(document_2_1['id'],
'doc2',
'id shouldn\'t change')
document_2_2 = await collection2.create_item(
body={'id': 'Doc3',
'prop': 'empty',
'key': 'value2'},
pre_trigger_include='t3')
self.assertEqual(document_2_2['id'], 'doc3t3')
triggers_3 = [trigger async for trigger in collection3.scripts.list_triggers()]
self.assertEqual(len(triggers_3), 1)
with self.assertRaises(Exception):
await collection3.create_item(
body={'id': 'Docoptype', 'key': 'value2'},
post_trigger_include='triggerOpType'
)
await db.delete_container(collection1)
await db.delete_container(collection2)
await db.delete_container(collection3)
async def test_stored_procedure_functionality(self):
# create database
db = self.databaseForTest
# create collection
collection = await self.databaseForTest.create_container(test_config._test_config.TEST_COLLECTION_MULTI_PARTITION)
sproc1 = {
'id': 'storedProcedure1' + str(uuid.uuid4()),
'body': (
'function () {' +
' for (var i = 0; i < 1000; i++) {' +
' var item = getContext().getResponse().getBody();' +
' if (i > 0 && item != i - 1) throw \'body mismatch\';' +
' getContext().getResponse().setBody(i);' +
' }' +
'}')
}
retrieved_sproc = await collection.scripts.create_stored_procedure(body=sproc1)
result = await collection.scripts.execute_stored_procedure(
sproc=retrieved_sproc['id'],
partition_key=1
)
self.assertEqual(result, 999)
sproc2 = {
'id': 'storedProcedure2' + str(uuid.uuid4()),
'body': (
'function () {' +
' for (var i = 0; i < 10; i++) {' +
' getContext().getResponse().appendValue(\'Body\', i);' +
' }' +
'}')
}
retrieved_sproc2 = await collection.scripts.create_stored_procedure(body=sproc2)
result = await collection.scripts.execute_stored_procedure(
sproc=retrieved_sproc2['id'],
partition_key=1
)
self.assertEqual(int(result), 123456789)
sproc3 = {
'id': 'storedProcedure3' + str(uuid.uuid4()),
'body': (
'function (input) {' +
' getContext().getResponse().setBody(' +
' \'a\' + input.temp);' +
'}')
}
retrieved_sproc3 = await collection.scripts.create_stored_procedure(body=sproc3)
result = await collection.scripts.execute_stored_procedure(
sproc=retrieved_sproc3['id'],
params={'temp': 'so'},
partition_key=1
)
self.assertEqual(result, 'aso')
async def __ValidateOfferResponseBody(self, offer, expected_coll_link, expected_offer_type):
# type: (Offer, str, Any) -> None
self.assertIsNotNone(offer.properties['id'], 'Id cannot be null.')
self.assertIsNotNone(offer.properties.get('_rid'), 'Resource Id (Rid) cannot be null.')
self.assertIsNotNone(offer.properties.get('_self'), 'Self Link cannot be null.')
self.assertIsNotNone(offer.properties.get('resource'), 'Resource Link cannot be null.')
self.assertTrue(offer.properties['_self'].find(offer.properties['id']) != -1,
'Offer id not contained in offer self link.')
self.assertEqual(expected_coll_link.strip('/'), offer.properties['resource'].strip('/'))
if (expected_offer_type):
self.assertEqual(expected_offer_type, offer.properties.get('offerType'))
async def test_offer_read_and_query(self):
# Create database.
db = self.databaseForTest
# Create collection.
collection = await db.create_container(
id='test_offer_read_and_query ' + str(uuid.uuid4()),
partition_key=PartitionKey(path='/id', kind='Hash')
)
# Read the offer.
expected_offer = await collection.get_throughput()
collection_properties = await collection.read()
await self.__ValidateOfferResponseBody(expected_offer, collection_properties.get('_self'), None)
# Now delete the collection.
await db.delete_container(container=collection)
# Reading fails.
await self.__AssertHTTPFailureWithStatus(StatusCodes.NOT_FOUND, collection.read_offer)
async def test_offer_replace(self):
# Create database.
db = self.databaseForTest
# Create collection.
collection = await self.databaseForTest.create_container(test_config._test_config.TEST_COLLECTION_MULTI_PARTITION)
# Read Offer
expected_offer = await collection.get_throughput()
collection_properties = await collection.read()
await self.__ValidateOfferResponseBody(expected_offer, collection_properties.get('_self'), None)
# Replace the offer.
replaced_offer = await collection.replace_throughput(expected_offer.offer_throughput + 100)
collection_properties = await collection.read()
await self.__ValidateOfferResponseBody(replaced_offer, collection_properties.get('_self'), None)
# Check if the replaced offer is what we expect.
self.assertEqual(expected_offer.properties.get('content').get('offerThroughput') + 100,
replaced_offer.properties.get('content').get('offerThroughput'))
self.assertEqual(expected_offer.offer_throughput + 100,
replaced_offer.offer_throughput)
async def test_database_account_functionality(self):
# Validate database account functionality.
database_account = await self.client._get_database_account()
self.assertEqual(database_account.DatabasesLink, '/dbs/')
self.assertEqual(database_account.MediaLink, '/media/')
if (HttpHeaders.MaxMediaStorageUsageInMB in
await self.client.client_connection.last_response_headers):
self.assertEqual(
database_account.MaxMediaStorageUsageInMB,
self.client.client_connection.last_response_headers[
HttpHeaders.MaxMediaStorageUsageInMB])
if (HttpHeaders.CurrentMediaStorageUsageInMB in
await self.client.client_connection.last_response_headers):
self.assertEqual(
database_account.CurrentMediaStorageUsageInMB,
await self.client.client_connection.last_response_headers[
HttpHeaders.CurrentMediaStorageUsageInMB])
self.assertIsNotNone(database_account.ConsistencyPolicy['defaultConsistencyLevel'])
async def test_index_progress_headers(self):
created_db = self.databaseForTest
consistent_coll = await created_db.create_container(
id='test_index_progress_headers consistent_coll ' + str(uuid.uuid4()),
partition_key=PartitionKey(path="/id", kind='Hash'),
)
created_container = created_db.get_container_client(container=consistent_coll)
await created_container.read(populate_quota_info=True)
self.assertFalse(HttpHeaders.LazyIndexingProgress in created_db.client_connection.last_response_headers)
self.assertTrue(HttpHeaders.IndexTransformationProgress in created_db.client_connection.last_response_headers)
none_coll = await created_db.create_container(
id='test_index_progress_headers none_coll ' + str(uuid.uuid4()),
indexing_policy={
'indexingMode': documents.IndexingMode.NoIndex,
'automatic': False
},
partition_key=PartitionKey(path="/id", kind='Hash')
)
created_container = created_db.get_container_client(container=none_coll)
await created_container.read(populate_quota_info=True)
self.assertFalse(HttpHeaders.LazyIndexingProgress in created_db.client_connection.last_response_headers)
self.assertTrue(HttpHeaders.IndexTransformationProgress in created_db.client_connection.last_response_headers)
await created_db.delete_container(consistent_coll)
await created_db.delete_container(none_coll)
async def test_id_validation(self):
# Id shouldn't end with space.
try:
await self.client.create_database(id='id_with_space ')
self.assertFalse(True)
except ValueError as e:
self.assertEqual('Id ends with a space.', e.args[0])
# Id shouldn't contain '/'.
try:
await self.client.create_database(id='id_with_illegal/_char')
self.assertFalse(True)
except ValueError as e:
self.assertEqual('Id contains illegal chars.', e.args[0])
# Id shouldn't contain '\\'.
try:
await self.client.create_database(id='id_with_illegal\\_char')
self.assertFalse(True)
except ValueError as e:
self.assertEqual('Id contains illegal chars.', e.args[0])
# Id shouldn't contain '?'.
try:
await self.client.create_database(id='id_with_illegal?_char')
self.assertFalse(True)
except ValueError as e:
self.assertEqual('Id contains illegal chars.', e.args[0])
# Id shouldn't contain '#'.
try:
await self.client.create_database(id='id_with_illegal#_char')
self.assertFalse(True)
except ValueError as e:
self.assertEqual('Id contains illegal chars.', e.args[0])
# Id can begin with space
db = await self.client.create_database(id=' id_begin_space')
self.assertTrue(True)
await self.client.delete_database(database=db)
async def test_id_case_validation(self):
# create database
created_db = self.databaseForTest
uuid_string = str(uuid.uuid4())
collection_id1 = 'sampleCollection ' + uuid_string
collection_id2 = 'SampleCollection ' + uuid_string
# Verify that no collections exist
collections = [collection async for collection in created_db.list_containers()]
number_of_existing_collections = len(collections)
# create 2 collections with different casing of IDs
# pascalCase
created_collection1 = await created_db.create_container(
id=collection_id1,
partition_key=PartitionKey(path='/id', kind='Hash')
)
# CamelCase
created_collection2 = await created_db.create_container(
id=collection_id2,
partition_key=PartitionKey(path='/id', kind='Hash')
)
collections = [collection async for collection in created_db.list_containers()]
# verify if a total of 2 collections got created
self.assertEqual(len(collections), number_of_existing_collections + 2)
# verify that collections are created with specified IDs
self.assertEqual(collection_id1, created_collection1.id)
self.assertEqual(collection_id2, created_collection2.id)
await created_db.delete_container(created_collection1)
await created_db.delete_container(created_collection2)
async def test_id_unicode_validation(self):
# create database
created_db = self.databaseForTest
# unicode chars in Hindi for Id which translates to: "Hindi is the national language of India"
collection_id1 = u'हिन्दी भारत की राष्ट्रीय भाषा है' # cspell:disable-line
# Special chars for Id
collection_id2 = "!@$%^&*()-~`'_[]{}|;:,.<>"
# verify that collections are created with specified IDs
created_collection1 = await created_db.create_container(
id=collection_id1,
partition_key=PartitionKey(path='/id', kind='Hash')
)
created_collection2 = await created_db.create_container(
id=collection_id2,
partition_key=PartitionKey(path='/id', kind='Hash')
)
self.assertEqual(collection_id1, created_collection1.id)
self.assertEqual(collection_id2, created_collection2.id)
created_collection1_properties = await created_collection1.read()
created_collection2_properties = await created_collection2.read()
await created_db.delete_container(created_collection1_properties)
await created_db.delete_container(created_collection2_properties)
async def test_get_resource_with_dictionary_and_object(self):
created_db = self.databaseForTest
# read database with id
read_db = self.client.get_database_client(created_db.id)
self.assertEqual(read_db.id, created_db.id)
# read database with instance
read_db = self.client.get_database_client(created_db)
self.assertEqual(read_db.id, created_db.id)
# read database with properties
read_db = self.client.get_database_client(await created_db.read())
self.assertEqual(read_db.id, created_db.id)
created_container = await self.databaseForTest.create_container(test_config._test_config.TEST_COLLECTION_MULTI_PARTITION, PartitionKey(path="/id"))
# read container with id
read_container = created_db.get_container_client(created_container.id)
self.assertEqual(read_container.id, created_container.id)
# read container with instance
read_container = created_db.get_container_client(created_container)
self.assertEqual(read_container.id, created_container.id)
# read container with properties
created_properties = await created_container.read()
read_container = created_db.get_container_client(created_properties)
self.assertEqual(read_container.id, created_container.id)
created_item = await created_container.create_item({'id': '1' + str(uuid.uuid4())})
# read item with id
read_item = await created_container.read_item(item=created_item['id'], partition_key=created_item['id'])
self.assertEqual(read_item['id'], created_item['id'])
# read item with properties
read_item = await created_container.read_item(item=created_item, partition_key=created_item['id'])
self.assertEqual(read_item['id'], created_item['id'])
created_sproc = await created_container.scripts.create_stored_procedure({
'id': 'storedProcedure' + str(uuid.uuid4()),
'body': 'function () { }'
})
# read sproc with id
read_sproc = await created_container.scripts.get_stored_procedure(created_sproc['id'])
self.assertEqual(read_sproc['id'], created_sproc['id'])
# read sproc with properties
read_sproc = await created_container.scripts.get_stored_procedure(created_sproc)
self.assertEqual(read_sproc['id'], created_sproc['id'])
created_trigger = await created_container.scripts.create_trigger({
'id': 'sample trigger' + str(uuid.uuid4()),
'serverScript': 'function() {var x = 10;}',
'triggerType': documents.TriggerType.Pre,
'triggerOperation': documents.TriggerOperation.All
})
# read trigger with id
read_trigger = await created_container.scripts.get_trigger(created_trigger['id'])
self.assertEqual(read_trigger['id'], created_trigger['id'])
# read trigger with properties
read_trigger = await created_container.scripts.get_trigger(created_trigger)
self.assertEqual(read_trigger['id'], created_trigger['id'])
created_udf = await created_container.scripts.create_user_defined_function({
'id': 'sample udf' + str(uuid.uuid4()),
'body': 'function() {var x = 10;}'
})
# read udf with id
read_udf = await created_container.scripts.get_user_defined_function(created_udf['id'])
self.assertEqual(created_udf['id'], read_udf['id'])
# read udf with properties
read_udf = await created_container.scripts.get_user_defined_function(created_udf)
self.assertEqual(created_udf['id'], read_udf['id'])
created_user = await created_db.create_user({
'id': 'user' + str(uuid.uuid4())
})
# read user with id
read_user = created_db.get_user_client(created_user.id)
self.assertEqual(read_user.id, created_user.id)
# read user with instance
read_user = created_db.get_user_client(created_user)
self.assertEqual(read_user.id, created_user.id)
# read user with properties
created_user_properties = await created_user.read()
read_user = created_db.get_user_client(created_user_properties)
self.assertEqual(read_user.id, created_user.id)
created_permission = await created_user.create_permission({
'id': 'all permission' + str(uuid.uuid4()),
'permissionMode': documents.PermissionMode.All,
'resource': created_container.container_link,
'resourcePartitionKey': [1]
})
# read permission with id
read_permission = await created_user.get_permission(created_permission.id)
self.assertEqual(read_permission.id, created_permission.id)
# read permission with instance
read_permission = await created_user.get_permission(created_permission)
self.assertEqual(read_permission.id, created_permission.id)
# read permission with properties
read_permission = await created_user.get_permission(created_permission.properties)
self.assertEqual(read_permission.id, created_permission.id)
# Temporarily commenting analytical storage tests until emulator support comes.
# def test_create_container_with_analytical_store_off(self):
# # don't run test, for the time being, if running against the emulator
# if 'localhost' in self.host or '127.0.0.1' in self.host:
# return
# created_db = self.databaseForTest
# collection_id = 'test_create_container_with_analytical_store_off_' + str(uuid.uuid4())
# collection_indexing_policy = {'indexingMode': 'consistent'}
# created_recorder = RecordDiagnostics()
# created_collection = created_db.create_container(id=collection_id,
# indexing_policy=collection_indexing_policy,
# partition_key=PartitionKey(path="/pk", kind="Hash"),
# response_hook=created_recorder)
# properties = created_collection.read()
# ttl_key = "analyticalStorageTtl"
# self.assertTrue(ttl_key not in properties or properties[ttl_key] == None)
# def test_create_container_with_analytical_store_on(self):
# # don't run test, for the time being, if running against the emulator
# if 'localhost' in self.host or '127.0.0.1' in self.host:
# return
# created_db = self.databaseForTest
# collection_id = 'test_create_container_with_analytical_store_on_' + str(uuid.uuid4())
# collection_indexing_policy = {'indexingMode': 'consistent'}
# created_recorder = RecordDiagnostics()
# created_collection = created_db.create_container(id=collection_id,
# analytical_storage_ttl=-1,
# indexing_policy=collection_indexing_policy,
# partition_key=PartitionKey(path="/pk", kind="Hash"),
# response_hook=created_recorder)
# properties = created_collection.read()
# ttl_key = "analyticalStorageTtl"
# self.assertTrue(ttl_key in properties and properties[ttl_key] == -1)
# def test_create_container_if_not_exists_with_analytical_store_on(self):
# # don't run test, for the time being, if running against the emulator
# if 'localhost' in self.host or '127.0.0.1' in self.host:
# return
# # first, try when we know the container doesn't exist.
# created_db = self.databaseForTest
# collection_id = 'test_create_container_if_not_exists_with_analytical_store_on_' + str(uuid.uuid4())
# collection_indexing_policy = {'indexingMode': 'consistent'}
# created_recorder = RecordDiagnostics()
# created_collection = created_db.create_container_if_not_exists(id=collection_id,
# analytical_storage_ttl=-1,
# indexing_policy=collection_indexing_policy,
# partition_key=PartitionKey(path="/pk", kind="Hash"),
# response_hook=created_recorder)
# properties = created_collection.read()
# ttl_key = "analyticalStorageTtl"
# self.assertTrue(ttl_key in properties and properties[ttl_key] == -1)
# # next, try when we know the container DOES exist. This way both code paths are tested.
# created_collection = created_db.create_container_if_not_exists(id=collection_id,
# analytical_storage_ttl=-1,
# indexing_policy=collection_indexing_policy,
# partition_key=PartitionKey(path="/pk", kind="Hash"),
# response_hook=created_recorder)
# properties = created_collection.read()
# ttl_key = "analyticalStorageTtl"
# self.assertTrue(ttl_key in properties and properties[ttl_key] == -1)
async def _MockExecuteFunction(self, function, *args, **kwargs):
self.last_headers.append(args[4].headers[HttpHeaders.PartitionKey]
if HttpHeaders.PartitionKey in args[4].headers else '')
return await self.OriginalExecuteFunction(function, *args, **kwargs)
|