blob: 2e414abfa1d9b53bc74772039f7860085c69365a [file] [log] [blame]
// Copyright (c) 2012 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 "content/public/browser/site_instance.h"
#include "ui/base/page_transition_types.h"
class GURL;
namespace content {
class BrowserContext;
class NavigationData;
class NavigationHandle;
class RenderFrameHost;
class RenderViewHost;
class WebContents;
struct Referrer;
// This interface allows embedders of content/ to write tests that depend on a
// test version of WebContents. This interface can be retrieved from any
// WebContents that was retrieved via a call to
// RenderViewHostTestHarness::GetWebContents() (directly or indirectly) or
// constructed explicitly via CreateTestWebContents.
// Tests within content/ can directly static_cast WebContents objects retrieved
// or created as described above to TestWebContents.
// Design note: We considered two alternatives to this separate test interface
// approach:
// a) Define a TestWebContents interface that inherits from WebContents, and
// have the concrete TestWebContents inherit from it as well as from
// WebContentsImpl. This approach was discarded as it introduces a diamond
// inheritance pattern, which means we wouldn't be e.g. able to downcast from
// WebContents to WebContentsImpl using static_cast.
// b) Define a TestWebContents interface that inherits from WebContents, and
// have the concrete TestWebContents implement it, using composition of a
// WebContentsImpl to implement most methods. This approach was discarded as
// there is a fundamental assumption in content/ that a WebContents* can be
// downcast to a WebContentsImpl*, and this wouldn't be true for TestWebContents
// objects.
class WebContentsTester {
// Retrieves a WebContentsTester to drive tests of the specified WebContents.
// As noted above you need to be sure the 'contents' object supports testing,
// i.e. is either created using one of the Create... functions below, or is
// retrieved via RenderViewHostTestHarness::GetWebContents().
static WebContentsTester* For(WebContents* contents);
// Creates a WebContents enabled for testing.
static WebContents* CreateTestWebContents(
BrowserContext* browser_context,
scoped_refptr<SiteInstance> instance);
// Simulates the appropriate RenderView (pending if any, current otherwise)
// sending a navigate notification for the NavigationController pending entry.
virtual void CommitPendingNavigation() = 0;
// Gets the pending RenderFrameHost, if any, for the main frame. For the
// current RenderFrameHost of the main frame, use WebContents::GetMainFrame().
// PlzNavigate: When browser side navigation is enabled it returns the
// speculative RenderFrameHost for the main frame if one exists.
virtual RenderFrameHost* GetPendingMainFrame() const = 0;
// Creates a pending navigation to |url|. Also simulates the
// DidStartProvisionalLoad received from the renderer. To commit the
// navigation, callers should use
// RenderFrameHostTester::SimulateNavigationCommit. Callers can then use
// RenderFrameHostTester::SimulateNavigationStop to simulate the navigation
// stop.
// Note that this function is meant for callers that want to control the
// timing of navigation events precisely. Other callers should use
// NavigateAndCommit.
// PlzNavigate: this does not simulate the DidStartProvisionalLoad from the
// renderer, as it only should be received after the navigation is ready to
// commit.
virtual void StartNavigation(const GURL& url) = 0;
// Creates a pending navigation to the given URL with the default parameters
// and then commits the load with a page ID one larger than any seen. This
// emulates what happens on a new navigation.
virtual void NavigateAndCommit(const GURL& url) = 0;
// Sets the loading state to the given value.
virtual void TestSetIsLoading(bool value) = 0;
// Simulates the current RVH notifying that it has unloaded so that the
// pending RVH navigation can proceed.
// Does nothing if no cross-navigation is pending.
virtual void ProceedWithCrossSiteNavigation() = 0;
// Simulates a navigation with the given information.
// Guidance for calling these:
// - nav_entry_id should be 0 if simulating a renderer-initiated navigation;
// if simulating a browser-initiated one, pass the GetUniqueID() value of
// the NavigationController's PendingEntry.
// - did_create_new_entry should be true if simulating a navigation that
// created a new navigation entry; false for history navigations, reloads,
// and other navigations that don't affect the history list.
virtual void TestDidNavigate(RenderFrameHost* render_frame_host,
int page_id,
int nav_entry_id,
bool did_create_new_entry,
const GURL& url,
ui::PageTransition transition) = 0;
virtual void TestDidNavigateWithReferrer(RenderFrameHost* render_frame_host,
int page_id,
int nav_entry_id,
bool did_create_new_entry,
const GURL& url,
const Referrer& referrer,
ui::PageTransition transition) = 0;
// Sets NavgationData on |navigation_handle|.
virtual void SetNavigationData(
NavigationHandle* navigation_handle,
std::unique_ptr<NavigationData> navigation_data) = 0;
// Returns headers that were passed in the previous SaveFrameWithHeaders(...)
// call.
virtual const std::string& GetSaveFrameHeaders() = 0;
} // namespace content