SafeBrowsing: Track and cancel API checks.

components/safe_browsing_db/database_manager_unittest.cc

 // Copyright 2016 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 <stddef.h>
 
 #include <string>
 #include <vector>
 
 #include "base/macros.h"
 #include "base/memory/ref_counted.h"
 #include "base/memory/scoped_ptr.h"
+#include "base/message_loop/message_loop.h"
 #include "base/run_loop.h"
 #include "components/safe_browsing_db/database_manager.h"
 #include "components/safe_browsing_db/test_database_manager.h"
 #include "components/safe_browsing_db/v4_get_hash_protocol_manager.h"
 #include "content/public/browser/browser_thread.h"
 #include "content/public/test/test_browser_thread_bundle.h"
 #include "testing/gtest/include/gtest/gtest.h"
 #include "url/gurl.h"
 
 using content::BrowserThread;
 
 namespace safe_browsing {
 
 namespace {
 
+void InvokeFullHashCallback(
+    V4GetHashProtocolManager::FullHashCallback callback,
+    const std::vector<SBFullHashResult>& full_hashes) {
+  callback.Run(full_hashes, base::TimeDelta::FromMinutes(0));
+}
+
 // A TestV4GetHashProtocolManager that returns fixed responses from the
 // Safe Browsing server for testing purpose.
 class TestV4GetHashProtocolManager : public V4GetHashProtocolManager {
  public:
   TestV4GetHashProtocolManager(
       net::URLRequestContextGetter* request_context_getter,
       const V4ProtocolConfig& config)
-      : V4GetHashProtocolManager(request_context_getter, config) {}
+      : V4GetHashProtocolManager(request_context_getter, config),
+        delay_seconds_(0) {}
 
   ~TestV4GetHashProtocolManager() override {}
 
   void GetFullHashesWithApis(const std::vector<SBPrefix>& prefixes,
                              FullHashCallback callback) override {
     prefixes_ = prefixes;
-    callback.Run(full_hashes_, base::TimeDelta::FromMinutes(0));
+    base::MessageLoop::current()->PostDelayedTask(
+        FROM_HERE, base::Bind(InvokeFullHashCallback, callback, full_hashes_),
+        base::TimeDelta::FromSeconds(delay_seconds_));

[Nathan Parker, 2016/04/19 18:05:19]

Does this use real time, or just ensure the ordering of tasks (real time delays
in test are generally unreliable.)

[kcarattini, 2016/04/20 01:55:53]

I'm not sure. It doesn't appear to use real time because I set a rather long
delay and the test does not take that long to run. Would you suggest a different
way of doing this?

+  }
+
+  void SetDelaySeconds(int delay) {
+    delay_seconds_ = delay;
   }
 
   // Prepare the GetFullHash results for the next request.
   void AddGetFullHashResponse(const SBFullHashResult& full_hash_result) {
     full_hashes_.push_back(full_hash_result);
   }
 
   // Returns the prefixes that were sent in the last request.
   const std::vector<SBPrefix>& GetRequestPrefixes() { return prefixes_; }
 
  private:
   std::vector<SBPrefix> prefixes_;
   std::vector<SBFullHashResult> full_hashes_;
+  int delay_seconds_;
 };
 
 // Factory that creates test protocol manager instances.
 class TestV4GetHashProtocolManagerFactory :
     public V4GetHashProtocolManagerFactory {
  public:
   TestV4GetHashProtocolManagerFactory() : pm_(NULL) {}
   ~TestV4GetHashProtocolManagerFactory() override {}
 
   V4GetHashProtocolManager* CreateProtocolManager(
@@ skipping 57 matching lines @@
 }
 
 TEST_F(SafeBrowsingDatabaseManagerTest, CheckApiBlacklistUrlPrefixes) {
   TestClient client;
   const GURL url("https://www.example.com/more");
   // Generated from the sorted output of UrlToFullHashes in util.h.
   std::vector<SBPrefix> expected_prefixes =
       {1237562338, 2871045197, 3553205461, 3766933875};
 
   EXPECT_FALSE(db_manager_->CheckApiBlacklistUrl(url, &client));
+  base::RunLoop().RunUntilIdle();
   std::vector<SBPrefix> prefixes = static_cast<TestV4GetHashProtocolManager*>(
       db_manager_->v4_get_hash_protocol_manager_)->GetRequestPrefixes();
   EXPECT_EQ(expected_prefixes.size(), prefixes.size());
   for (unsigned int i = 0; i < prefixes.size(); ++i) {
     EXPECT_EQ(expected_prefixes[i], prefixes[i]);
   }
 }
 
 TEST_F(SafeBrowsingDatabaseManagerTest, HandleGetHashesWithApisResults) {
   TestClient client;
@@ skipping 50 matching lines @@
 
   EXPECT_FALSE(db_manager_->CheckApiBlacklistUrl(url, &client));
   base::RunLoop().RunUntilIdle();
 
   const std::vector<std::string>& permissions = client.GetBlockedPermissions();
   EXPECT_EQ(2ul, permissions.size());
   EXPECT_EQ("GEOLOCATION", permissions[0]);
   EXPECT_EQ("NOTIFICATIONS", permissions[1]);
 }
 
+TEST_F(SafeBrowsingDatabaseManagerTest, CancelApiCheck) {
+  TestClient client;
+  const GURL url("https://www.example.com/more");
+  TestV4GetHashProtocolManager* pm = static_cast<TestV4GetHashProtocolManager*>(
+      db_manager_->v4_get_hash_protocol_manager_);
+  SBFullHashResult full_hash_result;
+  full_hash_result.hash = SBFullHashForString("example.com/");
+  full_hash_result.metadata.api_permissions.push_back("GEOLOCATION");
+  pm->AddGetFullHashResponse(full_hash_result);
+  pm->SetDelaySeconds(100);
+
+  EXPECT_FALSE(db_manager_->CheckApiBlacklistUrl(url, &client));
+  EXPECT_TRUE(db_manager_->CancelApiCheck(&client));
+  base::RunLoop().RunUntilIdle();
+
+  const std::vector<std::string>& permissions = client.GetBlockedPermissions();
+  EXPECT_EQ(0ul, permissions.size());

[Nathan Parker, 2016/04/19 18:05:19]

Does this verify that the callback was invoked?

[kcarattini, 2016/04/20 01:55:53]

No. How would I do that?

[Nathan Parker, 2016/04/20 03:03:35]

You could do something like set a "was_callback_invoked_" bool in
OnCheckApiBlacklistUrlResult() of the client. 

[kcarattini, 2016/04/20 04:44:01]

Oh, that callback. Done.

+}
+
 }  // namespace safe_browsing