src/chrome/test/base/testing_browser_process.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 // An implementation of BrowserProcess for unit tests that fails for most
   6 // services. By preventing creation of services, we reduce dependencies and
   7 // keep the profile clean. Clients of this class must handle the NULL return
   8 // value, however.
   9
  10 #ifndef CHROME_TEST_BASE_TESTING_BROWSER_PROCESS_H_
  11 #define CHROME_TEST_BASE_TESTING_BROWSER_PROCESS_H_
  12
  13 #include <string>
  14
  15 #include "base/memory/ref_counted.h"
  16 #include "base/memory/scoped_ptr.h"
  17 #include "build/build_config.h"
  18 #include "chrome/browser/browser_process.h"
  19 #include "chrome/browser/browser_process_platform_part.h"
  20
  21 class BackgroundModeManager;
  22 class CRLSetFetcher;
  23 class IOThread;
  24 class MHTMLGenerationManager;
  25 class NotificationUIManager;
  26 class PrefService;
  27 class WatchDogThread;
  28
  29 namespace content {
  30 class NotificationService;
  31 }
  32
  33 namespace extensions {
  34 class ExtensionsBrowserClient;
  35 }
  36
  37 namespace gcm {
  38 class GCMDriver;
  39 }
  40
  41 namespace policy {
  42 class BrowserPolicyConnector;
  43 class PolicyService;
  44 }
  45
  46 namespace prerender {
  47 class PrerenderTracker;
  48 }
  49
  50 class TestingBrowserProcess : public BrowserProcess {
  51  public:
  52   // Initializes |g_browser_process| with a new TestingBrowserProcess.
  53   static void CreateInstance();
  54
  55   // Cleanly destroys |g_browser_process|, which has special deletion semantics.
  56   static void DeleteInstance();
  57
  58   // Convenience method to get g_browser_process as a TestingBrowserProcess*.
  59   static TestingBrowserProcess* GetGlobal();
  60
  61   void ResourceDispatcherHostCreated() override;
  62   void EndSession() override;
  63   MetricsServicesManager* GetMetricsServicesManager() override;
  64   metrics::MetricsService* metrics_service() override;
  65   rappor::RapporService* rappor_service() override;
  66   IOThread* io_thread() override;
  67   WatchDogThread* watchdog_thread() override;
  68   ProfileManager* profile_manager() override;
  69   PrefService* local_state() override;
  70   chrome_variations::VariationsService* variations_service() override;
  71   policy::BrowserPolicyConnector* browser_policy_connector() override;
  72   policy::PolicyService* policy_service() override;
  73   IconManager* icon_manager() override;
  74   GLStringManager* gl_string_manager() override;
  75   GpuModeManager* gpu_mode_manager() override;
  76   BackgroundModeManager* background_mode_manager() override;
  77   void set_background_mode_manager_for_test(
  78       scoped_ptr<BackgroundModeManager> manager) override;
  79   StatusTray* status_tray() override;
  80   SafeBrowsingService* safe_browsing_service() override;
  81   safe_browsing::ClientSideDetectionService* safe_browsing_detection_service()
  82       override;
  83   net::URLRequestContextGetter* system_request_context() override;
  84   BrowserProcessPlatformPart* platform_part() override;
  85
  86   extensions::EventRouterForwarder* extension_event_router_forwarder() override;
  87   NotificationUIManager* notification_ui_manager() override;
  88   message_center::MessageCenter* message_center() override;
  89   IntranetRedirectDetector* intranet_redirect_detector() override;
  90   void CreateDevToolsHttpProtocolHandler(
  91       chrome::HostDesktopType host_desktop_type,
  92       const std::string& ip,
  93       int port) override;
  94   unsigned int AddRefModule() override;
  95   unsigned int ReleaseModule() override;
  96   bool IsShuttingDown() override;
  97   printing::PrintJobManager* print_job_manager() override;
  98   printing::PrintPreviewDialogController* print_preview_dialog_controller()
  99       override;
 100   printing::BackgroundPrintingManager* background_printing_manager() override;
 101   const std::string& GetApplicationLocale() override;
 102   void SetApplicationLocale(const std::string& app_locale) override;
 103   DownloadStatusUpdater* download_status_updater() override;
 104   DownloadRequestLimiter* download_request_limiter() override;
 105
 106 #if (defined(OS_WIN) || defined(OS_LINUX)) && !defined(OS_CHROMEOS)
 107   void StartAutoupdateTimer() override {}
 108 #endif
 109
 110   ChromeNetLog* net_log() override;
 111   prerender::PrerenderTracker* prerender_tracker() override;
 112   component_updater::ComponentUpdateService* component_updater() override;
 113   CRLSetFetcher* crl_set_fetcher() override;
 114   component_updater::PnaclComponentInstaller* pnacl_component_installer()
 115       override;
 116   MediaFileSystemRegistry* media_file_system_registry() override;
 117   bool created_local_state() const override;
 118
 119 #if defined(ENABLE_WEBRTC)
 120   WebRtcLogUploader* webrtc_log_uploader() override;
 121 #endif
 122
 123   network_time::NetworkTimeTracker* network_time_tracker() override;
 124
 125   gcm::GCMDriver* gcm_driver() override;
 126
 127   // Set the local state for tests. Consumer is responsible for cleaning it up
 128   // afterwards (using ScopedTestingLocalState, for example).
 129   void SetLocalState(PrefService* local_state);
 130   void SetProfileManager(ProfileManager* profile_manager);
 131   void SetIOThread(IOThread* io_thread);
 132   void SetBrowserPolicyConnector(policy::BrowserPolicyConnector* connector);
 133   void SetSafeBrowsingService(SafeBrowsingService* sb_service);
 134   void SetSystemRequestContext(net::URLRequestContextGetter* context_getter);
 135
 136  private:
 137   // See CreateInstance() and DestoryInstance() above.
 138   TestingBrowserProcess();
 139   ~TestingBrowserProcess() override;
 140
 141   scoped_ptr<content::NotificationService> notification_service_;
 142   unsigned int module_ref_count_;
 143   std::string app_locale_;
 144
 145   // TODO(ios): Add back members as more code is compiled.
 146 #if !defined(OS_IOS)
 147 #if defined(ENABLE_CONFIGURATION_POLICY)
 148   scoped_ptr<policy::BrowserPolicyConnector> browser_policy_connector_;
 149 #else
 150   scoped_ptr<policy::PolicyService> policy_service_;
 151 #endif
 152   scoped_ptr<ProfileManager> profile_manager_;
 153   scoped_ptr<NotificationUIManager> notification_ui_manager_;
 154
 155 #if defined(ENABLE_PRINTING)
 156   scoped_ptr<printing::PrintJobManager> print_job_manager_;
 157 #endif
 158
 159 #if defined(ENABLE_PRINT_PREVIEW)
 160   scoped_ptr<printing::BackgroundPrintingManager> background_printing_manager_;
 161   scoped_refptr<printing::PrintPreviewDialogController>
 162       print_preview_dialog_controller_;
 163 #endif
 164
 165   scoped_ptr<prerender::PrerenderTracker> prerender_tracker_;
 166   scoped_refptr<SafeBrowsingService> sb_service_;
 167 #endif  // !defined(OS_IOS)
 168
 169   scoped_ptr<network_time::NetworkTimeTracker> network_time_tracker_;
 170
 171   // The following objects are not owned by TestingBrowserProcess:
 172   PrefService* local_state_;
 173   IOThread* io_thread_;
 174   net::URLRequestContextGetter* system_request_context_;
 175
 176   scoped_ptr<BrowserProcessPlatformPart> platform_part_;
 177
 178 #if defined(ENABLE_EXTENSIONS)
 179   scoped_ptr<MediaFileSystemRegistry> media_file_system_registry_;
 180
 181   scoped_ptr<extensions::ExtensionsBrowserClient> extensions_browser_client_;
 182 #endif
 183
 184   DISALLOW_COPY_AND_ASSIGN(TestingBrowserProcess);
 185 };
 186
 187 // RAII (resource acquisition is initialization) for TestingBrowserProcess.
 188 // Allows you to initialize TestingBrowserProcess/NotificationService before
 189 // other member variables.
 190 //
 191 // This can be helpful if you are running a unit test inside the browser_tests
 192 // suite because browser_tests do not make a TestingBrowserProcess for you.
 193 //
 194 // class MyUnitTestRunningAsBrowserTest : public testing::Test {
 195 //  ...stuff...
 196 //  private:
 197 //   TestingBrowserProcessInitializer initializer_;
 198 //   LocalState local_state_;  // Needs a BrowserProcess to initialize.
 199 //   NotificationRegistrar registar_;  // Needs NotificationService.
 200 // };
 201 class TestingBrowserProcessInitializer {
 202  public:
 203   TestingBrowserProcessInitializer();
 204   ~TestingBrowserProcessInitializer();
 205
 206  private:
 207   DISALLOW_COPY_AND_ASSIGN(TestingBrowserProcessInitializer);
 208 };
 209
 210 #endif  // CHROME_TEST_BASE_TESTING_BROWSER_PROCESS_H_