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 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261
//! Helpers and objects for building Goose load tests.
//!
//! Goose manages load tests with a series of objects:
//!
//! - [`GooseTaskSet`] each user is assigned a task set, which is a collection of tasks.
//! - [`GooseTask`] tasks define one or more web requests and are assigned to task sets.
//! - [`GooseUser`] a user state responsible for repeatedly running all tasks in the assigned task set.
//! - [`GooseRequestMetric`] optional metrics collected for each URL/method pair.
//!
//! ## Creating Task Sets
//!
//! A [`GooseTaskSet`](./struct.GooseTaskSet.html) is created by passing in a `&str` name to the `new` function, for example:
//!
//! ```rust
//! use goose::prelude::*;
//!
//! let mut loadtest_tasks = taskset!("LoadtestTasks");
//! ```
//!
//! ### Task Set Weight
//!
//! A weight can be applied to a task set, controlling how often it is assigned to
//! [`GooseUser`](../goose/struct.GooseUser.html) threads. The larger the integer value
//! of weight, the more the task set will be assigned to user threads. In the following
//! example, `FooTasks` will be assigned to users twice as often as `Bar` tasks. We could
//! have just added a weight of `2` to `FooTasks` and left the default weight of `1`
//! assigned to `BarTasks` for the same weighting:
//!
//! ```rust
//! use goose::prelude::*;
//!
//! #[tokio::main]
//! async fn main() -> Result<(), GooseError> {
//! let mut foo_tasks = taskset!("FooTasks").set_weight(10)?;
//! let mut bar_tasks = taskset!("BarTasks").set_weight(5)?;
//!
//! Ok(())
//! }
//! ```
//!
//! ### Task Set Host
//!
//! A default host can be assigned to a task set, which will be used only if the `--host`
//! CLI option is not set at run-time. For example, this can configure your load test to
//! run against your local development environment by default, allowing the `--host` option
//! to override host when you want to load test production. You can also assign different
//! hosts to different task sets if this is desirable:
//!
//! ```rust
//! use goose::prelude::*;
//!
//! let mut foo_tasks = taskset!("FooTasks").set_host("http://www.local");
//! let mut bar_tasks = taskset!("BarTasks").set_host("http://www2.local");
//! ```
//!
//! ### Task Set Wait Time
//!
//! Wait time is specified as a low-high Duration range. Each time a task completes in the
//! task set, the user will pause for a random number of milliseconds inclusively between
//! the low and high wait times. In the following example, users loading `foo` tasks will
//! sleep 0 to 2.5 seconds after each task completes, and users loading `bar` tasks will
//! sleep 5 to 10 seconds after each task completes.
//!
//! ```rust
//! use goose::prelude::*;
//! use std::time::Duration;
//!
//! let mut foo_tasks = taskset!("FooTasks").set_wait_time(Duration::from_secs(0), Duration::from_millis(2500)).unwrap();
//! let mut bar_tasks = taskset!("BarTasks").set_wait_time(Duration::from_secs(5), Duration::from_secs(10)).unwrap();
//! ```
//! ## Creating Tasks
//!
//! A [`GooseTask`](./struct.GooseTask.html) must include a pointer to a function which
//! will be executed each time the task is run.
//!
//! ```rust
//! use goose::prelude::*;
//!
//! let mut a_task = task!(task_function);
//!
//! /// A very simple task that loads the front page.
//! async fn task_function(user: &mut GooseUser) -> GooseTaskResult {
//! let _goose = user.get("").await?;
//!
//! Ok(())
//! }
//! ```
//!
//! ### Task Name
//!
//! A name can be assigned to a task, and will be displayed in metrics about all requests
//! made by the task.
//!
//! ```rust
//! use goose::prelude::*;
//!
//! let mut a_task = task!(task_function).set_name("a");
//!
//! /// A very simple task that loads the front page.
//! async fn task_function(user: &mut GooseUser) -> GooseTaskResult {
//! let _goose = user.get("").await?;
//!
//! Ok(())
//! }
//! ```
//!
//! ### Task Weight
//!
//! Individual tasks can be assigned a weight, controlling how often the task runs. The
//! larger the value of weight, the more it will run. In the following example, `a_task`
//! runs 3 times as often as `b_task`:
//!
//! ```rust
//! use goose::prelude::*;
//!
//! #[tokio::main]
//! async fn main() -> Result<(), GooseError> {
//! let mut a_task = task!(a_task_function).set_weight(9)?;
//! let mut b_task = task!(b_task_function).set_weight(3)?;
//!
//! Ok(())
//! }
//!
//! /// A very simple task that loads the "a" page.
//! async fn a_task_function(user: &mut GooseUser) -> GooseTaskResult {
//! let _goose = user.get("a/").await?;
//!
//! Ok(())
//! }
//!
//! /// Another very simple task that loads the "b" page.
//! async fn b_task_function(user: &mut GooseUser) -> GooseTaskResult {
//! let _goose = user.get("b/").await?;
//!
//! Ok(())
//! }
//! ```
//!
//! ### Task Sequence
//!
//! Tasks can also be configured to run in a sequence. For example, a task with a sequence
//! value of `1` will always run before a task with a sequence value of `2`. Weight can
//! be applied to sequenced tasks, so for example a task with a weight of `2` and a sequence
//! of `1` will run two times before a task with a sequence of `2`. Task sets can contain
//! tasks with sequence values and without sequence values, and in this case all tasks with
//! a sequence value will run before tasks without a sequence value. In the following example,
//! `a_task` runs before `b_task`, which runs before `c_task`:
//!
//! ```rust
//! use goose::prelude::*;
//!
//! let mut a_task = task!(a_task_function).set_sequence(1);
//! let mut b_task = task!(b_task_function).set_sequence(2);
//! let mut c_task = task!(c_task_function);
//!
//! /// A very simple task that loads the "a" page.
//! async fn a_task_function(user: &mut GooseUser) -> GooseTaskResult {
//! let _goose = user.get("a/").await?;
//!
//! Ok(())
//! }
//!
//! /// Another very simple task that loads the "b" page.
//! async fn b_task_function(user: &mut GooseUser) -> GooseTaskResult {
//! let _goose = user.get("b/").await?;
//!
//! Ok(())
//! }
//!
//! /// Another very simple task that loads the "c" page.
//! async fn c_task_function(user: &mut GooseUser) -> GooseTaskResult {
//! let _goose = user.get("c/").await?;
//!
//! Ok(())
//! }
//! ```
//!
//! ### Task On Start
//!
//! Tasks can be flagged to only run when a user first starts. This can be useful if you'd
//! like your load test to use a logged-in user. It is possible to assign sequences and weights
//! to [`on_start`](./struct.GooseTask.html#method.set_on_start) functions if you want to have
//! multiple tasks run in a specific order at start time, and/or the tasks to run multiple times.
//! A task can be flagged to run both on start and on stop.
//!
//! ```rust
//! use goose::prelude::*;
//!
//! let mut a_task = task!(a_task_function).set_sequence(1).set_on_start();
//!
//! /// A very simple task that loads the "a" page.
//! async fn a_task_function(user: &mut GooseUser) -> GooseTaskResult {
//! let _goose = user.get("a/").await?;
//!
//! Ok(())
//! }
//! ```
//!
//! ### Task On Stop
//!
//! Tasks can be flagged to only run when a user stops. This can be useful if you'd like your
//! load test to simulate a user logging out when it finishes. It is possible to assign sequences
//! and weights to [`on_stop`](./struct.GooseTask.html#method.set_on_stop) functions if you want to
//! have multiple tasks run in a specific order at stop time, and/or the tasks to run multiple
//! times. A task can be flagged to run both on start and on stop.
//!
//! ```rust
//! use goose::prelude::*;
//!
//! let mut b_task = task!(b_task_function).set_sequence(2).set_on_stop();
//!
//! /// Another very simple task that loads the "b" page.
//! async fn b_task_function(user: &mut GooseUser) -> GooseTaskResult {
//! let _goose = user.get("b/").await?;
//!
//! Ok(())
//! }
//! ```
//!
//! ## Controlling User
//!
//! When Goose starts, it creates one or more [`GooseUser`](./struct.GooseUser.html)s,
//! assigning a single [`GooseTaskSet`](./struct.GooseTaskSet.html) to each. This user is
//! then used to generate load. Behind the scenes, Goose is leveraging the
//! [`reqwest::client`](https://docs.rs/reqwest/*/reqwest/struct.Client.html)
//! to load web pages, and Goose can therefor do anything [`reqwest`](https://docs.rs/reqwest/)
//! can do.
//!
//! The most common request types are [`GET`](./struct.GooseUser.html#method.get) and
//! [`POST`](./struct.GooseUser.html#method.post), but [`HEAD`](./struct.GooseUser.html#method.head),
//! PUT, PATCH and [`DELETE`](./struct.GooseUser.html#method.delete) are also supported.
//!
//! ### GET
//!
//! A helper to make a `GET` request of a path and collect relevant metrics.
//! Automatically prepends the correct host.
//!
//! ```rust
//! use goose::prelude::*;
//!
//! let mut task = task!(get_function);
//!
//! /// A very simple task that makes a GET request.
//! async fn get_function(user: &mut GooseUser) -> GooseTaskResult {
//! let _goose = user.get("path/to/foo/").await?;
//!
//! Ok(())
//! }
//! ```
//!
//! The returned response is a [`reqwest::Response`](https://docs.rs/reqwest/*/reqwest/struct.Response.html)
//! struct. You can use it as you would any Reqwest Response.
//!
//!
//! ### POST
//!
//! A helper to make a `POST` request of a string value to the path and collect relevant
//! metrics. Automatically prepends the correct host. The returned response is a
//! [`reqwest::Response`](https://docs.rs/reqwest/*/reqwest/struct.Response.html)
//!
//! ```rust
//! use goose::prelude::*;
//!
//! let mut task = task!(post_function);
//!
//! /// A very simple task that makes a POST request.
//! async fn post_function(user: &mut GooseUser) -> GooseTaskResult {
//! let _goose = user.post("path/to/foo/", "string value to post").await?;
//!
//! Ok(())
//! }
//! ```
//!
//! ## License
//!
//! Copyright 2020 Jeremy Andrews
//!
//! Licensed under the Apache License, Version 2.0 (the "License");
//! you may not use this file except in compliance with the License.
//! You may obtain a copy of the License at
//!
//! <http://www.apache.org/licenses/LICENSE-2.0>
//!
//! Unless required by applicable law or agreed to in writing, software
//! distributed under the License is distributed on an "AS IS" BASIS,
//! WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//! See the License for the specific language governing permissions and
//! limitations under the License.
use downcast_rs::{impl_downcast, Downcast};
use http::method::Method;
use reqwest::{header, Client, ClientBuilder, RequestBuilder, Response};
use serde::{Deserialize, Serialize};
use std::hash::{Hash, Hasher};
use std::sync::Arc;
use std::time::Duration;
use std::{fmt, str};
use std::{future::Future, pin::Pin, time::Instant};
use tokio::sync::RwLock;
use url::Url;
use crate::logger::GooseLog;
use crate::metrics::{
GooseCoordinatedOmissionMitigation, GooseMetric, GooseRawRequest, GooseRequestMetric,
};
use crate::{GooseConfiguration, GooseError, WeightedGooseTasks};
/// By default Goose sets the following User-Agent header when making requests.
static APP_USER_AGENT: &str = concat!(env!("CARGO_PKG_NAME"), "/", env!("CARGO_PKG_VERSION"));
/// `task!(foo)` expands to `GooseTask::new(foo)`, but also does some boxing to work around a limitation in the compiler.
#[macro_export]
macro_rules! task {
($task_func:ident) => {
GooseTask::new(std::sync::Arc::new(move |s| {
std::boxed::Box::pin($task_func(s))
}))
};
}
/// `taskset!("foo")` expands to `GooseTaskSet::new("foo")`.
#[macro_export]
macro_rules! taskset {
($name:tt) => {
GooseTaskSet::new($name)
};
}
/// Goose tasks return a result, which is empty on success, or contains a
/// [`GooseTaskError`](./enum.GooseTaskError.html) on error.
pub type GooseTaskResult = Result<(), GooseTaskError>;
/// An enumeration of all errors a [`GooseTask`](./struct.GooseTask.html) can return.
#[derive(Debug)]
pub enum GooseTaskError {
/// Wraps a [`reqwest::Error`](https://docs.rs/reqwest/*/reqwest/struct.Error.html).
Reqwest(reqwest::Error),
/// Wraps a [`url::ParseError`](https://docs.rs/url/*/url/enum.ParseError.html).
Url(url::ParseError),
/// The request failed.
RequestFailed {
/// The [`GooseRequestMetric`](./struct.GooseRequestMetric.html) that failed.
raw_request: GooseRequestMetric,
},
/// The request was canceled. This happens when the throttle is enabled and the load
/// test finishes.
RequestCanceled {
/// Wraps a [`flume::SendError`](https://docs.rs/flume/*/flume/struct.SendError.html),
/// a [`GooseRequestMetric`](./struct.GooseRequestMetric.html) has not yet been constructed.
source: flume::SendError<bool>,
},
/// There was an error sending the metrics for a request to the parent thread.
MetricsFailed {
/// Wraps a [`flume::SendError`](https://docs.rs/flume/*/flume/struct.SendError.html),
/// which contains the [`GooseMetric`](../metrics/enum.GooseMetric.html) that wasn't sent.
source: flume::SendError<GooseMetric>,
},
/// There was an error sending debug information to the logger thread.
LoggerFailed {
/// Wraps a [`flume::SendError`](https://docs.rs/flume/*/flume/struct.SendError.html),
/// which contains the [`GooseDebug`](./struct.GooseDebug.html) that wasn't sent.
source: flume::SendError<Option<GooseLog>>,
},
/// Attempted an unrecognized HTTP request method.
InvalidMethod {
/// The unrecognized HTTP request method.
method: Method,
},
}
/// Implement a helper to provide a text description of all possible types of errors.
impl GooseTaskError {
fn describe(&self) -> &str {
match *self {
GooseTaskError::Reqwest(_) => "reqwest::Error",
GooseTaskError::Url(_) => "url::ParseError",
GooseTaskError::RequestFailed { .. } => "request failed",
GooseTaskError::RequestCanceled { .. } => {
"request canceled because throttled load test ended"
}
GooseTaskError::MetricsFailed { .. } => "failed to send metrics to parent thread",
GooseTaskError::LoggerFailed { .. } => "failed to send log message to logger thread",
GooseTaskError::InvalidMethod { .. } => "unrecognized HTTP request method",
}
}
}
/// Implement format trait to allow displaying errors.
impl fmt::Display for GooseTaskError {
// Implement display of error with `{}` marker.
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
match *self {
GooseTaskError::Reqwest(ref source) => {
write!(f, "GooseTaskError: {} ({})", self.describe(), source)
}
GooseTaskError::Url(ref source) => {
write!(f, "GooseTaskError: {} ({})", self.describe(), source)
}
GooseTaskError::RequestCanceled { ref source } => {
write!(f, "GooseTaskError: {} ({})", self.describe(), source)
}
GooseTaskError::MetricsFailed { ref source } => {
write!(f, "GooseTaskError: {} ({})", self.describe(), source)
}
GooseTaskError::LoggerFailed { ref source } => {
write!(f, "GooseTaskError: {} ({})", self.describe(), source)
}
_ => write!(f, "GooseTaskError: {}", self.describe()),
}
}
}
// Define the lower level source of this error, if any.
impl std::error::Error for GooseTaskError {
fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
match *self {
GooseTaskError::Reqwest(ref source) => Some(source),
GooseTaskError::Url(ref source) => Some(source),
GooseTaskError::RequestCanceled { ref source } => Some(source),
GooseTaskError::MetricsFailed { ref source } => Some(source),
GooseTaskError::LoggerFailed { ref source } => Some(source),
_ => None,
}
}
}
/// Auto-convert Reqwest errors.
impl From<reqwest::Error> for GooseTaskError {
fn from(err: reqwest::Error) -> GooseTaskError {
GooseTaskError::Reqwest(err)
}
}
/// Auto-convert Url errors.
impl From<url::ParseError> for GooseTaskError {
fn from(err: url::ParseError) -> GooseTaskError {
GooseTaskError::Url(err)
}
}
/// When the throttle is enabled and the load test ends, the throttle channel is
/// shut down. This causes a
/// [`flume::SendError`](https://docs.rs/flume/*/flume/struct.SendError.html),
/// which gets automatically converted to `RequestCanceled`.
/// [`RequestCanceled`](./enum.GooseTaskError.html#variant.RequestCanceled)
impl From<flume::SendError<bool>> for GooseTaskError {
fn from(source: flume::SendError<bool>) -> GooseTaskError {
GooseTaskError::RequestCanceled { source }
}
}
/// Attempt to send metrics to the parent thread failed.
impl From<flume::SendError<GooseMetric>> for GooseTaskError {
fn from(source: flume::SendError<GooseMetric>) -> GooseTaskError {
GooseTaskError::MetricsFailed { source }
}
}
/// Attempt to send logs to the logger thread failed.
impl From<flume::SendError<Option<GooseLog>>> for GooseTaskError {
fn from(source: flume::SendError<Option<GooseLog>>) -> GooseTaskError {
GooseTaskError::LoggerFailed { source }
}
}
/// An individual task set.
#[derive(Clone, Hash)]
pub struct GooseTaskSet {
/// The name of the task set.
pub name: String,
/// An integer reflecting where this task set lives in the internal
/// [`GooseAttack`](../struct.GooseAttack.html)`.task_sets` vector.
pub task_sets_index: usize,
/// An integer value that controls the frequency that this task set will be assigned to a user.
pub weight: usize,
/// A [`Duration`](https://doc.rust-lang.org/std/time/struct.Duration.html) range defining the
/// minimum and maximum time a [`GooseUser`] should sleep after running a task.
pub task_wait: Option<(Duration, Duration)>,
/// A vector containing one copy of each [`GooseTask`](./struct.GooseTask.html) that will
/// run by users running this task set.
pub tasks: Vec<GooseTask>,
/// A fully scheduled and weighted vector of integers (pointing to
/// [`GooseTask`](./struct.GooseTask.html)s and [`GooseTask`](./struct.GooseTask.html) names.
pub weighted_tasks: WeightedGooseTasks,
/// A vector of vectors of integers, controlling the sequence and order
/// [`on_start`](./struct.GooseTask.html#method.set_on_start)
/// [`GooseTask`](./struct.GooseTask.html)s are run when the user first starts.
pub weighted_on_start_tasks: WeightedGooseTasks,
/// A vector of vectors of integers, controlling the sequence and order
/// [`on_stop`](./struct.GooseTask.html#method.set_on_stop)
/// [`GooseTask`](./struct.GooseTask.html)s are run when the user first starts.
pub weighted_on_stop_tasks: WeightedGooseTasks,
/// An optional default host to run this `GooseTaskSet` against.
pub host: Option<String>,
}
impl GooseTaskSet {
/// Creates a new [`GooseTaskSet`](./struct.GooseTaskSet.html). Once created, a
/// [`GooseTask`](./struct.GooseTask.html) must be assigned to it, and finally it must
/// be registered with the [`GooseAttack`](../struct.GooseAttack.html) object. The
/// returned object must be stored in a mutable value.
///
/// # Example
/// ```rust
/// use goose::prelude::*;
///
/// let mut example_tasks = taskset!("ExampleTasks");
/// ```
pub fn new(name: &str) -> Self {
trace!("new taskset: name: {}", &name);
GooseTaskSet {
name: name.to_string(),
task_sets_index: usize::max_value(),
weight: 1,
task_wait: None,
tasks: Vec::new(),
weighted_tasks: Vec::new(),
weighted_on_start_tasks: Vec::new(),
weighted_on_stop_tasks: Vec::new(),
host: None,
}
}
/// Registers a [`GooseTask`](./struct.GooseTask.html) with a
/// [`GooseTaskSet`](./struct.GooseTaskSet.html), where it is stored in the
/// [`GooseTaskSet`](./struct.GooseTaskSet.html)`.tasks` vector. The function
/// associated with the task will be run during the load test.
///
/// # Example
/// ```rust
/// use goose::prelude::*;
///
/// let mut example_tasks = taskset!("ExampleTasks");
/// example_tasks.register_task(task!(a_task_function));
///
/// /// A very simple task that loads the "a" page.
/// async fn a_task_function(user: &mut GooseUser) -> GooseTaskResult {
/// let _goose = user.get("a/").await?;
///
/// Ok(())
/// }
/// ```
pub fn register_task(mut self, mut task: GooseTask) -> Self {
trace!("{} register_task: {}", self.name, task.name);
task.tasks_index = self.tasks.len();
self.tasks.push(task);
self
}
/// Sets a weight on a task set. The larger the value of weight, the more often the task set will
/// be assigned to users. For example, if you have task set foo with a weight of 3, and task set
/// bar with a weight of 1, and you spin up a load test with 8 users, 6 of them will be running
/// the foo task set, and 2 will be running the bar task set.
///
/// # Example
/// ```rust
/// use goose::prelude::*;
///
/// #[tokio::main]
/// async fn main() -> Result<(), GooseError> {
/// let mut example_tasks = taskset!("ExampleTasks").set_weight(3)?;
///
/// Ok(())
/// }
/// ```
pub fn set_weight(mut self, weight: usize) -> Result<Self, GooseError> {
trace!("{} set_weight: {}", self.name, weight);
if weight == 0 {
return Err(GooseError::InvalidWeight {
weight,
detail: ("Weight must be set to at least 1.".to_string()),
});
}
self.weight = weight;
Ok(self)
}
/// Set a default host for the task set. If no `--host` flag is set when running the load test, this
/// host will be pre-pended on all requests. For example, this can configure your load test to run
/// against your local development environment by default, and the `--host` option could be used to
/// override host when running the load test against production.
///
/// # Example
/// ```rust
/// use goose::prelude::*;
///
/// let mut example_tasks = taskset!("ExampleTasks").set_host("http://10.1.1.42");
/// ```
pub fn set_host(mut self, host: &str) -> Self {
trace!("{} set_host: {}", self.name, host);
// Host validation happens in main() at startup.
self.host = Some(host.to_string());
self
}
/// Configure a task_set to to pause after running each task. The length of the pause will be randomly
/// selected from `min_wait` to `max_wait` inclusively.
///
/// # Example
/// ```rust
/// use goose::prelude::*;
/// use std::time::Duration;
///
/// #[tokio::main]
/// async fn main() -> Result<(), GooseError> {
/// taskset!("ExampleTasks").set_wait_time(Duration::from_secs(0), Duration::from_secs(1))?;
///
/// Ok(())
/// }
/// ```
pub fn set_wait_time(
mut self,
min_wait: Duration,
max_wait: Duration,
) -> Result<Self, GooseError> {
trace!(
"{} set_wait time: min: {:?} max: {:?}",
self.name,
min_wait,
max_wait
);
if min_wait.as_millis() > max_wait.as_millis() {
return Err(GooseError::InvalidWaitTime {
min_wait,
max_wait,
detail:
"The min_wait option can not be set to a larger value than the max_wait option."
.to_string(),
});
}
self.task_wait = Some((min_wait, max_wait));
Ok(self)
}
}
/// Commands sent from the parent thread to the user threads, and from the manager to the
/// worker processes.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub enum GooseUserCommand {
/// Tell worker process to pause load test.
Wait,
/// Tell worker process to start load test.
Run,
/// Tell user thread or worker process to exit.
Exit,
}
/// Supported HTTP methods.
#[derive(Debug, Clone, Eq, PartialEq, Serialize, Deserialize, Ord, PartialOrd)]
pub enum GooseMethod {
Delete,
Get,
Head,
Patch,
Post,
Put,
}
/// Display method in upper case.
impl fmt::Display for GooseMethod {
// Implement display of `GooseMethod` with `{}` marker.
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
match self {
GooseMethod::Delete => write!(f, "DELETE"),
GooseMethod::Get => write!(f, "GET"),
GooseMethod::Head => write!(f, "HEAD"),
GooseMethod::Patch => write!(f, "PATCH"),
GooseMethod::Post => write!(f, "POST"),
GooseMethod::Put => write!(f, "PUT"),
}
}
}
/// Convert [`http::method::Method`](https://docs.rs/http/*/http/method/struct.Method.html)
/// to [`GooseMethod`](./enum.GooseMethod.html).
pub fn goose_method_from_method(method: Method) -> Result<GooseMethod, GooseTaskError> {
Ok(match method {
Method::DELETE => GooseMethod::Delete,
Method::GET => GooseMethod::Get,
Method::HEAD => GooseMethod::Head,
Method::PATCH => GooseMethod::Patch,
Method::POST => GooseMethod::Post,
Method::PUT => GooseMethod::Put,
_ => {
return Err(GooseTaskError::InvalidMethod { method });
}
})
}
/// The response to a [`GooseRequestMetric`].
#[derive(Debug)]
pub struct GooseResponse {
/// The request that this is a response to.
pub request: GooseRequestMetric,
/// The response.
pub response: Result<Response, reqwest::Error>,
}
impl GooseResponse {
pub fn new(request: GooseRequestMetric, response: Result<Response, reqwest::Error>) -> Self {
GooseResponse { request, response }
}
}
/// Object created by [`log_debug()`](struct.GooseUser.html#method.log_debug) and written
/// to log to assist in debugging.
#[derive(Debug, Deserialize, Serialize)]
pub struct GooseDebug {
/// String to identify the source of the log message.
pub tag: String,
/// Optional request made.
pub request: Option<GooseRequestMetric>,
/// Optional headers returned by server.
pub header: Option<String>,
/// Optional body text returned by server.
pub body: Option<String>,
}
impl GooseDebug {
fn new(
tag: &str,
request: Option<&GooseRequestMetric>,
header: Option<&header::HeaderMap>,
body: Option<&str>,
) -> Self {
GooseDebug {
// Convert tag from &str to string.
tag: tag.to_string(),
// If request is defined, clone it.
request: request.cloned(),
// If header is defined, convert it to a string.
header: header.map(|h| format!("{:?}", h)),
// If header is defined, convert from &str to string.
body: body.map(|b| b.to_string()),
}
}
}
/// The elements needed to build an individual user state on a Gaggle Worker.
#[derive(Debug, Clone)]
pub struct GaggleUser {
/// An index into the internal [`GooseAttack`](../struct.GooseAttack.html)`.task_sets`
/// vector, indicating which [`GooseTaskSet`](./struct.GooseTaskSet.html) is running.
pub task_sets_index: usize,
/// The base URL to prepend to all relative paths.
pub base_url: Arc<RwLock<Url>>,
/// A local copy of the global GooseConfiguration.
pub config: GooseConfiguration,
/// Load test hash.
pub load_test_hash: u64,
}
impl GaggleUser {
/// Create a new user state.
pub fn new(
task_sets_index: usize,
base_url: Url,
configuration: &GooseConfiguration,
load_test_hash: u64,
) -> Self {
trace!("new gaggle user");
GaggleUser {
task_sets_index,
base_url: Arc::new(RwLock::new(base_url)),
config: configuration.clone(),
load_test_hash,
}
}
}
/// Used internally by Coordinated Omission Mitigation, tracks the cadence between when the same request
/// is made as Goose loops through a GooseTaskSet.
#[derive(Debug, Clone)]
struct GooseRequestCadence {
/// The last time this GooseUser lopped through its GooseTasks.
last_time: std::time::Instant,
/// Total milliseconds of delays followed each GooseTask. This has to be substracted out as it's
/// not impacted by the upstream server and it can change randomly affecting the cadence.
delays_since_last_time: u64,
/// How many times this GooseUser has looped through all of its GooseTasks.
counter: u64,
/// The minimum time taken to loop through all GooseTasks.
minimum_cadence: u64,
/// The maximum time taken to loop through all GooseTasks.
maximum_cadence: u64,
/// Average amount of time taken to loop through all GooseTasks.
average_cadence: u64,
/// Total amount of time spent processing GooseTasks.
total_elapsed: u64,
/// If non-zero, the length of the server slowdown detected by the Goose Coordinated
/// Omission Mitigation in milliseconds.
coordinated_omission_mitigation: u64,
/// The expected cadence to loop through all GooseTasks.
user_cadence: u64,
/// If -1 coordinated_omission_mitigation was never enabled. Otherwise is a counter of how
/// many times the mitigation triggered.
coordinated_omission_counter: isize,
}
impl GooseRequestCadence {
// Return a new, empty RequestCadence object.
fn new() -> GooseRequestCadence {
GooseRequestCadence {
last_time: std::time::Instant::now(),
delays_since_last_time: 0,
counter: 0,
minimum_cadence: 0,
maximum_cadence: 0,
average_cadence: 0,
total_elapsed: 0,
coordinated_omission_mitigation: 0,
user_cadence: 0,
coordinated_omission_counter: -1,
}
}
}
/// A marker trait representing user data of any type
/// ([generic](https://doc.rust-lang.org/rust-by-example/generics.html)) that can
/// be added to any [`GooseUser`](../goose/struct.GooseUser.html). The format of
/// the data stored in `GooseUserData` must be defined in your load test, and by
/// default supports any type that supports
/// [`Send`](https://doc.rust-lang.org/std/marker/trait.Send.html) and
/// [`Sync`](https://doc.rust-lang.org/std/marker/trait.Sync.html).
///
/// Stored in the [`GooseUser`] object in a private `session_data` field. Per-user
/// session data is stored by invoking [`GooseUser::set_session_data`]. The session
/// data can be accessed by invoking [`GooseUser::get_session_data`],
/// [`GooseUser::get_session_data_mut`], [`GooseUser::get_session_data_unchecked`],
/// or [`GooseUser::get_session_data_unchecked_mut`].
///
/// For an example, see
/// [`examples/simple_with_session`](https://github.com/tag1consulting/goose/blob/main/examples/simple_with_session.rs).
pub trait GooseUserData: Downcast + Send + Sync + 'static {}
impl_downcast!(GooseUserData);
impl<T: Send + Sync + 'static> GooseUserData for T {}
/// An individual user state, repeatedly running all [`GooseTask`](./struct.GooseTask.html)s
/// in a specific [`GooseTaskSet`](./struct.GooseTaskSet.html).
pub struct GooseUser {
/// The Instant when this `GooseUser` client started.
pub started: Instant,
/// An index into the internal [`GooseAttack`](../struct.GooseAttack.html)`.task_sets`
/// vector, indicating which [`GooseTaskSet`](./struct.GooseTaskSet.html) is running.
pub task_sets_index: usize,
/// Client used to make requests, managing sessions and cookies.
pub client: Client,
/// The base URL to prepend to all relative paths.
pub base_url: Url,
/// A local copy of the global [`GooseConfiguration`](../struct.GooseConfiguration.html).
pub config: GooseConfiguration,
/// Channel to logger.
pub logger: Option<flume::Sender<Option<GooseLog>>>,
/// Channel to throttle.
pub throttle: Option<flume::Sender<bool>>,
/// Normal tasks are optionally throttled,
/// [`test_start`](../struct.GooseAttack.html#method.test_start) and
/// [`test_stop`](../struct.GooseAttack.html#method.test_stop) tasks are not.
pub is_throttled: bool,
/// Channel to parent.
pub channel_to_parent: Option<flume::Sender<GooseMetric>>,
/// An index into the internal [`GooseAttack`](../struct.GooseAttack.html)`.weighted_users`
/// vector, indicating which weighted `GooseUser` is running.
pub weighted_users_index: usize,
/// Load test hash.
pub load_test_hash: u64,
/// Tracks the cadence that this user is looping through all GooseTasks, used by Coordinated
/// Omission Mitigation.
request_cadence: GooseRequestCadence,
/// Tracks how much time is spent sleeping during a loop through all tasks.
pub(crate) slept: u64,
/// Current task name.
pub(crate) task_name: Option<String>,
/// Optional per-user session data of a generic type implementing the
/// [`GooseUserData`] trait.
session_data: Option<Box<dyn GooseUserData>>,
}
impl GooseUser {
/// Create a new user state.
pub fn new(
task_sets_index: usize,
base_url: Url,
configuration: &GooseConfiguration,
load_test_hash: u64,
) -> Result<Self, GooseError> {
trace!("new GooseUser");
let client = Client::builder()
.user_agent(APP_USER_AGENT)
.cookie_store(true)
// Enable gzip unless `--no-gzip` flag is enabled.
.gzip(!configuration.no_gzip)
.build()?;
Ok(GooseUser {
started: Instant::now(),
task_sets_index,
client,
base_url,
config: configuration.clone(),
logger: None,
throttle: None,
is_throttled: true,
channel_to_parent: None,
// A value of max_value() indicates this user isn't fully initialized yet.
weighted_users_index: usize::max_value(),
load_test_hash,
request_cadence: GooseRequestCadence::new(),
slept: 0,
task_name: None,
session_data: None,
})
}
/// Create a new single-use user.
pub fn single(base_url: Url, configuration: &GooseConfiguration) -> Result<Self, GooseError> {
let mut single_user = GooseUser::new(0, base_url, configuration, 0)?;
// Only one user, so index is 0.
single_user.weighted_users_index = 0;
// Do not throttle [`test_start`](../struct.GooseAttack.html#method.test_start) (setup) and
// [`test_stop`](../struct.GooseAttack.html#method.test_stop) (teardown) tasks.
single_user.is_throttled = false;
Ok(single_user)
}
/// Returns an optional reference to per-[`GooseUser`] session data.
///
/// Leaves the session data in-place, returning an optional reference to the
/// original session data if existing and of the correct type. Returns [`None`]
/// if no session data has been set or the session data set is not of type `T`.
///
/// # Example
/// ```rust
/// use goose::prelude::*;
///
/// struct Foo(String);
///
/// let mut task = task!(get_session_data_function);
///
/// /// A very simple task that makes a GET request.
/// async fn get_session_data_function(user: &mut GooseUser) -> GooseTaskResult {
/// let foo = user.get_session_data::<Foo>().expect("Missing session data!");
/// println!("Session data: {}", foo.0);
///
/// Ok(())
/// }
/// ```
pub fn get_session_data<T: GooseUserData>(&self) -> Option<&T> {
match &self.session_data {
Some(data) => data.downcast_ref::<T>(),
None => None,
}
}
/// Returns a reference to per-[`GooseUser`] session data, without doing any
/// validation that the session data exists and is of the correct type.
///
/// Leaves the session data in-place, returning a reference to the original
/// session data. Calling this method on a [`GooseUser`] object without
/// session data or with a different type `T` will panic.
///
/// For a safe alternative see [`GooseUser::get_session_data`].
///
/// # Example
/// ```rust
/// use goose::prelude::*;
///
/// struct Foo(String);
///
/// let mut task = task!(get_session_data_unchecked_function);
///
/// /// A very simple task that makes a GET request.
/// async fn get_session_data_unchecked_function(user: &mut GooseUser) -> GooseTaskResult {
/// let foo = user.get_session_data_unchecked::<Foo>();
/// println!("Session data: {}", foo.0);
///
/// Ok(())
/// }
/// ```
pub fn get_session_data_unchecked<T: GooseUserData>(&self) -> &T {
let session_data = self.session_data.as_deref().expect("Missing session data!");
session_data
.downcast_ref::<T>()
.expect("Invalid session data!")
}
/// Returns an optional mutable reference to per-[`GooseUser`] session data.
///
/// Leaves the session data in-place, returning an optional mutable reference
/// to the original session data if existing and of the correct type. Returns
/// [`None`] if no session data has been set or the session data set is not of
/// type `T`.
///
/// # Example
/// ```rust
/// use goose::prelude::*;
///
/// struct Foo(String);
///
/// let mut task = task!(get_session_data_mut_function);
///
/// /// A very simple task that makes a GET request.
/// async fn get_session_data_mut_function(user: &mut GooseUser) -> GooseTaskResult {
/// let foo = user.get_session_data_mut::<Foo>().expect("Missing session data!");
/// foo.0 = "Bar".to_owned();
/// Ok(())
/// }
/// ```
pub fn get_session_data_mut<T: GooseUserData>(&mut self) -> Option<&mut T> {
match &mut self.session_data {
Some(data) => data.downcast_mut::<T>(),
None => None,
}
}
/// Returns a mutable reference to per-[`GooseUser`] session data, without
/// doing any validation that the session data exists and is of the correct
/// type.
///
/// Leaves the session data in-place, returning a mutable reference to the
/// original session data. Calling this method on a [`GooseUser`] object
/// without session data or with a different type `T` will panic.
///
/// For a safe alternative see [`GooseUser::get_session_data_mut`].
///
/// # Example
/// ```rust
/// use goose::prelude::*;
///
/// struct Foo(String);
///
/// let mut task = task!(get_session_data_unchecked_mut_function);
///
/// /// A very simple task that makes a GET request.
/// async fn get_session_data_unchecked_mut_function(user: &mut GooseUser) -> GooseTaskResult {
/// let foo = user.get_session_data_unchecked_mut::<Foo>();
/// foo.0 = "Bar".to_owned();
/// Ok(())
/// }
/// ```
pub fn get_session_data_unchecked_mut<T: GooseUserData>(&mut self) -> &mut T {
let session_data = self
.session_data
.as_deref_mut()
.expect("Missing session data!");
session_data
.downcast_mut::<T>()
.expect("Invalid session data!")
}
/// Sets session data for the current [`GooseUser`].
///
/// If session data already exists for the current [`GooseUser`], it will be
/// replaced. Session data must be of a type implementing the
/// [`GooseUserData`] trait.
///
/// # Example
/// ```rust
/// use goose::prelude::*;
///
/// struct Foo(String);
///
/// let mut task = task!(set_session_data_function);
///
/// /// A very simple task that makes a GET request.
/// async fn set_session_data_function(user: &mut GooseUser) -> GooseTaskResult {
/// user.set_session_data(Foo("Foo".to_string()));
///
/// Ok(())
/// }
/// ```
pub fn set_session_data<T: GooseUserData>(&mut self, data: T) {
self.session_data.replace(Box::new(data));
}
/// A helper that prepends a `base_url` to all relative paths.
///
/// A `base_url` is determined per user thread, using the following order
/// of precedence:
/// 1. `--host` (host specified on the command line when running load test)
/// 2. [`GooseTaskSet`](./struct.GooseTaskSet.html)`.host` (default host defined for the
/// current task set)
/// 3. [`GooseDefault::Host`](../config/enum.GooseDefault.html#variant.Host) (default host
/// defined for the current load test)
pub fn build_url(&self, path: &str) -> Result<String, GooseTaskError> {
// If URL includes a host, simply use it.
if let Ok(parsed_path) = Url::parse(path) {
if let Some(_host) = parsed_path.host() {
return Ok(path.to_string());
}
}
// Otherwise use the `base_url`.
Ok(self.base_url.join(path)?.to_string())
}
/// A helper to make a `GET` request of a path and collect relevant metrics.
/// Automatically prepends the correct host.
///
/// Calls to `get()` return a [`GooseResponse`](./struct.GooseResponse.html) object which
/// contains a copy of the request you made ([`GooseRequestMetric`](./struct.GooseRequestMetric.html)),
/// and the response ([`reqwest::Response`](https://docs.rs/reqwest/*/reqwest/struct.Response.html)).
///
/// If you need to set headers, change timeouts, or otherwise make use of the
/// [`reqwest::RequestBuilder`](https://docs.rs/reqwest/*/reqwest/struct.RequestBuilder.html)
/// object, refer to [`GooseUser::get_request_builder`].
///
/// # Example
/// GET a URL.
/// ```rust
/// use goose::prelude::*;
///
/// let mut task = task!(get_function);
///
/// /// A very simple task that makes a GET request.
/// async fn get_function(user: &mut GooseUser) -> GooseTaskResult {
/// let _goose = user.get("path/to/foo/").await?;
///
/// Ok(())
/// }
/// ```
pub async fn get(&mut self, path: &str) -> Result<GooseResponse, GooseTaskError> {
// GET path.
let goose_request = GooseRequest::builder()
.method(GooseMethod::Get)
.path(path)
.build();
// Make the request and return the GooseResponse.
Ok(self.request(goose_request).await?)
}
/// A helper to make a named `GET` request of a path and collect relevant metrics.
/// Automatically prepends the correct host.
///
/// Calls to `get_named()` return a [`GooseResponse`](./struct.GooseResponse.html) object which
/// contains a copy of the request you made ([`GooseRequestMetric`](./struct.GooseRequestMetric.html)),
/// and the response ([`reqwest::Response`](https://docs.rs/reqwest/*/reqwest/struct.Response.html)).
///
/// If you need to set headers, change timeouts, or otherwise make use of the
/// [`reqwest::RequestBuilder`](https://docs.rs/reqwest/*/reqwest/struct.RequestBuilder.html)
/// object, refer to [`GooseUser::get_request_builder`].
///
/// # Example
/// GET a URL and name the request in collected metrics.
/// ```rust
/// use goose::prelude::*;
///
/// let mut task = task!(get_function);
///
/// /// A very simple task that makes a GET request, naming it for metrics.
/// async fn get_function(user: &mut GooseUser) -> GooseTaskResult {
/// let _goose = user.get_named("path/to/foo/", "foo").await?;
///
/// Ok(())
/// }
/// ```
pub async fn get_named(
&mut self,
path: &str,
name: &str,
) -> Result<GooseResponse, GooseTaskError> {
// GET path named.
let goose_request = GooseRequest::builder()
.method(GooseMethod::Get)
.path(path)
.name(name)
.build();
// Make the request and return the GooseResponse.
Ok(self.request(goose_request).await?)
}
/// A helper to make a `POST` request of a path and collect relevant metrics.
/// Automatically prepends the correct host.
///
/// Calls to `post()` return a [`GooseResponse`](./struct.GooseResponse.html) object which
/// contains a copy of the request you made ([`GooseRequestMetric`](./struct.GooseRequestMetric.html)),
/// and the response ([`reqwest::Response`](https://docs.rs/reqwest/*/reqwest/struct.Response.html)).
///
/// If you need to set headers, change timeouts, or otherwise make use of the
/// [`reqwest::RequestBuilder`](https://docs.rs/reqwest/*/reqwest/struct.RequestBuilder.html)
/// object, refer to [`GooseUser::get_request_builder`].
///
/// # Example
/// POST an arbitrary body.
/// ```rust
/// use goose::prelude::*;
///
/// let mut task = task!(post_function);
///
/// /// A very simple task that makes a POST request.
/// async fn post_function(user: &mut GooseUser) -> GooseTaskResult {
/// let _goose = user.post("path/to/foo/", "BODY BEING POSTED").await?;
///
/// Ok(())
/// }
/// ```
pub async fn post<T: Into<reqwest::Body>>(
&mut self,
path: &str,
body: T,
) -> Result<GooseResponse, GooseTaskError> {
// Build a Reqwest RequestBuilder object.
let url = self.build_url(path)?;
let reqwest_request_builder = self.client.post(url);
// POST request.
let goose_request = GooseRequest::builder()
.method(GooseMethod::Post)
.set_request_builder(reqwest_request_builder.body(body))
.build();
// Make the request and return the GooseResponse.
Ok(self.request(goose_request).await?)
}
/// A helper to make a `POST` request of a form on a path and collect relevant metrics.
/// Automatically prepends the correct host.
///
/// Calls to `post_form()` return a [`GooseResponse`](./struct.GooseResponse.html) object which
/// contains a copy of the request you made ([`GooseRequestMetric`](./struct.GooseRequestMetric.html)),
/// and the response ([`reqwest::Response`](https://docs.rs/reqwest/*/reqwest/struct.Response.html)).
///
/// If you need to set headers, change timeouts, or otherwise make use of the
/// [`reqwest::RequestBuilder`](https://docs.rs/reqwest/*/reqwest/struct.RequestBuilder.html)
/// object, refer to [`GooseUser::get_request_builder`].
///
/// # Example
/// POST a form.
/// ```rust
/// use goose::prelude::*;
///
/// let mut task = task!(post_function);
///
/// /// A very simple task that POSTs form parameters.
/// async fn post_function(user: &mut GooseUser) -> GooseTaskResult {
/// let params = [("foo", "bar"), ("foo2", "bar2")];
/// let _goose = user.post_form("path/to/foo/", ¶ms).await?;
///
/// Ok(())
/// }
/// ```
pub async fn post_form<T: Serialize + ?Sized>(
&mut self,
path: &str,
form: &T,
) -> Result<GooseResponse, GooseTaskError> {
// Build a Reqwest RequestBuilder object.
let url = self.build_url(path)?;
let reqwest_request_builder = self.client.post(url);
// POST form request.
let goose_request = GooseRequest::builder()
.method(GooseMethod::Post)
.set_request_builder(reqwest_request_builder.form(&form))
.build();
// Make the request and return the GooseResponse.
Ok(self.request(goose_request).await?)
}
/// A helper to make a `POST` request of json on a path and collect relevant metrics.
/// Automatically prepends the correct host.
///
/// Calls to `post_json()` return a [`GooseResponse`](./struct.GooseResponse.html) object which
/// contains a copy of the request you made ([`GooseRequestMetric`](./struct.GooseRequestMetric.html)),
/// and the response ([`reqwest::Response`](https://docs.rs/reqwest/*/reqwest/struct.Response.html)).
///
/// If you need to set headers, change timeouts, or otherwise make use of the
/// [`reqwest::RequestBuilder`](https://docs.rs/reqwest/*/reqwest/struct.RequestBuilder.html)
/// object, refer to [`GooseUser::get_request_builder`].
///
/// # Example
/// POST an arbitrary JSON object.
/// ```rust
/// use goose::prelude::*;
///
/// let mut task = task!(post_function);
///
/// /// A very simple task that POSTs an arbitrary json object.
/// async fn post_function(user: &mut GooseUser) -> GooseTaskResult {
/// let json = &serde_json::json!({
/// "foo": "bar",
/// "foo2": "bar2"
/// });
/// let _goose = user.post_json("path/to/foo/", &json).await?;
///
/// Ok(())
/// }
/// ```
pub async fn post_json<T: Serialize + ?Sized>(
&mut self,
path: &str,
json: &T,
) -> Result<GooseResponse, GooseTaskError> {
// Build a Reqwest RequestBuilder object.
let url = self.build_url(path)?;
let reqwest_request_builder = self.client.post(url);
// POST json request.
let goose_request = GooseRequest::builder()
.method(GooseMethod::Post)
.set_request_builder(reqwest_request_builder.json(&json))
.build();
// Make the request and return the GooseResponse.
Ok(self.request(goose_request).await?)
}
/// A helper to make a `HEAD` request of a path and collect relevant metrics.
/// Automatically prepends the correct host.
///
/// Calls to `head()` return a [`GooseResponse`](./struct.GooseResponse.html) object which
/// contains a copy of the request you made ([`GooseRequestMetric`](./struct.GooseRequestMetric.html)),
/// and the response ([`reqwest::Response`](https://docs.rs/reqwest/*/reqwest/struct.Response.html)).
///
/// If you need to set headers, change timeouts, or otherwise make use of the
/// [`reqwest::RequestBuilder`](https://docs.rs/reqwest/*/reqwest/struct.RequestBuilder.html)
/// object, refer to [`GooseUser::get_request_builder`].
///
/// # Example
/// Make a HEAD request.
/// ```rust
/// use goose::prelude::*;
///
/// let mut task = task!(head_function);
///
/// /// A very simple task that makes a HEAD request.
/// async fn head_function(user: &mut GooseUser) -> GooseTaskResult {
/// let _goose = user.head("path/to/foo/").await?;
///
/// Ok(())
/// }
/// ```
pub async fn head(&mut self, path: &str) -> Result<GooseResponse, GooseTaskError> {
// HEAD request.
let goose_request = GooseRequest::builder()
.method(GooseMethod::Head)
.path(path)
.build();
// Make the request and return the GooseResponse.
Ok(self.request(goose_request).await?)
}
/// A helper to make a `DELETE` request of a path and collect relevant metrics.
/// Automatically prepends the correct host.
///
/// Calls to `delete()` return a [`GooseResponse`](./struct.GooseResponse.html) object which
/// contains a copy of the request you made ([`GooseRequestMetric`](./struct.GooseRequestMetric.html)),
/// and the response ([`reqwest::Response`](https://docs.rs/reqwest/*/reqwest/struct.Response.html)).
///
/// If you need to set headers, change timeouts, or otherwise make use of the
/// [`reqwest::RequestBuilder`](https://docs.rs/reqwest/*/reqwest/struct.RequestBuilder.html)
/// object, refer to [`GooseUser::get_request_builder`].
///
/// # Example
/// Make a DELETE request.
/// ```rust
/// use goose::prelude::*;
///
/// let mut task = task!(delete_function);
///
/// /// A very simple task that makes a DELETE request.
/// async fn delete_function(user: &mut GooseUser) -> GooseTaskResult {
/// let _goose = user.delete("path/to/foo/").await?;
///
/// Ok(())
/// }
/// ```
pub async fn delete(&mut self, path: &str) -> Result<GooseResponse, GooseTaskError> {
// DELETE request.
let goose_request = GooseRequest::builder()
.method(GooseMethod::Delete)
.path(path)
.build();
// Make the request and return the GooseResponse.
Ok(self.request(goose_request).await?)
}
/// Used to get a [`reqwest::RequestBuilder`] object. If no [`reqwest::RequestBuilder`] is
/// already defined in the [`GooseRequest`] passed to [`GooseUser::request`] it will automatically
/// invoke this function.
///
/// The HTTP request method must be defined as a [`GooseMethod`], and the path that will be requested
/// must be defined as a [`&str`].
///
/// It is possible to use this function to directly interact with the [`reqwest::RequestBuilder`]
/// object and the [`GooseRequest`] object during load tests. In the following example, we set a
/// timeout on the Request, and tell Goose to expect a 404 HTTP response status code.
///
/// # Example
/// Request a non-existent page, timing out after 500 milliseconds.
/// ```rust
/// use goose::prelude::*;
///
/// let mut task = task!(test_404);
///
/// async fn test_404(user: &mut GooseUser) -> GooseTaskResult {
/// use std::time::Duration;
///
/// // Manually interact with the Reqwest RequestBuilder object.
/// let request_builder = user.get_request_builder(&GooseMethod::Get, "no/such/path")?
/// // Configure the request to timeout if it takes longer than 500 milliseconds.
/// .timeout(Duration::from_millis(500));
///
/// // Manually build a GooseRequest.
/// let goose_request = GooseRequest::builder()
/// // Manually add our custom RequestBuilder object.
/// .set_request_builder(request_builder)
/// // Tell Goose to expect a 404 status code.
/// .expect_status_code(404)
/// // Turn the GooseRequestBuilder object into a GooseRequest.
/// .build();
///
/// // Finally make the actual request with our custom GooseRequest object.
/// let _goose = user.request(goose_request).await?;
///
/// Ok(())
/// }
/// ```
pub fn get_request_builder(
&self,
method: &GooseMethod,
path: &str,
) -> Result<RequestBuilder, GooseTaskError> {
// Prepend the `base_url` to all relative paths.
let url = self.build_url(path)?;
// Invoke appropriate Reqwest convenience function to generate an
// appropriate RequestBuilder.
Ok(match method {
GooseMethod::Delete => self.client.delete(&url),
GooseMethod::Get => self.client.get(&url),
GooseMethod::Head => self.client.head(&url),
GooseMethod::Patch => self.client.patch(&url),
GooseMethod::Post => self.client.post(&url),
GooseMethod::Put => self.client.put(&url),
})
}
/// Makes a request for the provided [`GooseRequest`] object, and if metrics are enabled
/// captures relevant metrics.
///
/// Calls to `request()` return a [`Result`] containing a [`GooseResponse`] on success, and a
/// [`flume::SendError`](https://docs.rs/flume/*/flume/struct.SendError.html)`<bool>`,
/// on failure. Failure only happens when `--throttle-requests` is enabled and the load test
/// completes. The [`GooseResponse`](./struct.GooseResponse.html) object contains a copy of
/// the request you made ([`GooseRequestMetric`](./struct.GooseRequestMetric.html)), and the
/// response ([`reqwest::Response`](https://docs.rs/reqwest/*/reqwest/struct.Response.html)).
///
/// # Example
/// Make a GET request.
/// ```rust
/// use goose::prelude::*;
///
/// let mut task = task!(get_function);
///
/// /// A simple task that makes a GET request.
/// async fn get_function(user: &mut GooseUser) -> GooseTaskResult {
/// let goose_request = GooseRequest::builder()
/// // Goose will prepend a host name to this path.
/// .path("path/to/loadtest")
/// // GET is the default method, this is not necessary.
/// .method(GooseMethod::Get)
/// // Assemble the `GooseRequestBuilder` into a `GooseRequest.
/// .build();
/// let goose = user.request(goose_request).await?;
///
/// // Do stuff with goose.request and/or goose.response here.
///
/// Ok(())
/// }
/// ```
pub async fn request<'a>(
&mut self,
mut request: GooseRequest<'_>,
) -> Result<GooseResponse, GooseTaskError> {
// If the RequestBuilder is already defined in the GooseRequest use it.
let request_builder = if request.request_builder.is_some() {
request.request_builder.take().unwrap()
// Otherwise get a new RequestBuilder.
} else {
self.get_request_builder(&request.method, request.path)?
};
// Determine the name for this request.
let request_name = self.get_request_name(&request);
// If throttle-requests is enabled...
if self.is_throttled && self.throttle.is_some() {
// ...wait until there's room to add a token to the throttle channel before proceeding.
debug!("GooseUser: waiting on throttle");
// Will result in GooseTaskError::RequestCanceled if this fails.
self.throttle.clone().unwrap().send_async(true).await?;
};
// Once past the throttle, the request is officially started.
let started = Instant::now();
// Create a Reqwest Request object from the RequestBuilder.
let built_request = request_builder.build()?;
// Get a string version of request path for logging.
let path = match Url::parse(&built_request.url().to_string()) {
Ok(u) => u.path().to_string(),
Err(e) => {
error!("failed to parse url: {}", e);
"".to_string()
}
};
// Grab a copy of any headers set by this request, included in the request log
// and the debug log.
let mut headers: Vec<String> = Vec::new();
for header in built_request.headers() {
headers.push(format!("{:?}", header));
}
// If enabled, grab a copy of the request body, included in the request log and
// the debug log.
let body = if self.config.request_body {
// Get a bytes representation of the body, if any.
let body_bytes = match built_request.body() {
Some(b) => b.as_bytes().unwrap_or(b""),
None => b"",
};
// Convert the bytes into a &str if valid utf8.
str::from_utf8(body_bytes).unwrap_or("")
} else {
""
};
// Record the complete client request, included in the request log and the debug log.
let raw_request = GooseRawRequest::new(
request.method.clone(),
built_request.url().as_str(),
headers,
body,
);
// Record information about the request.
let mut request_metric = GooseRequestMetric::new(
raw_request,
request_name,
self.started.elapsed().as_millis(),
self.weighted_users_index,
);
// Make the actual request.
let response = self.client.execute(built_request).await;
request_metric.set_response_time(started.elapsed().as_millis());
// Determine if the request suceeded or failed.
match &response {
Ok(r) => {
let status_code = r.status();
debug!("{:?}: status_code {}", &path, status_code);
// Update the request_metric object.
request_metric.set_status_code(Some(status_code));
request_metric.set_final_url(r.url().as_str());
// Check if we were expecting a specific status code.
if let Some(expect_status_code) = request.expect_status_code {
// Record a failure if the expected status code was not returned.
if status_code != expect_status_code {
request_metric.success = false;
request_metric.error = format!("{}: {}", status_code, request_name);
}
// Otherwise record a failure if the returned status code was not a success.
} else if !status_code.is_success() {
request_metric.success = false;
request_metric.error = format!("{}: {}", status_code, request_name);
}
// Load test user was redirected.
if self.config.sticky_follow && request_metric.raw.url != request_metric.final_url {
let base_url = self.base_url.to_string();
// Check if the URL redirected started with the load test base_url.
if !request_metric.final_url.starts_with(&base_url) {
let redirected_url = Url::parse(&request_metric.final_url)?;
let redirected_base_url =
redirected_url[..url::Position::BeforePath].to_string();
info!(
"base_url for user {} redirected from {} to {}",
self.weighted_users_index + 1,
&base_url,
&redirected_base_url
);
let _ = self.set_base_url(&redirected_base_url);
}
}
}
Err(e) => {
// @TODO: what can we learn from a reqwest error?
warn!("{:?}: {}", &path, e);
request_metric.success = false;
request_metric.set_status_code(None);
request_metric.error = clean_reqwest_error(e, request_name);
}
};
// If enabled, track the cadence between each time the same request is made while
// this GooseUser is running. If requests are blocked by the upstream server, this
// allows Goose to backfill the requests that should have been made based on
// cadence statistics.
request_metric.user_cadence = self
.coordinated_omission_mitigation(&request_metric)
.await?;
// Send a copy of the raw request object to the parent process if
// we're tracking metrics.
if !self.config.no_metrics {
self.send_request_metric_to_parent(request_metric.clone())?;
}
Ok(GooseResponse::new(request_metric, response))
}
/// Tracks the time it takes for the current GooseUser to loop through all GooseTasks
/// if Coordinated Omission Mitigation is enabled.
pub(crate) async fn update_request_cadence(&mut self, thread_number: usize) {
if let Some(co_mitigation) = self.config.co_mitigation.as_ref() {
// Return immediately if coordinated omission mitigation is disabled.
if co_mitigation == &GooseCoordinatedOmissionMitigation::Disabled {
return;
}
// Grab the current timestamp to calculate the difference since the last
// time through the loop.
let now = std::time::Instant::now();
// Swap out the `slept` counter, which is the total time the GooseUser slept
// between tasks, a potentially randomly changing value. Reset to 0 for the
// next loop through all GooseTasks.
self.request_cadence.delays_since_last_time = self.slept;
self.slept = 0;
// How much time passed since the last time this GooseUser looped through all
// tasks, accounting for time waiting between GooseTasks due to `set_wait_time`.
let elapsed = (now - self.request_cadence.last_time).as_millis() as u64
- self.request_cadence.delays_since_last_time;
// Update `minimum_cadence` if this was the fastest seen.
if elapsed < self.request_cadence.minimum_cadence
|| self.request_cadence.minimum_cadence == 0
{
self.request_cadence.minimum_cadence = elapsed;
// Update `maximum_cadence` if this was the slowest seen.
} else if elapsed > self.request_cadence.maximum_cadence {
self.request_cadence.maximum_cadence = elapsed;
}
// Update request_cadence metrics based on the timing of the current request.
self.request_cadence.counter += 1;
self.request_cadence.total_elapsed += elapsed;
self.request_cadence.last_time = now;
self.request_cadence.average_cadence =
self.request_cadence.total_elapsed / self.request_cadence.counter;
if self.request_cadence.counter > 3 {
if self.request_cadence.coordinated_omission_counter < 0 {
debug!(
"user {} enabled coordinated omission mitigation",
thread_number
);
self.request_cadence.coordinated_omission_counter += 1;
}
// Calculate the expected cadence for this GooseTask request.
let cadence = match co_mitigation {
// Expected cadence is the average time between requests.
GooseCoordinatedOmissionMitigation::Average => {
self.request_cadence.average_cadence
}
// Expected cadence is the maximum time between requests.
GooseCoordinatedOmissionMitigation::Maximum => {
self.request_cadence.maximum_cadence
}
// Expected cadence is the minimum time between requests.
GooseCoordinatedOmissionMitigation::Minimum => {
self.request_cadence.minimum_cadence
}
// This is not possible as we would have exited already if coordinated
// omission mitigation was disabled.
GooseCoordinatedOmissionMitigation::Disabled => unreachable!(),
};
if elapsed > (cadence * 2) {
debug!(
"user {}: coordinated_omission_mitigation: elapsed({}) > cadence({})",
thread_number, elapsed, cadence
);
self.request_cadence.coordinated_omission_counter += 1;
self.request_cadence.coordinated_omission_mitigation = elapsed;
} else {
self.request_cadence.coordinated_omission_mitigation = 0;
}
// Always track the expected cadence.
self.request_cadence.user_cadence = cadence;
}
} else {
// Coordinated Omission Mitigation defaults to average.
unreachable!();
}
}
/// If Coordinated Omission Mitigation is enabled, compares how long has passed since the last
/// loop through all GooseTasks by the current GooseUser. Through this mechanism, Goose is
/// able to detect stalls on the upstream server being load tested, backfilling requests based
/// on what statistically should have happened. Can be disabled with `--co-mitigation disabled`.
async fn coordinated_omission_mitigation(
&self,
request_metric: &GooseRequestMetric,
) -> Result<u64, GooseTaskError> {
if let Some(co_mitigation) = self.config.co_mitigation.as_ref() {
// Return immediately if coordinated omission mitigation is disabled.
if co_mitigation == &GooseCoordinatedOmissionMitigation::Disabled {
return Ok(0);
}
// Generate an info level alert if this specific request took longer than the normal
// cadence, as that means this specific request will likely trigger Coordinated
// Omission Mitigation.
if self.request_cadence.counter > 3
&& request_metric.response_time > self.request_cadence.user_cadence
{
let task_name = if let Some(task_name) = &self.task_name {
format!(", task name: \"{}\"", task_name)
} else {
"".to_string()
};
info!(
"{:.3}s into goose attack: \"{} {}\" [{}] took abnormally long ({} ms){}",
request_metric.elapsed as f64 / 1_000.0,
request_metric.raw.method,
request_metric.raw.url,
request_metric.status_code,
request_metric.response_time,
task_name,
);
}
// Check if Coordinated Omission Mitigation has been triggered.
if self.request_cadence.coordinated_omission_mitigation > 0 {
// Base our coordinated omission generated request metric on the actual
// metric that triggered this logic.
let mut coordinated_omission_request_metric = request_metric.clone();
// Record data points specific to coordinated_omission.
coordinated_omission_request_metric.coordinated_omission_elapsed =
self.request_cadence.coordinated_omission_mitigation;
// Record data points specific to coordinated_omission.
coordinated_omission_request_metric.user_cadence =
self.request_cadence.user_cadence;
// Send the coordinated omission mitigation generated metrics to the parent.
self.send_request_metric_to_parent(coordinated_omission_request_metric)?;
}
Ok(self.request_cadence.user_cadence)
} else {
// A setting for coordinated omission mitigation is required, defaults to Average.
unreachable!();
}
}
fn send_request_metric_to_parent(&self, request_metric: GooseRequestMetric) -> GooseTaskResult {
// If requests-file is enabled, send a copy of the raw request to the logger thread.
if !self.config.request_log.is_empty() {
if let Some(logger) = self.logger.as_ref() {
logger.send(Some(GooseLog::Request(request_metric.clone())))?;
}
}
// Parent is not defined when running
// [`test_start`](../struct.GooseAttack.html#method.test_start),
// [`test_stop`](../struct.GooseAttack.html#method.test_stop), and during testing.
if let Some(parent) = self.channel_to_parent.clone() {
parent.send(GooseMetric::Request(request_metric))?;
}
Ok(())
}
/// If `request_name` is set, unwrap and use this. Otherwise, if the GooseTask has a name
/// set use it. Otherwise use the path.
fn get_request_name<'a>(&'a self, request: &'a GooseRequest) -> &'a str {
match request.name {
// If a request.name is set, unwrap and return it.
Some(rn) => rn,
None => {
// Otherwise determine if the current GooseTask is named, and if so return it.
if let Some(task_name) = &self.task_name {
task_name
} else {
// Otherwise return a copy of the the path.
request.path
}
}
}
}
/// Manually mark a request as a success.
///
/// Goose determines if a request was successful based on the the HTTP response status
/// code. By default, it uses [`reqwest::StatusCode::is_success`]. If an alternative
/// HTTP response code is expected, use [`GooseRequestBuilder::expect_status_code`]. If
/// validation requires additional logic, you can use set_success().
///
/// A copy of your original request is returned with the response, and a mutable copy
/// must be included when setting a request as a success.
///
/// # Example
/// ```rust
/// use goose::prelude::*;
///
/// let mut task = task!(get_function);
///
/// /// A simple task that makes a GET request.
/// async fn get_function(user: &mut GooseUser) -> GooseTaskResult {
/// let mut goose = user.get("404").await?;
///
/// if let Ok(response) = &goose.response {
/// // We expect a 404 here.
/// if response.status() == 404 {
/// return user.set_success(&mut goose.request);
/// }
/// }
///
/// Err(GooseTaskError::RequestFailed {
/// raw_request: goose.request.clone(),
/// })
/// }
/// ````
pub fn set_success(&self, request: &mut GooseRequestMetric) -> GooseTaskResult {
// Only send update if this was previously not a success.
if !request.success {
request.success = true;
request.update = true;
self.send_request_metric_to_parent(request.clone())?;
}
Ok(())
}
/// Manually mark a request as a failure.
///
/// By default, Goose will consider any response with a 2xx status code as a success.
/// You may require more advanced logic, in which a 2xx status code is actually a
/// failure. A copy of your original request is returned with the response, and a
/// mutable copy must be included when setting a request as a failure.
///
/// Calls to `set_failure` must include four parameters. The first, `tag`, is an
/// arbitrary string identifying the reason for the failure, used when logging. The
/// second, `request`, is a mutable reference to the
/// ([`GooseRequestMetric`](./struct.GooseRequestMetric.html)) object of the request being
/// identified as a failure (the contained `success` field will be set to `false`,
/// and the `update` field will be set to `true`). The last two parameters, `header`
/// and `body`, are optional and used to provide more detail in logs.
///
/// The value of `tag` will normally be collected into the errors summary table if
/// metrics are being displayed. However, if `set_failure` is called multiple times,
/// or is called on a request that was already an error, only the first error will
/// be collected.
///
/// This also calls [`GooseUser::log_debug`].
///
/// # Example
/// ```rust
/// use goose::prelude::*;
///
/// let mut task = task!(loadtest_index_page);
///
/// async fn loadtest_index_page(user: &mut GooseUser) -> GooseTaskResult {
/// let mut goose = user.get("").await?;
///
/// if let Ok(response) = goose.response {
/// // We only need to check pages that returned a success status code.
/// if response.status().is_success() {
/// match response.text().await {
/// Ok(text) => {
/// // If the expected string doesn't exist, this page load
/// // was a failure.
/// if !text.contains("this string must exist") {
/// // As this is a named request, pass in the name not the URL
/// return user.set_failure("string missing", &mut goose.request, None, None);
/// }
/// }
/// // Empty page, this is a failure.
/// Err(_) => {
/// return user.set_failure("empty page", &mut goose.request, None, None);
/// }
/// }
/// }
/// };
///
/// Ok(())
/// }
/// ````
pub fn set_failure(
&self,
tag: &str,
request: &mut GooseRequestMetric,
headers: Option<&header::HeaderMap>,
body: Option<&str>,
) -> GooseTaskResult {
// Only send update if this was previously a success.
if request.success {
request.success = false;
request.update = true;
request.error = tag.to_string();
self.send_request_metric_to_parent(request.clone())?;
}
// Write failure to log, converting `&mut request` to `&request` as needed by `log_debug()`.
self.log_debug(tag, Some(&*request), headers, body)?;
// Print log to stdout if `-v` is enabled.
info!("set_failure: {}", tag);
Err(GooseTaskError::RequestFailed {
raw_request: request.clone(),
})
}
/// Write to [`debug_file`](../struct.GooseConfiguration.html#structfield.debug_file)
/// if enabled.
///
/// This function provides a mechanism for optional debug logging when a load test
/// is running. This can be especially helpful when writing a load test. Each entry
/// must include a tag, which is an arbitrary string identifying the debug message.
/// It may also optionally include references to the GooseRequestMetric made, the headers
/// returned by the server, and the response body returned by the server,
///
/// As the response body can be large, the `--no-debug-body` option (or
/// [`GooseDefault::NoDebugBody`](../config/enum.GooseDefault.html#variant.NoDebugBody) default)
/// can be set to prevent the debug log from including the response body. When this option
/// is enabled, the body will always show up as `null` in the debug log.
///
/// Calls to [`GooseUser::set_failure`] automatically invoke `log_debug`.
///
/// To enable the debug log, a load test must be run with the `--debug-log-file=foo`
/// option set, where `foo` is either a relative or an absolute path of the log file
/// to create. Any existing file will be overwritten.
///
/// In the following example, we are logging debug messages whenever there are errors.
///
/// # Example
/// ```rust
/// use goose::prelude::*;
///
/// let mut task = task!(loadtest_index_page);
///
/// async fn loadtest_index_page(user: &mut GooseUser) -> GooseTaskResult {
/// let mut goose = user.get("").await?;
///
/// match goose.response {
/// Ok(response) => {
/// // Grab a copy of the headers so we can include them when logging errors.
/// let headers = &response.headers().clone();
/// // We only need to check pages that returned a success status code.
/// if !response.status().is_success() {
/// match response.text().await {
/// Ok(html) => {
/// // Server returned an error code, log everything.
/// user.log_debug(
/// "error loading /",
/// Some(&goose.request),
/// Some(headers),
/// Some(&html),
/// );
/// },
/// Err(e) => {
/// // No body was returned, log everything else.
/// user.log_debug(
/// &format!("error loading /: {}", e),
/// Some(&goose.request),
/// Some(headers),
/// None,
/// );
/// }
/// }
/// }
/// },
/// // No response from server.
/// Err(e) => {
/// user.log_debug(
/// "no response from server when loading /",
/// Some(&goose.request),
/// None,
/// None,
/// );
/// }
/// }
///
/// Ok(())
/// }
/// ````
pub fn log_debug(
&self,
tag: &str,
request: Option<&GooseRequestMetric>,
headers: Option<&header::HeaderMap>,
body: Option<&str>,
) -> GooseTaskResult {
if !self.config.debug_log.is_empty() {
// Logger is not defined when running
// [`test_start`](../struct.GooseAttack.html#method.test_start),
// [`test_stop`](../struct.GooseAttack.html#method.test_stop), and during testing.
if let Some(logger) = self.logger.clone() {
if self.config.no_debug_body {
logger.send(Some(GooseLog::Debug(GooseDebug::new(
tag, request, headers, None,
))))?;
} else {
logger.send(Some(GooseLog::Debug(GooseDebug::new(
tag, request, headers, body,
))))?;
}
}
}
Ok(())
}
/// Manually build a
/// [`reqwest::Client`](https://docs.rs/reqwest/*/reqwest/struct.Client.html).
///
/// By default, Goose configures two options when building a
/// [`reqwest::Client`](https://docs.rs/reqwest/*/reqwest/struct.Client.html). The first
/// configures Goose to report itself as the
/// [`user_agent`](https://docs.rs/reqwest/*/reqwest/struct.ClientBuilder.html#method.user_agent)
/// requesting web pages (ie `goose/0.11.2`). The second option configures
/// [`reqwest`](https://docs.rs/reqwest/) to
/// [store cookies](https://docs.rs/reqwest/*/reqwest/struct.ClientBuilder.html#method.cookie_store),
/// which is generally necessary if you aim to simulate logged in users.
///
/// # Default configuration:
///
/// ```rust
/// use reqwest::Client;
///
/// static APP_USER_AGENT: &str = concat!(env!("CARGO_PKG_NAME"), "/", env!("CARGO_PKG_VERSION"));
///
/// let builder = Client::builder()
/// .user_agent(APP_USER_AGENT)
/// .cookie_store(true)
/// .gzip(true);
/// ```
///
/// Alternatively, you can use this function to manually build a
/// [`reqwest::Client`](https://docs.rs/reqwest/*/reqwest/struct.Client.html).
/// with custom configuration. Available options are found in the
/// [`reqwest::ClientBuilder`](https://docs.rs/reqwest/*/reqwest/struct.ClientBuilder.html)
/// documentation.
///
/// When manually building a
/// [`reqwest::Client`](https://docs.rs/reqwest/*/reqwest/struct.Client.html),
/// there are a few things to be aware of:
/// - Manually building a client in [`test_start`](../struct.GooseAttack.html#method.test_start)
/// will only affect requests made during test setup;
/// - Manually building a client in [`test_stop`](../struct.GooseAttack.html#method.test_stop)
/// will only affect requests made during test teardown;
/// - A manually built client is specific to a single Goose thread -- if you are
/// generating a large load test with many users, each will need to manually build their
/// own client (typically you'd do this in a Task that is registered with
/// [`GooseTask::set_on_start()`] in each Task Set requiring a custom client;
/// - Manually building a client will completely replace the automatically built client
/// with a brand new one, so any configuration, cookies or headers set in the previously
/// built client will be gone;
/// - You must include all desired configuration, as you are completely replacing Goose
/// defaults. For example, if you want Goose clients to store cookies, you will have to
/// include
/// [`.cookie_store(true)`](https://docs.rs/reqwest/*/reqwest/struct.ClientBuilder.html#method.cookie_store).
///
/// In the following example, the Goose client is configured with a different user agent,
/// sets a default header on every request, stores cookies, and supports gzip compression.
///
/// ## Example
/// ```rust
/// use goose::prelude::*;
///
/// task!(setup_custom_client).set_on_start();
///
/// async fn setup_custom_client(user: &mut GooseUser) -> GooseTaskResult {
/// use reqwest::{Client, header};
///
/// // Build a custom HeaderMap to include with all requests made by this client.
/// let mut headers = header::HeaderMap::new();
/// headers.insert("X-Custom-Header", header::HeaderValue::from_str("custom value").unwrap());
///
/// // Build a custom client.
/// let builder = Client::builder()
/// .default_headers(headers)
/// .user_agent("custom user agent")
/// .cookie_store(true)
/// .gzip(true);
///
/// // Assign the custom client to this GooseUser.
/// user.set_client_builder(builder).await?;
///
/// Ok(())
/// }
/// ```
///
/// # Alternative Compression Algorithms
/// Reqwest also supports
/// [`brotli`](https://docs.rs/reqwest/*/reqwest/struct.ClientBuilder.html#method.brotli) and
/// [`deflate`](https://docs.rs/reqwest/*/reqwest/struct.ClientBuilder.html#method.deflate) compression.
///
/// To enable either, you must enable the features in your load test's `Cargo.toml`, for example:
/// ```text
/// reqwest = { version = "^0.11.4", default-features = false, features = [
/// "brotli",
/// "cookies",
/// "deflate",
/// "gzip",
/// "json",
/// ] }
/// ```
///
/// Once enabled, you can add `.brotli(true)` and/or `.deflate(true)` to your custom
/// [`reqwest::Client::builder()`], following the documentation above.
///
/// # Custom Cookies
/// Custom cookies can also be manually set when building a custom [`reqwest::Client`]. This requires
/// loading the [`GooseUser::base_url`] being load tested in order to properly build the cookie. Then
/// a custom [`reqwest::cookie::Jar`] is created and the custom cookie is added with
/// [`reqwest::cookie::Jar::add_cookie_str`]. Finally, the new cookie jar must be specified as the
/// [`reqwest::ClientBuilder::cookie_provider`] for the custom client.
///
/// ## Example
/// ```rust
/// use reqwest::{cookie::Jar, Client};
/// use std::sync::Arc;
///
/// use goose::prelude::*;
///
/// task!(custom_cookie_with_custom_client).set_on_start();
///
/// async fn custom_cookie_with_custom_client(user: &mut GooseUser) -> GooseTaskResult {
/// // Prepare the contents of a custom cookie.
/// let cookie = "my-custom-cookie=custom-value";
///
/// // Pre-load one or more cookies into a custom cookie jar to use with this client.
/// let jar = Jar::default();
/// jar.add_cookie_str(
/// cookie,
/// &user.base_url,
/// );
///
/// // Build a custom client.
/// let builder = Client::builder()
/// .user_agent("example-loadtest")
/// .cookie_store(true)
/// .cookie_provider(Arc::new(jar))
/// .gzip(true);
///
/// // Assign the custom client to this GooseUser.
/// user.set_client_builder(builder).await?;
///
/// Ok(())
/// }
/// ```
pub async fn set_client_builder(
&mut self,
builder: ClientBuilder,
) -> Result<(), GooseTaskError> {
self.client = builder.build()?;
Ok(())
}
/// Some websites use multiple domains to serve traffic, redirecting depending on
/// the user's roll. For this reason, Goose needs to respect a redirect of the
/// `base_url` and subsequent paths should be built from the redirect domain.
///
/// For example, if the `base_url` (ie `--host`) is set to `foo.example.com` and the
/// load test requests `/login`, thereby loading `http://foo.example.com/login` and
/// this request gets redirected by the server to `http://foo-secure.example.com/`,
/// subsequent requests made by this user need to be against the new
/// `foo-secure.example.com domain`. (Further, if the `base_url` is again redirected,
/// such as when loading `http://foo-secure.example.com/logout`, the user should
/// again follow for subsequent requests, perhaps in this case back to
/// `foo.example.com`.)
///
/// Load tests can also request absolute URLs, and if these URLs are redirected
/// it does not affect the `base_url` of the load test. For example, if
/// `foo.example.com` is the base url, and the load test requests
/// `http://bar.example.com` (a different domain) and this request gets redirected
/// to `http://other.example.com`, subsequent relative requests would still be made
/// against `foo.example.com`.
///
/// This functionality is used internally by Goose to follow redirects of the
/// `base_url` when `--sticky-follow` is specified at run time, or
/// [`set_default`](../struct.GooseAttack.html#method.set_default)
/// `(`[`GooseDefault::StickyFollow`](../config/enum.GooseDefault.html#variant.StickyFollow)
/// `, true)` is enabled. It is also
/// available to be manually invoked from a load test such as in the following
/// example.
///
/// # Example
/// ```rust
/// use goose::prelude::*;
/// use std::time::Duration;
///
/// #[tokio::main]
/// async fn main() -> Result<(), GooseError> {
/// let _goose_metrics = GooseAttack::initialize()?
/// .register_taskset(taskset!("LoadtestTasks")
/// .set_host("http://foo.example.com/")
/// .set_wait_time(Duration::from_secs(0), Duration::from_secs(3))?
/// .register_task(task!(task_foo).set_weight(10)?)
/// .register_task(task!(task_bar))
/// )
/// // Set a default run time so this test runs to completion.
/// .set_default(GooseDefault::RunTime, 1)?
/// .execute()
/// .await?;
///
/// Ok(())
/// }
///
/// async fn task_foo(user: &mut GooseUser) -> GooseTaskResult {
/// let _goose = user.get("").await?;
///
/// Ok(())
/// }
///
/// async fn task_bar(user: &mut GooseUser) -> GooseTaskResult {
/// // Before this task runs, all requests are being made against
/// // http://foo.example.com, after this task runs all subsequent
/// // requests are made against http://bar.example.com/.
/// user.set_base_url("http://bar.example.com/");
/// let _goose = user.get("").await?;
///
/// Ok(())
/// }
/// ```
pub fn set_base_url(&mut self, host: &str) -> Result<(), GooseTaskError> {
self.base_url = Url::parse(host)?;
Ok(())
}
}
/// Defines the HTTP requests that Goose makes.
///
/// Can be manually created and configured with [`GooseRequest::builder`], but it's typically
/// more convenient to use the [`GooseUser::get`], [`GooseUser::get_named`], [`GooseUser::post`],
/// [`GooseUser::post_form`], [`GooseUser::post_json`], [`GooseUser::head`] and
/// [`GooseUser::delete`] helpers.
///
/// For complete instructions review [`GooseRequestBuilder`].
#[derive(Debug)]
pub struct GooseRequest<'a> {
// Defaults to `""`.
path: &'a str,
// Defaults to [`GooseMethod::Get`].
method: GooseMethod,
// Defaults to [`None`].
name: Option<&'a str>,
// Defaults to [`None`].
expect_status_code: Option<u16>,
// Defaults to [`None`].
request_builder: Option<RequestBuilder>,
}
impl<'a> GooseRequest<'a> {
/// Convenience function to bring [`GooseRequestBuilder`] into scope.
pub fn builder() -> GooseRequestBuilder<'a> {
GooseRequestBuilder::new()
}
}
/// Used to build a [`GooseRequest`] object, necessary to make a request with Goose.
///
/// It's only necessary to build manually if the [`GooseUser::get`], [`GooseUser::get_named`],
/// [`GooseUser::post`], [`GooseUser::post_form`], [`GooseUser::post_json`], [`GooseUser::head`]
/// and [`GooseUser::delete`] helpers don't provide you with enough flexibility.
///
/// # Example
/// ```rust
/// use goose::prelude::*;
///
/// let mut a_task = task!(task_function);
///
/// // A simple task that loads a relative path.
/// async fn task_function(user: &mut GooseUser) -> GooseTaskResult {
/// // Manually create a GooseRequestBuilder object.
/// let goose_request = GooseRequest::builder()
/// // Set a relative path to request.
/// .path("about")
/// // Name the request in the metircs.
/// .name("About page")
/// // Build the GooseRequest object.
/// .build();
///
/// // Make the configured request.
/// let _goose = user.request(goose_request).await?;
///
/// Ok(())
/// }
/// ```
pub struct GooseRequestBuilder<'a> {
path: &'a str,
method: GooseMethod,
name: Option<&'a str>,
expect_status_code: Option<u16>,
request_builder: Option<RequestBuilder>,
}
impl<'a> GooseRequestBuilder<'a> {
// Internal method to build a [`GooseRequest`] from a [`GooseRequestBuilder`].
fn new() -> Self {
Self {
path: "",
method: GooseMethod::Get,
name: None,
expect_status_code: None,
request_builder: None,
}
}
/// Set the path to request.
///
/// Typically is a relative path allowing Goose to append a configurable base_url.
///
/// Defaults to `""` (the main index).
///
/// # Example
/// This can be implemented in a simpler way using the [`GooseUser::get`] helper function.
/// ```rust
/// use goose::prelude::*;
///
/// let mut a_task = task!(task_function);
///
/// // A simple task that loads a relative path.
/// async fn task_function(user: &mut GooseUser) -> GooseTaskResult {
/// // Manually create a GooseRequestBuilder object.
/// let goose_request = GooseRequest::builder()
/// // Set a relative path to request.
/// .path("a/relative/path")
/// // Build the GooseRequest object.
/// .build();
///
/// // Make the configured request.
/// let _goose = user.request(goose_request).await?;
///
/// Ok(())
/// }
/// ```
pub fn path(mut self, path: impl Into<&'a str>) -> Self {
self.path = path.into();
self
}
/// Set the method of the request.
///
/// Must be set to a [`GooseMethod`].
///
/// Defaults to [`GooseMethod::Get`].
///
/// # Example
/// ```rust
/// use goose::prelude::*;
///
/// let mut a_task = task!(task_function);
///
/// // Make a DELETE request.
/// async fn task_function(user: &mut GooseUser) -> GooseTaskResult {
/// // Manually create a GooseRequestBuilder object.
/// let goose_request = GooseRequest::builder()
/// // Set a relative path to request.
/// .path("path/to/delete")
/// // Set the method to DELETE.
/// .method(GooseMethod::Delete)
/// // Build the GooseRequest object.
/// .build();
///
/// // Make the configured DELETE request.
/// let _goose = user.request(goose_request).await?;
///
/// Ok(())
/// }
/// ```
pub fn method(mut self, method: GooseMethod) -> Self {
self.method = method;
self
}
/// Set a name for the request, affecting how it shows up in metrics.
///
/// Must be set to a [`GooseMethod`].
///
/// Defaults to [`GooseMethod::Get`].
///
/// # Example
/// ```rust
/// use goose::prelude::*;
///
/// let mut a_task = task!(task_function);
///
/// // Make a named request.
/// async fn task_function(user: &mut GooseUser) -> GooseTaskResult {
/// // Manually create a GooseRequestBuilder object.
/// let goose_request = GooseRequest::builder()
/// // Set a relative path to request.
/// .path("path/to/request")
/// // Name the request in the metrics.
/// .name("custom name")
/// // Build the GooseRequest object.
/// .build();
///
/// // Make the configured request.
/// let _goose = user.request(goose_request).await?;
///
/// Ok(())
/// }
/// ```
pub fn name(mut self, name: impl Into<&'a str>) -> Self {
self.name = Some(name.into());
self
}
/// Manually configure the expected HTTP response status code.
///
/// Defaults to [`reqwest::StatusCode::is_success`].
///
/// # Example
/// Intentionally request a 404 page, and do not trigger an error.
/// ```rust
/// use goose::prelude::*;
///
/// let mut a_task = task!(task_function);
///
/// // Make a named request.
/// async fn task_function(user: &mut GooseUser) -> GooseTaskResult {
/// // Manually create a GooseRequestBuilder object.
/// let goose_request = GooseRequest::builder()
/// // Set a relative path to request.
/// .path("no/such/path")
/// // Tell Goose to expect a 404 HTTP response status code.
/// .expect_status_code(404)
/// // Build the GooseRequest object.
/// .build();
///
/// // Make the configured request.
/// let _goose = user.request(goose_request).await?;
///
/// Ok(())
/// }
/// ```
pub fn expect_status_code(mut self, status_code: u16) -> Self {
self.expect_status_code = Some(status_code);
self
}
/// Manually create the [`reqwest::RequestBuilder`] used to make a request.
///
/// # Example
/// Manually create a `RequestBuilder` in order to set a timeout.
/// ```rust
/// use goose::prelude::*;
///
/// let mut a_task = task!(task_function);
///
/// async fn task_function(user: &mut GooseUser) -> GooseTaskResult {
/// use std::time::Duration;
///
/// // Manually interact with the Reqwest RequestBuilder object.
/// let request_builder = user.get_request_builder(&GooseMethod::Get, "no/such/path")?
/// // Configure the request to timeout if it takes longer than 500 milliseconds.
/// .timeout(Duration::from_millis(500));
///
/// // Manually build a GooseRequest in order to set our custom RequestBuilder.
/// let goose_request = GooseRequest::builder()
/// // Manually add our custom RequestBuilder object.
/// .set_request_builder(request_builder)
/// // Turn the GooseRequestBuilder object into a GooseRequest.
/// .build();
///
/// // Finally make the actual request with our custom GooseRequest object.
/// let _goose = user.request(goose_request).await?;
///
/// Ok(())
/// }
/// ```
pub fn set_request_builder(mut self, request_builder: RequestBuilder) -> Self {
self.request_builder = Some(request_builder);
self
}
/// Build the [`GooseRequest`] object which is then passed to [`GooseUser::request`].
///
/// # Example
/// ```rust
/// use goose::prelude::*;
///
/// // Build the default "GET /".
/// let goose_request = GooseRequest::builder().build();
/// ```
pub fn build(self) -> GooseRequest<'a> {
let Self {
path,
method,
name,
expect_status_code,
request_builder,
} = self;
GooseRequest {
path,
method,
name,
expect_status_code,
request_builder,
}
}
}
/// Remove path from Reqwest error to avoid having a lot of distincts error
/// when path parameters are used.
fn clean_reqwest_error(e: &reqwest::Error, request_name: &str) -> String {
let kind = if e.is_builder() {
"builder error"
} else if e.is_request() {
"error sending request"
} else if e.is_body() {
"request or response body error"
} else if e.is_decode() {
"error decoding response body"
} else if e.is_redirect() {
"error following redirect"
} else {
"Http status"
};
if let Some(ref e) = std::error::Error::source(e) {
format!("{} {}: {}", kind, request_name, e)
} else {
format!("{} {}", kind, request_name)
}
}
/// A helper to determine which host should be prepended to relative load test
/// paths in this TaskSet.
///
/// The first of these defined will be returned as the prepended host:
/// 1. `--host` (host specified on the command line when running load test)
/// 2. [`GooseTaskSet`](./struct.GooseTaskSet.html)`.host` (default host defined
/// for the current task set)
/// 3. [`GooseDefault::Host`](../config/enum.GooseDefault.html#variant.Host) (default
/// host defined for the current load test)
pub fn get_base_url(
config_host: Option<String>,
task_set_host: Option<String>,
default_host: Option<String>,
) -> Result<Url, GooseError> {
// If the `--host` CLI option is set, build the URL with it.
match config_host {
Some(host) => Ok(
Url::parse(&host).map_err(|parse_error| GooseError::InvalidHost {
host,
detail: "There was a failure parsing the host specified with --host.".to_string(),
parse_error,
})?,
),
None => {
match task_set_host {
// Otherwise, if `GooseTaskSet.host` is defined, usee this
Some(host) => {
Ok(
Url::parse(&host).map_err(|parse_error| GooseError::InvalidHost {
host,
detail: "There was a failure parsing the host specified with the GooseTaskSet.set_host() function.".to_string(),
parse_error,
})?,
)
}
// Otherwise, use global `GooseAttack.host`. `unwrap` okay as host validation was done at startup.
None => {
// Host is required, if we get here it's safe to unwrap this variable.
let default_host = default_host.unwrap();
Ok(
Url::parse(&default_host).map_err(|parse_error| GooseError::InvalidHost {
host: default_host.to_string(),
detail: "There was a failure parsing the host specified globally with the GooseAttack.set_default() function.".to_string(),
parse_error,
})?,
)
}
}
}
}
}
/// The function type of a goose task function.
pub type GooseTaskFunction = Arc<
dyn for<'r> Fn(&'r mut GooseUser) -> Pin<Box<dyn Future<Output = GooseTaskResult> + Send + 'r>>
+ Send
+ Sync,
>;
/// An individual task within a [`GooseTaskSet`](./struct.GooseTaskSet.html).
#[derive(Clone)]
pub struct GooseTask {
/// An index into [`GooseTaskSet`](./struct.GooseTaskSet.html)`.task`, indicating which
/// task this is.
pub tasks_index: usize,
/// An optional name for the task, used when displaying metrics about requests made.
pub name: String,
/// An integer value that controls the frequency that this task will be run.
pub weight: usize,
/// An integer value that controls when this task runs compared to other tasks in the same
/// [`GooseTaskSet`](./struct.GooseTaskSet.html).
pub sequence: usize,
/// A flag indicating that this task runs when the user starts.
pub on_start: bool,
/// A flag indicating that this task runs when the user stops.
pub on_stop: bool,
/// A required function that is executed each time this task runs.
pub function: GooseTaskFunction,
}
impl GooseTask {
pub fn new(function: GooseTaskFunction) -> Self {
trace!("new task");
GooseTask {
tasks_index: usize::max_value(),
name: "".to_string(),
weight: 1,
sequence: 0,
on_start: false,
on_stop: false,
function,
}
}
/// Set an optional name for the task, used when displaying metrics about
/// requests made by the task.
///
/// Individual requests can also be named using [`GooseRequestBuilder`], or for GET
/// requests with the [`GooseUser::get_named`] helper.
///
/// # Example
/// ```rust
/// use goose::prelude::*;
///
/// task!(my_task_function).set_name("foo");
///
/// async fn my_task_function(user: &mut GooseUser) -> GooseTaskResult {
/// let _goose = user.get("").await?;
///
/// Ok(())
/// }
/// ```
pub fn set_name(mut self, name: &str) -> Self {
trace!("[{}] set_name: {}", self.tasks_index, self.name);
self.name = name.to_string();
self
}
/// Set an optional flag indicating that this task should be run when
/// a user first starts. This could be used to log the user in, and
/// so all subsequent tasks are done as a logged in user. A task with
/// this flag set will only run at start time (and optionally at stop
/// time as well, if that flag is also set).
///
/// On-start tasks can be sequenced and weighted. Sequences allow
/// multiple on-start tasks to run in a controlled order. Weights allow
/// on-start tasks to run multiple times when a user starts.
///
/// # Example
/// ```rust
/// use goose::prelude::*;
///
/// task!(my_on_start_function).set_on_start();
///
/// async fn my_on_start_function(user: &mut GooseUser) -> GooseTaskResult {
/// let _goose = user.get("").await?;
///
/// Ok(())
/// }
/// ```
pub fn set_on_start(mut self) -> Self {
trace!("{} [{}] set_on_start task", self.name, self.tasks_index);
self.on_start = true;
self
}
/// Set an optional flag indicating that this task should be run when
/// a user stops. This could be used to log a user out when the user
/// finishes its load test. A task with this flag set will only run at
/// stop time (and optionally at start time as well, if that flag is
/// also set).
///
/// On-stop tasks can be sequenced and weighted. Sequences allow
/// multiple on-stop tasks to run in a controlled order. Weights allow
/// on-stop tasks to run multiple times when a user stops.
///
/// # Example
/// ```rust
/// use goose::prelude::*;
///
/// task!(my_on_stop_function).set_on_stop();
///
/// async fn my_on_stop_function(user: &mut GooseUser) -> GooseTaskResult {
/// let _goose = user.get("").await?;
///
/// Ok(())
/// }
/// ```
pub fn set_on_stop(mut self) -> Self {
trace!("{} [{}] set_on_stop task", self.name, self.tasks_index);
self.on_stop = true;
self
}
/// Sets a weight on an individual task. The larger the value of weight, the more often it will be run
/// in the TaskSet. For example, if one task has a weight of 3 and another task has a weight of 1, the
/// first task will run 3 times as often.
///
/// # Example
/// ```rust
/// use goose::prelude::*;
///
/// #[tokio::main]
/// async fn main() -> Result<(), GooseError> {
/// task!(task_function).set_weight(3)?;
///
/// Ok(())
/// }
///
/// async fn task_function(user: &mut GooseUser) -> GooseTaskResult {
/// let _goose = user.get("").await?;
///
/// Ok(())
/// }
/// ```
pub fn set_weight(mut self, weight: usize) -> Result<Self, GooseError> {
trace!(
"{} [{}] set_weight: {}",
self.name,
self.tasks_index,
weight
);
if weight == 0 {
return Err(GooseError::InvalidWeight {
weight,
detail: "Weight must be set to at least 1.".to_string(),
});
}
self.weight = weight;
Ok(self)
}
/// Defines the sequence value of an individual tasks. Tasks are run in order of their sequence value,
/// so a task with a sequence value of 1 will run before a task with a sequence value of 2. Tasks with
/// no sequence value (or a sequence value of 0) will run last, after all tasks with positive sequence
/// values.
///
/// All tasks with the same sequence value will run in a random order. Tasks can be assigned both
/// squence values and weights.
///
/// # Examples
/// In this first example, the variable names indicate the order the tasks will be run in:
/// ```rust
/// use goose::prelude::*;
///
/// let runs_first = task!(first_task_function).set_sequence(3);
/// let runs_second = task!(second_task_function).set_sequence(5835);
/// let runs_last = task!(third_task_function);
///
/// async fn first_task_function(user: &mut GooseUser) -> GooseTaskResult {
/// let _goose = user.get("1").await?;
///
/// Ok(())
/// }
///
/// async fn second_task_function(user: &mut GooseUser) -> GooseTaskResult {
/// let _goose = user.get("2").await?;
///
/// Ok(())
/// }
///
/// async fn third_task_function(user: &mut GooseUser) -> GooseTaskResult {
/// let _goose = user.get("3").await?;
///
/// Ok(())
/// }
/// ```
///
/// In the following example, the `runs_first` task runs two times, then one instance of `runs_second`
/// and two instances of `also_runs_second` are all three run. The user will do this over and over
/// the entire time it runs, with `runs_first` always running first, then the other tasks being
/// run in a random and weighted order:
/// ```rust
/// use goose::prelude::*;
///
/// #[tokio::main]
/// async fn main() -> Result<(), GooseError> {
/// let runs_first = task!(first_task_function).set_sequence(1).set_weight(2)?;
/// let runs_second = task!(second_task_function_a).set_sequence(2);
/// let also_runs_second = task!(second_task_function_b).set_sequence(2).set_weight(2)?;
///
/// Ok(())
/// }
///
/// async fn first_task_function(user: &mut GooseUser) -> GooseTaskResult {
/// let _goose = user.get("1").await?;
///
/// Ok(())
/// }
///
/// async fn second_task_function_a(user: &mut GooseUser) -> GooseTaskResult {
/// let _goose = user.get("2a").await?;
///
/// Ok(())
/// }
///
/// async fn second_task_function_b(user: &mut GooseUser) -> GooseTaskResult {
/// let _goose = user.get("2b").await?;
///
/// Ok(())
/// }
/// ```
pub fn set_sequence(mut self, sequence: usize) -> Self {
trace!(
"{} [{}] set_sequence: {}",
self.name,
self.tasks_index,
sequence
);
if sequence < 1 {
info!(
"setting sequence to 0 for task {} is unnecessary, sequence disabled",
self.name
);
}
self.sequence = sequence;
self
}
}
impl Hash for GooseTask {
fn hash<H: Hasher>(&self, state: &mut H) {
self.tasks_index.hash(state);
self.name.hash(state);
self.weight.hash(state);
self.sequence.hash(state);
self.on_start.hash(state);
self.on_stop.hash(state);
}
}
#[cfg(test)]
mod tests {
use super::*;
use gumdrop::Options;
use httpmock::{
Method::{GET, POST},
MockServer,
};
const EMPTY_ARGS: Vec<&str> = vec![];
fn setup_user(server: &MockServer) -> Result<GooseUser, GooseError> {
let mut configuration = GooseConfiguration::parse_args_default(&EMPTY_ARGS).unwrap();
configuration.co_mitigation = Some(GooseCoordinatedOmissionMitigation::Average);
let base_url = get_base_url(Some(server.url("/")), None, None).unwrap();
GooseUser::single(base_url, &configuration)
}
#[test]
fn goose_task_set() {
// Simplistic test task functions.
async fn test_function_a(user: &mut GooseUser) -> GooseTaskResult {
let _goose = user.get("/a/").await?;
Ok(())
}
async fn test_function_b(user: &mut GooseUser) -> GooseTaskResult {
let _goose = user.get("/b/").await?;
Ok(())
}
let mut task_set = taskset!("foo");
assert_eq!(task_set.name, "foo");
assert_eq!(task_set.task_sets_index, usize::max_value());
assert_eq!(task_set.weight, 1);
assert_eq!(task_set.task_wait, None);
assert!(task_set.host.is_none());
assert_eq!(task_set.tasks.len(), 0);
assert_eq!(task_set.weighted_tasks.len(), 0);
assert_eq!(task_set.weighted_on_start_tasks.len(), 0);
assert_eq!(task_set.weighted_on_stop_tasks.len(), 0);
// Registering a task adds it to tasks, but doesn't update weighted_tasks.
task_set = task_set.register_task(task!(test_function_a));
assert_eq!(task_set.tasks.len(), 1);
assert_eq!(task_set.weighted_tasks.len(), 0);
assert_eq!(task_set.task_sets_index, usize::max_value());
assert_eq!(task_set.weight, 1);
assert_eq!(task_set.task_wait, None);
assert!(task_set.host.is_none());
// Different task can be registered.
task_set = task_set.register_task(task!(test_function_b));
assert_eq!(task_set.tasks.len(), 2);
assert_eq!(task_set.weighted_tasks.len(), 0);
assert_eq!(task_set.task_sets_index, usize::max_value());
assert_eq!(task_set.weight, 1);
assert_eq!(task_set.task_wait, None);
assert!(task_set.host.is_none());
// Same task can be registered again.
task_set = task_set.register_task(task!(test_function_a));
assert_eq!(task_set.tasks.len(), 3);
assert_eq!(task_set.weighted_tasks.len(), 0);
assert_eq!(task_set.task_sets_index, usize::max_value());
assert_eq!(task_set.weight, 1);
assert_eq!(task_set.task_wait, None);
assert!(task_set.host.is_none());
// Setting weight only affects weight field.
task_set = task_set.set_weight(50).unwrap();
assert_eq!(task_set.weight, 50);
assert_eq!(task_set.tasks.len(), 3);
assert_eq!(task_set.weighted_tasks.len(), 0);
assert_eq!(task_set.task_sets_index, usize::max_value());
assert_eq!(task_set.task_wait, None);
assert!(task_set.host.is_none());
// Weight can be changed.
task_set = task_set.set_weight(5).unwrap();
assert_eq!(task_set.weight, 5);
// Setting host only affects host field.
task_set = task_set.set_host("http://foo.example.com/");
assert_eq!(task_set.host, Some("http://foo.example.com/".to_string()));
assert_eq!(task_set.weight, 5);
assert_eq!(task_set.tasks.len(), 3);
assert_eq!(task_set.weighted_tasks.len(), 0);
assert_eq!(task_set.task_sets_index, usize::max_value());
assert_eq!(task_set.task_wait, None);
// Host field can be changed.
task_set = task_set.set_host("https://bar.example.com/");
assert_eq!(task_set.host, Some("https://bar.example.com/".to_string()));
// Wait time only affects wait time fields.
task_set = task_set
.set_wait_time(Duration::from_secs(1), Duration::from_secs(10))
.unwrap();
assert_eq!(
task_set.task_wait,
Some((Duration::from_secs(1), Duration::from_secs(10)))
);
assert_eq!(task_set.host, Some("https://bar.example.com/".to_string()));
assert_eq!(task_set.weight, 5);
assert_eq!(task_set.tasks.len(), 3);
assert_eq!(task_set.weighted_tasks.len(), 0);
assert_eq!(task_set.task_sets_index, usize::max_value());
// Wait time can be changed.
task_set = task_set
.set_wait_time(Duration::from_secs(3), Duration::from_secs(9))
.unwrap();
assert_eq!(
task_set.task_wait,
Some((Duration::from_secs(3), Duration::from_secs(9)))
);
}
#[test]
fn goose_task() {
// Simplistic test task functions.
async fn test_function_a(user: &mut GooseUser) -> GooseTaskResult {
let _goose = user.get("/a/").await?;
Ok(())
}
// Initialize task set.
let mut task = task!(test_function_a);
assert_eq!(task.tasks_index, usize::max_value());
assert_eq!(task.name, "".to_string());
assert_eq!(task.weight, 1);
assert_eq!(task.sequence, 0);
assert!(!task.on_start);
assert!(!task.on_stop);
// Name can be set, without affecting other fields.
task = task.set_name("foo");
assert_eq!(task.name, "foo".to_string());
assert_eq!(task.weight, 1);
assert_eq!(task.sequence, 0);
assert!(!task.on_start);
assert!(!task.on_stop);
// Name can be set multiple times.
task = task.set_name("bar");
assert_eq!(task.name, "bar".to_string());
// On start flag can be set, without affecting other fields.
task = task.set_on_start();
assert!(task.on_start);
assert_eq!(task.name, "bar".to_string());
assert_eq!(task.weight, 1);
assert_eq!(task.sequence, 0);
assert!(!task.on_stop);
// Setting on start flag twice doesn't change anything.
task = task.set_on_start();
assert!(task.on_start);
// On stop flag can be set, without affecting other fields.
// It's possible to set both on_start and on_stop for same task.
task = task.set_on_stop();
assert!(task.on_stop);
assert!(task.on_start);
assert_eq!(task.name, "bar".to_string());
assert_eq!(task.weight, 1);
assert_eq!(task.sequence, 0);
// Setting on stop flag twice doesn't change anything.
task = task.set_on_stop();
assert!(task.on_stop);
// Setting weight doesn't change anything else.
task = task.set_weight(2).unwrap();
assert_eq!(task.weight, 2);
assert!(task.on_stop);
assert!(task.on_start);
assert_eq!(task.name, "bar".to_string());
assert_eq!(task.sequence, 0);
// Weight field can be changed multiple times.
task = task.set_weight(3).unwrap();
assert_eq!(task.weight, 3);
// Setting sequence doesn't change anything else.
task = task.set_sequence(4);
assert_eq!(task.sequence, 4);
assert_eq!(task.weight, 3);
assert!(task.on_stop);
assert!(task.on_start);
assert_eq!(task.name, "bar".to_string());
// Sequence field can be changed multiple times.
task = task.set_sequence(8);
assert_eq!(task.sequence, 8);
}
#[tokio::test]
async fn goose_user() {
const HOST: &str = "http://example.com/";
let configuration = GooseConfiguration::parse_args_default(&EMPTY_ARGS).unwrap();
let base_url = get_base_url(Some(HOST.to_string()), None, None).unwrap();
let user = GooseUser::new(0, base_url, &configuration, 0).unwrap();
assert_eq!(user.task_sets_index, 0);
assert_eq!(user.weighted_users_index, usize::max_value());
// Confirm the URLs are correctly built using the default_host.
let url = user.build_url("/foo").unwrap();
assert_eq!(&url, &[HOST, "foo"].concat());
let url = user.build_url("bar/").unwrap();
assert_eq!(&url, &[HOST, "bar/"].concat());
let url = user.build_url("/foo/bar").unwrap();
assert_eq!(&url, &[HOST, "foo/bar"].concat());
// Confirm the URLs are built with their own specified host.
let url = user.build_url("https://example.com/foo").unwrap();
assert_eq!(url, "https://example.com/foo");
let url = user
.build_url("https://www.example.com/path/to/resource")
.unwrap();
assert_eq!(url, "https://www.example.com/path/to/resource");
// Create a second user, this time setting a task_set_host.
let base_url = get_base_url(
None,
Some("http://www2.example.com/".to_string()),
Some("http://www.example.com/".to_string()),
)
.unwrap();
let user2 = GooseUser::new(0, base_url, &configuration, 0).unwrap();
// Confirm the URLs are correctly built using the task_set_host.
let url = user2.build_url("/foo").unwrap();
assert_eq!(url, "http://www2.example.com/foo");
// Confirm URLs are still built with their own specified host.
let url = user2.build_url("https://example.com/foo").unwrap();
assert_eq!(url, "https://example.com/foo");
// Confirm Goose can build a base_url that includes a path.
const HOST_WITH_PATH: &str = "http://example.com/with/path/";
let base_url = get_base_url(Some(HOST_WITH_PATH.to_string()), None, None).unwrap();
let user = GooseUser::new(0, base_url, &configuration, 0).unwrap();
// Confirm the URLs are correctly built using the default_host that includes a path.
let url = user.build_url("foo").unwrap();
assert_eq!(&url, &[HOST_WITH_PATH, "foo"].concat());
let url = user.build_url("bar/").unwrap();
assert_eq!(&url, &[HOST_WITH_PATH, "bar/"].concat());
let url = user.build_url("foo/bar").unwrap();
assert_eq!(&url, &[HOST_WITH_PATH, "foo/bar"].concat());
// Confirm that URLs are correctly re-written if an absolute path is used.
let url = user.build_url("/foo").unwrap();
assert_eq!(&url, &[HOST, "foo"].concat());
}
#[tokio::test]
async fn manual_requests() {
let server = MockServer::start();
let mut user = setup_user(&server).unwrap();
// Set up a mock http server endpoint.
const INDEX_PATH: &str = "/";
let index = server.mock(|when, then| {
when.method(GET).path(INDEX_PATH);
then.status(200);
});
// Make a GET request to the mock http server and confirm we get a 200 response.
assert_eq!(index.hits(), 0);
let goose = user
.get(INDEX_PATH)
.await
.expect("get returned unexpected error");
let status = goose.response.unwrap().status();
assert_eq!(status, 200);
assert_eq!(goose.request.raw.method, GooseMethod::Get);
assert_eq!(goose.request.name, INDEX_PATH);
assert!(goose.request.success);
assert!(!goose.request.update);
assert_eq!(goose.request.status_code, 200);
assert_eq!(index.hits(), 1);
const NO_SUCH_PATH: &str = "/no/such/path";
// Set up a mock http server endpoint.
let not_found = server.mock(|when, then| {
when.method(GET).path(NO_SUCH_PATH);
then.status(404);
});
// Make an invalid GET request to the mock http server and confirm we get a 404 response.
assert_eq!(not_found.hits(), 0);
let goose = user
.get(NO_SUCH_PATH)
.await
.expect("get returned unexpected error");
let status = goose.response.unwrap().status();
assert_eq!(status, 404);
assert_eq!(goose.request.raw.method, GooseMethod::Get);
assert_eq!(goose.request.name, NO_SUCH_PATH);
assert!(!goose.request.success);
assert!(!goose.request.update);
assert_eq!(goose.request.status_code, 404,);
not_found.assert_hits(1);
// Set up a mock http server endpoint.
const COMMENT_PATH: &str = "/comment";
let comment = server.mock(|when, then| {
when.method(POST).path(COMMENT_PATH).body("foo");
then.status(200).body("foo");
});
// Make a POST request to the mock http server and confirm we get a 200 OK response.
assert_eq!(comment.hits(), 0);
let goose = user
.post(COMMENT_PATH, "foo")
.await
.expect("post returned unexpected error");
let unwrapped_response = goose.response.unwrap();
let status = unwrapped_response.status();
assert_eq!(status, 200);
let body = unwrapped_response.text().await.unwrap();
assert_eq!(body, "foo");
assert_eq!(goose.request.raw.method, GooseMethod::Post);
assert!(goose.request.success);
assert!(!goose.request.update);
assert_eq!(goose.request.status_code, 200);
comment.assert_hits(1);
}
#[test]
fn test_set_session_data() {
#[derive(Debug, PartialEq, Clone)]
struct CustomSessionData {
data: String,
}
let session_data = CustomSessionData {
data: "foo".to_owned(),
};
let configuration = GooseConfiguration::parse_args_default(&EMPTY_ARGS).unwrap();
let mut user =
GooseUser::single("http://localhost:8080".parse().unwrap(), &configuration).unwrap();
user.set_session_data(session_data.clone());
let session = user.get_session_data::<CustomSessionData>();
assert!(session.is_some());
assert_eq!(session.unwrap(), &session_data);
let session = user.get_session_data_unchecked::<CustomSessionData>();
assert_eq!(session, &session_data);
}
#[test]
fn test_get_mut_session_data() {
#[derive(Debug)]
struct CustomSessionData {
data: String,
}
let session_data = CustomSessionData {
data: "foo".to_owned(),
};
let configuration = GooseConfiguration::parse_args_default(&EMPTY_ARGS).unwrap();
let mut user =
GooseUser::single("http://localhost:8080".parse().unwrap(), &configuration).unwrap();
user.set_session_data(session_data);
if let Some(session) = user.get_session_data_mut::<CustomSessionData>() {
session.data = "bar".to_owned();
}
let session = user.get_session_data_unchecked::<CustomSessionData>();
assert_eq!(session.data, "bar".to_string());
let session = user.get_session_data_unchecked_mut::<CustomSessionData>();
session.data = "foo".to_owned();
let session = user.get_session_data_unchecked::<CustomSessionData>();
assert_eq!(session.data, "foo".to_string());
}
#[test]
fn test_set_session_data_override() {
#[derive(Debug, Clone)]
struct CustomSessionData {
data: String,
}
let mut session_data = CustomSessionData {
data: "foo".to_owned(),
};
let configuration = GooseConfiguration::parse_args_default(&EMPTY_ARGS).unwrap();
let mut user =
GooseUser::single("http://localhost:8080".parse().unwrap(), &configuration).unwrap();
user.set_session_data(session_data.clone());
session_data.data = "bar".to_owned();
user.set_session_data(session_data);
let session = user.get_session_data_unchecked::<CustomSessionData>();
assert_eq!(session.data, "bar".to_string());
}
}