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
|
// Copyright 2022 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef UI_BASE_INTERACTION_INTERACTIVE_TEST_H_
#define UI_BASE_INTERACTION_INTERACTIVE_TEST_H_
#include <concepts>
#include <functional>
#include <memory>
#include <string>
#include <string_view>
#include <type_traits>
#include <utility>
#include <variant>
#include <vector>
#include "base/functional/callback_helpers.h"
#include "base/strings/strcat.h"
#include "base/strings/stringprintf.h"
#include "base/test/bind.h"
#include "base/test/rectify_callback.h"
#include "base/time/time.h"
#include "build/build_config.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest.h"
#include "ui/base/interaction/element_identifier.h"
#include "ui/base/interaction/element_tracker.h"
#include "ui/base/interaction/interaction_sequence.h"
#include "ui/base/interaction/interaction_test_util.h"
#include "ui/base/interaction/interactive_test_definitions.h"
#include "ui/base/interaction/interactive_test_internal.h"
#include "ui/base/interaction/polling_state_observer.h"
#include "ui/base/interaction/state_observer.h"
#if !BUILDFLAG(IS_IOS)
#include "ui/base/accelerators/accelerator.h"
#endif
namespace ui::test {
// Provides basic interactive test functionality.
//
// Interactive tests use InteractionSequence, ElementTracker, and
// InteractionTestUtil to provide a common library of concise test methods. This
// convenience API is nicknamed "Kombucha" (see
// //chrome/test/interaction/README.md for more information).
//
// This class is not a test fixture; it is a mixin that can be added to an
// existing test fixture using `InteractiveTestT<T>` - or just use
// `InteractiveTest`, which *is* a test fixture.
//
// Also, since this class does not implement input automation for any particular
// framework, you are more likely to want e.g. InteractiveViewsTest[Api] or
// InteractiveBrowserTest[Api], which inherit from this class.
class InteractiveTestApi {
public:
explicit InteractiveTestApi(
std::unique_ptr<internal::InteractiveTestPrivate> private_test_impl);
virtual ~InteractiveTestApi();
InteractiveTestApi(const InteractiveTestApi&) = delete;
void operator=(const InteractiveTestApi&) = delete;
protected:
using InputType = InteractionTestUtil::InputType;
using MultiStep = internal::InteractiveTestPrivate::MultiStep;
using StepBuilder = InteractionSequence::StepBuilder;
using TextEntryMode = InteractionTestUtil::TextEntryMode;
using OnIncompatibleAction =
internal::InteractiveTestPrivate::OnIncompatibleAction;
using AdditionalContext = internal::InteractiveTestPrivate::AdditionalContext;
// Construct a single MultiStep from one or more StepBuilders and/or
// MultiSteps. This should only be necessary when packaging up steps in custom
// verbs, or when appending a sequence of steps to another sequence.
//
// Note that you can use += to append one or more steps to the end of a
// `MultiStep`.
//
// Simple example in a custom verb:
// ```
// auto MyCustomVerb() {
// return Steps(
// DoStep1(),
// DoStep2(),
// DoStep3());
// }
// ```
//
// Example with concatenation:
// ```
// auto MyCustomVerb(bool do_third_step) {
// auto steps = Steps(
// DoStep1(),
// DoStep2());
//
// if (do_third_step) {
// steps += DoStep3();
// }
//
// steps += Steps(
// DoStep4(),
// DoStep5());
//
// AddDescriptionPrefix(steps, "MyCustomVerb()");
// return steps;
// }
// ```
template <typename... Args>
requires(internal::IsValueOrRvalue<Args> && ...)
static MultiStep Steps(Args&&... args);
// Returns an interaction simulator for things like clicking buttons.
// Generally, prefer to use functions like PressButton() to directly using the
// InteractionTestUtil.
InteractionTestUtil& test_util() { return private_test_impl_->test_util(); }
// Runs a test InteractionSequence in `context` from a series of Steps or
// StepBuilders with RunSynchronouslyForTesting(). Hooks both the completed
// and aborted callbacks to ensure completion, and prints an error on failure.
template <typename... Args>
requires(sizeof...(Args) > 0 && (internal::IsValueOrRvalue<Args> && ...))
bool RunTestSequenceInContext(ElementContext context, Args&&... steps);
// An ElementSpecifier holds either an ElementIdentifier or a
// std::string_view denoting a named element in the test sequence.
using ElementSpecifier = internal::ElementSpecifier;
// Convenience methods for creating interaction steps of type kShown. The
// resulting step's start callback is already set; therefore, do not try to
// add additional logic. However, any other parameter on the step may be set,
// such as SetMustBeVisibleAtStart(), SetTransitionOnlyOnEvent(),
// SetContext(), etc.
//
// Note that `ActivateSurface()`, `SelectMenuItem()` and
// `SelectDropdownItem()` are not outside of interactive tests (e.g.
// interactive_ui_tests); the exception is `SelectDropdownItem()` with the
// default `input_type`, which programmatically sets the value rather than
// using the actual drop-down.
[[nodiscard]] StepBuilder PressButton(
ElementSpecifier button,
InputType input_type = InputType::kDontCare);
[[nodiscard]] StepBuilder SelectMenuItem(
ElementSpecifier menu_item,
InputType input_type = InputType::kDontCare);
[[nodiscard]] StepBuilder DoDefaultAction(
ElementSpecifier element,
InputType input_type = InputType::kDontCare);
[[nodiscard]] StepBuilder SelectTab(
ElementSpecifier tab_collection,
size_t tab_index,
InputType input_type = InputType::kDontCare,
std::optional<size_t> expected_index_after_selection = std::nullopt);
[[nodiscard]] StepBuilder SelectDropdownItem(
ElementSpecifier collection,
size_t item,
InputType input_type = InputType::kDontCare);
[[nodiscard]] StepBuilder EnterText(
ElementSpecifier element,
std::u16string text,
TextEntryMode mode = TextEntryMode::kReplaceAll);
[[nodiscard]] StepBuilder ActivateSurface(ElementSpecifier element);
[[nodiscard]] StepBuilder FocusElement(ElementSpecifier element);
#if !BUILDFLAG(IS_IOS)
[[nodiscard]] StepBuilder SendAccelerator(ElementSpecifier element,
Accelerator accelerator);
[[nodiscard]] StepBuilder SendKeyPress(ElementSpecifier element,
KeyboardCode key,
int flags = EF_NONE);
#endif
[[nodiscard]] StepBuilder Confirm(ElementSpecifier element);
// Logs the given arguments, in order, at level INFO.
//
// This is *roughly* (but not exactly) equivalent to:
// `Do([=](){ LOG(INFO) << args...; })`
//
// By default, values are captured at the time the Log step is created, rather
// than when it is run. If you want the value to be captured at runtime, pass
// `std::ref(value)` instead:
//
// ```
// int x = 0;
// RunTestSequence(
// /* maybe change the value of x */
// Log("Value of x at sequence creation: ", x),
// Log("Value of x right now: ", std::ref(x)));
// ```
template <typename... Args>
[[nodiscard]] static StepBuilder Log(Args... args);
// Dumps all of the elements in the current UI tree in all contexts.
[[nodiscard]] StepBuilder DumpElements();
// Dumps all of the elements in the current UI tree in the current context.
[[nodiscard]] StepBuilder DumpElementsInContext();
// Does an action at this point in the test sequence.
template <typename A>
requires internal::HasSignature<A, void()>
[[nodiscard]] static StepBuilder Do(A&& action);
// Performs a check and fails the test if `check_callback` returns false.
template <typename C>
requires internal::HasSignature<C, bool()>
[[nodiscard]] static StepBuilder Check(
C&& check_callback,
std::string check_description = internal::kNoCheckDescriptionSpecified);
// Calls `function` and applies `matcher` to the result. If the matcher does
// not match, an appropriate error message is printed and the test fails.
//
// `matcher` should resolve or convert to a `Matcher<R>`.
template <typename C, typename M, typename R = internal::ReturnTypeOf<C>>
requires internal::HasSignature<C, R()>
[[nodiscard]] static StepBuilder CheckResult(
C&& function,
M&& matcher,
std::string check_description = internal::kNoCheckDescriptionSpecified);
// Checks the value of `variable` against `matcher`. The variable can be any
// local or class member that is guaranteed to still exist when the step is
// executed; if its value at the time the step is executed does not match,
// an appropriate error message is printed and the test fails.
//
// There is no need to wrap `variable` in e.g. `std::ref`; it is always
// captured by reference.
//
// `matcher` should resolve or convert to a `Matcher<T>`.
template <typename V, typename M, typename T = internal::MatcherTypeFor<V>>
[[nodiscard]] static StepBuilder CheckVariable(
V& variable,
M&& matcher,
std::string check_description = internal::kNoCheckDescriptionSpecified);
// Checks that `check` returns true for element `element`. Will fail the test
// sequence if `check` returns false - the callback should log any specific
// error before returning.
//
// Note that unless you add .SetMustBeVisibleAtStart(true), this test step
// will wait for `element` to be shown before proceeding.
template <typename C>
requires internal::HasSignature<C, bool(TrackedElement*)>
[[nodiscard]] static StepBuilder CheckElement(ElementSpecifier element,
C&& check);
// As CheckElement(), but checks that the result of calling `function` on
// `element` matches `matcher`. If not, the mismatch is printed and the test
// fails.
//
// `matcher` should resolve or convert to a `Matcher<R>`.
template <typename F, typename M, typename R = internal::ReturnTypeOf<F>>
requires internal::HasSignature<F, R(TrackedElement*)>
[[nodiscard]] static StepBuilder CheckElement(ElementSpecifier element,
F&& function,
M&& matcher);
// Shorthand methods for working with basic ElementTracker events. The element
// will have `step_callback` called on it. You may specify additional
// constraints such as SetMustBeVisibleAtStart(), SetTransitionOnlyOnEvent(),
// SetContext(), etc.
//
// `step_callback` arguments may be omitted from the left-hand side.
template <typename T>
requires internal::IsStepCallback<T>
[[nodiscard]] static StepBuilder AfterShow(ElementSpecifier element,
T&& step_callback);
template <typename T>
requires internal::IsStepCallback<T>
[[nodiscard]] static StepBuilder AfterEvent(ElementSpecifier element,
CustomElementEventType event_type,
T&& step_callback);
template <typename T>
requires internal::HasCompatibleSignature<T, void(InteractionSequence*)>
[[nodiscard]] static StepBuilder AfterHide(ElementSpecifier element,
T&& step_callback);
// Versions of the above that have no step callback; included for clarity and
// brevity.
[[nodiscard]] static StepBuilder WaitForShow(
ElementSpecifier element,
bool transition_only_on_event = false);
[[nodiscard]] static StepBuilder WaitForHide(
ElementSpecifier element,
bool transition_only_on_event = false);
[[nodiscard]] static StepBuilder WaitForEvent(ElementSpecifier element,
CustomElementEventType event);
// Equivalent to AfterShow() but the element must already be present.
template <typename T>
requires internal::IsStepCallback<T>
[[nodiscard]] static StepBuilder WithElement(ElementSpecifier element,
T&& step_callback);
// Ensures that `element_to_check` is not currently present/visible.
[[nodiscard]] static StepBuilder EnsureNotPresent(
ElementIdentifier element_to_check);
// Opposite of EnsureNotPresent. Equivalent to:
// ```
// WithElement(element_to_check, base::DoNothing())
// ```
[[nodiscard]] static StepBuilder EnsurePresent(
ElementSpecifier element_to_check);
// Specifies an element not relative to any particular other element.
using AbsoluteElementSpecifier = std::variant<
// Specify an element that is known at the time the sequence is created.
// The element must persist until the step executes.
TrackedElement*,
// Specify an element pointer that will be valid by the time the step
// executes. Use `std::ref()` to wrap the pointer that will receive the
// value.
std::reference_wrapper<TrackedElement*>,
// Find and return an element based on an arbitrary rule.
base::OnceCallback<TrackedElement*()>,
// Find and return an element in the given context based on a rule.
base::OnceCallback<TrackedElement*(ElementContext)>>;
// Names an element specified by `spec` as `name`. If `spec` requires a
// context, the context of the current step will be used.
//
// For Views, prefer `InteractiveViewsTest::NameView()`.
[[nodiscard]] StepBuilder NameElement(std::string_view name,
AbsoluteElementSpecifier spec);
// Calls `find_callback` to locate an element relative to element
// `relative_to` and assign it `name`.
//
// For Views, prefer `InteractiveViewsTest::NameViewRelative()`.
template <typename C>
requires internal::HasSignature<C, TrackedElement*(TrackedElement*)>
[[nodiscard]] StepBuilder NameElementRelative(ElementSpecifier relative_to,
std::string_view name,
C&& find_callback);
// Adds an observed state with identifier `id` in the current context. Use
// `WaitForState()` to wait for state changes. This is a useful way to wait
// for an asynchronous state that isn't a UI element.
//
// To construct the observer on the fly as the test is running, use the
// argument-forwarding version below.
//
// Note: Some types are unavailable; for any UTF-8 string type, use
// std::string. For any UTF-16 type, use std::u16string.
template <typename ObserverBase, typename Observer>
requires(std::derived_from<Observer, ObserverBase> &&
IsStateObserver<ObserverBase>)
[[nodiscard]] StepBuilder ObserveState(
StateIdentifier<ObserverBase> id,
std::unique_ptr<Observer> state_observer);
// Adds an observed state with identifier `id` in the current context. Use
// `WaitForState()` to wait for state changes. This is a useful way to wait
// for an asynchronous state that isn't a UI element.
//
// This version of the function forwards its arguments to the `Observer`'s
// constructor, with some of them being evaluated at runtime:
// - Arguments wrapped in `std::ref()` will be unwrapped
// - Functions and callbacks will be evaluated and their return values used
//
// If you must pass a callback or function pointer to the observer's
// constructor, use the other version of this method above.
//
// Note: Some types are unavailable; for any UTF-8 string type, use
// std::string. For any UTF-16 type, use std::u16string.
template <typename Observer, typename... Args>
requires IsStateObserver<Observer>
[[nodiscard]] StepBuilder ObserveState(StateIdentifier<Observer> id,
Args&&... args);
// Polls a state using a polling state observer with `id` and value callback
// `callback`. See `PollingStateObserver` and
// `DECLARE_POLLING_STATE_IDENTIFIER_VALUE()` for more info.
//
// Use WaitForState() to check the polled state. Note that unlike
// `ObserveState()`, transient states may be missed, so prefer using a custom
// event or `ObserveState()` when possible.
template <typename T, typename C>
[[nodiscard]] StepBuilder PollState(
StateIdentifier<PollingStateObserver<T>> id,
C&& callback,
base::TimeDelta polling_interval =
PollingStateObserver<T>::kDefaultPollingInterval);
// Polls an element using a polling element with `element_identifier` in the
// current context using state observer with `id` and value callback
// `callback`. See `PollingElementStateObserver` and
// `DECLARE_POLLING_ELEMENT_STATE_IDENTIFIER_VALUE()` for more info.
//
// Note that the actual value type is not T, but `std::optional<T>`, as the
// state will have the value std::nullopt if the element is not present.
//
// Use WaitForState() to check the polled state. Note that unlike
// `ObserveState()`, transient states may be missed, so prefer using a custom
// event or `ObserveState()` when possible.
template <typename T, typename C>
[[nodiscard]] StepBuilder PollElement(
StateIdentifier<PollingElementStateObserver<T>> id,
ui::ElementIdentifier element_identifier,
C&& callback,
base::TimeDelta polling_interval =
PollingStateObserver<T>::kDefaultPollingInterval);
// Waits for the state of state observer `id` (bound with `ObserveState()` in
// the current context) to match `value`. If `value` is a function, callback,
// or `std::reference_wrapper`, it will be called or unwrapped as the step is
// run, rather than having its value frozen when the test sequence is created.
// A matcher may also be passed, and the step will proceed when the value of
// the state satisfies the matcher.
//
// See /chrome/test/interaction/README.md for more information.
template <typename O, typename V>
requires IsStateObserver<O>
[[nodiscard]] static MultiStep WaitForState(StateIdentifier<O> id, V&& value);
// Checks that the current known state of observer `id` matches `value`. If
// `value` is a function, callback, or `std::reference_wrapper`, it will be
// called or unwrapped as the step is run, rather than having its value frozen
// when the test sequence is created. A matcher may also be passed, and the
// step will proceed when the value of the state satisfies the matcher.
//
// USE WITH CAUTION - if there's any chance of your state being transient or
// asynchronous this will almost certainly cause your test to flake. Use only
// to verify a state you have already observed through some other means.
//
// To this end, since they are inherently asynchronous, polling state
// observers are not supported. To verify the state of a polling observer, you
// must use `WaitForState()`.
template <typename O, typename V>
requires(IsStateObserver<O> && !IsPollingStateObserver<O>)
[[nodiscard]] static StepBuilder CheckState(StateIdentifier<O> id, V&& value);
// Ends observation of a state. Each `StateObserver` is normally cleaned up
// at the end of a test. This cleans up the observer with `id` immediately,
// including halting any associated polling.
//
// Typically unnecessary; included for completeness. Stopping an observation
// might avoid a UAF, or allow the caller to re-use `id` for a different
// observation in the same context.
//
// Must be called in the same context as `ObserveState()`, `PollState()`, etc.
template <typename O>
requires IsStateObserver<O>
[[nodiscard]] StepBuilder StopObservingState(StateIdentifier<O> id);
// Provides syntactic sugar so you can put "in any context" before an action
// or test step rather than after. For example the following are equivalent:
// ```
// PressButton(kElementIdentifier)
// .SetContext(InteractionSequence::ContextMode::kAny)
//
// InAnyContext(PressButton(kElementIdentifier))
// ```
template <typename... Args>
requires(sizeof...(Args) > 0 && (internal::IsValueOrRvalue<Args> && ...))
[[nodiscard]] static MultiStep InAnyContext(Args&&... args);
// Provides syntactic sugar so you can put "inherit context from previous
// step" around a step or steps to ensure a sequence executes in a specific
// context. For example:
// ```
// InAnyContext(WaitForShow(kMyElementInOtherContext)),
// InSameContext(
// PressButton(kMyElementInOtherContext),
// WaitForHide(kMyElementInOtherContext)
// ),
// ```
template <typename... Args>
requires(sizeof...(Args) > 0 && (internal::IsValueOrRvalue<Args> && ...))
[[nodiscard]] static MultiStep InSameContext(Args&&... args);
// Specifies that test step(s) should be executed in a specific context.
template <typename... Args>
requires(sizeof...(Args) > 0 && (internal::IsValueOrRvalue<Args> && ...))
[[nodiscard]] MultiStep InContext(ElementContext context, Args&&... args);
// Specifies that test step(s) should be executed in the same context as a
// specific `element`, which should be unique across contexts or a specific
// named element.
//
// NOTE: If the previous step already references the element, prefer
// `InSameContext()` as it has fewer limitations and handles elements that may
// be present in multiple contexts.
template <typename... Args>
requires(sizeof...(Args) > 0 && (internal::IsValueOrRvalue<Args> && ...))
[[nodiscard]] static MultiStep InSameContextAs(ElementSpecifier element,
Args&&... steps);
// Specifies that these test step(s) should be executed as soon as they are
// eligible to trigger, one after the other. By default, once a step is
// triggered, the system waits for a fresh call stack/message pump iteration
// to run the step callback and/or check for the next step's triggering
// condition.
//
// Use this when you want to respond to some event by doing a series of checks
// immediately, e.g.:
// ```
// PressButton(MyDialog::kCommitChangesButtonId),
// // Have to check the model when the dialog is completing because the model
// // goes away with the dialog.
// WithoutDelay(
// WaitForHide(MyDialog::kElementId),
// CheckResult(&CheckDialogModelCount, 3),
// CheckResult(&CheckDialogModelResult, MyDialogModel::Result::kUpdated)),
// ```
template <typename... Args>
requires(sizeof...(Args) > 0 && (internal::IsValueOrRvalue<Args> && ...))
[[nodiscard]] static MultiStep WithoutDelay(Args&&... steps);
// Creates a method named `Name` that takes the same arguments as `Steps()`
// and returns a strongly-typed StepBlock called `<Name>Block` that can be
// used as the input to specific verbs and control-flow structures.
#define DECLARE_STEP_BLOCK_FACTORY(Name) \
class Name##Block : public internal::StepBlock<Name##Block> { \
public: \
using StepBlock::StepBlock; \
}; \
template <typename... Args> \
requires(internal::IsValueOrRvalue<Args> && ...) \
static Name##Block Name(Args&&... args) { \
return Name##Block(Steps(std::forward<Args>(args)...)); \
}
// Use Then() to specify the step[s] to be executed when the condition of an
// `If()` is true.
DECLARE_STEP_BLOCK_FACTORY(Then)
// Use Else() to specify the step[s] to be executed when the condition of an
// `If()` is false.
DECLARE_STEP_BLOCK_FACTORY(Else)
// Executes `then_steps` if `condition` is true, else executes `else_steps`.
template <typename C>
requires internal::HasSignature<C, bool()>
[[nodiscard]] static StepBuilder If(C&& condition,
ThenBlock then_steps,
ElseBlock else_steps = Else());
// Executes `then_steps` if the result of `function` matches `matcher`, which
// should resolve or convert to a `Matcher<R>`. Arguments to `function` may be
// omitted.
template <typename F, typename M, typename R = internal::ReturnTypeOf<F>>
requires internal::HasCompatibleSignature<F, R(const InteractionSequence*)>
[[nodiscard]] static StepBuilder IfMatches(F&& function,
M&& matcher,
ThenBlock then_steps,
ElseBlock else_steps = Else());
// As If*(), but the `condition` receives a pointer to `element`. If the
// element is not present, null is passed instead (the step does not wait for
// the element to become visible). Arguments to `condition` may be omitted
// from the left.
template <typename C>
requires internal::IsCheckCallback<C, bool>
[[nodiscard]] static StepBuilder IfElement(ElementSpecifier element,
C&& condition,
ThenBlock then_steps,
ElseBlock else_steps = Else());
// As IfElement(), but the result of `function` is compared against `matcher`.
//
// Arguments to `function` may be omitted from the left. `matcher` should
// resolve or convert to a `Matcher<R>`.
template <typename F, typename M, typename R = internal::ReturnTypeOf<F>>
requires internal::IsCheckCallback<F, R>
[[nodiscard]] static StepBuilder IfElementMatches(
ElementSpecifier element,
F&& function,
M&& matcher,
ThenBlock then_steps,
ElseBlock else_steps = Else());
// Use RunSubsequence() to specify each path of an `InParallel()` or
// `AnyOf()`.
DECLARE_STEP_BLOCK_FACTORY(RunSubsequence)
// Executes two or more subsequences in parallel, independently of each other,
// with the expectation that all will succeed. All subsequences must succeed
// or the test will fail.
//
// This is useful when you are waiting for several discrete events, but the
// order they may occur in is unspecified/undefined, and there is no way to
// wait for them in sequence in a way that won't occasionally flake due to the
// race condition.
//
// Side-effects due to callbacks during these subsequences should be
// minimized, as one sequence could theoretically interfere with the
// functioning of another.
//
// Syntax is:
// ```
// InParallel(
// RunSubsequence(...),
// RunSubsequence(...)
// [, RunSubsequence(...) ...] )
// ```
template <typename... Args>
requires(sizeof...(Args) >= 2 &&
(std::same_as<Args, RunSubsequenceBlock> && ...))
[[nodiscard]] static StepBuilder InParallel(Args... subsequences);
// Executes two or more subsequences in parallel, independently of each other,
// with the expectation that at least one will succeed. (The others will be
// canceled.) At least one of the sequences must succeed or the test will
// fail.
//
// Side-effects due to callbacks during these subsequences should be
// minimized, as one sequence could theoretically interfere with the
// functioning of another, and no one sequence is guaranteed to execute to
// completion.
//
// Syntax is:
// ```
// AnyOf(
// RunSubsequence(...),
// RunSubsequence(...)
// [, RunSubsequence(...) ...] )
// ```
template <typename... Args>
requires(sizeof...(Args) >= 2 &&
(std::same_as<Args, RunSubsequenceBlock> && ...))
[[nodiscard]] static StepBuilder AnyOf(Args... additional);
// Sets how to handle a case where a test attempts an operation that is not
// supported in the current platform/build/environment. Default is to fail
// the test. See chrome/test/interaction/README.md for best practices.
//
// Note that `reason` must always be specified, unless `action` is
// `kFailTest`, in which case it may be empty.
[[nodiscard]] StepBuilder SetOnIncompatibleAction(OnIncompatibleAction action,
const char* reason);
// Used internally by methods in this class; do not call.
internal::InteractiveTestPrivate& private_test_impl() {
return *private_test_impl_;
}
// Adds a step or steps to the end of an existing MultiStep. Shorthand for
// making one or more calls to `std::vector::emplace_back`.
static void AddStep(MultiStep& dest, StepBuilder src);
static void AddStep(MultiStep& dest, MultiStep src);
// Equivalent to calling `AddDescriptionPrefix(prefix)` on every step in
// `steps`.
static void AddDescriptionPrefix(MultiStep& steps, std::string_view prefix);
// Call this from any test verb which requires an environment suitable for
// interactive testing. Typically, this means the test must be in an
// environment where it can control mouse input, window activation, etc.
//
// Will crash a test which uses an inappropriate verb, with a description of
// why the verb was disallowed.
void RequireInteractiveTest();
private:
// Implementation for RunTestSequenceInContext().
bool RunTestSequenceImpl(ElementContext context,
InteractionSequence::Builder builder);
// Returns a callback to locate an element based on a pivot element and the
// specification `spec`.
using FindElementCallback =
base::OnceCallback<TrackedElement*(TrackedElement*)>;
static FindElementCallback GetFindElementCallback(
AbsoluteElementSpecifier spec);
// Helper method to add a step or steps to a sequence builder.
static void AddStep(InteractionSequence::Builder& builder, MultiStep steps);
template <typename T>
static void AddStep(InteractionSequence::Builder& builder, T&& step);
std::unique_ptr<internal::InteractiveTestPrivate> private_test_impl_;
};
// Template that adds InteractiveTestApi to any test fixture. No simulators are
// attached to test_util() so if you want to use verbs like PressButton() you
// will need to install your own simulator.
template <typename T>
class InteractiveTestT : public T, public InteractiveTestApi {
public:
template <typename... Args>
explicit InteractiveTestT(Args&&... args)
: T(std::forward<Args>(args)...),
InteractiveTestApi(std::make_unique<internal::InteractiveTestPrivate>(
std::make_unique<InteractionTestUtil>())) {}
~InteractiveTestT() override = default;
protected:
void SetUp() override {
T::SetUp();
private_test_impl().DoTestSetUp();
}
void TearDown() override {
private_test_impl().DoTestTearDown();
T::TearDown();
}
};
// A simple test fixture that brings in all of the features of
// InteractiveTestApi. No simulators are attached to test_util() so if you want
// to use verbs like PressButton() you will need to install your own simulator.
//
// Provided for convenience, but generally you will want InteractiveViewsTest
// or InteractiveBrowserTest instead.
using InteractiveTest = InteractiveTestT<testing::Test>;
// Template definitions:
// static
template <typename... Args>
requires(internal::IsValueOrRvalue<Args> && ...)
InteractiveTestApi::MultiStep InteractiveTestApi::Steps(Args&&... args) {
MultiStep result;
(AddStep(result, std::forward<Args>(args)), ...);
return result;
}
// static
template <typename T>
void InteractiveTestApi::AddStep(InteractionSequence::Builder& builder,
T&& step) {
builder.AddStep(std::forward<T>(step));
}
template <typename... Args>
requires(sizeof...(Args) > 0 && (internal::IsValueOrRvalue<Args> && ...))
bool InteractiveTestApi::RunTestSequenceInContext(ElementContext context,
Args&&... steps) {
// TODO(dfried): is there any additional automation we need to do in order to
// get proper error scoping, RunLoop timeout handling, etc.? We may have to
// inject information directly into the steps or step callbacks; it's unclear.
InteractionSequence::Builder builder;
(AddStep(builder, std::forward<Args>(steps)), ...);
return RunTestSequenceImpl(context, std::move(builder));
}
template <typename A>
requires internal::HasSignature<A, void()>
// static
InteractiveTestApi::StepBuilder InteractiveTestApi::Do(A&& action) {
StepBuilder builder;
builder.SetDescription("Do()");
builder.SetElementID(internal::kInteractiveTestPivotElementId);
builder.SetStartCallback(
base::OnceClosure(internal::MaybeBind(std::forward<A>(action))));
return builder;
}
// static
template <typename T>
requires internal::IsStepCallback<T>
InteractionSequence::StepBuilder InteractiveTestApi::AfterShow(
ElementSpecifier element,
T&& step_callback) {
StepBuilder builder;
builder.SetDescription("AfterShow()");
internal::SpecifyElement(builder, element);
builder.SetStartCallback(
base::RectifyCallback<InteractionSequence::StepStartCallback>(
internal::MaybeBind(std::forward<T>(step_callback))));
return builder;
}
// static
template <typename T>
requires internal::IsStepCallback<T>
InteractionSequence::StepBuilder InteractiveTestApi::AfterEvent(
ElementSpecifier element,
CustomElementEventType event_type,
T&& step_callback) {
StepBuilder builder;
builder.SetDescription(
base::StrCat({"AfterEvent( ", event_type.GetName(), " )"}));
internal::SpecifyElement(builder, element);
builder.SetType(InteractionSequence::StepType::kCustomEvent, event_type);
builder.SetStartCallback(
base::RectifyCallback<InteractionSequence::StepStartCallback>(
internal::MaybeBind(std::forward<T>(step_callback))));
return builder;
}
// static
template <typename T>
requires internal::HasCompatibleSignature<T, void(InteractionSequence*)>
InteractionSequence::StepBuilder InteractiveTestApi::AfterHide(
ElementSpecifier element,
T&& step_callback) {
StepBuilder builder;
builder.SetDescription("AfterHide()");
internal::SpecifyElement(builder, element);
builder.SetType(InteractionSequence::StepType::kHidden);
using Callback = base::OnceCallback<void(InteractionSequence*)>;
builder.SetStartCallback(
base::BindOnce([](Callback callback, InteractionSequence* seq,
TrackedElement*) { std::move(callback).Run(seq); },
base::RectifyCallback<Callback>(
internal::MaybeBind(std::forward<T>(step_callback)))));
return builder;
}
// static
template <typename T>
requires internal::IsStepCallback<T>
InteractionSequence::StepBuilder InteractiveTestApi::WithElement(
ElementSpecifier element,
T&& step_callback) {
StepBuilder builder;
builder.SetDescription("WithElement()");
internal::SpecifyElement(builder, element);
builder.SetStartCallback(
base::RectifyCallback<InteractionSequence::StepStartCallback>(
internal::MaybeBind(std::forward<T>(step_callback))));
builder.SetMustBeVisibleAtStart(true);
return builder;
}
// static
template <typename C>
requires internal::HasSignature<C, TrackedElement*(TrackedElement*)>
InteractionSequence::StepBuilder InteractiveTestApi::NameElementRelative(
ElementSpecifier relative_to,
std::string_view name,
C&& find_callback) {
StepBuilder builder;
builder.SetDescription(
base::StringPrintf("NameElementRelative( \"%s\" )", name.data()));
ui::test::internal::SpecifyElement(builder, relative_to);
builder.SetMustBeVisibleAtStart(true);
builder.SetStartCallback(base::BindOnce(
[](base::OnceCallback<TrackedElement*(TrackedElement*)> find_callback,
std::string name, ui::InteractionSequence* seq,
ui::TrackedElement* el) {
TrackedElement* const result = std::move(find_callback).Run(el);
if (!result) {
LOG(ERROR) << "NameElement(): No View found.";
seq->FailForTesting();
return;
}
seq->NameElement(result, name);
},
ui::test::internal::MaybeBind(std::forward<C>(find_callback)),
std::string(name)));
return builder;
}
// static
template <typename... Args>
requires(sizeof...(Args) > 0 && (internal::IsValueOrRvalue<Args> && ...))
InteractiveTestApi::MultiStep InteractiveTestApi::InAnyContext(Args&&... args) {
auto steps = Steps(std::forward<Args>(args)...);
for (auto& step : steps) {
step.SetContext(InteractionSequence::ContextMode::kAny)
.AddDescriptionPrefix("InAnyContext()");
}
return steps;
}
// static
template <typename... Args>
requires(sizeof...(Args) > 0 && (internal::IsValueOrRvalue<Args> && ...))
InteractiveTestApi::MultiStep InteractiveTestApi::InSameContext(
Args&&... args) {
auto steps = Steps(std::forward<Args>(args)...);
for (auto& step : steps) {
step.SetContext(InteractionSequence::ContextMode::kFromPreviousStep)
.AddDescriptionPrefix("InSameContext()");
}
return steps;
}
template <typename... Args>
requires(sizeof...(Args) > 0 && (internal::IsValueOrRvalue<Args> && ...))
InteractiveTestApi::MultiStep InteractiveTestApi::InContext(
ElementContext context,
Args&&... args) {
// This context may not yet exist, but we want the pivot element to exist.
private_test_impl_->MaybeAddPivotElement(context);
auto steps = Steps(std::forward<Args>(args)...);
const std::string caller =
base::StringPrintf("InContext( %p, )", static_cast<const void*>(context));
for (auto& step : steps) {
step.SetContext(context).AddDescriptionPrefix(caller);
}
return steps;
}
// static
template <typename... Args>
requires(sizeof...(Args) > 0 && (internal::IsValueOrRvalue<Args> && ...))
InteractiveTestApi::MultiStep InteractiveTestApi::InSameContextAs(
ElementSpecifier element,
Args&&... steps) {
return Steps(
WithElement(element, base::DoNothing())
.SetContext(InteractionSequence::ContextMode::kAny)
.SetDescription("InSameContextAs() - locate reference element"),
InSameContext(std::forward<Args>(steps)...));
}
// static
template <typename... Args>
requires(sizeof...(Args) > 0 && (internal::IsValueOrRvalue<Args> && ...))
InteractiveTestApi::MultiStep InteractiveTestApi::WithoutDelay(
Args&&... steps) {
auto result = Steps(std::forward<Args>(steps)...);
for (auto& step : result) {
step.SetStepStartMode(InteractionSequence::StepStartMode::kImmediate)
.AddDescriptionPrefix("WithoutDelay()");
}
return result;
}
// static
template <typename C>
requires internal::IsCheckCallback<C, bool>
InteractionSequence::StepBuilder InteractiveTestApi::IfElement(
ElementSpecifier element,
C&& condition,
ThenBlock then_steps,
ElseBlock else_steps) {
auto step = IfElementMatches(element, std::forward<C>(condition), true,
std::move(then_steps), std::move(else_steps));
step.SetDescription("IfElement()");
return step;
}
// static
template <typename F, typename M, typename R>
requires internal::IsCheckCallback<F, R>
InteractionSequence::StepBuilder InteractiveTestApi::IfElementMatches(
ElementSpecifier element,
F&& function,
M&& matcher,
ThenBlock then_steps,
ElseBlock else_steps) {
InteractionSequence::StepBuilder step;
internal::SpecifyElement(step, element);
step.SetSubsequenceMode(InteractionSequence::SubsequenceMode::kAtMostOne);
using FunctionType =
base::OnceCallback<R(const InteractionSequence*, const TrackedElement*)>;
using MatcherType = internal::MatcherTypeFor<R>;
step.AddSubsequence(
internal::BuildSubsequence(std::move(then_steps.steps())),
base::BindOnce(
[](FunctionType function, testing::Matcher<MatcherType> matcher,
const InteractionSequence* seq, const TrackedElement* el) -> bool {
return matcher.Matches(
MatcherType(std::move(function).Run(seq, el)));
},
base::RectifyCallback<FunctionType>(
internal::MaybeBind(std::forward<F>(function))),
testing::Matcher<MatcherType>(std::forward<M>(matcher))));
if (!else_steps.steps().empty()) {
step.AddSubsequence(
internal::BuildSubsequence(std::move(else_steps.steps())));
}
step.SetDescription("IfElementMatches()");
return step;
}
// static
template <typename C>
requires internal::HasSignature<C, bool()>
InteractionSequence::StepBuilder InteractiveTestApi::If(C&& condition,
ThenBlock then_steps,
ElseBlock else_steps) {
auto step = IfMatches(std::forward<C>(condition), true, std::move(then_steps),
std::move(else_steps));
step.SetDescription("If()");
return step;
}
// static
template <typename F, typename M, typename R>
requires internal::HasCompatibleSignature<F, R(const InteractionSequence*)>
InteractionSequence::StepBuilder InteractiveTestApi::IfMatches(
F&& function,
M&& matcher,
ThenBlock then_steps,
ElseBlock else_steps) {
auto step = IfElementMatches(
internal::kInteractiveTestPivotElementId,
base::BindOnce(
[](base::OnceCallback<R(const InteractionSequence*)> function,
const InteractionSequence* seq, const ui::TrackedElement*) {
return std::move(function).Run(seq);
},
base::RectifyCallback<R(const InteractionSequence*)>(
internal::MaybeBind(std::forward<F>(function)))),
std::forward<M>(matcher), std::move(then_steps), std::move(else_steps));
step.SetDescription("IfMatches()");
return step;
}
// static
template <typename... Args>
requires(sizeof...(Args) >= 2 &&
(std::same_as<Args, InteractiveTestApi::RunSubsequenceBlock> && ...))
InteractionSequence::StepBuilder InteractiveTestApi::InParallel(
Args... subsequences) {
InteractionSequence::StepBuilder step;
step.SetElementID(internal::kInteractiveTestPivotElementId);
step.SetSubsequenceMode(InteractionSequence::SubsequenceMode::kAll);
(step.AddSubsequence(
internal::BuildSubsequence(std::move(subsequences.steps()))),
...);
step.SetDescription("InParallel()");
return step;
}
// static
template <typename... Args>
requires(sizeof...(Args) >= 2 &&
(std::same_as<Args, InteractiveTestApi::RunSubsequenceBlock> && ...))
InteractionSequence::StepBuilder InteractiveTestApi::AnyOf(
Args... subsequences) {
InteractionSequence::StepBuilder step;
step.SetElementID(internal::kInteractiveTestPivotElementId);
step.SetSubsequenceMode(InteractionSequence::SubsequenceMode::kAtLeastOne);
(step.AddSubsequence(
internal::BuildSubsequence(std::move(subsequences.steps()))),
...);
step.SetDescription("AnyOf()");
return step;
}
template <typename ObserverBase, typename Observer>
requires(std::derived_from<Observer, ObserverBase> &&
IsStateObserver<ObserverBase>)
InteractionSequence::StepBuilder InteractiveTestApi::ObserveState(
StateIdentifier<ObserverBase> id,
std::unique_ptr<Observer> observer) {
auto step = CheckElement(
internal::kInteractiveTestPivotElementId,
base::BindOnce(
[](InteractiveTestApi* api, ElementIdentifier id,
std::unique_ptr<Observer> observer, TrackedElement* el) {
return api->private_test_impl().AddStateObserver(
id, el->context(), std::move(observer));
},
base::Unretained(this), id.identifier(), std::move(observer)));
step.SetDescription("ObserveState()");
return step;
}
template <typename Observer, typename... Args>
requires IsStateObserver<Observer>
InteractionSequence::StepBuilder InteractiveTestApi::ObserveState(
StateIdentifier<Observer> id,
Args&&... args) {
auto step = CheckElement(
internal::kInteractiveTestPivotElementId,
base::BindOnce(
[](InteractiveTestApi* api, ElementIdentifier id,
std::remove_cvref_t<Args>... args, TrackedElement* el) {
return api->private_test_impl().AddStateObserver(
id, el->context(),
std::make_unique<Observer>(
internal::UnwrapArgument<Args>(std::move(args))...));
},
base::Unretained(this), id.identifier(), std::move(args)...));
step.SetDescription("ObserveState()");
return step;
}
template <typename T, typename C>
InteractionSequence::StepBuilder InteractiveTestApi::PollState(
StateIdentifier<PollingStateObserver<T>> id,
C&& callback,
base::TimeDelta polling_interval) {
using Cb = PollingStateObserver<T>::PollCallback;
auto step = CheckElement(
internal::kInteractiveTestPivotElementId,
base::BindOnce(
[](InteractiveTestApi* api, ElementIdentifier id, Cb callback,
base::TimeDelta polling_interval, TrackedElement* el) {
return api->private_test_impl().AddStateObserver(
id, el->context(),
std::make_unique<PollingStateObserver<T>>(std::move(callback),
polling_interval));
},
base::Unretained(this), id.identifier(),
internal::MaybeBindRepeating(std::forward<C>(callback)),
polling_interval));
step.SetDescription("PollState()");
return step;
}
template <typename T, typename C>
InteractionSequence::StepBuilder InteractiveTestApi::PollElement(
StateIdentifier<PollingElementStateObserver<T>> id,
ui::ElementIdentifier element_identifier,
C&& callback,
base::TimeDelta polling_interval) {
using Cb = PollingElementStateObserver<T>::PollElementCallback;
auto step = WithElement(
internal::kInteractiveTestPivotElementId,
base::BindOnce(
[](InteractiveTestApi* api, ElementIdentifier id,
ElementIdentifier element_id, Cb callback,
base::TimeDelta polling_interval, InteractionSequence* seq,
TrackedElement* el) {
if (!api->private_test_impl().AddStateObserver(
id, el->context(),
std::make_unique<PollingElementStateObserver<T>>(
element_id,
seq->IsCurrentStepInAnyContextForTesting()
? std::nullopt
: std::make_optional(el->context()),
std::move(callback), polling_interval))) {
seq->FailForTesting();
}
},
base::Unretained(this), id.identifier(), element_identifier,
internal::MaybeBindRepeating(std::forward<C>(callback)),
polling_interval));
step.SetDescription(base::StringPrintf("PollElementState(%s)",
element_identifier.GetName().c_str()));
return step;
}
// static
template <typename O, typename V>
requires IsStateObserver<O>
InteractiveTestApi::MultiStep InteractiveTestApi::WaitForState(
StateIdentifier<O> id,
V&& value) {
using T = typename O::ValueType;
using U = internal::MatcherTypeFor<V>;
auto wait_callback = base::BindOnce(
[](ElementIdentifier id, U value, InteractionSequence* seq,
TrackedElement* el) {
auto* const typed = internal::StateObserverElementT<T>::LookupElement(
id, el->context(), seq->IsCurrentStepInAnyContextForTesting());
if (!typed) {
LOG(ERROR) << "No state observer registered for identifier " << id
<< " in the current context. You must observe a state in "
"the same context you observed it in.";
seq->FailForTesting();
return;
}
typed->SetTarget(internal::CreateMatcherFromValue<T>(value));
},
id.identifier(), U(std::forward<V>(value)));
auto result = Steps(WithElement(internal::kInteractiveTestPivotElementId,
std::move(wait_callback)),
WaitForShow(id.identifier()));
AddDescriptionPrefix(result, "WaitForState()");
return result;
}
// static
template <typename O, typename V>
requires(IsStateObserver<O> && !IsPollingStateObserver<O>)
InteractiveTestApi::StepBuilder InteractiveTestApi::CheckState(
StateIdentifier<O> id,
V&& value) {
using T = typename O::ValueType;
using U = internal::MatcherTypeFor<V>;
auto check_callback = base::BindOnce(
[](ElementIdentifier id, U value, InteractionSequence* seq,
TrackedElement* el) {
auto* const typed = internal::StateObserverElementT<T>::LookupElement(
id, el->context(), seq->IsCurrentStepInAnyContextForTesting());
if (!typed) {
LOG(ERROR) << "No state observer registered for identifier " << id
<< " in the current context. You must observe a state in "
"the same context you observed it in.";
seq->FailForTesting();
return;
}
if (!internal::MatchAndExplain(
"CheckState()", internal::CreateMatcherFromValue<T>(value),
typed->current_value())) {
seq->FailForTesting();
return;
}
},
id.identifier(), U(std::forward<V>(value)));
auto step = WithElement(internal::kInteractiveTestPivotElementId,
std::move(check_callback));
step.SetDescription(
base::StringPrintf("CheckState(%s)", id.identifier().GetName()));
return step;
}
template <typename O>
requires IsStateObserver<O>
InteractiveTestApi::StepBuilder InteractiveTestApi::StopObservingState(
StateIdentifier<O> id) {
auto step = WithElement(
internal::kInteractiveTestPivotElementId,
base::BindOnce(
[](InteractiveTestApi* api, ElementIdentifier id,
InteractionSequence* seq, TrackedElement* el) {
const auto context = seq->IsCurrentStepInAnyContextForTesting()
? ElementContext()
: el->context();
if (!api->private_test_impl().RemoveStateObserver(id, context)) {
seq->FailForTesting();
}
},
base::Unretained(this), id.identifier()));
step.SetDescription(base::StringPrintf("StopObservingState(%s)",
id.identifier().GetName().c_str()));
return step;
}
// static
template <typename... Args>
InteractiveTestApi::StepBuilder InteractiveTestApi::Log(Args... args) {
auto step = Do(base::BindOnce(
[](std::remove_cvref_t<Args>... args) {
auto info = COMPACT_GOOGLE_LOG_INFO;
((info.stream() << internal::UnwrapArgument<Args>(std::move(args))),
...);
},
std::move(args)...));
step.SetDescription("Log()");
return step;
}
// static
template <typename C>
requires internal::HasSignature<C, bool()>
InteractiveTestApi::StepBuilder InteractiveTestApi::Check(
C&& check_callback,
std::string check_description) {
StepBuilder builder;
builder.SetDescription(
base::StringPrintf("Check(\"%s\")", check_description.c_str()));
builder.SetElementID(internal::kInteractiveTestPivotElementId);
builder.SetStartCallback(base::BindOnce(
[](base::OnceCallback<bool()> check_callback, InteractionSequence* seq,
TrackedElement*) {
const bool result = std::move(check_callback).Run();
if (!result) {
seq->FailForTesting();
}
},
internal::MaybeBind(std::forward<C>(check_callback))));
return builder;
}
// static
template <typename C, typename M, typename R>
requires internal::HasSignature<C, R()>
InteractionSequence::StepBuilder InteractiveTestApi::CheckResult(
C&& function,
M&& matcher,
std::string check_description) {
using MatcherType = internal::MatcherTypeFor<R>;
return std::move(
Check(base::BindOnce(
[](base::OnceCallback<R()> function,
testing::Matcher<MatcherType> matcher) {
return internal::MatchAndExplain(
"CheckResult()", matcher,
MatcherType(std::move(function).Run()));
},
internal::MaybeBind(std::forward<C>(function)),
testing::Matcher<MatcherType>(std::forward<M>(matcher))))
.SetDescription(base::StringPrintf("CheckResult(\"%s\")",
check_description.c_str())));
}
// static
template <typename V, typename M, typename T>
InteractionSequence::StepBuilder InteractiveTestApi::CheckVariable(
V& variable,
M&& matcher,
std::string check_description) {
return std::move(
Check(base::BindOnce(
[](std::reference_wrapper<V> ref, testing::Matcher<T> matcher) {
return internal::MatchAndExplain("CheckVariable()", matcher,
ref.get());
},
std::ref(variable),
testing::Matcher<T>(std::forward<M>(matcher))))
.SetDescription(base::StringPrintf("CheckVariable(\"%s\")",
check_description.c_str())));
}
// static
template <typename C>
requires internal::HasSignature<C, bool(TrackedElement*)>
InteractionSequence::StepBuilder InteractiveTestApi::CheckElement(
ElementSpecifier element,
C&& check) {
return CheckElement(element, std::forward<C>(check), true);
}
// static
template <typename F, typename M, typename R>
requires internal::HasSignature<F, R(TrackedElement*)>
InteractionSequence::StepBuilder InteractiveTestApi::CheckElement(
ElementSpecifier element,
F&& function,
M&& matcher) {
StepBuilder builder;
builder.SetDescription("CheckElement()");
internal::SpecifyElement(builder, element);
using MatcherType = internal::MatcherTypeFor<R>;
builder.SetStartCallback(base::BindOnce(
[](base::OnceCallback<R(TrackedElement*)> function,
testing::Matcher<MatcherType> matcher, InteractionSequence* seq,
TrackedElement* el) {
if (!internal::MatchAndExplain(
"CheckElement()", matcher,
MatcherType(std::move(function).Run(el)))) {
seq->FailForTesting();
}
},
internal::MaybeBind(std::forward<F>(function)),
testing::Matcher<MatcherType>(std::forward<M>(matcher))));
return builder;
}
} // namespace ui::test
#endif // UI_BASE_INTERACTION_INTERACTIVE_TEST_H_
|