// Copyright 2022 The Chromium Authors // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. #ifndef IOS_CHROME_BROWSER_SIGNIN_MODEL_FAKE_SYSTEM_IDENTITY_MANAGER_H_ #define IOS_CHROME_BROWSER_SIGNIN_MODEL_FAKE_SYSTEM_IDENTITY_MANAGER_H_ #import #include "base/containers/flat_set.h" #include "base/functional/callback.h" #include "base/location.h" #include "base/memory/weak_ptr.h" #include "base/observer_list.h" #include "base/sequence_checker.h" #include "components/signin/public/identity_manager/account_capabilities_test_mutator.h" #include "google_apis/gaia/core_account_id.h" #include "ios/chrome/browser/signin/model/fake_system_identity_details.h" #include "ios/chrome/browser/signin/model/system_identity_interaction_manager.h" #include "ios/chrome/browser/signin/model/system_identity_manager.h" #include "ios/chrome/browser/signin/model/system_identity_manager_observer.h" @class FakeSystemIdentity; @class FakeSystemIdentityManagerStorage; @protocol SystemIdentity; // An implementation of SystemIdentityManager that is used during test. // It allows faking the list of identities available on the system. class FakeSystemIdentityManager final : public SystemIdentityManager { public: // Callback used to mock HandleMDMNotification for errors created with // `CreateRefreshAccessTokenFailure()`. using HandleMDMNotificationCallback = base::RepeatingCallback; FakeSystemIdentityManager(); explicit FakeSystemIdentityManager( NSArray* fake_identities); ~FakeSystemIdentityManager() final; // Converts `manager` into a `FakeSystemIdentityManager*` if possible // or fails if the conversion is not valid. Must be used to get access // to FakeSystemIdentityManager API in tests. static FakeSystemIdentityManager* FromSystemIdentityManager( SystemIdentityManager* manager); // Adds `identity` to the available identities. // DCHECK failure will be triggered if the identity was already added. void AddIdentity(id identity); // Adds `identity` to the available identities without setting up // capabilities. // DCHECK failure will be triggered if the identity was already added. void AddIdentityWithUnknownCapabilities(id identity); // Adds `identity` and set the capabilities before firing the list changed // notification. // DCHECK failure will be triggered if the identity was already added. void AddIdentityWithCapabilities( id identity, NSDictionary* capabilities); // Simulates `identity` removed from another application. void ForgetIdentityFromOtherApplication(id identity); // Updates the avatar for an identity. // If `avatar` is nil, the avatar is reset. GetCachedAvatarForIdentity() will // return nil, and a fetch is needed to have the final avatar. // If `send_notification` is true, a notification is sent to notify that the // identity was updated. Otherwise, no notification is sent and the new avatar // is returned for any new avatar query. void UpdateSystemIdentityAvatar(const GaiaId& gaia_id, UIImage* avatar, bool send_notification = true); // Returns a test object that enables changes to capability state. AccountCapabilitiesTestMutator* GetPendingCapabilitiesMutator( id identity); // Returns the list of account capabilities associated with the identity. AccountCapabilities GetVisibleCapabilities(id identity); // Sets whether the hosted domain for each identity will be automatically and // immediately available via GetCachedHostedDomainForIdentity(). If false, the // hosted domain must first be queried (asynchronously) via GetHostedDomain(). // True by default. void SetInstantlyFillHostedDomainCache(bool instantly_fill); // Sets the error to be returned from all GetHostedDomain() calls. If nil, the // calls will succeed. void SetGetHostedDomainError(NSError* error); // Returns the number of hosted domain requests that have been answered with // an error (as set by SetGetHostedDomainError()). size_t GetNumHostedDomainErrorsReturned() const; // Simulates reloading the identities from the keychain. void FireSystemIdentityReloaded(); // Simulates an updated notification for `identity`. void FireIdentityUpdatedNotification(id identity); // Simulates a refresh token updated notification for `identity`. void FireIdentityRefreshTokenUpdatedNotification(id identity); // Waits until all asynchronous callbacks have been completed. void WaitForServiceCallbacksToComplete(); // Returns YES if the identity was already added. bool ContainsIdentity(id identity); // Simulates a persistent authentication error for an account. After calling // this method, token requests for the corresponding account will fail with an // auth error. void SetPersistentAuthErrorForAccount(const CoreAccountId& accountId); // Simulates a persistent authentication error being resolved for an account. // After calling this method, token requests for the corresponding account // will succeed. void ClearPersistentAuthErrorForAccount(const CoreAccountId& accountId); // Sets a callback to be called whenever an access token the specified // account is requested. void SetGetAccessTokenCallback(const CoreAccountId& accountId, GetAccessTokenCallback callback); void SetGetAccessTokenCallback(const CoreAccountId& accountId, GetAccessTokenRequestCallback callback); // Simulates a failure next time the access token for `identity` would be // fetched and return the error that would be sent to the observers. The // callback will be invoked each time `HandleMDMNotification()` is called // with the returned error object. // // Only a single error can be scheduled, so if this method is called a // second time without refreshing the access token, only the second error // will be sent to the observers. id CreateRefreshAccessTokenFailure( id identity, HandleMDMNotificationCallback callback); // Returns whether an MDM notification was displayed. bool WasMDMNotificationDisplayed() const; // Resets the MDM notification displayed flag. void ResetMDMNotificationDisplayed(); // SystemIdentityManager implementation. bool IsSigninSupported() final; bool HandleSessionOpenURLContexts( UIScene* scene, NSSet* url_contexts) final; void ApplicationDidDiscardSceneSessions( NSSet* scene_sessions) final; void DismissDialogs() final; DismissViewCallback PresentAccountDetailsController( PresentDialogConfiguration configuration) final; DismissViewCallback PresentWebAndAppSettingDetailsController( PresentDialogConfiguration configuration) final; DismissViewCallback PresentLinkedServicesSettingsDetailsController( PresentDialogConfiguration configuration) final; // Sets the factory for creating SystemIdentityInteractionManager instances. void SetInteractionManagerFactory( base::RepeatingCallback()> factory); id CreateInteractionManager() final; void IterateOverIdentities(IdentityIteratorCallback callback) final; void ForgetIdentity(id identity, ForgetIdentityCallback callback) final; bool IdentityRemovedByUser(const GaiaId& gaia_id) final; void GetAccessToken(id identity, const std::set& scopes, AccessTokenCallback callback) final; void GetAccessToken(id identity, const std::string& client_id, const std::set& scopes, AccessTokenCallback callback) final; void GetAccessToken(id identity, const std::set& scopes, AccessTokenRequestCallback callback) final; void GetAccessToken(id identity, const std::string& client_id, const std::set& scopes, AccessTokenRequestCallback callback) final; void FetchAvatarForIdentity(id identity) final; UIImage* GetCachedAvatarForIdentity(id identity) final; void GetHostedDomain(id identity, HostedDomainCallback callback) final; NSString* GetCachedHostedDomainForIdentity(id identity) final; void FetchCapabilities(id identity, const std::vector& names, FetchCapabilitiesCallback callback) final; void FetchCapabilitiesWithPartial( id identity, const std::vector& names, FetchCapabilitiesCompletion completion, FetchPartialCapabilitiesCallback partial_callback) final; void RegisterExternalPrivacyContextProvider( id provider) final; void UnregisterExternalPrivacyContextProvider( id provider) final; void ExternalPrivacyContextProviderReady( id provider) final; bool HandleMDMNotification(id identity, NSArray>* active_identities, id error, HandleMDMCallback callback) final; bool DisplayMDMNotification(id identity, const GoogleServiceAuthError& error, HandleMDMCallback callback) final; bool IsScopeLimitedError(id error) final; bool IsMDMError(id identity, NSError* error) final; void FetchTokenAuthURL(id identity, NSURL* target_url, AuthenticatedURLCallback callback) final; private: // Returns a weak pointer to the current instance. base::WeakPtr GetWeakPtr(); // Helper used to implement the asynchronous part of `ForgetIdentity`. void ForgetIdentityAsync(id identity, ForgetIdentityCallback callback, bool removed_by_user); // Helper used to implement the asynchronous part of `GetAccessToken`. void GetAccessTokenAsyncLegacy(id identity, AccessTokenCallback callback); void GetAccessTokenAsync(id identity, AccessTokenRequestCallback callback); // Helper used to implement the asynchronous part of `FetchAvatarForIdentity`. void FetchAvatarForIdentityAsync(id identity); // Helper used to implement the asynchronous part of `GetHostedDomain`. void GetHostedDomainAsync(id identity, HostedDomainCallback callback); // Helper used to implement the asynchronous part of `GetHostedDomain`. void FetchCapabilitiesAsync(id identity, const std::vector& names, FetchCapabilitiesCallback callback); void FetchCapabilitiesWithPartialAsync( id identity, const std::vector& names, FetchCapabilitiesCompletion completion, FetchPartialCapabilitiesCallback partial_callback); // Posts `closure` to be executed asynchronously on the current sequence // while maintaining a counter of pending callbacks. The counter is used // to implement `WaitForServiceCallbacksToComplete()`. void PostClosure(base::Location from_here, base::OnceClosure closure); // Runs `closure` updating the counter of pending callbacks. Resumes the // execution of `WaitForServiceCallbacksToComplete()` when the counter // reaches 0. void ExecuteClosure(base::OnceClosure closure); bool instantly_fill_hosted_domain_cache_ = true; bool was_mdm_notification_displayed_ = false; NSMutableSet>* hosted_domain_cache_ = [NSMutableSet set]; NSError* get_hosted_domain_error_ = nil; size_t num_hosted_domain_errors_returned_ = 0; // Counter of pending callback and closure used to resume the execution // of `WaitForServiceCallbacksToComplete()` when the counter reaches 0. size_t pending_callbacks_ = 0; base::OnceClosure resume_closure_; // Stores identities. __strong FakeSystemIdentityManagerStorage* storage_ = nil; // List of gaia ids for identities that has been removed by calling // `ForgetIdentity()` (instead of `ForgetIdentityFromOtherApplication()`). base::flat_set gaia_ids_removed_by_user_; base::RepeatingCallback()> interaction_manager_factory_; base::WeakPtrFactory weak_ptr_factory_{this}; }; #endif // IOS_CHROME_BROWSER_SIGNIN_MODEL_FAKE_SYSTEM_IDENTITY_MANAGER_H_