Adding NetLog support to SafeBrowsingPingManager.

chrome/browser/safe_browsing/ping_manager_unittest.cc

 // Copyright (c) 2012 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 "base/base64.h"
 #include "base/logging.h"
 #include "base/strings/stringprintf.h"
 #include "base/time/time.h"
+#include "base/values.h"
 #include "chrome/browser/safe_browsing/ping_manager.h"
 #include "google_apis/google_api_keys.h"
 #include "net/base/escape.h"
+#include "net/log/net_log.h"
+#include "net/log/net_log_source_type.h"
+#include "net/log/test_net_log.h"
+#include "net/log/test_net_log_entry.h"
+#include "net/url_request/test_url_fetcher_factory.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
 using base::Time;
 using base::TimeDelta;
 using safe_browsing::HitReport;
 using safe_browsing::ThreatSource;
 
 static const char kUrlPrefix[] = "https://prefix.com/foo";
 static const char kClient[] = "unittest";
 static const char kAppVer[] = "1.0";
 
 namespace safe_browsing {
 
 class SafeBrowsingPingManagerTest : public testing::Test {
+ public:
+  SafeBrowsingPingManagerTest()
+      : net_log_(new net::TestNetLog()) {
+    net_log_with_source_ = net::NetLogWithSource::Make(
+        net_log_.get(), net::NetLogSourceType::SAFE_BROWSING);
+  }
+
  protected:
-  std::string key_param_;
-
   void SetUp() override {
     std::string key = google_apis::GetAPIKey();
     if (!key.empty()) {
       key_param_ = base::StringPrintf(
           "&key=%s",
           net::EscapeQueryParamValue(key, true).c_str());
     }
+
+    SafeBrowsingProtocolConfig config;
+    config.client_name = kClient;
+    config.url_prefix = kUrlPrefix;
+    ping_manager_.reset(new SafeBrowsingPingManager(NULL, config));
+    ping_manager_->version_ = kAppVer;
+    ping_manager_->net_log_ = net_log_with_source_;
   }
+
+  SafeBrowsingPingManager* ping_manager()  {
+    return ping_manager_.get();
+  }
+
+  std::string key_param_;
+  std::unique_ptr<net::TestNetLog> net_log_;
+  net::NetLogWithSource net_log_with_source_;
+  net::TestURLFetcherFactory fetcher_factory_;
+  std::unique_ptr<SafeBrowsingPingManager> ping_manager_;
 };
 
 TEST_F(SafeBrowsingPingManagerTest, TestSafeBrowsingHitUrl) {
-  SafeBrowsingProtocolConfig config;
-  config.client_name = kClient;
-  config.url_prefix = kUrlPrefix;
-  SafeBrowsingPingManager pm(NULL, config);
-  pm.version_ = kAppVer;
-
   HitReport base_hp;
   base_hp.malicious_url = GURL("http://malicious.url.com");
   base_hp.page_url = GURL("http://page.url.com");
   base_hp.referrer_url = GURL("http://referrer.url.com");
 
   {
     HitReport hp(base_hp);
     hp.threat_type = SB_THREAT_TYPE_URL_MALWARE;
     hp.threat_source = ThreatSource::LOCAL_PVER3;
     hp.is_subresource = true;
     hp.is_extended_reporting = true;
     hp.is_metrics_reporting_active = true;
 
     EXPECT_EQ(
         "https://prefix.com/foo/report?client=unittest&appver=1.0&"
         "pver=3.0" +
             key_param_ +
             "&ext=1&evts=malblhit&evtd=http%3A%2F%2Fmalicious.url.com%2F&"
             "evtr=http%3A%2F%2Fpage.url.com%2F&evhr=http%3A%2F%2Freferrer."
             "url.com%2F&evtb=1&src=l3&m=1",
-        pm.SafeBrowsingHitUrl(hp).spec());
+        ping_manager()->SafeBrowsingHitUrl(hp).spec());
   }
 
   {
     HitReport hp(base_hp);
     hp.threat_type = SB_THREAT_TYPE_URL_PHISHING;
     hp.threat_source = ThreatSource::DATA_SAVER;
     hp.is_subresource = false;
     hp.is_extended_reporting = true;
     hp.is_metrics_reporting_active = true;
     EXPECT_EQ(
         "https://prefix.com/foo/report?client=unittest&appver=1.0&"
         "pver=3.0" +
             key_param_ +
             "&ext=1&evts=phishblhit&"
             "evtd=http%3A%2F%2Fmalicious.url.com%2F&"
             "evtr=http%3A%2F%2Fpage.url.com%2F&evhr=http%3A%2F%2Freferrer."
             "url.com%2F&evtb=0&src=ds&m=1",
-        pm.SafeBrowsingHitUrl(hp).spec());
+        ping_manager()->SafeBrowsingHitUrl(hp).spec());
   }
 
   {
     HitReport hp(base_hp);
     hp.threat_type = SB_THREAT_TYPE_BINARY_MALWARE_URL;
     hp.threat_source = ThreatSource::REMOTE;
     hp.is_extended_reporting = false;
     hp.is_metrics_reporting_active = true;
     hp.is_subresource = false;
     EXPECT_EQ(
         "https://prefix.com/foo/report?client=unittest&appver=1.0&"
         "pver=3.0" +
             key_param_ +
             "&ext=0&evts=binurlhit&"
             "evtd=http%3A%2F%2Fmalicious.url.com%2F&"
             "evtr=http%3A%2F%2Fpage.url.com%2F&evhr=http%3A%2F%2Freferrer."
             "url.com%2F&evtb=0&src=rem&m=1",
-        pm.SafeBrowsingHitUrl(hp).spec());
+        ping_manager()->SafeBrowsingHitUrl(hp).spec());
   }
 
   {
     HitReport hp(base_hp);
     hp.threat_type = SB_THREAT_TYPE_CLIENT_SIDE_PHISHING_URL;
     hp.threat_source = ThreatSource::LOCAL_PVER4;
     hp.is_extended_reporting = false;
     hp.is_metrics_reporting_active = false;
     hp.is_subresource = false;
     EXPECT_EQ(
         "https://prefix.com/foo/report?client=unittest&appver=1.0&"
         "pver=3.0" +
             key_param_ +
             "&ext=0&evts=phishcsdhit&"
             "evtd=http%3A%2F%2Fmalicious.url.com%2F&"
             "evtr=http%3A%2F%2Fpage.url.com%2F&evhr=http%3A%2F%2Freferrer."
             "url.com%2F&evtb=0&src=l4&m=0",
-        pm.SafeBrowsingHitUrl(hp).spec());
+        ping_manager()->SafeBrowsingHitUrl(hp).spec());
   }
 
   {
     HitReport hp(base_hp);
     hp.threat_type = SB_THREAT_TYPE_CLIENT_SIDE_MALWARE_URL;
     hp.threat_source = ThreatSource::LOCAL_PVER4;
     hp.is_extended_reporting = false;
     hp.is_metrics_reporting_active = false;
     hp.is_subresource = true;
     EXPECT_EQ(
         "https://prefix.com/foo/report?client=unittest&appver=1.0&"
         "pver=3.0" +
             key_param_ +
             "&ext=0&evts=malcsdhit&"
             "evtd=http%3A%2F%2Fmalicious.url.com%2F&"
             "evtr=http%3A%2F%2Fpage.url.com%2F&evhr=http%3A%2F%2Freferrer."
             "url.com%2F&evtb=1&src=l4&m=0",
-        pm.SafeBrowsingHitUrl(hp).spec());
+        ping_manager()->SafeBrowsingHitUrl(hp).spec());
   }
 
   // Same as above, but add population_id
   {
     HitReport hp(base_hp);
     hp.threat_type = SB_THREAT_TYPE_CLIENT_SIDE_MALWARE_URL;
     hp.threat_source = ThreatSource::LOCAL_PVER4;
     hp.is_extended_reporting = false;
     hp.is_metrics_reporting_active = false;
     hp.is_subresource = true;
     hp.population_id = "foo bar";
     EXPECT_EQ(
         "https://prefix.com/foo/report?client=unittest&appver=1.0&"
         "pver=3.0" +
             key_param_ +
             "&ext=0&evts=malcsdhit&"
             "evtd=http%3A%2F%2Fmalicious.url.com%2F&"
             "evtr=http%3A%2F%2Fpage.url.com%2F&evhr=http%3A%2F%2Freferrer."
             "url.com%2F&evtb=1&src=l4&m=0&up=foo+bar",
-        pm.SafeBrowsingHitUrl(hp).spec());
+        ping_manager()->SafeBrowsingHitUrl(hp).spec());
   }
 }
 
 TEST_F(SafeBrowsingPingManagerTest, TestThreatDetailsUrl) {
-  SafeBrowsingProtocolConfig config;
-  config.client_name = kClient;
-  config.url_prefix = kUrlPrefix;
-  SafeBrowsingPingManager pm(NULL, config);
-
-  pm.version_ = kAppVer;
   EXPECT_EQ("https://prefix.com/foo/clientreport/malware?"
             "client=unittest&appver=1.0&pver=1.0" + key_param_,
-            pm.ThreatDetailsUrl().spec());
+            ping_manager()->ThreatDetailsUrl().spec());
+}
+
+TEST_F(SafeBrowsingPingManagerTest, TestReportThreatDetails) {
+  const std::string kThreatDetailsReportString = "Threat Details Report String";
+  std::string encoded_threat_report = "";
+  base::Base64Encode(kThreatDetailsReportString, &encoded_threat_report);
+  std::string expected_threat_details_url = ping_manager()->ThreatDetailsUrl()
+      .spec();
+  const int kRequestErrorCode = -123;
+
+  // Start the report.
+  ping_manager()->ReportThreatDetails(kThreatDetailsReportString);
+
+  net::TestURLFetcher* fetcher = fetcher_factory_.GetFetcherByID(0);
+  DCHECK(fetcher);
+  // Set some error response data on the fetcher to make things interesting.
+  fetcher->set_status(
+      net::URLRequestStatus(net::URLRequestStatus::FAILED, kRequestErrorCode));
+  // Tell the test fetcher to invoke the fetch callback.
+  fetcher->delegate()->OnURLFetchComplete(fetcher);
+
+  // We expect two net log entries: one when the ping starts, one when it ends.
+  net::TestNetLogEntry::List entries;
+  net_log_->GetEntries(&entries);
+  ASSERT_EQ(2u, entries.size());
+
+  // Check for expected log entries for the begin phase.
+  const net::TestNetLogEntry& start_entry = entries[0];
+  ASSERT_EQ(3u, start_entry.params->size());
+
+  std::string string_value;
+  EXPECT_TRUE(start_entry.GetStringValue("url", &string_value));
+  EXPECT_EQ(expected_threat_details_url, string_value);
+
+  EXPECT_TRUE(start_entry.GetStringValue("payload", &string_value));
+  EXPECT_EQ(encoded_threat_report, string_value);
+
+  // We don't really care what the source_dependency value is, just making sure
+  // it's there.
+  EXPECT_TRUE(start_entry.params->HasKey("source_dependency"));
+
+  // Check for expected log entries for the end phase.
+  const net::TestNetLogEntry& end_entry = entries[1];
+  ASSERT_EQ(3u, end_entry.params->size());
+
+  int int_value;
+  EXPECT_TRUE(end_entry.GetIntegerValue("status", &int_value));
+  EXPECT_EQ(net::URLRequestStatus::FAILED, int_value);
+
+  EXPECT_TRUE(end_entry.GetIntegerValue("error", &int_value));
+  EXPECT_EQ(kRequestErrorCode, int_value);
+
+  // We don't really care what the source_dependency value is, just making sure
+  // it's there.
+  EXPECT_TRUE(end_entry.params->HasKey("source_dependency"));
+}
+
+TEST_F(SafeBrowsingPingManagerTest, TestReportSafeBrowsingHit) {
+  const std::string kHitReportPostData = "Hit Report POST Data";
+  std::string encoded_post_data = "";
+  base::Base64Encode(kHitReportPostData, &encoded_post_data);
+
+  HitReport hp;
+  hp.malicious_url = GURL("http://malicious.url.com");
+  hp.page_url = GURL("http://page.url.com");
+  hp.referrer_url = GURL("http://referrer.url.com");
+  hp.threat_type = SB_THREAT_TYPE_CLIENT_SIDE_MALWARE_URL;
+  hp.threat_source = ThreatSource::LOCAL_PVER4;
+  hp.is_extended_reporting = false;
+  hp.is_metrics_reporting_active = false;
+  hp.is_subresource = true;
+  hp.population_id = "foo bar";
+  hp.post_data = kHitReportPostData;
+  std::string expected_hit_report_url = ping_manager()->SafeBrowsingHitUrl(hp)
+      .spec();
+  const int kRequestErrorCode = -321;
+
+  // Start the report.
+  ping_manager()->ReportSafeBrowsingHit(hp);
+
+  net::TestURLFetcher* fetcher = fetcher_factory_.GetFetcherByID(0);
+  DCHECK(fetcher);
+  // Set some error response data on the fetcher to make things interesting.
+  fetcher->set_status(
+      net::URLRequestStatus(net::URLRequestStatus::FAILED, kRequestErrorCode));
+  // Tell the test fetcher to invoke the fetch callback.
+  fetcher->delegate()->OnURLFetchComplete(fetcher);
+
+  // We expect two net log entries: one when the ping starts, one when it ends.
+  net::TestNetLogEntry::List entries;
+  net_log_->GetEntries(&entries);
+  ASSERT_EQ(2u, entries.size());
+
+  // Check for expected log entries for the begin phase.
+  const net::TestNetLogEntry& start_entry = entries[0];
+  ASSERT_EQ(3u, start_entry.params->size());
+
+  std::string string_value;
+  EXPECT_TRUE(start_entry.GetStringValue("url", &string_value));
+  EXPECT_EQ(expected_hit_report_url, string_value);
+
+  EXPECT_TRUE(start_entry.GetStringValue("payload", &string_value));
+  EXPECT_EQ(encoded_post_data, string_value);
+
+  // We don't really care what the source_dependency value is, just making sure
+  // it's there.
+  EXPECT_TRUE(start_entry.params->HasKey("source_dependency"));
+
+  // Check for expected log entries for the end phase.
+  const net::TestNetLogEntry& end_entry = entries[1];
+  ASSERT_EQ(3u, end_entry.params->size());
+
+  int int_value;
+  EXPECT_TRUE(end_entry.GetIntegerValue("status", &int_value));
+  EXPECT_EQ(net::URLRequestStatus::FAILED, int_value);
+
+  EXPECT_TRUE(end_entry.GetIntegerValue("error", &int_value));
+  EXPECT_EQ(kRequestErrorCode, int_value);
+
+  // We don't really care what the source_dependency value is, just making sure
+  // it's there.
+  EXPECT_TRUE(end_entry.params->HasKey("source_dependency"));
 }
 
 }  // namespace safe_browsing