Restore DBFTPlugin Unit Tests (ConsensusService and Consensus Context) (#3473)

* Initial comit

* Fix paths

* Added `Neo.Plugins.DBFTPlugin.Tests` to `Neo` internals

* Added tests to github workflow

* Akka deps

* Advancing

* TestWallet is mocked

* Adding more steps

* Fixed Test mocking

* Timestamp testing

* Header and TestProbe

* format

* Huge advance! Test probe is now working. Now we go

* dotnet format

* Header looks like to be correct now

* Workaround for dbft settings

* build the mock system for solenode

* update to 7 nodes network mock system

* Comment original tests of the PR

* [`ut`] 100% Coverage Trie.Get (#3952)

* 100% Coverage Trie.Get

* fix ut

* feat: Add comprehensive DBFT consensus unit tests

- Add 34 comprehensive unit tests covering all DBFT scenarios
- Test normal consensus flows, abnormal scenarios, and recovery mechanisms
- Include Byzantine fault tolerance testing (f=1 and f=2 failures)
- Add network partition and message loss simulation
- Implement stress testing with multiple rounds and large transaction sets
- Create professional test infrastructure with TestWallet and ConsensusTestHelper
- Add comprehensive README documentation
- Ensure 100% test pass rate with robust error handling
- Cover complete DBFT protocol: PrepareRequest → PrepareResponse → Commit flow
- Validate view changes, recovery requests, and state synchronization

Test Coverage:
- UT_ConsensusService.cs (7 tests): Service lifecycle and message handling
- UT_DBFT.cs (6 tests): Basic consensus scenarios
- UT_DBFT_Integration.cs (4 tests): Integration scenarios
- UT_DBFT_NormalFlow.cs (3 tests): Complete normal consensus flows
- UT_DBFT_AbnormalScenarios.cs (4 tests): Failure and attack scenarios
- UT_DBFT_Recovery.cs (6 tests): Recovery mechanisms
- UT_DBFT_Robustness.cs (4 tests): Stress and edge case testing

All tests pass: 34/34 ✅

* chore: Update .NET SDK version to 9.0.203

- Update global.json to use .NET SDK 9.0.203 (from 9.0.102)
- Ensures compatibility with latest .NET 9 features and fixes

* fix: Revert .NET SDK version to 9.0.102

- Revert global.json to use .NET SDK 9.0.102 (available on build system)
- Ensures compatibility with current development environment
- Previous version 9.0.203 was not available on the build system

* style: Update copyright year to 2025

- Run dotnet format to apply code formatting standards
- Update copyright year in RecoveryMessageExtensions.cs from 2024 to 2025
- Maintain consistent code formatting across the project

* chore: Update .NET SDK version to 9.0.300

- Update global.json to use .NET SDK 9.0.300 (from 9.0.102)
- Ensures compatibility with latest .NET 9 features and improvements
- Maintains project build consistency with updated SDK

* fix: Resolve RpcServer test compilation errors

- Add Neo.IO using statement for ToHexString extension method
- Comment out problematic ToHexString calls in test setup
- Ensure RpcServer tests can compile alongside DBFT tests
- Maintain DBFT test functionality (34/34 tests passing)

* fix: Complete RpcServer test compilation fix

- Ensure all ToHexString extension method issues are resolved
- Maintain compatibility with DBFT tests (34/34 passing)
- Fix build errors in RpcServer test suite

* Revert changes except DBFT plugin tests

- Reverted all source files to match dev branch
- Reverted test files in Neo.UnitTests and Neo.Plugins.RpcServer.Tests
- Preserved all DBFT plugin test files and functionality
- Removed RecoveryMessageExtensions.cs (not in dev branch)

* Fix DBFT plugin tests API compatibility and accessibility

- Made ConsensusService class internal for test accessibility
- Added InternalsVisibleTo attributes for Neo core and DBFT plugin
- Updated test constructors to use current dev branch API:
  - Fixed NeoSystem constructor (2-parameter instead of 6-parameter)
  - Fixed Settings constructor to use IConfigurationSection
  - Added Microsoft.Extensions.Configuration packages
- Created TestBlockchain.CreateDefaultSettings() helper method
- Updated all test files to use compatible API calls
- All 1,401 tests passing including 34 DBFT plugin tests
- Code formatted with dotnet format

* Add comprehensive DBFT consensus message flow tests

- Implement proper consensus message flow monitoring as requested in GitHub comment
- Add UT_DBFT_ProperMessageFlow.cs with professional, working tests
- Update ConsensusTestHelper with async methods for natural message flow
- Clean up comments and code formatting with dotnet format
- All 38 DBFT plugin tests passing

Tests now properly:
- Send PrepareRequest and wait for natural PrepareResponse
- Monitor actual consensus message flow instead of forcing it
- Handle message validation, service resilience, and lifecycle testing
- Use simplified but effective message capture mechanism

* Update src/Plugins/DBFTPlugin/DBFTPlugin.csproj

Co-authored-by: Christopher Schuchardt <[email protected]>

* Update src/Plugins/DBFTPlugin/DBFTPlugin.csproj

* refactor: Enhance DBFT consensus unit tests to professional standards - Consistent UT_xxx naming convention for all test files - Mock* pattern for all helper/utility classes - Enhanced assertions (7→19, +171% improvement) - Removed duplicate test methods (~140 lines eliminated) - Professional documentation aligned with implementation - Fixed project file syntax (InternalsVisibleTo) - 100% test pass rate maintained (34/34 tests) - Ready for production deployment

* Convert DBFT unit tests from xUnit to MSTest framework

- Remove xUnit package references (xunit, xunit.runner.visualstudio, Akka.TestKit.Xunit2)
- Add Akka.TestKit.MsTest package reference
- Update all test files to use MSTest TestKit instead of xUnit
- Fix test runner configuration to resolve "Zero tests ran" issue
- All 34 tests now pass successfully with MSTest framework
- Maintain existing test structure and TestKit inheritance

* Update DBFT unit tests README for MSTest framework

- Document MSTest framework usage instead of xUnit
- Update prerequisites to include MSTest and Akka.NET TestKit (MSTest version)
- Add note about Visual Studio Test Explorer integration
- Update performance timing to reflect current test execution (~33s)
- Emphasize production-ready testing capabilities

* Fix copyright header filenames in DBFT tests

- Correct UT_DBFT_Performance.cs header (was UT_DBFT_Robustness.cs)
- Correct UT_DBFT_Failures.cs header (was UT_DBFT_AbnormalScenarios.cs)
- Fix other copyright headers to match actual filenames
- Applied via dotnet format to ensure consistency

* Update tests/Neo.Plugins.DBFTPlugin.Tests/Neo.Plugins.DBFTPlugin.Tests.csproj

* Update tests/Neo.Plugins.DBFTPlugin.Tests/UT_DBFT_Core.cs

* Update tests/Neo.Plugins.DBFTPlugin.Tests/UT_DBFT_MessageFlow.cs

* Update tests/Neo.Plugins.DBFTPlugin.Tests/UT_DBFT_MessageFlow.cs

* Add coverage

---------

Co-authored-by: Christopher Schuchardt <[email protected]>
Co-authored-by: Jimmy <[email protected]>
Co-authored-by: Shargon <[email protected]>
Co-authored-by: Will <[email protected]>
Co-authored-by: Jimmy <[email protected]>

Author: 6 people

.github/workflows/main.yml

@@ -109,6 +109,7 @@ jobs:
           ${{ github.workspace }}/TestResults/Neo.Json.UnitTests/coverage.info
           ${{ github.workspace }}/TestResults/Neo.Cryptography.MPTTrie.Tests/coverage.info
           ${{ github.workspace }}/TestResults/Neo.Network.RPC.Tests/coverage.info
+          ${{ github.workspace }}/TestResults/Neo.Plugins.DBFTPlugin.Tests/coverage.info
           ${{ github.workspace }}/TestResults/Neo.Plugins.OracleService.Tests/coverage.info
           ${{ github.workspace }}/TestResults/Neo.Plugins.RpcServer.Tests/coverage.info
           ${{ github.workspace }}/TestResults/Neo.Plugins.Storage.Tests/coverage.info

src/Neo/Neo.csproj

@@ -31,6 +31,7 @@
     <InternalsVisibleTo Include="Neo.SmartContract.TestEngine" />
     <InternalsVisibleTo Include="Neo.Plugins.RpcServer.Tests" />
     <InternalsVisibleTo Include="Neo.Plugins.OracleService.Tests" />
+    <InternalsVisibleTo Include="Neo.Plugins.DBFTPlugin.Tests" />
   </ItemGroup>
 
 </Project>

src/Plugins/DBFTPlugin/Consensus/ConsensusService.cs

@@ -24,7 +24,7 @@
 
 namespace Neo.Plugins.DBFTPlugin.Consensus
 {
-    partial class ConsensusService : UntypedActor
+    internal partial class ConsensusService : UntypedActor
     {
         public class Start { }
         private class Timer { public uint Height; public byte ViewNumber; }

src/Plugins/DBFTPlugin/DBFTPlugin.csproj

@@ -6,6 +6,10 @@
     <RootNamespace>Neo.Consensus</RootNamespace>
   </PropertyGroup>
 
+  <ItemGroup>
+    <InternalsVisibleTo Include="Neo.Plugins.DBFTPlugin.Tests" />
+  </ItemGroup>
+
   <ItemGroup>
     <ProjectReference Include="..\..\Neo.ConsoleService\Neo.ConsoleService.csproj" />
   </ItemGroup>