fake_profile_oauth2_token_service.h revision 68043e1e95eeb07d5cae7aca370b26518b0867d6
1// Copyright 2013 The Chromium Authors. All rights reserved. 2// Use of this source code is governed by a BSD-style license that can be 3// found in the LICENSE file. 4 5#ifndef CHROME_BROWSER_SIGNIN_FAKE_PROFILE_OAUTH2_TOKEN_SERVICE_H_ 6#define CHROME_BROWSER_SIGNIN_FAKE_PROFILE_OAUTH2_TOKEN_SERVICE_H_ 7 8#include <string> 9#include <vector> 10 11#include "base/compiler_specific.h" 12#include "base/memory/weak_ptr.h" 13 14#if defined(OS_ANDROID) 15#include "chrome/browser/signin/android_profile_oauth2_token_service.h" 16#else 17#include "chrome/browser/signin/profile_oauth2_token_service.h" 18#endif 19 20namespace content { 21class BrowserContext; 22} 23 24// Helper class to simplify writing unittests that depend on an instance of 25// ProfileOAuth2TokenService. 26// 27// Tests would typically do something like the following: 28// 29// FakeProfileOAuth2TokenService service; 30// ... 31// service.IssueRefreshToken("token"); // Issue refresh token/notify observers 32// ... 33// // Confirm that there is at least one active request. 34// EXPECT_GT(0U, service.GetPendingRequests().size()); 35// ... 36// // Make any pending token fetches for a given scope succeed. 37// ScopeSet scopes; 38// scopes.insert(GaiaConstants::kYourServiceScope); 39// IssueTokenForScope(scopes, "access_token", base::Time()::Max()); 40// ... 41// // ...or make them fail... 42// IssueErrorForScope(scopes, GoogleServiceAuthError(INVALID_GAIA_CREDENTIALS)); 43// 44class FakeProfileOAuth2TokenService 45#if defined(OS_ANDROID) 46 : public AndroidProfileOAuth2TokenService { 47#else 48 : public ProfileOAuth2TokenService { 49#endif 50 public: 51 struct PendingRequest { 52 PendingRequest(); 53 ~PendingRequest(); 54 55 std::string account_id; 56 std::string client_id; 57 std::string client_secret; 58 ScopeSet scopes; 59 base::WeakPtr<RequestImpl> request; 60 }; 61 62 FakeProfileOAuth2TokenService(); 63 virtual ~FakeProfileOAuth2TokenService(); 64 65 // Overriden to make sure it works on Android. 66 virtual bool RefreshTokenIsAvailable( 67 const std::string& account_id) OVERRIDE; 68 69 // Sets the current refresh token. If |token| is non-empty, this will invoke 70 // OnRefreshTokenAvailable() on all Observers, otherwise this will invoke 71 // OnRefreshTokenRevoked(). 72 void IssueRefreshToken(const std::string& token); 73 74 // Gets a list of active requests (can be used by tests to validate that the 75 // correct request has been issued). 76 std::vector<PendingRequest> GetPendingRequests(); 77 78 // Helper routines to issue tokens for pending requests. 79 // TODO(fgorski): Add account IDs as parameters. 80 void IssueTokenForScope(const ScopeSet& scopes, 81 const std::string& access_token, 82 const base::Time& expiration); 83 84 void IssueErrorForScope(const ScopeSet& scopes, 85 const GoogleServiceAuthError& error); 86 87 void IssueTokenForAllPendingRequests(const std::string& access_token, 88 const base::Time& expiration); 89 90 void IssueErrorForAllPendingRequests(const GoogleServiceAuthError& error); 91 92 // Helper function to be used with 93 // BrowserContextKeyedService::SetTestingFactory(). 94 static BrowserContextKeyedService* Build(content::BrowserContext* profile); 95 96 protected: 97 // OAuth2TokenService overrides. 98 virtual void FetchOAuth2Token(RequestImpl* request, 99 const std::string& account_id, 100 net::URLRequestContextGetter* getter, 101 const std::string& client_id, 102 const std::string& client_secret, 103 const ScopeSet& scopes) OVERRIDE; 104 105 virtual std::string GetRefreshToken(const std::string& account_id) OVERRIDE; 106 107 virtual net::URLRequestContextGetter* GetRequestContext() OVERRIDE; 108 109 private: 110 // Helper function to complete pending requests - if |all_scopes| is true, 111 // then all pending requests are completed, otherwise, only those requests 112 // matching |scopes| are completed. 113 void CompleteRequests(bool all_scopes, 114 const ScopeSet& scopes, 115 const GoogleServiceAuthError& error, 116 const std::string& access_token, 117 const base::Time& expiration); 118 119 std::vector<PendingRequest> pending_requests_; 120 std::string refresh_token_; 121 122 DISALLOW_COPY_AND_ASSIGN(FakeProfileOAuth2TokenService); 123}; 124 125#endif // CHROME_BROWSER_SIGNIN_FAKE_PROFILE_OAUTH2_TOKEN_SERVICE_H_ 126