Skip to content

Commit

Permalink
Version 1.1.0 Release
Browse files Browse the repository at this point in the history
Version 1.1.0 Release
  • Loading branch information
Arkatufus committed Jan 7, 2022
2 parents c43455c + 5030d07 commit 62d6712
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 27 deletions.
43 changes: 22 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,39 @@
# Akka.MultiNode.TestAdapter

Visual Studio 2019 Test Explorer and .NET CLI Test runner for the Akka.NET MultiNode tests
Visual Studio 2019 Test Explorer, JetBrains Rider, and .NET CLI Test runner for the Akka.NET MultiNode tests

## Documentation
`Akka.MultiNode.TestAdapter` is a standalone .NET CLI and VSTest adapter for Akka.NET multi node testkit;
It allows you to run multinode tests directly inside Visual Studio Text Explorer window and run them
using the `dotnet test` .NET CLI command.
`Akka.MultiNode.TestAdapter` is a standalone test adapter for Akka.NET multi node testkit; it is based on the popular Xunit test framework to allow multinode tests to run directly inside popular C# IDE such as Microsoft Visual Studio and JetBrains Rider and run them using the `dotnet test` .NET CLI command.

To use the VSTest test adapter in your multinode spec projects, You will need to add these nuget packages:
To use the test adapter in your multinode spec projects, You will need to add these nuget packages:
- [Akka.MultiNode.TestAdapter](https://www.nuget.org/packages/Akka.MultiNode.TestAdapter)
- [Microsoft.NET.Test.Sdk](https://www.nuget.org/packages/Microsoft.NET.Test.Sdk/)

Documentation regarding the multinode specs themselves can be read in the Akka.NET documentation pages:
- [Using the MultiNode TestKit](https://getakka.net/articles/networking/multi-node-test-kit.html)
- [Multi-Node Testing Distributed Akka.NET Applications](https://getakka.net/articles/testing/multi-node-testing.html)

### VSTest .runsettings
This is the .runsettings XML sub-section `Akka.MultiNode.TestAdapter` can use:
```xml
<?xml version="1.0" encoding="utf-8"?>
<RunSettings>
<MultiNodeTestRunnerOptions>
<ListenAddress>127.0.0.1</ListenAddress>
<ListenPort>0</ListenPort>
<ClearOutputDirectory>false</ClearOutputDirectory>
<UseTeamCityFormatting>false</UseTeamCityFormatting>
</MultiNodeTestRunnerOptions>
</RunSettings>
### Json Settings

This test adapter follows the Xunit convention on loading test configuration via a json file. It will
check the directory where the test assembly is located for a `[Assembly Name].xunit.multinode.runner.json`
or a `xunit.multinode.runner.json` file.

```json
{
"outputDirectory": "TestResults",
"failedSpecsDirectory": "FAILED_SPECS_LOGS",
"listenAddress": "127.0.0.1",
"listenPort": 0,
"clearOutputDirectory": false
}
```

- **ListenAddress**: Determines the address that this multi-node test runner will use to listen for log messages from individual spec.
- **ListenPort**: Determines the port number that this multi-node test runner will use to listen for log messages from individual spec.
- **ClearOutputDirectory**: Clear the output directory before running the test session. If set to false, all test logs are appended to the out file.
- **UseTeamCityFormatting**: Use TeamCity formatting on the log outputs.
* **outputDirectory**: Determines output directory for all log output files.
* **failedSpecsDirectory**: Determines output directory for aggregated failed test logs.
* **listenAddress**: Determines the address that this multi-node test runner will use to listen for log messages from individual spec.
* **listenPort**: Determines the port number that this multi-node test runner will use to listen for log messages from individual spec.
* **ClearOutputDirectory**: Clear the output directory before running the test session. If set to false, all test logs are appended to the out file.

## Building this solution
To run the build script associated with this solution, execute the following:
Expand Down
8 changes: 6 additions & 2 deletions RELEASE_NOTES.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
#### 1.1.0-beta2 December 23 2019 ####
#### 1.1.0 January 6 2022 ####

Version 1.1.0 release.

#### 1.1.0-beta2 December 23 2021 ####
- [Add support for Xunit TestFrameworkAttribute attribute](https://github.com/akkadotnet/Akka.MultiNodeTestRunner/pull/116)

In this release we added `MultiNodeTestFramework` to simplify non-parallel test setup. This test
Expand All @@ -18,7 +22,7 @@ Note that you can also use this assembly level attribute to achieve more or less
[assembly: CollectionBehavior(DisableTestParallelization = true)]
```

#### 1.1.0-beta1 October 20 2019 ####
#### 1.1.0-beta1 October 20 2021 ####

- [Switch to pure Xunit implementation](https://github.com/akkadotnet/Akka.MultiNodeTestRunner/pull/105)

Expand Down
4 changes: 1 addition & 3 deletions src/Akka.MultiNode.TestAdapter/xunit.multinode.runner.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,5 @@
"failedSpecsDirectory": "FAILED_SPECS_LOGS",
"listenAddress": "127.0.0.1",
"listenPort": 0,
"reporter": "console",
"clearOutputDirectory": false,
"teamCityFormatting": false
"clearOutputDirectory": false
}
2 changes: 1 addition & 1 deletion src/common.props
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<NetCoreTestVersion>netcoreapp3.1</NetCoreTestVersion>
<NetTestVersion>net5.0</NetTestVersion>
<NetStandardLibVersion>netstandard2.0</NetStandardLibVersion>
<FluentAssertionsVersion>6.2.0</FluentAssertionsVersion>
<FluentAssertionsVersion>6.3.0</FluentAssertionsVersion>
<FsCheckVersion>2.9.0</FsCheckVersion>
<AkkaVersion>1.4.31</AkkaVersion>
<!--
Expand Down

0 comments on commit 62d6712

Please sign in to comment.