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
//! # Goose //! //! Have you ever been attacked by a goose? //! //! Goose is a load testing tool 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. //! //! ## Creating and running a Goose load test //! //! ### Creating a simple Goose load test //! //! First create a new empty cargo application, for example: //! //! ```bash //! $ cargo new loadtest //! Created binary (application) `loadtest` package //! $ cd loadtest/ //! ``` //! //! Add Goose as a dependency in `Cargo.toml`: //! //! ```toml //! [dependencies] //! goose = "0.7" //! ``` //! //! Add the following boilerplate `use` declaration at the top of your `src/main.rs`: //! //! ```rust //! use goose::prelude::*; //! ``` //! //! Using the above prelude will automatically add the following `use` statements //! necessary for your load test, so you don't need to manually add them: //! //! ```rust //! use goose::{GooseAttack, task, taskset}; //! use goose::goose::{GooseTaskSet, GooseClient, GooseTask}; //! ``` //! //! Below your `main` function (which currently is the default `Hello, world!`), add //! one or more load test functions. The names of these functions are arbitrary, but it is //! recommended you use self-documenting names. Load test functions must be async. Each load //! test function must accept a mutable GooseClient pointer. For example: //! //! ```rust //! use goose::prelude::*; //! //! async fn loadtest_foo(client: &GooseClient) { //! let _response = client.get("/path/to/foo"); //! } //! ``` //! //! In the above example, we're using the GooseClient helper method `get` to load a path //! on the website we are load testing. This helper creates a Reqwest request builder, and //! uses it to build and execute a request for the above path. If you want access to the //! request builder object, you can instead use the `goose_get` helper, for example to //! set a timout on this specific request: //! //! ```rust //! use std::time; //! //! use goose::prelude::*; //! //! async fn loadtest_bar(client: &GooseClient) { //! let request_builder = client.goose_get("/path/to/bar").await; //! let _response = client.goose_send(request_builder.timeout(time::Duration::from_secs(3)), None).await; //! } //! ``` //! //! We pass the `request_builder` object to `goose_send` which builds and executes it, also //! collecting useful statistics. The `.await` at the end is necessary as `goose_send` is an //! async function. //! //! Once all our tasks are created, we edit the main function to initialize goose and register //! the tasks. In this very simple example we only have two tasks to register, while in a real //! load test you can have any number of task sets with any number of individual tasks. //! //! ```rust,no_run //! use goose::prelude::*; //! //! GooseAttack::initialize() //! .register_taskset(taskset!("LoadtestTasks") //! .set_wait_time(0, 3) //! // Register the foo task, assigning it a weight of 10. //! .register_task(task!(loadtest_foo).set_weight(10)) //! // Register the bar task, assigning it a weight of 2 (so it //! // runs 1/5 as often as bar). Apply a task name which shows up //! // in statistics. //! .register_task(task!(loadtest_bar).set_name("bar").set_weight(2)) //! ) //! // You could also set a default host here, for example: //! //.set_host("http://dev.local/") //! .execute(); //! //! async fn loadtest_foo(client: &GooseClient) { //! let _response = client.get("/path/to/foo"); //! } //! //! async fn loadtest_bar(client: &GooseClient) { //! let _response = client.get("/path/to/bar"); //! } //! ``` //! //! Goose now spins up a configurable number of clients, each simulating a user on your //! website. Thanks to Reqwest, each user maintains its own client state, handling cookies //! and more so your "users" can log in, fill out forms, and more, as real users on your //! sites would do. //! //! ### Running the Goose load test //! //! Attempts to run our example will result in an error, as we have not yet defined the //! host against which this load test should be run. We intentionally do not hard code the //! host in the individual tasks, as this allows us to run the test against different //! environments, such as local and staging. //! //! ```bash //! $ cargo run --release //! Compiling loadtest v0.1.0 (~/loadtest) //! Finished release [optimized] target(s) in 1.52s //! Running `target/release/loadtest` //! 05:33:06 [ERROR] Host must be defined globally or per-TaskSet. No host defined for LoadtestTasks. //! ``` //! Pass in the `-h` flag to see all available run-time options. For now, we'll use a few //! options to customize our load test. //! //! ```bash //! $ cargo run --release -- --host http://dev.local -t 30s -v //! ``` //! //! The first option we specified is `--host`, and in this case tells Goose to run the load test //! against an 8-core VM on my local network. The `-t 30s` option tells Goose to end the load test //! after 30 seconds (for real load tests you'll certainly want to run it longer, you can use `m` to //! specify minutes and `h` to specify hours. For example, `-t 1h30m` would run the load test for 1 //! hour 30 minutes). Finally, the `-v` flag tells goose to display INFO and higher level logs to //! stdout, giving more insight into what is happening. (Additional `-v` flags will result in //! considerably more debug output, and are not recommended for running actual load tests; they're //! only useful if you're trying to debug Goose itself.) //! //! Running the test results in the following output (broken up to explain it as it goes): //! //! ```bash //! Finished release [optimized] target(s) in 0.05s //! Running `target/release/loadtest --host 'http://dev.local' -t 30s -v` //! 05:56:30 [ INFO] Output verbosity level: INFO //! 05:56:30 [ INFO] Logfile verbosity level: INFO //! 05:56:30 [ INFO] Writing to log file: goose.log //! ``` //! //! By default Goose will write a log file with INFO and higher level logs into the same directory //! as you run the test from. //! //! ```bash //! 05:56:30 [ INFO] run_time = 30 //! 05:56:30 [ INFO] concurrent clients defaulted to 8 (number of CPUs) //! ``` //! //! Goose will default to launching 1 client per available CPU core, and will launch them all in //! one second. You can change how many clients are launched with the `-c` option, and you can //! change how many clients are launched per second with the `-r` option. For example, `-c 30 -r 2` //! would launch 30 clients over 15 seconds, or two clients per second. //! //! ```bash //! 05:56:30 [ INFO] global host configured: http://dev.local //! 05:56:30 [ INFO] launching client 1 from LoadtestTasks... //! 05:56:30 [ INFO] launching client 2 from LoadtestTasks... //! 05:56:30 [ INFO] launching client 3 from LoadtestTasks... //! 05:56:30 [ INFO] launching client 4 from LoadtestTasks... //! 05:56:30 [ INFO] launching client 5 from LoadtestTasks... //! 05:56:30 [ INFO] launching client 6 from LoadtestTasks... //! 05:56:30 [ INFO] launching client 7 from LoadtestTasks... //! 05:56:31 [ INFO] launching client 8 from LoadtestTasks... //! 05:56:31 [ INFO] launched 8 clients... //! ``` //! //! Each client is launched in its own thread with its own client state. Goose is able to make //! very efficient use of server resources. //! //! ```bash //! 05:56:46 [ INFO] printing running statistics after 15 seconds... //! ------------------------------------------------------------------------------ //! Name | # reqs | # fails | req/s | fail/s //! ----------------------------------------------------------------------------- //! GET /path/to/foo | 15,795 | 0 (0%) | 1,053 | 0 //! GET bar | 3,161 | 0 (0%) | 210 | 0 //! ------------------------+----------------+----------------+--------+--------- //! Aggregated | 18,956 | 0 (0%) | 1,263 | 0 //! ------------------------------------------------------------------------------ //! ``` //! //! When printing statistics, by default Goose will display running values approximately //! every 15 seconds. Running statistics are broken into two tables. The first, above, //! shows how many requests have been made, how many of them failed (non-2xx response), //! and the corresponding per-second rates. //! //! Note that Goose respected the per-task weights we set, and `foo` (with a weight of //! 10) is being loaded five times as often as `bar` (with a weight of 2). Also notice //! that because we didn't name the `foo` task by default we see the URL loaded in the //! statistics, whereas we did name the `bar` task so we see the name in the statistics. //! //! ```bash //! Name | Avg (ms) | Min | Max | Mean //! ----------------------------------------------------------------------------- //! GET /path/to/foo | 67 | 31 | 1351 | 53 //! GET bar | 60 | 33 | 1342 | 53 //! ------------------------+------------+------------+------------+------------- //! Aggregated | 66 | 31 | 1351 | 56 //! ``` //! //! The second table in running statistics provides details on response times. In our //! example (which is running over wifi from my development laptop), on average each //! page is returning within `66` milliseconds. The quickest page response was for //! `foo` in `31` milliseconds. The slowest page response was also for `foo` in `1351` //! milliseconds. //! //! //! ```bash //! 05:37:10 [ INFO] stopping after 30 seconds... //! 05:37:10 [ INFO] waiting for clients to exit //! ``` //! //! Our example only runs for 30 seconds, so we only see running statistics once. When //! the test completes, we get more detail in the final summary. The first two tables //! are the same as what we saw earlier, however now they include all statistics for the //! entire load test: //! //! ```bash //! ------------------------------------------------------------------------------ //! Name | # reqs | # fails | req/s | fail/s //! ----------------------------------------------------------------------------- //! GET bar | 6,050 | 0 (0%) | 201 | 0 //! GET /path/to/foo | 30,257 | 0 (0%) | 1,008 | 0 //! ------------------------+----------------+----------------+--------+---------- //! Aggregated | 36,307 | 0 (0%) | 1,210 | 0 //! ------------------------------------------------------------------------------- //! Name | Avg (ms) | Min | Max | Mean //! ----------------------------------------------------------------------------- //! GET bar | 66 | 32 | 1388 | 53 //! GET /path/to/foo | 68 | 31 | 1395 | 53 //! ------------------------+------------+------------+------------+------------- //! Aggregated | 67 | 31 | 1395 | 50 //! ------------------------------------------------------------------------------- //! ``` //! //! The ratio between `foo` and `bar` remained 5:2 as expected. As the test ran, //! however, we saw some slower page loads, with the slowest again `foo` this time //! at 1395 milliseconds. //! //! ```bash //! Slowest page load within specified percentile of requests (in ms): //! ------------------------------------------------------------------------------ //! Name | 50% | 75% | 98% | 99% | 99.9% | 99.99% //! ----------------------------------------------------------------------------- //! GET bar | 53 | 66 | 217 | 537 | 1872 | 12316 //! GET /path/to/foo | 53 | 66 | 265 | 1060 | 1800 | 10732 //! ------------------------+--------+--------+-------+---------+--------+------- //! Aggregated | 53 | 66 | 237 | 645 | 1832 | 10818 //! ``` //! //! A new table shows additional information, breaking down response-time by //! percentile. This shows that the slowest page loads only happened in the //! slowest .001% of page loads, so were very much an edge case. 99.9% of the time //! page loads happened in less than 2 seconds. //! //! ## 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. #[macro_use] extern crate log; extern crate structopt; pub mod goose; mod client; #[cfg(feature = "gaggle")] mod manager; pub mod prelude; mod stats; mod util; #[cfg(feature = "gaggle")] mod worker; use std::collections::hash_map::DefaultHasher; use std::collections::{BTreeMap, HashMap}; use std::f32; use std::fs::File; use std::hash::{Hash, Hasher}; use std::path::PathBuf; use std::sync::{ atomic::{AtomicBool, AtomicUsize, Ordering}, Arc, }; use std::time; use lazy_static::lazy_static; #[cfg(feature = "gaggle")] use nng::Socket; use reqwest::Client; use serde::{Deserialize, Serialize}; use simplelog::*; use structopt::StructOpt; use tokio::sync::{mpsc, Mutex, RwLock}; use url::Url; use crate::goose::{ GooseClient, GooseClientCommand, GooseRawRequest, GooseRequest, GooseTask, GooseTaskSet, }; /// Constant defining how often statistics should be displayed while load test is running. const RUNNING_STATS_EVERY: usize = 15; /// Constant defining Goose's default port when running a Gaggle. const DEFAULT_PORT: &str = "5115"; static APP_USER_AGENT: &str = concat!(env!("CARGO_PKG_NAME"), "/", env!("CARGO_PKG_VERSION")); // Share CLIENT object globally. lazy_static! { static ref CLIENT: RwLock<Vec<GooseClientState>> = RwLock::new(Vec::new()); } struct GooseClientState { /// A Reqwest client, wrapped in a Mutex as a read-write copy is always needed to /// manage things like sessions and cookies. client: Mutex<Client>, /// Integer value indicating which sequenced bucket the client is currently running /// tasks from. weighted_bucket: AtomicUsize, /// Integer value indicating which task within the current sequenced bucket is currently /// running. weighted_bucket_position: AtomicUsize, } impl GooseClientState { // Initialize one client per thread. async fn initialize(clients: usize) { // Grab a write lock to initialize state for each client. let mut goose_client_state = CLIENT.write().await; // State can be reinitialized for `test_start` or `test_stop`. if !goose_client_state.is_empty() { goose_client_state.clear(); } for _ in 0..clients { // Build a new client, setting the USER_AGENT and enabling cookie storage. let builder = Client::builder() .user_agent(APP_USER_AGENT) .cookie_store(true); let client = match builder.build() { Ok(c) => Mutex::new(c), Err(e) => { error!("failed to build client: {}", e); std::process::exit(1); } }; // Push the new client into the global client vector. goose_client_state.push(GooseClientState { client, weighted_bucket: AtomicUsize::new(0), weighted_bucket_position: AtomicUsize::new(0), }); } } } // WORKER_ID is only used when running a gaggle (a distributed load test). lazy_static! { static ref WORKER_ID: AtomicUsize = AtomicUsize::new(0); } /// Worker ID to aid in tracing logs when running a Gaggle. pub fn get_worker_id() -> usize { WORKER_ID.load(Ordering::Relaxed) } #[cfg(not(feature = "gaggle"))] #[derive(Debug)] /// Socket used for coordinating a Gaggle, a distributed load test. pub struct Socket {} /// Internal global state for load test. #[derive(Clone)] pub struct GooseAttack { /// An optional task to run one time before starting clients and running task sets. test_start_task: Option<GooseTask>, /// An optional task to run one time after clients have finished running task sets. test_stop_task: Option<GooseTask>, /// A vector containing one copy of each GooseTaskSet that will run during this load test. task_sets: Vec<GooseTaskSet>, /// A checksum of the task_sets vector to be sure all workers are running the same load test. task_sets_hash: u64, /// A weighted vector containing a GooseClient object for each client that will run during this load test. weighted_clients: Vec<GooseClient>, /// An optional default host to run this load test against. host: Option<String>, /// Configuration object managed by StructOpt. configuration: GooseConfiguration, /// By default launch 1 client per number of CPUs. number_of_cpus: usize, /// Track how long the load test should run. run_time: usize, /// Track total number of clients to run for this load test. clients: usize, /// Track how many clients are already loaded. active_clients: usize, /// All requests statistics merged together. merged_requests: HashMap<String, GooseRequest>, } /// Goose's internal global state. impl GooseAttack { /// Load configuration from command line and initialize a GooseAttack. /// /// # Example /// ```rust,no_run /// use goose::prelude::*; /// /// let mut goose_attack = GooseAttack::initialize(); /// ``` pub fn initialize() -> GooseAttack { let goose_attack = GooseAttack { test_start_task: None, test_stop_task: None, task_sets: Vec::new(), task_sets_hash: 0, weighted_clients: Vec::new(), host: None, configuration: GooseConfiguration::from_args(), number_of_cpus: num_cpus::get(), run_time: 0, clients: 0, active_clients: 0, merged_requests: HashMap::new(), }; goose_attack.setup() } /// Initialize a GooseAttack with an already loaded configuration. /// This should only be called by worker instances. /// /// # Example /// ```rust,no_run /// use goose::{GooseAttack, GooseConfiguration}; /// use structopt::StructOpt; /// /// let configuration = GooseConfiguration::from_args(); /// let mut goose_attack = GooseAttack::initialize_with_config(configuration); /// ``` pub fn initialize_with_config(config: GooseConfiguration) -> GooseAttack { GooseAttack { test_start_task: None, test_stop_task: None, task_sets: Vec::new(), task_sets_hash: 0, weighted_clients: Vec::new(), host: None, configuration: config, number_of_cpus: num_cpus::get(), run_time: 0, clients: 0, active_clients: 0, merged_requests: HashMap::new(), } } pub fn initialize_logger(&self) { // Allow optionally controlling debug output level let debug_level; match self.configuration.verbose { 0 => debug_level = LevelFilter::Warn, 1 => debug_level = LevelFilter::Info, 2 => debug_level = LevelFilter::Debug, _ => debug_level = LevelFilter::Trace, } // Allow optionally controlling log level let log_level; match self.configuration.log_level { 0 => log_level = LevelFilter::Info, 1 => log_level = LevelFilter::Debug, _ => log_level = LevelFilter::Trace, } let log_file = PathBuf::from(&self.configuration.log_file); match CombinedLogger::init(vec![ match TermLogger::new(debug_level, Config::default(), TerminalMode::Mixed) { Some(t) => t, None => { eprintln!("failed to initialize TermLogger"); return; } }, WriteLogger::new( log_level, Config::default(), File::create(&log_file).unwrap(), ), ]) { Ok(_) => (), Err(e) => { info!("failed to initialize CombinedLogger: {}", e); } } info!("Output verbosity level: {}", debug_level); info!("Logfile verbosity level: {}", log_level); info!("Writing to log file: {}", log_file.display()); } pub fn setup(mut self) -> Self { self.initialize_logger(); // Don't allow overhead of collecting status codes unless we're printing statistics. if self.configuration.status_codes && self.configuration.no_stats { error!("You must not enable --no-stats when enabling --status-codes."); std::process::exit(1); } // Don't allow overhead of collecting statistics unless we're printing them. if self.configuration.only_summary && self.configuration.no_stats { error!("You must not enable --no-stats when enabling --only-summary."); std::process::exit(1); } // Configure maximum run time if specified, otherwise run until canceled. if self.configuration.worker { if self.configuration.run_time != "" { error!("The --run-time option is only available to the manager."); std::process::exit(1); } self.run_time = 0; } else if self.configuration.run_time != "" { self.run_time = util::parse_timespan(&self.configuration.run_time); info!("run_time = {}", self.run_time); } else { self.run_time = 0; } // Configure number of client threads to launch, default to the number of CPU cores available. self.clients = match self.configuration.clients { Some(c) => { if c == 0 { if self.configuration.worker { error!("At least 1 client is required."); std::process::exit(1); } else { 0 } } else { if self.configuration.worker { error!("The --clients option is only available to the manager."); std::process::exit(1); } c } } None => { let c = self.number_of_cpus; if !self.configuration.manager && !self.configuration.worker { info!("concurrent clients defaulted to {} (number of CPUs)", c); } c } }; if !self.configuration.manager && !self.configuration.worker { debug!("clients = {}", self.clients); } self } /// A load test must contain one or more `GooseTaskSet`s. Each task set must /// be registered into Goose's global state with this method for it to run. /// /// # Example /// ```rust,no_run /// use goose::prelude::*; /// /// GooseAttack::initialize() /// .register_taskset(taskset!("ExampleTasks") /// .register_task(task!(example_task)) /// ) /// .register_taskset(taskset!("OtherTasks") /// .register_task(task!(other_task)) /// ); /// /// async fn example_task(client: &GooseClient) { /// let _response = client.get("/foo"); /// } /// /// async fn other_task(client: &GooseClient) { /// let _response = client.get("/bar"); /// } /// ``` pub fn register_taskset(mut self, mut taskset: GooseTaskSet) -> Self { taskset.task_sets_index = self.task_sets.len(); self.task_sets.push(taskset); self } /// Optionally define a task to run before clients are started and all task sets /// start running. This is would generally be used to set up anything required /// for the load test. /// /// When running in a distributed Gaggle, this task is only run one time by the /// Manager. /// /// # Example /// ```rust,no_run /// use goose::prelude::*; /// /// GooseAttack::initialize() /// .test_start(task!(setup)); /// /// async fn setup(client: &GooseClient) { /// // do stuff to set up load test ... /// } /// ``` pub fn test_start(mut self, task: GooseTask) -> Self { self.test_start_task = Some(task); self } /// Optionally define a task to run after all clients have finished running /// all defined task sets. 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 task is only run one time by the /// Manager. /// /// # Example /// ```rust,no_run /// use goose::prelude::*; /// /// GooseAttack::initialize() /// .test_stop(task!(teardown)); /// /// async fn teardown(client: &GooseClient) { /// // do stuff to tear down the load test ... /// } /// ``` pub fn test_stop(mut self, task: GooseTask) -> Self { self.test_stop_task = Some(task); self } /// Optionally configure a default host for the load test. This is used if /// no per-GooseTaskSet host is defined, no `--host` CLI option is configurared, /// and if the GooseTask itself doesn't hard-code the host in its request. The /// host is prepended on all requests. /// /// For example, your load test may default to running against your local development /// container, and the `--host` option could be used to override host to run the load /// test against production. /// /// # Example /// ```rust,no_run /// use goose::prelude::*; /// /// GooseAttack::initialize() /// .set_host("local.dev"); /// ``` pub fn set_host(mut self, host: &str) -> Self { trace!("set_host: {}", host); // Host validation happens in main() at startup. self.host = Some(host.to_string()); self } /// Allocate a vector of weighted GooseClient. fn weight_task_set_clients(&mut self) -> Vec<GooseClient> { trace!("weight_task_set_clients"); let mut u: usize = 0; let mut v: usize; for task_set in &self.task_sets { if u == 0 { u = task_set.weight; } else { v = task_set.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 weighted lists of task sets (identified by index) let mut weighted_task_sets = Vec::new(); for (index, task_set) in self.task_sets.iter().enumerate() { // divide by greatest common divisor so vector is as short as possible let weight = task_set.weight / u; trace!( "{}: {} has weight of {} (reduced with gcd to {})", index, task_set.name, task_set.weight, weight ); let mut weighted_sets = vec![index; weight]; weighted_task_sets.append(&mut weighted_sets); } // Allocate a state for each client that will be spawned. info!("initializing client states..."); let mut weighted_clients = Vec::new(); let mut client_count = 0; let config = self.configuration.clone(); loop { for task_sets_index in &weighted_task_sets { let task_set_host = self.task_sets[*task_sets_index].host.clone(); weighted_clients.push(GooseClient::new( self.task_sets[*task_sets_index].task_sets_index, self.host.clone(), task_set_host, self.task_sets[*task_sets_index].min_wait, self.task_sets[*task_sets_index].max_wait, &config, self.task_sets_hash, )); client_count += 1; if client_count >= self.clients { trace!("created {} weighted_clients", client_count); return weighted_clients; } } } } /// Execute the load test. /// /// # Example /// ```rust,no_run /// use goose::prelude::*; /// /// GooseAttack::initialize() /// .register_taskset(taskset!("ExampleTasks") /// .register_task(task!(example_task).set_weight(2)) /// .register_task(task!(another_example_task).set_weight(3)) /// ) /// .execute(); /// /// async fn example_task(client: &GooseClient) { /// let _response = client.get("/foo"); /// } /// /// async fn another_example_task(client: &GooseClient) { /// let _response = client.get("/bar"); /// } /// ``` pub fn execute(mut self) { // At least one task set is required. if self.task_sets.is_empty() { error!("No task sets defined."); std::process::exit(1); } if self.configuration.list { // Display task sets and tasks, then exit. println!("Available tasks:"); for task_set in self.task_sets { println!(" - {} (weight: {})", task_set.name, task_set.weight); for task in task_set.tasks { println!(" o {} (weight: {})", task.name, task.weight); } } std::process::exit(0); } // Manager mode. if self.configuration.manager { // @TODO: support running in both manager and worker mode. if self.configuration.worker { error!("You can only run in manager or worker mode, not both."); std::process::exit(1); } if self.configuration.expect_workers < 1 { error!("You must set --expect-workers to 1 or more."); std::process::exit(1); } if self.configuration.expect_workers as usize > self.clients { error!( "You must enable at least as many clients ({}) as workers ({}).", self.clients, self.configuration.expect_workers ); std::process::exit(1); } } // Worker mode. if self.configuration.worker { // @TODO: support running in both manager and worker mode. if self.configuration.manager { error!("You can only run in manager or worker mode, not both."); std::process::exit(1); } if self.configuration.expect_workers > 0 { error!("The --expect-workers option is only available to the manager"); std::process::exit(1); } if self.configuration.host != "" { error!("The --host option is only available to the manager"); std::process::exit(1); } if self.configuration.manager_bind_host != "0.0.0.0" { error!("The --manager-bind-host option is only available to the manager"); std::process::exit(1); } let default_port: u16 = DEFAULT_PORT.to_string().parse().unwrap(); if self.configuration.manager_bind_port != default_port { error!("The --manager-bind-port option is only available to the manager"); std::process::exit(1); } if self.configuration.no_stats { error!("The --no-stats option is only available to the manager"); std::process::exit(1); } if self.configuration.only_summary { error!("The --only-summary option is only available to the manager"); std::process::exit(1); } if self.configuration.status_codes { error!("The --status-codes option is only available to the manager"); std::process::exit(1); } if self.configuration.no_hash_check { error!("The --no-hash-check option is only available to the manager"); std::process::exit(1); } } if !self.configuration.manager && !self.configuration.worker && self.configuration.no_hash_check { error!("The --no-hash-check option is only available when running in manager mode"); std::process::exit(1); } // Configure number of client threads to launch per second, defaults to 1. let hatch_rate = self.configuration.hatch_rate; if hatch_rate < 1 { error!("Hatch rate must be greater than 0, or no clients will launch."); std::process::exit(1); } if hatch_rate > 1 && self.configuration.worker { error!("The --hatch-rate option is only available to the manager"); std::process::exit(1); } debug!("hatch_rate = {}", hatch_rate); // Confirm there's either a global host, or each task set has a host defined. if self.configuration.host.is_empty() { for task_set in &self.task_sets { match &task_set.host { Some(h) => { if is_valid_host(h) { info!("host for {} configured: {}", task_set.name, h); } } None => match &self.host { Some(h) => { if is_valid_host(h) { info!("host for {} configured: {}", task_set.name, h); } } None => { if !self.configuration.worker { error!("Host must be defined globally or per-TaskSet. No host defined for {}.", task_set.name); std::process::exit(1); } } }, } } } else if is_valid_host(&self.configuration.host) { info!("global host configured: {}", self.configuration.host); } // Apply weights to tasks in each task set. for task_set in &mut self.task_sets { let (weighted_on_start_tasks, weighted_tasks, weighted_on_stop_tasks) = weight_tasks(&task_set); task_set.weighted_on_start_tasks = weighted_on_start_tasks; task_set.weighted_tasks = weighted_tasks; task_set.weighted_on_stop_tasks = weighted_on_stop_tasks; debug!( "weighted {} on_start: {:?} tasks: {:?} on_stop: {:?}", task_set.name, task_set.weighted_on_start_tasks, task_set.weighted_tasks, task_set.weighted_on_stop_tasks ); } // Allocate a state for each of the clients we are about to start. if !self.configuration.worker { self.weighted_clients = self.weight_task_set_clients(); } // Calculate a unique hash for the current load test. let mut s = DefaultHasher::new(); self.task_sets.hash(&mut s); self.task_sets_hash = s.finish(); debug!("task_sets_hash: {}", self.task_sets_hash); // Our load test is officially starting. let started = time::Instant::now(); // Spawn clients at hatch_rate per second, or one every 1 / hatch_rate fraction of a second. let sleep_float = 1.0 / hatch_rate as f32; let sleep_duration = time::Duration::from_secs_f32(sleep_float); // Start goose in manager mode. if self.configuration.manager { #[cfg(feature = "gaggle")] { self = manager::manager_main(self); } #[cfg(not(feature = "gaggle"))] { error!( "goose must be recompiled with `--features gaggle` to start in manager mode" ); std::process::exit(1); } } // Start goose in worker mode. else if self.configuration.worker { #[cfg(feature = "gaggle")] { worker::worker_main(&self); } #[cfg(not(feature = "gaggle"))] { error!("goose must be recompiled with `--features gaggle` to start in worker mode"); std::process::exit(1); } } // Start goose in single-process mode. else { let mut rt = tokio::runtime::Runtime::new().unwrap(); self = rt.block_on(self.launch_clients(started, sleep_duration, None)); } if !self.configuration.no_stats && !self.configuration.worker { stats::print_final_stats(&self, started.elapsed().as_secs() as usize); } } /// Called internally in local-mode and gaggle-mode. async fn launch_clients( mut self, mut started: time::Instant, sleep_duration: time::Duration, socket: Option<Socket>, ) -> GooseAttack { trace!( "launch clients: started({:?}) sleep_duration({:?}) socket({:?})", started, sleep_duration, socket ); // Initilize per-client states. if !self.configuration.worker { // First run global test_start_task, if defined. match &self.test_start_task { Some(t) => { info!("running test_start_task"); // Setup temporary state for our single client. GooseClientState::initialize(1).await; // Create a one-time-use Client to run the test_start_task. let mut client = GooseClient::new(0, self.host.clone(), None, 0, 0, &self.configuration, 0); client.weighted_clients_index = 0; let function = t.function; function(&client).await; } // No test_start_task defined, nothing to do. None => (), } } // Initial globa client state. GooseClientState::initialize(self.weighted_clients.len()).await; // Collect client threads in a vector for when we want to stop them later. let mut clients = vec![]; // Collect client thread channels in a vector so we can talk to the client threads. let mut client_channels = vec![]; // Create a single channel allowing all Goose child threads to sync state back to parent let (all_threads_sender, mut parent_receiver): ( mpsc::UnboundedSender<GooseRawRequest>, mpsc::UnboundedReceiver<GooseRawRequest>, ) = mpsc::unbounded_channel(); // Spawn clients, each with their own weighted task_set. for mut thread_client in self.weighted_clients.clone() { // Stop launching threads if the run_timer has expired. if util::timer_expired(started, self.run_time) { break; } // Copy weighted tasks and weighted on start tasks into the client thread. thread_client.weighted_tasks = self.task_sets[thread_client.task_sets_index] .weighted_tasks .clone(); thread_client.weighted_on_start_tasks = self.task_sets[thread_client.task_sets_index] .weighted_on_start_tasks .clone(); thread_client.weighted_on_stop_tasks = self.task_sets[thread_client.task_sets_index] .weighted_on_stop_tasks .clone(); // Remember which task group this client is using. thread_client.weighted_clients_index = self.active_clients; // Create a per-thread channel allowing parent thread to control child threads. let (parent_sender, thread_receiver): ( mpsc::UnboundedSender<GooseClientCommand>, mpsc::UnboundedReceiver<GooseClientCommand>, ) = mpsc::unbounded_channel(); client_channels.push(parent_sender); // Copy the client-to-parent sender channel, used by all threads. thread_client.parent = Some(all_threads_sender.clone()); // Copy the appropriate task_set into the thread. let thread_task_set = self.task_sets[thread_client.task_sets_index].clone(); // We number threads from 1 as they're human-visible (in the logs), whereas active_clients starts at 0. let thread_number = self.active_clients + 1; let is_worker = self.configuration.worker; // Launch a new client. let client = tokio::spawn(client::client_main( thread_number, thread_task_set, thread_client, thread_receiver, is_worker, )); clients.push(client); self.active_clients += 1; debug!("sleeping {:?} milliseconds...", sleep_duration); tokio::time::delay_for(sleep_duration).await; } // Restart the timer now that all threads are launched. started = time::Instant::now(); if self.configuration.worker { info!( "[{}] launched {} clients...", get_worker_id(), self.active_clients ); } else { info!("launched {} clients...", self.active_clients); } // Track whether or not we've (optionally) reset the statistics after all clients started. let mut statistics_reset: bool = false; // Catch ctrl-c to allow clean shutdown to display statistics. let canceled = Arc::new(AtomicBool::new(false)); util::setup_ctrlc_handler(&canceled); // Determine when to display running statistics (if enabled). let mut statistics_timer = time::Instant::now(); let mut display_running_statistics = false; loop { // When displaying running statistics, sync data from client threads first. if !self.configuration.no_stats { // Synchronize statistics from client threads into parent. if util::timer_expired(statistics_timer, RUNNING_STATS_EVERY) { statistics_timer = time::Instant::now(); if !self.configuration.only_summary { display_running_statistics = true; } } // Load messages from client threads until the receiver queue is empty. let mut received_message = false; let mut message = parent_receiver.try_recv(); while message.is_ok() { received_message = true; let raw_request = message.unwrap(); let key = format!("{:?} {}", raw_request.method, raw_request.name); let mut merge_request = match self.merged_requests.get(&key) { Some(m) => m.clone(), None => GooseRequest::new(&raw_request.name, raw_request.method, 0), }; merge_request.set_response_time(raw_request.response_time); merge_request.set_status_code(raw_request.status_code); if raw_request.success { merge_request.success_count += 1; } else { merge_request.fail_count += 1; } self.merged_requests.insert(key.to_string(), merge_request); message = parent_receiver.try_recv(); } // As worker, push statistics up to manager. if self.configuration.worker && received_message { #[cfg(feature = "gaggle")] { // Push all statistics to manager process. if !worker::push_stats_to_manager( &socket.clone().unwrap(), &self.merged_requests.clone(), true, ) { // EXIT received, cancel. canceled.store(true, Ordering::SeqCst); } // The manager has all our statistics, reset locally. self.merged_requests = HashMap::new(); } } // Flush statistics collected prior to all client threads running if self.configuration.reset_stats && !statistics_reset { info!("statistics reset..."); self.merged_requests = HashMap::new(); statistics_reset = true; } } if util::timer_expired(started, self.run_time) || canceled.load(Ordering::SeqCst) { if self.configuration.worker { info!( "[{}] stopping after {} seconds...", get_worker_id(), started.elapsed().as_secs() ); } else { info!("stopping after {} seconds...", started.elapsed().as_secs()); } for (index, send_to_client) in client_channels.iter().enumerate() { match send_to_client.send(GooseClientCommand::EXIT) { Ok(_) => { debug!("telling client {} to exit", index); } Err(e) => { info!("failed to tell client {} to exit: {}", index, e); } } } if self.configuration.worker { info!("[{}] waiting for clients to exit", get_worker_id()); } else { info!("waiting for clients to exit"); } futures::future::join_all(clients).await; debug!("all clients exited"); // If we're printing statistics, collect the final messages received from clients if !self.configuration.no_stats { let mut message = parent_receiver.try_recv(); while message.is_ok() { let raw_request = message.unwrap(); let key = format!("{:?} {}", raw_request.method, raw_request.name); let mut merge_request = match self.merged_requests.get(&key) { Some(m) => m.clone(), None => GooseRequest::new(&raw_request.name, raw_request.method, 0), }; merge_request.set_response_time(raw_request.response_time); merge_request.set_status_code(raw_request.status_code); if raw_request.success { merge_request.success_count += 1; } else { merge_request.fail_count += 1; } self.merged_requests.insert(key.to_string(), merge_request); message = parent_receiver.try_recv(); } } #[cfg(feature = "gaggle")] { // As worker, push statistics up to manager. if self.configuration.worker { // Push all statistics to manager process. worker::push_stats_to_manager( &socket.clone().unwrap(), &self.merged_requests.clone(), true, ); // No need to reset local stats, the worker is exiting. } } // All clients are done, exit out of loop for final cleanup. break; } // If enabled, display running statistics after sync if display_running_statistics { display_running_statistics = false; stats::print_running_stats(&self, started.elapsed().as_secs() as usize); } let one_second = time::Duration::from_secs(1); tokio::time::delay_for(one_second).await; } if !self.configuration.worker { // Run global test_stop_task, if defined. match &self.test_stop_task { Some(t) => { info!("running test_stop_task"); // Setup temporary state for our single client. GooseClientState::initialize(1).await; // Create a one-time-use Client to run the test_stop_task. let mut client = GooseClient::new(0, self.host.clone(), None, 0, 0, &self.configuration, 0); client.weighted_clients_index = 0; let function = t.function; function(&client).await; } // No test_stop_task defined, nothing to do. None => (), } } self } } /// CLI options available when launching a Goose load test. #[derive(StructOpt, Debug, Default, Clone, Serialize, Deserialize)] #[structopt(name = "client")] pub struct GooseConfiguration { /// Host to load test, for example: http://10.21.32.33 #[structopt(short = "H", long, required = false, default_value = "")] pub host: String, /// Number of concurrent Goose users (defaults to available CPUs). #[structopt(short, long)] pub clients: Option<usize>, /// How many users to spawn per second. #[structopt(short = "r", long, required = false, default_value = "1")] pub hatch_rate: usize, /// Stop after the specified amount of time, e.g. (300s, 20m, 3h, 1h30m, etc.). #[structopt(short = "t", long, required = false, default_value = "")] pub run_time: String, /// Don't print stats in the console #[structopt(long)] pub no_stats: bool, /// Includes status code counts in console stats #[structopt(long)] pub status_codes: bool, /// Only prints summary stats #[structopt(long)] pub only_summary: bool, /// Resets statistics once hatching has been completed #[structopt(long)] pub reset_stats: bool, /// Shows list of all possible Goose tasks and exits #[structopt(short, long)] pub list: bool, // The number of occurrences of the `v/verbose` flag /// Debug level (-v, -vv, -vvv, etc.) #[structopt(short = "v", long, parse(from_occurrences))] pub verbose: u8, // The number of occurrences of the `g/log-level` flag /// Log level (-g, -gg, -ggg, etc.) #[structopt(short = "g", long, parse(from_occurrences))] pub log_level: u8, /// Log file name #[structopt(long, default_value = "goose.log")] pub log_file: String, /// Enables manager mode #[structopt(long)] pub manager: bool, /// Ignore worker load test checksum #[structopt(long)] pub no_hash_check: bool, /// Required when in manager mode, how many workers to expect #[structopt(long, required = false, default_value = "0")] pub expect_workers: u16, /// Define host manager listens on, formatted x.x.x.x #[structopt(long, default_value = "0.0.0.0")] pub manager_bind_host: String, /// Define port manager listens on #[structopt(long, default_value=DEFAULT_PORT)] pub manager_bind_port: u16, /// Enables worker mode #[structopt(long)] pub worker: bool, /// Host manager is running on #[structopt(long, default_value = "127.0.0.1")] pub manager_host: String, /// Port manager is listening on #[structopt(long, default_value=DEFAULT_PORT)] pub manager_port: u16, } /// Returns a sequenced bucket of weighted usize pointers to Goose Tasks fn weight_tasks(task_set: &GooseTaskSet) -> (Vec<Vec<usize>>, Vec<Vec<usize>>, Vec<Vec<usize>>) { trace!("weight_tasks for {}", task_set.name); // A BTreeMap of Vectors allows us to group and sort tasks per sequence value. let mut sequenced_tasks: BTreeMap<usize, Vec<GooseTask>> = BTreeMap::new(); let mut sequenced_on_start_tasks: BTreeMap<usize, Vec<GooseTask>> = BTreeMap::new(); let mut sequenced_on_stop_tasks: BTreeMap<usize, Vec<GooseTask>> = BTreeMap::new(); let mut unsequenced_tasks: Vec<GooseTask> = Vec::new(); let mut unsequenced_on_start_tasks: Vec<GooseTask> = Vec::new(); let mut unsequenced_on_stop_tasks: Vec<GooseTask> = Vec::new(); let mut u: usize = 0; let mut v: usize; // Handle ordering of tasks. for task in &task_set.tasks { if task.sequence > 0 { if task.on_start { if let Some(sequence) = sequenced_on_start_tasks.get_mut(&task.sequence) { // This is another task with this order value. sequence.push(task.clone()); } else { // This is the first task with this order value. sequenced_on_start_tasks.insert(task.sequence, vec![task.clone()]); } } // Allow a task to be both on_start and on_stop. if task.on_stop { if let Some(sequence) = sequenced_on_stop_tasks.get_mut(&task.sequence) { // This is another task with this order value. sequence.push(task.clone()); } else { // This is the first task with this order value. sequenced_on_stop_tasks.insert(task.sequence, vec![task.clone()]); } } if !task.on_start && !task.on_stop { if let Some(sequence) = sequenced_tasks.get_mut(&task.sequence) { // This is another task with this order value. sequence.push(task.clone()); } else { // This is the first task with this order value. sequenced_tasks.insert(task.sequence, vec![task.clone()]); } } } else { if task.on_start { unsequenced_on_start_tasks.push(task.clone()); } if task.on_stop { unsequenced_on_stop_tasks.push(task.clone()); } if !task.on_start && !task.on_stop { unsequenced_tasks.push(task.clone()); } } // Look for lowest common divisor amongst all tasks of any weight. if u == 0 { u = task.weight; } else { v = task.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 weight to sequenced tasks. let mut weighted_tasks: Vec<Vec<usize>> = Vec::new(); for (_sequence, tasks) in sequenced_tasks.iter() { let mut sequence_weighted_tasks = Vec::new(); for task in tasks { // divide by greatest common divisor so bucket is as small as possible let weight = task.weight / u; trace!( "{}: {} has weight of {} (reduced with gcd to {})", task.tasks_index, task.name, task.weight, weight ); let mut tasks = vec![task.tasks_index; weight]; sequence_weighted_tasks.append(&mut tasks); } weighted_tasks.push(sequence_weighted_tasks); } // Apply weight to unsequenced tasks. trace!("created weighted_tasks: {:?}", weighted_tasks); let mut weighted_unsequenced_tasks = Vec::new(); for task in unsequenced_tasks { // divide by greatest common divisor so bucket is as small as possible let weight = task.weight / u; trace!( "{}: {} has weight of {} (reduced with gcd to {})", task.tasks_index, task.name, task.weight, weight ); let mut tasks = vec![task.tasks_index; weight]; weighted_unsequenced_tasks.append(&mut tasks); } // Unsequenced tasks come last. if !weighted_unsequenced_tasks.is_empty() { weighted_tasks.push(weighted_unsequenced_tasks); } // Apply weight to on_start sequenced tasks. let mut weighted_on_start_tasks: Vec<Vec<usize>> = Vec::new(); for (_sequence, tasks) in sequenced_on_start_tasks.iter() { let mut sequence_on_start_weighted_tasks = Vec::new(); for task in tasks { // divide by greatest common divisor so bucket is as small as possible let weight = task.weight / u; trace!( "{}: {} has weight of {} (reduced with gcd to {})", task.tasks_index, task.name, task.weight, weight ); let mut tasks = vec![task.tasks_index; weight]; sequence_on_start_weighted_tasks.append(&mut tasks); } weighted_on_start_tasks.push(sequence_on_start_weighted_tasks); } // Apply weight to unsequenced on_start tasks. trace!("created weighted_on_start_tasks: {:?}", weighted_tasks); let mut weighted_on_start_unsequenced_tasks = Vec::new(); for task in unsequenced_on_start_tasks { // divide by greatest common divisor so bucket is as small as possible let weight = task.weight / u; trace!( "{}: {} has weight of {} (reduced with gcd to {})", task.tasks_index, task.name, task.weight, weight ); let mut tasks = vec![task.tasks_index; weight]; weighted_on_start_unsequenced_tasks.append(&mut tasks); } // Unsequenced tasks come lost. weighted_on_start_tasks.push(weighted_on_start_unsequenced_tasks); // Apply weight to on_stop sequenced tasks. let mut weighted_on_stop_tasks: Vec<Vec<usize>> = Vec::new(); for (_sequence, tasks) in sequenced_on_stop_tasks.iter() { let mut sequence_on_stop_weighted_tasks = Vec::new(); for task in tasks { // divide by greatest common divisor so bucket is as small as possible let weight = task.weight / u; trace!( "{}: {} has weight of {} (reduced with gcd to {})", task.tasks_index, task.name, task.weight, weight ); let mut tasks = vec![task.tasks_index; weight]; sequence_on_stop_weighted_tasks.append(&mut tasks); } weighted_on_stop_tasks.push(sequence_on_stop_weighted_tasks); } // Apply weight to unsequenced on_stop tasks. trace!("created weighted_on_stop_tasks: {:?}", weighted_tasks); let mut weighted_on_stop_unsequenced_tasks = Vec::new(); for task in unsequenced_on_stop_tasks { // divide by greatest common divisor so bucket is as small as possible let weight = task.weight / u; trace!( "{}: {} has weight of {} (reduced with gcd to {})", task.tasks_index, task.name, task.weight, weight ); let mut tasks = vec![task.tasks_index; weight]; weighted_on_stop_unsequenced_tasks.append(&mut tasks); } // Unsequenced tasks come last. weighted_on_stop_tasks.push(weighted_on_stop_unsequenced_tasks); ( weighted_on_start_tasks, weighted_tasks, weighted_on_stop_tasks, ) } fn is_valid_host(host: &str) -> bool { match Url::parse(host) { Ok(_) => true, Err(e) => { error!("invalid host '{}': {}", host, e); std::process::exit(1); } } } #[cfg(test)] mod test { use super::*; #[test] fn valid_host() { // We can only test valid domains, as we exit on failure. // @TODO: rework so we don't exit on failure assert_eq!(is_valid_host("http://example.com"), true); assert_eq!(is_valid_host("http://example.com/"), true); assert_eq!(is_valid_host("https://www.example.com/and/with/path"), true); assert_eq!(is_valid_host("foo://example.com"), true); assert_eq!(is_valid_host("file:///path/to/file"), true); } }