components/user_education/test/user_education_session_mocks.h

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

#ifndef COMPONENTS_USER_EDUCATION_TEST_USER_EDUCATION_SESSION_MOCKS_H_
#define COMPONENTS_USER_EDUCATION_TEST_USER_EDUCATION_SESSION_MOCKS_H_

#include "base/callback_list.h"
#include "components/user_education/common/feature_promo/feature_promo_session_policy.h"
#include "components/user_education/common/session/user_education_idle_observer.h"
#include "components/user_education/common/session/user_education_idle_policy.h"
#include "components/user_education/common/session/user_education_session_manager.h"
#include "testing/gmock/include/gmock/gmock.h"

namespace user_education::test {

// Version of `IdleObserver` that returns a provided state and which sends state
// updates only when `UpdateState()` is called.
class TestIdleObserver : public UserEducationIdleObserver {
 public:
  explicit TestIdleObserver(std::optional<base::Time> initial_active_time);
  ~TestIdleObserver() override;

  // Call to modify the current state and optionally send an update.
  void SetLastActiveTime(std::optional<base::Time> new_last_active_time,
                         bool send_update);

 private:
  // UserEducationIdleObserver:
  void StartObserving() final;
  std::optional<base::Time> MaybeGetNewLastActiveTime() const final;

  std::optional<base::Time> last_active_time_;
};

// Mock version of `IdlePolicy` that allows specific queries to be intercepted.
class MockIdlePolicy : public UserEducationIdlePolicy {
 public:
  MockIdlePolicy();
  ~MockIdlePolicy() override;

  MOCK_METHOD(bool,
              IsNewSession,
              (base::Time, base::Time, base::Time),
              (const, override));
};

// Fakes the behavior of a session provider.
class TestUserEducationSessionProvider : public UserEducationSessionProvider {
 public:
  explicit TestUserEducationSessionProvider(bool has_new_session);
  ~TestUserEducationSessionProvider() override;

  // UserEducationSessionProvider:
  base::CallbackListSubscription AddNewSessionCallback(
      base::RepeatingClosure new_session_callback) override;
  bool GetNewSessionSinceStartup() const override;

  // Starts a new session.
  void StartNewSession();

 private:
  base::RepeatingClosureList callbacks_;
  bool has_new_session_;
};

// Mock version of `UserEducationSessionManager` that can monitor when updates
// or new sessions happen.
class MockUserEducationSessionManager : public UserEducationSessionManager {
 public:
  MockUserEducationSessionManager();
  ~MockUserEducationSessionManager() override;
  MOCK_METHOD(void, OnLastActiveTimeUpdating, (base::Time), (override));
  MOCK_METHOD(void,
              OnNewSession,
              (const base::Time, const base::Time, const base::Time),
              (override));
};

// Allows for overriding of `CanShowPromo()`. Other methods work as they
// currently do in order to ensure that data is written to storage. Note that
// a session manager is not necessary and may be passed to `Init()` as
// `nullptr`.
class MockFeaturePromoSessionPolicy : public FeaturePromoSessionPolicy {
 public:
  MockFeaturePromoSessionPolicy();
  ~MockFeaturePromoSessionPolicy() override;

  MOCK_METHOD(FeaturePromoResult,
              CanShowPromo,
              (PromoPriorityInfo to_show,
               std::optional<PromoPriorityInfo> currently_showing),
              (const override));
};

}  // namespace user_education::test

#endif  // COMPONENTS_USER_EDUCATION_TEST_USER_EDUCATION_SESSION_MOCKS_H_