Geolocation: extract ContentBrowserClient methods specific to Geolocation into a class

content/browser/geolocation/location_arbitrator_impl_unittest.cc

 // 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 "content/browser/geolocation/location_arbitrator_impl.h"
 
 #include <memory>
 
 #include "base/bind.h"
 #include "base/memory/ptr_util.h"
@@ skipping 48 matching lines @@
   ASSERT_TRUE(position.Validate());
   provider->HandlePositionChanged(position);
 }
 
 void SetReferencePosition(MockLocationProvider* provider) {
   SetPositionFix(provider, 51.0, -0.1, 400);
 }
 
 namespace {
 
-class GeolocationContentBrowserClient : public TestContentBrowserClient {
+class FakeDelegate : public GeolocationProvider::Delegate {
  public:
-  GeolocationContentBrowserClient() {}
+  FakeDelegate() = default;
 
+  bool UseNetworkLocationProviders() override { return use_network_; }
   void set_use_network(bool use_network) { use_network_ = use_network; }
 
   LocationProvider* OverrideSystemLocationProvider() override {
-    provider_ = new MockLocationProvider;
-    return provider_;
+    if (!location_provider_)
+      location_provider_ = base::WrapUnique(new MockLocationProvider);
+    return location_provider_.get();
   }
-
-  bool UseNetworkLocationProviders() override { return use_network_; }
-
-  // This provider does not own the object. It is returned by
-  // GeolocationLocationAribtratorTest::GetSystemLocationProviderOverride().
-  // The caller takes ownership. This is just a reference we can use for
-  // mocking purposes.
-  MockLocationProvider* provider_ = nullptr;
+  LocationProvider* location_provider() const {

[Michael van Ouwerkerk, 2016/06/28 11:17:07]

nit: blank line above this one

[mcasas, 2016/06/28 16:51:25]

Done.

+    return location_provider_.get();
+  }
 
  private:
   bool use_network_ = true;
+  std::unique_ptr<LocationProvider> location_provider_;

[Michael van Ouwerkerk, 2016/06/28 11:17:08]

nit: consider renaming to system_location_provider_ for clarity.

[mcasas, 2016/06/28 16:51:25]

Done.

 
-  DISALLOW_COPY_AND_ASSIGN(GeolocationContentBrowserClient);
+  DISALLOW_COPY_AND_ASSIGN(FakeDelegate);
 };
 
 class TestingLocationArbitrator : public LocationArbitratorImpl {
  public:
   TestingLocationArbitrator(
       const LocationArbitratorImpl::LocationUpdateCallback& callback,
-      AccessTokenStore* access_token_store)
-      : LocationArbitratorImpl(callback),
+      AccessTokenStore* access_token_store,
+      GeolocationProvider::Delegate* delegate,
+      bool is_fake_delegate)
+      : LocationArbitratorImpl(callback, delegate),
+        is_fake_delegate_(is_fake_delegate),
         cell_(nullptr),
         gps_(nullptr),
         access_token_store_(access_token_store) {}
 
   base::Time GetTimeNow() const override { return GetTimeNowForTest(); }
 
   AccessTokenStore* NewAccessTokenStore() override {
     return access_token_store_.get();
   }
 
   std::unique_ptr<LocationProvider> NewNetworkLocationProvider(
       AccessTokenStore* access_token_store,
       net::URLRequestContextGetter* context,
       const GURL& url,
       const base::string16& access_token) override {
     cell_ = new MockLocationProvider;
     return base::WrapUnique(cell_);
   }
 
   std::unique_ptr<LocationProvider> NewSystemLocationProvider() override {
     gps_ = new MockLocationProvider;
     return base::WrapUnique(gps_);
   }
 
+  FakeDelegate* GetFakeDelegate() {
+    DCHECK(is_fake_delegate_);
+    return static_cast<FakeDelegate*>(GetDelegateForTesting());
+  }
+
+  LocationProvider* GetLocationProvider() {
+    if (is_fake_delegate_)
+      return GetFakeDelegate()->location_provider();
+    return GetDelegateForTesting()->OverrideSystemLocationProvider();
+  }
+
+  const bool is_fake_delegate_;

[Michael van Ouwerkerk, 2016/06/28 11:17:07]

nit: blank line below this one

[mcasas, 2016/06/28 16:51:25]

Done.

   // Two location providers, with nice short names to make the tests more
   // readable. Note |gps_| will only be set when there is a high accuracy
   // observer registered (and |cell_| when there's at least one observer of any
   // type).
 
   // TODO(mvanouwerkerk): rename |cell_| to |network_location_provider_| and
   // |gps_| to |system_location_provider_|
   MockLocationProvider* cell_;
   MockLocationProvider* gps_;
   scoped_refptr<AccessTokenStore> access_token_store_;
 };
 
 }  // namespace
 
 class GeolocationLocationArbitratorTest : public testing::Test {
  protected:
   // testing::Test
   void SetUp() override {
     access_token_store_ = new NiceMock<FakeAccessTokenStore>;
     observer_.reset(new MockLocationObserver);
-    LocationArbitratorImpl::LocationUpdateCallback callback =
+  }
+
+  // There are two types of test cases: those using FakeDelegate and the ones
+  // exercising whatever the embedder provides. Test cases call this method to
+  // choose the appropriate one.
+  void InitializeArbitrator(bool use_fake_delegate) {
+    delegate_.reset(use_fake_delegate ? new FakeDelegate()
+                                      : new GeolocationProvider::Delegate);
+    const LocationArbitratorImpl::LocationUpdateCallback callback =
         base::Bind(&MockLocationObserver::OnLocationUpdate,
                    base::Unretained(observer_.get()));
-    arbitrator_.reset(new TestingLocationArbitrator(
-        callback, access_token_store_.get()));
-    override_content_browser_client_.reset(new GeolocationContentBrowserClient);
+    arbitrator_.reset(
+        new TestingLocationArbitrator(callback, access_token_store_.get(),
+                                      delegate_.get(), use_fake_delegate));
   }
 
   // testing::Test
   void TearDown() override {}
 
   void CheckLastPositionInfo(double latitude,
                              double longitude,
                              double accuracy) {
     Geoposition geoposition = observer_->last_position_;
     EXPECT_TRUE(geoposition.Validate());
@@ skipping 10 matching lines @@
 
   MockLocationProvider* cell() {
     return arbitrator_->cell_;
   }
 
   MockLocationProvider* gps() {
     return arbitrator_->gps_;
   }
 
   MockLocationProvider* GetSystemLocationProviderOverride() {
-    return override_content_browser_client_->provider_;
+    return static_cast<MockLocationProvider*>(
+        arbitrator_->GetLocationProvider());
   }
 
   scoped_refptr<FakeAccessTokenStore> access_token_store_;
   std::unique_ptr<MockLocationObserver> observer_;
   std::unique_ptr<TestingLocationArbitrator> arbitrator_;
+  std::unique_ptr<GeolocationProvider::Delegate> delegate_;
   base::MessageLoop loop_;
-  std::unique_ptr<GeolocationContentBrowserClient>
-      override_content_browser_client_;
 };
 
 TEST_F(GeolocationLocationArbitratorTest, CreateDestroy) {
   EXPECT_TRUE(access_token_store_.get());
+  InitializeArbitrator(true /* use_fake_delegate */);
   EXPECT_TRUE(arbitrator_);
   arbitrator_.reset();
   SUCCEED();
 }
 
 TEST_F(GeolocationLocationArbitratorTest, OnPermissionGranted) {
+  InitializeArbitrator(false /* use_fake_delegate */);
   EXPECT_FALSE(arbitrator_->HasPermissionBeenGranted());
   arbitrator_->OnPermissionGranted();
   EXPECT_TRUE(arbitrator_->HasPermissionBeenGranted());
   // Can't check the provider has been notified without going through the
   // motions to create the provider (see next test).
   EXPECT_FALSE(cell());
   EXPECT_FALSE(gps());
   EXPECT_FALSE(GetSystemLocationProviderOverride());
 }
 
 TEST_F(GeolocationLocationArbitratorTest, NormalUsage) {
+  InitializeArbitrator(false /* use_fake_delegate */);
   ASSERT_TRUE(access_token_store_.get());
   ASSERT_TRUE(arbitrator_);
 
   EXPECT_FALSE(cell());
   EXPECT_FALSE(gps());
   EXPECT_FALSE(GetSystemLocationProviderOverride());
   arbitrator_->StartProviders(false);
 
   EXPECT_TRUE(access_token_store_->access_token_map_.empty());
 
@@ skipping 16 matching lines @@
             observer_->last_position_.latitude);
 
   EXPECT_FALSE(cell()->is_permission_granted_);
   EXPECT_FALSE(arbitrator_->HasPermissionBeenGranted());
   arbitrator_->OnPermissionGranted();
   EXPECT_TRUE(arbitrator_->HasPermissionBeenGranted());
   EXPECT_TRUE(cell()->is_permission_granted_);
 }
 
 TEST_F(GeolocationLocationArbitratorTest, CustomSystemProviderOnly) {
-  override_content_browser_client_->set_use_network(false);
-  SetBrowserClientForTesting(override_content_browser_client_.get());
+  InitializeArbitrator(true /* use_fake_delegate */);
+  arbitrator_->GetFakeDelegate()->set_use_network(false);
   ASSERT_TRUE(arbitrator_);
 
   EXPECT_FALSE(cell());
   EXPECT_FALSE(gps());
-  EXPECT_FALSE(GetSystemLocationProviderOverride());
   arbitrator_->StartProviders(false);
 
   ASSERT_FALSE(cell());
   EXPECT_FALSE(gps());
-  EXPECT_TRUE(GetSystemLocationProviderOverride());
+  ASSERT_TRUE(GetSystemLocationProviderOverride());
   EXPECT_EQ(MockLocationProvider::LOW_ACCURACY,
             GetSystemLocationProviderOverride()->state_);
   EXPECT_FALSE(observer_->last_position_.Validate());
   EXPECT_EQ(Geoposition::ERROR_CODE_NONE, observer_->last_position_.error_code);
 
   SetReferencePosition(GetSystemLocationProviderOverride());
 
   EXPECT_TRUE(observer_->last_position_.Validate() ||
               observer_->last_position_.error_code !=
                   Geoposition::ERROR_CODE_NONE);
   EXPECT_EQ(GetSystemLocationProviderOverride()->position_.latitude,
             observer_->last_position_.latitude);
 
   EXPECT_FALSE(GetSystemLocationProviderOverride()->is_permission_granted_);
   EXPECT_FALSE(arbitrator_->HasPermissionBeenGranted());
   arbitrator_->OnPermissionGranted();
   EXPECT_TRUE(arbitrator_->HasPermissionBeenGranted());
   EXPECT_TRUE(GetSystemLocationProviderOverride()->is_permission_granted_);
 }
 
 TEST_F(GeolocationLocationArbitratorTest,
        CustomSystemAndDefaultNetworkProviders) {
-  override_content_browser_client_->set_use_network(true);
-  content::SetBrowserClientForTesting(override_content_browser_client_.get());
+  InitializeArbitrator(true /* use_fake_delegate */);
+  arbitrator_->GetFakeDelegate()->set_use_network(true);
   ASSERT_TRUE(arbitrator_);
 
   EXPECT_FALSE(cell());
   EXPECT_FALSE(gps());
-  EXPECT_FALSE(GetSystemLocationProviderOverride());
   arbitrator_->StartProviders(false);
 
   EXPECT_TRUE(access_token_store_->access_token_map_.empty());
 
   access_token_store_->NotifyDelegateTokensLoaded();
 
   ASSERT_TRUE(cell());
   EXPECT_FALSE(gps());
-  EXPECT_TRUE(GetSystemLocationProviderOverride());
+  ASSERT_TRUE(GetSystemLocationProviderOverride());
   EXPECT_EQ(MockLocationProvider::LOW_ACCURACY,
             GetSystemLocationProviderOverride()->state_);
   EXPECT_EQ(MockLocationProvider::LOW_ACCURACY, cell()->state_);
   EXPECT_FALSE(observer_->last_position_.Validate());
   EXPECT_EQ(Geoposition::ERROR_CODE_NONE, observer_->last_position_.error_code);
 
   SetReferencePosition(cell());
 
   EXPECT_TRUE(observer_->last_position_.Validate() ||
               observer_->last_position_.error_code !=
                   Geoposition::ERROR_CODE_NONE);
   EXPECT_EQ(cell()->position_.latitude, observer_->last_position_.latitude);
 
   EXPECT_FALSE(cell()->is_permission_granted_);
   EXPECT_FALSE(arbitrator_->HasPermissionBeenGranted());
   arbitrator_->OnPermissionGranted();
   EXPECT_TRUE(arbitrator_->HasPermissionBeenGranted());
   EXPECT_TRUE(cell()->is_permission_granted_);
 }
 
 TEST_F(GeolocationLocationArbitratorTest, SetObserverOptions) {
+  InitializeArbitrator(false /* use_fake_delegate */);
   arbitrator_->StartProviders(false);
   access_token_store_->NotifyDelegateTokensLoaded();
   ASSERT_TRUE(cell());
   ASSERT_TRUE(gps());
   EXPECT_FALSE(GetSystemLocationProviderOverride());
   EXPECT_EQ(MockLocationProvider::LOW_ACCURACY, cell()->state_);
   EXPECT_EQ(MockLocationProvider::LOW_ACCURACY, gps()->state_);
   SetReferencePosition(cell());
   EXPECT_EQ(MockLocationProvider::LOW_ACCURACY, cell()->state_);
   EXPECT_EQ(MockLocationProvider::LOW_ACCURACY, gps()->state_);
   arbitrator_->StartProviders(true);
   EXPECT_EQ(MockLocationProvider::HIGH_ACCURACY, cell()->state_);
   EXPECT_EQ(MockLocationProvider::HIGH_ACCURACY, gps()->state_);
   EXPECT_FALSE(GetSystemLocationProviderOverride());
 }
 
 TEST_F(GeolocationLocationArbitratorTest, Arbitration) {
+  InitializeArbitrator(false /* use_fake_delegate */);
   arbitrator_->StartProviders(false);
   access_token_store_->NotifyDelegateTokensLoaded();
   ASSERT_TRUE(cell());
   ASSERT_TRUE(gps());
   EXPECT_FALSE(GetSystemLocationProviderOverride());
 
   SetPositionFix(cell(), 1, 2, 150);
 
   // First position available
   EXPECT_TRUE(observer_->last_position_.Validate());
@@ skipping 57 matching lines @@
   CheckLastPositionInfo(3.5657104, 139.690341, 300);
 
   // 2 minutes later
   AdvanceTimeNow(base::TimeDelta::FromMinutes(2));
   // Arrive in station. Cell moves but GPS is stale. Switch to fresher cell.
   SetPositionFix(cell(), 3.5658700, 139.069979, 1000);
   CheckLastPositionInfo(3.5658700, 139.069979, 1000);
 }
 
 TEST_F(GeolocationLocationArbitratorTest, TwoOneShotsIsNewPositionBetter) {
+  InitializeArbitrator(false /* use_fake_delegate */);
   arbitrator_->StartProviders(false);
   access_token_store_->NotifyDelegateTokensLoaded();
   ASSERT_TRUE(cell());
   ASSERT_TRUE(gps());
   EXPECT_FALSE(GetSystemLocationProviderOverride());
 
   // Set the initial position.
   SetPositionFix(cell(), 3, 139, 100);
   CheckLastPositionInfo(3, 139, 100);
 
@@ skipping 10 matching lines @@
 
   // Advance the time a short while to simulate successive calls.
   AdvanceTimeNow(base::TimeDelta::FromMilliseconds(5));
 
   // Update with a less accurate position to verify 240956.
   SetPositionFix(cell(), 3, 139, 150);
   CheckLastPositionInfo(3, 139, 150);
 }
 
 }  // namespace content