ios/chrome/browser/sessions/session_service_ios_unittest.mm - chromium/src - Git at Google

 // Copyright 2012 The Chromium Authors
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.

 #import <Foundation/Foundation.h>

 #import <memory>

 #import "base/apple/foundation_util.h"
 #import "base/files/file_path.h"
 #import "base/files/file_util.h"
 #import "base/files/scoped_temp_dir.h"
 #import "base/path_service.h"
 #import "base/run_loop.h"
 #import "base/task/sequenced_task_runner.h"
 #import "base/task/single_thread_task_runner.h"
 #import "base/test/ios/wait_util.h"
 #import "base/test/scoped_feature_list.h"
 #import "base/test/task_environment.h"
 #import "ios/chrome/browser/sessions/session_ios.h"
 #import "ios/chrome/browser/sessions/session_ios_factory.h"
 #import "ios/chrome/browser/sessions/session_service_ios.h"
 #import "ios/chrome/browser/sessions/session_window_ios.h"
 #import "ios/chrome/browser/shared/model/paths/paths.h"
 #import "ios/chrome/browser/shared/model/web_state_list/test/fake_web_state_list_delegate.h"
 #import "ios/chrome/browser/shared/model/web_state_list/web_state_list.h"
 #import "ios/chrome/browser/shared/model/web_state_list/web_state_opener.h"
 #import "ios/web/public/session/crw_session_storage.h"
 #import "ios/web/public/session/serializable_user_data_manager.h"
 #import "ios/web/public/test/fakes/fake_web_state.h"
 #import "testing/gtest/include/gtest/gtest.h"
 #import "testing/gtest_mac.h"
 #import "testing/platform_test.h"

 // To get access to web::features::kEnableSessionSerializationOptimizations.
 // TODO(crbug.com/1383087): remove once the feature is fully launched.
 #import "ios/web/common/features.h"

 namespace {

 // Fixture Class. Takes care of deleting the directory used to store test data.
 class SessionServiceTest : public PlatformTest {
  public:
   SessionServiceTest() {
     scoped_feature_list_.InitAndDisableFeature(
         web::features::kEnableSessionSerializationOptimizations);
   }

   SessionServiceTest(const SessionServiceTest&) = delete;
   SessionServiceTest& operator=(const SessionServiceTest&) = delete;

   ~SessionServiceTest() override = default;

  protected:
   void SetUp() override {
     PlatformTest::SetUp();
     ASSERT_TRUE(scoped_temp_directory_.CreateUniqueTempDir());
     directory_ = scoped_temp_directory_.GetPath();

     scoped_refptr<base::SequencedTaskRunner> task_runner =
         base::SingleThreadTaskRunner::GetCurrentDefault();
     session_service_ =
         [[SessionServiceIOS alloc] initWithTaskRunner:task_runner];
   }

   void TearDown() override {
     session_service_ = nil;
     PlatformTest::TearDown();
   }

   // Returns a WebStateList with `tabs_count` WebStates and activates the first
   // WebState.
   std::unique_ptr<WebStateList> CreateWebStateList(int tabs_count) {
     std::unique_ptr<WebStateList> web_state_list =
         std::make_unique<WebStateList>(&web_state_list_delegate_);
     for (int i = 0; i < tabs_count; ++i) {
       auto web_state = std::make_unique<web::FakeWebState>();
       web_state->SetNavigationItemCount(1);
       web_state_list->InsertWebState(i, std::move(web_state),
                                      WebStateList::INSERT_FORCE_INDEX,
                                      WebStateOpener());
     }
     if (tabs_count > 0)
       web_state_list->ActivateWebStateAt(0);
     return web_state_list;
   }

   // Returns the path to serialized SessionWindowIOS from a testdata file named
   // `filename` or nil if the file cannot be found.
   NSString* SessionPathForTestData(const base::FilePath::CharType* filename) {
     base::FilePath session_path;
     if (!base::PathService::Get(ios::DIR_TEST_DATA, &session_path))
       return nil;

     session_path = session_path.Append(FILE_PATH_LITERAL("sessions"));
     session_path = session_path.Append(filename);
     if (!base::PathExists(session_path))
       return nil;

     return base::apple::FilePathToNSString(session_path);
   }

   SessionServiceIOS* session_service() { return session_service_; }

   const base::FilePath& directory() const { return directory_; }

   NSString* directory_as_nsstring() const {
     return base::apple::FilePathToNSString(directory());
   }

  private:
   base::ScopedTempDir scoped_temp_directory_;
   base::test::TaskEnvironment task_environment_;
   base::test::ScopedFeatureList scoped_feature_list_;
   SessionServiceIOS* session_service_ = nil;
   FakeWebStateListDelegate web_state_list_delegate_;
   base::FilePath directory_;
 };

 TEST_F(SessionServiceTest, SessionPathForDirectory) {
   const base::FilePath root(FILE_PATH_LITERAL("root"));
   EXPECT_NSEQ(@"root/Sessions/session-id/session.plist",
               [SessionServiceIOS sessionPathForSessionID:@"session-id"
                                                directory:root]);
 }

 TEST_F(SessionServiceTest, SaveSessionWindowToPath) {
   std::unique_ptr<WebStateList> web_state_list = CreateWebStateList(0);
   SessionIOSFactory* factory =
       [[SessionIOSFactory alloc] initWithWebStateList:web_state_list.get()];

   NSString* session_id = [[NSUUID UUID] UUIDString];
   [session_service() saveSession:factory
                        sessionID:session_id
                        directory:directory()
                      immediately:YES];

   // Even if `immediately` is YES, the file is created by a task on the task
   // runner passed to SessionServiceIOS initializer (which is the current
   // thread task runner during test). Wait for the task to complete.
   base::RunLoop().RunUntilIdle();

   NSFileManager* file_manager = [NSFileManager defaultManager];
   EXPECT_TRUE([file_manager removeItemAtPath:directory_as_nsstring()
                                        error:nullptr]);
 }

 TEST_F(SessionServiceTest, SaveSessionWindowToPathDirectoryExists) {
   ASSERT_TRUE([[NSFileManager defaultManager]
             createDirectoryAtPath:directory_as_nsstring()
       withIntermediateDirectories:YES
                        attributes:nil
                             error:nullptr]);
   std::unique_ptr<WebStateList> web_state_list = CreateWebStateList(0);
   SessionIOSFactory* factory =
       [[SessionIOSFactory alloc] initWithWebStateList:web_state_list.get()];

   NSString* session_id = [[NSUUID UUID] UUIDString];
   [session_service() saveSession:factory
                        sessionID:session_id
                        directory:directory()
                      immediately:YES];

   // Even if `immediately` is YES, the file is created by a task on the task
   // runner passed to SessionServiceIOS initializer (which is the current
   // thread task runner during test). Wait for the task to complete.
   base::RunLoop().RunUntilIdle();

   NSFileManager* file_manager = [NSFileManager defaultManager];
   EXPECT_TRUE([file_manager removeItemAtPath:directory_as_nsstring()
                                        error:nullptr]);
 }

 TEST_F(SessionServiceTest, LoadSessionFromDirectoryNoFile) {
   NSString* session_id = [[NSUUID UUID] UUIDString];
   SessionIOS* session =
       [session_service() loadSessionWithSessionID:session_id
                                         directory:directory()];
   EXPECT_TRUE(session == nil);
 }

 // Tests that the session service doesn't retain the SessionIOSFactory, and that
 // SaveSession will be no-op if the factory is destroyed earlier.
 TEST_F(SessionServiceTest, SaveExpiredSession) {
   std::unique_ptr<WebStateList> web_state_list = CreateWebStateList(2);
   SessionIOSFactory* factory =
       [[SessionIOSFactory alloc] initWithWebStateList:web_state_list.get()];

   NSString* session_id = [[NSUUID UUID] UUIDString];
   [session_service() saveSession:factory
                        sessionID:session_id
                        directory:directory()
                      immediately:NO];
   [factory disconnect];
   factory = nil;
   // Make sure that the delay for saving a session has passed (at least 2.5
   // seconds)
   base::test::ios::SpinRunLoopWithMinDelay(base::Seconds(2.5));
   base::RunLoop().RunUntilIdle();

   SessionIOS* session =
       [session_service() loadSessionWithSessionID:session_id
                                         directory:directory()];
   EXPECT_FALSE(session);
 }

 TEST_F(SessionServiceTest, LoadSessionFromDirectory) {
   std::unique_ptr<WebStateList> web_state_list = CreateWebStateList(2);
   SessionIOSFactory* factory =
       [[SessionIOSFactory alloc] initWithWebStateList:web_state_list.get()];

   NSString* session_id = [[NSUUID UUID] UUIDString];
   [session_service() saveSession:factory
                        sessionID:session_id
                        directory:directory()
                      immediately:YES];

   // Even if `immediately` is YES, the file is created by a task on the task
   // runner passed to SessionServiceIOS initializer (which is the current
   // thread task runner during test). Wait for the task to complete.
   base::RunLoop().RunUntilIdle();

   SessionIOS* session =
       [session_service() loadSessionWithSessionID:session_id
                                         directory:directory()];
   EXPECT_EQ(1u, session.sessionWindows.count);
   EXPECT_EQ(2u, session.sessionWindows[0].sessions.count);
   EXPECT_EQ(0u, session.sessionWindows[0].selectedIndex);
 }

 TEST_F(SessionServiceTest, LoadSessionFromPath) {
   std::unique_ptr<WebStateList> web_state_list = CreateWebStateList(2);
   SessionIOSFactory* factory =
       [[SessionIOSFactory alloc] initWithWebStateList:web_state_list.get()];

   NSString* session_id = [[NSUUID UUID] UUIDString];
   [session_service() saveSession:factory
                        sessionID:session_id
                        directory:directory()
                      immediately:YES];

   // Even if `immediately` is YES, the file is created by a task on the task
   // runner passed to SessionServiceIOS initializer (which is the current
   // thread task runner during test). Wait for the task to complete.
   base::RunLoop().RunUntilIdle();

   NSString* session_path =
       [SessionServiceIOS sessionPathForSessionID:session_id
                                        directory:directory()];
   NSString* renamed_path = [session_path stringByAppendingPathExtension:@"bak"];
   ASSERT_NSNE(session_path, renamed_path);

   // Rename the file.
   ASSERT_TRUE([[NSFileManager defaultManager] moveItemAtPath:session_path
                                                       toPath:renamed_path
                                                        error:nil]);

   SessionIOS* session = [session_service() loadSessionFromPath:renamed_path];
   EXPECT_EQ(1u, session.sessionWindows.count);
   EXPECT_EQ(2u, session.sessionWindows[0].sessions.count);
   EXPECT_EQ(0u, session.sessionWindows[0].selectedIndex);
 }

 TEST_F(SessionServiceTest, LoadCorruptedSession) {
   NSString* session_path =
       SessionPathForTestData(FILE_PATH_LITERAL("corrupted.plist"));
   ASSERT_NSNE(nil, session_path);
   SessionIOS* session = [session_service() loadSessionFromPath:session_path];
   EXPECT_TRUE(session == nil);
 }

 // TODO(crbug.com/661633): remove this once M67 has shipped (i.e. once more
 // than a year has passed since the introduction of the compatibility code).
 TEST_F(SessionServiceTest, LoadM57Session) {
   NSString* session_path =
       SessionPathForTestData(FILE_PATH_LITERAL("session_m57.plist"));
   ASSERT_NSNE(nil, session_path);
   SessionIOS* session = [session_service() loadSessionFromPath:session_path];
   EXPECT_EQ(1u, session.sessionWindows.count);
 }

 // TODO(crbug.com/661633): remove this once M68 has shipped (i.e. once more
 // than a year has passed since the introduction of the compatibility code).
 TEST_F(SessionServiceTest, LoadM58Session) {
   NSString* session_path =
       SessionPathForTestData(FILE_PATH_LITERAL("session_m58.plist"));
   ASSERT_NSNE(nil, session_path);
   SessionIOS* session = [session_service() loadSessionFromPath:session_path];
   EXPECT_EQ(1u, session.sessionWindows.count);
 }

 }  // anonymous namespace
	// Copyright 2012 The Chromium Authors
	// Use of this source code is governed by a BSD-style license that can be
	// found in the LICENSE file.

	#import <Foundation/Foundation.h>

	#import <memory>

	#import "base/apple/foundation_util.h"
	#import "base/files/file_path.h"
	#import "base/files/file_util.h"
	#import "base/files/scoped_temp_dir.h"
	#import "base/path_service.h"
	#import "base/run_loop.h"
	#import "base/task/sequenced_task_runner.h"
	#import "base/task/single_thread_task_runner.h"
	#import "base/test/ios/wait_util.h"
	#import "base/test/scoped_feature_list.h"
	#import "base/test/task_environment.h"
	#import "ios/chrome/browser/sessions/session_ios.h"
	#import "ios/chrome/browser/sessions/session_ios_factory.h"
	#import "ios/chrome/browser/sessions/session_service_ios.h"
	#import "ios/chrome/browser/sessions/session_window_ios.h"
	#import "ios/chrome/browser/shared/model/paths/paths.h"
	#import "ios/chrome/browser/shared/model/web_state_list/test/fake_web_state_list_delegate.h"
	#import "ios/chrome/browser/shared/model/web_state_list/web_state_list.h"
	#import "ios/chrome/browser/shared/model/web_state_list/web_state_opener.h"
	#import "ios/web/public/session/crw_session_storage.h"
	#import "ios/web/public/session/serializable_user_data_manager.h"
	#import "ios/web/public/test/fakes/fake_web_state.h"
	#import "testing/gtest/include/gtest/gtest.h"
	#import "testing/gtest_mac.h"
	#import "testing/platform_test.h"

	// To get access to web::features::kEnableSessionSerializationOptimizations.
	// TODO(crbug.com/1383087): remove once the feature is fully launched.
	#import "ios/web/common/features.h"

	namespace {

	// Fixture Class. Takes care of deleting the directory used to store test data.
	class SessionServiceTest : public PlatformTest {
	public:
	SessionServiceTest() {
	scoped_feature_list_.InitAndDisableFeature(
	web::features::kEnableSessionSerializationOptimizations);
	}

	SessionServiceTest(const SessionServiceTest&) = delete;
	SessionServiceTest& operator=(const SessionServiceTest&) = delete;

	~SessionServiceTest() override = default;

	protected:
	void SetUp() override {
	PlatformTest::SetUp();
	ASSERT_TRUE(scoped_temp_directory_.CreateUniqueTempDir());
	directory_ = scoped_temp_directory_.GetPath();

	scoped_refptr<base::SequencedTaskRunner> task_runner =
	base::SingleThreadTaskRunner::GetCurrentDefault();
	session_service_ =
	[[SessionServiceIOS alloc] initWithTaskRunner:task_runner];
	}

	void TearDown() override {
	session_service_ = nil;
	PlatformTest::TearDown();
	}

	// Returns a WebStateList with `tabs_count` WebStates and activates the first
	// WebState.
	std::unique_ptr<WebStateList> CreateWebStateList(int tabs_count) {
	std::unique_ptr<WebStateList> web_state_list =
	std::make_unique<WebStateList>(&web_state_list_delegate_);
	for (int i = 0; i < tabs_count; ++i) {
	auto web_state = std::make_unique<web::FakeWebState>();
	web_state->SetNavigationItemCount(1);
	web_state_list->InsertWebState(i, std::move(web_state),
	WebStateList::INSERT_FORCE_INDEX,
	WebStateOpener());
	}
	if (tabs_count > 0)
	web_state_list->ActivateWebStateAt(0);
	return web_state_list;
	}

	// Returns the path to serialized SessionWindowIOS from a testdata file named
	// `filename` or nil if the file cannot be found.
	NSString* SessionPathForTestData(const base::FilePath::CharType* filename) {
	base::FilePath session_path;
	if (!base::PathService::Get(ios::DIR_TEST_DATA, &session_path))
	return nil;

	session_path = session_path.Append(FILE_PATH_LITERAL("sessions"));
	session_path = session_path.Append(filename);
	if (!base::PathExists(session_path))
	return nil;

	return base::apple::FilePathToNSString(session_path);
	}

	SessionServiceIOS* session_service() { return session_service_; }

	const base::FilePath& directory() const { return directory_; }

	NSString* directory_as_nsstring() const {
	return base::apple::FilePathToNSString(directory());
	}

	private:
	base::ScopedTempDir scoped_temp_directory_;
	base::test::TaskEnvironment task_environment_;
	base::test::ScopedFeatureList scoped_feature_list_;
	SessionServiceIOS* session_service_ = nil;
	FakeWebStateListDelegate web_state_list_delegate_;
	base::FilePath directory_;
	};

	TEST_F(SessionServiceTest, SessionPathForDirectory) {
	const base::FilePath root(FILE_PATH_LITERAL("root"));
	EXPECT_NSEQ(@"root/Sessions/session-id/session.plist",
	[SessionServiceIOS sessionPathForSessionID:@"session-id"
	directory:root]);
	}

	TEST_F(SessionServiceTest, SaveSessionWindowToPath) {
	std::unique_ptr<WebStateList> web_state_list = CreateWebStateList(0);
	SessionIOSFactory* factory =
	[[SessionIOSFactory alloc] initWithWebStateList:web_state_list.get()];

	NSString* session_id = [[NSUUID UUID] UUIDString];
	[session_service() saveSession:factory
	sessionID:session_id
	directory:directory()
	immediately:YES];

	// Even if `immediately` is YES, the file is created by a task on the task
	// runner passed to SessionServiceIOS initializer (which is the current
	// thread task runner during test). Wait for the task to complete.
	base::RunLoop().RunUntilIdle();

	NSFileManager* file_manager = [NSFileManager defaultManager];
	EXPECT_TRUE([file_manager removeItemAtPath:directory_as_nsstring()
	error:nullptr]);
	}

	TEST_F(SessionServiceTest, SaveSessionWindowToPathDirectoryExists) {
	ASSERT_TRUE([[NSFileManager defaultManager]
	createDirectoryAtPath:directory_as_nsstring()
	withIntermediateDirectories:YES
	attributes:nil
	error:nullptr]);
	std::unique_ptr<WebStateList> web_state_list = CreateWebStateList(0);
	SessionIOSFactory* factory =
	[[SessionIOSFactory alloc] initWithWebStateList:web_state_list.get()];

	NSString* session_id = [[NSUUID UUID] UUIDString];
	[session_service() saveSession:factory
	sessionID:session_id
	directory:directory()
	immediately:YES];

	// Even if `immediately` is YES, the file is created by a task on the task
	// runner passed to SessionServiceIOS initializer (which is the current
	// thread task runner during test). Wait for the task to complete.
	base::RunLoop().RunUntilIdle();

	NSFileManager* file_manager = [NSFileManager defaultManager];
	EXPECT_TRUE([file_manager removeItemAtPath:directory_as_nsstring()
	error:nullptr]);
	}

	TEST_F(SessionServiceTest, LoadSessionFromDirectoryNoFile) {
	NSString* session_id = [[NSUUID UUID] UUIDString];
	SessionIOS* session =
	[session_service() loadSessionWithSessionID:session_id
	directory:directory()];
	EXPECT_TRUE(session == nil);
	}

	// Tests that the session service doesn't retain the SessionIOSFactory, and that
	// SaveSession will be no-op if the factory is destroyed earlier.
	TEST_F(SessionServiceTest, SaveExpiredSession) {
	std::unique_ptr<WebStateList> web_state_list = CreateWebStateList(2);
	SessionIOSFactory* factory =
	[[SessionIOSFactory alloc] initWithWebStateList:web_state_list.get()];

	NSString* session_id = [[NSUUID UUID] UUIDString];
	[session_service() saveSession:factory
	sessionID:session_id
	directory:directory()
	immediately:NO];
	[factory disconnect];
	factory = nil;
	// Make sure that the delay for saving a session has passed (at least 2.5
	// seconds)
	base::test::ios::SpinRunLoopWithMinDelay(base::Seconds(2.5));
	base::RunLoop().RunUntilIdle();

	SessionIOS* session =
	[session_service() loadSessionWithSessionID:session_id
	directory:directory()];
	EXPECT_FALSE(session);
	}

	TEST_F(SessionServiceTest, LoadSessionFromDirectory) {
	std::unique_ptr<WebStateList> web_state_list = CreateWebStateList(2);
	SessionIOSFactory* factory =
	[[SessionIOSFactory alloc] initWithWebStateList:web_state_list.get()];

	NSString* session_id = [[NSUUID UUID] UUIDString];
	[session_service() saveSession:factory
	sessionID:session_id
	directory:directory()
	immediately:YES];

	// Even if `immediately` is YES, the file is created by a task on the task
	// runner passed to SessionServiceIOS initializer (which is the current
	// thread task runner during test). Wait for the task to complete.
	base::RunLoop().RunUntilIdle();

	SessionIOS* session =
	[session_service() loadSessionWithSessionID:session_id
	directory:directory()];
	EXPECT_EQ(1u, session.sessionWindows.count);
	EXPECT_EQ(2u, session.sessionWindows[0].sessions.count);
	EXPECT_EQ(0u, session.sessionWindows[0].selectedIndex);
	}

	TEST_F(SessionServiceTest, LoadSessionFromPath) {
	std::unique_ptr<WebStateList> web_state_list = CreateWebStateList(2);
	SessionIOSFactory* factory =
	[[SessionIOSFactory alloc] initWithWebStateList:web_state_list.get()];

	NSString* session_id = [[NSUUID UUID] UUIDString];
	[session_service() saveSession:factory
	sessionID:session_id
	directory:directory()
	immediately:YES];

	// Even if `immediately` is YES, the file is created by a task on the task
	// runner passed to SessionServiceIOS initializer (which is the current
	// thread task runner during test). Wait for the task to complete.
	base::RunLoop().RunUntilIdle();

	NSString* session_path =
	[SessionServiceIOS sessionPathForSessionID:session_id
	directory:directory()];
	NSString* renamed_path = [session_path stringByAppendingPathExtension:@"bak"];
	ASSERT_NSNE(session_path, renamed_path);

	// Rename the file.
	ASSERT_TRUE([[NSFileManager defaultManager] moveItemAtPath:session_path
	toPath:renamed_path
	error:nil]);

	SessionIOS* session = [session_service() loadSessionFromPath:renamed_path];
	EXPECT_EQ(1u, session.sessionWindows.count);
	EXPECT_EQ(2u, session.sessionWindows[0].sessions.count);
	EXPECT_EQ(0u, session.sessionWindows[0].selectedIndex);
	}

	TEST_F(SessionServiceTest, LoadCorruptedSession) {
	NSString* session_path =
	SessionPathForTestData(FILE_PATH_LITERAL("corrupted.plist"));
	ASSERT_NSNE(nil, session_path);
	SessionIOS* session = [session_service() loadSessionFromPath:session_path];
	EXPECT_TRUE(session == nil);
	}

	// TODO(crbug.com/661633): remove this once M67 has shipped (i.e. once more
	// than a year has passed since the introduction of the compatibility code).
	TEST_F(SessionServiceTest, LoadM57Session) {
	NSString* session_path =
	SessionPathForTestData(FILE_PATH_LITERAL("session_m57.plist"));
	ASSERT_NSNE(nil, session_path);
	SessionIOS* session = [session_service() loadSessionFromPath:session_path];
	EXPECT_EQ(1u, session.sessionWindows.count);
	}

	// TODO(crbug.com/661633): remove this once M68 has shipped (i.e. once more
	// than a year has passed since the introduction of the compatibility code).
	TEST_F(SessionServiceTest, LoadM58Session) {
	NSString* session_path =
	SessionPathForTestData(FILE_PATH_LITERAL("session_m58.plist"));
	ASSERT_NSNE(nil, session_path);
	SessionIOS* session = [session_service() loadSessionFromPath:session_path];
	EXPECT_EQ(1u, session.sessionWindows.count);
	}

	} // anonymous namespace