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
//! # Goose
//!
//! Have you ever been attacked by a goose?
//!
//! Goose is a load testing framework inspired by [Locust](https://locust.io/).
//! User behavior is defined with standard Rust code.
//!
//! Goose load tests, called Goose Attacks, are built by creating an application
//! with Cargo, and declaring a dependency on the Goose library.
//!
//! Goose uses [`reqwest`](https://docs.rs/reqwest/) to provide a convenient HTTP
//! client.
//!
//! ## Documentation
//!
//! - [The Goose Book](https://book.goose.rs)
//! - [Developer documentation](https://docs.rs/goose/)
//! - [Blogs and more](https://tag1.com/goose/)
//! - [Goose vs Locust and jMeter](https://www.tag1consulting.com/blog/jmeter-vs-locust-vs-goose)
//! - [Real-life load testing with Goose](https://www.tag1consulting.com/blog/real-life-goose-load-testing)
//! - [Gaggle: a distributed load test](https://www.tag1consulting.com/blog/show-me-how-flock-flies-working-gaggle-goose)
//! - [Optimizing Goose performance](https://www.tag1consulting.com/blog/golden-goose-egg-compile-time-adventure)
//!
//! ## License
//!
//! Copyright 2020-2022 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.
#[macro_use]
extern crate log;
pub mod config;
pub mod controller;
pub mod goose;
mod graph;
pub mod logger;
#[cfg(feature = "gaggle")]
mod manager;
pub mod metrics;
pub mod prelude;
mod report;
mod test_plan;
mod throttle;
mod user;
pub mod util;
#[cfg(feature = "gaggle")]
mod worker;
use gumdrop::Options;
use lazy_static::lazy_static;
#[cfg(feature = "gaggle")]
use nng::Socket;
use rand::seq::SliceRandom;
use rand::thread_rng;
use std::collections::{hash_map::DefaultHasher, BTreeMap, HashSet};
use std::hash::{Hash, Hasher};
use std::sync::{
atomic::{AtomicUsize, Ordering},
Arc, RwLock,
};
use std::time::{self, Duration};
use std::{fmt, io};
use tokio::fs::File;
use crate::config::{GooseConfiguration, GooseDefaults};
use crate::controller::{ControllerProtocol, ControllerRequest};
use crate::goose::{GaggleUser, GooseUser, GooseUserCommand, Scenario, Transaction};
use crate::graph::GraphData;
use crate::logger::{GooseLoggerJoinHandle, GooseLoggerTx};
use crate::metrics::{GooseMetric, GooseMetrics};
use crate::test_plan::{TestPlan, TestPlanHistory, TestPlanStepAction};
#[cfg(feature = "gaggle")]
use crate::worker::{register_shutdown_pipe_handler, GaggleMetrics};
/// Constant defining Goose's default telnet Controller port.
const DEFAULT_TELNET_PORT: &str = "5116";
/// Constant defining Goose's default WebSocket Controller port.
const DEFAULT_WEBSOCKET_PORT: &str = "5117";
lazy_static! {
// WORKER_ID is used to identify different works when running a gaggle.
static ref WORKER_ID: AtomicUsize = AtomicUsize::new(0);
// Global used to count how many times ctrl-c has been pressed, reset each time a
// load test starts.
static ref CANCELED: Arc<RwLock<bool>> = Arc::new(RwLock::new(false));
// Global used to detect when to shut down Gaggle across threads for reasons other than
// ctrl-c being pressed, reset each time a load test starts.
static ref SHUTDOWN_GAGGLE: Arc<RwLock<bool>> = Arc::new(RwLock::new(false));
}
/// Internal representation of a weighted transaction list.
type WeightedTransactions = Vec<(usize, String)>;
/// Internal representation of unsequenced transactions.
type UnsequencedTransactions = Vec<Transaction>;
/// Internal representation of sequenced transactions.
type SequencedTransactions = BTreeMap<usize, Vec<Transaction>>;
/// Returns the unique identifier of the running Worker when running in Gaggle mode.
///
/// The first Worker to connect to the Manager is assigned an ID of 1. For each
/// subsequent Worker to connect to the Manager the ID is incremented by 1. This
/// identifier is primarily an aid in tracing logs.
pub fn get_worker_id() -> usize {
WORKER_ID.load(Ordering::Relaxed)
}
#[cfg(not(feature = "gaggle"))]
#[derive(Debug, Clone)]
/// Socket used for coordinating a Gaggle distributed load test.
pub(crate) struct Socket {}
/// An enumeration of all errors a [`GooseAttack`](./struct.GooseAttack.html) can return.
#[derive(Debug)]
pub enum GooseError {
/// Wraps a [`std::io::Error`](https://doc.rust-lang.org/std/io/struct.Error.html).
Io(io::Error),
/// Wraps a [`reqwest::Error`](https://docs.rs/reqwest/*/reqwest/struct.Error.html).
Reqwest(reqwest::Error),
/// Wraps a ['tokio::task::JoinError'](https://tokio-rs.github.io/tokio/doc/tokio/task/struct.JoinError.html).
TokioJoin(tokio::task::JoinError),
/// Failed attempt to use code that requires a compile-time feature be enabled.
FeatureNotEnabled {
/// The missing compile-time feature.
feature: String,
/// An optional explanation of the error.
detail: String,
},
/// Failed to parse a hostname.
InvalidHost {
/// The invalid hostname that caused this error.
host: String,
/// An optional explanation of the error.
detail: String,
/// Wraps a [`url::ParseError`](https://docs.rs/url/*/url/enum.ParseError.html).
parse_error: url::ParseError,
},
/// Invalid option or value specified, may only be invalid in context.
InvalidOption {
/// The invalid option that caused this error, may be only invalid in context.
option: String,
/// The invalid value that caused this error, may be only invalid in context.
value: String,
/// An optional explanation of the error.
detail: String,
},
/// Invalid wait time specified.
InvalidWaitTime {
// The specified minimum wait time.
min_wait: Duration,
// The specified maximum wait time.
max_wait: Duration,
/// An optional explanation of the error.
detail: String,
},
/// Invalid weight specified.
InvalidWeight {
// The specified weight.
weight: usize,
/// An optional explanation of the error.
detail: String,
},
/// Invalid controller command.
InvalidControllerCommand {
/// An optional explanation of the error.
detail: String,
},
/// [`GooseAttack`](./struct.GooseAttack.html) has no [`Scenario`](./goose/struct.Scenario.html) defined.
NoScenarios {
/// An optional explanation of the error.
detail: String,
},
}
/// Implement a helper to provide a text description of all possible types of errors.
impl GooseError {
fn describe(&self) -> &str {
match *self {
GooseError::Io(_) => "io::Error",
GooseError::Reqwest(_) => "reqwest::Error",
GooseError::TokioJoin(_) => "tokio::task::JoinError",
GooseError::FeatureNotEnabled { .. } => "required compile-time feature not enabled",
GooseError::InvalidHost { .. } => "failed to parse hostname",
GooseError::InvalidOption { .. } => "invalid option or value specified",
GooseError::InvalidWaitTime { .. } => "invalid wait_time specified",
GooseError::InvalidWeight { .. } => "invalid weight specified",
GooseError::InvalidControllerCommand { .. } => "invalid controller command",
GooseError::NoScenarios { .. } => "no scenarios defined",
}
}
}
/// Implement format trait to allow displaying errors.
impl fmt::Display for GooseError {
// Implement display of error with `{}` marker.
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
match *self {
GooseError::Io(ref source) => write!(f, "GooseError: {} ({})", self.describe(), source),
GooseError::Reqwest(ref source) => {
write!(f, "GooseError: {} ({})", self.describe(), source)
}
GooseError::TokioJoin(ref source) => {
write!(f, "GooseError: {} ({})", self.describe(), source)
}
GooseError::InvalidHost {
ref parse_error, ..
} => write!(f, "GooseError: {} ({})", self.describe(), parse_error),
_ => write!(f, "GooseError: {}", self.describe()),
}
}
}
// Define the lower level source of this error, if any.
impl std::error::Error for GooseError {
fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
match *self {
GooseError::Io(ref source) => Some(source),
GooseError::Reqwest(ref source) => Some(source),
GooseError::TokioJoin(ref source) => Some(source),
GooseError::InvalidHost {
ref parse_error, ..
} => Some(parse_error),
_ => None,
}
}
}
/// Auto-convert Reqwest errors.
impl From<reqwest::Error> for GooseError {
fn from(err: reqwest::Error) -> GooseError {
GooseError::Reqwest(err)
}
}
/// Auto-convert IO errors.
impl From<io::Error> for GooseError {
fn from(err: io::Error) -> GooseError {
GooseError::Io(err)
}
}
/// Auto-convert TokioJoin errors.
impl From<tokio::task::JoinError> for GooseError {
fn from(err: tokio::task::JoinError) -> GooseError {
GooseError::TokioJoin(err)
}
}
#[derive(Clone, Debug, PartialEq)]
/// A [`GooseAttack`](./struct.GooseAttack.html) load test operates in one (and only one)
/// of the following modes.
pub enum AttackMode {
/// During early startup before one of the following modes gets assigned.
Undefined,
/// A single standalone process performing a load test.
StandAlone,
/// The controlling process in a Gaggle distributed load test.
Manager,
/// One of one or more working processes in a Gaggle distributed load test.
Worker,
}
#[derive(Clone, Debug, PartialEq)]
/// A [`GooseAttack`](./struct.GooseAttack.html) load test moves through each of the following
/// phases during a complete load test.
pub enum AttackPhase {
/// No load test is running, configuration can be changed by a Controller.
Idle,
/// [`GooseUser`](./goose/struct.GooseUser.html)s are launching.
Increase,
/// [`GooseUser`](./goose/struct.GooseUser.html)s have been launched and are generating load.
Maintain,
/// [`GooseUser`](./goose/struct.GooseUser.html)s are stopping.
Decrease,
/// Exiting the load test.
Shutdown,
}
#[derive(Clone, Debug, PartialEq)]
/// Used to define the order [`Scenario`](./goose/struct.Scenario.html)s and
/// [`Transaction`](./goose/struct.Transaction.html)s are allocated.
///
/// In order to configure the scheduler, and to see examples of the different scheduler
/// variants, review the
/// [`GooseAttack::set_scheduler`](./struct.GooseAttack.html#method.set_scheduler)
/// documentation.
pub enum GooseScheduler {
/// Allocate one of each available type at a time (default).
RoundRobin,
/// Allocate in the order and weighting defined.
Serial,
/// Allocate in a random order.
Random,
}
#[derive(Debug)]
/// Internal global run state for load test.
struct GooseAttackRunState {
/// A timestamp tracking when the previous [`GooseUser`](./goose/struct.GooseUser.html)
/// was increased or decreased.
adjust_user_timer: std::time::Instant,
/// How many milliseconds until the next [`GooseUser`](./goose/struct.GooseUser.html)
/// should be increased or decreased.
adjust_user_in_ms: usize,
/// A counter tracking how many [`GooseUser`](./goose/struct.GooseUser.html)s are running.
active_users: usize,
/// A counter tracking many users have been stopped.
completed_users: usize,
/// This variable accounts for time spent doing things which is then subtracted from
/// the time sleeping to avoid an unintentional drift in events that are supposed to
/// happen regularly.
drift_timer: tokio::time::Instant,
/// Unbounded sender used by all [`GooseUser`](./goose/struct.GooseUser.html)
/// threads to send metrics to parent.
all_threads_metrics_tx: flume::Sender<GooseMetric>,
/// Unbounded receiver used by Goose parent to receive metrics from
/// [`GooseUser`](./goose/struct.GooseUser.html)s.
metrics_rx: flume::Receiver<GooseMetric>,
/// Unbounded sender used by all [`GooseUser`](./goose/struct.GooseUser.html)
/// threads to alert the parent when they shutdown.
all_threads_shutdown_tx: flume::Sender<usize>,
/// Unbounded receiver used by [`GooseUser`](./goose.GooseUser.html) threads to notify
/// the parent if they shut themselves down (for example if `--iterations` is reached).
shutdown_rx: flume::Receiver<usize>,
/// Optional unbounded receiver for logger thread, if enabled.
logger_handle: GooseLoggerJoinHandle,
/// Optional unbounded sender from all [`GooseUser`](./goose/struct.GooseUser.html)s
/// to logger thread, if enabled.
all_threads_logger_tx: GooseLoggerTx,
/// Optional receiver for all [`GooseUser`](./goose/struct.GooseUser.html)s from
/// throttle thread, if enabled.
throttle_threads_tx: Option<flume::Sender<bool>>,
/// Optional sender for throttle thread, if enabled.
parent_to_throttle_tx: Option<flume::Sender<bool>>,
/// Optional channel allowing controller thread to make requests, if not disabled.
controller_channel_rx: Option<flume::Receiver<ControllerRequest>>,
/// A flag tracking whether or not the header has been written when the metrics
/// log is enabled.
metrics_header_displayed: bool,
/// When entering the idle phase use this flag to only display a message one time.
idle_status_displayed: bool,
/// Collection of all [`GooseUser`](./goose/struct.GooseUser.html) threads so they
/// can be stopped later.
users: Vec<tokio::task::JoinHandle<()>>,
/// All unbounded senders to allow communication with
/// [`GooseUser`](./goose/struct.GooseUser.html) threads.
user_channels: Vec<flume::Sender<GooseUserCommand>>,
/// Timer tracking when to display running metrics, if enabled.
running_metrics_timer: std::time::Instant,
/// Boolean flag indicating if running metrics should be displayed.
display_running_metrics: bool,
/// Boolean flag indicating if all [`GooseUser`](./goose/struct.GooseUser.html)s
/// have been spawned.
all_users_spawned: bool,
/// Set of users that have shut themselves down.
users_shutdown: HashSet<usize>,
/// Boolean flag indicating of Goose should shutdown after stopping a running load test.
shutdown_after_stop: bool,
/// Whether or not the load test is currently canceling.
canceling: bool,
/// Optional socket used to coordinate a distributed Gaggle.
socket: Option<Socket>,
}
/// Global internal state for the load test.
pub struct GooseAttack {
/// An optional transaction that is run one time before starting GooseUsers and running Scenarios.
test_start_transaction: Option<Transaction>,
/// An optional transaction that is run one time after all GooseUsers have finished.
test_stop_transaction: Option<Transaction>,
/// A vector containing one copy of each Scenario defined by this load test.
scenarios: Vec<Scenario>,
/// A set of all registered scenario names.
scenario_machine_names: HashSet<String>,
/// A weighted vector containing a GooseUser object for each GooseUser that will run during this load test.
weighted_users: Vec<GooseUser>,
/// A weighted vector containing a lightweight GaggleUser object that is sent to all Workers if running in Gaggle mode.
weighted_gaggle_users: Vec<GaggleUser>,
/// Optional default values for Goose run-time options.
defaults: GooseDefaults,
/// Configuration object holding options set when launching the load test.
configuration: GooseConfiguration,
/// The load test operates in only one of the following modes: StandAlone, Manager, or Worker.
attack_mode: AttackMode,
/// Which phase the load test is currently operating in.
attack_phase: AttackPhase,
/// Defines the order [`Scenario`](./goose/struct.Scenario.html)s and
/// [`Transaction`](./goose/struct.Transaction.html)s are allocated.
scheduler: GooseScheduler,
/// When the load test started.
started: Option<time::Instant>,
/// Internal Goose test plan representation.
test_plan: TestPlan,
/// When the current test plan step started.
step_started: Option<time::Instant>,
/// All metrics merged together.
metrics: GooseMetrics,
/// All data for report graphs.
graph_data: GraphData,
}
/// Goose's internal global state.
impl GooseAttack {
/// Load configuration and initialize a [`GooseAttack`](./struct.GooseAttack.html).
///
/// # Example
/// ```rust
/// use goose::prelude::*;
///
/// let mut goose_attack = GooseAttack::initialize();
/// ```
pub fn initialize() -> Result<GooseAttack, GooseError> {
let configuration = GooseConfiguration::parse_args_default_or_exit();
Ok(GooseAttack {
test_start_transaction: None,
test_stop_transaction: None,
scenarios: Vec::new(),
scenario_machine_names: HashSet::new(),
weighted_users: Vec::new(),
weighted_gaggle_users: Vec::new(),
defaults: GooseDefaults::default(),
configuration,
attack_mode: AttackMode::Undefined,
attack_phase: AttackPhase::Idle,
scheduler: GooseScheduler::RoundRobin,
started: None,
test_plan: TestPlan::new(),
step_started: None,
metrics: GooseMetrics::default(),
graph_data: GraphData::new(),
})
}
/// Initialize a [`GooseAttack`](./struct.GooseAttack.html) with an already loaded
/// configuration.
///
/// This is generally used by Worker instances and tests.
///
/// # Example
/// ```rust
/// use goose::GooseAttack;
/// use goose::config::GooseConfiguration;
/// use gumdrop::Options;
///
/// let configuration = GooseConfiguration::parse_args_default_or_exit();
/// let mut goose_attack = GooseAttack::initialize_with_config(configuration);
/// ```
pub fn initialize_with_config(
configuration: GooseConfiguration,
) -> Result<GooseAttack, GooseError> {
Ok(GooseAttack {
test_start_transaction: None,
test_stop_transaction: None,
scenarios: Vec::new(),
scenario_machine_names: HashSet::new(),
weighted_users: Vec::new(),
weighted_gaggle_users: Vec::new(),
defaults: GooseDefaults::default(),
configuration,
attack_mode: AttackMode::Undefined,
attack_phase: AttackPhase::Idle,
scheduler: GooseScheduler::RoundRobin,
started: None,
test_plan: TestPlan::new(),
step_started: None,
metrics: GooseMetrics::default(),
graph_data: GraphData::new(),
})
}
/// Define the order [`Scenario`](./goose/struct.Scenario.html)s are
/// allocated to new [`GooseUser`](./goose/struct.GooseUser.html)s as they are
/// launched.
///
/// By default, [`Scenario`](./goose/struct.Scenario.html)s are allocated
/// to new [`GooseUser`](./goose/struct.GooseUser.html)s in a round robin style.
/// For example, if Scenario A has a weight of 5, Scenario B has a weight of 3, and
/// you launch 20 users, they will be launched in the following order:
/// A, B, A, B, A, B, A, A, A, B, A, B, A, B, A, A, A, B, A, B
///
/// Note that the following pattern is repeated:
/// A, B, A, B, A, B, A, A
///
/// If reconfigured to schedule serially, then they will instead be allocated in
/// the following order:
/// A, A, A, A, A, B, B, B, A, A, A, A, A, B, B, B, A, A, A, A
///
/// In the serial case, the following pattern is repeated:
/// A, A, A, A, A, B, B, B
///
/// In the following example, [`Scenario`](./goose/struct.Scenario.html)s
/// are allocated to launching [`GooseUser`](./goose/struct.GooseUser.html)s in a
/// random order. This means running the test multiple times can generate
/// different amounts of load, as depending on your weighting rules you may
/// have a different number of [`GooseUser`](./goose/struct.GooseUser.html)s
/// running each [`Scenario`](./goose/struct.Scenario.html) each time.
///
/// # Example
/// ```rust
/// use goose::prelude::*;
///
/// #[tokio::main]
/// async fn main() -> Result<(), GooseError> {
/// GooseAttack::initialize()?
/// .set_scheduler(GooseScheduler::Random)
/// .register_scenario(scenario!("A Scenario")
/// .set_weight(5)?
/// .register_transaction(transaction!(a_transaction))
/// )
/// .register_scenario(scenario!("B Scenario")
/// .set_weight(3)?
/// .register_transaction(transaction!(b_transaction))
/// );
///
/// Ok(())
/// }
///
/// async fn a_transaction(user: &mut GooseUser) -> TransactionResult {
/// let _goose = user.get("/foo").await?;
///
/// Ok(())
/// }
///
/// async fn b_transaction(user: &mut GooseUser) -> TransactionResult {
/// let _goose = user.get("/bar").await?;
///
/// Ok(())
/// }
/// ```
pub fn set_scheduler(mut self, scheduler: GooseScheduler) -> Self {
self.scheduler = scheduler;
self
}
/// A load test must contain one or more [`Scenario`](./goose/struct.Scenario.html)s
/// be registered into Goose's global state with this method for it to run.
///
/// # Example
/// ```rust
/// use goose::prelude::*;
///
/// #[tokio::main]
/// async fn main() -> Result<(), GooseError> {
/// GooseAttack::initialize()?
/// .register_scenario(scenario!("ExampleScenario")
/// .register_transaction(transaction!(example_transaction))
/// )
/// .register_scenario(scenario!("OtherScenario")
/// .register_transaction(transaction!(other_transaction))
/// );
///
/// Ok(())
/// }
///
/// async fn example_transaction(user: &mut GooseUser) -> TransactionResult {
/// let _goose = user.get("/foo").await?;
///
/// Ok(())
/// }
///
/// async fn other_transaction(user: &mut GooseUser) -> TransactionResult {
/// let _goose = user.get("/bar").await?;
///
/// Ok(())
/// }
/// ```
pub fn register_scenario(mut self, mut scenario: Scenario) -> Self {
scenario.scenarios_index = self.scenarios.len();
// Machine names must be unique. If this machine name has already been seen, add an
// integer at the end to differentiate.
let mut conflicts: u32 = 0;
let mut machine_name = scenario.machine_name.to_string();
// Inserting into the scenario_machine_names hashset will fail if this is name was
// already seen.
while !self.scenario_machine_names.insert(machine_name) {
// For each conflict increase the counter and try again.
conflicts += 1;
machine_name = format!("{}_{}", scenario.machine_name, conflicts);
}
// If there was a conflict, also update the scenario itself.
if conflicts > 0 {
scenario.machine_name = format!("{}_{}", scenario.machine_name, conflicts);
}
// Finally, register the scenario.
self.scenarios.push(scenario);
self
}
/// Optionally define a transaction to run before users are started and all transactions
/// start running. This is would generally be used to set up anything required
/// for the load test.
///
/// The [`GooseUser`](./goose/struct.GooseUser.html) used to run the `test_start`
/// transactions is not preserved and does not otherwise affect the subsequent
/// [`GooseUser`](./goose/struct.GooseUser.html)s that run the rest of the load
/// test. For example, if the [`GooseUser`](./goose/struct.GooseUser.html)
/// logs in during `test_start`, subsequent [`GooseUser`](./goose/struct.GooseUser.html)
/// do not retain this session and are therefor not already logged in.
///
/// When running in a distributed Gaggle, this transaction is only run one time by the
/// Manager.
///
/// # Example
/// ```rust
/// use goose::prelude::*;
///
/// #[tokio::main]
/// async fn main() -> Result<(), GooseError> {
/// GooseAttack::initialize()?
/// .test_start(transaction!(setup));
///
/// Ok(())
/// }
///
/// async fn setup(user: &mut GooseUser) -> TransactionResult {
/// // do stuff to set up load test ...
///
/// Ok(())
/// }
/// ```
pub fn test_start(mut self, transaction: Transaction) -> Self {
self.test_start_transaction = Some(transaction);
self
}
/// Optionally define a transaction to run after all users have finished running
/// all defined transactions. This would generally be used to clean up anything
/// that was specifically set up for the load test.
///
/// When running in a distributed Gaggle, this transaction is only run one time by the
/// Manager.
///
/// # Example
/// ```rust
/// use goose::prelude::*;
///
/// #[tokio::main]
/// async fn main() -> Result<(), GooseError> {
/// GooseAttack::initialize()?
/// .test_stop(transaction!(teardown));
///
/// Ok(())
/// }
///
/// async fn teardown(user: &mut GooseUser) -> TransactionResult {
/// // do stuff to tear down the load test ...
///
/// Ok(())
/// }
/// ```
pub fn test_stop(mut self, transaction: Transaction) -> Self {
self.test_stop_transaction = Some(transaction);
self
}
/// Internal helper to determine if the scenario is currently active.
fn scenario_is_active(&self, scenario: &Scenario) -> bool {
// All scenarios are enabled by default.
if self.configuration.scenarios.active.is_empty() {
true
// Returns true or false depending on if the machine name is included in the
// configured `--scenarios`.
} else {
for active in &self.configuration.scenarios.active {
if scenario.machine_name.contains(active) {
return true;
}
}
// No matches found, this scenario is not active.
false
}
}
/// Use configured GooseScheduler to build out a properly weighted list of
/// [`Scenario`](./goose/struct.Scenario.html)s to be assigned to
/// [`GooseUser`](./goose/struct.GooseUser.html)s
fn allocate_scenarios(&mut self) -> Vec<usize> {
trace!("allocate_scenarios");
let mut u: usize = 0;
let mut v: usize;
for scenario in &self.scenarios {
if self.scenario_is_active(scenario) {
if u == 0 {
u = scenario.weight;
} else {
v = scenario.weight;
trace!("calculating greatest common denominator of {} and {}", u, v);
u = util::gcd(u, v);
trace!("inner gcd: {}", u);
}
}
}
// 'u' will always be the greatest common divisor
debug!("gcd: {}", u);
// Build a vector of vectors to be used to schedule users.
let mut available_scenarios = Vec::with_capacity(self.scenarios.len());
let mut total_scenarios = 0;
for (index, scenario) in self.scenarios.iter().enumerate() {
if self.scenario_is_active(scenario) {
// divide by greatest common divisor so vector is as short as possible
let weight = scenario.weight / u;
trace!(
"{}: {} has weight of {} (reduced with gcd to {})",
index,
scenario.name,
scenario.weight,
weight
);
let weighted_sets = vec![index; weight];
total_scenarios += weight;
available_scenarios.push(weighted_sets);
}
}
info!(
"allocating transactions and scenarios with {:?} scheduler",
self.scheduler
);
// Now build the weighted list with the appropriate scheduler.
let mut weighted_scenarios = Vec::new();
match self.scheduler {
GooseScheduler::RoundRobin => {
// Allocate scenarios round robin.
let scenarios_len = available_scenarios.len();
loop {
for (scenario_index, scenarios) in available_scenarios
.iter_mut()
.enumerate()
.take(scenarios_len)
{
if let Some(scenario) = scenarios.pop() {
debug!("allocating 1 user from Scenario {}", scenario_index);
weighted_scenarios.push(scenario);
}
}
if weighted_scenarios.len() >= total_scenarios {
break;
}
}
}
GooseScheduler::Serial => {
// Allocate scenarios serially in the weighted order defined.
for (scenario_index, scenarios) in available_scenarios.iter().enumerate() {
debug!(
"allocating all {} users from Scenario {}",
scenarios.len(),
scenario_index,
);
weighted_scenarios.append(&mut scenarios.clone());
}
}
GooseScheduler::Random => {
// Allocate scenarios randomly.
loop {
let scenario = available_scenarios.choose_mut(&mut rand::thread_rng());
match scenario {
Some(set) => {
if let Some(s) = set.pop() {
weighted_scenarios.push(s);
}
}
None => warn!("randomly allocating a Scenario failed, trying again"),
}
if weighted_scenarios.len() >= total_scenarios {
break;
}
}
}
}
weighted_scenarios
}
/// Pre-allocate a vector of weighted [`GooseUser`](./goose/struct.GooseUser.html)s.
fn weight_scenario_users(&mut self, total_users: usize) -> Result<Vec<GooseUser>, GooseError> {
trace!("weight_scenario_users");
let weighted_scenarios = self.allocate_scenarios();
// Allocate a state for each user that will be launched.
info!(
"initializing {} user states...",
self.test_plan.total_users()
);
let mut weighted_users = Vec::new();
let mut user_count = 0;
loop {
for scenarios_index in &weighted_scenarios {
debug!(
"creating user state: {} ({})",
weighted_users.len(),
scenarios_index
);
let base_url = goose::get_base_url(
self.get_configuration_host(),
self.scenarios[*scenarios_index].host.clone(),
self.defaults.host.clone(),
)?;
weighted_users.push(GooseUser::new(
self.scenarios[*scenarios_index].scenarios_index,
base_url,
&self.configuration,
self.metrics.hash,
)?);
user_count += 1;
if user_count == total_users {
debug!("created {} weighted_users", user_count);
return Ok(weighted_users);
}
}
}
}
/// Allocate a vector of weighted [`GaggleUser`](./goose/struct.GaggleUser.html).
fn prepare_worker_scenario_users(&mut self) -> Result<Vec<GaggleUser>, GooseError> {
trace!("prepare_worker_scenario_users");
let weighted_scenarios = self.allocate_scenarios();
// Determine the users sent to each Worker.
info!("preparing users for Workers...");
let mut weighted_users = Vec::new();
let mut user_count = 0;
loop {
for scenarios_index in &weighted_scenarios {
let base_url = goose::get_base_url(
self.get_configuration_host(),
self.scenarios[*scenarios_index].host.clone(),
self.defaults.host.clone(),
)?;
weighted_users.push(GaggleUser::new(
self.scenarios[*scenarios_index].scenarios_index,
base_url,
&self.configuration,
self.metrics.hash,
));
user_count += 1;
if user_count == self.test_plan.total_users() {
debug!("prepared {} weighted_gaggle_users", user_count);
return Ok(weighted_users);
}
}
}
}
// Change from one attack_phase to another.
fn set_attack_phase(
&mut self,
goose_attack_run_state: &mut GooseAttackRunState,
phase: AttackPhase,
) {
// There's nothing to do if already in the specified phase.
if self.attack_phase == phase {
return;
}
// The drift timer starts at 0 any time the phase is changed.
goose_attack_run_state.drift_timer = tokio::time::Instant::now();
// Optional debug output.
info!("entering GooseAttack phase: {:?}", &phase);
// Update the current phase.
self.attack_phase = phase;
}
// If enabled, returns the path of the report_file, otherwise returns None.
fn get_report_file_path(&mut self) -> Option<String> {
// Return if enabled.
if !self.configuration.report_file.is_empty() {
Some(self.configuration.report_file.to_string())
// Otherwise there is no report file.
} else {
None
}
}
// Display all scenarios (sorted by machine name).
fn print_scenarios(&self) {
let mut scenarios = BTreeMap::new();
println!("Scenarios:");
for scenario in &self.scenarios {
scenarios.insert(scenario.machine_name.clone(), scenario.clone());
}
// Display sorted by machine_name.
for (key, scenario) in scenarios {
println!(r#" - {}: ("{}")"#, key, scenario.name);
}
}
/// Execute the [`GooseAttack`](./struct.GooseAttack.html) load test.
///
/// # Example
/// ```rust
/// use goose::prelude::*;
///
/// #[tokio::main]
/// async fn main() -> Result<(), GooseError> {
/// let _goose_metrics = GooseAttack::initialize()?
/// .register_scenario(scenario!("ExampleTransaction")
/// .register_transaction(transaction!(example_transaction).set_weight(2)?)
/// .register_transaction(transaction!(another_example_transaction).set_weight(3)?)
/// // Goose must run against a host, point to localhost so test starts.
/// .set_host("http://localhost")
/// )
/// // Exit after one second so test doesn't run forever.
/// .set_default(GooseDefault::RunTime, 1)?
/// .execute()
/// .await?;
///
/// Ok(())
/// }
///
/// async fn example_transaction(user: &mut GooseUser) -> TransactionResult {
/// let _goose = user.get("/foo").await?;
///
/// Ok(())
/// }
///
/// async fn another_example_transaction(user: &mut GooseUser) -> TransactionResult {
/// let _goose = user.get("/bar").await?;
///
/// Ok(())
/// }
/// ```
pub async fn execute(mut self) -> Result<GooseMetrics, GooseError> {
// If version flag is set, display package name and version and exit.
if self.configuration.version {
println!("{} {}", env!("CARGO_PKG_NAME"), env!("CARGO_PKG_VERSION"));
std::process::exit(0);
}
// At least one scenario is required.
if self.scenarios.is_empty() {
return Err(GooseError::NoScenarios {
detail: "No scenarios are defined.".to_string(),
});
}
// Display scenarios and transactions, then exit.
if self.configuration.list {
println!("Available transactions:");
for scenario in self.scenarios {
println!(" - {} (weight: {})", scenario.name, scenario.weight);
for transaction in scenario.transactions {
println!(
" o {} (weight: {})",
transaction.name, transaction.weight
);
}
}
std::process::exit(0);
}
// Configure GooseConfiguration.
self.configuration.configure(&self.defaults);
// Validate GooseConfiguration.
self.configuration.validate()?;
// Display scenarios, then exit.
if self.configuration.scenarios_list {
self.print_scenarios();
std::process::exit(0);
}
// At least one scenario must be active.
let mut active_scenario: bool = false;
for scenario in &self.scenarios {
if self.scenario_is_active(scenario) {
active_scenario = true;
break;
}
}
if !active_scenario {
self.print_scenarios();
return Err(GooseError::NoScenarios {
detail: "No scenarios are enabled.".to_string(),
});
}
// Build TestPlan.
self.test_plan = TestPlan::build(&self.configuration);
// With a validated GooseConfiguration, enter a run mode.
self.attack_mode = if self.configuration.manager {
AttackMode::Manager
} else if self.configuration.worker {
AttackMode::Worker
} else {
AttackMode::StandAlone
};
// Confirm there's either a global host, or each scenario has a host defined.
if self.configuration.no_autostart && self.validate_host().is_err() {
info!("host must be configured via Controller before starting load test");
} else {
// If configuration.host is empty, then it will fall back to per-scenario
// defaults if set.
if !self.configuration.host.is_empty() {
info!("global host configured: {}", self.configuration.host);
}
self.prepare_load_test()?;
}
// Calculate a unique hash for the current load test.
let mut s = DefaultHasher::new();
self.scenarios.hash(&mut s);
self.metrics.hash = s.finish();
debug!("hash: {}", self.metrics.hash);
// Start goose in manager mode.
if self.attack_mode == AttackMode::Manager {
#[cfg(feature = "gaggle")]
{
self = manager::manager_main(self).await;
}
#[cfg(not(feature = "gaggle"))]
{
return Err(GooseError::FeatureNotEnabled {
feature: "gaggle".to_string(), detail: "Load test must be recompiled with `--features gaggle` to start in manager mode.".to_string()
});
}
}
// Start goose in worker mode.
else if self.attack_mode == AttackMode::Worker {
#[cfg(feature = "gaggle")]
{
self = worker::worker_main(self).await;
}
#[cfg(not(feature = "gaggle"))]
{
return Err(GooseError::FeatureNotEnabled {
feature: "gaggle".to_string(),
detail: "Load test must be recompiled with `--features gaggle` to start in worker mode.".to_string(),
});
}
}
// Start goose in single-process mode.
else {
self = self.start_attack(None).await?;
}
if self.metrics.display_metrics {
info!(
"printing final metrics after {} seconds...",
self.metrics.duration
);
print!("{}", self.metrics);
// Write an html report, if enabled.
self.write_html_report().await?;
}
Ok(self.metrics)
}
// Returns OK(()) if there's a valid host, GooseError with details if not.
fn validate_host(&mut self) -> Result<(), GooseError> {
if self.configuration.host.is_empty() {
for scenario in &self.scenarios {
match &scenario.host {
Some(h) => {
if util::is_valid_host(h).is_ok() {
info!("host for {} configured: {}", scenario.name, h);
}
}
None => match &self.defaults.host {
Some(h) => {
if util::is_valid_host(h).is_ok() {
info!("host for {} configured: {}", scenario.name, h);
}
}
None => {
if self.attack_mode != AttackMode::Worker {
return Err(GooseError::InvalidOption {
option: "--host".to_string(),
value: "".to_string(),
detail: format!("A host must be defined via the --host option, the GooseAttack.set_default() function, or the Scenario.set_host() function (no host defined for {}).", scenario.name)
});
}
}
},
}
}
}
Ok(())
}
// Create and schedule GooseUsers. This requires that the host that will be load tested
// has been configured.
fn prepare_load_test(&mut self) -> Result<(), GooseError> {
// If not on a Worker, be sure a valid host has been defined before building configuration.
if self.attack_mode != AttackMode::Worker {
self.validate_host()?;
}
// Apply weights to transactions in each scenario.
for scenario in &mut self.scenarios {
let (
weighted_on_start_transactions,
weighted_transactions,
weighted_on_stop_transactions,
) = allocate_transactions(scenario, &self.scheduler);
scenario.weighted_on_start_transactions = weighted_on_start_transactions;
scenario.weighted_transactions = weighted_transactions;
scenario.weighted_on_stop_transactions = weighted_on_stop_transactions;
debug!(
"weighted {} on_start: {:?} transactions: {:?} on_stop: {:?}",
scenario.name,
scenario.weighted_on_start_transactions,
scenario.weighted_transactions,
scenario.weighted_on_stop_transactions
);
}
if self.attack_mode != AttackMode::Worker {
// Stand-alone and Manager processes can display metrics.
if !self.configuration.no_metrics && !self.configuration.no_print_metrics {
self.metrics.display_metrics = true;
}
if self.attack_mode == AttackMode::StandAlone {
// Allocate a state for each of the users we are about to start.
self.weighted_users = self.weight_scenario_users(self.test_plan.total_users())?;
} else if self.attack_mode == AttackMode::Manager {
// Build a list of users to be allocated on Workers.
self.weighted_gaggle_users = self.prepare_worker_scenario_users()?;
}
}
Ok(())
}
/// Helper to wrap configured host in `Option<>` if set.
fn get_configuration_host(&self) -> Option<String> {
if self.configuration.host.is_empty() {
None
} else {
Some(self.configuration.host.to_string())
}
}
// Helper to spawn a throttle thread if configured. The throttle thread opens
// a bounded channel to control how quickly [`GooseUser`](./goose/struct.GooseUser.html)
// threads can make requests.
async fn setup_throttle(
&self,
) -> (
// A channel used by [`GooseUser`](./goose/struct.GooseUser.html)s to throttle requests.
Option<flume::Sender<bool>>,
// A channel used by parent to tell throttle the load test is complete.
Option<flume::Sender<bool>>,
) {
// If the throttle isn't enabled, return immediately.
if self.configuration.throttle_requests == 0 {
return (None, None);
}
// Create a bounded channel allowing single-sender multi-receiver to throttle
// [`GooseUser`](./goose/struct.GooseUser.html) threads.
let (all_threads_throttle, throttle_receiver): (
flume::Sender<bool>,
flume::Receiver<bool>,
) = flume::bounded(self.configuration.throttle_requests);
// Create a channel allowing the parent to inform the throttle thread when the
// load test is finished. Even though we only send one message, we can't use a
// oneshot channel as we don't want to block waiting for a message.
let (parent_to_throttle_tx, throttle_rx) = flume::bounded(1);
// Launch a new thread for throttling, no need to rejoin it.
let _ = Some(tokio::spawn(throttle::throttle_main(
self.configuration.throttle_requests,
throttle_receiver,
throttle_rx,
)));
let sender = all_threads_throttle.clone();
// We start from 1 instead of 0 to intentionally fill all but one slot in the
// channel to avoid a burst of traffic during startup. The channel then provides
// an implementation of the leaky bucket algorithm as a queue. Requests have to
// add a token to the bucket before making a request, and are blocked until this
// throttle thread "leaks out" a token thereby creating space. More information
// can be found at: https://en.wikipedia.org/wiki/Leaky_bucket
for _ in 1..self.configuration.throttle_requests {
let _ = sender.send_async(true).await;
}
(Some(all_threads_throttle), Some(parent_to_throttle_tx))
}
// Helper to optionally spawn a telnet and/or WebSocket Controller thread. The Controller
// threads share a control channel, allowing it to send requests to the parent process. When
// a response is required, the Controller will also send a one-shot channel allowing a direct
// reply.
async fn setup_controllers(&mut self) -> Option<flume::Receiver<ControllerRequest>> {
// If the telnet controller is disabled, return immediately.
if self.configuration.no_telnet && self.configuration.no_websocket {
return None;
}
// Create an unbounded channel for controller threads to send requests to the parent
// process.
let (all_threads_controller_request_tx, controller_request_rx): (
flume::Sender<ControllerRequest>,
flume::Receiver<ControllerRequest>,
) = flume::unbounded();
// Configured telnet Controller if not disabled.
if !self.configuration.no_telnet {
// Configure telnet_host, using default if run-time option is not set.
if self.configuration.telnet_host.is_empty() {
self.configuration.telnet_host =
if let Some(host) = self.defaults.telnet_host.clone() {
host
} else {
"0.0.0.0".to_string()
}
}
// Then configure telnet_port, using default if run-time option is not set.
if self.configuration.telnet_port == 0 {
self.configuration.telnet_port = if let Some(port) = self.defaults.telnet_port {
port
} else {
DEFAULT_TELNET_PORT.to_string().parse().unwrap()
};
}
// Spawn the initial controller thread to allow real-time control of the load test.
// There is no need to rejoin this thread when the load test ends.
let _ = Some(tokio::spawn(controller::controller_main(
self.configuration.clone(),
all_threads_controller_request_tx.clone(),
ControllerProtocol::Telnet,
)));
}
// Configured WebSocket Controller if not disabled.
if !self.configuration.no_websocket {
// Configure websocket_host, using default if run-time option is not set.
if self.configuration.websocket_host.is_empty() {
self.configuration.websocket_host =
if let Some(host) = self.defaults.websocket_host.clone() {
host
} else {
"0.0.0.0".to_string()
}
}
// Then configure websocket_port, using default if run-time option is not set.
if self.configuration.websocket_port == 0 {
self.configuration.websocket_port = if let Some(port) = self.defaults.websocket_port
{
port
} else {
DEFAULT_WEBSOCKET_PORT.to_string().parse().unwrap()
};
}
// Spawn the initial controller thread to allow real-time control of the load test.
// There is no need to rejoin this thread when the load test ends.
let _ = Some(tokio::spawn(controller::controller_main(
self.configuration.clone(),
all_threads_controller_request_tx,
ControllerProtocol::WebSocket,
)));
}
// Return the parent end of the Controller channel.
Some(controller_request_rx)
}
// Prepare an asynchronous file writer for `report_file` (if enabled).
async fn prepare_report_file(&mut self) -> Result<Option<File>, GooseError> {
if let Some(report_file_path) = self.get_report_file_path() {
Ok(Some(File::create(&report_file_path).await?))
} else {
Ok(None)
}
}
// Invoke `test_start` transactions if existing.
async fn run_test_start(&self) -> Result<(), GooseError> {
// Initialize per-user states.
if self.attack_mode != AttackMode::Worker {
// First run global test_start_transaction, if defined.
match &self.test_start_transaction {
Some(t) => {
info!("running test_start_transaction");
// Create a one-time-use User to run the test_start_transaction.
let base_url = goose::get_base_url(
self.get_configuration_host(),
None,
self.defaults.host.clone(),
)?;
let mut user = GooseUser::single(base_url, &self.configuration)?;
let function = &t.function;
let _ = function(&mut user).await;
}
// No test_start_transaction defined, nothing to do.
None => (),
}
}
Ok(())
}
// Invoke `test_stop` transactions if existing.
async fn run_test_stop(&self) -> Result<(), GooseError> {
// Initialize per-user states.
if self.attack_mode != AttackMode::Worker {
// First run global test_stop_transaction, if defined.
match &self.test_stop_transaction {
Some(t) => {
info!("running test_stop_transaction");
// Create a one-time-use User to run the test_stop_transaction.
let base_url = goose::get_base_url(
self.get_configuration_host(),
None,
self.defaults.host.clone(),
)?;
let mut user = GooseUser::single(base_url, &self.configuration)?;
let function = &t.function;
let _ = function(&mut user).await;
}
// No test_stop_transaction defined, nothing to do.
None => (),
}
}
Ok(())
}
// Create a GooseAttackRunState object and do all initialization required
// to start a [`GooseAttack`](./struct.GooseAttack.html).
async fn initialize_attack(
&mut self,
socket: Option<Socket>,
) -> Result<GooseAttackRunState, GooseError> {
trace!("initialize_attack");
// Create a single channel used to send metrics from GooseUser threads
// to parent thread.
let (all_threads_metrics_tx, metrics_rx): (
flume::Sender<GooseMetric>,
flume::Receiver<GooseMetric>,
) = flume::unbounded();
// Create a single channel to allow GooseUser threads to notify the
// parent thread when they exit.
let (all_threads_shutdown_tx, shutdown_rx): (flume::Sender<usize>, flume::Receiver<usize>) =
flume::unbounded();
// Optionally spawn a telnet and/or Websocket Controller thread.
let controller_channel_rx = self.setup_controllers().await;
// Grab now() once from the standard library, used by multiple timers in
// the run state.
let std_now = std::time::Instant::now();
let goose_attack_run_state = GooseAttackRunState {
adjust_user_timer: std_now,
adjust_user_in_ms: 0,
active_users: 0,
completed_users: 0,
drift_timer: tokio::time::Instant::now(),
all_threads_metrics_tx,
all_threads_shutdown_tx,
metrics_rx,
shutdown_rx,
logger_handle: None,
all_threads_logger_tx: None,
throttle_threads_tx: None,
parent_to_throttle_tx: None,
controller_channel_rx,
metrics_header_displayed: false,
idle_status_displayed: false,
users: Vec::new(),
user_channels: Vec::new(),
running_metrics_timer: std_now,
display_running_metrics: false,
users_shutdown: HashSet::new(),
all_users_spawned: false,
shutdown_after_stop: !self.configuration.no_autostart,
canceling: false,
socket,
};
// Access socket to avoid errors.
trace!("socket: {:?}", &goose_attack_run_state.socket);
// Catch ctrl-c to allow clean shutdown to display metrics.
util::setup_ctrlc_handler();
Ok(goose_attack_run_state)
}
// Determine how long has elapsed since this step started.
fn step_elapsed(&mut self) -> u128 {
if let Some(step_started) = self.step_started {
step_started.elapsed().as_millis()
} else if let Some(started) = self.started {
started.elapsed().as_millis()
} else {
// An idle load test.
0
}
}
// Add delay before starting next step if there's time remaining.
async fn end_of_step_delay(&mut self) {
// Determine if there's remaining time in this step.
let elapsed = self.step_elapsed() as u64;
if elapsed < self.test_plan.steps[self.test_plan.current].1 as u64 {
let remainder = self.test_plan.steps[self.test_plan.current].1 as u64 - elapsed;
// Sleep 500ms, or all remaining time if less -- this will continue looping until all time remaining
// on the current step runs out, waking up regularly to handle events like the load test being
// canceled or a controller command.
let maximum_sleep = 500;
let sleep_duration = if remainder > maximum_sleep {
Duration::from_millis(maximum_sleep)
} else {
Duration::from_millis(remainder)
};
tokio::time::sleep(sleep_duration).await
}
}
// Increase the number of active [`GooseUser`](./goose/struct.GooseUser.html) threads in the
// active [`GooseAttack`](./struct.GooseAttack.html).
async fn increase_attack(
&mut self,
goose_attack_run_state: &mut GooseAttackRunState,
) -> Result<(), GooseError> {
// Determine if enough users have been launched.
let all_users_launched = match self.attack_mode {
AttackMode::Worker | AttackMode::Manager => {
// If running in Gaggle mode, all configured users must be launched.
self.weighted_users.is_empty()
}
_ => {
// If not running in Gaggle mode, all users for current step must be launched.
goose_attack_run_state.active_users
>= self.test_plan.steps[self.test_plan.current].0
}
};
if all_users_launched {
// All users were increased, delay until test_plan step time has elapsed.
self.end_of_step_delay().await;
if self.step_elapsed() as usize >= self.test_plan.steps[self.test_plan.current].1 {
if self.attack_mode == AttackMode::Worker {
info!(
"[{}] launched {} users...",
get_worker_id(),
self.test_plan.steps[self.test_plan.current].0
);
}
// Automatically reset metrics if appropriate.
self.reset_metrics(goose_attack_run_state).await?;
// Moving to the next phase, reset adjust_user_in_ms.
goose_attack_run_state.adjust_user_in_ms = 0;
// Advance to the next TestPlan step.
self.advance_test_plan(goose_attack_run_state);
}
} else {
// If this is the first load plan step, then there were no previously started users.
let previous_users = if self.test_plan.current == 0 {
0
// Otherwise retreive the number of users configured in the previous step.
} else {
self.test_plan.steps[self.test_plan.current - 1].0
};
// Sanity check: increase_attack can only be called if the number of users is increasing
// in the current step.
assert!(self.test_plan.steps[self.test_plan.current].0 > previous_users);
// Divide the number of new users to launch by the time configured to launch them.
let increase_rate: f32 = (self.test_plan.steps[self.test_plan.current].0 - previous_users)
as f32
/ self.test_plan.steps[self.test_plan.current].1 as f32
// Convert from milliseconds to seconds.
* 1_000.0;
// Determine if it's time to spawn a GooseUser.
if goose_attack_run_state.adjust_user_in_ms == 0
|| util::ms_timer_expired(
goose_attack_run_state.adjust_user_timer,
goose_attack_run_state.adjust_user_in_ms,
)
{
let mut thread_user = self
.weighted_users
.pop()
.expect("insufficent weighted_users");
// Reset the spawn timer.
goose_attack_run_state.adjust_user_timer = std::time::Instant::now();
// To determine how long before we spawn the next GooseUser, start with 1,000.0
// milliseconds and divide by the increase_rate.
goose_attack_run_state.adjust_user_in_ms = (1_000.0 / increase_rate) as usize;
// If running on a Worker, multiply by the number of workers as each is spawning
// GooseUsers at this rate.
if self.attack_mode == AttackMode::Worker {
goose_attack_run_state.adjust_user_in_ms *=
self.configuration.expect_workers.unwrap() as usize;
};
// Remember which task group this user is using.
thread_user.weighted_users_index = self.metrics.total_users;
// Create a per-thread channel allowing parent thread to control child threads.
let (parent_sender, thread_receiver): (
flume::Sender<GooseUserCommand>,
flume::Receiver<GooseUserCommand>,
) = flume::unbounded();
goose_attack_run_state.user_channels.push(parent_sender);
// Clone the logger_tx if enabled, otherwise is None.
thread_user.logger = goose_attack_run_state.all_threads_logger_tx.clone();
// Copy the GooseUser-throttle receiver channel, used by all threads.
thread_user.throttle = if self.configuration.throttle_requests > 0 {
Some(goose_attack_run_state.throttle_threads_tx.clone().unwrap())
} else {
None
};
// Copy the GooseUser-metrics sender channel, used by all threads.
thread_user.metrics_channel =
Some(goose_attack_run_state.all_threads_metrics_tx.clone());
// Copy the GooseUser-shutdown sender channel, used by all threads.
thread_user.shutdown_channel =
Some(goose_attack_run_state.all_threads_shutdown_tx.clone());
// Copy the appropriate task_set into the thread.
let thread_scenario = self.scenarios[thread_user.scenarios_index].clone();
// Start at 1 as this is human visible.
let thread_number = self.metrics.total_users + 1;
let is_worker = self.attack_mode == AttackMode::Worker;
// If running on Worker, use Worker configuration in GooseUser.
if is_worker {
thread_user.config = self.configuration.clone();
}
// Launch a new user.
let user = tokio::spawn(user::user_main(
thread_number,
thread_scenario,
thread_user,
thread_receiver,
is_worker,
));
goose_attack_run_state.users.push(user);
goose_attack_run_state.active_users += 1;
self.metrics.total_users += 1;
if goose_attack_run_state.active_users > self.metrics.maximum_users {
self.metrics.maximum_users = goose_attack_run_state.active_users;
}
if let Some(running_metrics) = self.configuration.running_metrics {
if self.attack_mode != AttackMode::Worker
&& util::ms_timer_expired(
goose_attack_run_state.running_metrics_timer,
running_metrics,
)
{
goose_attack_run_state.running_metrics_timer = time::Instant::now();
self.metrics.print_running();
}
}
} else {
// Wake up twice a second to handle messages and allow for a quick shutdown if the
// load test is canceled during startup.
let sleep_duration = if goose_attack_run_state.adjust_user_in_ms > 500 {
Duration::from_millis(500)
} else {
Duration::from_millis(goose_attack_run_state.adjust_user_in_ms as u64)
};
debug!("sleeping {:?}...", sleep_duration);
goose_attack_run_state.drift_timer =
util::sleep_minus_drift(sleep_duration, goose_attack_run_state.drift_timer)
.await;
}
}
Ok(())
}
// Maintain the number of active [`GooseUser`](./goose/struct.GooseUser.html) threads in the
// active [`GooseAttack`](./struct.GooseAttack.html).
async fn maintain_attack(
&mut self,
goose_attack_run_state: &mut GooseAttackRunState,
) -> Result<(), GooseError> {
// Determine if it's time to move to the next test plan step.
if self.test_plan.current < self.test_plan.steps.len()
&& util::ms_timer_expired(
self.step_started.unwrap(),
self.test_plan.steps[self.test_plan.current].1,
)
{
self.advance_test_plan(goose_attack_run_state);
} else {
// Subtract the time spent doing other things, running the main parent loop twice
// per second.
goose_attack_run_state.drift_timer = util::sleep_minus_drift(
time::Duration::from_millis(500),
goose_attack_run_state.drift_timer,
)
.await;
}
Ok(())
}
// Decrease the number of active [`GooseUser`](./goose/struct.GooseUser.html) threads in the
// active [`GooseAttack`](./struct.GooseAttack.html).
async fn decrease_attack(
&mut self,
goose_attack_run_state: &mut GooseAttackRunState,
) -> Result<(), GooseError> {
// Sanity check: if there's more than one step the first step can't decrease the attack. If there's
// only one step then an idle load test may be being shut down through the controller.
if self.test_plan.steps.len() > 1 {
assert!(self.test_plan.current > 0);
}
// If this is the last step of the load test and there are 0 users, shut down.
if goose_attack_run_state.active_users == 0
// Subtract 1 from len() as it starts at 1 while current starts at 0.
&& self.test_plan.current >= self.test_plan.steps.len() - 1
{
// Load test is shutting down, update pipe handler so there is no panic
// when the Manager goes away.
#[cfg(feature = "gaggle")]
if self.attack_mode == AttackMode::Worker || self.attack_mode == AttackMode::Manager {
let manager = goose_attack_run_state.socket.clone().unwrap();
register_shutdown_pipe_handler(&manager);
}
// If throttle is enabled, tell throttle thread the load test is over.
if let Some(throttle_tx) = goose_attack_run_state.parent_to_throttle_tx.clone() {
let _ = throttle_tx.send(false);
}
// Take the users vector out of the GooseAttackRunState object so it can be
// consumed by futures::future::join_all().
let users = std::mem::take(&mut goose_attack_run_state.users);
futures::future::join_all(users).await;
debug!("all users exited");
// If the logger thread is enabled, tell it to flush and exit.
if goose_attack_run_state.logger_handle.is_some() {
if let Err(e) = goose_attack_run_state
.all_threads_logger_tx
.clone()
.unwrap()
.send(None)
{
warn!("unexpected error telling logger thread to exit: {}", e);
};
// Take logger out of the GooseAttackRunState object so it can be
// consumed by tokio::join!().
let logger = std::mem::take(&mut goose_attack_run_state.logger_handle);
let _ = tokio::join!(logger.unwrap());
}
// If we're printing metrics, collect the final metrics received from users.
if !self.configuration.no_metrics {
// Set the second parameter to true, ensuring that Goose waits until all metrics
// are received.
let _received_message = self.receive_metrics(goose_attack_run_state, true).await?;
}
#[cfg(feature = "gaggle")]
{
// As worker, push metrics up to manager.
if self.attack_mode == AttackMode::Worker {
worker::push_metrics_to_manager(
&goose_attack_run_state.socket.clone().unwrap(),
vec![
GaggleMetrics::Requests(self.metrics.requests.clone()),
GaggleMetrics::Errors(self.metrics.errors.clone()),
GaggleMetrics::Transactions(self.metrics.transactions.clone()),
GaggleMetrics::Scenarios(self.metrics.scenarios.clone()),
],
true,
);
// No need to reset local metrics, the worker is exiting.
}
}
// Stop any running GooseUser threads.
self.stop_attack().await?;
// Collect all metrics sent by GooseUser threads.
self.sync_metrics(goose_attack_run_state, true).await?;
// Record last users for users per second graph in HTML report.
if let Some(started) = self.started {
self.graph_data.record_users_per_second(
goose_attack_run_state.active_users,
started.elapsed().as_secs() as usize,
);
};
// The load test is fully stopped at this point.
self.metrics
.history
.push(TestPlanHistory::step(TestPlanStepAction::Finished, 0));
// Shutdown Goose or go into an idle waiting state.
if goose_attack_run_state.shutdown_after_stop {
self.set_attack_phase(goose_attack_run_state, AttackPhase::Shutdown);
} else {
// Print metrics, if enabled.
if !self.configuration.no_metrics {
println!("{}", self.metrics);
}
// Write an html report, if enabled.
self.write_html_report().await?;
// Return to an Idle state.
self.set_attack_phase(goose_attack_run_state, AttackPhase::Idle);
}
// If this is not the last step of the load test and sufficient users decreased, move to next step.
} else if goose_attack_run_state.active_users
<= self.test_plan.steps[self.test_plan.current].0
{
// Be sure step takes as long as it was configured to.
self.end_of_step_delay().await;
// Then advance to next step.
if self.step_elapsed() as usize >= self.test_plan.steps[self.test_plan.current].1 {
// Moving to the next phase, reset adjust_user_in_ms.
goose_attack_run_state.adjust_user_in_ms = 0;
// Advance to the next TestPlan step.
self.advance_test_plan(goose_attack_run_state);
}
// Otherwise, decrease a user when ready.
} else {
// Retreive the number of users configured in the previous step.
let previous_users = self.test_plan.steps[self.test_plan.current - 1].0;
// Divide the number of users to decrease by the time configured to decrease them.
let decrease_rate: f32 = (previous_users - self.test_plan.steps[self.test_plan.current].0)
as f32
/ self.test_plan.steps[self.test_plan.current].1 as f32
// Convert from milliseconds to seconds.
* 1_000.0;
// Determine if it's time to decrease a GooseUser.
if goose_attack_run_state.adjust_user_in_ms == 0
|| util::ms_timer_expired(
goose_attack_run_state.adjust_user_timer,
goose_attack_run_state.adjust_user_in_ms,
)
{
// Reset the adjust timer.
goose_attack_run_state.adjust_user_timer = std::time::Instant::now();
// To determine how long before we decrease the next GooseUser, start with 1,000.0
// milliseconds and divide by the decrease_rate.
goose_attack_run_state.adjust_user_in_ms = (1_000.0 / decrease_rate) as usize;
if let Some(send_to_user) = goose_attack_run_state.user_channels.pop() {
match send_to_user.send(GooseUserCommand::Exit) {
Ok(_) => {
debug!(
"telling user {} to exit",
goose_attack_run_state.completed_users
);
}
Err(e) => {
// Error is expected if this user already shut down.
if !goose_attack_run_state
.users_shutdown
.contains(&goose_attack_run_state.completed_users)
{
info!(
"failed to tell user {} to exit: {}",
goose_attack_run_state.completed_users, e
);
}
}
}
goose_attack_run_state.completed_users += 1;
goose_attack_run_state.active_users -= 1;
}
} else {
// Wake up twice a second to handle messages and allow for a quick shutdown if the
// load test is canceled during decrease.
let sleep_duration = if goose_attack_run_state.adjust_user_in_ms > 500 {
Duration::from_millis(500)
} else {
Duration::from_millis(goose_attack_run_state.adjust_user_in_ms as u64)
};
debug!("sleeping {:?}...", sleep_duration);
goose_attack_run_state.drift_timer =
util::sleep_minus_drift(sleep_duration, goose_attack_run_state.drift_timer)
.await;
}
}
Ok(())
}
// Quickly abort and shut down an active [`GooseAttack`](./struct.GooseAttack.html).
async fn cancel_attack(
&mut self,
goose_attack_run_state: &mut GooseAttackRunState,
) -> Result<(), GooseError> {
// Determine how long has elapsed since this step started.
let elapsed = self.step_elapsed() as usize;
// Reset the test_plan to stop all users quickly.
self.test_plan.steps = vec![
// Record how many active users there are currently.
(goose_attack_run_state.active_users, elapsed),
// Record how long the attack ran in this step.
(0, 0),
];
// Reset the current step to what was happening when canceled.
self.test_plan.current = 0;
// Moving to the last phase, reset adjust_user_in_ms.
goose_attack_run_state.adjust_user_in_ms = 0;
// Advance to the final decrease phase.
self.advance_test_plan(goose_attack_run_state);
// Load test isn't just decreasing, it's canceling.
self.metrics
.history
.last_mut()
.expect("tried to cancel load test with no history")
.action = TestPlanStepAction::Canceling;
Ok(())
}
// Cleanly shut down the [`GooseAttack`](./struct.GooseAttack.html).
async fn stop_attack(&mut self) -> Result<(), GooseError> {
// Run any configured test_stop() functions.
self.run_test_stop().await?;
// Percentile and errors are only displayed when the load test is finished.
self.metrics.final_metrics = true;
Ok(())
}
// Reset the GooseAttackRunState before starting a load test. This is to allow a Controller
// to stop and start the load test multiple times, for example from a UI.
async fn reset_run_state(
&mut self,
goose_attack_run_state: &mut GooseAttackRunState,
) -> Result<(), GooseError> {
// Run any configured test_start() functions.
self.run_test_start().await.unwrap();
// Prepare to collect metrics, if enabled.
self.metrics = GooseMetrics::default();
if !self.configuration.no_metrics {
self.metrics.initialize_transaction_metrics(
&self.scenarios,
&self.configuration,
&self.defaults,
)?;
self.metrics
.initialize_scenario_metrics(&self.scenarios, &self.configuration);
if !self.configuration.no_print_metrics {
self.metrics.display_metrics = true;
}
// Only display status codes if not disaled.
self.metrics.display_status_codes = !self.configuration.no_status_codes;
}
// Reset the run state.
let std_now = std::time::Instant::now();
goose_attack_run_state.adjust_user_timer = std_now;
goose_attack_run_state.adjust_user_in_ms = 0;
goose_attack_run_state.active_users = 0;
goose_attack_run_state.drift_timer = tokio::time::Instant::now();
goose_attack_run_state.metrics_header_displayed = false;
goose_attack_run_state.idle_status_displayed = false;
goose_attack_run_state.users = Vec::new();
goose_attack_run_state.user_channels = Vec::new();
goose_attack_run_state.running_metrics_timer = std_now;
goose_attack_run_state.display_running_metrics = false;
goose_attack_run_state.shutdown_after_stop = !self.configuration.no_autostart;
goose_attack_run_state.all_users_spawned = false;
// If enabled, spawn a logger thread.
let (logger_handle, all_threads_logger_tx) =
self.configuration.setup_loggers(&self.defaults).await?;
goose_attack_run_state.logger_handle = logger_handle;
goose_attack_run_state.all_threads_logger_tx = all_threads_logger_tx;
// If enabled, spawn a throttle thread.
let (throttle_threads_tx, parent_to_throttle_tx) = self.setup_throttle().await;
goose_attack_run_state.throttle_threads_tx = throttle_threads_tx;
goose_attack_run_state.parent_to_throttle_tx = parent_to_throttle_tx;
// If enabled, try to create the report file to confirm access.
let _report_file = match self.prepare_report_file().await {
Ok(f) => f,
Err(e) => {
return Err(GooseError::InvalidOption {
option: "--report-file".to_string(),
value: self.get_report_file_path().unwrap(),
detail: format!("Failed to create report file: {}", e),
})
}
};
// Record when the GooseAttack officially started.
self.started = Some(time::Instant::now());
Ok(())
}
// Called internally in local-mode and gaggle-mode.
async fn start_attack(mut self, socket: Option<Socket>) -> Result<GooseAttack, GooseError> {
trace!("start_attack: socket({:?})", socket);
// The GooseAttackRunState is used while spawning and running the
// GooseUser threads that generate the load test.
let mut goose_attack_run_state = self
.initialize_attack(socket)
.await
.expect("failed to initialize GooseAttackRunState");
// The Goose parent process GooseAttack loop runs until Goose shuts down. Goose enters
// the loop in AttackPhase::Idle, and exits in AttackPhase::Shutdown.
loop {
match self.attack_phase {
// In the Idle phase the Goose configuration can be changed by a Controller,
// and otherwise nothing happens but sleeping an checking for messages.
AttackPhase::Idle => {
if self.configuration.no_autostart {
// Sleep then check for further instructions.
if goose_attack_run_state.idle_status_displayed {
let sleep_duration = Duration::from_millis(250);
debug!("sleeping {:?}...", sleep_duration);
goose_attack_run_state.drift_timer = util::sleep_minus_drift(
sleep_duration,
goose_attack_run_state.drift_timer,
)
.await;
// Only display informational message about being idle one time.
} else {
info!("Goose is currently idle.");
goose_attack_run_state.idle_status_displayed = true;
}
} else {
// Prepare to start the load test, resetting timers and counters.
self.reset_run_state(&mut goose_attack_run_state).await?;
self.metrics
.history
.push(TestPlanHistory::step(TestPlanStepAction::Increasing, 0));
//self.graph_data.set_starting(Utc::now());
self.set_attack_phase(&mut goose_attack_run_state, AttackPhase::Increase);
}
}
// In the Increase phase, Goose launches GooseUser threads.
AttackPhase::Increase => {
self.update_duration();
self.increase_attack(&mut goose_attack_run_state).await?;
}
// In the Maintain phase, Goose continues runnning all launched GooseUser threads.
AttackPhase::Maintain => {
self.update_duration();
self.maintain_attack(&mut goose_attack_run_state).await?;
}
// In the Decrease phase, Goose stops GooseUser threads.
AttackPhase::Decrease => {
// If displaying metrics, update internal state reflecting how long load test
// has been running.
self.update_duration();
// Reduce the number of GooseUsers running.
self.decrease_attack(&mut goose_attack_run_state).await?;
}
// By reaching the Shutdown phase, break out of the GooseAttack loop.
AttackPhase::Shutdown => break,
}
// Record current users for users per second graph in HTML report.
if let Some(started) = self.started {
self.graph_data.record_users_per_second(
goose_attack_run_state.active_users,
started.elapsed().as_secs() as usize,
);
};
// Regularly synchronize metrics.
self.sync_metrics(&mut goose_attack_run_state, false)
.await?;
// Check if a Controller has made a request.
self.handle_controller_requests(&mut goose_attack_run_state)
.await?;
let mut message = goose_attack_run_state.shutdown_rx.try_recv();
while message.is_ok() {
goose_attack_run_state
.users_shutdown
.insert(message.expect("failed to wrap OK message"));
// In Gaggle mode, the Worker starts a fraction of the users.
#[cfg(feature = "gaggle")]
if goose_attack_run_state.users_shutdown.len()
== goose_attack_run_state.active_users
{
// Pause to allow other Workers a chance to shut down cleanly as well.
tokio::time::sleep(Duration::from_secs(3)).await;
self.cancel_attack(&mut goose_attack_run_state).await?;
}
// In Stand-alone mode, all users are started.
#[cfg(not(feature = "gaggle"))]
if goose_attack_run_state.users_shutdown.len() == self.test_plan.total_users() {
self.cancel_attack(&mut goose_attack_run_state).await?;
}
message = goose_attack_run_state.shutdown_rx.try_recv();
}
// Gracefully exit loop if ctrl-c is caught.
if self.attack_phase != AttackPhase::Shutdown
&& !goose_attack_run_state.canceling
&& *CANCELED.read().unwrap()
{
// Shutdown after stopping as the load test was canceled.
goose_attack_run_state.shutdown_after_stop = true;
// No metrics to display when sitting idle, so disable.
if self.attack_phase == AttackPhase::Idle {
self.metrics.display_metrics = false;
}
// Cleanly stop the load test.
self.cancel_attack(&mut goose_attack_run_state).await?;
// Load test is actively canceling.
goose_attack_run_state.canceling = true;
}
}
Ok(self)
}
}
/// Use the configured GooseScheduler to allocate all [`Transaction`](./goose/struct.Transaction.html)s
/// within the [`Scenario`](./goose/struct.Scenario.html) in the appropriate order. Returns
/// three set of ordered transactions: `on_start_transactions`, `transactions`, and `on_stop_transactions`.
/// The `on_start_transactions` are only run once when the [`GooseAttack`](./struct.GooseAttack.html) first
/// starts. Normal `transactions` are then run for the duration of the
/// [`GooseAttack`](./struct.GooseAttack.html). The `on_stop_transactions` finally are only run once when
/// the [`GooseAttack`](./struct.GooseAttack.html) stops.
fn allocate_transactions(
scenario: &Scenario,
scheduler: &GooseScheduler,
) -> (
WeightedTransactions,
WeightedTransactions,
WeightedTransactions,
) {
debug!(
"allocating Transactions on GooseUsers with {:?} scheduler",
scheduler
);
// A BTreeMap of Vectors allows us to group and sort transactions per sequence value.
let mut sequenced_transactions: SequencedTransactions = BTreeMap::new();
let mut sequenced_on_start_transactions: SequencedTransactions = BTreeMap::new();
let mut sequenced_on_stop_transactions: SequencedTransactions = BTreeMap::new();
let mut unsequenced_transactions: UnsequencedTransactions = Vec::new();
let mut unsequenced_on_start_transactions: UnsequencedTransactions = Vec::new();
let mut unsequenced_on_stop_transactions: UnsequencedTransactions = Vec::new();
let mut u: usize = 0;
let mut v: usize;
// Find the greatest common divisor of all transactions in the scenario.
for transaction in &scenario.transactions {
if transaction.sequence > 0 {
if transaction.on_start {
if let Some(sequence) =
sequenced_on_start_transactions.get_mut(&transaction.sequence)
{
// This is another transaction with this order value.
sequence.push(transaction.clone());
} else {
// This is the first transaction with this order value.
sequenced_on_start_transactions
.insert(transaction.sequence, vec![transaction.clone()]);
}
}
// Allow a transaction to be both on_start and on_stop.
if transaction.on_stop {
if let Some(sequence) =
sequenced_on_stop_transactions.get_mut(&transaction.sequence)
{
// This is another transaction with this order value.
sequence.push(transaction.clone());
} else {
// This is the first transaction with this order value.
sequenced_on_stop_transactions
.insert(transaction.sequence, vec![transaction.clone()]);
}
}
if !transaction.on_start && !transaction.on_stop {
if let Some(sequence) = sequenced_transactions.get_mut(&transaction.sequence) {
// This is another transaction with this order value.
sequence.push(transaction.clone());
} else {
// This is the first transaction with this order value.
sequenced_transactions.insert(transaction.sequence, vec![transaction.clone()]);
}
}
} else {
if transaction.on_start {
unsequenced_on_start_transactions.push(transaction.clone());
}
if transaction.on_stop {
unsequenced_on_stop_transactions.push(transaction.clone());
}
if !transaction.on_start && !transaction.on_stop {
unsequenced_transactions.push(transaction.clone());
}
}
// Look for lowest common divisor amongst all transactions of any weight.
if u == 0 {
u = transaction.weight;
} else {
v = transaction.weight;
trace!("calculating greatest common denominator of {} and {}", u, v);
u = util::gcd(u, v);
trace!("inner gcd: {}", u);
}
}
// 'u' will always be the greatest common divisor
debug!("gcd: {}", u);
// Apply weights to sequenced transactions.
let weighted_sequenced_on_start_transactions =
weight_sequenced_transactions(&sequenced_on_start_transactions, u);
let weighted_sequenced_transactions = weight_sequenced_transactions(&sequenced_transactions, u);
let weighted_sequenced_on_stop_transactions =
weight_sequenced_transactions(&sequenced_on_stop_transactions, u);
// Apply weights to unsequenced transactions.
let (weighted_unsequenced_on_start_transactions, total_unsequenced_on_start_transactions) =
weight_unsequenced_transactions(&unsequenced_on_start_transactions, u);
let (weighted_unsequenced_transactions, total_unsequenced_transactions) =
weight_unsequenced_transactions(&unsequenced_transactions, u);
let (weighted_unsequenced_on_stop_transactions, total_unsequenced_on_stop_transactions) =
weight_unsequenced_transactions(&unsequenced_on_stop_transactions, u);
// Schedule sequenced transactions.
let scheduled_sequenced_on_start_transactions =
schedule_sequenced_transactions(&weighted_sequenced_on_start_transactions, scheduler);
let scheduled_sequenced_transactions =
schedule_sequenced_transactions(&weighted_sequenced_transactions, scheduler);
let scheduled_sequenced_on_stop_transactions =
schedule_sequenced_transactions(&weighted_sequenced_on_stop_transactions, scheduler);
// Schedule unsequenced transactions.
let scheduled_unsequenced_on_start_transactions = schedule_unsequenced_transactions(
&weighted_unsequenced_on_start_transactions,
total_unsequenced_on_start_transactions,
scheduler,
);
let scheduled_unsequenced_transactions = schedule_unsequenced_transactions(
&weighted_unsequenced_transactions,
total_unsequenced_transactions,
scheduler,
);
let scheduled_unsequenced_on_stop_transactions = schedule_unsequenced_transactions(
&weighted_unsequenced_on_stop_transactions,
total_unsequenced_on_stop_transactions,
scheduler,
);
// Finally build a Vector of tuples: (transaction id, transaction name)
let mut on_start_transactions = Vec::new();
let mut transactions = Vec::new();
let mut on_stop_transactions = Vec::new();
// Sequenced transactions come first.
for transaction in scheduled_sequenced_on_start_transactions.iter() {
on_start_transactions.extend(vec![(
*transaction,
scenario.transactions[*transaction].name.to_string(),
)])
}
for transaction in scheduled_sequenced_transactions.iter() {
transactions.extend(vec![(
*transaction,
scenario.transactions[*transaction].name.to_string(),
)])
}
for transaction in scheduled_sequenced_on_stop_transactions.iter() {
on_stop_transactions.extend(vec![(
*transaction,
scenario.transactions[*transaction].name.to_string(),
)])
}
// Unsequenced transactions come last.
for transaction in scheduled_unsequenced_on_start_transactions.iter() {
on_start_transactions.extend(vec![(
*transaction,
scenario.transactions[*transaction].name.to_string(),
)])
}
for transaction in scheduled_unsequenced_transactions.iter() {
transactions.extend(vec![(
*transaction,
scenario.transactions[*transaction].name.to_string(),
)])
}
for transaction in scheduled_unsequenced_on_stop_transactions.iter() {
on_stop_transactions.extend(vec![(
*transaction,
scenario.transactions[*transaction].name.to_string(),
)])
}
// Return sequenced buckets of weighted usize pointers to and names of Transactions.
(on_start_transactions, transactions, on_stop_transactions)
}
/// Build a weighted vector of vectors of unsequenced Transactions.
fn weight_unsequenced_transactions(
unsequenced_transactions: &[Transaction],
u: usize,
) -> (Vec<Vec<usize>>, usize) {
// Build a vector of vectors to be used to schedule users.
let mut available_unsequenced_transactions = Vec::with_capacity(unsequenced_transactions.len());
let mut total_transactions = 0;
for transaction in unsequenced_transactions.iter() {
// divide by greatest common divisor so vector is as short as possible
let weight = transaction.weight / u;
trace!(
"{}: {} has weight of {} (reduced with gcd to {})",
transaction.transactions_index,
transaction.name,
transaction.weight,
weight
);
let weighted_transactions = vec![transaction.transactions_index; weight];
available_unsequenced_transactions.push(weighted_transactions);
total_transactions += weight;
}
(available_unsequenced_transactions, total_transactions)
}
/// Build a weighted vector of vectors of sequenced Transactions.
fn weight_sequenced_transactions(
sequenced_transactions: &SequencedTransactions,
u: usize,
) -> BTreeMap<usize, Vec<Vec<usize>>> {
// Build a sequenced BTreeMap containing weighted vectors of Transactions.
let mut available_sequenced_transactions = BTreeMap::new();
// Step through sequences, each containing a bucket of all Transactions with the same
// sequence value, allowing actual weighting to be done by weight_unsequenced_transactions().
for (sequence, unsequenced_transactions) in sequenced_transactions.iter() {
let (weighted_transactions, _total_weighted_transactions) =
weight_unsequenced_transactions(unsequenced_transactions, u);
available_sequenced_transactions.insert(*sequence, weighted_transactions);
}
available_sequenced_transactions
}
fn schedule_sequenced_transactions(
available_sequenced_transactions: &BTreeMap<usize, Vec<Vec<usize>>>,
scheduler: &GooseScheduler,
) -> Vec<usize> {
let mut weighted_transactions: Vec<usize> = Vec::new();
for (_sequence, transactions) in available_sequenced_transactions.iter() {
let scheduled_transactions =
schedule_unsequenced_transactions(transactions, transactions[0].len(), scheduler);
weighted_transactions.extend(scheduled_transactions);
}
weighted_transactions
}
// Return a list of transactions in the order to be run.
fn schedule_unsequenced_transactions(
available_unsequenced_transactions: &[Vec<usize>],
total_transactions: usize,
scheduler: &GooseScheduler,
) -> Vec<usize> {
// Now build the weighted list with the appropriate scheduler.
let mut weighted_transactions = Vec::new();
match scheduler {
GooseScheduler::RoundRobin => {
// Allocate round robin.
let transactions_len = available_unsequenced_transactions.len();
let mut available_transactions = available_unsequenced_transactions.to_owned();
loop {
// Transactions are contained in a vector of vectors. The outer vectors each
// contain a different Transaction, and the inner vectors contain each
// instance of that specific Transaction.
for (transaction_index, transactions) in available_transactions
.iter_mut()
.enumerate()
.take(transactions_len)
{
if let Some(transaction) = transactions.pop() {
debug!(
"allocating transaction from Transaction {}",
transaction_index
);
weighted_transactions.push(transaction);
}
}
if weighted_transactions.len() >= total_transactions {
break;
}
}
}
GooseScheduler::Serial | GooseScheduler::Random => {
// Allocate serially in the weighted order defined. If the Random scheduler is being used, they will get
// shuffled later.
for (transaction_index, transactions) in
available_unsequenced_transactions.iter().enumerate()
{
debug!(
"allocating all {} transactions from Transaction {}",
transactions.len(),
transaction_index
);
let mut transactions_clone = transactions.clone();
if scheduler == &GooseScheduler::Random {
transactions_clone.shuffle(&mut thread_rng());
}
weighted_transactions.append(&mut transactions_clone);
}
}
}
weighted_transactions
}