Compare commits
10 Commits
b58a74709e
...
master
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
4bcfdb56b5 | ||
|
|
f19d390b78 | ||
|
|
2d8ea50944 | ||
|
|
e5980ecb10 | ||
|
|
c36b4581c1 | ||
|
|
379ec7881f | ||
|
|
38df3a3ff3 | ||
|
|
abf09308fc | ||
|
|
50f0754a0f | ||
|
|
3084a49bdd |
30
README.md
30
README.md
@@ -1,3 +1,33 @@
|
|||||||
# WpfViewModelFirst
|
# WpfViewModelFirst
|
||||||
|
|
||||||
This project is for researching Actions that need to call an async/await function.
|
This project is for researching Actions that need to call an async/await function.
|
||||||
|
|
||||||
|
**Unit Testing:**
|
||||||
|
|
||||||
|
This area has been troubling. The MainWindowViewModel needs to set a value
|
||||||
|
of the ObservableObject on the UI thread. Doing a straight unit test will
|
||||||
|
cause a deadlock.
|
||||||
|
|
||||||
|
The first process of testing was learning that the Moq mocking framework
|
||||||
|
has the ability to trigger the action passed to Part1ViewModel. This has
|
||||||
|
extra setup and makes the test hard to read.
|
||||||
|
|
||||||
|
The next step was finding a way to wait for the ContinueWith in the method
|
||||||
|
to finish. That was accomplished with the TaskCompletionSource.
|
||||||
|
With the code being triggered by the callback, this would exhibit 3 different
|
||||||
|
behaviors. Many times it would pass. Occassionally it would fail one of the
|
||||||
|
asserts. The other times it would frustratingly get into a deadlock.
|
||||||
|
|
||||||
|
In searching for a way to test this I learned I can set an attribute on the
|
||||||
|
class to allow internal methods and fields to be seen by the test assembly.
|
||||||
|
This helped the test code be easier to read.
|
||||||
|
[assembly:System.Runtime.CompilerServices.InternalsVisibleTo("WpfViewModelFirst.Tests")]
|
||||||
|
|
||||||
|
|
||||||
|
Using a combination of Task.Run and DispatcherFrame the tests appear to
|
||||||
|
complete successfully every time.
|
||||||
|
|
||||||
|
**Note:** When the Task.Run is awaited the test
|
||||||
|
will deadlock.
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -1,4 +1,6 @@
|
|||||||
using Moq;
|
using Moq;
|
||||||
|
using System.Windows.Controls;
|
||||||
|
using System.Windows.Threading;
|
||||||
using WpfViewModelFirst.Part1;
|
using WpfViewModelFirst.Part1;
|
||||||
using WpfViewModelFirst.Part2;
|
using WpfViewModelFirst.Part2;
|
||||||
|
|
||||||
@@ -9,26 +11,119 @@ namespace WpfViewModelFirst.Tests
|
|||||||
[Fact]
|
[Fact]
|
||||||
public void Part1WillSetPart1ViewModelToCurrentViewModel()
|
public void Part1WillSetPart1ViewModelToCurrentViewModel()
|
||||||
{
|
{
|
||||||
Part1ViewModel part1ViewModel = new(() => _ = true);
|
Part1ViewModel part1ViewModel = new(() => { return Task.CompletedTask; });
|
||||||
Mock<IViewModelFactory> mockViewModelFactory = new Mock<IViewModelFactory>();
|
Mock<IViewModelFactory> mockViewModelFactory = new();
|
||||||
mockViewModelFactory.Setup(vmf => vmf.GetPart1ViewModel(It.IsAny<Action>()))
|
mockViewModelFactory.Setup(vmf => vmf.GetPart1ViewModel(It.IsAny<Func<Task>>()))
|
||||||
.Returns(part1ViewModel);
|
.Returns(part1ViewModel);
|
||||||
MainWindowViewModel main = new(mockViewModelFactory.Object);
|
MainWindowViewModel main = new(mockViewModelFactory.Object);
|
||||||
main.Part1(null);
|
main.Part1(null);
|
||||||
Assert.Equal(part1ViewModel, main.CurrentViewModel);
|
Assert.Equal(part1ViewModel, main.CurrentViewModel);
|
||||||
}
|
}
|
||||||
|
//[Fact]
|
||||||
|
//public async Task Part1CallbackIsSuccessfull()
|
||||||
|
//{
|
||||||
|
// TaskCompletionSource<bool> taskCompletionSource = new();
|
||||||
|
// Mock<IViewModelFactory> mockViewModelFactory = new();
|
||||||
|
// mockViewModelFactory.Setup(vmf => vmf.GetPart1ViewModel(It.IsAny<Func<Task>>()))
|
||||||
|
// .Callback<Func<Task>>(c =>
|
||||||
|
// {
|
||||||
|
// Task.Run(() =>
|
||||||
|
// {
|
||||||
|
// c.Invoke();
|
||||||
|
// });
|
||||||
|
// });
|
||||||
|
// mockViewModelFactory.Setup(vmf => vmf.GetPart2ViewModel())
|
||||||
|
// .Returns(() => new Part2ViewModel());
|
||||||
|
// MainWindowViewModel main = new(mockViewModelFactory.Object);
|
||||||
|
// main.ItHappened += () => taskCompletionSource.SetResult(true);
|
||||||
|
// main.Part1(null);
|
||||||
|
// await taskCompletionSource.Task.WaitAsync(CancellationToken.None);
|
||||||
|
// Assert.IsType<Part2ViewModel>(main.CurrentViewModel);
|
||||||
|
// Assert.Single(main.Strings);
|
||||||
|
//}
|
||||||
[Fact]
|
[Fact]
|
||||||
public void Part1CallbackIsSuccessfull()
|
public async Task Part1CallBackExample()
|
||||||
{
|
{
|
||||||
Mock<IViewModelFactory> mockViewModelFactory = new Mock<IViewModelFactory>();
|
Mock<IViewModelFactory> mockViewModelFactory = new();
|
||||||
mockViewModelFactory.Setup(vmf => vmf.GetPart1ViewModel(It.IsAny<Action>()))
|
|
||||||
.Returns(() => new Part1ViewModel(() => Task.Delay(0)))
|
|
||||||
.Callback<Action>(c => c.Invoke());
|
|
||||||
mockViewModelFactory.Setup(vmf => vmf.GetPart2ViewModel())
|
mockViewModelFactory.Setup(vmf => vmf.GetPart2ViewModel())
|
||||||
.Returns(() => new Part2ViewModel());
|
.Returns(() => new Part2ViewModel());
|
||||||
MainWindowViewModel main = new(mockViewModelFactory.Object);
|
MainWindowViewModel main = new(mockViewModelFactory.Object);
|
||||||
|
TaskCompletionSource<bool> taskCompletionSource = new();
|
||||||
|
main.ItHappened += () => taskCompletionSource.SetResult(true);
|
||||||
|
mockViewModelFactory.Setup(vmf => vmf.GetPart1ViewModel(It.IsAny<Func<Task>>()))
|
||||||
|
.Callback<Func<Task>>(c =>
|
||||||
|
{
|
||||||
|
Task.Run(() =>
|
||||||
|
{
|
||||||
|
DispatcherFrame frame = new();
|
||||||
|
frame.Dispatcher.Invoke(
|
||||||
|
DispatcherPriority.Normal, () =>
|
||||||
|
{
|
||||||
|
c.Invoke();
|
||||||
|
frame.Continue = true;
|
||||||
|
});
|
||||||
|
Dispatcher.PushFrame(frame);
|
||||||
|
});
|
||||||
|
});
|
||||||
main.Part1(null);
|
main.Part1(null);
|
||||||
|
await taskCompletionSource.Task.WaitAsync(CancellationToken.None);
|
||||||
|
Assert.IsType<Part2ViewModel>(main.CurrentViewModel);
|
||||||
|
Assert.Single(main.Strings);
|
||||||
|
}
|
||||||
|
// This method requires the Part1Action method to be internal not private
|
||||||
|
// The MainWindowViewModel class also needs to have an attribute allowing
|
||||||
|
// this assembly to see the internals
|
||||||
|
// [assembly:System.Runtime.CompilerServices.InternalsVisibleTo("WpfViewModelFirst.Tests")]
|
||||||
|
[Fact]
|
||||||
|
public async Task Part1ActionWillSetCurrentViewModel()
|
||||||
|
{
|
||||||
|
Mock<IViewModelFactory> mockViewModelFactory = new();
|
||||||
|
mockViewModelFactory.Setup(vmf => vmf.GetPart2ViewModel())
|
||||||
|
.Returns(() => new Part2ViewModel());
|
||||||
|
MainWindowViewModel main = new(mockViewModelFactory.Object);
|
||||||
|
TaskCompletionSource<bool> taskCompletionSource = new();
|
||||||
|
main.ItHappened += () => taskCompletionSource.SetResult(true);
|
||||||
|
|
||||||
|
Task run = new(() =>
|
||||||
|
{
|
||||||
|
DispatcherFrame frame = new();
|
||||||
|
frame.Dispatcher.Invoke(
|
||||||
|
DispatcherPriority.Normal, () =>
|
||||||
|
{
|
||||||
|
main.Part1Action();
|
||||||
|
frame.Continue = true;
|
||||||
|
});
|
||||||
|
Dispatcher.PushFrame(frame);
|
||||||
|
});
|
||||||
|
run.Start();
|
||||||
|
await taskCompletionSource.Task.WaitAsync(CancellationToken.None);
|
||||||
Assert.IsType<Part2ViewModel>(main.CurrentViewModel);
|
Assert.IsType<Part2ViewModel>(main.CurrentViewModel);
|
||||||
}
|
}
|
||||||
|
[Fact]
|
||||||
|
public async Task Part1ActionWillSetSingle()
|
||||||
|
{
|
||||||
|
Mock<IViewModelFactory> mockViewModelFactory = new();
|
||||||
|
mockViewModelFactory.Setup(vmf => vmf.GetPart2ViewModel())
|
||||||
|
.Returns(() => new Part2ViewModel());
|
||||||
|
MainWindowViewModel main = new(mockViewModelFactory.Object);
|
||||||
|
TaskCompletionSource<bool> taskCompletionSource = new();
|
||||||
|
main.ItHappened += () => taskCompletionSource.SetResult(true);
|
||||||
|
|
||||||
|
Task run = new(() =>
|
||||||
|
{
|
||||||
|
DispatcherFrame frame = new();
|
||||||
|
frame.Dispatcher.Invoke(
|
||||||
|
DispatcherPriority.Normal, () =>
|
||||||
|
{
|
||||||
|
main.Part1Action();
|
||||||
|
frame.Continue = true;
|
||||||
|
});
|
||||||
|
Dispatcher.PushFrame(frame);
|
||||||
|
});
|
||||||
|
run.Start();
|
||||||
|
await taskCompletionSource.Task.WaitAsync(CancellationToken.None);
|
||||||
|
Assert.Single(main.Strings);
|
||||||
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -1,4 +1,5 @@
|
|||||||
using System;
|
using System;
|
||||||
|
using System.Threading.Tasks;
|
||||||
using WpfViewModelFirst.Part1;
|
using WpfViewModelFirst.Part1;
|
||||||
using WpfViewModelFirst.Part2;
|
using WpfViewModelFirst.Part2;
|
||||||
|
|
||||||
@@ -6,7 +7,7 @@ namespace WpfViewModelFirst
|
|||||||
{
|
{
|
||||||
public interface IViewModelFactory
|
public interface IViewModelFactory
|
||||||
{
|
{
|
||||||
Part1ViewModel GetPart1ViewModel(Action finishAction);
|
Part1ViewModel GetPart1ViewModel(Func<Task> finishAction);
|
||||||
Part2ViewModel GetPart2ViewModel();
|
Part2ViewModel GetPart2ViewModel();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -10,6 +10,7 @@ using System.Windows.Threading;
|
|||||||
using WpfViewModelFirst.Part1;
|
using WpfViewModelFirst.Part1;
|
||||||
using WpfViewModelFirst.Part2;
|
using WpfViewModelFirst.Part2;
|
||||||
|
|
||||||
|
[assembly:System.Runtime.CompilerServices.InternalsVisibleTo("WpfViewModelFirst.Tests")]
|
||||||
namespace WpfViewModelFirst
|
namespace WpfViewModelFirst
|
||||||
{
|
{
|
||||||
public class MainWindowViewModel : ViewModelBase
|
public class MainWindowViewModel : ViewModelBase
|
||||||
@@ -20,7 +21,7 @@ namespace WpfViewModelFirst
|
|||||||
StartCommand = new CustomCommand(Part1);
|
StartCommand = new CustomCommand(Part1);
|
||||||
}
|
}
|
||||||
|
|
||||||
private IViewModelFactory _viewModelFactory;
|
private readonly IViewModelFactory _viewModelFactory;
|
||||||
|
|
||||||
public ICommand StartCommand { get; set; }
|
public ICommand StartCommand { get; set; }
|
||||||
|
|
||||||
@@ -29,24 +30,26 @@ namespace WpfViewModelFirst
|
|||||||
CurrentViewModel = null;
|
CurrentViewModel = null;
|
||||||
CurrentViewModel = _viewModelFactory.GetPart1ViewModel(Part1Action);
|
CurrentViewModel = _viewModelFactory.GetPart1ViewModel(Part1Action);
|
||||||
}
|
}
|
||||||
private void Part1Action()
|
internal Task Part1Action()
|
||||||
{
|
{
|
||||||
var currentDispatcher = Dispatcher.CurrentDispatcher;
|
|
||||||
CurrentViewModel = null;
|
CurrentViewModel = null;
|
||||||
LongDelay().ContinueWith(c =>
|
Dispatcher currentDispatcher = Dispatcher.CurrentDispatcher;
|
||||||
|
return LongDelay().ContinueWith((c) =>
|
||||||
{
|
{
|
||||||
System.Diagnostics.Debug.WriteLine(c.Result);
|
|
||||||
CurrentViewModel = _viewModelFactory.GetPart2ViewModel();
|
CurrentViewModel = _viewModelFactory.GetPart2ViewModel();
|
||||||
currentDispatcher.Invoke(() =>
|
currentDispatcher.Invoke(() =>
|
||||||
{
|
{
|
||||||
Strings.Add($"{DateTime.Now}");
|
Strings.Add($"{DateTime.Now}");
|
||||||
}
|
});
|
||||||
);
|
ItHappened?.Invoke();
|
||||||
}, TaskContinuationOptions.OnlyOnRanToCompletion);
|
}, TaskContinuationOptions.OnlyOnRanToCompletion);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public event Action? ItHappened;
|
||||||
|
|
||||||
private async Task<string> LongDelay()
|
private async Task<string> LongDelay()
|
||||||
{
|
{
|
||||||
|
// This would be the Repository call in the production application
|
||||||
await Task.Delay(500);
|
await Task.Delay(500);
|
||||||
return "Completed";
|
return "Completed";
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -12,6 +12,9 @@
|
|||||||
<RowDefinition/>
|
<RowDefinition/>
|
||||||
</Grid.RowDefinitions>
|
</Grid.RowDefinitions>
|
||||||
<Button Grid.Row="0"
|
<Button Grid.Row="0"
|
||||||
|
HorizontalAlignment="Center"
|
||||||
|
VerticalAlignment="Center"
|
||||||
|
Padding="10"
|
||||||
Content="Finish"
|
Content="Finish"
|
||||||
Command="{Binding FinishCommand}"/>
|
Command="{Binding FinishCommand}"/>
|
||||||
</Grid>
|
</Grid>
|
||||||
|
|||||||
@@ -9,9 +9,9 @@ namespace WpfViewModelFirst.Part1
|
|||||||
{
|
{
|
||||||
public class Part1ViewModel : ViewModelBase
|
public class Part1ViewModel : ViewModelBase
|
||||||
{
|
{
|
||||||
private readonly Action _finishAction;
|
private readonly Func<Task> _finishAction;
|
||||||
|
|
||||||
public Part1ViewModel(Action finishAction)
|
public Part1ViewModel(Func<Task> finishAction)
|
||||||
{
|
{
|
||||||
_finishAction = finishAction;
|
_finishAction = finishAction;
|
||||||
FinishCommand = new CustomCommand(Finish);
|
FinishCommand = new CustomCommand(Finish);
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ namespace WpfViewModelFirst
|
|||||||
{
|
{
|
||||||
public class ViewModelFactory : IViewModelFactory
|
public class ViewModelFactory : IViewModelFactory
|
||||||
{
|
{
|
||||||
public Part1.Part1ViewModel GetPart1ViewModel(Action finishAction)
|
public Part1.Part1ViewModel GetPart1ViewModel(Func<Task> finishAction)
|
||||||
{
|
{
|
||||||
return new(finishAction);
|
return new(finishAction);
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user