Skip to content

Commit 029d2fa

Browse files
pomianowskipomianowski
committed
Add some tests
1 parent 149248d commit 029d2fa

6 files changed

+165
-12
lines changed

‎README.md

+16-10
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# 🚎 ReflectionEventing
22

33
[Created with ❤ in Poland by lepo.co](https://dev.lepo.co/)
4-
Unleash the power of decoupled design with eventing. ReflectionEventing empowers developers to create simple events between services using DI in WPF, WinForms, or CLI applications. By facilitating better Inversion of Control, ReflectionEventing helps reduce coupling, enhancing the modularity and flexibility of your applications.
4+
ReflectionEventing is a powerful tool for developers looking to create decoupled designs in WPF, WinForms, or CLI applications. By leveraging the power of Dependency Injection (DI) and eventing, ReflectionEventing promotes better Inversion of Control (IoC), reducing coupling and enhancing the modularity and flexibility of your applications.
55

66
[![GitHub license](https://img.shields.io/github/license/lepoco/reflectioneventing)](https://github.com/lepoco/reflectioneventing/blob/master/LICENSE) [![Nuget](https://img.shields.io/nuget/v/ReflectionEventing)](https://www.nuget.org/packages/ReflectionEventing/) [![Nuget](https://img.shields.io/nuget/dt/ReflectionEventing?label=nuget)](https://www.nuget.org/packages/ReflectionEventing/) [![Sponsors](https://img.shields.io/github/sponsors/lepoco)](https://github.com/sponsors/lepoco)
77

88
## 👀 What does this repo contain?
99

10-
The repository contains NuGet package source code, which uses C# reflection to register services that can be used to listen for local events.
10+
This repository houses the source code for the ReflectionEventing NuGet package. The package utilizes C# reflection to register services that can listen for and respond to local events.
1111

1212
## Gettings started
1313

@@ -28,25 +28,29 @@ dotnet add package ReflectionEventing.DependencyInjection
2828
NuGet\Install-Package ReflectionEventing.DependencyInjection
2929
```
3030

31-
### Usage
31+
### 🛠️ How to Use ReflectionEventing
3232

33-
#### Register consumers and bus
33+
#### 1. Register Consumers and the Event Bus
34+
35+
In this step, we register our ViewModel as a singleton and add it as a consumer to the event bus. This allows the ViewModel to listen for events published on the bus.
3436

3537
```csharp
3638
IHost host = Host.CreateDefaultBuilder()
3739
.ConfigureServices((context, services) =>
3840
{
39-
_ = services.AddSingleton<MainWindowViewModel>();
40-
_ = services.AddEventBus(e =>
41+
services.AddSingleton<MainWindowViewModel>();
42+
services.AddEventBus(e =>
4143
{
42-
_ = e.AddConsumer<MainWindowViewModel>();
44+
e.AddConsumer<MainWindowViewModel>();
4345
});
4446
}
4547
)
4648
.Build();
4749
```
4850

49-
#### Publish your event
51+
#### 2. Publish Events
52+
53+
Here, we create a background service that publishes an event on the event bus. This event could be anything - in this case, we're publishing a `BackgroundTicked` event.
5054

5155
```csharp
5256
public class MyBackgroundService(IEventBus eventBus)
@@ -58,7 +62,9 @@ public class MyBackgroundService(IEventBus eventBus)
5862
}
5963
```
6064

61-
#### Now you can listen for the event
65+
#### 3. Listen for Events
66+
67+
Finally, we implement the `IConsumer<T>` interface in our ViewModel. This allows the ViewModel to consume `BackgroundTicked` events. When a `BackgroundTicked` event is published, the `ConsumeAsync` method is called, and we update the `CurrentTick` property.
6268

6369
```csharp
6470
public partial class MainWindowViewModel : ObservableObject, IConsumer<BackgroundTicked>
@@ -77,7 +83,7 @@ public partial class MainWindowViewModel : ObservableObject, IConsumer<Backgroun
7783

7884
## Compilation
7985

80-
Use Visual Studio 2022 and invoke the .sln.
86+
To build the project, use Visual Studio 2022 and open the .sln file.
8187

8288
Visual Studio
8389
**ReflectionEventing** is an Open Source project. You are entitled to download and use the freely available Visual Studio Community Edition to build, run or develop for ReflectionEventing. As per the Visual Studio Community Edition license, this applies regardless of whether you are an individual or a corporate user.

‎ReflectionEventing.sln

+13-2
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,13 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
1717
README.md = README.md
1818
EndProjectSection
1919
EndProject
20-
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ReflectionEventing.Autofac", "src\ReflectionEventing.Autofac\ReflectionEventing.Autofac.csproj", "{6023E50F-2B4D-4315-B85D-9E8A12746045}"
20+
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "ReflectionEventing.Autofac", "src\ReflectionEventing.Autofac\ReflectionEventing.Autofac.csproj", "{6023E50F-2B4D-4315-B85D-9E8A12746045}"
2121
EndProject
22-
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ReflectionEventing.DependencyInjection", "src\ReflectionEventing.DependencyInjection\ReflectionEventing.DependencyInjection.csproj", "{09F0D6A2-3791-4173-A612-98E6EA92FCC4}"
22+
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "ReflectionEventing.DependencyInjection", "src\ReflectionEventing.DependencyInjection\ReflectionEventing.DependencyInjection.csproj", "{09F0D6A2-3791-4173-A612-98E6EA92FCC4}"
23+
EndProject
24+
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Tests", "Tests", "{7A58AE12-65AA-4E1B-B5DB-CBD2732D1AE7}"
25+
EndProject
26+
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ReflectionEventing.UnitTests", "tests\ReflectionEventing.UnitTests\ReflectionEventing.UnitTests.csproj", "{7F506A5A-1F70-49CB-B371-428DFA573451}"
2327
EndProject
2428
Global
2529
GlobalSection(SolutionConfigurationPlatforms) = preSolution
@@ -43,10 +47,17 @@ Global
4347
{09F0D6A2-3791-4173-A612-98E6EA92FCC4}.Debug|Any CPU.Build.0 = Debug|Any CPU
4448
{09F0D6A2-3791-4173-A612-98E6EA92FCC4}.Release|Any CPU.ActiveCfg = Release|Any CPU
4549
{09F0D6A2-3791-4173-A612-98E6EA92FCC4}.Release|Any CPU.Build.0 = Release|Any CPU
50+
{7F506A5A-1F70-49CB-B371-428DFA573451}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
51+
{7F506A5A-1F70-49CB-B371-428DFA573451}.Debug|Any CPU.Build.0 = Debug|Any CPU
52+
{7F506A5A-1F70-49CB-B371-428DFA573451}.Release|Any CPU.ActiveCfg = Release|Any CPU
53+
{7F506A5A-1F70-49CB-B371-428DFA573451}.Release|Any CPU.Build.0 = Release|Any CPU
4654
EndGlobalSection
4755
GlobalSection(SolutionProperties) = preSolution
4856
HideSolutionNode = FALSE
4957
EndGlobalSection
58+
GlobalSection(NestedProjects) = preSolution
59+
{7F506A5A-1F70-49CB-B371-428DFA573451} = {7A58AE12-65AA-4E1B-B5DB-CBD2732D1AE7}
60+
EndGlobalSection
5061
GlobalSection(ExtensibilityGlobals) = postSolution
5162
SolutionGuid = {B017BA78-67A5-4D0F-92A3-671B0D8A2911}
5263
EndGlobalSection

‎tests/ReflectionEventing.UnitTests/EventBusBuilderTests.cs

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
// This Source Code Form is subject to the terms of the MIT License.
2+
// If a copy of the MIT was not distributed with this file, You can obtain one at https://opensource.org/licenses/MIT.
3+
// Copyright (C) Leszek Pomianowski and ReflectionEventing Contributors.
4+
// All Rights Reserved.
5+
6+
using FluentAssertions;
7+
8+
namespace ReflectionEventing.UnitTests;
9+
10+
public sealed class EventBusBuilderTests
11+
{
12+
private readonly EventBusBuilder _eventBusBuilder = new EventBusBuilder();
13+
14+
[Fact]
15+
public void AddConsumer_ShouldAddConsumerToDictionary()
16+
{
17+
Type consumerType = typeof(MySampleConsumer);
18+
19+
_eventBusBuilder.AddConsumer(consumerType);
20+
21+
IDictionary<Type, IEnumerable<Type>> consumers = _eventBusBuilder.GetConsumers();
22+
_ = consumers.Should().ContainKey(consumerType);
23+
}
24+
25+
[Fact]
26+
public void AddConsumer_ShouldAddEventTypeToConsumerInDictionary()
27+
{
28+
Type consumerType = typeof(MySampleConsumer);
29+
30+
_eventBusBuilder.AddConsumer(consumerType);
31+
32+
IDictionary<Type, IEnumerable<Type>> consumers = _eventBusBuilder.GetConsumers();
33+
_ = consumers[consumerType].Should().Contain(typeof(TestEvent));
34+
}
35+
36+
public sealed record TestEvent;
37+
38+
public sealed record MySampleConsumer : IConsumer<TestEvent>
39+
{
40+
public Task ConsumeAsync(TestEvent payload, CancellationToken cancellationToken)
41+
{
42+
return Task.CompletedTask;
43+
}
44+
}
45+
}

‎tests/ReflectionEventing.UnitTests/EventBusTests.cs

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
// This Source Code Form is subject to the terms of the MIT License.
2+
// If a copy of the MIT was not distributed with this file, You can obtain one at https://opensource.org/licenses/MIT.
3+
// Copyright (C) Leszek Pomianowski and ReflectionEventing Contributors.
4+
// All Rights Reserved.
5+
6+
namespace ReflectionEventing.UnitTests;
7+
8+
public sealed class EventBusTests
9+
{
10+
private readonly IConsumerProvider _consumerProvider;
11+
private readonly IConsumerTypesProvider _consumerTypesProvider;
12+
private readonly EventBus _eventBus;
13+
14+
public EventBusTests()
15+
{
16+
_consumerProvider = Substitute.For<IConsumerProvider>();
17+
_consumerTypesProvider = Substitute.For<IConsumerTypesProvider>();
18+
_eventBus = new EventBus(_consumerProvider, _consumerTypesProvider);
19+
}
20+
21+
[Fact]
22+
public async Task PublishAsync_ShouldCallConsumeAsyncOnAllConsumers()
23+
{
24+
TestEvent testEvent = new();
25+
Type consumerType = typeof(IConsumer<TestEvent>);
26+
IConsumer<TestEvent> consumer = Substitute.For<IConsumer<TestEvent>>();
27+
28+
_ = _consumerTypesProvider.GetConsumerTypes<TestEvent>().Returns([consumerType]);
29+
_ = _consumerProvider.GetConsumerTypes(consumerType).Returns([consumer]);
30+
31+
await _eventBus.PublishAsync(testEvent, CancellationToken.None);
32+
33+
await consumer.Received().ConsumeAsync(testEvent, Arg.Any<CancellationToken>());
34+
}
35+
36+
[Fact]
37+
public async Task Publish_ShouldCallPublishAsync()
38+
{
39+
TestEvent testEvent = new();
40+
Type consumerType = typeof(IConsumer<TestEvent>);
41+
IConsumer<TestEvent> consumer = Substitute.For<IConsumer<TestEvent>>();
42+
43+
_ = _consumerTypesProvider.GetConsumerTypes<TestEvent>().Returns([consumerType]);
44+
_ = _consumerProvider.GetConsumerTypes(consumerType).Returns([consumer]);
45+
46+
_eventBus.Publish(testEvent);
47+
48+
await consumer.Received().ConsumeAsync(testEvent, Arg.Any<CancellationToken>());
49+
}
50+
51+
public sealed record TestEvent;
52+
}

‎tests/ReflectionEventing.UnitTests/GlobalUsings.cs

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
// This Source Code Form is subject to the terms of the MIT License.
2+
// If a copy of the MIT was not distributed with this file, You can obtain one at https://opensource.org/licenses/MIT.
3+
// Copyright (C) Leszek Pomianowski and ReflectionEventing Contributors.
4+
// All Rights Reserved.
5+
6+
global using NSubstitute;
7+
global using System;
8+
global using System.Collections.Generic;
9+
global using System.Threading;
10+
global using System.Threading.Tasks;
11+
global using Xunit;

‎tests/ReflectionEventing.UnitTests/ReflectionEventing.UnitTests.csproj

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
<Project Sdk="Microsoft.NET.Sdk">
2+
3+
<PropertyGroup>
4+
<TargetFramework>net8.0</TargetFramework>
5+
<IsPackable>false</IsPackable>
6+
<IsTestProject>true</IsTestProject>
7+
</PropertyGroup>
8+
9+
<ItemGroup>
10+
<PackageReference Include="FluentAssertions"/>
11+
<PackageReference Include="NSubstitute"/>
12+
<PackageReference Include="Microsoft.NET.Test.Sdk"/>
13+
<PackageReference Include="xunit" />
14+
<PackageReference Include="xunit.runner.visualstudio">
15+
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
16+
<PrivateAssets>all</PrivateAssets>
17+
</PackageReference>
18+
<PackageReference Include="coverlet.collector">
19+
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
20+
<PrivateAssets>all</PrivateAssets>
21+
</PackageReference>
22+
</ItemGroup>
23+
24+
<ItemGroup>
25+
<ProjectReference Include="..\..\src\ReflectionEventing\ReflectionEventing.csproj" />
26+
</ItemGroup>
27+
28+
</Project>

0 commit comments

Comments
 (0)