blob: 1d60a1b0716e34b0f482d00208d71b9032ba827b [file] [log] [blame]
// Copyright 2017 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 <map>
#include <memory>
#include <string>
#include <type_traits>
#include "base/macros.h"
#include "base/observer_list.h"
#include "extensions/browser/event_router.h"
#include "extensions/browser/event_router_factory.h"
#include "extensions/common/extension_id.h"
namespace extensions {
// An EventRouter that tests can use to observe, await, or verify events
// dispatched to an extension.
class TestEventRouter : public EventRouter {
// Allows observing events dispatched to the event router.
class EventObserver {
// These functions correspond to the ones in EventRouter.
virtual void OnBroadcastEvent(const Event& event);
virtual void OnDispatchEventToExtension(const std::string& extension_id,
const Event& event);
virtual ~EventObserver();
explicit TestEventRouter(content::BrowserContext* context);
~TestEventRouter() override;
// Returns the number of times an event has been broadcast or dispatched.
int GetEventCount(std::string event_name) const;
void AddEventObserver(EventObserver* obs);
void RemoveEventObserver(EventObserver* obs);
// Sets the extension ID all dispatched events will be expected to be sent to.
void set_expected_extension_id(const ExtensionId& extension_id) {
expected_extension_id_ = extension_id;
// EventRouter:
void BroadcastEvent(std::unique_ptr<Event> event) override;
void DispatchEventToExtension(const std::string& extension_id,
std::unique_ptr<Event> event) override;
// Increments the count of dispatched events seen with the given name.
void IncrementEventCount(const std::string& event_name);
ExtensionId expected_extension_id_;
// Count of dispatched and broadcasted events by event name.
std::map<std::string, int> seen_events_;
base::ObserverList<EventObserver, false>::Unchecked observers_;
// Creates and enables a TestEventRouter for testing. Callers can override T to
// provide a derived event router.
template <typename T = TestEventRouter>
T* CreateAndUseTestEventRouter(content::BrowserContext* context) {
// The factory function only requires that T be a KeyedService. Ensure it is
// actually derived from EventRouter to avoid undefined behavior.
static_assert(std::is_base_of<EventRouter, T>(),
"T must be derived from EventRouter");
return static_cast<T*>(
context, base::BindRepeating([](content::BrowserContext* context) {
return static_cast<std::unique_ptr<KeyedService>>(
} // namespace extensions