Signup for GCM upstream notifications

chrome/browser/chromeos/policy/heartbeat_scheduler_unittest.cc

 // Copyright (c) 2015 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 "chrome/browser/chromeos/policy/heartbeat_scheduler.h"
 
+#include "base/macros.h"
 #include "base/strings/string_number_conversions.h"
 #include "base/test/test_simple_task_runner.h"
 #include "chrome/browser/chromeos/settings/scoped_cros_settings_test_helper.h"
 #include "chromeos/settings/cros_settings_names.h"
+#include "components/gcm_driver/common/gcm_messages.h"
 #include "components/gcm_driver/fake_gcm_driver.h"
 #include "components/policy/core/common/cloud/cloud_policy_client.h"
 #include "components/policy/core/common/cloud/mock_cloud_policy_client.h"
 #include "content/public/test/test_utils.h"
+#include "net/base/ip_endpoint.h"
 #include "testing/gmock/include/gmock/gmock.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
 using ::testing::_;
+using ::testing::AnyNumber;
+using ::testing::AtLeast;
+using ::testing::Contains;
+using ::testing::Field;
+using ::testing::Key;
+using ::testing::Matches;
+using ::testing::Pair;
 using ::testing::SaveArg;
 
 namespace {
 const char* const kFakeEnrollmentDomain = "example.com";
 const char* const kFakeDeviceId = "fake_device_id";
 const char* const kHeartbeatGCMAppID = "com.google.chromeos.monitoring";
 const char* const kRegistrationId = "registration_id";
 const char* const kDMToken = "fake_dm_token";
 
+MATCHER(IsHeartbeatMsg, "") {
+  return Matches(
+      Field(&gcm::OutgoingMessage::data, Contains(Pair("type", "hb"))))(arg);
+}
+
+MATCHER(IsUpstreamNotificationMsg, "") {
+  return Matches(Field(&gcm::OutgoingMessage::data, Contains(Key("notify"))))(
+      arg);
+}
+
 class MockGCMDriver : public testing::StrictMock<gcm::FakeGCMDriver> {
  public:
   MockGCMDriver() {
   }
 
   ~MockGCMDriver() override {
   }
 
   MOCK_METHOD2(RegisterImpl,
                void(const std::string&, const std::vector<std::string>&));
   MOCK_METHOD3(SendImpl,
                void(const std::string&,
                     const std::string&,
                     const gcm::OutgoingMessage& message));
 
   // Helper function to complete a registration previously started by
   // Register().
   void CompleteRegistration(const std::string& app_id,
                             gcm::GCMClient::Result result) {
     RegisterFinished(app_id, kRegistrationId, result);
   }
 
   // Helper function to complete a send operation previously started by
   // Send().
   void CompleteSend(const std::string& app_id,
                     const std::string& message_id,
                     gcm::GCMClient::Result result) {
     SendFinished(app_id, message_id, result);
   }
+
+  void AddConnectionObserver(gcm::GCMConnectionObserver* observer) override {
+    EXPECT_FALSE(observer_);
+    observer_ = observer;
+  }
+
+  void RemoveConnectionObserver(gcm::GCMConnectionObserver* observer) override {
+    EXPECT_TRUE(observer_);
+    observer_ = nullptr;
+  }
+
+  void NotifyConnected() {
+    ASSERT_TRUE(observer_);
+    observer_->OnConnected(net::IPEndPoint());
+  }
+
+ private:
+  gcm::GCMConnectionObserver* observer_ = nullptr;
+
+  DISALLOW_COPY_AND_ASSIGN(MockGCMDriver);
 };
 
 class HeartbeatSchedulerTest : public testing::Test {
  public:
   HeartbeatSchedulerTest()
       : task_runner_(new base::TestSimpleTaskRunner()),
         scheduler_(&gcm_driver_,
                    &cloud_policy_client_,
                    kFakeEnrollmentDomain,
                    kFakeDeviceId,
@@ skipping 22 matching lines @@
     // smaller than |expected_delay|.
     //
     // We do know that the task was posted sometime between |last_heartbeat|
     // and |now|, so we know that 0 <= |expected_delay| - |actual_delay| <=
     // |now| - |last_heartbeat|.
     base::TimeDelta delta = expected_delay - actual_delay;
     EXPECT_LE(base::TimeDelta(), delta);
     EXPECT_GE(now - last_heartbeat, delta);
   }
 
+  void IgnoreUpstreamNotificationMsg() {
+    EXPECT_CALL(gcm_driver_,
+                SendImpl(kHeartbeatGCMAppID, _, IsUpstreamNotificationMsg()))
+        .Times(AnyNumber());
+  }
+
   base::MessageLoop loop_;
   MockGCMDriver gcm_driver_;
   chromeos::ScopedCrosSettingsTestHelper settings_helper_;
   testing::NiceMock<policy::MockCloudPolicyClient> cloud_policy_client_;
 
   // TaskRunner used to run individual tests.
   scoped_refptr<base::TestSimpleTaskRunner> task_runner_;
 
   // The HeartbeatScheduler instance under test.
   policy::HeartbeatScheduler scheduler_;
@@ skipping 11 matching lines @@
   EXPECT_CALL(gcm_driver_, RegisterImpl(kHeartbeatGCMAppID, _));
   settings_helper_.SetBoolean(chromeos::kHeartbeatEnabled, true);
   gcm_driver_.CompleteRegistration(
       kHeartbeatGCMAppID, gcm::GCMClient::GCM_DISABLED);
 
   // There should be no heartbeat tasks pending, because registration failed.
   ASSERT_TRUE(task_runner_->GetPendingTasks().empty());
 }
 
 TEST_F(HeartbeatSchedulerTest, TemporarilyFailedGCMRegistration) {
+  IgnoreUpstreamNotificationMsg();
+
   EXPECT_CALL(gcm_driver_, RegisterImpl(kHeartbeatGCMAppID, _));
   settings_helper_.SetBoolean(chromeos::kHeartbeatEnabled, true);
   gcm_driver_.CompleteRegistration(
       kHeartbeatGCMAppID, gcm::GCMClient::SERVER_ERROR);
   testing::Mock::VerifyAndClearExpectations(&gcm_driver_);
 
+  IgnoreUpstreamNotificationMsg();
+
   // Should have a pending task to try registering again.
   ASSERT_FALSE(task_runner_->GetPendingTasks().empty());
   EXPECT_CALL(gcm_driver_, RegisterImpl(kHeartbeatGCMAppID, _));
   task_runner_->RunPendingTasks();
   testing::Mock::VerifyAndClearExpectations(&gcm_driver_);
 
+  IgnoreUpstreamNotificationMsg();
+
   // Once we have successfully registered, we should send a heartbeat.
-  EXPECT_CALL(gcm_driver_, SendImpl(kHeartbeatGCMAppID, _, _));
+  EXPECT_CALL(gcm_driver_, SendImpl(kHeartbeatGCMAppID, _, IsHeartbeatMsg()));
   gcm_driver_.CompleteRegistration(
       kHeartbeatGCMAppID, gcm::GCMClient::SUCCESS);
   task_runner_->RunPendingTasks();
 }
 
 TEST_F(HeartbeatSchedulerTest, ChangeHeartbeatFrequency) {
+  IgnoreUpstreamNotificationMsg();
+
   EXPECT_CALL(gcm_driver_, RegisterImpl(kHeartbeatGCMAppID, _));
   settings_helper_.SetBoolean(chromeos::kHeartbeatEnabled, true);
   gcm_driver_.CompleteRegistration(
       kHeartbeatGCMAppID, gcm::GCMClient::SUCCESS);
 
   EXPECT_EQ(1U, task_runner_->GetPendingTasks().size());
   // Should have a heartbeat task posted with zero delay on startup.
   EXPECT_EQ(base::TimeDelta(), task_runner_->NextPendingTaskDelay());
   testing::Mock::VerifyAndClearExpectations(&gcm_driver_);
 
+  IgnoreUpstreamNotificationMsg();
+
   const int new_delay = 1234*1000;  // 1234 seconds.
   settings_helper_.SetInteger(chromeos::kHeartbeatFrequency, new_delay);
   // Now run pending heartbeat task, should send a heartbeat.
   gcm::OutgoingMessage message;
-  EXPECT_CALL(gcm_driver_, SendImpl(kHeartbeatGCMAppID, _, _))
+  EXPECT_CALL(gcm_driver_, SendImpl(kHeartbeatGCMAppID, _, IsHeartbeatMsg()))
       .WillOnce(SaveArg<2>(&message));
   task_runner_->RunPendingTasks();
   EXPECT_TRUE(task_runner_->GetPendingTasks().empty());
 
   // Complete sending a message - we should queue up the next heartbeat
   // even if the previous attempt failed.
   gcm_driver_.CompleteSend(
       kHeartbeatGCMAppID, message.id, gcm::GCMClient::SERVER_ERROR);
   EXPECT_EQ(1U, task_runner_->GetPendingTasks().size());
   CheckPendingTaskDelay(scheduler_.last_heartbeat(),
                         base::TimeDelta::FromMilliseconds(new_delay));
 }
 
 TEST_F(HeartbeatSchedulerTest, DisableHeartbeats) {
+  IgnoreUpstreamNotificationMsg();
+
   // Makes sure that we can disable heartbeats on the fly.
   EXPECT_CALL(gcm_driver_, RegisterImpl(kHeartbeatGCMAppID, _));
   settings_helper_.SetBoolean(chromeos::kHeartbeatEnabled, true);
   gcm::OutgoingMessage message;
-  EXPECT_CALL(gcm_driver_, SendImpl(kHeartbeatGCMAppID, _, _))
+  EXPECT_CALL(gcm_driver_, SendImpl(kHeartbeatGCMAppID, _, IsHeartbeatMsg()))
       .WillOnce(SaveArg<2>(&message));
   gcm_driver_.CompleteRegistration(
       kHeartbeatGCMAppID, gcm::GCMClient::SUCCESS);
   // Should have a heartbeat task posted.
   EXPECT_EQ(1U, task_runner_->GetPendingTasks().size());
   task_runner_->RunPendingTasks();
 
   // Complete sending a message - we should queue up the next heartbeat.
   gcm_driver_.CompleteSend(
       kHeartbeatGCMAppID, message.id, gcm::GCMClient::SUCCESS);
 
   // Should have a new heartbeat task posted.
   ASSERT_EQ(1U, task_runner_->GetPendingTasks().size());
   CheckPendingTaskDelay(
       scheduler_.last_heartbeat(),
       base::TimeDelta::FromMilliseconds(
           policy::HeartbeatScheduler::kDefaultHeartbeatIntervalMs));
   testing::Mock::VerifyAndClearExpectations(&gcm_driver_);
 
+  IgnoreUpstreamNotificationMsg();

[Andrew T Wilson (Slow), 2015/11/18 11:43:32]

Why is this required? How many notification messages are we sending up?

[binjin, 2015/11/19 05:50:27]

I didn't consider much, I just add one call after each occurrence of
VerifyAndClearExpectations().

+
   // Now disable heartbeats. Should get no more heartbeats sent.
   settings_helper_.SetBoolean(chromeos::kHeartbeatEnabled, false);
   task_runner_->RunPendingTasks();
   EXPECT_TRUE(task_runner_->GetPendingTasks().empty());
 }
 
 TEST_F(HeartbeatSchedulerTest, CheckMessageContents) {
+  IgnoreUpstreamNotificationMsg();
+
   gcm::OutgoingMessage message;
   EXPECT_CALL(gcm_driver_, RegisterImpl(kHeartbeatGCMAppID, _));
-  EXPECT_CALL(gcm_driver_, SendImpl(kHeartbeatGCMAppID, _, _))
+  EXPECT_CALL(gcm_driver_, SendImpl(kHeartbeatGCMAppID, _, IsHeartbeatMsg()))
       .WillOnce(SaveArg<2>(&message));
   settings_helper_.SetBoolean(chromeos::kHeartbeatEnabled, true);
   gcm_driver_.CompleteRegistration(
       kHeartbeatGCMAppID, gcm::GCMClient::SUCCESS);
   task_runner_->RunPendingTasks();
 
   // Heartbeats should have a time-to-live equivalent to the heartbeat frequency
   // so we don't have more than one heartbeat queued at a time.
   EXPECT_EQ(policy::HeartbeatScheduler::kDefaultHeartbeatIntervalMs/1000,
             message.time_to_live);
 
   // Check the values in the message payload.
   EXPECT_EQ("hb", message.data["type"]);
   int64 timestamp;
   EXPECT_TRUE(base::StringToInt64(message.data["timestamp"], &timestamp));
   EXPECT_EQ(kFakeEnrollmentDomain, message.data["domain_name"]);
   EXPECT_EQ(kFakeDeviceId, message.data["device_id"]);
 }
 
 TEST_F(HeartbeatSchedulerTest, SendGcmIdUpdate) {
   // Verifies that GCM id update request was sent after GCM registration.
   cloud_policy_client_.SetDMToken(kDMToken);
   policy::CloudPolicyClient::StatusCallback callback;
   EXPECT_CALL(cloud_policy_client_, UpdateGcmId(kRegistrationId, _))
       .WillOnce(SaveArg<1>(&callback));
 
   // Enable heartbeats.
   EXPECT_CALL(gcm_driver_, RegisterImpl(kHeartbeatGCMAppID, _));
-  EXPECT_CALL(gcm_driver_, SendImpl(kHeartbeatGCMAppID, _, _));
+  EXPECT_CALL(gcm_driver_, SendImpl(kHeartbeatGCMAppID, _, _))
+      .Times(AtLeast(1));
   settings_helper_.SetBoolean(chromeos::kHeartbeatEnabled, true);
   gcm_driver_.CompleteRegistration(kHeartbeatGCMAppID, gcm::GCMClient::SUCCESS);
   task_runner_->RunPendingTasks();
 
   // Verifies that CloudPolicyClient got the update request, with a valid
   // callback.
   testing::Mock::VerifyAndClearExpectations(&cloud_policy_client_);
   EXPECT_FALSE(callback.is_null());
   callback.Run(true);
 }
 
+TEST_F(HeartbeatSchedulerTest, GcmUpstreamNotificationSignup) {
+  // Verifies that upstream notification works as expected.
+  cloud_policy_client_.SetDMToken(kDMToken);
+  EXPECT_CALL(gcm_driver_, RegisterImpl(kHeartbeatGCMAppID, _))
+      .Times(AnyNumber());
+  EXPECT_CALL(cloud_policy_client_, UpdateGcmId(kRegistrationId, _));
+
+  // GCM connected event before the registration should be ignored.
+  settings_helper_.SetBoolean(chromeos::kHeartbeatEnabled, true);
+  gcm_driver_.NotifyConnected();
+  task_runner_->RunPendingTasks();
+  testing::Mock::VerifyAndClearExpectations(&gcm_driver_);
+
+  // Ignore unintested calls.
+  EXPECT_CALL(gcm_driver_, RegisterImpl(kHeartbeatGCMAppID, _))
+      .Times(AnyNumber());
+  EXPECT_CALL(gcm_driver_, SendImpl(kHeartbeatGCMAppID, _, IsHeartbeatMsg()))
+      .Times(AnyNumber());
+
+  EXPECT_CALL(gcm_driver_,
+              SendImpl(kHeartbeatGCMAppID, _, IsUpstreamNotificationMsg()))
+      .Times(AtLeast(1));
+  gcm_driver_.CompleteRegistration(kHeartbeatGCMAppID, gcm::GCMClient::SUCCESS);
+
+  gcm_driver_.NotifyConnected();
+}
+
 }  // namespace