aboutsummaryrefslogtreecommitdiffhomepage
path: root/Example/Messaging/Tests/FIRMessagingContextManagerServiceTest.m
blob: cb48e7fd58e024554bf596e9197f766743556fe1 (plain)
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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
/*
 * Copyright 2017 Google
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#import <XCTest/XCTest.h>

#import <OCMock/OCMock.h>

#import "FIRMessagingContextManagerService.h"

@interface FIRMessagingContextManagerServiceTest : XCTestCase

@property(nonatomic, readwrite, strong) NSDateFormatter *dateFormatter;
@property(nonatomic, readwrite, strong) NSMutableArray *scheduledLocalNotifications;

@end

@implementation FIRMessagingContextManagerServiceTest

- (void)setUp {
  [super setUp];
  self.dateFormatter = [[NSDateFormatter alloc] init];
  [self.dateFormatter setDateFormat:@"yyyy-MM-dd HH:mm:ss"];
  self.scheduledLocalNotifications = [NSMutableArray array];
  [self mockSchedulingLocalNotifications];
}

- (void)tearDown {
  [super tearDown];
}

/**
 *  Test invalid context manager message, missing lt_start string.
 */
- (void)testInvalidContextManagerMessage_missingStartTime {
  NSDictionary *message = @{
    @"hello" : @"world",
  };
  XCTAssertFalse([FIRMessagingContextManagerService isContextManagerMessage:message]);
}

/**
 *  Test valid context manager message.
 */
- (void)testValidContextManagerMessage {
  NSDictionary *message = @{
    kFIRMessagingContextManagerLocalTimeStart: @"2015-12-12 00:00:00",
    @"hello" : @"world",
  };
  XCTAssertTrue([FIRMessagingContextManagerService isContextManagerMessage:message]);
}

// TODO: Enable these tests. They fail because we cannot schedule local
// notifications on OSX without permission. It's better to mock AppDelegate's
// scheduleLocalNotification to mock scheduling behavior.

/**
 *  Context Manager message with future start date should be successfully scheduled.
 */
- (void)testMessageWithFutureStartTime {
  NSString *messageIdentifier = @"fcm-cm-test1";
  NSString *startTimeString = @"2020-01-12 12:00:00";  // way into the future
  NSDictionary *message = @{
    kFIRMessagingContextManagerLocalTimeStart: startTimeString,
    kFIRMessagingContextManagerBodyKey : @"Hello world!",
    @"id": messageIdentifier,
    @"hello" : @"world"
  };

  XCTAssertTrue([FIRMessagingContextManagerService handleContextManagerMessage:message]);

  XCTAssertEqual(self.scheduledLocalNotifications.count, 1);
  UILocalNotification *notification = [self.scheduledLocalNotifications firstObject];
  NSDate *date = [self.dateFormatter dateFromString:startTimeString];
  XCTAssertEqual([notification.fireDate compare:date], NSOrderedSame);
}

/**
 *  Context Manager message with past end date should not be scheduled.
 */
- (void)testMessageWithPastEndTime {
  NSString *messageIdentifier = @"fcm-cm-test1";
  NSString *startTimeString = @"2010-01-12 12:00:00";  // way into the past
  NSString *endTimeString = @"2011-01-12 12:00:00";  // way into the past
  NSDictionary *message = @{
    kFIRMessagingContextManagerLocalTimeStart: startTimeString,
    kFIRMessagingContextManagerLocalTimeEnd : endTimeString,
    kFIRMessagingContextManagerBodyKey : @"Hello world!",
    @"id": messageIdentifier,
    @"hello" : @"world"
  };

  XCTAssertTrue([FIRMessagingContextManagerService handleContextManagerMessage:message]);
  XCTAssertEqual(self.scheduledLocalNotifications.count, 0);
}

/**
 *  Context Manager message with past start and future end date should be successfully
 *  scheduled.
 */
- (void)testMessageWithPastStartAndFutureEndTime {
  NSString *messageIdentifier = @"fcm-cm-test1";
  NSDate *startDate = [NSDate dateWithTimeIntervalSinceNow:-1000];  // past
  NSDate *endDate = [NSDate dateWithTimeIntervalSinceNow:1000];  // future
  NSString *startTimeString = [self.dateFormatter stringFromDate:startDate];
  NSString *endTimeString = [self.dateFormatter stringFromDate:endDate];

  NSDictionary *message = @{
    kFIRMessagingContextManagerLocalTimeStart : startTimeString,
    kFIRMessagingContextManagerLocalTimeEnd : endTimeString,
    kFIRMessagingContextManagerBodyKey : @"Hello world!",
    @"id": messageIdentifier,
    @"hello" : @"world"
  };

  XCTAssertTrue([FIRMessagingContextManagerService handleContextManagerMessage:message]);

  XCTAssertEqual(self.scheduledLocalNotifications.count, 1);
  UILocalNotification *notification = [self.scheduledLocalNotifications firstObject];
  // schedule notification after start date
  XCTAssertEqual([notification.fireDate compare:startDate], NSOrderedDescending);
  // schedule notification after end date
  XCTAssertEqual([notification.fireDate compare:endDate], NSOrderedAscending);
}

/**
 *  Test correctly parsing user data in local notifications.
 */
- (void)testTimedNotificationsUserInfo {
  NSString *messageIdentifierKey = @"message.id";
  NSString *messageIdentifier = @"fcm-cm-test1";
  NSString *startTimeString = @"2020-01-12 12:00:00";  // way into the future

  NSString *customDataKey = @"hello";
  NSString *customData = @"world";
  NSDictionary *message = @{
    kFIRMessagingContextManagerLocalTimeStart : startTimeString,
    kFIRMessagingContextManagerBodyKey : @"Hello world!",
    messageIdentifierKey : messageIdentifier,
    customDataKey : customData,
  };

  XCTAssertTrue([FIRMessagingContextManagerService handleContextManagerMessage:message]);

  XCTAssertEqual(self.scheduledLocalNotifications.count, 1);
  UILocalNotification *notification = [self.scheduledLocalNotifications firstObject];
  XCTAssertEqualObjects(notification.userInfo[messageIdentifierKey], messageIdentifier);
  XCTAssertEqualObjects(notification.userInfo[customDataKey], customData);
}

#pragma mark - Private Helpers

- (void)mockSchedulingLocalNotifications {
  id mockApplication = OCMPartialMock([UIApplication sharedApplication]);
  __block UILocalNotification *notificationToSchedule;
  [[[mockApplication stub]
      andDo:^(NSInvocation *invocation) {
        // Mock scheduling a notification
        if (notificationToSchedule) {
          [self.scheduledLocalNotifications addObject:notificationToSchedule];
        }
      }] scheduleLocalNotification:[OCMArg checkWithBlock:^BOOL(id obj) {
        if ([obj isKindOfClass:[UILocalNotification class]]) {
          notificationToSchedule = obj;
          return YES;
        }
        return NO;
      }]];
}

@end