Add support for GCM subtypes to desktop Instance ID implementation

google_apis/gcm/engine/unregistration_request_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 <stdint.h>
 #include <map>
 #include <string>
 #include <utility>
 #include <vector>
 
 #include "base/strings/string_number_conversions.h"
 #include "base/strings/string_tokenizer.h"
 #include "google_apis/gcm/engine/gcm_request_test_base.h"
 #include "google_apis/gcm/engine/gcm_unregistration_request_handler.h"
 #include "google_apis/gcm/engine/instance_id_delete_token_request_handler.h"
 #include "google_apis/gcm/monitoring/fake_gcm_stats_recorder.h"
 #include "net/base/load_flags.h"
 
 namespace gcm {
 
 namespace {
 const int kMaxRetries = 2;
 const uint64_t kAndroidId = 42UL;
 const char kLoginHeader[] = "AidLogin";
 const char kAppId[] = "TestAppId";
 const char kDeletedAppId[] = "deleted=TestAppId";
 const char kDeletedToken[] = "token=SomeToken";
+const char kProductCategoryForSubtypes[] = "com.chrome.macosx";
 const char kRegistrationURL[] = "http://foo.bar/register";
 const uint64_t kSecurityToken = 77UL;
 const int kGCMVersion = 40;
 const char kInstanceId[] = "IID1";
 const char kDeveloperId[] = "Project1";
 const char kScope[] = "GCM";
 
 }  // namespace
 
 class UnregistrationRequestTest : public GCMRequestTestBase {
@@ skipping 46 matching lines @@
   void CreateRequest();
 };
 
 GCMUnregistrationRequestTest::GCMUnregistrationRequestTest() {
 }
 
 GCMUnregistrationRequestTest::~GCMUnregistrationRequestTest() {
 }
 
 void GCMUnregistrationRequestTest::CreateRequest() {
-  UnregistrationRequest::RequestInfo request_info(
-      kAndroidId, kSecurityToken, kAppId);
+  UnregistrationRequest::RequestInfo request_info(kAndroidId, kSecurityToken,
+                                                  kAppId /* category */,
+                                                  std::string() /* subtype */);
   std::unique_ptr<GCMUnregistrationRequestHandler> request_handler(
       new GCMUnregistrationRequestHandler(kAppId));
   request_.reset(new UnregistrationRequest(
       GURL(kRegistrationURL), request_info, std::move(request_handler),
       GetBackoffPolicy(),
       base::Bind(&UnregistrationRequestTest::UnregistrationCallback,
                  base::Unretained(this)),
       max_retry_count_, url_request_context_getter(), &recorder_,
       std::string()));
 }
@@ skipping 17 matching lines @@
   fetcher->GetExtraRequestHeaders(&headers);
   std::string auth_header;
   headers.GetHeader(net::HttpRequestHeaders::kAuthorization, &auth_header);
   base::StringTokenizer auth_tokenizer(auth_header, " :");
   ASSERT_TRUE(auth_tokenizer.GetNext());
   EXPECT_EQ(kLoginHeader, auth_tokenizer.token());
   ASSERT_TRUE(auth_tokenizer.GetNext());
   EXPECT_EQ(base::Uint64ToString(kAndroidId), auth_tokenizer.token());
   ASSERT_TRUE(auth_tokenizer.GetNext());
   EXPECT_EQ(base::Uint64ToString(kSecurityToken), auth_tokenizer.token());
-  std::string app_id_header;
-  headers.GetHeader("app", &app_id_header);
-  EXPECT_EQ(kAppId, app_id_header);
 
   std::map<std::string, std::string> expected_pairs;
   expected_pairs["app"] = kAppId;
   expected_pairs["device"] = base::Uint64ToString(kAndroidId);
   expected_pairs["delete"] = "true";
   expected_pairs["gcm_unreg_caller"] = "false";
 
-  // Verify data was formatted properly.
-  std::string upload_data = fetcher->upload_data();
-  base::StringTokenizer data_tokenizer(upload_data, "&=");
-  while (data_tokenizer.GetNext()) {
-    std::map<std::string, std::string>::iterator iter =
-        expected_pairs.find(data_tokenizer.token());
-    ASSERT_TRUE(iter != expected_pairs.end()) << data_tokenizer.token();
-    ASSERT_TRUE(data_tokenizer.GetNext()) << data_tokenizer.token();
-    EXPECT_EQ(iter->second, data_tokenizer.token());
-    // Ensure that none of the keys appears twice.
-    expected_pairs.erase(iter);
-  }
-
-  EXPECT_EQ(0UL, expected_pairs.size());
+  ASSERT_NO_FATAL_FAILURE(VerifyFetcherUploadData(&expected_pairs));
 }
 
 TEST_F(GCMUnregistrationRequestTest, SuccessfulUnregistration) {
   set_max_retry_count(0);
   CreateRequest();
   request_->Start();
 
   SetResponse(net::HTTP_OK, kDeletedAppId);
   CompleteFetch();
 
@@ skipping 150 matching lines @@
 
   EXPECT_TRUE(callback_called_);
   EXPECT_EQ(UnregistrationRequest::REACHED_MAX_RETRIES, status_);
 }
 
 class InstaceIDDeleteTokenRequestTest : public UnregistrationRequestTest {
  public:
   InstaceIDDeleteTokenRequestTest();
   ~InstaceIDDeleteTokenRequestTest() override;
 
-  void CreateRequest(const std::string& instance_id,
+  void CreateRequest(bool use_subtype,
+                     const std::string& instance_id,
                      const std::string& authorized_entity,
                      const std::string& scope);
 };
 
 InstaceIDDeleteTokenRequestTest::InstaceIDDeleteTokenRequestTest() {
 }
 
 InstaceIDDeleteTokenRequestTest::~InstaceIDDeleteTokenRequestTest() {
 }
 
 void InstaceIDDeleteTokenRequestTest::CreateRequest(
+    bool use_subtype,
     const std::string& instance_id,
     const std::string& authorized_entity,
     const std::string& scope) {
-  UnregistrationRequest::RequestInfo request_info(
-      kAndroidId, kSecurityToken, kAppId);
+  std::string category = use_subtype ? kProductCategoryForSubtypes : kAppId;
+  std::string subtype = use_subtype ? kAppId : std::string();
+  UnregistrationRequest::RequestInfo request_info(kAndroidId, kSecurityToken,
+                                                  category, subtype);
   std::unique_ptr<InstanceIDDeleteTokenRequestHandler> request_handler(
       new InstanceIDDeleteTokenRequestHandler(instance_id, authorized_entity,
                                               scope, kGCMVersion));
   request_.reset(new UnregistrationRequest(
       GURL(kRegistrationURL), request_info, std::move(request_handler),
       GetBackoffPolicy(),
       base::Bind(&UnregistrationRequestTest::UnregistrationCallback,
                  base::Unretained(this)),
       max_retry_count(), url_request_context_getter(), &recorder_,
       std::string()));
 }
 
 TEST_F(InstaceIDDeleteTokenRequestTest, RequestDataPassedToFetcher) {
-  CreateRequest(kInstanceId, kDeveloperId, kScope);
+  CreateRequest(false /* use_subtype */, kInstanceId, kDeveloperId, kScope);
   request_->Start();
 
   // Get data sent by request.
   net::TestURLFetcher* fetcher = GetFetcher();
   ASSERT_TRUE(fetcher);
 
   EXPECT_EQ(GURL(kRegistrationURL), fetcher->GetOriginalURL());
 
   // Verify that authorization header was put together properly.
   net::HttpRequestHeaders headers;
   fetcher->GetExtraRequestHeaders(&headers);
   std::string auth_header;
   headers.GetHeader(net::HttpRequestHeaders::kAuthorization, &auth_header);
   base::StringTokenizer auth_tokenizer(auth_header, " :");
   ASSERT_TRUE(auth_tokenizer.GetNext());
   EXPECT_EQ(kLoginHeader, auth_tokenizer.token());
   ASSERT_TRUE(auth_tokenizer.GetNext());
   EXPECT_EQ(base::Uint64ToString(kAndroidId), auth_tokenizer.token());
   ASSERT_TRUE(auth_tokenizer.GetNext());
   EXPECT_EQ(base::Uint64ToString(kSecurityToken), auth_tokenizer.token());
-  std::string app_id_header;
-  headers.GetHeader("app", &app_id_header);
-  EXPECT_EQ(kAppId, app_id_header);
 
   std::map<std::string, std::string> expected_pairs;
   expected_pairs["gmsv"] = base::IntToString(kGCMVersion);
   expected_pairs["app"] = kAppId;
   expected_pairs["device"] = base::Uint64ToString(kAndroidId);
   expected_pairs["delete"] = "true";
   expected_pairs["appid"] = kInstanceId;
   expected_pairs["sender"] = kDeveloperId;
-  expected_pairs["X-subtype"] = kDeveloperId;
   expected_pairs["scope"] = kScope;
   expected_pairs["X-scope"] = kScope;
 
-  // Verify data was formatted properly.
-  std::string upload_data = fetcher->upload_data();
-  base::StringTokenizer data_tokenizer(upload_data, "&=");
-  while (data_tokenizer.GetNext()) {
-    std::map<std::string, std::string>::iterator iter =
-        expected_pairs.find(data_tokenizer.token());
-    ASSERT_TRUE(iter != expected_pairs.end()) << data_tokenizer.token();
-    ASSERT_TRUE(data_tokenizer.GetNext()) << data_tokenizer.token();
-    EXPECT_EQ(iter->second, data_tokenizer.token());
-    // Ensure that none of the keys appears twice.
-    expected_pairs.erase(iter);
-  }
+  ASSERT_NO_FATAL_FAILURE(VerifyFetcherUploadData(&expected_pairs));
+}
 
-  EXPECT_EQ(0UL, expected_pairs.size());
+TEST_F(InstaceIDDeleteTokenRequestTest, RequestDataWithSubtype) {
+  CreateRequest(true /* use_subtype */, kInstanceId, kDeveloperId, kScope);
+  request_->Start();
+
+  // Get data sent by request.
+  net::TestURLFetcher* fetcher = GetFetcher();
+  ASSERT_TRUE(fetcher);
+
+  // Same as RequestDataPassedToFetcher except "app" and "X-subtype".
+  std::map<std::string, std::string> expected_pairs;
+  expected_pairs["gmsv"] = base::IntToString(kGCMVersion);
+  expected_pairs["app"] = kProductCategoryForSubtypes;
+  expected_pairs["X-subtype"] = kAppId;
+  expected_pairs["device"] = base::Uint64ToString(kAndroidId);
+  expected_pairs["delete"] = "true";
+  expected_pairs["appid"] = kInstanceId;
+  expected_pairs["sender"] = kDeveloperId;
+  expected_pairs["scope"] = kScope;
+  expected_pairs["X-scope"] = kScope;
+
+  ASSERT_NO_FATAL_FAILURE(VerifyFetcherUploadData(&expected_pairs));
 }
 
 TEST_F(InstaceIDDeleteTokenRequestTest, SuccessfulUnregistration) {
-  CreateRequest(kInstanceId, kDeveloperId, kScope);
+  CreateRequest(false /* use_subtype */, kInstanceId, kDeveloperId, kScope);
   request_->Start();
 
   SetResponse(net::HTTP_OK, kDeletedToken);
   CompleteFetch();
 
   EXPECT_TRUE(callback_called_);
   EXPECT_EQ(UnregistrationRequest::SUCCESS, status_);
 }
 
 TEST_F(InstaceIDDeleteTokenRequestTest, ResponseHttpStatusNotOK) {
-  CreateRequest(kInstanceId, kDeveloperId, kScope);
+  CreateRequest(false /* use_subtype */, kInstanceId, kDeveloperId, kScope);
   request_->Start();
 
   SetResponse(net::HTTP_UNAUTHORIZED, "");
   CompleteFetch();
 
   EXPECT_FALSE(callback_called_);
 
   SetResponse(net::HTTP_OK, kDeletedToken);
   CompleteFetch();
 
   EXPECT_TRUE(callback_called_);
   EXPECT_EQ(UnregistrationRequest::SUCCESS, status_);
 }
 
 TEST_F(InstaceIDDeleteTokenRequestTest, InvalidParametersError) {
-  CreateRequest(kInstanceId, kDeveloperId, kScope);
+  CreateRequest(false /* use_subtype */, kInstanceId, kDeveloperId, kScope);
   request_->Start();
 
   SetResponse(net::HTTP_OK, "Error=INVALID_PARAMETERS");
   CompleteFetch();
 
   EXPECT_TRUE(callback_called_);
   EXPECT_EQ(UnregistrationRequest::INVALID_PARAMETERS, status_);
 }
 
 TEST_F(InstaceIDDeleteTokenRequestTest, UnkwnownError) {
-  CreateRequest(kInstanceId, kDeveloperId, kScope);
+  CreateRequest(false /* use_subtype */, kInstanceId, kDeveloperId, kScope);
   request_->Start();
 
   SetResponse(net::HTTP_OK, "Error=XXX");
   CompleteFetch();
 
   EXPECT_TRUE(callback_called_);
   EXPECT_EQ(UnregistrationRequest::UNKNOWN_ERROR, status_);
 }
 
 }  // namespace gcm