Add tests for the XPC client.

chrome/browser/notifications/notification_platform_bridge_mac_unittest.mm

 // Copyright 2016 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #import <AppKit/AppKit.h>
 #import <objc/runtime.h>
 
 #include "base/mac/scoped_nsobject.h"
-#import "base/mac/scoped_objc_class_swizzler.h"
 #include "base/strings/utf_string_conversions.h"
 #include "chrome/browser/notifications/notification.h"
 #include "chrome/browser/notifications/notification_platform_bridge_mac.h"
 #include "chrome/browser/notifications/notification_test_util.h"
+#include "chrome/browser/notifications/stub_alert_dispatcher_mac.h"
 #include "chrome/browser/notifications/stub_notification_center_mac.h"
 #include "chrome/browser/ui/cocoa/notifications/notification_builder_mac.h"
 #include "chrome/browser/ui/cocoa/notifications/notification_constants_mac.h"
 #include "chrome/browser/ui/cocoa/notifications/notification_response_builder_mac.h"
+#include "chrome/common/features.h"
 #include "testing/gtest/include/gtest/gtest.h"
 #include "testing/gtest_mac.h"
 #include "url/gurl.h"
 
 class NotificationPlatformBridgeMacTest : public testing::Test {
  public:
   void SetUp() override {
     notification_center_.reset([[StubNotificationCenter alloc] init]);
   }
 
@@ skipping 15 matching lines @@
     [builder setTag:@"tag1"];
     [builder setIcon:[NSImage imageNamed:@"NSApplicationIcon"]];
     [builder setNotificationId:@"notification_id"];
     [builder setProfileId:@"profile_id"];
     [builder setIncognito:false];
     [builder setNotificationType:@(NotificationCommon::PERSISTENT)];
 
     return [builder buildUserNotification];
   }
 
+  std::unique_ptr<Notification> CreateBanner(const char* title,
+                                             const char* subtitle,
+                                             const char* origin,
+                                             const char* button1,
+                                             const char* button2) {
+    return CreateNotification(title, subtitle, origin, button1, button2,
+                              false /* require_interaction */);
+  }
+
+  std::unique_ptr<Notification> CreateAlert(const char* title,
+                                            const char* subtitle,
+                                            const char* origin,
+                                            const char* button1,
+                                            const char* button2) {
+    return CreateNotification(title, subtitle, origin, button1, button2,
+                              true /* require_interaction */);
+  }
+
   std::unique_ptr<Notification> CreateNotification(const char* title,
                                                    const char* subtitle,
                                                    const char* origin,
                                                    const char* button1,
-                                                   const char* button2) {
+                                                   const char* button2,
+                                                   bool require_interaction) {
     message_center::RichNotificationData optional_fields;
     optional_fields.context_message = base::UTF8ToUTF16(origin);
     if (button1) {
       optional_fields.buttons.push_back(
           message_center::ButtonInfo(base::UTF8ToUTF16(button1)));
       if (button2) {
         optional_fields.buttons.push_back(
             message_center::ButtonInfo(base::UTF8ToUTF16(button2)));
       }
     }
 
     GURL url = GURL(origin);
 
     std::unique_ptr<Notification> notification(new Notification(
         message_center::NOTIFICATION_TYPE_SIMPLE, base::UTF8ToUTF16(title),
         base::UTF8ToUTF16(subtitle), gfx::Image(),
         message_center::NotifierId(url), base::UTF8ToUTF16("Notifier's Name"),
         url, "id1", optional_fields, new MockNotificationDelegate("id1")));
+    if (require_interaction)
+      notification->set_never_timeout(true);
 
     return notification;
   }
 
   NSMutableDictionary* BuildDefaultNotificationResponse() {
     return [NSMutableDictionary
         dictionaryWithDictionary:[NotificationResponseBuilder
                                      buildDictionary:BuildNotification()]];
   }
 
@@ skipping 65 matching lines @@
   [response setValue:@"invalidorigin"
               forKey:notification_constants::kNotificationOrigin];
   EXPECT_FALSE(NotificationPlatformBridgeMac::VerifyNotificationData(response));
 
   // If however the origin is not present the response should be fine.
   [response removeObjectForKey:notification_constants::kNotificationOrigin];
   EXPECT_TRUE(NotificationPlatformBridgeMac::VerifyNotificationData(response));
 }
 
 TEST_F(NotificationPlatformBridgeMacTest, TestDisplayNoButtons) {
-  std::unique_ptr<Notification> notification = CreateNotification(
-      "Title", "Context", "https://gmail.com", nullptr, nullptr);
+  std::unique_ptr<Notification> notification =
+      CreateBanner("Title", "Context", "https://gmail.com", nullptr, nullptr);
 
   std::unique_ptr<NotificationPlatformBridgeMac> bridge(
-      new NotificationPlatformBridgeMac(notification_center()));
+      new NotificationPlatformBridgeMac(notification_center(), nullptr));
   bridge->Display(NotificationCommon::PERSISTENT, "notification_id",
                   "profile_id", false, *notification);
   NSArray* notifications = [notification_center() deliveredNotifications];
 
   EXPECT_EQ(1u, [notifications count]);
 
   NSUserNotification* delivered_notification = [notifications objectAtIndex:0];
   EXPECT_NSEQ(@"Title", [delivered_notification title]);
   EXPECT_NSEQ(@"Context", [delivered_notification informativeText]);
   EXPECT_NSEQ(@"https://gmail.com", [delivered_notification subtitle]);
   EXPECT_NSEQ(@"Close", [delivered_notification otherButtonTitle]);
   EXPECT_NSEQ(@"Settings", [delivered_notification actionButtonTitle]);
 }
 
 TEST_F(NotificationPlatformBridgeMacTest, TestDisplayOneButton) {
-  std::unique_ptr<Notification> notification = CreateNotification(
+  std::unique_ptr<Notification> notification = CreateBanner(
       "Title", "Context", "https://gmail.com", "Button 1", nullptr);
 
   std::unique_ptr<NotificationPlatformBridgeMac> bridge(
-      new NotificationPlatformBridgeMac(notification_center()));
+      new NotificationPlatformBridgeMac(notification_center(), nullptr));
   bridge->Display(NotificationCommon::PERSISTENT, "notification_id",
                   "profile_id", false, *notification);
 
   NSArray* notifications = [notification_center() deliveredNotifications];
   EXPECT_EQ(1u, [notifications count]);
   NSUserNotification* delivered_notification = [notifications objectAtIndex:0];
   EXPECT_NSEQ(@"Title", [delivered_notification title]);
   EXPECT_NSEQ(@"Context", [delivered_notification informativeText]);
   EXPECT_NSEQ(@"https://gmail.com", [delivered_notification subtitle]);
   EXPECT_NSEQ(@"Close", [delivered_notification otherButtonTitle]);
   EXPECT_NSEQ(@"Options", [delivered_notification actionButtonTitle]);
 }
 
 TEST_F(NotificationPlatformBridgeMacTest, TestCloseNotification) {
-  std::unique_ptr<Notification> notification = CreateNotification(
+  std::unique_ptr<Notification> notification = CreateBanner(
       "Title", "Context", "https://gmail.com", "Button 1", nullptr);
 
   std::unique_ptr<NotificationPlatformBridgeMac> bridge(
-      new NotificationPlatformBridgeMac(notification_center()));
+      new NotificationPlatformBridgeMac(notification_center(), nullptr));
   EXPECT_EQ(0u, [[notification_center() deliveredNotifications] count]);
   bridge->Display(NotificationCommon::PERSISTENT, "notification_id",
                   "profile_id", false, *notification);
   EXPECT_EQ(1u, [[notification_center() deliveredNotifications] count]);
 
   bridge->Close("profile_id", "notification_id");
   EXPECT_EQ(0u, [[notification_center() deliveredNotifications] count]);
 }
 
 TEST_F(NotificationPlatformBridgeMacTest, TestCloseNonExistingNotification) {
-  std::unique_ptr<Notification> notification = CreateNotification(
+  std::unique_ptr<Notification> notification = CreateBanner(
       "Title", "Context", "https://gmail.com", "Button 1", nullptr);
 
   std::unique_ptr<NotificationPlatformBridgeMac> bridge(
-      new NotificationPlatformBridgeMac(notification_center()));
+      new NotificationPlatformBridgeMac(notification_center(), nullptr));
   EXPECT_EQ(0u, [[notification_center() deliveredNotifications] count]);
   bridge->Display(NotificationCommon::PERSISTENT, "notification_id",
                   "profile_id", false, *notification);
   EXPECT_EQ(1u, [[notification_center() deliveredNotifications] count]);
 
   bridge->Close("profile_id_does_not_exist", "notification_id");
   EXPECT_EQ(1u, [[notification_center() deliveredNotifications] count]);
 }
 
 TEST_F(NotificationPlatformBridgeMacTest, TestGetDisplayed) {
-  std::unique_ptr<Notification> notification = CreateNotification(
+  std::unique_ptr<Notification> notification = CreateBanner(
       "Title", "Context", "https://gmail.com", "Button 1", nullptr);
   std::unique_ptr<NotificationPlatformBridgeMac> bridge(
-      new NotificationPlatformBridgeMac(notification_center()));
+      new NotificationPlatformBridgeMac(notification_center(), nullptr));
   EXPECT_EQ(0u, [[notification_center() deliveredNotifications] count]);
   bridge->Display(NotificationCommon::PERSISTENT, "notification_id",
                   "profile_id", false, *notification);
   EXPECT_EQ(1u, [[notification_center() deliveredNotifications] count]);
 
   std::set<std::string> notifications;
   EXPECT_TRUE(bridge->GetDisplayed("profile_id", false, &notifications));
   EXPECT_EQ(1u, notifications.size());
 }
 
 TEST_F(NotificationPlatformBridgeMacTest, TestGetDisplayedUnknownProfile) {
-  std::unique_ptr<Notification> notification = CreateNotification(
+  std::unique_ptr<Notification> notification = CreateBanner(
       "Title", "Context", "https://gmail.com", "Button 1", nullptr);
   std::unique_ptr<NotificationPlatformBridgeMac> bridge(
-      new NotificationPlatformBridgeMac(notification_center()));
+      new NotificationPlatformBridgeMac(notification_center(), nullptr));
   EXPECT_EQ(0u, [[notification_center() deliveredNotifications] count]);
   bridge->Display(NotificationCommon::PERSISTENT, "notification_id",
                   "profile_id", false, *notification);
   EXPECT_EQ(1u, [[notification_center() deliveredNotifications] count]);
 
   std::set<std::string> notifications;
   EXPECT_TRUE(
       bridge->GetDisplayed("unknown_profile_id", false, &notifications));
   EXPECT_EQ(0u, notifications.size());
 }
 
 TEST_F(NotificationPlatformBridgeMacTest, TestQuitRemovesNotifications) {
-  std::unique_ptr<Notification> notification = CreateNotification(
+  std::unique_ptr<Notification> notification = CreateBanner(
       "Title", "Context", "https://gmail.com", "Button 1", nullptr);
   {
     std::unique_ptr<NotificationPlatformBridgeMac> bridge(
-        new NotificationPlatformBridgeMac(notification_center()));
+        new NotificationPlatformBridgeMac(notification_center(), nullptr));
     EXPECT_EQ(0u, [[notification_center() deliveredNotifications] count]);
     bridge->Display(NotificationCommon::PERSISTENT, "notification_id",
                     "profile_id", false, *notification);
     EXPECT_EQ(1u, [[notification_center() deliveredNotifications] count]);
   }
 
   // The destructor of the bridge should close all notifications.
   EXPECT_EQ(0u, [[notification_center() deliveredNotifications] count]);
 }
+
+// TODO(miguelg) There is some duplication between these tests and the ones
+// Above. Once the flag is removed most tests can be merged.
+#if BUILDFLAG(ENABLE_XPC_NOTIFICATIONS)
+TEST_F(NotificationPlatformBridgeMacTest, TestDisplayAlert) {
+  StubAlertDispatcher* alert_dispatcher = [[StubAlertDispatcher alloc] init];

[Robert Sesek, 2016/11/11 19:21:16]

The ownership here is a bit odd. I'd expect this to be in a scoped_nsobject if
it were local. But it's going to be owned now by the Bridge, so I'd expect it to
also be in a scoped_nsobject and std::move'd to the Bridge. But it still needs
to be referenced below.

I think to make this a little more conventional, place the alert_dispatcher in a
scoped_nsobject, have Bridge take just a pointer to it, and then the Bridge can
-retain it and place it in a scoped_nsprotocol.

OR

Make NotificationPlatformBridgeMac() take in a scoped_nsprotocol and keep a weak
pointer to it here.

[Miguel Garcia, 2016/11/21 11:57:56]

Ok so after our chat I went with retaining both the notification center and the
alert dispatcher in a scoped_ns{object,protocol}. 


On 2016/11/11 19:21:16, Robert Sesek wrote:

+  std::unique_ptr<Notification> alert =
+      CreateAlert("Title", "Context", "https://gmail.com", "Button 1", nullptr);
+  std::unique_ptr<NotificationPlatformBridgeMac> bridge(
+      new NotificationPlatformBridgeMac(notification_center(),
+                                        alert_dispatcher));
+  bridge->Display(NotificationCommon::PERSISTENT, "notification_id",
+                  "profile_id", false, *alert);
+  EXPECT_EQ(0u, [[notification_center() deliveredNotifications] count]);
+  EXPECT_EQ(1u, [[alert_dispatcher alerts] count]);
+}
+
+TEST_F(NotificationPlatformBridgeMacTest, TestDisplayBannerAndAlert) {
+  StubAlertDispatcher* alert_dispatcher = [[StubAlertDispatcher alloc] init];
+  std::unique_ptr<Notification> alert =
+      CreateAlert("Title", "Context", "https://gmail.com", "Button 1", nullptr);
+  std::unique_ptr<Notification> banner = CreateBanner(
+      "Title", "Context", "https://gmail.com", "Button 1", nullptr);
+  std::unique_ptr<NotificationPlatformBridgeMac> bridge(
+      new NotificationPlatformBridgeMac(notification_center(),
+                                        alert_dispatcher));
+  bridge->Display(NotificationCommon::PERSISTENT, "notification_id",
+                  "profile_id", false, *banner);
+  bridge->Display(NotificationCommon::PERSISTENT, "notification_id2",
+                  "profile_id", false, *alert);
+  EXPECT_EQ(1u, [[notification_center() deliveredNotifications] count]);
+  EXPECT_EQ(1u, [[alert_dispatcher alerts] count]);
+}
+
+TEST_F(NotificationPlatformBridgeMacTest, TestCloseAlert) {
+  std::unique_ptr<Notification> alert =
+      CreateAlert("Title", "Context", "https://gmail.com", "Button 1", nullptr);
+  StubAlertDispatcher* alert_dispatcher = [[StubAlertDispatcher alloc] init];
+  std::unique_ptr<NotificationPlatformBridgeMac> bridge(
+      new NotificationPlatformBridgeMac(notification_center(),
+                                        alert_dispatcher));
+  EXPECT_EQ(0u, [[alert_dispatcher alerts] count]);
+  bridge->Display(NotificationCommon::PERSISTENT, "notification_id",
+                  "profile_id", false, *alert);
+  EXPECT_EQ(1u, [[alert_dispatcher alerts] count]);
+
+  bridge->Close("profile_id", "notification_id");
+  EXPECT_EQ(0u, [[notification_center() deliveredNotifications] count]);
+}
+
+#endif