device/geolocation/location_arbitrator_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 "device/geolocation/location_arbitrator.h"

#include <memory>
#include <utility>

#include "base/bind.h"
#include "base/memory/ptr_util.h"
#include "base/test/scoped_task_environment.h"
#include "device/geolocation/fake_location_provider.h"
#include "device/geolocation/public/cpp/geoposition.h"
#include "device/geolocation/public/cpp/location_provider.h"
#include "net/url_request/url_request_test_util.h"
#include "services/device/public/interfaces/geoposition.mojom.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest.h"

using ::testing::NiceMock;

namespace device {
namespace {

std::unique_ptr<LocationProvider> GetCustomLocationProviderForTest(
    std::unique_ptr<LocationProvider> provider) {
  return provider;
}

class MockLocationObserver {
 public:
  virtual ~MockLocationObserver() = default;
  void InvalidateLastPosition() {
    last_position_.latitude = 100;
    last_position_.error_code = mojom::Geoposition::ErrorCode::NONE;
    ASSERT_FALSE(ValidateGeoposition(last_position_));
  }
  void OnLocationUpdate(const LocationProvider* provider,
                        const mojom::Geoposition& position) {
    last_position_ = position;
  }

  mojom::Geoposition last_position() { return last_position_; }

 private:
  mojom::Geoposition last_position_;
};

double g_fake_time_now_secs = 1;

base::Time GetTimeNowForTest() {
  return base::Time::FromDoubleT(g_fake_time_now_secs);
}

void AdvanceTimeNow(const base::TimeDelta& delta) {
  g_fake_time_now_secs += delta.InSecondsF();
}

void SetPositionFix(FakeLocationProvider* provider,
                    double latitude,
                    double longitude,
                    double accuracy) {
  mojom::Geoposition position;
  position.error_code = mojom::Geoposition::ErrorCode::NONE;
  position.latitude = latitude;
  position.longitude = longitude;
  position.accuracy = accuracy;
  position.timestamp = GetTimeNowForTest();
  ASSERT_TRUE(ValidateGeoposition(position));
  provider->HandlePositionChanged(position);
}

// TODO(lethalantidote): Populate a Geoposition in the class from kConstants
// and then just copy that with "=" versus using a helper function.
void SetReferencePosition(FakeLocationProvider* provider) {
  SetPositionFix(provider, 51.0, -0.1, 400);
}

}  // namespace

// Simple request context producer that immediately produces a nullptr
// URLRequestContextGetter, indicating that network geolocation should not be
// used.
void NullRequestContextProducer(
    base::OnceCallback<void(scoped_refptr<net::URLRequestContextGetter>)>
        response_callback) {
  std::move(response_callback)
      .Run(scoped_refptr<net::URLRequestContextGetter>(nullptr));
}

// Simple request context producer that immediately produces a
// TestURLRequestContextGetter.
void TestRequestContextProducer(
    const scoped_refptr<base::SingleThreadTaskRunner>& network_task_runner,
    base::OnceCallback<void(scoped_refptr<net::URLRequestContextGetter>)>
        response_callback) {
  std::move(response_callback)
      .Run(base::MakeRefCounted<net::TestURLRequestContextGetter>(
          network_task_runner));
}

class TestingLocationArbitrator : public LocationArbitrator {
 public:
  TestingLocationArbitrator(
      const LocationProviderUpdateCallback& callback,
      const CustomLocationProviderCallback& provider_getter,
      GeolocationProvider::RequestContextProducer request_context_producer)
      : LocationArbitrator(provider_getter,
                           request_context_producer,
                           std::string() /* api_key */),
        cell_(nullptr),
        gps_(nullptr) {
    SetUpdateCallback(callback);
  }

  base::Time GetTimeNow() const override { return GetTimeNowForTest(); }

  std::unique_ptr<LocationProvider> NewNetworkLocationProvider(
      scoped_refptr<net::URLRequestContextGetter> context,
      const std::string& api_key) override {
    cell_ = new FakeLocationProvider;
    return base::WrapUnique(cell_);
  }

  std::unique_ptr<LocationProvider> NewSystemLocationProvider() override {
    gps_ = new FakeLocationProvider;
    return base::WrapUnique(gps_);
  }

  // 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 |gps_location_provider_|
  FakeLocationProvider* cell_;
  FakeLocationProvider* gps_;
};

class GeolocationLocationArbitratorTest : public testing::Test {
 protected:
  GeolocationLocationArbitratorTest() : observer_(new MockLocationObserver) {}

  // Initializes |arbitrator_| with the specified |provider|, which may be null.
  void InitializeArbitrator(
      const CustomLocationProviderCallback& provider_getter,
      GeolocationProvider::RequestContextProducer request_context_producer) {
    const LocationProvider::LocationProviderUpdateCallback callback =
        base::Bind(&MockLocationObserver::OnLocationUpdate,
                   base::Unretained(observer_.get()));
    arbitrator_.reset(new TestingLocationArbitrator(callback, provider_getter,
                                                    request_context_producer));
  }

  // testing::Test
  void TearDown() override {}

  void CheckLastPositionInfo(double latitude,
                             double longitude,
                             double accuracy) {
    mojom::Geoposition geoposition = observer_->last_position();
    EXPECT_TRUE(ValidateGeoposition(geoposition));
    EXPECT_DOUBLE_EQ(latitude, geoposition.latitude);
    EXPECT_DOUBLE_EQ(longitude, geoposition.longitude);
    EXPECT_DOUBLE_EQ(accuracy, geoposition.accuracy);
  }

  base::TimeDelta SwitchOnFreshnessCliff() {
    // Add 1, to ensure it meets any greater-than test.
    return LocationArbitrator::kFixStaleTimeoutTimeDelta +
           base::TimeDelta::FromMilliseconds(1);
  }

  FakeLocationProvider* cell() { return arbitrator_->cell_; }

  FakeLocationProvider* gps() { return arbitrator_->gps_; }

  const std::unique_ptr<MockLocationObserver> observer_;
  std::unique_ptr<TestingLocationArbitrator> arbitrator_;
  base::test::ScopedTaskEnvironment scoped_task_environment_;
};

// Basic test of the text fixture.
TEST_F(GeolocationLocationArbitratorTest, CreateDestroy) {
  InitializeArbitrator(base::Bind(&GetCustomLocationProviderForTest, nullptr),
                       base::Bind(&NullRequestContextProducer));
  EXPECT_TRUE(arbitrator_);
  arbitrator_.reset();
  SUCCEED();
}

// Tests OnPermissionGranted().
TEST_F(GeolocationLocationArbitratorTest, OnPermissionGranted) {
  InitializeArbitrator(base::Bind(&GetCustomLocationProviderForTest, nullptr),
                       base::Bind(&NullRequestContextProducer));
  EXPECT_FALSE(arbitrator_->HasPermissionBeenGrantedForTest());
  arbitrator_->OnPermissionGranted();
  EXPECT_TRUE(arbitrator_->HasPermissionBeenGrantedForTest());
  // 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());
}

// Tests basic operation (single position fix) with both network location
// providers and system location provider.
TEST_F(GeolocationLocationArbitratorTest, NormalUsage) {
  InitializeArbitrator(
      base::Bind(&GetCustomLocationProviderForTest, nullptr),
      base::Bind(&TestRequestContextProducer,
                 scoped_task_environment_.GetMainThreadTaskRunner()));
  ASSERT_TRUE(arbitrator_);

  EXPECT_FALSE(cell());
  EXPECT_FALSE(gps());
  arbitrator_->StartProvider(false);

  ASSERT_TRUE(cell());
  EXPECT_TRUE(gps());
  EXPECT_EQ(FakeLocationProvider::LOW_ACCURACY, cell()->state_);
  EXPECT_EQ(FakeLocationProvider::LOW_ACCURACY, gps()->state_);
  EXPECT_FALSE(ValidateGeoposition(observer_->last_position()));
  EXPECT_EQ(mojom::Geoposition::ErrorCode::NONE,
            observer_->last_position().error_code);

  SetReferencePosition(cell());

  EXPECT_TRUE(ValidateGeoposition(observer_->last_position()) ||
              observer_->last_position().error_code !=
                  mojom::Geoposition::ErrorCode::NONE);
  EXPECT_EQ(cell()->GetPosition().latitude,
            observer_->last_position().latitude);

  EXPECT_FALSE(cell()->is_permission_granted());
  EXPECT_FALSE(arbitrator_->HasPermissionBeenGrantedForTest());
  arbitrator_->OnPermissionGranted();
  EXPECT_TRUE(arbitrator_->HasPermissionBeenGrantedForTest());
  EXPECT_TRUE(cell()->is_permission_granted());
}

// Tests basic operation (single position fix) with no network location
// providers and a custom system location provider.
TEST_F(GeolocationLocationArbitratorTest, CustomSystemProviderOnly) {
  auto provider = std::make_unique<FakeLocationProvider>();
  FakeLocationProvider* fake_location_provider = provider.get();
  InitializeArbitrator(
      base::Bind(&GetCustomLocationProviderForTest, base::Passed(&provider)),
      base::Bind(&NullRequestContextProducer));
  ASSERT_TRUE(arbitrator_);

  EXPECT_FALSE(cell());
  EXPECT_FALSE(gps());
  arbitrator_->StartProvider(false);

  ASSERT_FALSE(cell());
  EXPECT_FALSE(gps());
  EXPECT_EQ(FakeLocationProvider::LOW_ACCURACY, fake_location_provider->state_);
  EXPECT_FALSE(ValidateGeoposition(observer_->last_position()));
  EXPECT_EQ(mojom::Geoposition::ErrorCode::NONE,
            observer_->last_position().error_code);

  SetReferencePosition(fake_location_provider);

  EXPECT_TRUE(ValidateGeoposition(observer_->last_position()) ||
              observer_->last_position().error_code !=
                  mojom::Geoposition::ErrorCode::NONE);
  EXPECT_EQ(fake_location_provider->GetPosition().latitude,
            observer_->last_position().latitude);

  EXPECT_FALSE(fake_location_provider->is_permission_granted());
  EXPECT_FALSE(arbitrator_->HasPermissionBeenGrantedForTest());
  arbitrator_->OnPermissionGranted();
  EXPECT_TRUE(arbitrator_->HasPermissionBeenGrantedForTest());
  EXPECT_TRUE(fake_location_provider->is_permission_granted());
}

// Tests basic operation (single position fix) with both network location
// providers and a custom system location provider.
TEST_F(GeolocationLocationArbitratorTest,
       CustomSystemAndDefaultNetworkProviders) {
  auto provider = std::make_unique<FakeLocationProvider>();
  FakeLocationProvider* fake_location_provider = provider.get();
  InitializeArbitrator(
      base::Bind(&GetCustomLocationProviderForTest, base::Passed(&provider)),
      base::Bind(&TestRequestContextProducer,
                 scoped_task_environment_.GetMainThreadTaskRunner()));
  ASSERT_TRUE(arbitrator_);

  EXPECT_FALSE(cell());
  EXPECT_FALSE(gps());
  arbitrator_->StartProvider(false);

  ASSERT_TRUE(cell());
  EXPECT_FALSE(gps());
  EXPECT_EQ(FakeLocationProvider::LOW_ACCURACY, fake_location_provider->state_);
  EXPECT_EQ(FakeLocationProvider::LOW_ACCURACY, cell()->state_);
  EXPECT_FALSE(ValidateGeoposition(observer_->last_position()));
  EXPECT_EQ(mojom::Geoposition::ErrorCode::NONE,
            observer_->last_position().error_code);

  SetReferencePosition(cell());

  EXPECT_TRUE(ValidateGeoposition(observer_->last_position()) ||
              observer_->last_position().error_code !=
                  mojom::Geoposition::ErrorCode::NONE);
  EXPECT_EQ(cell()->GetPosition().latitude,
            observer_->last_position().latitude);

  EXPECT_FALSE(cell()->is_permission_granted());
  EXPECT_FALSE(arbitrator_->HasPermissionBeenGrantedForTest());
  arbitrator_->OnPermissionGranted();
  EXPECT_TRUE(arbitrator_->HasPermissionBeenGrantedForTest());
  EXPECT_TRUE(cell()->is_permission_granted());
}

// Tests flipping from Low to High accuracy mode as requested by a location
// observer.
TEST_F(GeolocationLocationArbitratorTest, SetObserverOptions) {
  InitializeArbitrator(
      base::Bind(&GetCustomLocationProviderForTest, nullptr),
      base::Bind(&TestRequestContextProducer,
                 scoped_task_environment_.GetMainThreadTaskRunner()));
  arbitrator_->StartProvider(false);
  ASSERT_TRUE(cell());
  ASSERT_TRUE(gps());
  EXPECT_EQ(FakeLocationProvider::LOW_ACCURACY, cell()->state_);
  EXPECT_EQ(FakeLocationProvider::LOW_ACCURACY, gps()->state_);
  SetReferencePosition(cell());
  EXPECT_EQ(FakeLocationProvider::LOW_ACCURACY, cell()->state_);
  EXPECT_EQ(FakeLocationProvider::LOW_ACCURACY, gps()->state_);
  arbitrator_->StartProvider(true);
  EXPECT_EQ(FakeLocationProvider::HIGH_ACCURACY, cell()->state_);
  EXPECT_EQ(FakeLocationProvider::HIGH_ACCURACY, gps()->state_);
}

// Tests arbitration algorithm through a sequence of position fixes from
// multiple sources, with varying accuracy, across a period of time.
TEST_F(GeolocationLocationArbitratorTest, Arbitration) {
  InitializeArbitrator(
      base::Bind(&GetCustomLocationProviderForTest, nullptr),
      base::Bind(&TestRequestContextProducer,
                 scoped_task_environment_.GetMainThreadTaskRunner()));
  arbitrator_->StartProvider(false);
  ASSERT_TRUE(cell());
  ASSERT_TRUE(gps());

  SetPositionFix(cell(), 1, 2, 150);

  // First position available
  EXPECT_TRUE(ValidateGeoposition(observer_->last_position()));
  CheckLastPositionInfo(1, 2, 150);

  SetPositionFix(gps(), 3, 4, 50);

  // More accurate fix available
  CheckLastPositionInfo(3, 4, 50);

  SetPositionFix(cell(), 5, 6, 150);

  // New fix is available but it's less accurate, older fix should be kept.
  CheckLastPositionInfo(3, 4, 50);

  // Advance time, and notify once again
  AdvanceTimeNow(SwitchOnFreshnessCliff());
  cell()->HandlePositionChanged(cell()->GetPosition());

  // New fix is available, less accurate but fresher
  CheckLastPositionInfo(5, 6, 150);

  // Advance time, and set a low accuracy position
  AdvanceTimeNow(SwitchOnFreshnessCliff());
  SetPositionFix(cell(), 5.676731, 139.629385, 1000);
  CheckLastPositionInfo(5.676731, 139.629385, 1000);

  // 15 secs later, step outside. Switches to gps signal.
  AdvanceTimeNow(base::TimeDelta::FromSeconds(15));
  SetPositionFix(gps(), 3.5676457, 139.629198, 50);
  CheckLastPositionInfo(3.5676457, 139.629198, 50);

  // 5 mins later switch cells while walking. Stay on gps.
  AdvanceTimeNow(base::TimeDelta::FromMinutes(5));
  SetPositionFix(cell(), 3.567832, 139.634648, 300);
  SetPositionFix(gps(), 3.5677675, 139.632314, 50);
  CheckLastPositionInfo(3.5677675, 139.632314, 50);

  // Ride train and gps signal degrades slightly. Stay on fresher gps
  AdvanceTimeNow(base::TimeDelta::FromMinutes(5));
  SetPositionFix(gps(), 3.5679026, 139.634777, 300);
  CheckLastPositionInfo(3.5679026, 139.634777, 300);

  // 14 minutes later
  AdvanceTimeNow(base::TimeDelta::FromMinutes(14));

  // GPS reading misses a beat, but don't switch to cell yet to avoid
  // oscillating.
  SetPositionFix(gps(), 3.5659005, 139.682579, 300);

  AdvanceTimeNow(base::TimeDelta::FromSeconds(7));
  SetPositionFix(cell(), 3.5689579, 139.691420, 1000);
  CheckLastPositionInfo(3.5659005, 139.682579, 300);

  // 1 minute later
  AdvanceTimeNow(base::TimeDelta::FromMinutes(1));

  // Enter tunnel. Stay on fresher gps for a moment.
  SetPositionFix(cell(), 3.5657078, 139.68922, 300);
  SetPositionFix(gps(), 3.5657104, 139.690341, 300);
  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);
}

// Verifies that the arbitrator doesn't retain pointers to old providers after
// it has stopped and then restarted (crbug.com/240956).
TEST_F(GeolocationLocationArbitratorTest, TwoOneShotsIsNewPositionBetter) {
  InitializeArbitrator(
      base::Bind(&GetCustomLocationProviderForTest, nullptr),
      base::Bind(&TestRequestContextProducer,
                 scoped_task_environment_.GetMainThreadTaskRunner()));
  arbitrator_->StartProvider(false);
  ASSERT_TRUE(cell());
  ASSERT_TRUE(gps());

  // Set the initial position.
  SetPositionFix(cell(), 3, 139, 100);
  CheckLastPositionInfo(3, 139, 100);

  // Restart providers to simulate a one-shot request.
  arbitrator_->StopProvider();

  // To test 240956, perform a throwaway alloc.
  // This convinces the allocator to put the providers in a new memory location.
  std::unique_ptr<FakeLocationProvider> dummy_provider(
      new FakeLocationProvider);

  arbitrator_->StartProvider(false);

  // 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 device