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
//! Helpers and objects for building Goose load tests. //! //! Goose manages load tests with a series of objects: //! //! - **GooseTaskSets** a global object that holds all task sets and client states. //! - **GooseTaskSet** each client is assigned a task set, which is a collection of tasks. //! - **GooseTask** tasks define one or more web requests and are assigned to task sets. //! - **GooseClient** a client state responsible for repeatedly running all tasks in the assigned task set. //! - **GooseRequest** optional statistics collected for each URL/method pair. //! //! ## Creating Task Sets //! //! Task sets are created by passing in a &str to the `new` function, for example: //! //! ```rust //! let mut loadtest_tasks = GooseTaskSet::new("LoadtestTasks"); //! ``` //! //! ### Task Set Weight //! //! A weight can be assigned to a task set, controlling how often it is assigned to client //! threads. The larger the value of weight, the more it will be assigned to clients. In the //! following example, `FooTasks` will be assigned to clients twice as often as `Bar` tasks. //! We could have just added a weight of `2` to `FooTasks` and left the default weight of `1` //! assigned to `BarTasks` for the same weighting: //! //! ```rust //! let mut foo_tasks = GooseTaskSet::new("FooTasks").set_weight(10); //! let mut bar_tasks = GooseTaskSet::new("BarTasks").set_weight(5); //! ``` //! //! ### Task Set Host //! //! A default host can be assigned to a task set, which will be used only if the `--host` //! CLI option is not set at run-time. For example, this can configure your load test to //! run against your local development environment by default, allowing the `--host` option //! to override host when you wawnt to load test production. You can assign different //! hosts to different task sets if this is desirable: //! //! ```rust //! foo_tasks.set_host("http://www.local"); //! bar_tasks.set_host("http://www2.local"); //! ``` //! //! ### Task Set Wait Time //! //! Wait time is specified as a low-high integer range. Each time a task completes in //! the task set, the client will pause for a random number of seconds inclusively between //! the low and high wait times. In the following example, Clients loading `foo` tasks will //! sleep 0 to 3 seconds after each task completes, and Clients loading `bar` tasks will //! sleep 5 to 10 seconds after each task completes. //! //! ```rust //! foo_tasks.set_wait_time(0, 3); //! bar_tasks.set_host(5, 10); //! ``` //! ## Creating Tasks //! //! Tasks can be created with or without a name. The name is used when displaying //! statistics about the load test. For example: //! //! ```rust //! let mut a_task = GooseTask::new(); //! let mut b_task = GooseTask::named("b"); //! ``` //! //! ### Task Name //! //! A name can also be assigned (or changed) after a task is created, for example: //! //! ```rust //! a_task.set_name("a"); //! ``` //! //! ### Task Weight //! //! Individual tasks can be assigned a weight, controlling how often the task runs. The //! larger the value of weight, the more it will run. In the following example, `a_task` //! runs 3 times as often as `b_task`: //! //! ```rust //! a_task.set_weight(9); //! b_task.set_weight(3); //! ``` //! //! ### Task Sequence //! //! Tasks can also be configured to run in a sequence. For example, a task with a sequence //! value of `1` will always run before a task with a sequence value of `2`. Weight can //! be applied to sequenced tasks, so for example a task with a weight of `2` and a sequence //! of `1` will run two times before a task with a sequence of `2`. Task sets can contain //! tasks with sequence values and without sequence values, and in this case all tasks with //! a sequence value will run before tasks without a sequence value. In the folllowing example, //! `a_task` runs before `b_task`, which runs before `c_task`: //! //! ```rust //! a_task.set_sequence(1); //! b_task.set_sequence(2); //! let mut c_task = GooseTask::named("c"); //! ``` //! //! ### Task Function //! //! All tasks must be associated with a function. Goose will invoke this function each time //! the task is run. //! //! ```rust //! a_task.set_function(a_task_function); //! b_task.set_function(b_task_function); //! // Re-use the same task function. //! c_task.set_function(b_task_function); //! ``` //! //! The same task function can be assigned to multiple tasks and/or multiple task sets, if desired. //! //! ### Task On Start //! //! Tasks can be flagged to only run when a client first starts. This can be useful if you'd //! like your load test to use a logged-in user. It is possible to assign sequences and weights //! to `on_start` functions if you want to have multiple tasks run at start time, and/or the //! tasks to run multiple times. //! //! ```rust //! a_task.set_on_start(); //! ``` //! //! ### Task On Stop //! //! Tasks can be flagged to only run when a client stop. This can be useful if you'd like your //! load test to simluate a user logging out when it finishes. It is possible to assign sequences //! and weights to `on_stop` functions if you want to have multiple tasks run at stop time, and/or //! the tasks to run multiple times. //! //! ```rust //! a_task.set_on_stop(); //! ``` //! //! ## Controlling Clients //! //! When Goose starts, it creates a configurable number of "clients", assigning a single Task Set //! to each. This client is then used to generate load. Behind the scenes, Goose is leveraging //! the Reqwest Blocking client to load web pages, and Goose can therefor do anything Reqwest can //! do. //! //! The most common request types are GET and POST, but HEAD, PUT, PATCH, and DELETE are also //! fully supported. //! //! ### GET //! //! A HTTP GET request. //! //! ``` //! client.get("/path/to/foo"); //! ``` //! //! ### POST //! //! A HTTP POST request. //! //! ``` //! client.post("/path/to/bar"); //! ``` //! //! ### HEAD //! //! ### PUT //! //! ### PATCH //! //! ### DELETE use std::collections::HashMap; use std::time::Instant; use http::StatusCode; use http::method::Method; use reqwest::blocking::{Client, Response, RequestBuilder}; use reqwest::Error; use url::Url; use crate::Configuration; static APP_USER_AGENT: &str = concat!(env!("CARGO_PKG_NAME"), "/", env!("CARGO_PKG_VERSION")); /// A global list of all Goose task sets #[derive(Clone)] pub struct GooseTaskSets { pub task_sets: Vec<GooseTaskSet>, pub weighted_clients: Vec<GooseClient>, pub weighted_clients_order: Vec<usize>, } impl GooseTaskSets { pub fn new() -> Self { let goose_tasksets = GooseTaskSets { task_sets: Vec::new(), weighted_clients: Vec::new(), weighted_clients_order: Vec::new(), }; goose_tasksets } pub fn register_taskset(&mut self, mut taskset: GooseTaskSet) { taskset.task_sets_index = self.task_sets.len(); self.task_sets.push(taskset); } } /// An individual task set #[derive(Clone)] pub struct GooseTaskSet { pub name: String, // This is the GooseTaskSets.task_sets index pub task_sets_index: usize, pub weight: usize, pub min_wait: usize, pub max_wait: usize, pub tasks: Vec<GooseTask>, pub weighted_tasks: Vec<Vec<usize>>, pub weighted_on_start_tasks: Vec<Vec<usize>>, pub weighted_on_stop_tasks: Vec<Vec<usize>>, pub host: Option<String>, } impl GooseTaskSet { pub fn new(name: &str) -> Self { trace!("new taskset: name: {}", &name); let task_set = GooseTaskSet { name: name.to_string(), task_sets_index: usize::max_value(), weight: 1, min_wait: 0, max_wait: 0, tasks: Vec::new(), weighted_tasks: Vec::new(), weighted_on_start_tasks: Vec::new(), weighted_on_stop_tasks: Vec::new(), host: None, }; task_set } pub fn register_task(&mut self, mut task: GooseTask) { trace!("{} register_task: {}", self.name, task.name); task.tasks_index = self.tasks.len(); self.tasks.push(task); } pub fn set_weight(mut self, weight: usize) -> Self { trace!("{} set_weight: {}", self.name, weight); if weight < 1 { error!("{} weight of {} not allowed", self.name, weight); std::process::exit(1); } else { self.weight = weight; } self } pub fn set_host(mut self, host: &str) -> Self { trace!("{} set_host: {}", self.name, host); // Host validation happens in main() at startup. self.host = Some(host.to_string()); self } pub fn set_wait_time(mut self, min_wait: usize, max_wait: usize) -> Self { trace!("{} set_wait time: min: {} max: {}", self.name, min_wait, max_wait); if min_wait > max_wait { error!("min_wait({}) can't be larger than max_weight({})", min_wait, max_wait); std::process::exit(1); } self.min_wait = min_wait; self.max_wait = max_wait; self } } #[derive(Debug, Clone)] pub enum GooseClientMode { INIT, HATCHING, RUNNING, EXITING, } #[derive(Debug, Clone)] pub enum GooseClientCommand { // Tell client thread to push statistics to parent SYNC, // Tell client thread to exit EXIT, } #[derive(Debug, Clone)] pub struct GooseRequest { pub url: String, pub method: Method, pub response_times: Vec<f32>, pub status_code_counts: HashMap<u16, usize>, pub success_count: usize, pub fail_count: usize, } impl GooseRequest { pub fn new(url: &str, method: Method) -> Self { trace!("new request"); GooseRequest { url: url.to_string(), method: method, response_times: Vec::new(), status_code_counts: HashMap::new(), success_count: 0, fail_count: 0, } } pub fn set_response_time(&mut self, response_time: f32) { self.response_times.push(response_time); } pub fn set_status_code(&mut self, status_code: StatusCode) { let status_code_u16 = status_code.as_u16(); let counter = match self.status_code_counts.get(&status_code_u16) { // We've seen this status code before, increment counter. Some(c) => { debug!("got {} counter: {}", status_code, c); *c + 1 } // First time we've seen this status code, initialize counter. None => { debug!("no match for counter: {}", status_code_u16); 1 } }; self.status_code_counts.insert(status_code_u16, counter); debug!("incremented {} counter: {}", status_code_u16, counter); } } #[derive(Debug, Clone)] pub struct GooseClient { // This is the GooseTaskSets.task_sets index pub task_sets_index: usize, // This is the reqwest.blocking.client (@TODO: test with async) pub client: Client, pub task_set_host: Option<String>, pub min_wait: usize, pub max_wait: usize, pub config: Configuration, pub weighted_clients_index: usize, pub mode: GooseClientMode, pub weighted_on_start_tasks: Vec<Vec<usize>>, pub weighted_tasks: Vec<Vec<usize>>, pub weighted_bucket: usize, pub weighted_bucket_position: usize, pub weighted_on_stop_tasks: Vec<Vec<usize>>, pub request_name: String, pub requests: HashMap<String, GooseRequest>, } impl GooseClient { /// Create a new client state. pub fn new(index: usize, host: Option<String>, min_wait: usize, max_wait: usize, configuration: &Configuration) -> Self { trace!("new client"); let builder = Client::builder() .user_agent(APP_USER_AGENT); let client = match builder.build() { Ok(c) => c, Err(e) => { error!("failed to build client {}: {}", index, e); std::process::exit(1); } }; GooseClient { task_sets_index: index, task_set_host: host, client: client, config: configuration.clone(), min_wait: min_wait, max_wait: max_wait, weighted_clients_index: usize::max_value(), mode: GooseClientMode::INIT, weighted_on_start_tasks: Vec::new(), weighted_tasks: Vec::new(), weighted_bucket: 0, weighted_bucket_position: 0, weighted_on_stop_tasks: Vec::new(), request_name: "".to_string(), requests: HashMap::new(), } } pub fn set_mode(&mut self, mode: GooseClientMode) { self.mode = mode; } fn get_request(&mut self, url: &str, method: &Method) -> GooseRequest { let key = format!("{:?} {}", method, url); trace!("get key: {}", &key); match self.requests.get(&key) { Some(r) => r.clone(), None => GooseRequest::new(url, method.clone()), } } fn set_request(&mut self, url: &str, method: &Method, request: GooseRequest) { let key = format!("{:?} {}", method, url); trace!("set key: {}", &key); self.requests.insert(key, request.clone()); } fn build_url(&mut self, path: &str) -> String { if self.config.host.len() > 0 { format!("{}{}", self.config.host, path) } else { // If no global URL is configured a task_set_host must be, so unwrap() is safe here. format!("{}{}", self.task_set_host.clone().unwrap(), path) } } // Simple get() wrapper that calls goose_get() followed by goose_send(). pub fn get(&mut self, path: &str) -> Result<Response, Error> { let request_builder = self.goose_get(path); let response = self.goose_send(request_builder); response } // Simple post() wrapper that calls goose_post() followed by goose_send(). pub fn post(&mut self, path: &str, body: String) -> Result<Response, Error> { let request_builder = self.goose_post(path).body(body); let response = self.goose_send(request_builder); response } // Simple head() wrapper that calls goose_head() followed by goose_send(). pub fn head(&mut self, path: &str) -> Result<Response, Error> { let request_builder = self.goose_head(path); let response = self.goose_send(request_builder); response } // Simple delete() wrapper that calls goose_delete() followed by goose_send(). pub fn delete(&mut self, path: &str) -> Result<Response, Error> { let request_builder = self.goose_delete(path); let response = self.goose_send(request_builder); response } // Calls Reqwest get() and returns a Reqwest RequestBuilder. pub fn goose_get(&mut self, path: &str) -> RequestBuilder { let url = self.build_url(path); self.client.get(&url) } // Calls Reqwest post() and returns a Reqwest RequestBuilder. pub fn goose_post(&mut self, path: &str) -> RequestBuilder { let url = self.build_url(path); self.client.post(&url) } // Calls Reqwest head() and returns a Reqwest RequestBuilder. pub fn goose_head(&mut self, path: &str) -> RequestBuilder { let url = self.build_url(path); self.client.head(&url) } // Calls Reqwest put() and returns a Reqwest RequestBuilder. pub fn goose_put(&mut self, path: &str) -> RequestBuilder { let url = self.build_url(path); self.client.put(&url) } // Calls Reqwest patch() and returns a Reqwest RequestBuilder. pub fn goose_patch(&mut self, path: &str) -> RequestBuilder { let url = self.build_url(path); self.client.patch(&url) } // Calls Reqwest delete() and returns a Reqwest RequestBuilder. pub fn goose_delete(&mut self, path: &str) -> RequestBuilder { let url = self.build_url(path); self.client.delete(&url) } // Executes a Reqwest RequestBuilder, optionally capturing statistics. pub fn goose_send(&mut self, request_builder: RequestBuilder) -> Result<Response, Error> { let started = Instant::now(); let request = request_builder.build()?; // Allow introspection. let method = request.method().clone(); let url = request.url().to_string(); // Make the actual request. let response = self.client.execute(request); let elapsed = started.elapsed() * 100; if self.config.print_stats { // Introspect the request for logging and statistics let path = match Url::parse(&url) { Ok(u) => u.path().to_string(), Err(e) => { warn!("failed to parse url: {}", e); "parse error".to_string() } }; // By default requests are recorded as "METHOD URL", allow override of "METHOD NAME" let request_name; if self.request_name != "" { request_name = self.request_name.to_string(); } else { request_name = path.to_string(); } let mut goose_request = self.get_request(&request_name, &method.clone()); goose_request.set_response_time(elapsed.as_secs_f32()); match &response { Ok(r) => { let status_code = r.status(); // Only increment status_code_counts if we're displaying the results if self.config.status_codes { goose_request.set_status_code(status_code); } debug!("{:?}: status_code {}", &path, status_code); // @TODO: match/handle all is_foo() https://docs.rs/http/0.2.1/http/status/struct.StatusCode.html if status_code.is_success() { goose_request.success_count += 1; } // @TODO: properly track redirects and other code ranges else { // @TODO: handle this correctly debug!("{:?}: non-success status_code: {:?}", &path, status_code); goose_request.fail_count += 1; } } Err(e) => { // @TODO: what can we learn from a reqwest error? debug!("{:?}: error: {}", &path, e); goose_request.fail_count += 1; } }; self.set_request(&request_name, &method, goose_request); } response } } /// An individual task within a task set #[derive(Clone)] pub struct GooseTask { // This is the GooseTaskSet.tasks index pub tasks_index: usize, pub name: String, pub weight: usize, pub sequence: usize, pub on_start: bool, pub on_stop: bool, pub function: Option<fn(&mut GooseClient)>, } impl GooseTask { pub fn new() -> Self { trace!("new task"); let task = GooseTask { tasks_index: usize::max_value(), name: "".to_string(), weight: 1, sequence: 0, on_start: false, on_stop: false, function: None, }; task } pub fn named(name: &str) -> Self { trace!("new task: {}", name); let task = GooseTask { tasks_index: usize::max_value(), name: name.to_string(), weight: 1, sequence: 0, on_start: false, on_stop: false, function: None, }; task } pub fn set_on_start(mut self) -> Self { trace!("{} [{}] set_on_start task", self.name, self.tasks_index); self.on_start = true; self } pub fn set_on_stop(mut self) -> Self { trace!("{} [{}] set_on_stop task", self.name, self.tasks_index); self.on_stop = true; self } pub fn set_name(mut self, name: &str) -> Self { trace!("[{}] set_name: {}", self.tasks_index, self.name); self.name = name.to_string(); self } pub fn set_weight(mut self, weight: usize) -> Self { trace!("{} [{}] set_weight: {}", self.name, self.tasks_index, weight); if weight < 1 { error!("{} weight of {} not allowed", self.name, weight); std::process::exit(1); } else { self.weight = weight; } self } pub fn set_sequence(mut self, sequence: usize) -> Self { trace!("{} [{}] set_sequence: {}", self.name, self.tasks_index, sequence); if sequence < 1 { info!("setting sequence to 0 for task {} is unnecessary, sequence disabled", self.name); } self.sequence = sequence; self } pub fn set_function(mut self, function: fn(&mut GooseClient)) -> Self { self.function = Some(function); self } }