[GCM] Handling connection events in GCMAccountTracker

chrome/browser/services/gcm/gcm_account_tracker_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 "chrome/browser/services/gcm/gcm_account_tracker.h"
 
 #include <map>
 #include <string>
 
 #include "base/memory/scoped_ptr.h"
 #include "base/message_loop/message_loop.h"
+#include "base/run_loop.h"
+#include "components/gcm_driver/fake_gcm_driver.h"
 #include "google_apis/gaia/fake_identity_provider.h"
 #include "google_apis/gaia/fake_oauth2_token_service.h"
 #include "google_apis/gaia/google_service_auth_error.h"
 #include "net/http/http_status_code.h"
 #include "net/url_request/test_url_fetcher_factory.h"
 #include "net/url_request/url_request_test_util.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
 namespace gcm {
 
@@ skipping 32 matching lines @@
            actual_iter = actual_tokens.begin();
        expected_iter != expected_tokens.end() &&
            actual_iter != actual_tokens.end();
        ++expected_iter, ++actual_iter) {
     EXPECT_EQ(expected_iter->account_id, actual_iter->account_id);
     EXPECT_EQ(expected_iter->email, actual_iter->email);
     EXPECT_EQ(expected_iter->access_token, actual_iter->access_token);
   }
 }
 
+class CustomFakeGCMDriver : public FakeGCMDriver {

[Nicolas Zea, 2014/10/08 00:36:35]

nit: comment what it does differently from the normal fake?

[fgorski, 2014/10/08 18:04:27]

Done.

+ public:
+  CustomFakeGCMDriver();
+  virtual ~CustomFakeGCMDriver();
+
+  virtual void SetAccountTokens(
+      const std::vector<GCMClient::AccountTokenInfo>& account_tokens) OVERRIDE;

[Nicolas Zea, 2014/10/08 00:36:35]

nit: OVERRIDE -> override

[fgorski, 2014/10/08 18:04:27]

Done.

+  virtual void AddConnectionObserver(GCMConnectionObserver* observer) OVERRIDE;
+  virtual void RemoveConnectionObserver(
+      GCMConnectionObserver* observer) OVERRIDE;
+  virtual bool IsConnected() const OVERRIDE { return connected_; }
+
+  void set_connected(bool connected) {

[Nicolas Zea, 2014/10/08 00:36:35]

uber nit: the hacker_style inline method is generally just for setters/getters.
This is also calling a virtual observer method, so should be named SetConnected.

[fgorski, 2014/10/08 18:04:27]

Uber done.

+    connected_ = connected;
+    if (connected && last_connection_observer_)
+      last_connection_observer_->OnConnected(ip_endpoint_);
+  }
+
+  // Test results and helpers.
+  void ResetResults();
+  bool update_accounts_called() const { return update_accounts_called_; }
+  const std::vector<GCMClient::AccountTokenInfo>& accounts() const {
+    return accounts_;
+  }
+  const GCMConnectionObserver* last_connection_observer() const {
+    return last_connection_observer_;
+  }
+  const GCMConnectionObserver* last_removed_connection_observer() const {
+    return removed_connection_observer_;
+  }
+
+ private:
+  bool connected_;
+  std::vector<GCMClient::AccountTokenInfo> accounts_;
+  bool update_accounts_called_;
+  GCMConnectionObserver* last_connection_observer_;
+  GCMConnectionObserver* removed_connection_observer_;
+  net::IPEndPoint ip_endpoint_;
+
+  DISALLOW_COPY_AND_ASSIGN(CustomFakeGCMDriver);
+};
+
+CustomFakeGCMDriver::CustomFakeGCMDriver()
+    : connected_(true),
+      update_accounts_called_(false),
+      last_connection_observer_(NULL),
+      removed_connection_observer_(NULL) {
+}
+
+CustomFakeGCMDriver::~CustomFakeGCMDriver() {
+}
+
+void CustomFakeGCMDriver::SetAccountTokens(
+    const std::vector<GCMClient::AccountTokenInfo>& accounts) {
+  update_accounts_called_ = true;
+  accounts_ = accounts;
+}
+
+void CustomFakeGCMDriver::AddConnectionObserver(
+    GCMConnectionObserver* observer) {
+  last_connection_observer_ = observer;
+}
+
+void CustomFakeGCMDriver::RemoveConnectionObserver(
+    GCMConnectionObserver* observer) {
+  removed_connection_observer_ = observer;
+}
+
+void CustomFakeGCMDriver::ResetResults() {
+  accounts_.clear();
+  update_accounts_called_ = false;
+  last_connection_observer_ = NULL;
+  removed_connection_observer_ = NULL;
+}
+
 }  // namespace
 
 class GCMAccountTrackerTest : public testing::Test {
  public:
   GCMAccountTrackerTest();
   virtual ~GCMAccountTrackerTest();
 
-  // Callback for the account tracker.
-  void UpdateAccounts(const std::vector<GCMClient::AccountTokenInfo>& accounts);
-
   // Helpers to pass fake events to the tracker. Tests should have either a pair
   // of Start/FinishAccountSignIn or SignInAccount per account. Don't mix.
   // Call to SignOutAccount is not mandatory.
   void StartAccountSignIn(const std::string& account_key);
   void FinishAccountSignIn(const std::string& account_key);
   void SignInAccount(const std::string& account_key);
   void SignOutAccount(const std::string& account_key);
 
   // Helpers for dealing with OAuth2 access token requests.
   void IssueAccessToken(const std::string& account_key);
+  void IssueExpiredAccessToken(const std::string& account_key);
   void IssueError(const std::string& account_key);
 
-  // Test results and helpers.
-  void ResetResults();
-  bool update_accounts_called() const { return update_accounts_called_; }
-  const std::vector<GCMClient::AccountTokenInfo>& accounts() const {
-    return accounts_;
-  }
-
-  // Accessor to account tracker.
+  // Accessors to account tracker and gcm driver.
   GCMAccountTracker* tracker() { return tracker_.get(); }
+  CustomFakeGCMDriver* driver() { return &driver_; }
 
  private:
-  std::vector<GCMClient::AccountTokenInfo> accounts_;
-  bool update_accounts_called_;
+  CustomFakeGCMDriver driver_;
 
   base::MessageLoop message_loop_;
   net::TestURLFetcherFactory test_fetcher_factory_;
   scoped_ptr<FakeOAuth2TokenService> fake_token_service_;
   scoped_ptr<FakeIdentityProvider> fake_identity_provider_;
   scoped_ptr<GCMAccountTracker> tracker_;
 };
 
-GCMAccountTrackerTest::GCMAccountTrackerTest()
-    : update_accounts_called_(false) {
+GCMAccountTrackerTest::GCMAccountTrackerTest() {
   fake_token_service_.reset(new FakeOAuth2TokenService());
 
   fake_identity_provider_.reset(
       new FakeIdentityProvider(fake_token_service_.get()));
 
   scoped_ptr<gaia::AccountTracker> gaia_account_tracker(
       new gaia::AccountTracker(fake_identity_provider_.get(),
                                new net::TestURLRequestContextGetter(
                                    message_loop_.message_loop_proxy())));
 
-  tracker_.reset(new GCMAccountTracker(
-      gaia_account_tracker.Pass(),
-      base::Bind(&GCMAccountTrackerTest::UpdateAccounts,
-                 base::Unretained(this))));
+  tracker_.reset(new GCMAccountTracker(gaia_account_tracker.Pass(), &driver_));
 }
 
 GCMAccountTrackerTest::~GCMAccountTrackerTest() {
   if (tracker_)
     tracker_->Shutdown();
 }
 
-void GCMAccountTrackerTest::UpdateAccounts(
-    const std::vector<GCMClient::AccountTokenInfo>& accounts) {
-  update_accounts_called_ = true;
-  accounts_ = accounts;
-}
-
-void GCMAccountTrackerTest::ResetResults() {
-  accounts_.clear();
-  update_accounts_called_ = false;
-}
-
 void GCMAccountTrackerTest::StartAccountSignIn(const std::string& account_key) {
   fake_identity_provider_->LogIn(account_key);
   fake_token_service_->AddAccount(account_key);
 }
 
 void GCMAccountTrackerTest::FinishAccountSignIn(
     const std::string& account_key) {
   IssueAccessToken(account_key);
 
   net::TestURLFetcher* fetcher = test_fetcher_factory_.GetFetcherByID(
@@ skipping 11 matching lines @@
 
 void GCMAccountTrackerTest::SignOutAccount(const std::string& account_key) {
   fake_token_service_->RemoveAccount(account_key);
 }
 
 void GCMAccountTrackerTest::IssueAccessToken(const std::string& account_key) {
   fake_token_service_->IssueAllTokensForAccount(
       account_key, MakeAccessToken(account_key), base::Time::Max());
 }
 
+void GCMAccountTrackerTest::IssueExpiredAccessToken(
+    const std::string& account_key) {
+  fake_token_service_->IssueAllTokensForAccount(
+      account_key, MakeAccessToken(account_key), base::Time::Now());
+}
+
 void GCMAccountTrackerTest::IssueError(const std::string& account_key) {
   fake_token_service_->IssueErrorForAllPendingRequestsForAccount(
       account_key,
       GoogleServiceAuthError(GoogleServiceAuthError::SERVICE_UNAVAILABLE));
 }
 
+// TODO(fgorsk): This actually need fixing.

[Nicolas Zea, 2014/10/08 00:36:35]

Is this comment still relevant?

[fgorski, 2014/10/08 18:04:27]

Removing.

 TEST_F(GCMAccountTrackerTest, NoAccounts) {
-  EXPECT_FALSE(update_accounts_called());
+  EXPECT_FALSE(driver()->update_accounts_called());
   tracker()->Start();
   // Callback should not be called if there where no accounts provided.
-  EXPECT_FALSE(update_accounts_called());
-  EXPECT_TRUE(accounts().empty());
-  tracker()->Stop();
+  EXPECT_FALSE(driver()->update_accounts_called());
+  EXPECT_TRUE(driver()->accounts().empty());
 }
 
 // Verifies that callback is called after a token is issued for a single account
 // with a specific scope. In this scenario, the underlying account tracker is
 // still working when the CompleteCollectingTokens is called for the first time.
 TEST_F(GCMAccountTrackerTest, SingleAccount) {
   StartAccountSignIn(kAccountId1);
 
   tracker()->Start();
   // We don't have any accounts to report, but given the inner account tracker
   // is still working we don't make a call with empty accounts list.
-  EXPECT_FALSE(update_accounts_called());
+  EXPECT_FALSE(driver()->update_accounts_called());
 
   // This concludes the work of inner account tracker.
   FinishAccountSignIn(kAccountId1);
   IssueAccessToken(kAccountId1);
 
-  EXPECT_TRUE(update_accounts_called());
+  EXPECT_TRUE(driver()->update_accounts_called());
 
   std::vector<GCMClient::AccountTokenInfo> expected_accounts;
   expected_accounts.push_back(MakeAccountToken(kAccountId1));
-  VerifyAccountTokens(expected_accounts, accounts());
-  tracker()->Stop();
+  VerifyAccountTokens(expected_accounts, driver()->accounts());
 }
 
 TEST_F(GCMAccountTrackerTest, MultipleAccounts) {
   StartAccountSignIn(kAccountId1);
   StartAccountSignIn(kAccountId2);
 
   tracker()->Start();
-  EXPECT_FALSE(update_accounts_called());
+  EXPECT_FALSE(driver()->update_accounts_called());
 
   FinishAccountSignIn(kAccountId1);
   IssueAccessToken(kAccountId1);
-  EXPECT_FALSE(update_accounts_called());
+  EXPECT_FALSE(driver()->update_accounts_called());
 
   FinishAccountSignIn(kAccountId2);
   IssueAccessToken(kAccountId2);
-  EXPECT_TRUE(update_accounts_called());
+  EXPECT_TRUE(driver()->update_accounts_called());
 
   std::vector<GCMClient::AccountTokenInfo> expected_accounts;
   expected_accounts.push_back(MakeAccountToken(kAccountId1));
   expected_accounts.push_back(MakeAccountToken(kAccountId2));
-  VerifyAccountTokens(expected_accounts, accounts());
-
-  tracker()->Stop();
+  VerifyAccountTokens(expected_accounts, driver()->accounts());
 }
 
 TEST_F(GCMAccountTrackerTest, AccountAdded) {
   tracker()->Start();
-  ResetResults();
+  driver()->ResetResults();
 
   SignInAccount(kAccountId1);
-  EXPECT_FALSE(update_accounts_called());
+  EXPECT_FALSE(driver()->update_accounts_called());
 
   IssueAccessToken(kAccountId1);
-  EXPECT_TRUE(update_accounts_called());
+  EXPECT_TRUE(driver()->update_accounts_called());
 
   std::vector<GCMClient::AccountTokenInfo> expected_accounts;
   expected_accounts.push_back(MakeAccountToken(kAccountId1));
-  VerifyAccountTokens(expected_accounts, accounts());
-
-  tracker()->Stop();
+  VerifyAccountTokens(expected_accounts, driver()->accounts());
 }
 
 TEST_F(GCMAccountTrackerTest, AccountRemoved) {
   SignInAccount(kAccountId1);
   SignInAccount(kAccountId2);
 
   tracker()->Start();
   IssueAccessToken(kAccountId1);
   IssueAccessToken(kAccountId2);
-  EXPECT_TRUE(update_accounts_called());
+  EXPECT_TRUE(driver()->update_accounts_called());
 
-  ResetResults();
-  EXPECT_FALSE(update_accounts_called());
+  driver()->ResetResults();
+  EXPECT_FALSE(driver()->update_accounts_called());
 
   SignOutAccount(kAccountId2);
-  EXPECT_TRUE(update_accounts_called());
+  EXPECT_TRUE(driver()->update_accounts_called());
 
   std::vector<GCMClient::AccountTokenInfo> expected_accounts;
   expected_accounts.push_back(MakeAccountToken(kAccountId1));
-  VerifyAccountTokens(expected_accounts, accounts());
-
-  tracker()->Stop();
+  VerifyAccountTokens(expected_accounts, driver()->accounts());
 }
 
 TEST_F(GCMAccountTrackerTest, GetTokenFailed) {
   SignInAccount(kAccountId1);
   SignInAccount(kAccountId2);
 
   tracker()->Start();
   IssueAccessToken(kAccountId1);
-  EXPECT_FALSE(update_accounts_called());
+  EXPECT_FALSE(driver()->update_accounts_called());
 
   IssueError(kAccountId2);
-  EXPECT_TRUE(update_accounts_called());
+  EXPECT_FALSE(driver()->update_accounts_called());
+
+  EXPECT_EQ(1UL, tracker()->get_pending_token_request_count());
+
+  IssueAccessToken(kAccountId2);
+  EXPECT_TRUE(driver()->update_accounts_called());
 
   std::vector<GCMClient::AccountTokenInfo> expected_accounts;
   expected_accounts.push_back(MakeAccountToken(kAccountId1));
-  VerifyAccountTokens(expected_accounts, accounts());
-
-  tracker()->Stop();
+  expected_accounts.push_back(MakeAccountToken(kAccountId2));
+  VerifyAccountTokens(expected_accounts, driver()->accounts());
 }
 
 TEST_F(GCMAccountTrackerTest, GetTokenFailedAccountRemoved) {
   SignInAccount(kAccountId1);
   SignInAccount(kAccountId2);
 
   tracker()->Start();
   IssueAccessToken(kAccountId1);
   IssueError(kAccountId2);
 
-  ResetResults();
+  driver()->ResetResults();
   SignOutAccount(kAccountId2);
-  EXPECT_TRUE(update_accounts_called());
+  IssueError(kAccountId2);
+
+  EXPECT_TRUE(driver()->update_accounts_called());
 
   std::vector<GCMClient::AccountTokenInfo> expected_accounts;
   expected_accounts.push_back(MakeAccountToken(kAccountId1));
-  VerifyAccountTokens(expected_accounts, accounts());
-
-  tracker()->Stop();
+  VerifyAccountTokens(expected_accounts, driver()->accounts());
 }
 
 TEST_F(GCMAccountTrackerTest, AccountRemovedWhileRequestsPending) {
   SignInAccount(kAccountId1);
   SignInAccount(kAccountId2);
 
   tracker()->Start();
   IssueAccessToken(kAccountId1);
-  EXPECT_FALSE(update_accounts_called());
+  EXPECT_FALSE(driver()->update_accounts_called());
 
   SignOutAccount(kAccountId2);
   IssueAccessToken(kAccountId2);
-  EXPECT_TRUE(update_accounts_called());
+  EXPECT_TRUE(driver()->update_accounts_called());
 
   std::vector<GCMClient::AccountTokenInfo> expected_accounts;
   expected_accounts.push_back(MakeAccountToken(kAccountId1));
-  VerifyAccountTokens(expected_accounts, accounts());
+  VerifyAccountTokens(expected_accounts, driver()->accounts());
+}
 
-  tracker()->Stop();
+// Makes sure that tracker observes GCM connection when running.
+TEST_F(GCMAccountTrackerTest, TrackerObservesConnection) {
+  EXPECT_EQ(NULL, driver()->last_connection_observer());
+  tracker()->Start();
+  EXPECT_EQ(tracker(), driver()->last_connection_observer());
+  tracker()->Shutdown();
+  EXPECT_EQ(tracker(), driver()->last_removed_connection_observer());
+}
+
+// Makes sure that token fetching happens only after connection is established.
+TEST_F(GCMAccountTrackerTest, PostponeTokenFetchingUntilConnected) {
+  driver()->set_connected(false);
+  StartAccountSignIn(kAccountId1);
+  tracker()->Start();
+  FinishAccountSignIn(kAccountId1);
+
+  EXPECT_EQ(0UL, tracker()->get_pending_token_request_count());
+  driver()->set_connected(true);
+
+  EXPECT_EQ(1UL, tracker()->get_pending_token_request_count());
+}
+
+TEST_F(GCMAccountTrackerTest, IvalidateExpiredTokens) {
+  StartAccountSignIn(kAccountId1);
+  StartAccountSignIn(kAccountId2);
+  tracker()->Start();
+  FinishAccountSignIn(kAccountId1);
+  FinishAccountSignIn(kAccountId2);
+
+  EXPECT_EQ(2UL, tracker()->get_pending_token_request_count());
+
+  IssueExpiredAccessToken(kAccountId1);
+  IssueAccessToken(kAccountId2);
+  // Because the first token is expired, we expect the sanitize to kick in and
+  // clean it up before the SetAccessToken is called. This also means a new
+  // token request will be issued
+  EXPECT_FALSE(driver()->update_accounts_called());
+  EXPECT_EQ(1UL, tracker()->get_pending_token_request_count());
 }
 
 // TODO(fgorski): Add test for adding account after removal >> make sure it does
 // not mark removal.
 
 }  // namespace gcm