[**Part-1**] Added ApplicationLogs Unit Tests

.github/workflows/main.yml

@@ -87,6 +87,7 @@ jobs:
         dotnet test ./tests/Neo.Plugins.OracleService.Tests --output ./bin/tests/Neo.Plugins.OracleService.Tests
         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
 
     - name: Coveralls
       if: matrix.os == 'ubuntu-latest'
@@ -104,6 +105,7 @@ jobs:
           ${{ github.workspace }}/tests/Neo.Plugins.OracleService.Tests/TestResults/coverage.info
           ${{ github.workspace }}/tests/Neo.Plugins.RpcServer.Tests/TestResults/coverage.info
           ${{ github.workspace }}/tests/Neo.Plugins.Storage.Tests/TestResults/coverage.info
+          ${{ github.workspace }}/tests/Neo.Plugins.ApplicationLogs.Tests/TestResults/coverage.info
 
   PublishPackage:
     if: github.ref == 'refs/heads/master' && startsWith(github.repository, 'neo-project/')

neo.sln

@@ -78,6 +78,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "TokensTracker", "src\Plugin
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "RpcClient", "src\Plugins\RpcClient\RpcClient.csproj", "{185ADAFC-BFC6-413D-BC2E-97F9FB0A8AF0}"
 EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Neo.Plugins.ApplicationLogs.Tests", "tests\Neo.Plugins.ApplicationLogs.Tests\Neo.Plugins.ApplicationLogs.Tests.csproj", "{8C866DC8-2E55-4399-9563-2F47FD4602EC}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -216,6 +218,10 @@ Global
 		{185ADAFC-BFC6-413D-BC2E-97F9FB0A8AF0}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{185ADAFC-BFC6-413D-BC2E-97F9FB0A8AF0}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{185ADAFC-BFC6-413D-BC2E-97F9FB0A8AF0}.Release|Any CPU.Build.0 = Release|Any CPU
+		{8C866DC8-2E55-4399-9563-2F47FD4602EC}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{8C866DC8-2E55-4399-9563-2F47FD4602EC}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{8C866DC8-2E55-4399-9563-2F47FD4602EC}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{8C866DC8-2E55-4399-9563-2F47FD4602EC}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -255,6 +261,7 @@ Global
 		{FF76D8A4-356B-461A-8471-BC1B83E57BBC} = {C2DC830A-327A-42A7-807D-295216D30DBB}
 		{5E4947F3-05D3-4806-B0F3-30DAC71B5986} = {C2DC830A-327A-42A7-807D-295216D30DBB}
 		{185ADAFC-BFC6-413D-BC2E-97F9FB0A8AF0} = {C2DC830A-327A-42A7-807D-295216D30DBB}
+		{8C866DC8-2E55-4399-9563-2F47FD4602EC} = {7F257712-D033-47FF-B439-9D4320D06599}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {BCBA19D9-F868-4C6D-8061-A2B91E06E3EC}

src/Plugins/ApplicationLogs/ApplicationLogs.csproj

@@ -14,9 +14,14 @@
       <ExcludeAssets>runtime</ExcludeAssets>
     </ProjectReference>
   </ItemGroup>
+
   <ItemGroup>
     <None Update="ApplicationLogs.json">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>
   </ItemGroup>
+
+  <ItemGroup>
+    <InternalsVisibleTo Include="$(PackageId).Tests" />
+  </ItemGroup>
 </Project>

tests/Neo.Plugins.ApplicationLogs.Tests/Neo.Plugins.ApplicationLogs.Tests.csproj

@@ -0,0 +1,19 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>net8.0</TargetFramework>
+    <RootNamespace>Neo.Plugins.ApplicationsLogs.Tests</RootNamespace>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
+    <PackageReference Include="xunit" Version="2.5.3" />
+    <PackageReference Include="xunit.runner.visualstudio" Version="2.5.3" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\..\src\Plugins\ApplicationLogs\ApplicationLogs.csproj" />
+    <ProjectReference Include="..\..\src\Plugins\RocksDBStore\RocksDBStore.csproj" />
+  </ItemGroup>
+
+</Project>

tests/Neo.Plugins.ApplicationLogs.Tests/Setup/InsertTransactionEngineState.cs

@@ -0,0 +1,53 @@
+// Copyright (C) 2015-2024 The Neo Project.
+//
+// PutTestTransactionEngineState.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;
+using Neo.Plugins.ApplicationLogs.Store;
+using Neo.Plugins.ApplicationLogs.Store.States;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Reflection;
+using System.Text;
+using System.Threading.Tasks;
+using Xunit.Sdk;
+
+namespace Neo.Plugins.ApplicationsLogs.Tests.Setup
+{
+    [AttributeUsage(AttributeTargets.Method, AllowMultiple = true)]
+    public class InsertTransactionEngineState : BeforeAfterTestAttribute
+    {
+        private readonly ISnapshot _snapshot;
+        private readonly Guid _expectedGuid;
+        private readonly UInt256 _expectedBlockHash;
+
+        public InsertTransactionEngineState(
+            string logId,
+            string blockHash)
+        {
+            _expectedGuid = Guid.Parse(logId);
+            _expectedBlockHash = UInt256.Parse(blockHash);
+            _snapshot = TestStorage.Store.GetSnapshot();
+        }
+
+        public override void Before(MethodInfo methodUnderTest)
+        {
+            using var lss = new LogStorageStore(_snapshot);
+            lss.PutTransactionEngineState(_expectedBlockHash, TransactionEngineLogState.Create([_expectedGuid]));
+            _snapshot.Commit();
+        }
+
+        public override void After(MethodInfo methodUnderTest)
+        {
+            _snapshot.Dispose();
+        }
+    }
+}

tests/Neo.Plugins.ApplicationLogs.Tests/Setup/TestStorage.cs

@@ -0,0 +1,31 @@
+// Copyright (C) 2015-2024 The Neo Project.
+//
+// StorageFixture.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;
+using Neo.Plugins.ApplicationLogs.Store;
+using Neo.Plugins.Storage;
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using Xunit;
+
+namespace Neo.Plugins.ApplicationsLogs.Tests.Setup
+{
+    public class TestStorage
+    {
+        private static readonly string s_dirPath = Path.GetRandomFileName();
+        private static readonly RocksDBStore rocksDbStore = new RocksDBStore();
+        public static readonly IStore Store = rocksDbStore.GetStore(s_dirPath);
+    }
+}

tests/Neo.Plugins.ApplicationLogs.Tests/UT_LogStorageStore.cs

@@ -0,0 +1,81 @@
+// Copyright (C) 2015-2024 The Neo Project.
+//
+// UT_LogStorageStore.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;
+using Neo.Plugins.ApplicationLogs.Store;
+using Neo.Plugins.ApplicationLogs.Store.States;
+using Neo.Plugins.ApplicationsLogs.Tests.Setup;
+using Neo.SmartContract;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using Xunit;
+
+namespace Neo.Plugins.ApplicationsLogs.Tests
+{
+    public class UT_LogStorageStore
+    {
+        [Theory]
+        [InlineData(TriggerType.OnPersist, "0x0000000000000000000000000000000000000000000000000000000000000001")]
+        [InlineData(TriggerType.Application, "0x0000000000000000000000000000000000000000000000000000000000000002")]
+        [InlineData(TriggerType.PostPersist, "0x0000000000000000000000000000000000000000000000000000000000000003")]
+        public void Test_Put_Get_BlockState_Storage(TriggerType trigger, string blockHash)
+        {
+            var expectedGuid = Guid.NewGuid();
+            var expectedHash = UInt256.Parse(blockHash);
+
+            using (var snapshot = TestStorage.Store.GetSnapshot())
+            {
+                using (var lss = new LogStorageStore(snapshot))
+                {
+                    // Put Block States in Storage for each Trigger
+                    lss.PutBlockState(expectedHash, trigger, BlockLogState.Create([expectedGuid]));
+                    // Commit Data to "Store" Storage for Lookup
+                    snapshot.Commit();
+                }
+            }
+
+            // The Current way that ISnapshot Works we need to Create New Instance of LogStorageStore
+            using (var lss = new LogStorageStore(TestStorage.Store.GetSnapshot()))
+            {
+                // Get OnPersist Block State from Storage
+                lss.TryGetBlockState(expectedHash, trigger, out var actualState);
+
+                Assert.NotNull(actualState);
+                Assert.NotNull(actualState.NotifyLogIds);
+                Assert.Single(actualState.NotifyLogIds);
+                Assert.Equal(expectedGuid, actualState.NotifyLogIds[0]);
+            }
+        }
+
+        [Theory]
+        [InlineData("00000000-0000-0000-0000-000000000000", "0x0000000000000000000000000000000000000000000000000000000000000001")]
+        [InsertTransactionEngineState("00000000-0000-0000-0000-000000000000", "0x0000000000000000000000000000000000000000000000000000000000000001")]
+        public void Test_Put_Get_TransactionEngineState_Storage(string expectedLogId, string expectedHashString)
+        {
+            var expectedGuid = Guid.Parse(expectedLogId);
+            var expectedHash = UInt256.Parse(expectedHashString);
+
+            using (var lss = new LogStorageStore(TestStorage.Store.GetSnapshot()))
+            {
+                // Get OnPersist Block State from Storage
+                lss.TryGetTransactionEngineState(expectedHash, out var actualState);
+
+                Assert.NotNull(actualState);
+                Assert.NotNull(actualState.LogIds);
+                Assert.Single(actualState.LogIds);
+                Assert.Equal(expectedGuid, actualState.LogIds[0]);
+            }
+        }
+    }
+}