chrome/browser/sessions/session_service_test_helper.h

// 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.

#ifndef CHROME_BROWSER_SESSIONS_SESSION_SERVICE_TEST_HELPER_H_
#define CHROME_BROWSER_SESSIONS_SESSION_SERVICE_TEST_HELPER_H_

#include <stddef.h>

#include <memory>
#include <set>
#include <string>
#include <utility>
#include <vector>

#include "base/functional/callback_forward.h"
#include "base/memory/raw_ptr.h"
#include "base/memory/scoped_refptr.h"
#include "components/sessions/core/session_id.h"

class Profile;
class SessionService;

namespace base {
class Location;
class SequencedTaskRunner;
}

namespace sessions {
class CommandStorageManager;
class SerializedNavigationEntry;
struct SerializedUserAgentOverride;
struct SessionTab;
struct SessionWindow;
}

// A simple class that makes writing SessionService related tests easier.

class SessionServiceTestHelper {
 public:
  SessionServiceTestHelper();
  explicit SessionServiceTestHelper(Profile* profile);
  explicit SessionServiceTestHelper(SessionService* service);
  SessionServiceTestHelper(const SessionServiceTestHelper&) = delete;
  SessionServiceTestHelper& operator=(const SessionServiceTestHelper&) = delete;
  ~SessionServiceTestHelper();

  void SaveNow();

  void PrepareTabInWindow(SessionID window_id,
                          SessionID tab_id,
                          int visual_index,
                          bool select);

  void SetTabExtensionAppID(SessionID window_id,
                            SessionID tab_id,
                            const std::string& extension_app_id);

  void SetTabUserAgentOverride(
      SessionID window_id,
      SessionID tab_id,
      const sessions::SerializedUserAgentOverride& user_agent_override);

  void SetForceBrowserNotAliveWithNoWindows(
      bool force_browser_not_alive_with_no_windows);

  // Reads the contents of the last session.
  void ReadWindows(
      std::vector<std::unique_ptr<sessions::SessionWindow>>* windows,
      SessionID* active_window_id,
      std::string* platform_session_id,
      std::set<SessionID>* discarded_window_ids);

  void AssertTabEquals(SessionID window_id,
                       SessionID tab_id,
                       int visual_index,
                       int nav_index,
                       size_t nav_count,
                       const sessions::SessionTab& session_tab);

  void AssertTabEquals(int visual_index,
                       int nav_index,
                       size_t nav_count,
                       const sessions::SessionTab& session_tab);

  void AssertNavigationEquals(
      const sessions::SerializedNavigationEntry& expected,
      const sessions::SerializedNavigationEntry& actual);

  void AssertSingleWindowWithSingleTab(
      const std::vector<std::unique_ptr<sessions::SessionWindow>>& windows,
      size_t nav_count);

  void SetService(SessionService* service);
  SessionService* service() { return service_; }

  void RunTaskOnBackendThread(const base::Location& from_here,
                              base::OnceClosure task);

  scoped_refptr<base::SequencedTaskRunner> GetBackendTaskRunner();

  void SetAvailableRange(SessionID tab_id, const std::pair<int, int>& range);
  bool GetAvailableRange(SessionID tab_id, std::pair<int, int>* range);

  void SetHasOpenTrackableBrowsers(bool has_open_trackable_browsers);
  bool GetHasOpenTrackableBrowsers();

  void SetIsOnlyOneTabLeft(bool is_only_one_tab_left);

  bool HasPendingReset();

  bool HasPendingSave();

  void SetSavingEnabled(bool enabled);

  bool did_save_commands_at_least_once() const;

  sessions::CommandStorageManager* command_storage_manager();

 private:
  raw_ptr<SessionService, DanglingUntriaged> service_;
};

#endif  // CHROME_BROWSER_SESSIONS_SESSION_SERVICE_TEST_HELPER_H_