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
|
// Copyright 2025 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CHROME_BROWSER_GLIC_TEST_SUPPORT_INTERACTIVE_GLIC_TEST_H_
#define CHROME_BROWSER_GLIC_TEST_SUPPORT_INTERACTIVE_GLIC_TEST_H_
#include <map>
#include <sstream>
#include <string_view>
#include "base/path_service.h"
#include "base/test/scoped_feature_list.h"
#include "base/timer/timer.h"
#include "chrome/browser/glic/glic_enabling.h"
#include "chrome/browser/glic/glic_keyed_service.h"
#include "chrome/browser/glic/glic_keyed_service_factory.h"
#include "chrome/browser/glic/glic_pref_names.h"
#include "chrome/browser/glic/host/glic.mojom.h"
#include "chrome/browser/glic/host/glic_cookie_synchronizer.h"
#include "chrome/browser/glic/host/glic_page_handler.h"
#include "chrome/browser/glic/host/host.h"
#include "chrome/browser/glic/test_support/glic_test_environment.h"
#include "chrome/browser/glic/test_support/glic_test_util.h"
#include "chrome/browser/glic/test_support/interactive_test_util.h"
#include "chrome/browser/glic/widget/glic_view.h"
#include "chrome/browser/glic/widget/glic_widget.h"
#include "chrome/browser/glic/widget/glic_window_controller.h"
#include "chrome/browser/picture_in_picture/picture_in_picture_occlusion_tracker.h"
#include "chrome/browser/picture_in_picture/picture_in_picture_window_manager.h"
#include "chrome/browser/ui/browser.h"
#include "chrome/browser/ui/browser_element_identifiers.h"
#include "chrome/browser/ui/browser_list.h"
#include "chrome/browser/ui/browser_window/public/browser_window_interface.h"
#include "chrome/browser/ui/ui_features.h"
#include "chrome/common/chrome_features.h"
#include "chrome/common/chrome_switches.h"
#include "chrome/test/base/in_process_browser_test.h"
#include "chrome/test/interaction/interactive_browser_test.h"
#include "chrome/test/user_education/interactive_feature_promo_test.h"
#include "components/feature_engagement/public/feature_constants.h"
#include "testing/gtest/include/gtest/gtest.h"
#include "ui/base/interaction/interactive_test.h"
#include "ui/events/test/event_generator.h"
#include "url/gurl.h"
#include "url/url_util.h"
namespace glic::test {
extern const InteractiveBrowserTestApi::DeepQuery kPathToMockGlicCloseButton;
extern const InteractiveBrowserTestApi::DeepQuery kPathToGuestPanel;
// Mixin class that adds a mock glic to the current browser.
// If all you need is the combination of this + interactive browser test, use
// `InteractiveGlicTest` (defined below) instead.
template <typename T>
requires(std::derived_from<T, InProcessBrowserTest> &&
std::derived_from<T, InteractiveBrowserTestApi>)
class InteractiveGlicTestT : public T {
public:
// Determines whether this is an attached or detached Glic window.
enum GlicWindowMode {
kAttached,
kDetached,
};
// What portions of the glic window should be instrumented on open.
enum GlicInstrumentMode {
// Instruments the host as `kGlicHostElementId` and contents as
// `kGlicContentsElementId`.
kHostAndContents,
// Instruments only the host as `kGlicHostElementId`.
kHostOnly,
// Does not instrument either.
kNone
};
// Constructor that takes `FieldTrialParams` and a
// `GlicTestEnvironmentConfig`, then forwards the rest of the args.
template <typename... Args>
explicit InteractiveGlicTestT(const base::FieldTrialParams& glic_params,
const GlicTestEnvironmentConfig& glic_config,
Args&&... args)
: T(std::forward<Args>(args)...), glic_test_environment_(glic_config) {
features_.InitWithFeaturesAndParameters(
{{features::kGlic, glic_params},
{features::kTabstripComboButton, {}},
{features::kGlicRollout, {}},
{features::kGlicKeyboardShortcutNewBadge, {}}},
{});
}
// Default constructor (no forwarded args or field trial parameters).
InteractiveGlicTestT()
: InteractiveGlicTestT(base::FieldTrialParams(),
GlicTestEnvironmentConfig()) {}
explicit InteractiveGlicTestT(const base::FieldTrialParams& glic_params)
: InteractiveGlicTestT(glic_params, GlicTestEnvironmentConfig()) {}
// Constructor with no field trial params; all arguments are forwarded to the
// base class.
template <typename Arg, typename... Args>
requires(!std::same_as<base::FieldTrialParams, std::remove_cvref_t<Arg>>)
explicit InteractiveGlicTestT(Arg&& arg, Args&&... args)
: InteractiveGlicTestT(base::FieldTrialParams(),
std::forward<Arg>(arg),
std::forward<Args>(args)...) {}
~InteractiveGlicTestT() override = default;
void SetUpBrowserContextKeyedServices(
content::BrowserContext* context) override {
T::SetUpBrowserContextKeyedServices(context);
}
void SetUpOnMainThread() override {
T::SetUpOnMainThread();
Test::embedded_test_server()->ServeFilesFromDirectory(
base::PathService::CheckedGet(base::DIR_ASSETS)
.AppendASCII("gen/chrome/test/data/webui/glic/"));
Test::embedded_test_server()->ServeFilesFromSourceDirectory(
"chrome/test/data/webui/glic/");
ASSERT_TRUE(test_server_handle_ =
Test::embedded_test_server()->StartAndReturnHandle());
// Need to set this here rather than in SetUpCommandLine because we need to
// use the embedded test server to get the right URL and it's not started
// at that time.
std::ostringstream path;
path << glic_page_path_;
// Append the query parameters to the URL.
bool first_param = true;
auto encode = [](const std::string_view& value) {
url::RawCanonOutputT<char> encoded;
url::EncodeURIComponent(value, &encoded);
return std::string(encoded.view());
};
for (const auto& [key, value] : mock_glic_query_params_) {
path << (first_param ? "?" : "&");
first_param = false;
path << encode(key);
if (!value.empty()) {
path << "=" << encode(value);
}
}
auto* command_line = base::CommandLine::ForCurrentProcess();
guest_url_ = Test::embedded_test_server()->GetURL(path.str());
command_line->AppendSwitchASCII(::switches::kGlicGuestURL,
guest_url_.spec());
}
void TearDownOnMainThread() override {
T::TearDownOnMainThread();
}
void SetGlicPagePath(const std::string& glic_page_path) {
glic_page_path_ = glic_page_path;
}
auto WaitForAndInstrumentGlic(GlicInstrumentMode instrument_mode) {
return WaitForAndInstrumentGlic(instrument_mode, window_controller());
}
// Ensures that the WebContents for some combination of glic host and contents
// are instrumented, per `instrument_mode`. Takes a window controller, to
// permit instrumenting for a different profile.
auto WaitForAndInstrumentGlic(GlicInstrumentMode instrument_mode,
GlicWindowController& window_controller) {
// NOTE: The use of "Api::" here is required because this is a template
// class with weakly-specified base class; it is not necessary in derived
// test classes.
Api::MultiStep steps;
switch (instrument_mode) {
case GlicInstrumentMode::kHostAndContents:
steps = Api::Steps(
Api::UninstrumentWebContents(kGlicContentsElementId, false),
Api::UninstrumentWebContents(kGlicHostElementId, false),
Api::ObserveState(internal::kGlicWindowControllerState,
std::ref(window_controller)),
Api::InAnyContext(Api::Steps(
Api::InstrumentNonTabWebView(kGlicHostElementId,
kGlicViewElementId),
Api::InstrumentInnerWebContents(kGlicContentsElementId,
kGlicHostElementId, 0),
Api::WaitForWebContentsReady(kGlicContentsElementId))),
Api::WaitForState(internal::kGlicWindowControllerState,
GlicWindowController::State::kOpen),
Api::StopObservingState(internal::kGlicWindowControllerState)
/*, WaitForElementVisible(kPathToGuestPanel)*/);
break;
case GlicInstrumentMode::kHostOnly:
steps = Api::Steps(
Api::UninstrumentWebContents(kGlicHostElementId, false),
Api::ObserveState(internal::kGlicWindowControllerState,
std::ref(window_controller)),
Api::InAnyContext(Api::InstrumentNonTabWebView(kGlicHostElementId,
kGlicViewElementId)),
Api::WaitForState(
internal::kGlicWindowControllerState,
testing::Matcher<GlicWindowController::State>(testing::AnyOf(
GlicWindowController::State::kWaitingForGlicToLoad,
GlicWindowController::State::kOpen))),
Api::StopObservingState(internal::kGlicWindowControllerState));
break;
case GlicInstrumentMode::kNone:
// no-op.
break;
}
Api::AddDescriptionPrefix(steps, "WaitForAndInstrumentGlic");
return steps;
}
// Activate one of the glic entrypoints.
// If `instrument_glic_contents` is true both the host and contents will be
// instrumented (see `WaitForAndInstrumentGlic()`) else only the host will be
// instrumented (`WaitForAndInstrumentGlicHostOnly()`).
auto OpenGlicWindow(GlicWindowMode window_mode,
GlicInstrumentMode instrument_mode =
GlicInstrumentMode::kHostAndContents) {
// NOTE: The use of "Api::" here is required because this is a template
// class with weakly-specified base class; it is not necessary in derived
// test classes.
auto steps = Api::Steps(
EnsureGlicWindowState("window must be closed in order to open it",
GlicWindowController::State::kClosed),
// Technically, this toggles the window, but we've already ensured that
// it's closed.
ToggleGlicWindow(window_mode),
WaitForAndInstrumentGlic(instrument_mode));
Api::AddDescriptionPrefix(steps, "OpenGlicWindow");
return steps;
}
// Toggles Glic through one of the entrypoints.
// Does not wait for Glic to open or close, tests using this should check for
// the correct window state after toggling.
auto ToggleGlicWindow(GlicWindowMode window_mode) {
switch (window_mode) {
case GlicWindowMode::kAttached:
return Api::PressButton(kGlicButtonElementId)
.SetContext(
ui::ElementContext(browser()->TopContainer()->GetWidget()));
case GlicWindowMode::kDetached:
return Api::Do(
[this] { window_controller().ShowDetachedForTesting(); });
}
}
// Ensures a mock glic button is present and then clicks it. Works even if the
// element is off-screen.
auto ClickMockGlicElement(
const WebContentsInteractionTestUtil::DeepQuery& where,
const bool click_closes_window = false) {
auto steps = Api::Steps(
// Note: Elements on the test client don't need to be in the viewport to
// be used. Ideally we would wait until the element is visible, but not
// necessarily on screen. Because we don't have any elements that get
// hidden on the test client, waiting for body visibility is good
// enough.
Api::WaitForElementVisible(kGlicContentsElementId, {"body"}),
// TODO(dfried): Figure out why Api::CheckJsResultAt() here doesn't
// work. Error:
// Interactive test failed on step 28 (ClickMockGlicElement:
// CheckJsResultAt( {"#contextAccessIndicator"}, " ... with reason
// kSequenceDestroyed; step type kShown; id ElementIdentifier
// kGlicContentsElementId.
Api::ExecuteJsAt(
kGlicContentsElementId, where, "(el)=>el.click()",
click_closes_window
? InteractiveBrowserTestApi::ExecuteJsMode::kFireAndForget
: InteractiveBrowserTestApi::ExecuteJsMode::
kWaitForCompletion));
Api::AddDescriptionPrefix(steps, "ClickMockGlicElement");
return steps;
}
// Closes the glic window, which must be open.
//
// TODO: this only works if glic is actually loaded; handle the case where the
// contents pane has either not loaded or failed to load.
auto CloseGlicWindow() {
// NOTE: The use of "Api::" here is required because this is a template
// class with weakly-specified base class; it is not necessary in derived
// test classes.
auto steps = Api::InAnyContext(Api::Steps(
EnsureGlicWindowState("cannot close window if it is not open",
GlicWindowController::State::kOpen),
ClickMockGlicElement(kPathToMockGlicCloseButton),
Api::WaitForHide(kGlicViewElementId)));
Api::AddDescriptionPrefix(steps, "CloseGlicWindow");
return steps;
}
auto SimulateAcceleratorPress(const ui::Accelerator& accelerator) {
return Api::Do([this, accelerator] {
gfx::NativeWindow target_window =
window_controller().GetGlicWidget()->GetNativeWindow();
#if (USE_AURA)
ui::test::EventGenerator event_generator(target_window->GetRootWindow(),
target_window);
#else
ui::test::EventGenerator event_generator(target_window);
#endif
event_generator.set_target(ui::test::EventGenerator::Target::WINDOW);
event_generator.PressAndReleaseKeyAndModifierKeys(
accelerator.key_code(), accelerator.modifiers());
});
}
auto CheckControllerHasWidget(bool expect_widget) {
return Api::CheckResult(
[this]() { return window_controller().GetGlicWidget() != nullptr; },
expect_widget, "CheckControllerHasWidget");
}
auto CheckControllerShowing(bool expect_showing) {
return Api::CheckResult(
[this]() { return window_controller().IsShowing(); }, expect_showing,
"CheckControllerShowing");
}
auto CheckControllerWidgetMode(GlicWindowMode mode) {
return Api::CheckResult(
[this]() {
return window_controller().IsAttached() ? GlicWindowMode::kAttached
: GlicWindowMode::kDetached;
},
mode, "CheckControllerWidgetMode");
}
auto CheckPointIsWithinDraggableArea(const gfx::Point& point,
bool expect_within_area) {
return Api::CheckResult(
[this, point]() {
return window_controller().GetGlicView()->IsPointWithinDraggableArea(
point);
},
expect_within_area,
"CheckPointIsWithinDraggableArea_" + point.ToString());
}
auto CheckIfAttachedToBrowser(Browser* new_browser) {
return Api::CheckResult(
[this] { return window_controller().attached_browser(); }, new_browser,
"attached to the other browser");
}
auto CheckWidgetMinimumSize(const gfx::Size& size) {
// Size can't be smaller than the initial size.
auto expected_size = glic::GlicWidget::GetInitialSize();
expected_size.SetToMax(size);
return Api::CheckResult(
[this]() {
return window_controller().GetGlicWidget()->GetMinimumSize();
},
expected_size, "CheckWidgetMinimumSize");
}
auto CheckTabCount(int expected_count) {
return Api::CheckResult(
[this] { return browser()->tab_strip_model()->GetTabCount(); },
expected_count, "CheckTabCount");
}
auto CheckOcclusionTracked(bool expect_is_tracked) {
return Api::CheckResult(
[this]() {
return base::Contains(PictureInPictureWindowManager::GetInstance()
->GetOcclusionTracker()
->GetPictureInPictureWidgetsForTesting(),
window_controller().GetGlicWidget());
},
expect_is_tracked, "CheckOcclusionTracked");
}
auto Wait(base::TimeDelta timeout) {
auto observer = std::make_unique<internal::WaitingStateObserver>();
auto observer_ptr = observer.get();
return Api::Steps(
Api::Do(base::BindRepeating(
[](internal::WaitingStateObserver* observer,
base::TimeDelta timeout) { observer->Start(timeout); },
base::Unretained(observer_ptr), timeout)),
Api::ObserveState(glic::test::internal::kDelayState,
std::move(observer)),
Api::WaitForState(glic::test::internal::kDelayState, true));
}
auto WaitForCanResizeEnabled(bool enabled) {
return Api::Steps(
Api::ObserveState(internal::kGlicWindowControllerResizeState,
std::ref(window_controller())),
Api::Log("WaitForCanResize: ", enabled ? "true" : "false"),
Api::WaitForState(internal::kGlicWindowControllerResizeState, enabled),
Api::StopObservingState(internal::kGlicWindowControllerResizeState));
}
content::RenderFrameHost* FindGlicGuestMainFrame() {
for (GlicPageHandler* handler : host().GetPageHandlersForTesting()) {
if (handler->GetGuestMainFrame()) {
return handler->GetGuestMainFrame();
}
}
return nullptr;
}
glic::GlicTestEnvironment& glic_test_environment() {
return glic_test_environment_;
}
glic::GlicTestEnvironmentService& glic_test_service() {
return *glic_test_environment_.GetService(browser()->GetProfile());
}
protected:
GlicKeyedService* glic_service() {
return GlicKeyedServiceFactory::GetGlicKeyedService(
browser()->GetProfile());
}
GlicWindowController& window_controller() {
return glic_service()->window_controller();
}
Host& host() { return glic_service()->host(); }
template <typename... M>
auto EnsureGlicWindowState(const std::string& desc, M&&... matchers) {
return Api::CheckResult([this]() { return window_controller().state(); },
testing::Matcher<GlicWindowController::State>(
testing::AnyOf(std::forward<M>(matchers)...)),
desc);
}
// Adds a query param to the URL that will be used to load the mock glic.
// Must be called before `SetUpOnMainThread()`. Both `key` and `value` (if
// specified) will be URL-encoded for safety.
void add_mock_glic_query_param(const std::string_view& key,
const std::string_view& value = "") {
mock_glic_query_params_.emplace(key, value);
}
GURL GetGuestURL() {
CHECK(guest_url_.is_valid()) << "Guest URL not yet configured.";
return guest_url_;
}
// `InteractiveGlicTestT` is configured to operate a single browser, but it
// can change which browser it operates. This changes the browser to be used
// in functions of `InteractiveGlicTestT`.
void SetActiveBrowser(Browser* browser) {
active_browser_ = browser->AsWeakPtr();
}
// Returns the active browser.
Browser* browser() {
if (active_browser_) {
return active_browser_.get();
} else {
CHECK(!active_browser_.WasInvalidated())
<< "SetActiveBrowser() was called, but that browser no longer "
"exists.";
return InProcessBrowserTest::browser();
}
}
private:
// Because of limitations in the template system, calls to base class methods
// that are guaranteed by the `requires` clause must still be scoped. These
// are here for convenience to make the methods above more readable.
using Api = InteractiveBrowserTestApi;
using Test = InProcessBrowserTest;
base::WeakPtr<Browser> active_browser_;
glic::GlicTestEnvironment glic_test_environment_;
net::test_server::EmbeddedTestServerHandle test_server_handle_;
// This is the default test file. Tests can override with a different path.
std::string glic_page_path_ = "/glic/test_client/index.html";
GURL guest_url_;
base::test::ScopedFeatureList features_;
std::map<std::string, std::string> mock_glic_query_params_;
};
// For most tests, you can alias or inherit from this instead of deriving your
// own `InteractiveGlicTestT<...>`.
using InteractiveGlicTest = InteractiveGlicTestT<InteractiveBrowserTest>;
// For testing IPH associated with glic - i.e. help bubbles that anchor in the
// chrome browser rather than showing up in the glic content itself - inherit
// from this.
using InteractiveGlicFeaturePromoTest =
InteractiveGlicTestT<InteractiveFeaturePromoTest>;
} // namespace glic::test
#endif // CHROME_BROWSER_GLIC_TEST_SUPPORT_INTERACTIVE_GLIC_TEST_H_
|