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
//! Goose Eggs are helpful in writing [`Goose`](https://book.goose.rs/) load tests.
//!
//! ## Example
//! The [Umami example](https://github.com/tag1consulting/goose/tree/main/examples/umami)
//! included with Goose has been [converted to use the Goose Eggs library](https://github.com/tag1consulting/goose-eggs/tree/main/examples/umami)
//! and serves as a useful example on how to leverage it when writing load tests.
//!
//! ## Feature flags
//! * `default`: use the native TLS implementation for `goose` and `reqwest`
//! * `rustls-tls`: use the TLS implemenation provided by `rustls`
use goose::goose::GooseResponse;
use goose::prelude::*;
use http::Uri;
use log::info;
use regex::Regex;
use reqwest::header::HeaderMap;
pub mod drupal;
pub mod text;
/// Validate that the status code is equal or not equal to a specified value.
#[derive(Clone, Debug)]
struct ValidateStatus {
// Whether to validate that the status code is equal or not equal to the specified value.
equals: bool,
// Status code to validate
status_code: u16,
}
/// Validate that the page title is equal or not equal to a specified value.
#[derive(Clone, Debug)]
struct ValidateTitle<'a> {
// Whether to validate that the title contains or does not contain the specified value.
exists: bool,
// Title text to validate
title: &'a str,
}
/// Validate that the specified text exists or does not exist on the page.
#[derive(Clone, Debug)]
struct ValidateText<'a> {
// Whether to validate that the page contains or does not contain the specified text.
exists: bool,
// Text to validate
text: &'a str,
}
/// Validate that the specified header exists or does not exist, optionally containing a specified value.
#[derive(Clone, Debug)]
struct ValidateHeader<'a> {
// Whether to validate that the page contains or does not contain the specified header.
exists: bool,
// Header to validate
header: &'a str,
// Header value to validate
value: &'a str,
}
/// Define one or more items to be validated in a web page response. For complete
/// documentation, refer to [`ValidateBuilder`].
///
/// This structure is passed to [`validate_page`] or [`validate_and_load_static_assets`].
#[derive(Clone, Debug)]
pub struct Validate<'a> {
/// Optionally validate the response status code.
status: Option<ValidateStatus>,
/// Optionally validate the response title.
title: Option<ValidateTitle<'a>>,
/// Optionally validate arbitrary texts in the response html.
texts: Vec<ValidateText<'a>>,
/// Optionally validate the response headers.
headers: Vec<ValidateHeader<'a>>,
/// Optionally validate whether or not the page redirects
redirect: Option<bool>,
}
impl<'a> Validate<'a> {
/// Convenience function to bring [`ValidateBuilder`] into scope.
pub fn builder() -> ValidateBuilder<'a> {
ValidateBuilder::new()
}
/// Create a [`Validate`] object that performs no validation.
///
/// This is useful to load all static assets and return the body of the response.
///
/// This structure is passed to [`validate_page`] or [`validate_and_load_static_assets`].
///
/// # Example
/// ```rust
/// use goose_eggs::Validate;
///
/// let _validate = Validate::none();
/// ```
pub fn none() -> Validate<'a> {
Validate::builder().build()
}
}
/// Used to build a [`Validate`] object, necessary to invoke the
/// [`validate_page`] or [`validate_and_load_static_assets`] functions.
///
/// # Example
/// ```rust
/// use goose::prelude::*;
/// use goose_eggs::{validate_and_load_static_assets, Validate};
///
/// transaction!(load_and_validate_page);
///
/// async fn load_and_validate_page(user: &mut GooseUser) -> TransactionResult {
/// // Make a GET request.
/// let mut goose = user.get("example/path").await?;
///
/// // Build a [`Validate`] object to confirm the response is valid.
/// let validate = &Validate::builder()
/// // Validate that the page has `Example` in the title.
/// .title("Example")
/// // Validate that the page has `foo` in the returned html body.
/// .text("foo")
/// // Validate that the page also has `<a href="bar">` in the returned
/// // html body.
/// .text(r#"<a href="bar">"#)
/// .build();
///
/// // Perform the actual validation, using `?` to pass up the error if any
/// // validation fails.
/// validate_and_load_static_assets(
/// user,
/// goose,
/// &validate,
/// ).await?;
///
/// Ok(())
/// }
#[derive(Clone, Debug)]
pub struct ValidateBuilder<'a> {
/// Optionally validate the response status code.
status: Option<ValidateStatus>,
/// Optionally validate the response title.
title: Option<ValidateTitle<'a>>,
/// Optionally validate arbitrary texts in the response html.
texts: Vec<ValidateText<'a>>,
/// Optionally validate the response headers.
headers: Vec<ValidateHeader<'a>>,
/// Optionally validate whether or not the page redirects
redirect: Option<bool>,
}
impl<'a> ValidateBuilder<'a> {
// Internally used when building to set defaults.
fn new() -> Self {
Self {
status: None,
title: None,
texts: vec![],
headers: vec![],
redirect: None,
}
}
/// Define the HTTP status expected to be returned when loading the page.
///
/// This structure is passed to [`validate_page`] or [`validate_and_load_static_assets`].
///
/// # Example
/// ```rust
/// use goose_eggs::Validate;
///
/// let _validate = Validate::builder()
/// .status(200)
/// .build();
/// ```
pub fn status(mut self, status_code: u16) -> Self {
self.status = Some(ValidateStatus {
equals: true,
status_code,
});
self
}
/// Define an HTTP status not expected to be returned when loading the page.
///
/// This structure is passed to [`validate_page`] or [`validate_and_load_static_assets`].
///
/// # Example
/// ```rust
/// use goose_eggs::Validate;
///
/// let _validate = Validate::builder()
/// .not_status(404)
/// .build();
/// ```
pub fn not_status(mut self, status_code: u16) -> Self {
self.status = Some(ValidateStatus {
equals: false,
status_code,
});
self
}
/// Create a [`Validate`] object to validate that response title contains the specified
/// text.
///
/// This structure is passed to [`validate_page`] or [`validate_and_load_static_assets`].
///
/// # Example
/// ```rust
/// use goose_eggs::Validate;
///
/// let _validate = Validate::builder()
/// .title("Home page")
/// .build();
/// ```
pub fn title(mut self, title: impl Into<&'a str>) -> Self {
self.title = Some(ValidateTitle {
exists: true,
title: title.into(),
});
self
}
/// Create a [`Validate`] object to validate that response title does not contain the
/// specified text.
///
/// This structure is passed to [`validate_page`] or [`validate_and_load_static_assets`].
///
/// # Example
/// ```rust
/// use goose_eggs::Validate;
///
/// let _validate = Validate::builder()
/// .not_title("Home page")
/// .build();
/// ```
pub fn not_title(mut self, title: impl Into<&'a str>) -> Self {
self.title = Some(ValidateTitle {
exists: false,
title: title.into(),
});
self
}
/// Create a [`Validate`] object to validate that the response page contains the specified
/// text.
///
/// This structure is passed to [`validate_page`] or [`validate_and_load_static_assets`].
///
/// # Example
/// ```rust
/// use goose_eggs::Validate;
///
/// let _validate = Validate::builder()
/// .text("example")
/// .build();
/// ```
///
/// It's possible to call this function multiple times to validate that multiple texts
/// appear on the page. Alternatively you can call [`ValidateBuilder::texts`].
///
/// # Multiple Example
/// ```rust
/// use goose_eggs::Validate;
///
/// let _validate = Validate::builder()
/// .text("example")
/// .text("another")
/// .build();
/// ```
pub fn text(mut self, text: &'a str) -> Self {
self.texts.push(ValidateText { exists: true, text });
self
}
/// Create a [`Validate`] object to validate that the response page does not contain the
/// specified text.
///
/// This structure is passed to [`validate_page`] or [`validate_and_load_static_assets`].
///
/// # Example
/// ```rust
/// use goose_eggs::Validate;
///
/// let _validate = Validate::builder()
/// .not_text("example not on page")
/// .build();
/// ```
///
/// It's possible to call this function multiple times (and together with `text()`,
/// `texts()` and `not_texts()`) to validate that multiple texts do or do not appear
/// on the page. Alternatively you can call [`ValidateBuilder::texts`].
///
/// # Multiple Example
/// ```rust
/// use goose_eggs::Validate;
///
/// let _validate = Validate::builder()
/// .not_text("example not on the page")
/// .not_text("another not on the page")
/// .text("this is on the page")
/// .build();
/// ```
pub fn not_text(mut self, text: &'a str) -> Self {
self.texts.push(ValidateText {
exists: false,
text,
});
self
}
/// Create a [`Validate`] object to validate that the response page contains the specified
/// texts.
///
/// This structure is passed to [`validate_page`] or [`validate_and_load_static_assets`].
///
/// # Example
/// ```rust
/// use goose_eggs::Validate;
///
/// let _validate = Validate::builder()
/// .texts(vec!["example", "another"])
/// .build();
/// ```
///
/// It's possible to call this function multiple times (and together with `text()`, `not_text()`
/// and `not_texts()`) to validate that multiple texts do or do not appear on the page.
/// Alternatively you can call [`ValidateBuilder::texts`].
///
/// # Example
/// ```rust
/// use goose_eggs::Validate;
///
/// let _validate = Validate::builder()
/// .texts(vec!["example", "another"])
/// .not_texts(vec!["foo", "bar"])
/// .texts(vec!["also this", "and this"])
/// .build();
/// ```
///
/// Alternatively you can call [`ValidateBuilder::text`].
pub fn texts(mut self, texts: Vec<&'a str>) -> Self {
for text in texts {
self = self.text(text);
}
self
}
/// Create a [`Validate`] object to validate that the response page does not contains the
/// specified texts.
///
/// This structure is passed to [`validate_page`] or [`validate_and_load_static_assets`].
///
/// # Example
/// ```rust
/// use goose_eggs::Validate;
///
/// let _validate = Validate::builder()
/// .not_texts(vec!["example", "another"])
/// .build();
/// ```
///
/// It's possible to call this function multiple times (and together with `text()`, `not_text()`
/// and `texts()`) to validate that multiple texts do or do not appear on the page.
/// Alternatively you can call [`ValidateBuilder::texts`].
///
/// # Example
/// ```rust
/// use goose_eggs::Validate;
///
/// let _validate = Validate::builder()
/// .not_texts(vec!["example", "another"])
/// .texts(vec!["does include foo", "and bar"])
/// .not_texts(vec!["but not this", "or this"])
/// .build();
/// ```
///
/// Alternatively you can call [`ValidateBuilder::text`].
pub fn not_texts(mut self, texts: Vec<&'a str>) -> Self {
for text in texts {
self = self.not_text(text);
}
self
}
/// Create a [`Validate`] object to validate that the response includes the specified
/// header.
///
/// To validate that a header contains a specific value (instead of just validating
/// that it exists), use [`ValidateBuilder::header_value`].
///
/// This structure is passed to [`validate_page`] or [`validate_and_load_static_assets`].
///
/// # Example
/// ```rust
/// use goose_eggs::Validate;
///
/// let _validate = Validate::builder()
/// .header("x-cache")
/// .build();
/// ```
///
/// It's possible to call this function multiple times, and/or together with
/// [`ValidateBuilder::not_header`], [`ValidateBuilder::header_value`] and
/// [`ValidateBuilder::not_header_value`].
///
/// # Multiple Example
/// ```rust
/// use goose_eggs::Validate;
///
/// let _validate = Validate::builder()
/// .header("x-cache")
/// .header("x-generator")
/// .build();
/// ```
pub fn header(mut self, header: impl Into<&'a str>) -> Self {
self.headers.push(ValidateHeader {
exists: true,
header: header.into(),
value: "",
});
self
}
/// Create a [`Validate`] object to validate that the response does not include the
/// specified header.
///
/// To validate that a header does not contain a specific value (instead of just validating
/// that it does not exist), use [`ValidateBuilder::not_header_value`].
///
/// This structure is passed to [`validate_page`] or [`validate_and_load_static_assets`].
///
/// # Example
/// ```rust
/// use goose_eggs::Validate;
///
/// let _validate = Validate::builder()
/// .not_header("x-cache")
/// .build();
/// ```
///
/// It's possible to call this function multiple times, and/or together with
/// [`ValidateBuilder::header`], [`ValidateBuilder::header_value`] and
/// [`ValidateBuilder::not_header_value`].
///
/// # Multiple Example
/// ```rust
/// use goose_eggs::Validate;
///
/// let _validate = Validate::builder()
/// .not_header("x-cache")
/// .header("x-generator")
/// .build();
/// ```
pub fn not_header(mut self, header: impl Into<&'a str>) -> Self {
self.headers.push(ValidateHeader {
exists: false,
header: header.into(),
value: "",
});
self
}
/// Create a [`Validate`] object to validate that the response includes the specified
/// header which contains the specified value.
///
/// To validate that a header simply exists without confirming that it contains a
/// specific value, use [`ValidateBuilder::header`].
///
/// This structure is passed to [`validate_page`] or [`validate_and_load_static_assets`].
///
/// # Example
/// ```rust
/// use goose_eggs::Validate;
///
/// let _validate = Validate::builder()
/// .header_value("x-generator", "Drupal 7")
/// .build();
/// ```
///
/// It's possible to call this function multiple times, and/or together with
/// [`ValidateBuilder::header`], [`ValidateBuilder::not_header`] and
/// [`ValidateBuilder::not_header_value`].
///
/// # Multiple Example
/// ```rust
/// use goose_eggs::Validate;
///
/// let _validate = Validate::builder()
/// // Validate that the "x-cache" header is set.
/// .header("x-cache")
/// // Validate that the "x-generator" header is set and contains "Drupal 7".
/// .header_value("x-generator", "Drupal-7")
/// // Validate that the "x-drupal-cache" header is set and contains "HIT".
/// .header_value("x-drupal-cache", "HIT")
/// .build();
/// ```
pub fn header_value(mut self, header: impl Into<&'a str>, value: impl Into<&'a str>) -> Self {
self.headers.push(ValidateHeader {
exists: true,
header: header.into(),
value: value.into(),
});
self
}
/// Create a [`Validate`] object to validate that given header does not contain the specified
/// value.
///
/// To validate that a header simply doesn't exist without confirming that it doesn't contain
/// a specific value, use [`ValidateBuilder::not_header`].
///
/// This structure is passed to [`validate_page`] or [`validate_and_load_static_assets`].
///
/// # Example
/// ```rust
/// use goose_eggs::Validate;
///
/// let _validate = Validate::builder()
/// .not_header_value("x-generator", "Drupal 7")
/// .build();
/// ```
///
/// It's possible to call this function multiple times, and/or together with
/// [`ValidateBuilder::header_value`], [`ValidateBuilder::not_header`] and
/// [`ValidateBuilder::header`].
///
/// # Multiple Example
/// ```rust
/// use goose_eggs::Validate;
///
/// let _validate = Validate::builder()
/// // Validate that the "x-cache" header is set.
/// .header("x-cache")
/// // Validate that the "x-generator" header if set does not contain "Drupal 7".
/// .not_header_value("x-generator", "Drupal-7")
/// // Validate that the "x-drupal-cache" header is set to "HIT".
/// .header_value("x-drupal-cache", "HIT")
/// .build();
/// ```
pub fn not_header_value(
mut self,
header: impl Into<&'a str>,
value: impl Into<&'a str>,
) -> Self {
self.headers.push(ValidateHeader {
exists: false,
header: header.into(),
value: value.into(),
});
self
}
/// Create a [`Validate`] object to validate whether or not the response page redirected.
///
/// This structure is passed to [`validate_page`] or [`validate_and_load_static_assets`].
///
/// # Example
/// ```rust
/// use goose_eggs::Validate;
///
/// // Verify the response redirected.
/// let _validate = Validate::builder().redirect(true).build();
///
/// // Verify the response did not redirect.
/// let _validate = Validate::builder().redirect(false).build();
/// ```
pub fn redirect(mut self, redirect: impl Into<bool>) -> Self {
self.redirect = Some(redirect.into());
self
}
/// Build the [`Validate`] object which is then passed to the
/// [`validate_page`] or [`validate_and_load_static_assets`] functions.
///
/// # Example
/// ```rust
/// use goose_eggs::Validate;
///
/// // Use the default search form to search for `example keys`.
/// let _validate = Validate::builder()
/// .text("example text")
/// .build();
/// ```
pub fn build(self) -> Validate<'a> {
let Self {
status,
title,
texts,
headers,
redirect,
} = self;
Validate {
status,
title,
texts,
headers,
redirect,
}
}
}
/// Use a regular expression to get the HTML header from the web page.
///
/// # Example
/// ```rust
/// use goose_eggs::get_html_header;
///
/// // For this example we grab just a subset of a web page, enough to demonstrate. Normally
/// // you'd use the entire html snippet returned from [`validate_page`] or
/// // [`validate_and_load_static_assets`].
/// let html = r#"
/// <html lang="en" dir="ltr">
/// <head>
/// <meta charset="utf-8" />
/// <link rel="canonical" href="https://example.com/" />
/// <link rel="shortlink" href="https://example.com/" />
/// <meta name="Generator" content="Drupal 9 (https://www.drupal.org)" />
/// <meta name="MobileOptimized" content="width" />
/// <meta name="HandheldFriendly" content="true" />
/// <meta name="viewport" content="width=device-width, initial-scale=1.0" />
/// <title>Example Website</title>
/// </head>
/// <body>
/// This is the web page body.
/// </body>
/// </html>
/// "#;
///
/// let html_header = get_html_header(html);
/// assert!(!html_header.is_none());
/// ```
pub fn get_html_header(html: &str) -> Option<String> {
let re = Regex::new(r#"<head(.*?)</head>"#).unwrap();
// Strip carriage returns to simplify regex.
let line = html.replace('\n', "");
// Return the entire html header, a subset of the received html.
re.captures(&line).map(|value| value[0].to_string())
}
/// Use a regular expression to get the web page title.
///
/// # Example
/// ```rust
/// use goose_eggs::{get_html_header, get_title};
///
/// // For this example we grab just a subset of a web page, enough to demonstrate. Normally
/// // you'd use the entire html snippet returned from [`validate_page`] or
/// // [`validate_and_load_static_assets`].
/// let html = r#"
/// <html lang="en" dir="ltr">
/// <head>
/// <meta charset="utf-8" />
/// <link rel="canonical" href="https://example.com/" />
/// <link rel="shortlink" href="https://example.com/" />
/// <meta name="Generator" content="Drupal 9 (https://www.drupal.org)" />
/// <meta name="MobileOptimized" content="width" />
/// <meta name="HandheldFriendly" content="true" />
/// <meta name="viewport" content="width=device-width, initial-scale=1.0" />
/// <title>Example Website</title>
/// </head>
/// <body>
/// This is the web page body.
/// </body>
/// </html>
/// "#;
///
/// // Start by extracting the HTML header from the HTML.
/// let html_header = get_html_header(html).map_or_else(|| "".to_string(), |h| h.to_string());
/// // Next extract the title from the HTML header.
/// let title = get_title(&html_header).map_or_else(|| "".to_string(), |t| t.to_string());
/// assert_eq!(title, "Example Website");
/// ```
pub fn get_title(html: &str) -> Option<String> {
let re = Regex::new(r#"<title>(.*?)</title>"#).unwrap();
// Strip carriage returns to simplify regex.
let line = html.replace('\n', "");
// Return the entire title, a subset of the received html.
re.captures(&line).map(|value| value[1].to_string())
}
/// Returns a [`bool`] indicating whether or not the title (case insensitive) on the
/// webpage contains the provided string.
///
/// While you can invoke this function directly, it's generally preferred to invoke
/// [`validate_page`] or [`validate_and_load_static_assets`] which in turn invoke this function.
///
/// A valid title is found between `<title></title>` tags inside `<head></head>` tags.
/// For example, if the title is as follows:
/// ```html
/// <head>
/// <title>this is the title</title>
/// </head>
/// ```
///
/// Then a call to `valid_title("the title")` will return [`true`], whereas a call to
/// `valid_title("foo")` will return [`false`].
///
/// This function is case insensitive, so in the above example calling
/// `valid_title("The Title")` and `valid_title("THE TITLE")` will both also return
/// [`true`]. The function only tests if the title includes the specified text, the
/// title can also include other text and will still be considered valid.
///
/// # Example
/// ```rust
/// use goose::prelude::*;
/// use goose_eggs::valid_title;
///
/// transaction!(validate_title).set_on_start();
///
/// async fn validate_title(user: &mut GooseUser) -> TransactionResult {
/// let mut goose = user.get("/").await?;
///
/// match goose.response {
/// Ok(response) => {
/// // Copy the headers so we have them for logging if there are errors.
/// let headers = &response.headers().clone();
/// match response.text().await {
/// Ok(html) => {
/// // Confirm that the HTML header includes the expected title.
/// let title = "example";
/// if !valid_title(&html, title) {
/// return user.set_failure(
/// &format!("{}: title not found: {}", goose.request.raw.url, title),
/// &mut goose.request,
/// Some(headers),
/// Some(&html),
/// );
/// }
/// }
/// Err(e) => {
/// return user.set_failure(
/// &format!("{}: failed to parse page: {}", goose.request.raw.url, e),
/// &mut goose.request,
/// Some(headers),
/// None,
/// );
/// }
/// }
/// }
/// Err(e) => {
/// return user.set_failure(
/// &format!("{}: no response from server: {}", goose.request.raw.url, e),
/// &mut goose.request,
/// None,
/// None,
/// );
/// }
/// }
///
/// Ok(())
/// }
/// ```
pub fn valid_title(html: &str, title: &str) -> bool {
// Extract the HTML header from the provided html.
let html_header = get_html_header(html).map_or_else(|| "".to_string(), |h| h);
// Next extract the title from the HTML header.
let html_title = get_title(&html_header).map_or_else(|| "".to_string(), |t| t);
// Finally, confirm that the title contains the expected text.
html_title
.to_ascii_lowercase()
.contains(title.to_ascii_lowercase().as_str())
}
/// Returns a [`bool`] indicating whether or not an arbitrary str (case sensitive) is found
/// within the html.
///
/// Returns [`true`] if the expected str is found, otherwise returns [`false`].
///
/// This function is case sensitive, if the text "foo" is specified it will only match "foo",
/// not "Foo" or "FOO".
///
/// While you can invoke this function directly, it's generally preferred to invoke
/// [`validate_page`] or [`validate_and_load_static_assets`] which in turn invoke this function.
///
/// # Example
/// ```rust
/// use goose::prelude::*;
/// use goose_eggs::valid_text;
///
/// transaction!(validate_text).set_on_start();
///
/// async fn validate_text(user: &mut GooseUser) -> TransactionResult {
/// let mut goose = user.get("/").await?;
///
/// match goose.response {
/// Ok(response) => {
/// // Copy the headers so we have them for logging if there are errors.
/// let headers = &response.headers().clone();
/// match response.text().await {
/// Ok(html) => {
/// let text = r#"<code class="language-console">$ cargo new hello_world --bin"#;
/// if !valid_text(&html, text) {
/// return user.set_failure(
/// &format!("{}: text not found: {}", goose.request.raw.url, text),
/// &mut goose.request,
/// Some(headers),
/// Some(&html),
/// );
/// }
/// }
/// Err(e) => {
/// return user.set_failure(
/// &format!("{}: failed to parse page: {}", goose.request.raw.url, e),
/// &mut goose.request,
/// Some(headers),
/// None,
/// );
/// }
/// }
/// }
/// Err(e) => {
/// return user.set_failure(
/// &format!("{}: no response from server: {}", goose.request.raw.url, e),
/// &mut goose.request,
/// None,
/// None,
/// );
/// }
/// }
///
/// Ok(())
/// }
/// ```
pub fn valid_text(html: &str, text: &str) -> bool {
html.contains(text)
}
/// Returns a [`bool`] indicating whether or not a header was set in the server Response.
///
/// Returns [`true`] if the expected header was set, otherwise returns [`false`].
///
/// While you can invoke this function directly, it's generally preferred to invoke
/// [`validate_page`] or [`validate_and_load_static_assets`] which in turn invoke this function.
///
/// # Example
/// ```rust
/// use goose::prelude::*;
/// use goose_eggs::header_is_set;
///
/// transaction!(validate_header).set_on_start();
///
/// async fn validate_header(user: &mut GooseUser) -> TransactionResult {
/// let mut goose = user.get("/").await?;
///
/// match goose.response {
/// Ok(response) => {
/// // Copy the headers so we have them for logging if there are errors.
/// let headers = &response.headers().clone();
/// if !header_is_set(headers, "server") {
/// return user.set_failure(
/// &format!("{}: header not found: {}", goose.request.raw.url, "server"),
/// &mut goose.request,
/// Some(headers),
/// None,
/// );
/// }
/// }
/// Err(e) => {
/// return user.set_failure(
/// &format!("{}: no response from server: {}", goose.request.raw.url, e),
/// &mut goose.request,
/// None,
/// None,
/// );
/// }
/// }
///
/// Ok(())
/// }
/// ```
pub fn header_is_set(headers: &HeaderMap, header: &str) -> bool {
headers.contains_key(header)
}
/// Returns a [`bool`] indicating whether or not a header contains an expected value.
///
/// Returns [`true`] if the expected value was found, otherwise returns [`false`].
///
/// Expects a [`&str`] [`tuple`] with a length of 2 where the first defines the header
/// name and the second defines the header value, ie `("name", "value")`.
///
/// While you can invoke this function directly, it's generally preferred to invoke
/// [`validate_page`] or [`validate_and_load_static_assets`] which in turn invoke this function.
///
/// # Example
/// ```rust
/// use goose::prelude::*;
/// use goose_eggs::valid_header_value;
///
/// transaction!(validate_header_value).set_on_start();
///
/// async fn validate_header_value(user: &mut GooseUser) -> TransactionResult {
/// let mut goose = user.get("/").await?;
///
/// match goose.response {
/// Ok(response) => {
/// // Copy the headers so we have them for logging if there are errors.
/// let headers = &response.headers().clone();
/// if !valid_header_value(headers, ("server", "nginx")) {
/// return user.set_failure(
/// &format!("{}: server header value not correct: {}", goose.request.raw.url, "nginx"),
/// &mut goose.request,
/// Some(headers),
/// None,
/// );
/// }
/// }
/// Err(e) => {
/// return user.set_failure(
/// &format!("{}: no response from server: {}", goose.request.raw.url, e),
/// &mut goose.request,
/// None,
/// None,
/// );
/// }
/// }
///
/// Ok(())
/// }
/// ```
pub fn valid_header_value<'a>(headers: &HeaderMap, header: (&'a str, &'a str)) -> bool {
// A header name is required, exit early if it's empty.
if header.0.is_empty() {
info!("no header specified");
return false;
}
if header_is_set(headers, header.0) {
if header.1.is_empty() {
false
} else {
let header_value = match headers.get(header.0) {
// Extract the value of the header and try to convert to a &str.
Some(v) => v.to_str().unwrap_or(""),
None => "",
};
// Check if the desired value is in the header.
if header_value.contains(header.1) {
true
} else {
// Provide some extra debug.
info!(
r#"header does not contain expected value: "{}: {}""#,
header.0, header.1
);
false
}
}
} else {
info!("header ({}) not set", header.0);
false
}
}
/// Helper to confirm the URI is valid and local.
fn valid_local_uri(user: &mut GooseUser, uri: &str) -> bool {
match uri.parse::<Uri>() {
Ok(parsed_uri) => {
if let Some(parsed_host) = parsed_uri.host() {
if parsed_host == user.base_url.host_str().unwrap() {
// The URI host matches the base_url.
true
} else {
// The URI host does not match the base_url.
false
}
} else {
// The URI is a valid relative path.
true
}
}
Err(_) => {
let url_leading = format!("/{}", uri);
match url_leading.parse::<Uri>() {
Ok(_) => {
// The URI is a valid relative path (without a leading slash).
true
}
Err(_) => {
// The URI is not valid.
false
}
}
}
}
}
/// Extract all local static elements defined with a `src=` tag from the the provided html.
///
/// While you can invoke this function directly, it's generally preferred to invoke
/// [`validate_and_load_static_assets`] which in turn invokes this function.
pub async fn get_src_elements(user: &mut GooseUser, html: &str) -> Vec<String> {
// Use a case-insensitive regular expression to find all src=<foo> in the html, where
// <foo> is the URL to local image and js assets.
// @TODO: parse HTML5 srcset= also
let src_elements = Regex::new(r#"(?i)src="(.*?)""#).unwrap();
let mut elements: Vec<String> = Vec::new();
for url in src_elements.captures_iter(html) {
if valid_local_uri(user, &url[1]) {
elements.push(url[1].to_string());
}
}
elements
}
/// Extract all local css elements defined with a `href=` tag from the the provided html.
///
/// While you can invoke this function directly, it's generally preferred to invoke
/// [`validate_and_load_static_assets`] which in turn invokes this function.
pub async fn get_css_elements(user: &mut GooseUser, html: &str) -> Vec<String> {
// Use a case-insensitive regular expression to find all href=<foo> in the html, where
// <foo> is the URL to local css assets.
let css = Regex::new(r#"(?i)href="(.*?\.css.*?)""#).unwrap();
let mut elements: Vec<String> = Vec::new();
for url in css.captures_iter(html) {
if valid_local_uri(user, &url[1]) {
elements.push(url[1].to_string());
}
}
elements
}
/// Extract and load all local static elements from the the provided html.
///
/// While you can invoke this function directly, it's generally preferred to invoke
/// [`validate_and_load_static_assets`] which in turn invokes this function.
///
/// # Example
/// ```rust
/// use goose::prelude::*;
/// use goose_eggs::load_static_elements;
///
/// transaction!(load_page_and_static_elements).set_on_start();
///
/// async fn load_page_and_static_elements(user: &mut GooseUser) -> TransactionResult {
/// let mut goose = user.get("/").await?;
///
/// match goose.response {
/// Ok(response) => {
/// // Copy the headers so we have them for logging if there are errors.
/// let headers = &response.headers().clone();
/// match response.text().await {
/// Ok(html) => {
/// // Load all static elements on page.
/// load_static_elements(user, &html).await;
/// }
/// Err(e) => {
/// return user.set_failure(
/// &format!("{}: failed to parse page: {}", goose.request.raw.url, e),
/// &mut goose.request,
/// Some(headers),
/// None,
/// );
/// }
/// }
/// }
/// Err(e) => {
/// return user.set_failure(
/// &format!("{}: no response from server: {}", goose.request.raw.url, e),
/// &mut goose.request,
/// None,
/// None,
/// );
/// }
/// }
///
/// Ok(())
/// }
/// ```
pub async fn load_static_elements(user: &mut GooseUser, html: &str) {
// Use a case-insensitive regular expression to find all src=<foo> in the html, where
// <foo> is the URL to local image and js assets.
// @TODO: parse HTML5 srcset= also
for url in get_src_elements(user, html).await {
let is_js = url.contains(".js");
let resource_type = if is_js { "js" } else { "img" };
let _ = user
.get_named(&url, &("static asset: ".to_owned() + resource_type))
.await;
}
// Use a case-insensitive regular expression to find all href=<foo> in the html, where
// <foo> is the URL to local css assets.
for url in get_css_elements(user, html).await {
let _ = user.get_named(&url, "static asset: css").await;
}
}
/// Validate the HTML response and return the HTML body.
///
/// What is validated is defined with the [`Validate`] structure.
///
/// If the page doesn't load, an empty [`String`] will be returned. If the page does load
/// but validation fails, an Error is returned. If the page loads and there are no
/// errors the body is returned as a [`String`].
///
/// This function is invoked by [validate_and_load_static_assets], which then also invokes
/// [load_static_elements] to better simulate a web browser loading a page.
///
/// # Example
/// ```rust
/// use goose::prelude::*;
/// use goose_eggs::{validate_page, Validate};
///
/// transaction!(load_page).set_on_start();
///
/// async fn load_page(user: &mut GooseUser) -> TransactionResult {
/// let mut goose = user.get("/").await?;
/// validate_page(
/// user,
/// goose,
/// // Validate title and other arbitrary text on the response html.
/// &Validate::builder()
/// .title("my page")
/// .texts(vec!["foo", r#"<a href="bar">"#])
/// .build(),
/// ).await?;
///
/// Ok(())
/// }
/// ```
pub async fn validate_page<'a>(
user: &mut GooseUser,
mut goose: GooseResponse,
validate: &'a Validate<'a>,
) -> Result<String, Box<TransactionError>> {
let empty = "".to_string();
match goose.response {
Ok(response) => {
// Validate whether or not the request redirected.
if let Some(redirect) = validate.redirect {
if goose.request.redirected != redirect {
// Get as much as we can from the response for useful debug logging.
let headers = &response.headers().clone();
let html = response.text().await.unwrap_or_else(|_| "".to_string());
let error = if redirect {
format!("{}: did not redirect", goose.request.raw.url)
// Unexpected redirect happened.
} else {
format!("{}: redirected unexpectedly", goose.request.raw.url)
};
user.set_failure(&error, &mut goose.request, Some(headers), Some(&html))?;
// Exit as soon as validation fails, to avoid cascades of
// errors whe na page fails to load.
return Ok(html);
}
}
// Validate status code if defined.
if let Some(validate_status) = validate.status.as_ref() {
// If equals is false, error if response.status == status
if !validate_status.equals && response.status() == validate_status.status_code {
// Get as much as we can from the response for useful debug logging.
let headers = &response.headers().clone();
let response_status = response.status();
let html = response.text().await.unwrap_or_else(|_| "".to_string());
user.set_failure(
&format!(
"{}: response status == {}]: {}",
goose.request.raw.url, validate_status.status_code, response_status
),
&mut goose.request,
Some(headers),
Some(&html),
)?;
// Exit as soon as validation fails, to avoid cascades of
// errors whe na page fails to load.
return Ok(html);
// If equals is true, error if response.status != status
} else if validate_status.equals && response.status() != validate_status.status_code
{
// Get as much as we can from the response for useful debug logging.
let headers = &response.headers().clone();
let response_status = response.status();
let html = response.text().await.unwrap_or_else(|_| "".to_string());
user.set_failure(
&format!(
"{}: response status != {}]: {}",
goose.request.raw.url, validate_status.status_code, response_status
),
&mut goose.request,
Some(headers),
Some(&html),
)?;
// Exit as soon as validation fails, to avoid cascades of
// errors whe na page fails to load.
return Ok(html);
}
}
// Validate headers if defined.
let headers = &response.headers().clone();
for validate_header in &validate.headers {
if !validate_header.exists {
if header_is_set(headers, validate_header.header) {
// Get as much as we can from the response for useful debug logging.
let html = response.text().await.unwrap_or_else(|_| "".to_string());
user.set_failure(
&format!(
"{}: header included in response: {:?}",
goose.request.raw.url, validate_header.header
),
&mut goose.request,
Some(headers),
Some(&html),
)?;
// Exit as soon as validation fails, to avoid cascades of
// errors when a page fails to load.
return Ok(html);
}
if !validate_header.value.is_empty()
&& valid_header_value(
headers,
(validate_header.header, validate_header.value),
)
{
// Get as much as we can from the response for useful debug logging.
let html = response.text().await.unwrap_or_else(|_| "".to_string());
user.set_failure(
&format!(
"{}: header contains unexpected value: {:?}",
goose.request.raw.url, validate_header.value
),
&mut goose.request,
Some(headers),
Some(&html),
)?;
// Exit as soon as validation fails, to avoid cascades of
// errors when a page fails to load.
return Ok(html);
}
} else {
if !header_is_set(headers, validate_header.header) {
// Get as much as we can from the response for useful debug logging.
let html = response.text().await.unwrap_or_else(|_| "".to_string());
user.set_failure(
&format!(
"{}: header not included in response: {:?}",
goose.request.raw.url, validate_header.header
),
&mut goose.request,
Some(headers),
Some(&html),
)?;
// Exit as soon as validation fails, to avoid cascades of
// errors when a page fails to load.
return Ok(html);
}
if !validate_header.value.is_empty()
&& !valid_header_value(
headers,
(validate_header.header, validate_header.value),
)
{
// Get as much as we can from the response for useful debug logging.
let html = response.text().await.unwrap_or_else(|_| "".to_string());
user.set_failure(
&format!(
"{}: header does not contain expected value: {:?}",
goose.request.raw.url, validate_header.value
),
&mut goose.request,
Some(headers),
Some(&html),
)?;
// Exit as soon as validation fails, to avoid cascades of
// errors when a page fails to load.
return Ok(html);
}
}
}
// Extract the response body to validate and load static elements.
match response.text().await {
Ok(html) => {
// Validate title if defined.
if let Some(validate_title) = validate.title.as_ref() {
// Be sure the title doesn't contain the specified text.
if !validate_title.exists && valid_title(&html, validate_title.title) {
user.set_failure(
&format!(
"{}: title found: {}",
goose.request.raw.url, validate_title.title
),
&mut goose.request,
Some(headers),
Some(&html),
)?;
// Exit as soon as validation fails, to avoid cascades of
// errors when a page fails to load.
return Ok(html);
// Be sure the title contains the specified text.
} else if validate_title.exists && !valid_title(&html, validate_title.title)
{
user.set_failure(
&format!(
"{}: title not found: {}",
goose.request.raw.url, validate_title.title
),
&mut goose.request,
Some(headers),
Some(&html),
)?;
// Exit as soon as validation fails, to avoid cascades of
// errors when a page fails to load.
return Ok(html);
}
}
// Validate texts in body if defined.
for validate_text in &validate.texts {
if !validate_text.exists && valid_text(&html, validate_text.text) {
user.set_failure(
&format!(
"{}: text found on page: {}",
goose.request.raw.url, validate_text.text
),
&mut goose.request,
Some(headers),
Some(&html),
)?;
// Exit as soon as validation fails, to avoid cascades of
// errors when a page fails to load.
return Ok(html);
} else if validate_text.exists && !valid_text(&html, validate_text.text) {
user.set_failure(
&format!(
"{}: text not found on page: {}",
goose.request.raw.url, validate_text.text
),
&mut goose.request,
Some(headers),
Some(&html),
)?;
// Exit as soon as validation fails, to avoid cascades of
// errors when a page fails to load.
return Ok(html);
}
}
Ok(html)
}
Err(e) => {
user.set_failure(
&format!("{}: failed to parse page: {}", goose.request.raw.url, e),
&mut goose.request,
Some(headers),
None,
)?;
Ok(empty)
}
}
}
Err(e) => {
user.set_failure(
&format!("{}: no response from server: {}", goose.request.raw.url, e),
&mut goose.request,
None,
None,
)?;
Ok(empty)
}
}
}
/// Validate the HTML response, extract and load all static elements on the page, and
/// return the HTML body.
///
/// What is validated is defined with the [`Validate`] structure.
///
/// If the page doesn't load, an empty [`String`] will be returned. If the page does load
/// but validation fails, an Error is returned. If the page loads and there are no
/// errors the body is returned as a [`String`].
///
/// To only validate the page without also loading static elements, use instead
/// [validate_page].
///
/// # Example
/// ```rust
/// use goose::prelude::*;
/// use goose_eggs::{validate_and_load_static_assets, Validate};
///
/// transaction!(load_page).set_on_start();
///
/// async fn load_page(user: &mut GooseUser) -> TransactionResult {
/// let mut goose = user.get("/").await?;
/// validate_and_load_static_assets(
/// user,
/// goose,
/// // Validate title and other arbitrary text on the response html.
/// &Validate::builder()
/// .title("my page")
/// .texts(vec!["foo", r#"<a href="bar">"#])
/// .build(),
/// ).await?;
///
/// Ok(())
/// }
/// ```
pub async fn validate_and_load_static_assets<'a>(
user: &mut GooseUser,
goose: GooseResponse,
validate: &'a Validate<'a>,
) -> Result<String, Box<TransactionError>> {
match validate_page(user, goose, validate).await {
Ok(html) => {
load_static_elements(user, &html).await;
Ok(html)
}
Err(e) => Err(e),
}
}
#[cfg(test)]
mod tests {
use super::*;
use goose::config::GooseConfiguration;
use goose::goose::get_base_url;
use gumdrop::Options;
const EMPTY_ARGS: Vec<&str> = vec![];
const HOST: &str = "http://example.com";
#[tokio::test]
async fn get_static_elements() {
const HTML: &str = r#"<!DOCTYPE html>
<html>
<body>
<!-- 4 valid CSS paths -->
<!-- valid local http path including host -->
<link href="http://example.com/example.css" rel="stylesheet" />
<!-- valid local http path including host and query parameter -->
<link href="http://example.com/example.css?version=abc123" rel="stylesheet" />
<!-- invalid http path on different subdomain -->
<link href="http://other.example.com/example.css" rel="stylesheet" />
<!-- invalid http path on different domain -->
<link href="http://other.com/example.css" rel="stylesheet" />
<!-- invalid http path not ending in css -->
<link href="http://example.com/example" rel="stylesheet" />
<!-- valid relative path -->
<link href="path/to/example.css" rel="stylesheet" />
<!-- valid absolute path -->
<link href="/path/to/example.css" rel="stylesheet" />
<!-- 4 valid image paths -->
<!-- valid local http path including host -->
<img src="http://example.com/example.jpg" alt="example image" width="10" height="10">
<!-- invalid http path on different subdomain -->
<img src="http://another.example.com/example.jpg" alt="example image" width="10" height="10">
<!-- invalid http path on different domain -->
<img src="http://another.com/example.jpg" alt="example image" width="10" height="10">
<!-- valid relative path -->
<img src="path/to/example.gif" alt="example image" />
<!-- valid absolute path -->
<img src="/path/to/example.png" alt="example image" />
<!-- valid absolute path with query parameter -->
<img src="/path/to/example.jpg?itok=Q8u7GC4u" alt="example image" />
<!-- 3 valid JS paths -->
<!-- valid local http path including host -->
<script src="http://example.com/example.js"></script>
<!-- invalid http path on different subdomain -->
<script src="http://different.example.com/example.js"></script>
<!-- valid relative path -->
<script src="path/to/example.js"></script>
<!-- valid absolute path -->
<script src="/path/to/example.js"></script>
</body>
</html>"#;
let configuration = GooseConfiguration::parse_args_default(&EMPTY_ARGS).unwrap();
let base_url = get_base_url(Some(HOST.to_string()), None, None).unwrap();
let mut user =
GooseUser::new(0, "".to_string(), base_url, &configuration, 0, None).unwrap();
let urls = get_css_elements(&mut user, HTML).await;
if urls.len() != 4 {
eprintln!(
"expected matches: {:#?}",
vec![
"http://example.com/example.css",
"http://example.com/example.css?version=abc123",
"path/to/example.css",
"/path/to/example.css",
]
);
eprintln!("actual matches: {:#?}", urls);
}
assert_eq!(urls.len(), 4);
let urls = get_src_elements(&mut user, HTML).await;
if urls.len() != 7 {
eprintln!(
"expected matches: {:#?}",
vec![
"http://example.com/example.jpg",
"path/to/example.gif",
"/path/to/example.png",
"/path/to/example.jpg?itok=Q8u7GC4u",
"http://example.com/example.js",
"path/to/example.js",
"/path/to/example.js",
]
);
eprintln!("actual matches: {:#?}", urls);
}
assert_eq!(urls.len(), 7);
}
}