Restore DBFTPlugin Unit Tests (ConsensusService and Consensus Context)

.github/workflows/main.yml

@@ -90,6 +90,7 @@ jobs:
         dotnet test ./tests/Neo.Plugins.RpcServer.Tests --output ./bin/tests/Neo.Plugins.RpcServer.Tests
         dotnet test ./tests/Neo.Plugins.Storage.Tests --output ./bin/tests/Neo.Plugins.Storage.Tests
         dotnet test ./tests/Neo.Plugins.ApplicationLogs.Tests --output ./bin/tests/Neo.Plugins.ApplicationLogs.Tests
+        dotnet test ./tests/Neo.Plugins.DBFTPlugin.Tests --output ./bin/tests/Neo.Plugins.DBFTPlugin.Tests
 
     - name: Coveralls
       if: matrix.os == 'ubuntu-latest'
@@ -109,6 +110,7 @@ jobs:
           ${{ github.workspace }}/tests/Neo.Plugins.Storage.Tests/TestResults/coverage.info
           ${{ github.workspace }}/tests/Neo.Plugins.ApplicationLogs.Tests/TestResults/coverage.info
           ${{ github.workspace }}/tests/Neo.Extensions.Tests/TestResults/coverage.info
+          ${{ github.workspace }}/tests/Neo.Plugins.DBFTPlugin.Tests/TestResults/coverage.info
 
   PublishPackage:
     if: github.ref == 'refs/heads/master' && startsWith(github.repository, 'neo-project/')

neo.sln

@@ -1,4 +1,4 @@
-Microsoft Visual Studio Solution File, Format Version 12.00
+Microsoft Visual Studio Solution File, Format Version 12.00
 # Visual Studio Version 17
 VisualStudioVersion = 17.2.32516.85
 MinimumVisualStudioVersion = 10.0.40219.1
@@ -82,6 +82,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Neo.Plugins.ApplicationLogs
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Neo.Extensions.Tests", "tests\Neo.Extensions.Tests\Neo.Extensions.Tests.csproj", "{77FDEE2E-9381-4BFC-B9E6-741EDBD6B90F}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Neo.Plugins.DBFTPlugin.Tests", "tests\Neo.Plugins.DBFTPlugin.Tests\Neo.Plugins.DBFTPlugin.Tests.csproj", "{378132CA-0931-4ADD-A20F-D78AE991C8CD}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -228,6 +230,10 @@ Global
 		{77FDEE2E-9381-4BFC-B9E6-741EDBD6B90F}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{77FDEE2E-9381-4BFC-B9E6-741EDBD6B90F}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{77FDEE2E-9381-4BFC-B9E6-741EDBD6B90F}.Release|Any CPU.Build.0 = Release|Any CPU
+		{378132CA-0931-4ADD-A20F-D78AE991C8CD}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{378132CA-0931-4ADD-A20F-D78AE991C8CD}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{378132CA-0931-4ADD-A20F-D78AE991C8CD}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{378132CA-0931-4ADD-A20F-D78AE991C8CD}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -269,6 +275,7 @@ Global
 		{185ADAFC-BFC6-413D-BC2E-97F9FB0A8AF0} = {C2DC830A-327A-42A7-807D-295216D30DBB}
 		{8C866DC8-2E55-4399-9563-2F47FD4602EC} = {7F257712-D033-47FF-B439-9D4320D06599}
 		{77FDEE2E-9381-4BFC-B9E6-741EDBD6B90F} = {EDE05FA8-8E73-4924-BC63-DD117127EEE1}
+		{378132CA-0931-4ADD-A20F-D78AE991C8CD} = {7F257712-D033-47FF-B439-9D4320D06599}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {BCBA19D9-F868-4C6D-8061-A2B91E06E3EC}

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/Neo/NeoSystem.cs

@@ -145,6 +145,27 @@ public NeoSystem(ProtocolSettings settings, IStoreProvider storageProvider, stri
             Blockchain.Ask(new Blockchain.Initialize()).Wait();
         }
 
+
+        internal NeoSystem(ProtocolSettings settings, IStoreProvider storageProvider, IActorRef localNode, IActorRef blockchain, IActorRef taskManager, IActorRef txRouter)
+        {
+            Settings = settings;
+            GenesisBlock = CreateGenesisBlock(settings);
+            this.storageProvider = storageProvider;
+            store = storageProvider.GetStore(null);
+            MemPool = new MemoryPool(this);
+
+            /* Unmerged change from project 'Neo(net8.0)'
+            Before:
+                        Blockchain =blockchain;
+            After:
+                        Blockchain = blockchain;
+            */
+            Blockchain = blockchain;
+            LocalNode = localNode;
+            TaskManager = taskManager;
+            TxRouter = txRouter;
+        }
+
         /// <summary>
         /// Creates the genesis block for the NEO blockchain.
         /// </summary>

src/Neo/Persistence/MemoryStore.cs

@@ -22,7 +22,7 @@ namespace Neo.Persistence
     /// </summary>
     public class MemoryStore : IStore
     {
-        private readonly ConcurrentDictionary<byte[], byte[]> _innerData = new(ByteArrayEqualityComparer.Default);
+        internal readonly ConcurrentDictionary<byte[], byte[]> _innerData = new(ByteArrayEqualityComparer.Default);
 
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
         public void Delete(byte[] key)

src/Plugins/DBFTPlugin/Consensus/ConsensusService.cs

@@ -25,12 +25,12 @@
 
 namespace Neo.Plugins.DBFTPlugin.Consensus
 {
-    partial class ConsensusService : UntypedActor
+    public partial class ConsensusService : UntypedActor
     {
         public class Start { }
-        private class Timer { public uint Height; public byte ViewNumber; }
+        internal class Timer { public uint Height; public byte ViewNumber; }
 
-        private readonly ConsensusContext context;
+        internal readonly ConsensusContext context;
         private readonly IActorRef localNode;
         private readonly IActorRef taskManager;
         private readonly IActorRef blockchain;
@@ -39,6 +39,8 @@ private class Timer { public uint Height; public byte ViewNumber; }
         private uint block_received_index;
         private bool started = false;
 
+        internal bool IsStarted => started;
+
         /// <summary>
         /// This will record the information from last scheduled timer
         /// </summary>
@@ -81,6 +83,7 @@ private void OnPersistCompleted(Block block)
 
         private void InitializeConsensus(byte viewNumber)
         {
+            Console.WriteLine("InitializeConsensus...");
             context.Reset(viewNumber);
             if (viewNumber > 0)
                 Log($"View changed: view={viewNumber} primary={context.Validators[context.GetPrimaryIndex((byte)(viewNumber - 1u))]}", LogLevel.Warning);
@@ -114,6 +117,7 @@ private void InitializeConsensus(byte viewNumber)
 
         protected override void OnReceive(object message)
         {
+            Console.WriteLine("OnReceive some message");
             if (message is Start)
             {
                 if (started) return;
@@ -143,6 +147,7 @@ protected override void OnReceive(object message)
 
         private void OnStart()
         {
+            Console.WriteLine("OnStart - First Log ConsensusService");
             Log("OnStart");
             started = true;
             if (!dbftSettings.IgnoreRecoveryLogs && context.Load())

src/Plugins/DBFTPlugin/DBFTPlugin.csproj

@@ -17,4 +17,8 @@
     </None>
   </ItemGroup>
 
+  <ItemGroup>
+    <InternalsVisibleTo Include="Neo.Plugins.DBFTPlugin.Tests" />
+  </ItemGroup>
+
 </Project>

src/Plugins/DBFTPlugin/Settings.cs

@@ -15,21 +15,35 @@ namespace Neo.Plugins.DBFTPlugin
 {
     public class Settings : PluginSettings
     {
-        public string RecoveryLogs { get; }
-        public bool IgnoreRecoveryLogs { get; }
-        public bool AutoStart { get; }
-        public uint Network { get; }
-        public uint MaxBlockSize { get; }
-        public long MaxBlockSystemFee { get; }
+        public string RecoveryLogs { get; private set; }
+        public bool IgnoreRecoveryLogs { get; private set; }
+        public bool AutoStart { get; private set; }
+        public uint Network { get; private set; }
+        public uint MaxBlockSize { get; private set; }
+        public long MaxBlockSystemFee { get; private set; }
 
-        public Settings(IConfigurationSection section) : base(section)
+        // Modified constructor with default values
+        public Settings(IConfigurationSection section = null)
+            : base(section)
         {
-            RecoveryLogs = section.GetValue("RecoveryLogs", "ConsensusState");
-            IgnoreRecoveryLogs = section.GetValue("IgnoreRecoveryLogs", false);
-            AutoStart = section.GetValue("AutoStart", false);
-            Network = section.GetValue("Network", 5195086u);
-            MaxBlockSize = section.GetValue("MaxBlockSize", 262144u);
-            MaxBlockSystemFee = section.GetValue("MaxBlockSystemFee", 150000000000L);
+            // Set default values
+            RecoveryLogs = "ConsensusState";
+            IgnoreRecoveryLogs = false;
+            AutoStart = false;
+            Network = 5195086u;
+            MaxBlockSize = 262144u;
+            MaxBlockSystemFee = 150000000000L;
+
+            // Override defaults if section is provided
+            if (section != null)
+            {
+                RecoveryLogs = section.GetValue("RecoveryLogs", RecoveryLogs);
+                IgnoreRecoveryLogs = section.GetValue("IgnoreRecoveryLogs", IgnoreRecoveryLogs);
+                AutoStart = section.GetValue("AutoStart", AutoStart);
+                Network = section.GetValue("Network", Network);
+                MaxBlockSize = section.GetValue("MaxBlockSize", MaxBlockSize);
+                MaxBlockSystemFee = section.GetValue("MaxBlockSystemFee", MaxBlockSystemFee);
+            }
         }
     }
 }

tests/Neo.Plugins.DBFTPlugin.Tests/CustomAutoPilot.cs

@@ -0,0 +1,25 @@
+// Copyright (C) 2015-2024 The Neo Project.
+//
+// CustomAutoPilot.cs file belongs to the neo project and is free
+// software distributed under the MIT software license, see the
+// accompanying file LICENSE in the main directory of the
+// repository or http://www.opensource.org/licenses/mit-license.php
+// for more details.
+//
+// Redistribution and use in source and binary forms with or without
+// modifications are permitted.
+
+using Akka.Actor;
+using Akka.TestKit;
+using System;
+
+namespace Neo.Plugins.DBFTPlugin.Tests;
+
+internal class CustomAutoPilot(Action<IActorRef, object> action) : AutoPilot
+{
+    public override AutoPilot Run(IActorRef sender, object message)
+    {
+        action(sender, message);
+        return this;
+    }
+}

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

@@ -0,0 +1,26 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>net8.0</TargetFramework>
+    <RootNamespace>Neo.Plugins.DBFTPlugin.Tests</RootNamespace>
+    <AssemblyName>Neo.Plugins.DBFTPlugin.Tests</AssemblyName>
+    <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.10.0" />
+    <PackageReference Include="Moq" Version="4.20.70" />
+    <PackageReference Include="MSTest.TestAdapter" Version="3.5.0" />
+    <PackageReference Include="MSTest.TestFramework" Version="3.5.0" />
+    <PackageReference Include="Akka.TestKit" Version="1.5.26" />
+    <PackageReference Include="Akka.TestKit.Xunit2" Version="1.5.26" />
+    <PackageReference Include="NeoFS.API" Version="3.5.0" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\..\src\Neo\Neo.csproj" />
+    <ProjectReference Include="..\..\src\Plugins\DBFTPlugin\DBFTPlugin.csproj" />
+    <ProjectReference Include="..\Neo.UnitTests\Neo.UnitTests.csproj" />
+  </ItemGroup>
+
+</Project>

tests/Neo.Plugins.DBFTPlugin.Tests/TestBlockchain.cs

@@ -0,0 +1,49 @@
+// Copyright (C) 2015-2024 The Neo Project.
+//
+// TestBlockchain.cs file belongs to the neo project and is free
+// software distributed under the MIT software license, see the
+// accompanying file LICENSE in the main directory of the
+// repository or http://www.opensource.org/licenses/mit-license.php
+// for more details.
+//
+// Redistribution and use in source and binary forms with or without
+// modifications are permitted.
+
+using Akka.Actor;
+using Neo.Ledger;
+using Neo.Persistence;
+using System;
+
+namespace Neo.Plugins.DBFTPlugin.Tests
+{
+    public static class TestBlockchain
+    {
+        public static readonly NeoSystem TheNeoSystem;
+        public static readonly UInt160[] DefaultExtensibleWitnessWhiteList;
+        private static readonly MemoryStore Store = new();
+
+        internal class StoreProvider : IStoreProvider
+        {
+            public string Name => "TestProvider";
+
+            public IStore GetStore(string path) => Store;
+        }
+
+        static TestBlockchain()
+        {
+            Console.WriteLine("initialize NeoSystem");
+            TheNeoSystem = new NeoSystem(TestProtocolSettings.Default, new StoreProvider());
+        }
+
+        internal static void ResetStore()
+        {
+            Store.Reset();
+            TheNeoSystem.Blockchain.Ask(new Blockchain.Initialize()).Wait();
+        }
+
+        internal static DataCache GetTestSnapshot()
+        {
+            return TheNeoSystem.GetSnapshotCache().CloneCache();
+        }
+    }
+}

tests/Neo.Plugins.DBFTPlugin.Tests/TestMemoryStoreProvider.cs

@@ -0,0 +1,21 @@
+// Copyright (C) 2015-2024 The Neo Project.
+//
+// TestMemoryStoreProvider.cs file belongs to the neo project and is free
+// software distributed under the MIT software license, see the
+// accompanying file LICENSE in the main directory of the
+// repository or http://www.opensource.org/licenses/mit-license.php
+// for more details.
+//
+// Redistribution and use in source and binary forms with or without
+// modifications are permitted.
+
+using Neo.Persistence;
+
+namespace Neo.Plugins.DBFTPlugin.Tests;
+
+public class TestMemoryStoreProvider(MemoryStore memoryStore) : IStoreProvider
+{
+    public MemoryStore MemoryStore { get; init; } = memoryStore;
+    public string Name => nameof(MemoryStore);
+    public IStore GetStore(string path) => MemoryStore;
+}