blob: 4f8f37a390e5403496003d041dbc67e242dff71a [file] [log] [blame]
// Copyright 2019 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include <string>
#include "base/macros.h"
#include "base/test/test_timeouts.h"
#include "build/build_config.h"
#include "content/public/browser/content_browser_client.h"
#include "content/public/browser/lock_observer.h"
#include "content/public/browser/render_process_host.h"
#include "content/public/test/browser_test_utils.h"
#include "content/public/test/content_browser_test.h"
#include "content/public/test/content_browser_test_utils.h"
#include "content/public/test/content_mock_cert_verifier.h"
#include "content/shell/browser/shell.h"
#include "net/dns/mock_host_resolver.h"
#include "net/test/embedded_test_server/embedded_test_server.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest.h"
#if defined(OS_ANDROID)
#include "base/android/build_info.h"
#endif
namespace content {
namespace {
class TestBrowserClient : public ContentBrowserClient {
public:
explicit TestBrowserClient(LockObserver* lock_observer)
: lock_observer_(lock_observer) {}
~TestBrowserClient() override = default;
LockObserver* GetLockObserver() override { return lock_observer_; }
private:
LockObserver* const lock_observer_;
TestBrowserClient(const TestBrowserClient&) = delete;
TestBrowserClient& operator=(const TestBrowserClient&) = delete;
};
class MockObserver : public LockObserver {
public:
MockObserver() = default;
~MockObserver() = default;
// LockObserver:
MOCK_METHOD2(OnFrameStartsHoldingWebLocks,
void(int render_process_id, int render_frame_id));
MOCK_METHOD2(OnFrameStopsHoldingWebLocks,
void(int render_process_id, int render_frame_id));
};
void RunLoopWithTimeout() {
base::RunLoop run_loop;
base::ThreadTaskRunnerHandle::Get()->PostDelayedTask(
FROM_HERE, run_loop.QuitClosure(), TestTimeouts::tiny_timeout());
run_loop.Run();
}
} // namespace
class LockManagerBrowserTest : public ContentBrowserTest {
public:
LockManagerBrowserTest() = default;
~LockManagerBrowserTest() override = default;
void SetUpCommandLine(base::CommandLine* command_line) override {
ContentBrowserTest::SetUpCommandLine(command_line);
cert_verifier_.SetUpCommandLine(command_line);
}
void SetUpInProcessBrowserTestFixture() override {
ContentBrowserTest::SetUpInProcessBrowserTestFixture();
cert_verifier_.SetUpInProcessBrowserTestFixture();
}
void SetUpOnMainThread() override {
ContentBrowserTest::SetUpOnMainThread();
original_client_ = SetBrowserClientForTesting(&test_browser_client_);
host_resolver()->AddRule("*", "127.0.0.1");
cert_verifier_.mock_cert_verifier()->set_default_result(net::OK);
server_.ServeFilesFromSourceDirectory(GetTestDataFilePath());
ASSERT_TRUE(server_.Start());
ASSERT_TRUE(NavigateToURL(shell(), GetLocksURL("a.com")));
}
void TearDownInProcessBrowserTestFixture() override {
ContentBrowserTest::TearDownInProcessBrowserTestFixture();
cert_verifier_.TearDownInProcessBrowserTestFixture();
}
void TearDownOnMainThread() override {
ContentBrowserTest::TearDownOnMainThread();
if (original_client_)
SetBrowserClientForTesting(original_client_);
}
bool ShouldRunTest() const {
#if defined(OS_ANDROID)
// Don't run the test if we couldn't override BrowserClient. It happens only
// on Android Kitkat or older systems.
if (!original_client_)
return false;
// TODO(https://crbug.com/1011765): Navigation fails on Android Kit Kat.
if (base::android::BuildInfo::GetInstance()->sdk_int() <=
base::android::SDK_VERSION_KITKAT) {
return false;
}
#endif
return true;
}
GURL GetLocksURL(const std::string& hostname) const {
return server_.GetURL(hostname, "/locks/locks.html");
}
testing::StrictMock<MockObserver> mock_observer_;
private:
ContentMockCertVerifier cert_verifier_;
net::EmbeddedTestServer server_{net::EmbeddedTestServer::TYPE_HTTPS};
ContentBrowserClient* original_client_ = nullptr;
TestBrowserClient test_browser_client_{&mock_observer_};
LockManagerBrowserTest(const LockManagerBrowserTest&) = delete;
LockManagerBrowserTest& operator=(const LockManagerBrowserTest&) = delete;
};
// Verify that content::LockObserver is notified when a frame acquires a single
// locks.
IN_PROC_BROWSER_TEST_F(LockManagerBrowserTest, ObserverSingleLock) {
if (!ShouldRunTest())
return;
RenderFrameHost* rfh = shell()->web_contents()->GetMainFrame();
int frame_id = rfh->GetRoutingID();
int process_id = rfh->GetProcess()->GetID();
{
// Acquire a lock. Expect observer notification.
base::RunLoop run_loop;
EXPECT_CALL(mock_observer_,
OnFrameStartsHoldingWebLocks(process_id, frame_id))
.WillOnce([&](int, int) { run_loop.Quit(); });
EXPECT_TRUE(ExecJs(rfh, "AcquireLock('lock_a');"));
// Quit when OnFrameStartsHoldingWebLocks(process_id, frame_id) is invoked.
run_loop.Run();
}
{
// Release a lock. Expect observer notification.
base::RunLoop run_loop;
EXPECT_CALL(mock_observer_,
OnFrameStopsHoldingWebLocks(process_id, frame_id))
.WillOnce([&](int, int) { run_loop.Quit(); });
EXPECT_TRUE(ExecJs(rfh, "ReleaseLock('lock_a');"));
// Quit when OnFrameStopsHoldingWebLocks(process_id, frame_id) is invoked.
run_loop.Run();
}
}
// Verify that content::LockObserver is notified when a frame acquires multiple
// locks (notifications only when the number of held locks switches between zero
// and non-zero).
IN_PROC_BROWSER_TEST_F(LockManagerBrowserTest, ObserverTwoLocks) {
if (!ShouldRunTest())
return;
RenderFrameHost* rfh = shell()->web_contents()->GetMainFrame();
int frame_id = rfh->GetRoutingID();
int process_id = rfh->GetProcess()->GetID();
{
// Acquire a lock. Expect observer notification.
base::RunLoop run_loop;
EXPECT_CALL(mock_observer_,
OnFrameStartsHoldingWebLocks(process_id, frame_id))
.WillOnce([&](int, int) { run_loop.Quit(); });
EXPECT_TRUE(ExecJs(rfh, "AcquireLock('lock_a');"));
// Quit when OnFrameStartsHoldingWebLocks(process_id, frame_id) is invoked.
run_loop.Run();
}
// Acquire a second lock. Don't expect a notification.
EXPECT_TRUE(ExecJs(rfh, "AcquireLock('lock_b');"));
// Wait a short timeout to make sure that the observer is not notified.
RunLoopWithTimeout();
// Release a lock. Don't expect a notification.
EXPECT_TRUE(ExecJs(rfh, "ReleaseLock('lock_a');"));
// Wait a short timeout to make sure that the observer is not notified.
RunLoopWithTimeout();
{
// Release a lock. Expect observer notification, because number of held
// locks is now zero.
base::RunLoop run_loop;
EXPECT_CALL(mock_observer_,
OnFrameStopsHoldingWebLocks(process_id, frame_id))
.WillOnce([&](int, int) { run_loop.Quit(); });
EXPECT_TRUE(ExecJs(rfh, "ReleaseLock('lock_b');"));
// Quit when OnFrameStopsHoldingWebLocks(process_id, frame_id) is invoked.
run_loop.Run();
}
}
// Verify that content::LockObserver is notified that a frame stopped holding
// locks when it is navigated away.
IN_PROC_BROWSER_TEST_F(LockManagerBrowserTest, ObserverNavigate) {
if (!ShouldRunTest())
return;
RenderFrameHost* rfh = shell()->web_contents()->GetMainFrame();
int frame_id = rfh->GetRoutingID();
int process_id = rfh->GetProcess()->GetID();
{
// Acquire a lock. Expect observer notification.
base::RunLoop run_loop;
EXPECT_CALL(mock_observer_,
OnFrameStartsHoldingWebLocks(process_id, frame_id))
.WillOnce([&](int, int) { run_loop.Quit(); });
EXPECT_TRUE(ExecJs(rfh, "AcquireLock('lock_a');"));
// Quit when OnFrameStartsHoldingWebLocks(process_id, frame_id) is invoked.
run_loop.Run();
}
{
// Navigate away. Expect observer notification.
base::RunLoop run_loop;
EXPECT_CALL(mock_observer_,
OnFrameStopsHoldingWebLocks(process_id, frame_id))
.WillOnce([&](int, int) { run_loop.Quit(); });
EXPECT_TRUE(NavigateToURL(shell(), GetLocksURL("b.com")));
// Quit when OnFrameStopsHoldingWebLocks(process_id, frame_id) is invoked.
run_loop.Run();
}
}
// Verify that content::LockObserver is notified when a frame steals a lock from
// another frame.
IN_PROC_BROWSER_TEST_F(LockManagerBrowserTest, ObserverStealLock) {
if (!ShouldRunTest())
return;
RenderFrameHost* rfh = shell()->web_contents()->GetMainFrame();
int frame_id = rfh->GetRoutingID();
int process_id = rfh->GetProcess()->GetID();
{
// Acquire a lock in first WebContents lock. Expect observer notification.
base::RunLoop run_loop;
EXPECT_CALL(mock_observer_,
OnFrameStartsHoldingWebLocks(process_id, frame_id))
.WillOnce([&](int, int) { run_loop.Quit(); });
EXPECT_TRUE(ExecJs(rfh, "AcquireLock('lock_a');"));
// Quit when OnFrameStartsHoldingWebLocks(process_id, frame_id) is invoked.
run_loop.Run();
}
// Open another WebContents and navigate.
Shell* other_shell =
Shell::CreateNewWindow(shell()->web_contents()->GetBrowserContext(),
GURL(), nullptr, gfx::Size());
EXPECT_TRUE(NavigateToURL(other_shell, GetLocksURL("a.com")));
RenderFrameHost* other_rfh = other_shell->web_contents()->GetMainFrame();
int other_frame_id = other_rfh->GetRoutingID();
int other_process_id = other_rfh->GetProcess()->GetID();
{
// Steal the lock from other WebContents. Expect observer notifications.
base::RunLoop run_loop;
EXPECT_CALL(mock_observer_,
OnFrameStopsHoldingWebLocks(process_id, frame_id))
.WillOnce([&](int, int) {
EXPECT_CALL(mock_observer_, OnFrameStartsHoldingWebLocks(
other_process_id, other_frame_id))
.WillOnce([&](int, int) { run_loop.Quit(); });
});
EXPECT_TRUE(ExecJs(other_rfh, "StealLock('lock_a');"));
// Quit when OnFrameStopsHoldingWebLocks(process_id, frame_id) and
// OnFrameStartsHoldingWebLocks(other_process_id, other_frame_id) are
// invoked.
run_loop.Run();
}
}
// Verify that content::LockObserver is *not* notified when a lock is acquired
// by a dedicated worker.
IN_PROC_BROWSER_TEST_F(LockManagerBrowserTest, ObserverDedicatedWorker) {
if (!ShouldRunTest())
return;
RenderFrameHost* rfh = shell()->web_contents()->GetMainFrame();
// Use EvalJs() instead of ExecJs() to ensure that this doesn't return before
// the lock is acquired and released by the worker.
EXPECT_TRUE(EvalJs(rfh, R"(
(async () => {
await AcquireReleaseLockFromDedicatedWorker();
return true;
}) ();
)")
.ExtractBool());
// Wait a short timeout to make sure that the observer is not notified.
RunLoopWithTimeout();
}
// SharedWorkers are not enabled on Android. https://crbug.com/154571
#if !defined(OS_ANDROID)
// Verify that content::LockObserver is *not* notified when a lock is acquired
// by a shared worker.
IN_PROC_BROWSER_TEST_F(LockManagerBrowserTest, ObserverSharedWorker) {
if (!ShouldRunTest())
return;
RenderFrameHost* rfh = shell()->web_contents()->GetMainFrame();
// Use EvalJs() instead of ExecJs() to ensure that this doesn't return before
// the lock is acquired and released by the worker.
EXPECT_TRUE(EvalJs(rfh, R"(
(async () => {
await AcquireReleaseLockFromSharedWorker();
return true;
}) ();
)")
.ExtractBool());
// Wait a short timeout to make sure that the observer is not notified.
RunLoopWithTimeout();
}
#endif // !defined(OS_ANDROID)
// Verify that content::LockObserver is *not* notified when a lock is acquired
// by a service worker.
IN_PROC_BROWSER_TEST_F(LockManagerBrowserTest, ObserverServiceWorker) {
if (!ShouldRunTest())
return;
RenderFrameHost* rfh = shell()->web_contents()->GetMainFrame();
// Use EvalJs() instead of ExecJs() to ensure that this doesn't return before
// the lock is acquired and released by the worker.
EXPECT_TRUE(EvalJs(rfh, R"(
(async () => {
await AcquireReleaseLockFromServiceWorker();
return true;
}) ();
)")
.ExtractBool());
// Wait a short timeout to make sure that the observer is not notified.
RunLoopWithTimeout();
}
} // namespace content