-
Notifications
You must be signed in to change notification settings - Fork 639
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
SWEEP: Removed dependency on Prism.Core and brought the Prism.Events …
…namespace into Lucene.Net.Util.Events including tests
- Loading branch information
1 parent
6dd2565
commit ab0df3f
Showing
30 changed files
with
3,172 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
43 changes: 43 additions & 0 deletions
43
src/Lucene.Net.Tests/Support/Util/Events/MockDelegateReference.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
// Source: https://github.com/PrismLibrary/Prism/blob/7f0b1680bbe754da790274f80851265f808d9bbf | ||
|
||
#region Copyright .NET Foundation, Licensed under the MIT License (MIT) | ||
// The MIT License (MIT) | ||
// | ||
// Copyright(c).NET Foundation | ||
// | ||
// All rights reserved. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated | ||
// documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, | ||
// copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software | ||
// is furnished to do so, subject to the following conditions: | ||
// | ||
// The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. | ||
// | ||
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES | ||
// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE | ||
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR | ||
// IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. | ||
#endregion | ||
|
||
#if !FEATURE_CONDITIONALWEAKTABLE_ENUMERATOR | ||
|
||
using System; | ||
|
||
namespace Lucene.Net.Util.Events | ||
{ | ||
class MockDelegateReference : IDelegateReference | ||
{ | ||
public Delegate Target { get; set; } | ||
|
||
public MockDelegateReference() | ||
{ | ||
|
||
} | ||
|
||
public MockDelegateReference(Delegate target) | ||
{ | ||
Target = target; | ||
} | ||
} | ||
} | ||
|
||
#endif |
91 changes: 91 additions & 0 deletions
91
src/Lucene.Net.Tests/Support/Util/Events/TestBackgroundEventSubscription.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,91 @@ | ||
// Source: https://github.com/PrismLibrary/Prism/blob/7f0b1680bbe754da790274f80851265f808d9bbf | ||
|
||
#region Copyright .NET Foundation, Licensed under the MIT License (MIT) | ||
// The MIT License (MIT) | ||
// | ||
// Copyright(c).NET Foundation | ||
// | ||
// All rights reserved. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated | ||
// documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, | ||
// copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software | ||
// is furnished to do so, subject to the following conditions: | ||
// | ||
// The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. | ||
// | ||
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES | ||
// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE | ||
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR | ||
// IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. | ||
#endregion | ||
|
||
#if !FEATURE_CONDITIONALWEAKTABLE_ENUMERATOR | ||
|
||
using NUnit.Framework; | ||
using System; | ||
using System.Threading; | ||
using Assert = Lucene.Net.TestFramework.Assert; | ||
|
||
namespace Lucene.Net.Util.Events | ||
{ | ||
[TestFixture] | ||
public class TestBackgroundEventSubscription | ||
{ | ||
[Test] | ||
public void ShouldReceiveDelegateOnDifferentThread() | ||
{ | ||
ManualResetEvent completeEvent = new ManualResetEvent(false); | ||
SynchronizationContext.SetSynchronizationContext(new SynchronizationContext()); | ||
SynchronizationContext calledSyncContext = null; | ||
Action<object> action = delegate | ||
{ | ||
calledSyncContext = SynchronizationContext.Current; | ||
completeEvent.Set(); | ||
}; | ||
|
||
IDelegateReference actionDelegateReference = new MockDelegateReference() { Target = action }; | ||
IDelegateReference filterDelegateReference = new MockDelegateReference() { Target = (Predicate<object>)delegate { return true; } }; | ||
|
||
var eventSubscription = new BackgroundEventSubscription<object>(actionDelegateReference, filterDelegateReference); | ||
|
||
|
||
var publishAction = eventSubscription.GetExecutionStrategy(); | ||
|
||
Assert.NotNull(publishAction); | ||
|
||
publishAction.Invoke(null); | ||
|
||
completeEvent.WaitOne(5000); | ||
|
||
Assert.AreNotEqual(SynchronizationContext.Current, calledSyncContext); | ||
} | ||
|
||
[Test] | ||
public void ShouldReceiveDelegateOnDifferentThreadNonGeneric() | ||
{ | ||
var completeEvent = new ManualResetEvent(false); | ||
SynchronizationContext.SetSynchronizationContext(new SynchronizationContext()); | ||
SynchronizationContext calledSyncContext = null; | ||
Action action = delegate | ||
{ | ||
calledSyncContext = SynchronizationContext.Current; | ||
completeEvent.Set(); | ||
}; | ||
|
||
IDelegateReference actionDelegateReference = new MockDelegateReference() { Target = action }; | ||
|
||
var eventSubscription = new BackgroundEventSubscription(actionDelegateReference); | ||
|
||
var publishAction = eventSubscription.GetExecutionStrategy(); | ||
|
||
Assert.NotNull(publishAction); | ||
|
||
publishAction.Invoke(null); | ||
|
||
completeEvent.WaitOne(5000); | ||
|
||
Assert.AreNotEqual(SynchronizationContext.Current, calledSyncContext); | ||
} | ||
} | ||
} | ||
|
||
#endif |
214 changes: 214 additions & 0 deletions
214
src/Lucene.Net.Tests/Support/Util/Events/TestDelegateReference.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,214 @@ | ||
// Source: https://github.com/PrismLibrary/Prism/blob/7f0b1680bbe754da790274f80851265f808d9bbf | ||
|
||
#region Copyright .NET Foundation, Licensed under the MIT License (MIT) | ||
// The MIT License (MIT) | ||
// | ||
// Copyright(c).NET Foundation | ||
// | ||
// All rights reserved. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated | ||
// documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, | ||
// copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software | ||
// is furnished to do so, subject to the following conditions: | ||
// | ||
// The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. | ||
// | ||
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES | ||
// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE | ||
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR | ||
// IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. | ||
#endregion | ||
|
||
#if !FEATURE_CONDITIONALWEAKTABLE_ENUMERATOR | ||
|
||
using NUnit.Framework; | ||
using System; | ||
using System.Threading.Tasks; | ||
using Assert = Lucene.Net.TestFramework.Assert; | ||
|
||
namespace Lucene.Net.Util.Events | ||
{ | ||
[TestFixture] | ||
public class TestDelegateReference | ||
{ | ||
[Test] | ||
public void KeepAlivePreventsDelegateFromBeingCollected() | ||
{ | ||
var delegates = new SomeClassHandler(); | ||
var delegateReference = new DelegateReference((Action<string>)delegates.DoEvent, true); | ||
|
||
delegates = null; | ||
GC.Collect(); | ||
|
||
Assert.NotNull(delegateReference.Target); | ||
} | ||
|
||
[Test] | ||
public async Task NotKeepAliveAllowsDelegateToBeCollected() | ||
{ | ||
var delegates = new SomeClassHandler(); | ||
var delegateReference = new DelegateReference((Action<string>)delegates.DoEvent, false); | ||
|
||
delegates = null; | ||
await Task.Delay(100); | ||
GC.Collect(); | ||
|
||
Assert.Null(delegateReference.Target); | ||
} | ||
|
||
[Test] | ||
public async Task NotKeepAliveKeepsDelegateIfStillAlive() | ||
{ | ||
var delegates = new SomeClassHandler(); | ||
var delegateReference = new DelegateReference((Action<string>)delegates.DoEvent, false); | ||
|
||
GC.Collect(); | ||
|
||
Assert.NotNull(delegateReference.Target); | ||
|
||
GC.KeepAlive(delegates); //Makes delegates ineligible for garbage collection until this point (to prevent oompiler optimizations that may release the referenced object prematurely). | ||
delegates = null; | ||
await Task.Delay(100); | ||
GC.Collect(); | ||
|
||
Assert.Null(delegateReference.Target); | ||
} | ||
|
||
[Test] | ||
public void TargetShouldReturnAction() | ||
{ | ||
var classHandler = new SomeClassHandler(); | ||
Action<string> myAction = new Action<string>(classHandler.MyAction); | ||
|
||
var weakAction = new DelegateReference(myAction, false); | ||
|
||
((Action<string>)weakAction.Target)("payload"); | ||
Assert.AreEqual("payload", classHandler.MyActionArg); | ||
} | ||
|
||
[Test] | ||
public async Task ShouldAllowCollectionOfOriginalDelegate() | ||
{ | ||
var classHandler = new SomeClassHandler(); | ||
Action<string> myAction = new Action<string>(classHandler.MyAction); | ||
|
||
var weakAction = new DelegateReference(myAction, false); | ||
|
||
var originalAction = new WeakReference(myAction); | ||
myAction = null; | ||
await Task.Delay(100); | ||
GC.Collect(); | ||
Assert.False(originalAction.IsAlive); | ||
|
||
((Action<string>)weakAction.Target)("payload"); | ||
Assert.AreEqual("payload", classHandler.MyActionArg); | ||
} | ||
|
||
[Test] | ||
public async Task ShouldReturnNullIfTargetNotAlive() | ||
{ | ||
SomeClassHandler handler = new SomeClassHandler(); | ||
var weakHandlerRef = new WeakReference(handler); | ||
|
||
var action = new DelegateReference((Action<string>)handler.DoEvent, false); | ||
|
||
handler = null; | ||
await Task.Delay(100); | ||
GC.Collect(); | ||
Assert.False(weakHandlerRef.IsAlive); | ||
|
||
Assert.Null(action.Target); | ||
} | ||
|
||
[Test] | ||
public void WeakDelegateWorksWithStaticMethodDelegates() | ||
{ | ||
var action = new DelegateReference((Action)SomeClassHandler.StaticMethod, false); | ||
|
||
Assert.NotNull(action.Target); | ||
} | ||
|
||
[Test] | ||
public void TargetEqualsActionShouldReturnTrue() | ||
{ | ||
var classHandler = new SomeClassHandler(); | ||
Action<string> myAction = new Action<string>(classHandler.MyAction); | ||
|
||
var weakAction = new DelegateReference(myAction, false); | ||
|
||
Assert.True(weakAction.TargetEquals(new Action<string>(classHandler.MyAction))); | ||
} | ||
|
||
[Test] | ||
public async Task TargetEqualsNullShouldReturnTrueIfTargetNotAlive() | ||
{ | ||
SomeClassHandler handler = new SomeClassHandler(); | ||
var weakHandlerRef = new WeakReference(handler); | ||
|
||
var action = new DelegateReference((Action<string>)handler.DoEvent, false); | ||
|
||
handler = null; | ||
|
||
// Intentional delay to encourage Garbage Collection to actually occur | ||
await Task.Delay(100); | ||
GC.Collect(); | ||
Assert.False(weakHandlerRef.IsAlive); | ||
|
||
Assert.True(action.TargetEquals(null)); | ||
} | ||
|
||
[Test] | ||
public void TargetEqualsNullShouldReturnFalseIfTargetAlive() | ||
{ | ||
SomeClassHandler handler = new SomeClassHandler(); | ||
var weakHandlerRef = new WeakReference(handler); | ||
|
||
var action = new DelegateReference((Action<string>)handler.DoEvent, false); | ||
|
||
Assert.False(action.TargetEquals(null)); | ||
Assert.True(weakHandlerRef.IsAlive); | ||
GC.KeepAlive(handler); | ||
} | ||
|
||
[Test] | ||
public void TargetEqualsWorksWithStaticMethodDelegates() | ||
{ | ||
var action = new DelegateReference((Action)SomeClassHandler.StaticMethod, false); | ||
|
||
Assert.True(action.TargetEquals((Action)SomeClassHandler.StaticMethod)); | ||
} | ||
|
||
//todo: fix | ||
//[Test] | ||
//public void NullDelegateThrows() | ||
//{ | ||
// Assert.ThrowsException<ArgumentNullException>(() => | ||
// { | ||
// var action = new DelegateReference(null, true); | ||
// }); | ||
//} | ||
|
||
public class SomeClassHandler | ||
{ | ||
public string MyActionArg; | ||
|
||
public void DoEvent(string value) | ||
{ | ||
string myValue = value; | ||
} | ||
|
||
public static void StaticMethod() | ||
{ | ||
#pragma warning disable 0219 | ||
int i = 0; | ||
#pragma warning restore 0219 | ||
} | ||
|
||
public void MyAction(string arg) | ||
{ | ||
MyActionArg = arg; | ||
} | ||
} | ||
} | ||
} | ||
|
||
#endif |
Oops, something went wrong.