[GCM] Adding basic G-services handling

google_apis/gcm/gcm_client_impl_unittest.cc

 // Copyright 2014 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 "google_apis/gcm/gcm_client_impl.h"
 
 #include "base/files/scoped_temp_dir.h"
 #include "base/message_loop/message_loop.h"
 #include "base/run_loop.h"
+#include "base/strings/string_number_conversions.h"
 #include "base/test/simple_test_clock.h"
 #include "components/os_crypt/os_crypt.h"
 #include "google_apis/gcm/base/mcs_message.h"
 #include "google_apis/gcm/base/mcs_util.h"
 #include "google_apis/gcm/engine/fake_connection_factory.h"
 #include "google_apis/gcm/engine/fake_connection_handler.h"
 #include "google_apis/gcm/protocol/android_checkin.pb.h"
 #include "google_apis/gcm/protocol/checkin.pb.h"
 #include "google_apis/gcm/protocol/mcs.pb.h"
 #include "net/url_request/test_url_fetcher_factory.h"
@@ skipping 10 matching lines @@
   LOADING_COMPLETED,
   REGISTRATION_COMPLETED,
   UNREGISTRATION_COMPLETED,
   MESSAGE_SEND_ERROR,
   MESSAGE_RECEIVED,
   MESSAGES_DELETED,
 };
 
 const uint64 kDeviceAndroidId = 54321;
 const uint64 kDeviceSecurityToken = 12345;
+const int64 kSettingsCheckinInterval = 3600;
+const char kSettingsDefaultDigest[] = "default_digest";
 const char kAppId[] = "app_id";
 const char kSender[] = "project_id";
 const char kSender2[] = "project_id2";
 const char kSender3[] = "project_id3";
 const char kRegistrationResponsePrefix[] = "token=";
 const char kUnregistrationResponsePrefix[] = "deleted=";
 
 // Helper for building arbitrary data messages.
 MCSMessage BuildDownstreamMessage(
     const std::string& project_id,
@@ skipping 98 matching lines @@
 }
 
 scoped_ptr<ConnectionFactory> FakeGCMInternalsBuilder::BuildConnectionFactory(
     const std::vector<GURL>& endpoints,
     const net::BackoffEntry::Policy& backoff_policy,
     scoped_refptr<net::HttpNetworkSession> network_session,
     net::NetLog* net_log) {
   return make_scoped_ptr<ConnectionFactory>(new FakeConnectionFactory());
 }
 
+class CheckinGCMClientImpl : public GCMClientImpl {
+ public:
+  CheckinGCMClientImpl(scoped_ptr<GCMInternalsBuilder> internals_builder);

[Nicolas Zea, 2014/04/01 21:42:14]

explicit

[fgorski, 2014/04/02 18:23:00]

Done.

+  virtual ~CheckinGCMClientImpl();
+
+  virtual base::TimeDelta GetCheckinInterval() const OVERRIDE;

[Nicolas Zea, 2014/04/01 21:42:14]

How important is it to override this? I think I'd rather avoid having this
CheckinGCMClientImpl (and the corresponding GCMClientImplCheckinTest).

[fgorski, 2014/04/02 18:23:00]

Done.

+};
+
+CheckinGCMClientImpl::CheckinGCMClientImpl(
+    scoped_ptr<GCMInternalsBuilder> internals_builder)
+      : GCMClientImpl(internals_builder.Pass()) {
+}
+
+CheckinGCMClientImpl::~CheckinGCMClientImpl() { }
+
+base::TimeDelta CheckinGCMClientImpl::GetCheckinInterval() const {
+  return base::TimeDelta::FromMilliseconds(10);
+}
+
 }  // namespace
 
 class GCMClientImplTest : public testing::Test,
                           public GCMClient::Delegate {
  public:
   GCMClientImplTest();
   virtual ~GCMClientImplTest();
 
   virtual void SetUp() OVERRIDE;
 
   void BuildGCMClient();
   void InitializeGCMClient();
   void ReceiveMessageFromMCS(const MCSMessage& message);
-  void CompleteCheckin(uint64 android_id, uint64 security_token);
+  void CompleteCheckin(
+      uint64 android_id,
+      uint64 security_token,
+      const std::string& digest,
+      const std::map<std::string, std::string>& settings);
   void CompleteRegistration(const std::string& registration_id);
   void CompleteUnregistration(const std::string& app_id);
 
   bool ExistsRegistration(const std::string& app_id) const;
   void AddRegistration(const std::string& app_id,
                        const std::vector<std::string>& sender_ids,
                        const std::string& registration_id);
 
   // GCMClient::Delegate overrides (for verification).
   virtual void OnRegisterFinished(const std::string& app_id,
@@ skipping 13 matching lines @@
       const gcm::GCMClient::SendErrorDetails& send_error_details) OVERRIDE;
   virtual void OnGCMReady() OVERRIDE;
 
   GCMClientImpl* gcm_client() const { return gcm_client_.get(); }
   FakeMCSClient* mcs_client() const {
     return reinterpret_cast<FakeMCSClient*>(gcm_client_->mcs_client_.get());
   }
   ConnectionFactory* connection_factory() const {
     return gcm_client_->connection_factory_.get();
   }
+  GServicesSettingsMap& services_settings() {
+    return gcm_client_->gservices_settings_;
+  }
+  const std::string& services_digest() {
+    return gcm_client_->gservices_digest_;
+  }
 
   void reset_last_event() {
     last_event_ = NONE;
     last_app_id_.clear();
     last_registration_id_.clear();
     last_message_id_.clear();
     last_result_ = GCMClient::UNKNOWN_ERROR;
   }
 
   LastEvent last_event() const { return last_event_; }
   const std::string& last_app_id() const { return last_app_id_; }
   const std::string& last_registration_id() const {
     return last_registration_id_;
   }
   const std::string& last_message_id() const { return last_message_id_; }
   GCMClient::Result last_result() const { return last_result_; }
   const GCMClient::IncomingMessage& last_message() const {
     return last_message_;
   }
   const GCMClient::SendErrorDetails& last_error_details() const {
     return last_error_details_;
   }
 
   int64 CurrentTime();
 
- private:
+ protected:
   // Tooling.
   void PumpLoop();
   void PumpLoopUntilIdle();
   void QuitLoop();
+  void ResetLoop();
+
+  bool CreateUniqueTempDir();
 
   base::SimpleTestClock* clock() const {
     return reinterpret_cast<base::SimpleTestClock*>(gcm_client_->clock_.get());
   }
 
+  scoped_ptr<GCMClientImpl> gcm_client_;

[Nicolas Zea, 2014/04/01 21:42:14]

this is already exposed via gcm_client(). Is is necessary to have this here?

[fgorski, 2014/04/02 18:23:00]

Done.

+ private:
   // Variables used for verification.
   LastEvent last_event_;
   std::string last_app_id_;
   std::string last_registration_id_;
   std::string last_message_id_;
   GCMClient::Result last_result_;
   GCMClient::IncomingMessage last_message_;
   GCMClient::SendErrorDetails last_error_details_;
 
-  scoped_ptr<GCMClientImpl> gcm_client_;
 
   base::MessageLoop message_loop_;
   scoped_ptr<base::RunLoop> run_loop_;
   net::TestURLFetcherFactory url_fetcher_factory_;
 
   // Injected to GCM client:
   base::ScopedTempDir temp_directory_;
   scoped_refptr<net::TestURLRequestContextGetter> url_request_context_getter_;
 };
 
 GCMClientImplTest::GCMClientImplTest()
     : last_event_(NONE),
       last_result_(GCMClient::UNKNOWN_ERROR),
       url_request_context_getter_(new net::TestURLRequestContextGetter(
           message_loop_.message_loop_proxy())) {
 }
 
 GCMClientImplTest::~GCMClientImplTest() {}
 
 void GCMClientImplTest::SetUp() {
-  ASSERT_TRUE(temp_directory_.CreateUniqueTempDir());
-  run_loop_.reset(new base::RunLoop);
+  ASSERT_TRUE(CreateUniqueTempDir());
+  ResetLoop();
   BuildGCMClient();
   InitializeGCMClient();
-  CompleteCheckin(kDeviceAndroidId, kDeviceSecurityToken);
+  CompleteCheckin(kDeviceAndroidId,
+                  kDeviceSecurityToken,
+                  kSettingsDefaultDigest,
+                  std::map<std::string, std::string>());
 }
 
 void GCMClientImplTest::PumpLoop() {
   run_loop_->Run();
   run_loop_.reset(new base::RunLoop());
 }
 
 void GCMClientImplTest::PumpLoopUntilIdle() {
   run_loop_->RunUntilIdle();
   run_loop_.reset(new base::RunLoop());
 }
 
 void GCMClientImplTest::QuitLoop() {
   if (run_loop_ && run_loop_->running())
     run_loop_->Quit();
 }
 
+void GCMClientImplTest::ResetLoop() {
+  run_loop_.reset(new base::RunLoop);
+}
+
+bool GCMClientImplTest::CreateUniqueTempDir() {
+  return temp_directory_.CreateUniqueTempDir();
+}
+
 void GCMClientImplTest::BuildGCMClient() {
   gcm_client_.reset(new GCMClientImpl(
       make_scoped_ptr<GCMInternalsBuilder>(new FakeGCMInternalsBuilder())));
 }
 
-void GCMClientImplTest::CompleteCheckin(uint64 android_id,
-                                        uint64 security_token) {
+void GCMClientImplTest::CompleteCheckin(
+    uint64 android_id,
+    uint64 security_token,
+    const std::string& digest,
+    const std::map<std::string, std::string>& settings) {
   checkin_proto::AndroidCheckinResponse response;
   response.set_stats_ok(true);
   response.set_android_id(android_id);
   response.set_security_token(security_token);
 
+  // For testing GServices settings.
+  response.set_digest(digest);
+  for (std::map<std::string, std::string>::const_iterator it = settings.begin();
+       it != settings.end(); ++it) {
+    checkin_proto::GservicesSetting* setting = response.add_setting();
+    setting->set_name(it->first);
+    setting->set_value(it->second);
+  }
+
   std::string response_string;
   response.SerializeToString(&response_string);
 
   net::TestURLFetcher* fetcher = url_fetcher_factory_.GetFetcherByID(0);
   ASSERT_TRUE(fetcher);
   fetcher->set_response_code(net::HTTP_OK);
   fetcher->SetResponseString(response_string);
   fetcher->delegate()->OnURLFetchComplete(fetcher);
   url_fetcher_factory_.RemoveFetcherFromMap(0);
 }
@@ skipping 274 matching lines @@
   EXPECT_EQ(500, mcs_client()->last_data_message_stanza().ttl());
   EXPECT_EQ(CurrentTime(), mcs_client()->last_data_message_stanza().sent());
   EXPECT_EQ("007", mcs_client()->last_data_message_stanza().id());
   EXPECT_EQ("gcm@chrome.com", mcs_client()->last_data_message_stanza().from());
   EXPECT_EQ(kSender, mcs_client()->last_data_message_stanza().to());
   EXPECT_EQ("key", mcs_client()->last_data_message_stanza().app_data(0).key());
   EXPECT_EQ("value",
             mcs_client()->last_data_message_stanza().app_data(0).value());
 }
 
+class GCMClientImplCheckinTest : public GCMClientImplTest {
+ public:
+  GCMClientImplCheckinTest();
+  virtual ~GCMClientImplCheckinTest();
+
+  virtual void SetUp() OVERRIDE;
+
+  std::map<std::string, std::string> GenerateSettings(int64 checkin_interval);

[Nicolas Zea, 2014/04/01 21:42:14]

you're always passing in kSettingsCheckinInterval here. Why not just use that
directly in GenerateSettings?

[fgorski, 2014/04/02 18:23:00]

Done.

+  void BuildGCMClient();
+};
+
+GCMClientImplCheckinTest::GCMClientImplCheckinTest() {}
+
+GCMClientImplCheckinTest::~GCMClientImplCheckinTest() {}
+
+void GCMClientImplCheckinTest::SetUp() {
+  ASSERT_TRUE(CreateUniqueTempDir());
+  ResetLoop();
+  BuildGCMClient();
+  InitializeGCMClient();
+}
+
+std::map<std::string, std::string> GCMClientImplCheckinTest::GenerateSettings(
+    int64 checkin_interval) {
+  std::map<std::string, std::string> settings;
+  settings["checkin_interval"] = base::Int64ToString(checkin_interval);

[Nicolas Zea, 2014/04/01 21:42:14]

nit: pull "checkin_interval" into a const and reuse here and below?

[fgorski, 2014/04/02 18:23:00]

Done.

+  return settings;
+}
+
+void GCMClientImplCheckinTest::BuildGCMClient() {
+  gcm_client_.reset(new CheckinGCMClientImpl(
+      make_scoped_ptr<GCMInternalsBuilder>(new FakeGCMInternalsBuilder())));
+}
+
+TEST_F(GCMClientImplCheckinTest, GServicesSettingsAfterInitialCheckin) {
+  CompleteCheckin(kDeviceAndroidId, kDeviceSecurityToken,
+      kSettingsDefaultDigest, GenerateSettings(kSettingsCheckinInterval));
+  EXPECT_EQ(base::Int64ToString(kSettingsCheckinInterval),
+            services_settings()["checkin_interval"]);
+}
+
+// This test only checks that periodic checkin happens.
+TEST_F(GCMClientImplCheckinTest, PeriodicCheckin) {
+  std::map<std::string, std::string> settings =
+      GenerateSettings(kSettingsCheckinInterval);
+  CompleteCheckin(kDeviceAndroidId, kDeviceSecurityToken,
+      kSettingsDefaultDigest, settings);
+  PumpLoopUntilIdle();
+
+  CompleteCheckin(kDeviceAndroidId, kDeviceSecurityToken,
+      kSettingsDefaultDigest, settings);
+  }
+
+// This test checks that checkin can update GServices settings by diffing them.
+TEST_F(GCMClientImplCheckinTest, GServicesSettingsSameDigest) {
+  std::map<std::string, std::string> settings =
+      GenerateSettings(kSettingsCheckinInterval);
+  settings["checkin_url"] = "http://checkin.google.com";
+  CompleteCheckin(kDeviceAndroidId, kDeviceSecurityToken,
+      kSettingsDefaultDigest, settings);
+  EXPECT_EQ(settings, services_settings());
+  PumpLoopUntilIdle();
+
+  CompleteCheckin(kDeviceAndroidId, kDeviceSecurityToken,
+      kSettingsDefaultDigest, settings);
+  EXPECT_EQ(settings, services_settings());
+}
+
+// Test that checkin can make full replacement of GServices settings.
+TEST_F(GCMClientImplCheckinTest, GServicesSettingsFullUpdate) {
+  std::map<std::string, std::string> settings =
+      GenerateSettings(kSettingsCheckinInterval);
+  settings["checkin_url"] = "http://checkin.google.com";
+  CompleteCheckin(kDeviceAndroidId, kDeviceSecurityToken,
+      kSettingsDefaultDigest, settings);
+  EXPECT_EQ(settings, services_settings());
+  EXPECT_EQ(kSettingsDefaultDigest, services_digest());
+  PumpLoopUntilIdle();
+
+  settings.clear();
+  settings["some_settings"] = "on second checkin";
+  settings["checkin_interval"] = "2100";
+  settings["checkin_url"] = "http://checkin.google.com";
+  std::string new_digest = "some_other_digest";
+
+  CompleteCheckin(kDeviceAndroidId, kDeviceSecurityToken, new_digest, settings);
+  EXPECT_EQ(settings, services_settings());
+  EXPECT_EQ(new_digest, services_digest());
+}
+
 }  // namespace gcm