Record connection, registration, and receiving activities.

google_apis/gcm/monitoring/gcm_stats_recorder_unittest.cc

Index: google_apis/gcm/monitoring/gcm_stats_recorder_unittest.cc
diff --git a/google_apis/gcm/monitoring/gcm_stats_recorder_unittest.cc b/google_apis/gcm/monitoring/gcm_stats_recorder_unittest.cc
index 488b31b1a37428a786b8ee5ccf61f2e45be91c13..ccf3caf2186a4963e8dc9a46f702d0796d5e3e3b 100644
--- a/google_apis/gcm/monitoring/gcm_stats_recorder_unittest.cc
+++ b/google_apis/gcm/monitoring/gcm_stats_recorder_unittest.cc
@@ -6,6 +6,7 @@
 
 #include <deque>
 #include <string>
+#include <vector>
 
 #include "google_apis/gcm/engine/mcs_client.h"
 #include "testing/gtest/include/gtest/gtest.h"
@@ -14,7 +15,10 @@ namespace gcm {
 
 namespace {
 
+static const char kHost[] = "www.example.com";
 static const char kAppId[] = "app id 1";
+static const char kFrom[] = "from";
+static const char kSenderIds[] = "s1,s2";
 static const char kReceiverId[] = "receiver 1";
 static const char kMessageId[] = "message id 1";
 static const int kQueuedSec = 5;
@@ -22,6 +26,55 @@ static const gcm::MCSClient::MessageSendStatus kMessageSendStatus =
     gcm::MCSClient::QUEUED;
 static const int kByteSize = 99;
 static const int kTTL = 7;
+static const int kRetries = 3;
+static const int64 kDelay = 15000;
+static const ConnectionFactory::ConnectionResetReason kReason =
+    ConnectionFactory::NETWORK_CHANGE;
+static const int kNetworkError = 1;
+
+static const RegistrationRequest::Status kRegistrationStatus =
+    RegistrationRequest::SUCCESS;
+static const UnregistrationRequest::Status kUnregistrationStatus =
+    UnregistrationRequest::SUCCESS;
+
+static const char kConnectionInitiatedEvent[] = "Connection initiated";
+static const char kConnectionInitiatedDetails[] = "www.example.com";
+static const char kConnectionDelayedDueToBackoffEvent[] = "Connection backoff";
+static const char kConnectionDelayedDueToBackoffDetails[] =
+    "Delayed for 15000 msec";
+static const char kConnectionSuccessEvent[] = "Connection succeeded";
+static const char kConnectionSuccessDetails[] = "";
+static const char kConnectionFailureEvent[] = "Connection failed";
+static const char kConnectionFailureDetails[] = "With network error 1";
+static const char kConnectionResetSignaledEvent[] = "Connection reset";
+static const char kConnectionResetSignaledDetails[] = "NETWORK_CHANGE";
+
+static const char kRegistrationSentEvent[] = "Registration request sent";
+static const char kRegistrationSentDetails[] = "";
+static const char kRegistrationResponseEvent[] =
+    "Registration response received";
+static const char kRegistrationResponseDetails[] = "SUCCESS";
+static const char kRegistrationRetryRequestedEvent[] =
+    "Registration retry requested";
+static const char kRegistrationRetryRequestedDetails[] = "Retries left: 3";
+static const char kUnregistrationSentEvent[] = "Unregistration request sent";
+static const char kUnregistrationSentDetails[] = "";
+static const char kUnregistrationResponseEvent[] =
+    "Unregistration response received";
+static const char kUnregistrationResponseDetails[] = "SUCCESS";
+static const char kUnregistrationRetryDelayedEvent[] =
+    "Unregistration retry delayed";
+static const char kUnregistrationRetryDelayedDetails[] =
+    "Delayed for 15000 msec";
+
+static const char kDataReceivedEvent[] = "Data msg received";
+static const char kDataReceivedDetails[] = "";
+static const char kDataReceivedNotRegisteredEvent[] = "Data msg received";
+static const char kDataReceivedNotRegisteredDetails[] =
+    "No such registered app found";
+static const char kDataDeletedMessageEvent[] = "Data msg received";
+static const char kDataDeletedMessageDetails[] =
+    "Message has been deleted on server";
 
 static const char kDataSentToWireEvent[] = "Data msg sent to wire";
 static const char kSentToWireDetails[] = "Msg queued for 5 seconds";
@@ -38,36 +91,186 @@ class GCMStatsRecorderTest : public testing::Test {
   virtual ~GCMStatsRecorderTest();
   virtual void SetUp() OVERRIDE;
 
+  void VerifyRecordedConnectionCount(int expected_count) {
+    EXPECT_EQ(expected_count,
+              static_cast<int>(recorder_.connection_activities().size()));
+  }
+  void VerifyRecordedRegistrationCount(int expected_count) {
+    EXPECT_EQ(expected_count,
+              static_cast<int>(recorder_.registration_activities().size()));
+  }
+  void VerifyRecordedReceivingCount(int expected_count) {
+    EXPECT_EQ(expected_count,
+              static_cast<int>(recorder_.receiving_activities().size()));
+  }
   void VerifyRecordedSendingCount(int expected_count) {
     EXPECT_EQ(expected_count,
               static_cast<int>(recorder_.sending_activities().size()));
   }
 
-  void VerifyDataSentToWire(const std::string& remark){
-    VerifyData(recorder_.sending_activities(),
-               kDataSentToWireEvent,
-               kSentToWireDetails,
-               remark);
+  void VerifyConnectionInitiated(const std::string& remark) {
+    VerifyConnection(recorder_.connection_activities(),
+                     kConnectionInitiatedEvent,
+                     kConnectionInitiatedDetails,
+                     remark);
+  }
+
+  void VerifyConnectionDelayedDueToBackoff(const std::string& remark) {
+    VerifyConnection(recorder_.connection_activities(),
+                     kConnectionDelayedDueToBackoffEvent,
+                     kConnectionDelayedDueToBackoffDetails,
+                     remark);
+  }
+
+  void VerifyConnectionSuccess(const std::string& remark) {
+    VerifyConnection(recorder_.connection_activities(),
+                     kConnectionSuccessEvent,
+                     kConnectionSuccessDetails,
+                     remark);
+  }
+
+  void VerifyConnectionFailure(const std::string& remark) {
+    VerifyConnection(recorder_.connection_activities(),
+                     kConnectionFailureEvent,
+                     kConnectionFailureDetails,
+                     remark);
+  }
+
+  void VerifyConnectionResetSignaled(const std::string& remark) {
+    VerifyConnection(recorder_.connection_activities(),
+                     kConnectionResetSignaledEvent,
+                     kConnectionResetSignaledDetails,
+                     remark);
   }
 
-  void VerifyNotifySendStatus(const std::string& remark){
-    VerifyData(recorder_.sending_activities(),
-               kNotifySendStatusEvent,
-               kNotifySendStatusDetails,
-               remark);
+  void VerifyRegistrationSent(const std::string& remark) {
+    VerifyRegistration(recorder_.registration_activities(),
+                       kSenderIds,
+                       kRegistrationSentEvent,
+                       kRegistrationSentDetails,
+                       remark);
   }
 
-  void VerifyIncomingSendError(const std::string& remark){
-    VerifyData(recorder_.sending_activities(),
-               kIncomingSendErrorEvent,
-               kIncomingSendErrorDetails,
-               remark);
+  void VerifyRegistrationResponse(const std::string& remark) {
+    VerifyRegistration(recorder_.registration_activities(),
+                       kSenderIds,
+                       kRegistrationResponseEvent,
+                       kRegistrationResponseDetails,
+                       remark);
+  }
+
+  void VerifyRegistrationRetryRequested(const std::string& remark) {
+    VerifyRegistration(recorder_.registration_activities(),
+                       kSenderIds,
+                       kRegistrationRetryRequestedEvent,
+                       kRegistrationRetryRequestedDetails,
+                       remark);
+  }
+
+  void VerifyUnregistrationSent(const std::string& remark) {
+    VerifyRegistration(recorder_.registration_activities(),
+                       std::string(),
+                       kUnregistrationSentEvent,
+                       kUnregistrationSentDetails,
+                       remark);
+  }
+
+  void VerifyUnregistrationResponse(const std::string& remark) {
+    VerifyRegistration(recorder_.registration_activities(),
+                       std::string(),
+                       kUnregistrationResponseEvent,
+                       kUnregistrationResponseDetails,
+                       remark);
+  }
+
+  void VerifyUnregistrationRetryDelayed(const std::string& remark) {
+    VerifyRegistration(recorder_.registration_activities(),
+                       std::string(),
+                       kUnregistrationRetryDelayedEvent,
+                       kUnregistrationRetryDelayedDetails,
+                       remark);
+  }
+
+  void VerifyDataMessageRecieved(const std::string& remark) {
+    VerifyReceivingData(recorder_.receiving_activities(),
+                        kDataReceivedEvent,
+                        kDataReceivedDetails,
+                        remark);
+  }
+
+  void VerifyDataDeletedMessage(const std::string& remark) {
+    VerifyReceivingData(recorder_.receiving_activities(),
+                        kDataDeletedMessageEvent,
+                        kDataDeletedMessageDetails,
+                        remark);
+  }
+
+  void VerifyDataMessageRecievedNotRegistered(const std::string& remark) {
+    VerifyReceivingData(recorder_.receiving_activities(),
+                        kDataReceivedNotRegisteredEvent,
+                        kDataReceivedNotRegisteredDetails,
+                        remark);
+  }
+
+  void VerifyDataSentToWire(const std::string& remark) {
+    VerifySendingData(recorder_.sending_activities(),
+                      kDataSentToWireEvent,
+                      kSentToWireDetails,
+                      remark);
+  }
+
+  void VerifyNotifySendStatus(const std::string& remark) {
+    VerifySendingData(recorder_.sending_activities(),
+                      kNotifySendStatusEvent,
+                      kNotifySendStatusDetails,
+                      remark);
+  }
+
+  void VerifyIncomingSendError(const std::string& remark) {
+    VerifySendingData(recorder_.sending_activities(),
+                      kIncomingSendErrorEvent,
+                      kIncomingSendErrorDetails,
+                      remark);
   }
 
  protected:
-  template <typename T>
-  void VerifyData(const std::deque<T>& queue, const std::string& event,
-                  const std::string& details, const std::string& remark) {
+  void VerifyConnection(
+      const std::deque<GCMStatsRecorder::ConnectionActivity>& queue,
+      const std::string& event,
+      const std::string& details,
+      const std::string& remark) {
+    EXPECT_EQ(event, queue.front().event) << remark;
+    EXPECT_EQ(details, queue.front().details) << remark;
+  }
+
+  void VerifyRegistration(
+      const std::deque<GCMStatsRecorder::RegistrationActivity>& queue,
+      const std::string& sender_ids,
+      const std::string& event,
+      const std::string& details,
+      const std::string& remark) {
+    EXPECT_EQ(kAppId, queue.front().app_id) << remark;
+    EXPECT_EQ(sender_ids, queue.front().sender_ids) << remark;
+    EXPECT_EQ(event, queue.front().event) << remark;
+    EXPECT_EQ(details, queue.front().details) << remark;
+  }
+
+  void VerifyReceivingData(
+      const std::deque<GCMStatsRecorder::ReceivingActivity>& queue,
+      const std::string& event,
+      const std::string& details,
+      const std::string& remark) {
+    EXPECT_EQ(kAppId, queue.front().app_id) << remark;
+    EXPECT_EQ(kFrom, queue.front().from) << remark;
+    EXPECT_EQ(kByteSize, queue.front().message_byte_size) << remark;
+    EXPECT_EQ(event, queue.front().event) << remark;
+    EXPECT_EQ(details, queue.front().details) << remark;
+  }
+
+  void VerifySendingData(
+      const std::deque<GCMStatsRecorder::SendingActivity>& queue,
+      const std::string& event, const std::string& details,
+      const std::string& remark) {
     EXPECT_EQ(kAppId, queue.front().app_id) << remark;
     EXPECT_EQ(kReceiverId, queue.front().receiver_id) << remark;
     EXPECT_EQ(kMessageId, queue.front().message_id) << remark;
@@ -75,6 +278,7 @@ class GCMStatsRecorderTest : public testing::Test {
     EXPECT_EQ(details, queue.front().details) << remark;
   }
 
+  std::vector<std::string> sender_ids_;
   GCMStatsRecorder recorder_;
 };
 
@@ -84,6 +288,8 @@ GCMStatsRecorderTest::GCMStatsRecorderTest(){
 GCMStatsRecorderTest::~GCMStatsRecorderTest() {}
 
 void GCMStatsRecorderTest::SetUp(){
+  sender_ids_.push_back("s1");
+  sender_ids_.push_back("s2");
   recorder_.SetRecording(true);
 }
 
@@ -114,6 +320,72 @@ TEST_F(GCMStatsRecorderTest, ClearLogTest) {
   VerifyRecordedSendingCount(0);
 }
 
+TEST_F(GCMStatsRecorderTest, ConnectionTest) {
+  recorder_.RecordConnectionInitiated(kHost);
+  VerifyRecordedConnectionCount(1);
+  VerifyConnectionInitiated("1st call");
+
+  recorder_.RecordConnectionDelayedDueToBackoff(kDelay);
+  VerifyRecordedConnectionCount(2);
+  VerifyConnectionDelayedDueToBackoff("2nd call");
+
+  recorder_.RecordConnectionSuccess();
+  VerifyRecordedConnectionCount(3);
+  VerifyConnectionSuccess("3rd call");
+
+  recorder_.RecordConnectionFailure(kNetworkError);
+  VerifyRecordedConnectionCount(4);
+  VerifyConnectionFailure("4th call");
+
+  recorder_.RecordConnectionResetSignaled(kReason);
+  VerifyRecordedConnectionCount(5);
+  VerifyConnectionResetSignaled("5th call");
+}
+
+TEST_F(GCMStatsRecorderTest, RegistrationTest) {
+  recorder_.RecordRegistrationSent(kAppId, kSenderIds);
+  VerifyRecordedRegistrationCount(1);
+  VerifyRegistrationSent("1st call");
+
+  recorder_.RecordRegistrationResponse(kAppId, sender_ids_,
+                                       kRegistrationStatus);
+  VerifyRecordedRegistrationCount(2);
+  VerifyRegistrationResponse("2nd call");
+
+  recorder_.RecordRegistrationRetryRequested(kAppId, sender_ids_, kRetries);
+  VerifyRecordedRegistrationCount(3);
+  VerifyRegistrationRetryRequested("3rd call");
+
+  recorder_.RecordUnregistrationSent(kAppId);
+  VerifyRecordedRegistrationCount(4);
+  VerifyUnregistrationSent("4th call");
+
+  recorder_.RecordUnregistrationResponse(kAppId, kUnregistrationStatus);
+  VerifyRecordedRegistrationCount(5);
+  VerifyUnregistrationResponse("5th call");
+
+  recorder_.RecordUnregistrationRetryDelayed(kAppId, kDelay);
+  VerifyRecordedRegistrationCount(6);
+  VerifyUnregistrationRetryDelayed("6th call");
+}
+
+TEST_F(GCMStatsRecorderTest, RecordReceivingTest) {
+  recorder_.RecordDataMessageRecieved(kAppId, kFrom, kByteSize, true,
+                                      GCMStatsRecorder::DATA_MESSAGE);
+  VerifyRecordedReceivingCount(1);
+  VerifyDataMessageRecieved("1st call");
+
+  recorder_.RecordDataMessageRecieved(kAppId, kFrom, kByteSize, true,
+                                      GCMStatsRecorder::DELETED_MESSAGES);
+  VerifyRecordedReceivingCount(2);
+  VerifyDataDeletedMessage("2nd call");
+
+  recorder_.RecordDataMessageRecieved(kAppId, kFrom, kByteSize, false,
+                                      GCMStatsRecorder::DATA_MESSAGE);
+  VerifyRecordedReceivingCount(3);
+  VerifyDataMessageRecievedNotRegistered("3rd call");
+}
+
 TEST_F(GCMStatsRecorderTest, RecordSendingTest) {
   recorder_.RecordDataSentToWire(kAppId, kReceiverId, kMessageId, kQueuedSec);
   VerifyRecordedSendingCount(1);