/
PageIteratorTests.cs
408 lines (330 loc) · 17.6 KB
/
PageIteratorTests.cs
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
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
// ------------------------------------------------------------------------------
// Copyright (c) Microsoft Corporation. All Rights Reserved. Licensed under the MIT License. See License in the project root for license information.
// ------------------------------------------------------------------------------
using Microsoft.CSharp.RuntimeBinder;
using Microsoft.Graph.DotnetCore.Test.Requests.Functional;
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Threading;
using System.Threading.Tasks;
using Xunit;
/**
Spec
https://github.com/microsoftgraph/msgraph-sdk-design/blob/master/tasks/PageIteratorTask.md
**/
namespace Microsoft.Graph.DotnetCore.Test.Tasks
{
public class PageIteratorTests : GraphTestBase
{
private PageIterator<Event> eventPageIterator;
[Fact(Skip = "No CI set up for e2e tests")]
public async Task PageIteratorDevTest()
{
// Get an initial page results to populate the iterator.
IUserEventsCollectionPage iUserEventsCollectionPage = await graphClient.Me.Events.Request().Top(2).GetAsync();
// Create the function to process each entity returned in the pages.
Func<Event, bool> processEachEvent = (e) =>
{
bool shouldContinue = true;
//if (e.Subject.Contains("Latin"))
// shouldContinue = false;
Debug.WriteLine($"Event subject: {e.Subject}");
return shouldContinue;
};
// This requires the dev to specify the generic type in the CollectionPage.
eventPageIterator = PageIterator<Event>.CreatePageIterator(graphClient, iUserEventsCollectionPage, processEachEvent);
await eventPageIterator.IterateAsync();
Assert.Equal(PagingState.Complete, eventPageIterator.State);
}
[Fact(Skip = "No CI set up for e2e tests")]
public async Task DeltaPageIteratorDevTest()
{
// Get an initial page results to populate the iterator.
var messagesDeltaCollectionPage = await graphClient.Me
.MailFolders["inbox"]
.Messages
.Delta()
.Request()
.GetAsync();
// Create the function to process each entity returned in the pages.
Func<Message, bool> processEachMessage = (e) =>
{
Debug.WriteLine($"Message subject: {e.Subject}");
return true;
};
// This requires the dev to specify the generic type in the CollectionPage.
var messagePageIterator = PageIterator<Message>.CreatePageIterator(graphClient,
messagesDeltaCollectionPage,
processEachMessage);
await messagePageIterator.IterateAsync();
Assert.Equal(PagingState.Delta, messagePageIterator.State);
var me = await graphClient.Me.Request().GetAsync();
var recipients = new List<Recipient>()
{
new Recipient()
{
EmailAddress = new EmailAddress()
{
Address = me.Mail
}
}
};
var message = new Message()
{
Subject = "Message sent after deltatoken received.",
ToRecipients = recipients
};
await graphClient.Me.SendMail(message, true).Request().PostAsync();
await Task.Delay(3000);
await messagePageIterator.ResumeAsync();
Assert.Equal(PagingState.Delta, messagePageIterator.State);
}
[Fact]
public async Task Given_Concrete_CollectionPage_It_Throws_RuntimeBinderException()
{
var page = new CollectionPage<Event>()
{
AdditionalData = new Dictionary<string, object>()
};
page.AdditionalData.Add(Constants.OdataInstanceAnnotations.NextLink, "testnextlink");
eventPageIterator = PageIterator<Event>.CreatePageIterator(graphClient, page, (e) => { return true; });
await Assert.ThrowsAsync<RuntimeBinderException>(() => eventPageIterator.IterateAsync());
}
[Fact]
public void Given_Null_CollectionPage_It_Throws_ArgumentNullException()
{
Assert.Throws<ArgumentNullException>(() => PageIterator<Event>.CreatePageIterator(graphClient, null, (e) => { return true; }));
}
[Fact]
public void Given_Null_Delegate_It_Throws_ArgumentNullException()
{
Assert.Throws<ArgumentNullException>(() => PageIterator<Event>.CreatePageIterator(graphClient, new CollectionPage<Event>(), null));
}
[Fact]
public async Task Given_Concrete_Generated_CollectionPage_It_Iterates_Page_Items()
{
int inputEventCount = 17;
var page = new UserEventsCollectionPage();
page.AdditionalData = new Dictionary<string, object>();
for (int i = 0; i < inputEventCount; i++)
{
page.Add(new Event() { Subject = $"Subject{i.ToString()}" });
}
List<Event> events = new List<Event>();
eventPageIterator = PageIterator<Event>.CreatePageIterator(graphClient, page, (e) =>
{
events.Add(e);
return true;
});
await eventPageIterator.IterateAsync();
Assert.Equal(inputEventCount, events.Count);
}
[Fact]
public async Task Given_Concrete_Generated_CollectionPage_It_Stops_Iterating_Pageitems()
{
int inputEventCount = 17;
var page = new UserEventsCollectionPage();
for (int i = 0; i < inputEventCount; i++)
{
page.Add(new Event() { Subject = $"Subject{i.ToString()}" });
}
List<Event> events = new List<Event>();
eventPageIterator = PageIterator<Event>.CreatePageIterator(graphClient, page, (e) =>
{
if (e.Subject == "Subject7")
return false;
events.Add(e);
return true;
});
await eventPageIterator.IterateAsync();
Assert.Equal(7, events.Count);
Assert.Equal(PagingState.Paused, eventPageIterator.State);
}
[Fact]
public async Task Given_CollectionPage_It_Stops_Iterating_Across_Pages()
{
// Create the 17 events to initiallize the original collection page.
List<Event> testEvents = new List<Event>();
int inputEventCount = 17;
for (int i = 0; i < inputEventCount; i++)
{
testEvents.Add(new Event() { Subject = $"Subject{i.ToString()}" });
}
// Create the 5 events to initialize the next collection page.
UserEventsCollectionPage nextPage = new UserEventsCollectionPage();
int nextPageEventCount = 5;
for (int i = 0; i < nextPageEventCount; i++)
{
nextPage.Add(new Event() { Subject = $"Subject for next page events: {i.ToString()}" });
}
// Create the CancellationTokenSource to test the cancellation of paging in the delegate.
CancellationTokenSource cancellationTokenSource = new CancellationTokenSource();
var pagingToken = cancellationTokenSource.Token;
// Create the delegate to process each entity returned in the pages. The delegate will cancel
// paging when the target subject is encountered.
Func<Event, bool> processEachEvent = (e) =>
{
bool shouldContinue = true;
if (e.Subject.Contains("Subject3"))
{
cancellationTokenSource.Cancel();
}
if (e.Subject.Contains("Subject for next page events"))
{
Assert.True(false, "Unexpectedly paged the next page of results.");
}
return shouldContinue;
};
Mocks.MockUserEventsCollectionRequest mockUserEventsCollectionRequest = new Mocks.MockUserEventsCollectionRequest(nextPage);
var mockUserEventsCollectionPage = new Mocks.MockUserEventsCollectionPage(testEvents, mockUserEventsCollectionRequest) as IUserEventsCollectionPage;
eventPageIterator = PageIterator<Event>.CreatePageIterator(graphClient, mockUserEventsCollectionPage, processEachEvent);
await eventPageIterator.IterateAsync(pagingToken);
Assert.True(cancellationTokenSource.IsCancellationRequested, "The delegate page iterator did not cancel requests to fetch more pages.");
}
[Fact]
public async Task Given_CollectionPage_It_Iterates_Across_Pages()
{
// Create the 17 events to initiallize the original collection page.
List<Event> originalCollectionPageEvents = new List<Event>();
int inputEventCount = 17;
for (int i = 0; i < inputEventCount; i++)
{
originalCollectionPageEvents.Add(new Event() { Subject = $"Subject{i.ToString()}" });
}
// Create the 5 events to initialize the next collection page.
UserEventsCollectionPage nextPage = new UserEventsCollectionPage();
int nextPageEventCount = 5;
for (int i = 0; i < nextPageEventCount; i++)
{
nextPage.Add(new Event() { Subject = $"Subject for next page events: {i.ToString()}" });
}
nextPage.AdditionalData = new Dictionary<string, object>();
bool reachedNextPage = false;
// Create the delegate to process each entity returned in the pages. The delegate will
// signal that we reached an event in the next page.
Func<Event, bool> processEachEvent = (e) =>
{
if (e.Subject.Contains("Subject for next page events"))
{
reachedNextPage = true;
return false;
}
return true;
};
Mocks.MockUserEventsCollectionRequest mockUserEventsCollectionRequest = new Mocks.MockUserEventsCollectionRequest(nextPage);
var mockUserEventsCollectionPage = new Mocks.MockUserEventsCollectionPage(originalCollectionPageEvents, mockUserEventsCollectionRequest, "nextLink") as IUserEventsCollectionPage;
eventPageIterator = PageIterator<Event>.CreatePageIterator(graphClient, mockUserEventsCollectionPage, processEachEvent);
await eventPageIterator.IterateAsync();
Assert.True(reachedNextPage, "The delegate page iterator did not reach the next page.");
Assert.Equal(PagingState.Paused, eventPageIterator.State);
}
[Fact]
public async Task Given_CollectionPage_It_Detects_Nextlink_Loop()
{
// Create the 17 events to initiallize the original collection page.
List<Event> originalCollectionPageEvents = new List<Event>();
int inputEventCount = 5;
for (int i = 0; i < inputEventCount; i++)
{
originalCollectionPageEvents.Add(new Event() { Subject = $"Subject{i.ToString()}" });
}
// Create the 5 events to initialize the next collection page.
UserEventsCollectionPage nextPage = new UserEventsCollectionPage();
int nextPageEventCount = 5;
for (int i = 0; i < nextPageEventCount; i++)
{
nextPage.Add(new Event() { Subject = $"Subject for next page events: {i.ToString()}" });
}
// This will be the same nextLink value as the one set in MockUserEventsCollectionPage cstor.
nextPage.AdditionalData = new Dictionary<string, object>() {
{ Constants.OdataInstanceAnnotations.NextLink, "testNextlink"}
};
// Create the delegate to process each entity returned in the pages. The delegate will
// signal that we reached an event in the next page.
Func<Event, bool> processEachEvent = (e) =>
{
return true;
};
Mocks.MockUserEventsCollectionRequest mockUserEventsCollectionRequest = new Mocks.MockUserEventsCollectionRequest(nextPage);
var mockUserEventsCollectionPage = new Mocks.MockUserEventsCollectionPage(originalCollectionPageEvents, mockUserEventsCollectionRequest, "nextLink") as IUserEventsCollectionPage;
eventPageIterator = PageIterator<Event>.CreatePageIterator(graphClient, mockUserEventsCollectionPage, processEachEvent);
await Assert.ThrowsAsync<ServiceException>(async () => await eventPageIterator.IterateAsync());
}
[Fact]
public async Task Given_CollectionPage_It_Handles_Empty_NextPage()
{
try
{
// Create the 17 events to initiallize the original collection page.
List<Event> originalCollectionPageEvents = new List<Event>();
int inputEventCount = 17;
for (int i = 0; i < inputEventCount; i++)
{
originalCollectionPageEvents.Add(new Event() { Subject = $"Subject{i.ToString()}" });
}
// Create empty next collection page.
UserEventsCollectionPage nextPage = new UserEventsCollectionPage();
// Create the delegate to process each entity returned in the pages.
Func<Event, bool> processEachEvent = (e) =>
{
return true;
};
Mocks.MockUserEventsCollectionRequest mockUserEventsCollectionRequest = new Mocks.MockUserEventsCollectionRequest(nextPage);
var mockUserEventsCollectionPage = new Mocks.MockUserEventsCollectionPage(originalCollectionPageEvents, mockUserEventsCollectionRequest) as IUserEventsCollectionPage;
eventPageIterator = PageIterator<Event>.CreatePageIterator(graphClient, mockUserEventsCollectionPage, processEachEvent);
await eventPageIterator.IterateAsync();
}
catch (Exception)
{
Assert.True(false, "Unexpected exception occurred when next page contains no elements.");
}
}
[Fact]
public void Given_PageIterator_It_Has_PagingState_NotStarted()
{
// Arrange
List<Event> originalCollectionPageEvents = new List<Event>();
UserEventsCollectionPage nextPage = new UserEventsCollectionPage();
Mocks.MockUserEventsCollectionRequest mockUserEventsCollectionRequest = new Mocks.MockUserEventsCollectionRequest(nextPage);
var mockUserEventsCollectionPage = new Mocks.MockUserEventsCollectionPage(originalCollectionPageEvents, mockUserEventsCollectionRequest, "nextlink") as IUserEventsCollectionPage;
// Act
eventPageIterator = PageIterator<Event>.CreatePageIterator(graphClient, mockUserEventsCollectionPage, (e) => { return true; });
// Assert
Assert.Equal<PagingState>(PagingState.NotStarted, eventPageIterator.State);
}
[Fact]
public async Task Given_RequestConfigurator_It_Is_Invoked()
{
// Create the 17 events to initiallize the original collection page.
List<Event> originalCollectionPageEvents = new List<Event>();
int inputEventCount = 17;
for (int i = 0; i < inputEventCount; i++)
{
originalCollectionPageEvents.Add(new Event() { Subject = $"Subject{i.ToString()}" });
}
// Create the 5 events to initialize the next collection page.
UserEventsCollectionPage nextPage = new UserEventsCollectionPage();
int nextPageEventCount = 5;
for (int i = 0; i < nextPageEventCount; i++)
{
nextPage.Add(new Event() { Subject = $"Subject for next page events: {i.ToString()}" });
}
nextPage.AdditionalData = new Dictionary<string, object>();
// Create the delegate to process each entity returned in the pages.
Func<Event, bool> processEachEvent = (e) => { return true; };
// Create the delegate to configure the next page request. The delegate will signal that it was invoked.
bool requestConfiguratorInvoked = false;
Func<IBaseRequest, IBaseRequest> requestConfigurator = (request) =>
{
requestConfiguratorInvoked = true;
return request;
};
Mocks.MockUserEventsCollectionRequest mockUserEventsCollectionRequest = new Mocks.MockUserEventsCollectionRequest(nextPage);
var mockUserEventsCollectionPage = new Mocks.MockUserEventsCollectionPage(originalCollectionPageEvents, mockUserEventsCollectionRequest, "nextLink") as IUserEventsCollectionPage;
eventPageIterator = PageIterator<Event>.CreatePageIterator(graphClient, mockUserEventsCollectionPage, processEachEvent, requestConfigurator);
await eventPageIterator.IterateAsync();
Assert.True(requestConfiguratorInvoked, "The delegate request configurator not invoked.");
}
}
}