content/browser/geolocation/mock_location_provider.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 #ifndef CONTENT_BROWSER_GEOLOCATION_MOCK_LOCATION_PROVIDER_H_
   6 #define CONTENT_BROWSER_GEOLOCATION_MOCK_LOCATION_PROVIDER_H_
   7
   8
   9 #include "base/compiler_specific.h"
  10 #include "base/memory/ref_counted.h"
  11 #include "base/single_thread_task_runner.h"
  12 #include "base/threading/thread.h"
  13 #include "content/browser/geolocation/location_provider_base.h"
  14 #include "content/public/common/geoposition.h"
  15
  16 namespace content {
  17
  18 // Mock implementation of a location provider for testing.
  19 class MockLocationProvider : public LocationProviderBase {
  20  public:
  21   // Will update |*self_ref| to point to |this| on construction, and to NULL
  22   // on destruction.
  23   explicit MockLocationProvider(MockLocationProvider** self_ref);
  24   ~MockLocationProvider() override;
  25
  26   // Updates listeners with the new position.
  27   void HandlePositionChanged(const Geoposition& position);
  28
  29   // LocationProvider implementation.
  30   bool StartProvider(bool high_accuracy) override;
  31   void StopProvider() override;
  32   void GetPosition(Geoposition* position) override;
  33   void OnPermissionGranted() override;
  34
  35   Geoposition position_;
  36   enum State { STOPPED, LOW_ACCURACY, HIGH_ACCURACY } state_;
  37   bool is_permission_granted_;
  38   MockLocationProvider** self_ref_;
  39
  40   scoped_refptr<base::SingleThreadTaskRunner> provider_task_runner_;
  41
  42   // Set when an instance of the mock is created via a factory function.
  43   static MockLocationProvider* instance_;
  44
  45   DISALLOW_COPY_AND_ASSIGN(MockLocationProvider);
  46 };
  47
  48 // Factory functions for the various sorts of mock location providers,
  49 // for use with LocationArbitrator::SetProviderFactoryForTest (i.e.
  50 // not intended for test code to use to get access to the mock, you can use
  51 // MockLocationProvider::instance_ for this, or make a custom factory method).
  52
  53 // Creates a mock location provider with no default behavior.
  54 LocationProvider* NewMockLocationProvider();
  55 // Creates a mock location provider that automatically notifies its
  56 // listeners with a valid location when StartProvider is called.
  57 LocationProvider* NewAutoSuccessMockLocationProvider();
  58 // Creates a mock location provider that automatically notifies its
  59 // listeners with an error when StartProvider is called.
  60 LocationProvider* NewAutoFailMockLocationProvider();
  61 // Similar to NewAutoSuccessMockLocationProvider but mimicks the behavior of
  62 // the Network Location provider, in deferring making location updates until
  63 // a permission request has been confirmed.
  64 LocationProvider* NewAutoSuccessMockNetworkLocationProvider();
  65
  66 }  // namespace content
  67
  68 #endif  // CONTENT_BROWSER_GEOLOCATION_MOCK_LOCATION_PROVIDER_H_