3 // Copyright (c) 2012 Petr Onderka
5 // Permission is hereby granted, free of charge, to any person obtaining a copy
6 // of this software and associated documentation files (the "Software"), to deal
7 // in the Software without restriction, including without limitation the rights
8 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 // copies of the Software, and to permit persons to whom the Software is
10 // furnished to do so, subject to the following conditions:
12 // The above copyright notice and this permission notice shall be included in
13 // all copies or substantial portions of the Software.
15 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24 using System.Collections.Generic;
25 using System.Threading;
26 using System.Threading.Tasks;
27 using System.Threading.Tasks.Dataflow;
28 using NUnit.Framework;
30 namespace MonoTests.System.Threading.Tasks.Dataflow {
32 public class ReceivingTest {
34 public void PostponeTest ()
36 var scheduler = new TestScheduler ();
38 new BufferBlock<int> (new DataflowBlockOptions { TaskScheduler = scheduler });
39 var target = new TestTargetBlock<int> { Postpone = true };
40 Assert.IsNotNull (source.LinkTo (target));
41 Assert.IsFalse (target.HasPostponed);
43 Assert.IsTrue (source.Post (42));
44 scheduler.ExecuteAll ();
45 Assert.IsTrue (target.HasPostponed);
48 Assert.IsTrue (target.RetryPostponed (out i));
49 Assert.AreEqual (42, i);
53 public void PostponeTwoTargetsTest ()
55 var scheduler = new TestScheduler ();
57 new BufferBlock<int> (new DataflowBlockOptions { TaskScheduler = scheduler });
58 var target1 = new TestTargetBlock<int> { Postpone = true };
59 var target2 = new TestTargetBlock<int> { Postpone = true };
60 Assert.IsNotNull (source.LinkTo (target1));
61 Assert.IsNotNull (source.LinkTo (target2));
62 Assert.IsFalse (target1.HasPostponed);
63 Assert.IsFalse (target2.HasPostponed);
65 Assert.IsTrue (source.Post (42));
66 scheduler.ExecuteAll ();
67 Assert.IsTrue (target1.HasPostponed);
68 Assert.IsTrue (target2.HasPostponed);
71 Assert.IsTrue (target2.RetryPostponed (out i));
72 Assert.AreEqual (42, i);
74 Assert.IsFalse (target1.RetryPostponed (out i));
75 Assert.AreEqual (default(int), i);
79 public void DecliningTest ()
81 var scheduler = new TestScheduler ();
83 new BufferBlock<int> (new DataflowBlockOptions { TaskScheduler = scheduler });
84 var target1 = new TestTargetBlock<int> { Decline = true };
85 var target2 = new TestTargetBlock<int> ();
86 Assert.IsNotNull (source.LinkTo (target1));
87 Assert.IsNotNull (source.LinkTo (target2));
88 Assert.AreEqual (default(int), target1.DirectlyAccepted);
89 Assert.AreEqual (default(int), target2.DirectlyAccepted);
91 Assert.IsTrue (source.Post (42));
92 scheduler.ExecuteAll ();
93 Assert.AreEqual (default(int), target1.DirectlyAccepted);
94 Assert.AreEqual (42, target2.DirectlyAccepted);
98 public void ConditionalDecliningTest ()
100 var scheduler = new TestScheduler ();
102 new BufferBlock<int> (new DataflowBlockOptions { TaskScheduler = scheduler });
103 var target = new TestTargetBlock<int> { Decline = true };
104 Assert.IsNotNull (source.LinkTo (target));
105 Assert.AreEqual (default(int), target.DirectlyAccepted);
107 Assert.IsTrue (source.Post (42));
108 scheduler.ExecuteAll ();
109 Assert.AreEqual (default(int), target.DirectlyAccepted);
111 target.Decline = false;
112 Assert.IsTrue (source.Post (43));
113 scheduler.ExecuteAll ();
114 Assert.AreEqual (default(int), target.DirectlyAccepted);
116 Assert.AreEqual (42, source.Receive (TimeSpan.FromMilliseconds (100)));
117 scheduler.ExecuteAll ();
118 Assert.AreEqual (43, target.DirectlyAccepted);
122 public void TryReceiveWithPredicateTest ()
124 var source = new BufferBlock<int> ();
125 Assert.IsTrue (source.Post (42));
126 Assert.IsTrue (source.Post (43));
129 Assert.IsFalse (source.TryReceive (i => i == 43, out item));
130 Assert.AreEqual (default(int), item);
132 Assert.AreEqual (42, source.Receive ());
134 Assert.IsTrue (source.TryReceive (i => i == 43, out item));
135 Assert.AreEqual (43, item);
139 public void ReserveTest ()
141 var scheduler = new TestScheduler ();
143 new BufferBlock<int> (new DataflowBlockOptions { TaskScheduler = scheduler });
144 var target = new TestTargetBlock<int> { Postpone = true };
145 Assert.IsNotNull (source.LinkTo (target));
146 Assert.IsFalse (target.HasPostponed);
148 Assert.IsTrue (source.Post (42));
149 Assert.IsTrue (source.Post (43));
150 scheduler.ExecuteAll ();
151 Assert.IsTrue (target.HasPostponed);
153 Assert.IsTrue (target.ReservePostponed ());
155 Assert.IsFalse (source.TryReceive (null, out i));
156 Assert.AreEqual (default(int), i);
158 Assert.IsFalse (source.TryReceiveAll (out items));
159 Assert.AreEqual (default(IList<int>), items);
161 Assert.IsTrue (target.RetryPostponed (out i));
162 Assert.AreEqual (42, i);
164 Assert.IsTrue (source.TryReceive (null, out i));
165 Assert.AreEqual (43, i);
169 public void ConsumeAfterReceiveTest ()
171 var scheduler = new TestScheduler ();
173 new BufferBlock<int> (new DataflowBlockOptions { TaskScheduler = scheduler });
174 var target = new TestTargetBlock<int> { Postpone = true };
175 Assert.IsNotNull (source.LinkTo (target));
176 Assert.IsFalse (target.HasPostponed);
178 Assert.IsTrue (source.Post (42));
179 scheduler.ExecuteAll ();
180 Assert.IsTrue (target.HasPostponed);
182 target.Postpone = false;
184 Assert.AreEqual (42, source.Receive ());
185 Assert.IsTrue (source.Post (43));
187 Assert.AreEqual (default(int), target.DirectlyAccepted);
190 Assert.IsFalse (target.RetryPostponed (out i));
191 Assert.AreEqual (default(int), i);
193 scheduler.ExecuteAll ();
195 Assert.AreEqual (43, target.DirectlyAccepted);
199 public void FaultConsume ()
201 var scheduler = new TestScheduler ();
203 new BufferBlock<int> (new DataflowBlockOptions { TaskScheduler = scheduler });
204 var target = new TestTargetBlock<int> { Postpone = true };
205 Assert.IsNotNull (source.LinkTo (target));
207 Assert.IsTrue (source.Post (42));
208 scheduler.ExecuteAll ();
209 Assert.IsTrue (target.HasPostponed);
211 ((IDataflowBlock)source).Fault (new Exception ());
213 scheduler.ExecuteAll ();
217 Assert.IsFalse (target.RetryPostponed (out value));
221 public void FaultConsumeBroadcast ()
223 var scheduler = new TestScheduler ();
224 var source = new BroadcastBlock<int> (null,
225 new DataflowBlockOptions { TaskScheduler = scheduler });
226 var target = new TestTargetBlock<int> { Postpone = true };
227 Assert.IsNotNull (source.LinkTo (target));
229 Assert.IsTrue (source.Post (42));
230 scheduler.ExecuteAll ();
231 Assert.IsTrue (target.HasPostponed);
233 var exception = new Exception ();
234 ((IDataflowBlock)source).Fault (exception);
236 scheduler.ExecuteAll ();
239 source.Completion.Wait (1000);
240 Assert.Fail ("Task must be faulted");
241 } catch (AggregateException ex) {
242 Assert.AreEqual (exception, ex.InnerException, "#9");
245 Assert.IsTrue (source.Completion.IsFaulted);
247 Assert.IsTrue (target.RetryPostponed (out value));
248 Assert.AreEqual (42, value);
252 public void FaultExecutingConsume ()
254 var evt = new ManualResetEventSlim ();
255 var source = new TransformBlock<int, int> (i =>
261 var target = new TestTargetBlock<int> { Postpone = true };
262 Assert.IsNotNull (source.LinkTo (target));
264 Assert.IsTrue (source.Post (1), "#1");
265 Assert.IsTrue (source.Post (2), "#2");
266 Assert.IsTrue (source.Post (3), "#3");
267 target.PostponedEvent.Wait (1000);
268 Assert.IsTrue (target.HasPostponed, "#4");
270 var exception = new Exception ();
271 ((IDataflowBlock)source).Fault (exception);
273 source.Completion.Wait (1000);
275 Assert.IsFalse (source.Completion.IsFaulted, "#5");
277 Assert.IsTrue (target.RetryPostponed (out value), "#6");
278 Assert.AreEqual (1, value, "#7");
283 source.Completion.Wait (1000);
284 Assert.Fail ("Task must be faulted");
285 } catch (AggregateException ex) {
286 Assert.AreEqual (exception, ex.InnerException, "#9");
289 Assert.IsTrue (source.Completion.IsFaulted, "#10");
290 Assert.IsFalse (target.RetryPostponed (out value), "#11");
294 public void ReserveFaultConsume ()
296 var scheduler = new TestScheduler ();
298 new BufferBlock<int> (new DataflowBlockOptions { TaskScheduler = scheduler });
299 var target = new TestTargetBlock<int> { Postpone = true };
300 Assert.IsNotNull (source.LinkTo (target));
302 Assert.IsTrue (source.Post (42));
303 scheduler.ExecuteAll ();
304 Assert.IsTrue (target.HasPostponed);
306 Assert.IsTrue (target.ReservePostponed ());
308 ((IDataflowBlock)source).Fault (new Exception ());
310 scheduler.ExecuteAll ();
314 Assert.IsTrue (target.RetryPostponed (out value));
318 public void ReserveFaultConsumeBroadcast ()
320 var scheduler = new TestScheduler ();
321 var source = new BroadcastBlock<int> (null,
322 new DataflowBlockOptions { TaskScheduler = scheduler });
323 var target = new TestTargetBlock<int> { Postpone = true };
324 Assert.IsNotNull (source.LinkTo (target));
326 Assert.IsTrue (source.Post (42));
327 scheduler.ExecuteAll ();
328 Assert.IsTrue (target.HasPostponed);
330 Assert.IsTrue (target.ReservePostponed ());
332 ((IDataflowBlock)source).Fault (new Exception ());
334 scheduler.ExecuteAll ();
338 Assert.IsTrue (target.RetryPostponed (out value));
342 public void PostAfterTimeout ()
344 var scheduler = new TestScheduler ();
346 new BufferBlock<int> (new DataflowBlockOptions { TaskScheduler = scheduler });
348 AssertEx.Throws<TimeoutException> (
349 () => block.Receive (TimeSpan.FromMilliseconds (100)));
353 scheduler.ExecuteAll ();
356 Assert.IsTrue (block.TryReceive (out item));
357 Assert.AreEqual (1, item);
361 public void PostAfterCancellation ()
363 var scheduler = new TestScheduler ();
365 new BufferBlock<int> (new DataflowBlockOptions { TaskScheduler = scheduler });
367 var tokenSource = new CancellationTokenSource ();
369 Task.Factory.StartNew (
373 tokenSource.Cancel ();
376 AssertEx.Throws<OperationCanceledException> (
377 () => block.Receive (tokenSource.Token));
381 scheduler.ExecuteAll ();
384 Assert.IsTrue (block.TryReceive (out item));
385 Assert.AreEqual (1, item);
389 class TestTargetBlock<T> : ITargetBlock<T> {
390 public bool Postpone { get; set; }
392 public bool Decline { get; set; }
394 Tuple<ISourceBlock<T>, DataflowMessageHeader> postponed;
396 public T DirectlyAccepted { get; private set; }
398 public ManualResetEventSlim PostponedEvent = new ManualResetEventSlim ();
400 public DataflowMessageStatus OfferMessage (
401 DataflowMessageHeader messageHeader, T messageValue, ISourceBlock<T> source,
402 bool consumeToAccept)
405 return DataflowMessageStatus.Declined;
408 postponed = Tuple.Create (source, messageHeader);
409 PostponedEvent.Set ();
410 return DataflowMessageStatus.Postponed;
413 DirectlyAccepted = messageValue;
414 return DataflowMessageStatus.Accepted;
417 public bool HasPostponed
419 get { return postponed != null; }
422 public bool RetryPostponed (out T value)
425 value = postponed.Item1.ConsumeMessage (
426 postponed.Item2, this, out consumed);
431 public bool ReservePostponed ()
433 return postponed.Item1.ReserveMessage (postponed.Item2, this);
436 public void Complete ()
440 public void Fault (Exception exception)
444 public Task Completion { get; private set; }