blob: 2bd9f404fb41a3a6ddbb10a92f26ac39f400f7db [file] [log] [blame]
// Copyright (c) 2011 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.
#pragma once
#include "base/callback.h"
#include "base/compiler_specific.h"
#include "base/memory/scoped_ptr.h"
#include "content/public/browser/notification_observer.h"
#include "content/public/browser/notification_registrar.h"
class JsInjectionReadyObserver;
// For browser_tests, which run on the UI thread, run a second
// MessageLoop and quit when the navigation completes loading. For
// WebUI tests that need to inject javascript, construct with a
// JsInjectionReadyObserver and this class will call its
// OnJsInjectionReady() at the appropriate time.
class TestNavigationObserver : public content::NotificationObserver {
class RVHOSendJS;
// Create and register a new TestNavigationObserver against the
// |controller|. When |js_injection_ready_observer| is non-null, notify with
// OnEntryCommitted() after |number_of_navigations| navigations.
// Note: |js_injection_ready_observer| is owned by the caller and should be
// valid until this class is destroyed.
TestNavigationObserver(const content::NotificationSource& source,
JsInjectionReadyObserver* js_injection_ready_observer,
int number_of_navigations);
// Like above but waits for one navigation.
explicit TestNavigationObserver(const content::NotificationSource& source);
virtual ~TestNavigationObserver();
// Run |wait_loop_callback| until complete, then run |done_callback|.
void WaitForObservation(const base::Closure& wait_loop_callback,
const base::Closure& done_callback);
// Convenient version of the above that runs a nested message loop and waits.
void Wait();
// Note: |js_injection_ready_observer| is owned by the caller and should be
// valid until this class is destroyed. Subclasses using this constructor MUST
// call RegisterAsObserver when a NavigationController becomes available.
explicit TestNavigationObserver(
JsInjectionReadyObserver* js_injection_ready_observer,
int number_of_navigations);
// Register this TestNavigationObserver as an observer of the |source|.
void RegisterAsObserver(const content::NotificationSource& source);
// content::NotificationObserver:
virtual void Observe(int type, const content::NotificationSource& source,
const content::NotificationDetails& details) OVERRIDE;
content::NotificationRegistrar registrar_;
// If true the navigation has started.
bool navigation_started_;
// The number of navigations that have been completed.
int navigations_completed_;
// The number of navigations to wait for.
int number_of_navigations_;
// Observer to take some action when the page is ready for JavaScript
// injection.
JsInjectionReadyObserver* js_injection_ready_observer_;
// |done_| will get set when this object observes a TabStripModel event.
bool done_;
// |done_callback_| will be set while |running_| is true and will be called
// when navigation completes.
base::Closure done_callback_;
// |running_| will be true during WaitForObservation until |done_| is true.
bool running_;
// |rvho_send_js_| will hold a RenderViewHostObserver subclass to allow
// JavaScript injection at the appropriate time.
scoped_ptr<RVHOSendJS> rvho_send_js_;