blob: 14ed4922ac058a5db81edb7c512306007c644bba [file] [log] [blame]
// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "chrome/test/base/ui_test_utils.h"
#include "base/memory/raw_ptr.h"
#include "base/scoped_observation.h"
#include <stddef.h>
#include <memory>
#include "base/bind.h"
#include "base/callback.h"
#include "base/callback_helpers.h"
#include "base/command_line.h"
#include "base/containers/contains.h"
#include "base/files/file_path.h"
#include "base/files/file_util.h"
#include "base/logging.h"
#include "base/memory/ref_counted.h"
#include "base/path_service.h"
#include "base/run_loop.h"
#include "base/strings/utf_string_conversions.h"
#include "base/test/bind.h"
#include "base/test/test_timeouts.h"
#include "base/threading/thread_restrictions.h"
#include "base/time/time.h"
#include "build/build_config.h"
#include "chrome/browser/bookmarks/bookmark_model_factory.h"
#include "chrome/browser/chrome_notification_types.h"
#include "chrome/browser/history/history_service_factory.h"
#include "chrome/browser/profiles/profile.h"
#include "chrome/browser/ui/browser.h"
#include "chrome/browser/ui/browser_commands.h"
#include "chrome/browser/ui/browser_finder.h"
#include "chrome/browser/ui/browser_list.h"
#include "chrome/browser/ui/browser_navigator.h"
#include "chrome/browser/ui/browser_navigator_params.h"
#include "chrome/browser/ui/browser_window.h"
#include "chrome/browser/ui/location_bar/location_bar.h"
#include "chrome/common/chrome_paths.h"
#include "chrome/common/pref_names.h"
#include "chrome/test/base/find_result_waiter.h"
#include "components/bookmarks/browser/bookmark_model.h"
#include "components/download/public/common/download_item.h"
#include "components/find_in_page/find_notification_details.h"
#include "components/find_in_page/find_tab_helper.h"
#include "components/history/core/browser/history_service_observer.h"
#include "components/javascript_dialogs/app_modal_dialog_controller.h"
#include "components/javascript_dialogs/app_modal_dialog_queue.h"
#include "components/omnibox/browser/autocomplete_controller.h"
#include "components/omnibox/browser/omnibox_controller_emitter.h"
#include "components/omnibox/browser/omnibox_edit_model.h"
#include "components/omnibox/browser/omnibox_view.h"
#include "components/prefs/pref_service.h"
#include "content/public/browser/download_manager.h"
#include "content/public/browser/navigation_controller.h"
#include "content/public/browser/navigation_entry.h"
#include "content/public/browser/notification_service.h"
#include "content/public/browser/render_frame_host.h"
#include "content/public/browser/render_process_host.h"
#include "content/public/browser/storage_partition.h"
#include "content/public/browser/web_contents.h"
#include "content/public/browser/web_contents_observer.h"
#include "content/public/test/browser_test_utils.h"
#include "content/public/test/download_test_observer.h"
#include "content/public/test/test_navigation_observer.h"
#include "content/public/test/test_utils.h"
#include "net/base/filename_util.h"
#include "net/cookies/canonical_cookie.h"
#include "net/cookies/cookie_constants.h"
#include "net/cookies/cookie_monster.h"
#include "net/cookies/cookie_store.h"
#include "net/cookies/cookie_util.h"
#include "services/device/public/mojom/geoposition.mojom.h"
#include "services/network/public/cpp/resource_request_body.h"
#include "services/network/public/mojom/cookie_manager.mojom.h"
#include "third_party/blink/public/common/chrome_debug_urls.h"
#include "ui/gfx/geometry/rect.h"
#if BUILDFLAG(IS_WIN)
#include <windows.h>
#endif
#if defined(TOOLKIT_VIEWS)
#include "ui/views/view.h"
#include "ui/views/widget/widget.h"
#endif
using content::NavigationController;
using content::NavigationEntry;
using content::OpenURLParams;
using content::Referrer;
using content::WebContents;
namespace ui_test_utils {
namespace {
Browser* WaitForBrowserNotInSet(std::set<Browser*> excluded_browsers) {
Browser* new_browser = GetBrowserNotInSet(excluded_browsers);
if (!new_browser) {
new_browser = WaitForBrowserToOpen();
// The new browser should never be in |excluded_browsers|.
DCHECK(!base::Contains(excluded_browsers, new_browser));
}
return new_browser;
}
class AppModalDialogWaiter : public javascript_dialogs::AppModalDialogObserver {
public:
AppModalDialogWaiter() = default;
AppModalDialogWaiter(const AppModalDialogWaiter&) = delete;
AppModalDialogWaiter& operator=(const AppModalDialogWaiter&) = delete;
~AppModalDialogWaiter() override = default;
javascript_dialogs::AppModalDialogController* Wait() {
if (dialog_)
return dialog_;
message_loop_runner_ = new content::MessageLoopRunner;
message_loop_runner_->Run();
EXPECT_TRUE(dialog_);
return dialog_;
}
// AppModalDialogObserver:
void Notify(javascript_dialogs::AppModalDialogController* dialog) override {
DCHECK(!dialog_);
dialog_ = dialog;
CheckForHangMonitorDisabling(dialog);
if (message_loop_runner_.get() && message_loop_runner_->loop_running())
message_loop_runner_->Quit();
}
static void CheckForHangMonitorDisabling(
javascript_dialogs::AppModalDialogController* dialog) {
// If a test waits for a beforeunload dialog but hasn't disabled the
// beforeunload hang timer before triggering it, there will be a race
// between the dialog and the timer and the test will be flaky. We can't
// disable the timer here, as it's too late, but we can tell when we've won
// a race that we shouldn't have been in.
if (!dialog->is_before_unload_dialog())
return;
// Unfortunately we don't know which frame spawned this dialog and should
// have the hang monitor disabled, so we cheat a bit and search for *a*
// frame with the hang monitor disabled. The failure case that's worrisome
// is someone who doesn't know the requirement to disable the hang monitor,
// and this will catch that case.
auto* contents = dialog->web_contents();
bool found_disabled_for_testing = false;
contents->GetPrimaryMainFrame()->ForEachRenderFrameHostWithAction(
[&found_disabled_for_testing](content::RenderFrameHost* frame) {
if (frame->IsBeforeUnloadHangMonitorDisabledForTesting()) {
found_disabled_for_testing = true;
return content::RenderFrameHost::FrameIterationAction::kStop;
}
return content::RenderFrameHost::FrameIterationAction::kContinue;
});
ASSERT_TRUE(found_disabled_for_testing)
<< "If waiting for a beforeunload dialog, the beforeunload timer "
"must be disabled on the spawning frame to avoid flakiness.";
}
private:
raw_ptr<javascript_dialogs::AppModalDialogController> dialog_ = nullptr;
scoped_refptr<content::MessageLoopRunner> message_loop_runner_;
};
class AutocompleteChangeObserver : public AutocompleteController::Observer {
public:
explicit AutocompleteChangeObserver(Profile* profile) {
scoped_observation_.Observe(
OmniboxControllerEmitter::GetForBrowserContext(profile));
}
AutocompleteChangeObserver(const AutocompleteChangeObserver&) = delete;
AutocompleteChangeObserver& operator=(const AutocompleteChangeObserver&) =
delete;
~AutocompleteChangeObserver() override = default;
void Wait() { run_loop_.Run(); }
// AutocompleteController::Observer:
void OnResultChanged(AutocompleteController* controller,
bool default_match_changed) override {
if (run_loop_.running())
run_loop_.Quit();
}
private:
base::RunLoop run_loop_;
base::ScopedObservation<OmniboxControllerEmitter,
AutocompleteController::Observer>
scoped_observation_{this};
};
} // namespace
bool GetCurrentTabTitle(const Browser* browser, std::u16string* title) {
WebContents* web_contents =
browser->tab_strip_model()->GetActiveWebContents();
if (!web_contents)
return false;
NavigationEntry* last_entry = web_contents->GetController().GetActiveEntry();
if (!last_entry)
return false;
title->assign(last_entry->GetTitleForDisplay());
return true;
}
void NavigateToURL(NavigateParams* params) {
Navigate(params);
content::WaitForLoadStop(params->navigated_or_inserted_contents);
}
void NavigateToURLWithPost(Browser* browser, const GURL& url) {
NavigateParams params(browser, url, ui::PAGE_TRANSITION_FORM_SUBMIT);
std::string post_data("test=body");
params.post_data = network::ResourceRequestBody::CreateFromBytes(
post_data.data(), post_data.size());
NavigateToURL(&params);
}
content::RenderFrameHost* NavigateToURL(Browser* browser, const GURL& url) {
return NavigateToURLWithDisposition(browser, url,
WindowOpenDisposition::CURRENT_TAB,
BROWSER_TEST_WAIT_FOR_LOAD_STOP);
}
content::RenderFrameHost*
NavigateToURLWithDispositionBlockUntilNavigationsComplete(
Browser* browser,
const GURL& url,
int number_of_navigations,
WindowOpenDisposition disposition,
int browser_test_flags) {
TRACE_EVENT1("test",
"ui_test_utils::"
"NavigateToURLWithDispositionBlockUntilNavigationsComplete",
"params", [&](perfetto::TracedValue context) {
// TODO(crbug.com/1183371): Replace this with passing more
// parameters to TRACE_EVENT directly when available.
auto dict = std::move(context).WriteDictionary();
dict.Add("url", url);
dict.Add("number_of_navigations", number_of_navigations);
dict.Add("disposition", disposition);
dict.Add("browser_test_flags", browser_test_flags);
});
TabStripModel* tab_strip = browser->tab_strip_model();
if (disposition == WindowOpenDisposition::CURRENT_TAB &&
tab_strip->GetActiveWebContents())
content::WaitForLoadStop(tab_strip->GetActiveWebContents());
content::TestNavigationObserver same_tab_observer(
tab_strip->GetActiveWebContents(), number_of_navigations,
content::MessageLoopRunner::QuitMode::DEFERRED,
/*ignore_uncommitted_navigations=*/false);
if (!blink::IsRendererDebugURL(url))
same_tab_observer.set_expected_initial_url(url);
std::set<Browser*> initial_browsers;
for (auto* initial_browser : *BrowserList::GetInstance())
initial_browsers.insert(initial_browser);
AllBrowserTabAddedWaiter tab_added_waiter;
WebContents* web_contents = browser->OpenURL(OpenURLParams(
url, Referrer(), disposition, ui::PAGE_TRANSITION_TYPED, false));
if (browser_test_flags & BROWSER_TEST_WAIT_FOR_BROWSER)
browser = WaitForBrowserNotInSet(initial_browsers);
if (browser_test_flags & BROWSER_TEST_WAIT_FOR_TAB)
tab_added_waiter.Wait();
if (!(browser_test_flags & BROWSER_TEST_WAIT_FOR_LOAD_STOP)) {
// Some other flag caused the wait prior to this.
return nullptr;
}
if (disposition == WindowOpenDisposition::NEW_BACKGROUND_TAB) {
EXPECT_TRUE(web_contents)
<< " Unable to wait for navigation to \"" << url.spec()
<< "\" because the new tab is not available yet";
if (!web_contents)
return nullptr;
} else if ((disposition == WindowOpenDisposition::CURRENT_TAB) ||
(disposition == WindowOpenDisposition::NEW_FOREGROUND_TAB) ||
(disposition == WindowOpenDisposition::SINGLETON_TAB)) {
// The tab we navigated should be the active one.
EXPECT_EQ(web_contents, browser->tab_strip_model()->GetActiveWebContents());
}
if (disposition == WindowOpenDisposition::CURRENT_TAB) {
same_tab_observer.Wait();
return web_contents->GetPrimaryMainFrame();
} else if (web_contents) {
content::TestNavigationObserver observer(
web_contents, number_of_navigations,
content::MessageLoopRunner::QuitMode::DEFERRED,
/*ignore_uncommitted_navigations=*/false);
if (!blink::IsRendererDebugURL(url))
observer.set_expected_initial_url(url);
observer.Wait();
return web_contents->GetPrimaryMainFrame();
}
EXPECT_TRUE(web_contents)
<< " Unable to wait for navigation to \"" << url.spec() << "\""
<< " because we can't get the tab contents";
return nullptr;
}
content::RenderFrameHost* NavigateToURLWithDisposition(
Browser* browser,
const GURL& url,
WindowOpenDisposition disposition,
int browser_test_flags) {
return NavigateToURLWithDispositionBlockUntilNavigationsComplete(
browser, url, 1, disposition, browser_test_flags);
}
content::RenderFrameHost* NavigateToURLBlockUntilNavigationsComplete(
Browser* browser,
const GURL& url,
int number_of_navigations) {
return NavigateToURLWithDispositionBlockUntilNavigationsComplete(
browser, url, number_of_navigations, WindowOpenDisposition::CURRENT_TAB,
BROWSER_TEST_WAIT_FOR_LOAD_STOP);
}
base::FilePath GetTestFilePath(const base::FilePath& dir,
const base::FilePath& file) {
base::ScopedAllowBlockingForTesting allow_blocking;
base::FilePath path;
base::PathService::Get(chrome::DIR_TEST_DATA, &path);
return path.Append(dir).Append(file);
}
GURL GetTestUrl(const base::FilePath& dir, const base::FilePath& file) {
return net::FilePathToFileURL(GetTestFilePath(dir, file));
}
bool GetRelativeBuildDirectory(base::FilePath* build_dir) {
base::ScopedAllowBlockingForTesting allow_blocking;
// This function is used to find the build directory so TestServer can serve
// built files (nexes, etc). TestServer expects a path relative to the source
// root.
base::FilePath exe_dir =
base::CommandLine::ForCurrentProcess()->GetProgram().DirName();
base::FilePath src_dir;
if (!base::PathService::Get(base::DIR_SOURCE_ROOT, &src_dir))
return false;
// We must first generate absolute paths to SRC and EXE and from there
// generate a relative path.
if (!exe_dir.IsAbsolute())
exe_dir = base::MakeAbsoluteFilePath(exe_dir);
if (!src_dir.IsAbsolute())
src_dir = base::MakeAbsoluteFilePath(src_dir);
if (!exe_dir.IsAbsolute())
return false;
if (!src_dir.IsAbsolute())
return false;
size_t match, exe_size, src_size;
// Determine point at which src and exe diverge.
auto exe_parts = exe_dir.GetComponents();
auto src_parts = src_dir.GetComponents();
exe_size = exe_parts.size();
src_size = src_parts.size();
for (match = 0; match < exe_size && match < src_size; ++match) {
if (exe_parts[match] != src_parts[match])
break;
}
// Create a relative path.
*build_dir = base::FilePath();
for (size_t tmp_itr = match; tmp_itr < src_size; ++tmp_itr)
*build_dir = build_dir->Append(FILE_PATH_LITERAL(".."));
for (; match < exe_size; ++match)
*build_dir = build_dir->Append(exe_parts[match]);
return true;
}
javascript_dialogs::AppModalDialogController* WaitForAppModalDialog() {
auto* dialog_queue = javascript_dialogs::AppModalDialogQueue::GetInstance();
if (dialog_queue->HasActiveDialog()) {
AppModalDialogWaiter::CheckForHangMonitorDisabling(
dialog_queue->active_dialog());
return dialog_queue->active_dialog();
}
AppModalDialogWaiter waiter;
return waiter.Wait();
}
#if defined(TOOLKIT_VIEWS)
void WaitForViewVisibility(Browser* browser, ViewID vid, bool visible) {
views::View* view = views::Widget::GetWidgetForNativeWindow(
browser->window()->GetNativeWindow())
->GetContentsView()
->GetViewByID(vid);
ASSERT_TRUE(view);
if (view->GetVisible() == visible)
return;
base::RunLoop run_loop;
auto subscription = view->AddVisibleChangedCallback(run_loop.QuitClosure());
run_loop.Run();
EXPECT_EQ(visible, view->GetVisible());
}
#endif
int FindInPage(WebContents* tab,
const std::u16string& search_string,
bool forward,
bool match_case,
int* ordinal,
gfx::Rect* selection_rect) {
find_in_page::FindTabHelper* find_tab_helper =
find_in_page::FindTabHelper::FromWebContents(tab);
find_tab_helper->StartFinding(search_string, forward, match_case,
true, /* find_match */
true /* run_synchronously_for_testing */);
FindResultWaiter observer(tab);
observer.Wait();
if (ordinal)
*ordinal = observer.active_match_ordinal();
if (selection_rect)
*selection_rect = observer.selection_rect();
return observer.number_of_matches();
}
void DownloadURL(Browser* browser, const GURL& download_url) {
content::DownloadManager* download_manager =
browser->profile()->GetDownloadManager();
std::unique_ptr<content::DownloadTestObserver> observer(
new content::DownloadTestObserverTerminal(
download_manager, 1,
content::DownloadTestObserver::ON_DANGEROUS_DOWNLOAD_ACCEPT));
ASSERT_TRUE(ui_test_utils::NavigateToURL(browser, download_url));
observer->WaitForFinished();
}
void WaitForAutocompleteDone(Browser* browser) {
auto* controller = browser->window()
->GetLocationBar()
->GetOmniboxView()
->model()
->autocomplete_controller();
while (!controller->done())
AutocompleteChangeObserver(browser->profile()).Wait();
}
void SendToOmniboxAndSubmit(Browser* browser,
const std::string& input,
base::TimeTicks match_selection_timestamp) {
LocationBar* location_bar = browser->window()->GetLocationBar();
OmniboxView* omnibox = location_bar->GetOmniboxView();
omnibox->model()->OnSetFocus(/*control_down=*/false);
omnibox->SetUserText(base::ASCIIToUTF16(input));
location_bar->AcceptInput(match_selection_timestamp);
WaitForAutocompleteDone(browser);
}
Browser* GetBrowserNotInSet(const std::set<Browser*>& excluded_browsers) {
for (auto* browser : *BrowserList::GetInstance()) {
if (excluded_browsers.find(browser) == excluded_browsers.end())
return browser;
}
return nullptr;
}
namespace {
void GetCookieCallback(base::RepeatingClosure callback,
net::CookieList* cookies,
const net::CookieAccessResultList& cookie_list,
const net::CookieAccessResultList& excluded_cookies) {
*cookies = net::cookie_util::StripAccessResults(cookie_list);
callback.Run();
}
} // namespace
void GetCookies(const GURL& url,
WebContents* contents,
int* value_size,
std::string* value) {
*value_size = -1;
if (url.is_valid() && contents) {
base::RunLoop loop;
auto* storage_partition =
contents->GetPrimaryMainFrame()->GetProcess()->GetStoragePartition();
net::CookieList cookie_list;
storage_partition->GetCookieManagerForBrowserProcess()->GetCookieList(
url, net::CookieOptions::MakeAllInclusive(),
net::CookiePartitionKeyCollection(),
base::BindOnce(GetCookieCallback, loop.QuitClosure(), &cookie_list));
loop.Run();
*value = net::CanonicalCookie::BuildCookieLine(cookie_list);
*value_size = static_cast<int>(value->size());
}
}
UrlLoadObserver::UrlLoadObserver(const GURL& url,
const content::NotificationSource& source)
: WindowedNotificationObserver(content::NOTIFICATION_LOAD_STOP, source),
url_(url) {
}
UrlLoadObserver::~UrlLoadObserver() {}
void UrlLoadObserver::Observe(
int type,
const content::NotificationSource& source,
const content::NotificationDetails& details) {
NavigationController* controller =
content::Source<NavigationController>(source).ptr();
NavigationEntry* entry = controller->GetVisibleEntry();
if (!entry || entry->GetVirtualURL() != url_)
return;
WindowedNotificationObserver::Observe(type, source, details);
}
HistoryEnumerator::HistoryEnumerator(Profile* profile) {
base::RunLoop run_loop;
base::CancelableTaskTracker tracker;
HistoryServiceFactory::GetForProfile(profile,
ServiceAccessType::EXPLICIT_ACCESS)
->QueryHistory(
std::u16string(), history::QueryOptions(),
base::BindLambdaForTesting([&](history::QueryResults results) {
for (const auto& item : results)
urls_.push_back(item.url());
run_loop.Quit();
}),
&tracker);
run_loop.Run();
}
HistoryEnumerator::~HistoryEnumerator() {}
// Wait for HistoryService to load.
class WaitHistoryLoadedObserver : public history::HistoryServiceObserver {
public:
explicit WaitHistoryLoadedObserver(content::MessageLoopRunner* runner);
~WaitHistoryLoadedObserver() override;
// history::HistoryServiceObserver:
void OnHistoryServiceLoaded(history::HistoryService* service) override;
private:
// weak
raw_ptr<content::MessageLoopRunner> runner_;
};
WaitHistoryLoadedObserver::WaitHistoryLoadedObserver(
content::MessageLoopRunner* runner)
: runner_(runner) {
}
WaitHistoryLoadedObserver::~WaitHistoryLoadedObserver() {
}
void WaitHistoryLoadedObserver::OnHistoryServiceLoaded(
history::HistoryService* service) {
runner_->Quit();
}
void WaitForHistoryToLoad(history::HistoryService* history_service) {
if (!history_service->BackendLoaded()) {
scoped_refptr<content::MessageLoopRunner> runner =
new content::MessageLoopRunner;
WaitHistoryLoadedObserver observer(runner.get());
base::ScopedObservation<history::HistoryService,
history::HistoryServiceObserver>
scoped_observer(&observer);
scoped_observer.Observe(history_service);
runner->Run();
}
}
Browser* WaitForBrowserToOpen() {
return BrowserChangeObserver(nullptr,
BrowserChangeObserver::ChangeType::kAdded)
.Wait();
}
void WaitForBrowserToClose(Browser* browser) {
BrowserChangeObserver(browser, BrowserChangeObserver::ChangeType::kRemoved)
.Wait();
}
TabAddedWaiter::TabAddedWaiter(Browser* browser) {
browser->tab_strip_model()->AddObserver(this);
}
void TabAddedWaiter::Wait() {
TRACE_EVENT0("test", "TabAddedWaiter::Wait");
run_loop_.Run();
}
void TabAddedWaiter::OnTabStripModelChanged(
TabStripModel* tab_strip_model,
const TabStripModelChange& change,
const TabStripSelectionChange& selection) {
if (change.type() == TabStripModelChange::kInserted)
run_loop_.Quit();
}
AllBrowserTabAddedWaiter::AllBrowserTabAddedWaiter() {
BrowserList::AddObserver(this);
for (const Browser* browser : *BrowserList::GetInstance())
browser->tab_strip_model()->AddObserver(this);
}
AllBrowserTabAddedWaiter::~AllBrowserTabAddedWaiter() {
BrowserList::RemoveObserver(this);
}
content::WebContents* AllBrowserTabAddedWaiter::Wait() {
run_loop_.Run();
return web_contents_;
}
void AllBrowserTabAddedWaiter::OnTabStripModelChanged(
TabStripModel* tab_strip_model,
const TabStripModelChange& change,
const TabStripSelectionChange& selection) {
if (web_contents_)
return;
if (change.type() != TabStripModelChange::kInserted)
return;
web_contents_ = change.GetInsert()->contents[0].contents;
run_loop_.Quit();
}
void AllBrowserTabAddedWaiter::OnBrowserAdded(Browser* browser) {
browser->tab_strip_model()->AddObserver(this);
}
BrowserChangeObserver::BrowserChangeObserver(Browser* browser, ChangeType type)
: browser_(browser), type_(type) {
BrowserList::AddObserver(this);
}
BrowserChangeObserver::~BrowserChangeObserver() {
BrowserList::RemoveObserver(this);
}
Browser* BrowserChangeObserver::Wait() {
run_loop_.Run();
return browser_;
}
void BrowserChangeObserver::OnBrowserAdded(Browser* browser) {
if (type_ == ChangeType::kAdded) {
browser_ = browser;
run_loop_.Quit();
}
}
void BrowserChangeObserver::OnBrowserRemoved(Browser* browser) {
if (browser_ && browser_ != browser)
return;
if (type_ == ChangeType::kRemoved) {
browser_ = browser;
run_loop_.Quit();
}
}
} // namespace ui_test_utils