1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
|
// Copyright 2017 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_NOTIFICATIONS_NOTIFICATION_DISPLAY_SERVICE_TESTER_H_
#define CHROME_BROWSER_NOTIFICATIONS_NOTIFICATION_DISPLAY_SERVICE_TESTER_H_
#include <optional>
#include <string>
#include <vector>
#include "base/functional/callback_forward.h"
#include "base/memory/raw_ptr.h"
#include "chrome/browser/notifications/notification_common.h"
#include "chrome/browser/notifications/stub_notification_display_service.h"
#include "components/keyed_service/core/keyed_service_shutdown_notifier.h"
class Profile;
namespace message_center {
class Notification;
}
// Helper class that enables use of the NotificationDisplayService in tests. The
// Profile* passed when constructing an instance may outlive this class.
//
// This class must only be used for testing purposes. Unlike most production
// NotificationDisplayService implementations, all operations on this tester are
// synchronous.
class NotificationDisplayServiceTester {
public:
// |profile| - the profile with which |display_service_| will be associated.
// It can be nullptr, in which case |display_service_| will be set up as a
// system notification display service.
explicit NotificationDisplayServiceTester(Profile* profile);
NotificationDisplayServiceTester(const NotificationDisplayServiceTester&) =
delete;
NotificationDisplayServiceTester& operator=(
const NotificationDisplayServiceTester&) = delete;
~NotificationDisplayServiceTester();
// Returns the currently active tester, if any.
static NotificationDisplayServiceTester* Get();
// Sets |closure| to be invoked when any notification has been added.
void SetNotificationAddedClosure(base::RepeatingClosure closure);
// Sets |closure| to be invoked when any notification has been closed.
void SetNotificationClosedClosure(base::RepeatingClosure closure);
// Synchronously gets a vector of the displayed Notifications for the |type|.
std::vector<message_center::Notification> GetDisplayedNotificationsForType(
NotificationHandler::Type type);
const NotificationCommon::Metadata* GetMetadataForNotification(
const message_center::Notification& notification);
std::optional<message_center::Notification> GetNotification(
const std::string& notification_id) const;
// Simulates the notification identified by |notification_id| being clicked
// on, optionally with the given |action_index| and |reply|.
void SimulateClick(NotificationHandler::Type notification_type,
const std::string& notification_id,
std::optional<int> action_index,
std::optional<std::u16string> reply);
// Simulates a click on the settings button of the notification identified by
// |notification_id|.
void SimulateSettingsClick(NotificationHandler::Type notification_type,
const std::string& notification_id);
// Simulates the notification identified by |notification_id| being closed due
// to external events, such as the user dismissing it when |by_user| is set.
// When |silent| is set, the notification handlers won't be informed of the
// change to immitate behaviour of operating systems that don't inform apps
// about removed notifications.
void RemoveNotification(NotificationHandler::Type type,
const std::string& notification_id,
bool by_user,
bool silent = false);
// Removes all notifications of the given |type|.
void RemoveAllNotifications(NotificationHandler::Type type, bool by_user);
// Sets a |delegate| to notify when ProcessNotificationOperation is called.
void SetProcessNotificationOperationDelegate(
const StubNotificationDisplayService::
ProcessNotificationOperationCallback& delegate);
static void EnsureFactoryBuilt();
private:
void OnProfileShutdown();
raw_ptr<Profile> profile_;
raw_ptr<StubNotificationDisplayService, AcrossTasksDanglingUntriaged>
display_service_;
base::CallbackListSubscription profile_shutdown_subscription_;
};
#endif // CHROME_BROWSER_NOTIFICATIONS_NOTIFICATION_DISPLAY_SERVICE_TESTER_H_
|
