Out of process tests

.github/workflows/ci.yml

@@ -18,7 +18,7 @@ jobs:
  strategy:
  matrix:
  include:
- - os: windows-2019
+ - os: windows-latest
  name: Windows
  - os: ubuntu-20.04
  name: Linux

README.md

@@ -75,7 +75,7 @@ It's important to make sure that each endpoint configuration works as expected,
 
 ### Testing message routing
 
-[Message routing](https://docs.particular.net/nservicebus/messaging/routing) is part of the endpoint configuration and is what makes a choreography successful, the only way to test correctness of the message routing set up is to exercise the choreography so that endpoints will use the production routing configuration to exchange messages, and to subscribe to events. If the routing configuration is wrong or is missing pieces the choreography tests wil fail.
+[Message routing](https://docs.particular.net/nservicebus/messaging/routing) is part of the endpoint configuration and is what makes a choreography successful, the only way to test correctness of the message routing set up is to exercise the choreography so that endpoints will use the production routing configuration to exchange messages, and to subscribe to events. If the routing configuration is wrong or is missing pieces the choreography tests will fail.
 
 ### Testing saga message mappings
 
@@ -85,18 +85,18 @@ In theory, it's possible to assert on [saga message mappings](https://docs.parti
 
 Defining an NServiceBus integration test is a multi-step process, composed of:
 
-- Make sure endpoints configuration can be istantiated by tests
+- Make sure endpoints configuration can be instantiated by tests
 - Define endpoints used in each test; and if needed customize each endpoint configuration to adapt to the test environment
 - Define tests and completion criteria
 - Assert on tests results
 
-### Make sure endpoints configuration can be istantiated by tests
+### Make sure endpoints configuration can be instantiated by tests
 
 One of the goals of end-to-end testing a NServiceBus endpoint is to make sure that what gets tested is the real production code, not a copy of it crafted for the tests. The production endpoint configuration has to be used in tests. To make sure that the testing infrastructure can instantiate the endpoint configuration there are a couple of options, with many variations.
 
 #### Inherit from EndpointConfiguration
 
-It's possible to create a class that inherits from `EndpointConfiguration` and then use it in both the production endpoint and the tests. To make so that the testing infrastructure can automatically instantiate it, the class must have a parameterless constructor, like in the following snippet:
+It's possible to create a class that inherits from `EndpointConfiguration` and then use it in both the production endpoint and the tests. To make so that the testing infrastructure can automatically instantiate it, the class must have a parameter-less constructor, like in the following snippet:
 
 <!-- snippet: inherit-from-endpoint-configuration -->
 <a id='snippet-inherit-from-endpoint-configuration'></a>
@@ -109,11 +109,15 @@ public class MyServiceConfiguration : EndpointConfiguration
  this.SendFailedMessagesTo("error");
  this.EnableInstallers();
 
- this.UseTransport(new RabbitMQTransport(Topology.Conventional, "host=localhost"));
+ /*
+ * Any NServiceBus suppported transport can be used. Tests in this 
+ * repostory are using the LearningTransport for the setup simplicity
+ */
+ this.UseTransport(new LearningTransport());
  }
 }
 ```
-<sup><a href='/src/Snippets/ConfigurationSnippets.cs#L5-L17' title='Snippet source file'>snippet source</a> | <a href='#snippet-inherit-from-endpoint-configuration' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Snippets/ConfigurationSnippets.cs#L5-L21' title='Snippet source file'>snippet source</a> | <a href='#snippet-inherit-from-endpoint-configuration' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 Using the above approach can be problematic when configuration values need to be read from an external source, like for example a configuration file. If this is the case the same external configuration source, most of the times with different values, needs to be available in tests too.
@@ -127,19 +131,23 @@ In case configuration values need to be passed to the endpoint configuration the
 ```cs
 public static class MyServiceConfigurationBuilder
 {
- public static EndpointConfiguration Build(string endpointName, string rabbitMqConnectionString)
+ public static EndpointConfiguration Build(string endpointName)
  {
  var config = new EndpointConfiguration(endpointName);
  config.SendFailedMessagesTo("error");
  config.EnableInstallers();
 
- config.UseTransport(new RabbitMQTransport(Topology.Conventional, rabbitMqConnectionString));
+ /*
+ * Any NServiceBus suppported transport can be used. Tests in this 
+ * repostory are using the LearningTransport for the setup simplicity
+ */
+ config.UseTransport(new LearningTransport());
 
  return config;
  }
 }
 ```
-<sup><a href='/src/Snippets/ConfigurationSnippets.cs#L19-L33' title='Snippet source file'>snippet source</a> | <a href='#snippet-use-builder-class' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Snippets/ConfigurationSnippets.cs#L23-L41' title='Snippet source file'>snippet source</a> | <a href='#snippet-use-builder-class' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 ### Define endpoints used in each test
@@ -310,7 +318,7 @@ An end-to-end test execution can only be terminated by 3 events:
 - the test times out
 - there are unhandled exceptions
 
-Unhandled exceptions are a sort of problem from the integration testing infrastructure perspecive as most of the times they'll result in messages being retried and eventually ending up in the error queue. Based on this it's better to consider failed messages as part of the done condition:
+Unhandled exceptions are a sort of problem from the integration testing infrastructure perspective as most of the times they'll result in messages being retried and eventually ending up in the error queue. Based on this it's better to consider failed messages as part of the done condition:
 
 <!-- snippet: simple-done-condition -->
 <a id='snippet-simple-done-condition'></a>
@@ -323,7 +331,7 @@ Unhandled exceptions are a sort of problem from the integration testing infrastr
 <sup><a href='/src/Snippets/DoneSnippets.cs#L15-L20' title='Snippet source file'>snippet source</a> | <a href='#snippet-simple-done-condition' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
-Such a done condition has to be read as: "If there are one or more failed messages the test is done, proceed to evaulate the assertions". Obviously this is not enough. In the identified test case scenario the test is done when a saga is invoked (specifically is created, more on this later). A saga invokation can be expressed as a done condition in the following way:
+Such a done condition has to be read as: "If there are one or more failed messages the test is done, proceed to evaluate the assertions". Obviously this is not enough. In the identified test case scenario the test is done when a saga is invoked (specifically is created, more on this later). A saga invocation can be expressed as a done condition in the following way:
 
 <!-- snippet: complete-done-condition -->
 <a id='snippet-complete-done-condition'></a>
@@ -453,7 +461,7 @@ The above extension method is far from being complete and doesn't handle all the
 
 ## How to install
 
-Using a package manager add a nuget reference to [NServiceBus.IntegrationTesting](https://www.nuget.org/packages/NServiceBus.IntegrationTesting/).
+Using a package manager add a NuGet reference to [NServiceBus.IntegrationTesting](https://www.nuget.org/packages/NServiceBus.IntegrationTesting/).
 
 ## Background
 

src/MyMessages/Messages/ALonleyMessage.cs

@@ -0,0 +1,11 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace MyMessages.Messages
+{
+ public class ALonleyMessage
+ {
+ public Guid AnIdentifier { get; set; }
+ }
+}

src/MyOtherService.TestProxy/MyOtherService.TestProxy.csproj

@@ -0,0 +1,14 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+ <PropertyGroup>
+ <OutputType>Exe</OutputType>
+ <TargetFramework>net48</TargetFramework>
+ <LangVersion>latest</LangVersion>
+ </PropertyGroup>
+
+ <ItemGroup>
+ <ProjectReference Include="..\MyOtherService\MyOtherService.csproj" />
+ <ProjectReference Include="..\NServiceBus.IntegrationTesting.OutOfProcess.Nsb8\NServiceBus.IntegrationTesting.OutOfProcess.Nsb8.csproj" />
+ </ItemGroup>
+
+</Project>

src/MyOtherService.TestProxy/Program.cs

@@ -0,0 +1,15 @@
+using System;
+using Microsoft.Extensions.Hosting;
+using NServiceBus;
+using Serilog;
+
+namespace MyOtherService.TestProxy
+{
+ public class Program
+ {
+ public static void Main(string[] args)
+ {
+ MyOtherService.Program.CreateHostBuilder(args).Build().Run();
+ }
+ }
+}

src/MyOtherService/MyOtherService.csproj

@@ -2,14 +2,13 @@
 
  <PropertyGroup>
  <OutputType>Exe</OutputType>
- <TargetFrameworks>netcoreapp3.1;net48</TargetFrameworks>
+ <TargetFramework>net48</TargetFramework>
  <LangVersion>latest</LangVersion>
  </PropertyGroup>
 
  <ItemGroup>
- <PackageReference Include="NServiceBus" Version="8.0.0-alpha.1897" />
  <PackageReference Include="NServiceBus.Newtonsoft.Json" Version="3.0.0-alpha.155" />
- <PackageReference Include="NServiceBus.RabbitMQ" Version="7.0.0-alpha.124" />
+ <PackageReference Include="NServiceBus" Version="8.0.0-alpha.1902" />
  </ItemGroup>
 
  <ItemGroup>

src/MyOtherService/MyOtherServiceConfigurationBuilder.cs

@@ -14,10 +14,8 @@ public static EndpointConfiguration Build(string endpointName, string rabbitMqCo
  config.UsePersistence<LearningPersistence>();
  config.EnableInstallers();
 
- //TODO: renable when a compatible combination of alphas is available
- //var transport = new RabbitMQTransport(Topology.Conventional, rabbitMqConnectionString);
- //config.UseTransport(transport);
- config.UseTransport(new LearningTransport());
+ var transport = new LearningTransport();
+ config.UseTransport(transport);
 
  config.SendFailedMessagesTo("error");
 

src/MyService.TestProxy/MyService.TestProxy.csproj

@@ -0,0 +1,14 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+ <PropertyGroup>
+ <OutputType>Exe</OutputType>
+ <TargetFramework>netcoreapp3.1</TargetFramework>
+ <LangVersion>latest</LangVersion>
+ </PropertyGroup>
+
+ <ItemGroup>
+ <ProjectReference Include="..\MyService\MyService.csproj" />
+ <ProjectReference Include="..\NServiceBus.IntegrationTesting.OutOfProcess.Nsb8\NServiceBus.IntegrationTesting.OutOfProcess.Nsb8.csproj" />
+ </ItemGroup>
+
+</Project>

src/MyService.TestProxy/Program.cs

@@ -0,0 +1,16 @@
+using System;
+using System.Diagnostics;
+using Microsoft.Extensions.Hosting;
+using NServiceBus;
+using Serilog;
+
+namespace MyService.TestProxy
+{
+ public class Program
+ {
+ public static void Main(string[] args)
+ {
+ MyService.Program.CreateHostBuilder(args).Build().Run();
+ }
+ }
+}

src/MyService/ALonleyMessageHandler.cs

@@ -0,0 +1,14 @@
+using MyMessages.Messages;
+using NServiceBus;
+using System.Threading.Tasks;
+
+namespace MyService
+{
+ class ALonleyMessageHandler : IHandleMessages<ALonleyMessage>
+ {
+ public Task Handle(ALonleyMessage message, IMessageHandlerContext context)
+ {
+ return Task.CompletedTask;
+ }
+ }
+}

src/MyService/MyService.csproj

@@ -2,24 +2,22 @@
 
  <PropertyGroup>
  <OutputType>Exe</OutputType>
- <TargetFrameworks>netcoreapp3.1;net48</TargetFrameworks>
+ <TargetFramework>netcoreapp3.1</TargetFramework>
  <LangVersion>latest</LangVersion>
  </PropertyGroup>
 
  <ItemGroup>
- <PackageReference Include="NServiceBus" Version="8.0.0-alpha.1897" />
+ <PackageReference Include="NServiceBus" Version="8.0.0-alpha.1902" />
  <PackageReference Include="NServiceBus.Extensions.Hosting" Version="2.0.0-alpha.144" />
  <PackageReference Include="Microsoft.Extensions.Hosting" Version="3.1.19" />
  <PackageReference Include="NServiceBus.Newtonsoft.Json" Version="3.0.0-alpha.155" />
- <PackageReference Include="NServiceBus.RabbitMQ" Version="7.0.0-alpha.124" />
  <PackageReference Include="Serilog.Extensions.Hosting" Version="4.2.0" />
  <PackageReference Include="Serilog.Settings.Configuration" Version="3.3.0" />
  <PackageReference Include="Serilog.Sinks.Console" Version="4.0.1" />
  </ItemGroup>
 
  <ItemGroup>
  <ProjectReference Include="..\MyMessages\MyMessages.csproj" />
- <ProjectReference Include="..\NServiceBus.AssemblyScanner.Extensions\NServiceBus.AssemblyScanner.Extensions.csproj" />
  </ItemGroup>
 
 </Project>

src/MyService/MyServiceConfiguration.cs

@@ -9,17 +9,13 @@ public MyServiceConfiguration()
  : base("MyService")
  {
  var scanner = this.AssemblyScanner();
- scanner.IncludeOnly("MyService.dll", "MyMessages.dll");
 
  this.UseSerialization<NewtonsoftSerializer>();
  this.UsePersistence<LearningPersistence>();
  this.EnableInstallers();
 
- //TODO: renable when a compatible combination of alphas is available
- //var transport = new RabbitMQTransport(Topology.Conventional, "host=localhost;username=guest;password=guest");
- //var routing = this.UseTransport(transport);
-
- var routing = this.UseTransport(new LearningTransport());
+ var transport = new LearningTransport();
+ var routing = this.UseTransport(transport);
 
  routing.RouteToEndpoint(typeof(AMessage), "MyOtherService");
 

src/MyService/Program.cs

@@ -12,7 +12,7 @@ public static void Main(string[] args)
  CreateHostBuilder(args).Build().Run();
  }
 
- public static IHostBuilder CreateHostBuilder(string[] args, Action<EndpointConfiguration> configPreview = null)
+ public static IHostBuilder CreateHostBuilder(string[] args)
  {
  var builder = Host.CreateDefaultBuilder(args);
  builder.UseConsoleLifetime();
@@ -25,8 +25,6 @@ public static IHostBuilder CreateHostBuilder(string[] args, Action<EndpointConfi
  builder.UseNServiceBus(ctx =>
  {
  var config = new MyServiceConfiguration();
- configPreview?.Invoke(config);
-
  return config;
  });
 

src/MySystem.AcceptanceTests/MyOtherServiceTemplate.cs

@@ -1,4 +1,6 @@
-using MyOtherService;
+#if NET48_OR_GREATER
+
+using MyOtherService;
 using NServiceBus;
 using NServiceBus.AcceptanceTesting.Support;
 using NServiceBus.IntegrationTesting;
@@ -18,3 +20,5 @@ protected override Task<EndpointConfiguration> OnGetConfiguration(RunDescriptor
  }
  }
 }
+
+#endif