[GCM] Wiring heartbeat interval calls to GCMDriver

google_apis/gcm/engine/mcs_client_unittest.cc

 // Copyright 2013 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/engine/mcs_client.h"
 
 #include "base/bind.h"
 #include "base/bind_helpers.h"
 #include "base/command_line.h"
 #include "base/files/scoped_temp_dir.h"
@@ skipping 95 matching lines @@
  public:
   MCSClientTest();
   ~MCSClientTest() override;
 
   void SetUp() override;
 
   void BuildMCSClient();
   void InitializeClient();
   void StoreCredentials();
   void LoginClient(const std::vector<std::string>& acknowledged_ids);
+  void LoginClientWithHeartbeat(
+      const std::vector<std::string>& acknowledged_ids,
+      int heartbeat_interval_ms);
   void AddExpectedLoginRequest(const std::vector<std::string>& acknowledged_ids,
-                               int custom_heartbeat_interval);
+                               int heartbeat_interval_ms);
 
   base::SimpleTestClock* clock() { return &clock_; }
   TestMCSClient* mcs_client() const { return mcs_client_.get(); }
   FakeConnectionFactory* connection_factory() {
     return &connection_factory_;
   }
   bool init_success() const { return init_success_; }
   uint64 restored_android_id() const { return restored_android_id_; }
   uint64 restored_security_token() const { return restored_security_token_; }
   MCSMessage* received_message() const { return received_message_.get(); }
@@ skipping 74 matching lines @@
                  base::Unretained(this)),
       base::Bind(&MCSClientTest::MessageReceivedCallback,
                  base::Unretained(this)),
       base::Bind(&MCSClientTest::MessageSentCallback, base::Unretained(this))));
   run_loop_->RunUntilIdle();
   run_loop_.reset(new base::RunLoop());
 }
 
 void MCSClientTest::LoginClient(
     const std::vector<std::string>& acknowledged_ids) {
-  AddExpectedLoginRequest(acknowledged_ids, 0);
+  LoginClientWithHeartbeat(acknowledged_ids, 0);
+}
+
+void MCSClientTest::LoginClientWithHeartbeat(
+    const std::vector<std::string>& acknowledged_ids,
+    int heartbeat_interval_ms) {
+  AddExpectedLoginRequest(acknowledged_ids, heartbeat_interval_ms);
   mcs_client_->Login(kAndroidId, kSecurityToken);
   run_loop_->Run();
   run_loop_.reset(new base::RunLoop());
 }
 
 void MCSClientTest::AddExpectedLoginRequest(
     const std::vector<std::string>& acknowledged_ids,
-    int custom_heartbeat_interval) {
+    int heartbeat_interval_ms) {
   scoped_ptr<mcs_proto::LoginRequest> login_request =
       BuildLoginRequest(kAndroidId, kSecurityToken, "");
   for (size_t i = 0; i < acknowledged_ids.size(); ++i)
     login_request->add_received_persistent_id(acknowledged_ids[i]);
-  if (custom_heartbeat_interval) {
+  if (heartbeat_interval_ms) {
     mcs_proto::Setting* setting = login_request->add_setting();
     setting->set_name("hbping");
-    setting->set_value(base::IntToString(custom_heartbeat_interval));
+    setting->set_value(base::IntToString(heartbeat_interval_ms));
   }
   GetFakeHandler()->ExpectOutgoingMessage(
       MCSMessage(kLoginRequestTag, login_request.Pass()));
 }
 
 void MCSClientTest::StoreCredentials() {
   gcm_store_->SetDeviceCredentials(
       kAndroidId, kSecurityToken,
       base::Bind(&MCSClientTest::SetDeviceCredentialsCallback,
                  base::Unretained(this)));
@@ skipping 661 matching lines @@
 
 // Tests adding and removing custom heartbeat interval.
 TEST_F(MCSClientTest, CustomHeartbeatInterval) {
   BuildMCSClient();
   InitializeClient();
   LoginClient(std::vector<std::string>());
 
   TestConnectionListener test_connection_listener;
   connection_factory()->SetConnectionListener(&test_connection_listener);
 
-  HeartbeatManager& hb_manager = mcs_client()->GetHeartbeatManagerForTesting();
+  HeartbeatManager* hb_manager = mcs_client()->GetHeartbeatManagerForTesting();
   // By default custom client interval is not set.
-  EXPECT_FALSE(hb_manager.HasClientHeartbeatInterval());
+  EXPECT_FALSE(hb_manager->HasClientHeartbeatInterval());
 
   const std::string component_1 = "component1";
   int interval_ms = 30 * 1000;  // 30 seconds, too low.
   mcs_client()->AddHeartbeatInterval(component_1, interval_ms);
   // Setting was too low so it was ignored.
-  EXPECT_FALSE(hb_manager.HasClientHeartbeatInterval());
+  EXPECT_FALSE(hb_manager->HasClientHeartbeatInterval());
 
   interval_ms = 60 * 60 * 1000;  // 1 hour, too high.
   mcs_client()->AddHeartbeatInterval(component_1, interval_ms);
   // Setting was too high, again it was ignored.
-  EXPECT_FALSE(hb_manager.HasClientHeartbeatInterval());
+  EXPECT_FALSE(hb_manager->HasClientHeartbeatInterval());
 
   int expected_disconnect_counter = 0;
   EXPECT_EQ(expected_disconnect_counter,
             test_connection_listener.get_disconnect_counter());
 
   interval_ms = 5 * 60 * 1000;  // 5 minutes. A valid setting.
   AddExpectedLoginRequest(std::vector<std::string>(), interval_ms);
   mcs_client()->AddHeartbeatInterval(component_1, interval_ms);
   // Setting was OK. HearbeatManager should get that setting now.
-  EXPECT_TRUE(hb_manager.HasClientHeartbeatInterval());
-  EXPECT_EQ(interval_ms, hb_manager.GetClientHeartbeatIntervalMs());
+  EXPECT_TRUE(hb_manager->HasClientHeartbeatInterval());
+  EXPECT_EQ(interval_ms, hb_manager->GetClientHeartbeatIntervalMs());
 
   ++expected_disconnect_counter;
   EXPECT_EQ(expected_disconnect_counter,
             test_connection_listener.get_disconnect_counter());
 
   const std::string component_2 = "component2";
   int other_interval_ms = 10 * 60 * 1000;  // 10 minutes. A valid setting.
   mcs_client()->AddHeartbeatInterval(component_2, other_interval_ms);
   // Setting was OK, but higher than the previous setting and HearbeatManager
   // will not be updated.
-  EXPECT_TRUE(hb_manager.HasClientHeartbeatInterval());
-  EXPECT_EQ(interval_ms, hb_manager.GetClientHeartbeatIntervalMs());
+  EXPECT_TRUE(hb_manager->HasClientHeartbeatInterval());
+  EXPECT_EQ(interval_ms, hb_manager->GetClientHeartbeatIntervalMs());
   // No connection reset expected.
   EXPECT_EQ(expected_disconnect_counter,
             test_connection_listener.get_disconnect_counter());
 
   other_interval_ms = 3 * 60 * 1000;  // 3 minutes. A valid setting.
   AddExpectedLoginRequest(std::vector<std::string>(), other_interval_ms);
   mcs_client()->AddHeartbeatInterval(component_2, other_interval_ms);
   // Setting was OK and lower then present setting. HearbeatManager should get
   // that setting now.
-  EXPECT_TRUE(hb_manager.HasClientHeartbeatInterval());
-  EXPECT_EQ(other_interval_ms, hb_manager.GetClientHeartbeatIntervalMs());
+  EXPECT_TRUE(hb_manager->HasClientHeartbeatInterval());
+  EXPECT_EQ(other_interval_ms, hb_manager->GetClientHeartbeatIntervalMs());
   ++expected_disconnect_counter;
   EXPECT_EQ(expected_disconnect_counter,
             test_connection_listener.get_disconnect_counter());
 
   mcs_client()->RemoveHeartbeatInterval(component_2);
   // Removing the lowest setting reverts to second lowest.
-  EXPECT_TRUE(hb_manager.HasClientHeartbeatInterval());
-  EXPECT_EQ(interval_ms, hb_manager.GetClientHeartbeatIntervalMs());
+  EXPECT_TRUE(hb_manager->HasClientHeartbeatInterval());
+  EXPECT_EQ(interval_ms, hb_manager->GetClientHeartbeatIntervalMs());
   // No connection reset expected.
   EXPECT_EQ(expected_disconnect_counter,
             test_connection_listener.get_disconnect_counter());
 
   mcs_client()->RemoveHeartbeatInterval(component_1);
   // Removing all of the intervals, removes it from the HeartbeatManager.
-  EXPECT_FALSE(hb_manager.HasClientHeartbeatInterval());
+  EXPECT_FALSE(hb_manager->HasClientHeartbeatInterval());
   // No connection reset expected.
   EXPECT_EQ(expected_disconnect_counter,
             test_connection_listener.get_disconnect_counter());
 
   mcs_client()->AddHeartbeatInterval(component_2, other_interval_ms);
   mcs_client()->AddHeartbeatInterval(component_1, interval_ms);
-  EXPECT_TRUE(hb_manager.HasClientHeartbeatInterval());
-  EXPECT_EQ(other_interval_ms, hb_manager.GetClientHeartbeatIntervalMs());
+  EXPECT_TRUE(hb_manager->HasClientHeartbeatInterval());
+  EXPECT_EQ(other_interval_ms, hb_manager->GetClientHeartbeatIntervalMs());
   // No connection reset expected.
   EXPECT_EQ(expected_disconnect_counter,
             test_connection_listener.get_disconnect_counter());
 
   // Removing interval other than lowest does not change anything.
   mcs_client()->RemoveHeartbeatInterval(component_1);
-  EXPECT_TRUE(hb_manager.HasClientHeartbeatInterval());
-  EXPECT_EQ(other_interval_ms, hb_manager.GetClientHeartbeatIntervalMs());
+  EXPECT_TRUE(hb_manager->HasClientHeartbeatInterval());
+  EXPECT_EQ(other_interval_ms, hb_manager->GetClientHeartbeatIntervalMs());
   // No connection reset expected.
   EXPECT_EQ(expected_disconnect_counter,
             test_connection_listener.get_disconnect_counter());
 }
 
+// Tests adding and removing custom heartbeat interval.
+TEST_F(MCSClientTest, StoringCustomHeartbeatInterval) {

[Nicolas Zea, 2015/05/07 18:13:52]

Can we break this up into multiple test cases?

Also, add test case for setting heartbeat interval before and during the initial
connection?

[fgorski, 2015/05/10 06:44:34]

Done.

+  BuildMCSClient();
+  InitializeClient();
+  LoginClient(std::vector<std::string>());
+  PumpLoop();
+  StoreCredentials();
+
+  const std::string component_1 = "component1";
+  int interval_ms = 30 * 1000;  // 30 seconds, too low.
+  mcs_client()->AddHeartbeatInterval(component_1, interval_ms);
+  // Setting was too low so it was ignored.
+
+  BuildMCSClient();
+  InitializeClient();
+  LoginClientWithHeartbeat(std::vector<std::string>(), 0);
+  PumpLoop();
+
+  HeartbeatManager* hb_manager = mcs_client()->GetHeartbeatManagerForTesting();
+  EXPECT_FALSE(hb_manager->HasClientHeartbeatInterval());
+
+  interval_ms = 60 * 60 * 1000;  // 1 hour, too high.
+  mcs_client()->AddHeartbeatInterval(component_1, interval_ms);
+
+  BuildMCSClient();
+  InitializeClient();
+  LoginClientWithHeartbeat(std::vector<std::string>(), 0);
+  PumpLoop();
+
+  // Setting was too high, again it was ignored.
+  hb_manager = mcs_client()->GetHeartbeatManagerForTesting();
+  EXPECT_FALSE(hb_manager->HasClientHeartbeatInterval());
+
+  interval_ms = 5 * 60 * 1000;  // 5 minutes. A valid setting.
+  AddExpectedLoginRequest(std::vector<std::string>(), interval_ms);
+  mcs_client()->AddHeartbeatInterval(component_1, interval_ms);
+  PumpLoop();
+
+  BuildMCSClient();
+  InitializeClient();
+  LoginClientWithHeartbeat(std::vector<std::string>(), interval_ms);
+  PumpLoop();
+
+  // Setting was OK. HearbeatManager should get that setting now.
+  hb_manager = mcs_client()->GetHeartbeatManagerForTesting();
+  EXPECT_TRUE(hb_manager->HasClientHeartbeatInterval());
+  EXPECT_EQ(interval_ms, hb_manager->GetClientHeartbeatIntervalMs());
+
+  const std::string component_2 = "component2";
+  int other_interval_ms = 10 * 60 * 1000;  // 10 minutes. A valid setting.
+  mcs_client()->AddHeartbeatInterval(component_2, other_interval_ms);
+
+  BuildMCSClient();
+  InitializeClient();
+  LoginClientWithHeartbeat(std::vector<std::string>(), interval_ms);
+  PumpLoop();
+
+  // Setting was OK, but higher than the previous setting and HearbeatManager
+  // will not be updated.
+  hb_manager = mcs_client()->GetHeartbeatManagerForTesting();
+  EXPECT_TRUE(hb_manager->HasClientHeartbeatInterval());
+  EXPECT_EQ(interval_ms, hb_manager->GetClientHeartbeatIntervalMs());
+
+  other_interval_ms = 3 * 60 * 1000;  // 3 minutes. A valid setting.
+  AddExpectedLoginRequest(std::vector<std::string>(), other_interval_ms);
+  mcs_client()->AddHeartbeatInterval(component_2, other_interval_ms);
+  PumpLoop();
+
+  BuildMCSClient();
+  InitializeClient();
+  LoginClientWithHeartbeat(std::vector<std::string>(), other_interval_ms);
+  PumpLoop();
+
+  // Setting was OK and lower then present setting. HearbeatManager should get
+  // that setting now.
+  hb_manager = mcs_client()->GetHeartbeatManagerForTesting();
+  EXPECT_TRUE(hb_manager->HasClientHeartbeatInterval());
+  EXPECT_EQ(other_interval_ms, hb_manager->GetClientHeartbeatIntervalMs());
+
+  mcs_client()->RemoveHeartbeatInterval(component_2);
+
+  BuildMCSClient();
+  InitializeClient();
+  LoginClientWithHeartbeat(std::vector<std::string>(), interval_ms);
+  PumpLoop();
+
+  // Heartbeat interval from component 1 is in effect at restart.
+  hb_manager = mcs_client()->GetHeartbeatManagerForTesting();
+  EXPECT_TRUE(hb_manager->HasClientHeartbeatInterval());
+  EXPECT_EQ(interval_ms, hb_manager->GetClientHeartbeatIntervalMs());
+
+  mcs_client()->RemoveHeartbeatInterval(component_1);
+
+  BuildMCSClient();
+  InitializeClient();
+  LoginClientWithHeartbeat(std::vector<std::string>(), 0);
+  PumpLoop();
+
+  // All of the intervals were removed, so nothing should be set on hb_manager
+  // after restart.
+  hb_manager = mcs_client()->GetHeartbeatManagerForTesting();
+  EXPECT_FALSE(hb_manager->HasClientHeartbeatInterval());
+}
+
 } // namespace
 
 }  // namespace gcm