File: synced_notifications_shim_unittest.cc

package info (click to toggle)
chromium-browser 37.0.2062.120-1~deb7u1
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 1,707,260 kB
  • sloc: cpp: 8,976,677; ansic: 3,473,199; python: 586,578; asm: 449,013; xml: 184,195; java: 142,924; sh: 118,496; perl: 81,467; makefile: 27,557; yacc: 10,506; objc: 8,886; tcl: 3,186; cs: 2,252; lex: 2,213; sql: 1,198; pascal: 1,170; lisp: 790; awk: 407; ruby: 155; php: 83; sed: 52; exp: 11
file content (331 lines) | stat: -rw-r--r-- 12,873 bytes parent folder | download
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
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
// Copyright 2014 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.

#include "chrome/browser/extensions/api/synced_notifications_private/synced_notifications_shim.h"

#include "base/json/json_writer.h"
#include "extensions/browser/event_router.h"
#include "sync/api/fake_sync_change_processor.h"
#include "sync/api/sync_change.h"
#include "sync/api/sync_error_factory.h"
#include "sync/protocol/sync.pb.h"
#include "testing/gtest/include/gtest/gtest.h"

using namespace extensions;
using namespace extensions::api;

namespace {

// Builds a SyncData for the specified |type| based on |key|.
syncer::SyncData BuildData(syncer::ModelType type, const std::string& key) {
  sync_pb::EntitySpecifics specifics;
  if (type == syncer::SYNCED_NOTIFICATIONS) {
    specifics.mutable_synced_notification()
        ->mutable_coalesced_notification()
        ->set_key(key);
  } else {
    specifics.mutable_synced_notification_app_info()
        ->add_synced_notification_app_info()
        ->add_app_id(key);
  }
  syncer::SyncData data = syncer::SyncData::CreateLocalData(
      key, key, specifics);
  return data;
}

// Builds a SyncChange with an update to the specified |type| based on |key|.
syncer::SyncChange BuildChange(syncer::ModelType type, const std::string& key) {
  syncer::SyncChangeList change_list;
  syncer::SyncData data = BuildData(type, key);
  return syncer::SyncChange(FROM_HERE, syncer::SyncChange::ACTION_UPDATE, data);
}

// Verifies that the specifics within |data| match the serialized specifics
// within |serialized|.
testing::AssertionResult DataSpecificsMatch(const syncer::SyncData& data,
                                            const std::string& serialized) {
  if (data.GetDataType() == syncer::SYNCED_NOTIFICATIONS) {
    const sync_pb::SyncedNotificationSpecifics& proto =
        data.GetSpecifics().synced_notification();
    if (serialized != proto.SerializeAsString())
      return testing::AssertionFailure() << "Notification specifics mismatch";
  } else {
    const sync_pb::SyncedNotificationAppInfoSpecifics& proto =
        data.GetSpecifics().synced_notification_app_info();
    if (serialized != proto.SerializeAsString())
      return testing::AssertionFailure() << "App info specifics mismatch";
  }
  return testing::AssertionSuccess();
}

// Verifies that the update within |change| matchs the serialized specifics
// within |serialized|.
testing::AssertionResult ChangeSpecificsMatch(const syncer::SyncChange& change,
                                              const std::string& serialized) {
  if (change.change_type() != syncer::SyncChange::ACTION_UPDATE)
    return testing::AssertionFailure() << "Invalid change type";
  return DataSpecificsMatch(change.sync_data(), serialized);
}

class SyncedNotificationsShimTest : public testing::Test {
 public:
  SyncedNotificationsShimTest();
  virtual ~SyncedNotificationsShimTest();

  // Starts sync for both sync types.
  void StartSync();
  // Starts sync for the specified datatype |type|.
  void StartSync(syncer::ModelType type);

  // Transfers ownership of the last event received.
  scoped_ptr<Event> GetLastEvent();

  SyncedNotificationsShim* shim() { return &shim_; }
  syncer::FakeSyncChangeProcessor* notification_processor() {
    return notification_processor_;
  }
  syncer::FakeSyncChangeProcessor* app_info_processor() {
    return app_info_processor_;
  }

 private:
  void EventCallback(scoped_ptr<Event> event);

  // Shim being tested.
  SyncedNotificationsShim shim_;

  syncer::FakeSyncChangeProcessor* notification_processor_;
  syncer::FakeSyncChangeProcessor* app_info_processor_;

  // The last event fired by the shim.
  scoped_ptr<Event> last_event_fired_;
};

SyncedNotificationsShimTest::SyncedNotificationsShimTest()
    : shim_(base::Bind(&SyncedNotificationsShimTest::EventCallback,
                       base::Unretained(this))),
      notification_processor_(NULL),
      app_info_processor_(NULL) {}

SyncedNotificationsShimTest::~SyncedNotificationsShimTest() {}

void SyncedNotificationsShimTest::EventCallback(scoped_ptr<Event> event) {
  ASSERT_FALSE(last_event_fired_);
  last_event_fired_ = event.Pass();
}

scoped_ptr<Event> SyncedNotificationsShimTest::GetLastEvent() {
  return last_event_fired_.Pass();
}

void SyncedNotificationsShimTest::StartSync() {
  StartSync(syncer::SYNCED_NOTIFICATIONS);
  StartSync(syncer::SYNCED_NOTIFICATION_APP_INFO);
  GetLastEvent();
}

void SyncedNotificationsShimTest::StartSync(syncer::ModelType type) {
  scoped_ptr<syncer::FakeSyncChangeProcessor> change_processor(
      new syncer::FakeSyncChangeProcessor());
  if (type == syncer::SYNCED_NOTIFICATIONS)
    notification_processor_ = change_processor.get();
  else
    app_info_processor_ = change_processor.get();
  syncer::SyncDataList sync_data;
  shim_.MergeDataAndStartSyncing(
      type,
      sync_data,
      change_processor.PassAs<syncer::SyncChangeProcessor>(),
      scoped_ptr<syncer::SyncErrorFactory>());
}

// Starting sync should fire the sync started event, but only after both types
// have started.
TEST_F(SyncedNotificationsShimTest, StartSync) {
  EXPECT_FALSE(shim()->IsSyncReady());
  StartSync(syncer::SYNCED_NOTIFICATIONS);
  EXPECT_FALSE(shim()->IsSyncReady());
  EXPECT_FALSE(GetLastEvent());

  StartSync(syncer::SYNCED_NOTIFICATION_APP_INFO);
  EXPECT_TRUE(shim()->IsSyncReady());

  scoped_ptr<Event> event = GetLastEvent();
  ASSERT_TRUE(event);
  EXPECT_EQ(synced_notifications_private::OnSyncStartup::kEventName,
            event->event_name);

  EXPECT_TRUE(notification_processor()->changes().empty());
  EXPECT_TRUE(app_info_processor()->changes().empty());
}

// A sync update should fire the OnDataChanges event with the updated
// notification.
TEST_F(SyncedNotificationsShimTest, ProcessSyncChangesSingleNotification) {
  StartSync();
  syncer::SyncChangeList change_list;
  change_list.push_back(BuildChange(syncer::SYNCED_NOTIFICATIONS, "key"));
  shim()->ProcessSyncChanges(FROM_HERE, change_list);
  scoped_ptr<Event> event = GetLastEvent();
  ASSERT_TRUE(event);
  EXPECT_EQ(synced_notifications_private::OnDataChanges::kEventName,
            event->event_name);
  ASSERT_TRUE(event->event_args);
  EXPECT_EQ(1U, event->event_args->GetSize());

  base::ListValue* args = NULL;
  ASSERT_TRUE(event->event_args->GetList(0, &args));
  EXPECT_EQ(1U, args->GetSize());
  base::DictionaryValue* sync_change_value = NULL;
  ASSERT_TRUE(args->GetDictionary(0, &sync_change_value));
  scoped_ptr<synced_notifications_private::SyncChange> sync_change =
      synced_notifications_private::SyncChange::FromValue(*sync_change_value);
  ASSERT_TRUE(sync_change);
  EXPECT_TRUE(ChangeSpecificsMatch(change_list[0],
                                   sync_change->data.data_item));
  EXPECT_EQ(synced_notifications_private::CHANGE_TYPE_UPDATED,
            sync_change->change_type);
}

// Verify that multiple notification updates can be sent in one event.
TEST_F(SyncedNotificationsShimTest, ProcessSyncChangesMultipleNotification) {
  StartSync();
  syncer::SyncChangeList change_list;
  change_list.push_back(BuildChange(syncer::SYNCED_NOTIFICATIONS, "key"));
  change_list.push_back(BuildChange(syncer::SYNCED_NOTIFICATIONS, "key2"));
  shim()->ProcessSyncChanges(FROM_HERE, change_list);
  scoped_ptr<Event> event = GetLastEvent();
  ASSERT_TRUE(event);
  EXPECT_EQ(synced_notifications_private::OnDataChanges::kEventName,
            event->event_name);
  ASSERT_TRUE(event->event_args);
  base::ListValue* args = NULL;
  ASSERT_TRUE(event->event_args->GetList(0, &args));
  EXPECT_EQ(2U, args->GetSize());

  base::DictionaryValue* sync_change_value = NULL;
  ASSERT_TRUE(args->GetDictionary(0, &sync_change_value));
  scoped_ptr<synced_notifications_private::SyncChange> sync_change =
      synced_notifications_private::SyncChange::FromValue(*sync_change_value);
  ASSERT_TRUE(sync_change);
  EXPECT_TRUE(ChangeSpecificsMatch(change_list[0],
                                   sync_change->data.data_item));
  EXPECT_EQ(synced_notifications_private::CHANGE_TYPE_UPDATED,
            sync_change->change_type);

  ASSERT_TRUE(args->GetDictionary(1, &sync_change_value));
  sync_change =
      synced_notifications_private::SyncChange::FromValue(*sync_change_value);
  ASSERT_TRUE(sync_change);
  EXPECT_TRUE(ChangeSpecificsMatch(change_list[1],
                                   sync_change->data.data_item));
  EXPECT_EQ(synced_notifications_private::CHANGE_TYPE_UPDATED,
            sync_change->change_type);
}

// Verify AppInfo updates trigger OnDataChanges events.
TEST_F(SyncedNotificationsShimTest, ProcessSyncChangeAppInfo) {
  StartSync();
  syncer::SyncChangeList change_list;
  change_list.push_back(
      BuildChange(syncer::SYNCED_NOTIFICATION_APP_INFO, "key"));
  shim()->ProcessSyncChanges(FROM_HERE, change_list);
  scoped_ptr<Event> event = GetLastEvent();
  ASSERT_TRUE(event);
  EXPECT_EQ(synced_notifications_private::OnDataChanges::kEventName,
            event->event_name);
  ASSERT_TRUE(event->event_args);
  EXPECT_EQ(1U, event->event_args->GetSize());

  base::ListValue* args = NULL;
  ASSERT_TRUE(event->event_args->GetList(0, &args));
  EXPECT_EQ(1U, args->GetSize());
  base::DictionaryValue* sync_change_value = NULL;
  ASSERT_TRUE(args->GetDictionary(0, &sync_change_value));
  scoped_ptr<synced_notifications_private::SyncChange> sync_change =
      synced_notifications_private::SyncChange::FromValue(*sync_change_value);
  ASSERT_TRUE(sync_change);
  EXPECT_TRUE(ChangeSpecificsMatch(change_list[0],
                                   sync_change->data.data_item));
  EXPECT_EQ(synced_notifications_private::CHANGE_TYPE_UPDATED,
            sync_change->change_type);
}

// Attempt to get the initial sync data both before and after sync starts.
TEST_F(SyncedNotificationsShimTest, GetInitialData) {
  std::vector<linked_ptr<synced_notifications_private::SyncData> > data;
  EXPECT_FALSE(shim()->GetInitialData(
      synced_notifications_private::SYNC_DATA_TYPE_SYNCED_NOTIFICATION, &data));
  EXPECT_FALSE(shim()->GetInitialData(
      synced_notifications_private::SYNC_DATA_TYPE_APP_INFO, &data));

  StartSync();

  EXPECT_TRUE(shim()->GetInitialData(
      synced_notifications_private::SYNC_DATA_TYPE_SYNCED_NOTIFICATION, &data));
  EXPECT_TRUE(data.empty());
  EXPECT_TRUE(shim()->GetInitialData(
      synced_notifications_private::SYNC_DATA_TYPE_APP_INFO, &data));
  EXPECT_TRUE(data.empty());

  notification_processor()->data().push_back(BuildData(
      syncer::SYNCED_NOTIFICATIONS, "notif_key"));
  EXPECT_TRUE(shim()->GetInitialData(
      synced_notifications_private::SYNC_DATA_TYPE_SYNCED_NOTIFICATION, &data));
  EXPECT_EQ(1U, data.size());
  EXPECT_TRUE(DataSpecificsMatch(notification_processor()->data()[0],
                                 data[0]->data_item));

  data.clear();
  app_info_processor()->data().push_back(BuildData(
      syncer::SYNCED_NOTIFICATION_APP_INFO, "app_key"));
  EXPECT_TRUE(shim()->GetInitialData(
      synced_notifications_private::SYNC_DATA_TYPE_APP_INFO, &data));
  EXPECT_EQ(1U, data.size());
  EXPECT_TRUE(DataSpecificsMatch(app_info_processor()->data()[0],
                                 data[0]->data_item));
}

// Verify that notification updates are properly handled.
TEST_F(SyncedNotificationsShimTest, UpdateNotification) {
  syncer::SyncData data =
      BuildData(syncer::SYNCED_NOTIFICATIONS, "notif_key");
  std::string serialized =
      data.GetSpecifics().synced_notification().SerializeAsString();
  EXPECT_FALSE(shim()->UpdateNotification(serialized));

  StartSync();

  EXPECT_FALSE(shim()->UpdateNotification("gibberish"));
  EXPECT_TRUE(notification_processor()->changes().empty());

  EXPECT_TRUE(shim()->UpdateNotification(serialized));
  EXPECT_EQ(1U, notification_processor()->changes().size());
  EXPECT_EQ(syncer::SyncChange::ACTION_UPDATE,
            notification_processor()->changes()[0].change_type());
  EXPECT_EQ(syncer::SYNCED_NOTIFICATIONS,
            notification_processor()->changes()[0].sync_data().GetDataType());
  EXPECT_EQ(serialized,
            notification_processor()
                ->changes()[0]
                .sync_data()
                .GetSpecifics()
                .synced_notification()
                .SerializeAsString());
}

// Verify that SetRenderContext updates the datatype context properly.
TEST_F(SyncedNotificationsShimTest, SetRenderContext) {
  const std::string kContext = "context";
  EXPECT_FALSE(shim()->SetRenderContext(
      synced_notifications_private::REFRESH_REQUEST_REFRESH_NEEDED, kContext));

  StartSync();

  EXPECT_TRUE(shim()->SetRenderContext(
      synced_notifications_private::REFRESH_REQUEST_REFRESH_NEEDED, kContext));
  EXPECT_EQ(kContext, notification_processor()->context());
}

}  // namespace