Feature/skipped progress (#7927)

Author: asdacap

src/Nethermind/Nethermind.Core.Test/MeasuredProgressTests.cs src/Nethermind/Nethermind.Core.Test/ProgressLoggerTests.cs

@@ -2,63 +2,64 @@
 // SPDX-License-Identifier: LGPL-3.0-only
 
 using System;
+using Nethermind.Logging;
+using NSubstitute;
 using NUnit.Framework;
 
 namespace Nethermind.Core.Test;
 
-public class MeasuredProgressTests
+public class ProgressLoggerTests
 {
     [Test]
     public void Current_per_second_uninitialized()
     {
-        MeasuredProgress measuredProgress = new();
-        Assert.That(measuredProgress.CurrentPerSecond, Is.EqualTo(decimal.Zero));
+        ProgressLogger progressLogger = CreateProgress();
+        Assert.That(progressLogger.CurrentPerSecond, Is.EqualTo(decimal.Zero));
     }
 
     [Test]
     public void Total_per_second_uninitialized()
     {
-        MeasuredProgress measuredProgress = new();
-        Assert.That(measuredProgress.TotalPerSecond, Is.EqualTo(decimal.Zero));
+        ProgressLogger progressLogger = CreateProgress();
+        Assert.That(progressLogger.TotalPerSecond, Is.EqualTo(decimal.Zero));
     }
 
     [Test]
     public void Current_value_uninitialized()
     {
-        MeasuredProgress measuredProgress = new();
-        Assert.That(measuredProgress.CurrentValue, Is.EqualTo(0L));
+        ProgressLogger progressLogger = CreateProgress();
+        Assert.That(progressLogger.CurrentValue, Is.EqualTo(0L));
     }
 
     [Test]
     public void Update_0L()
     {
-        MeasuredProgress measuredProgress = new();
-        measuredProgress.Update(0L);
-        Assert.That(measuredProgress.CurrentValue, Is.EqualTo(0L));
+        ProgressLogger progressLogger = CreateProgress();
+        progressLogger.Update(0L);
+        Assert.That(progressLogger.CurrentValue, Is.EqualTo(0L));
     }
 
     [Test]
     public void Update_0L_total_per_second()
     {
-        MeasuredProgress measuredProgress = new();
-        measuredProgress.Update(0L);
-        Assert.That(measuredProgress.TotalPerSecond, Is.EqualTo(0L));
+        ProgressLogger progressLogger = CreateProgress();
+        progressLogger.Update(0L);
+        Assert.That(progressLogger.TotalPerSecond, Is.EqualTo(0L));
     }
 
     [Test]
     public void Update_0L_current_per_second()
     {
-        MeasuredProgress measuredProgress = new();
-        measuredProgress.Update(0L);
-        Assert.That(measuredProgress.CurrentPerSecond, Is.EqualTo(0L));
+        ProgressLogger progressLogger = CreateProgress();
+        progressLogger.Update(0L);
+        Assert.That(progressLogger.CurrentPerSecond, Is.EqualTo(0L));
     }
 
     [Test]
     [Retry(3)]
     public void Update_twice_total_per_second()
     {
-        ManualTimestamper manualTimestamper = new();
-        MeasuredProgress measuredProgress = new(manualTimestamper);
+        (ProgressLogger measuredProgress, ManualTimestamper manualTimestamper) = CreateProgressWithManualTimestamper();
         measuredProgress.Update(0L);
         measuredProgress.SetMeasuringPoint();
         manualTimestamper.Add(TimeSpan.FromMilliseconds(100));
@@ -71,8 +72,7 @@ public void Update_twice_total_per_second()
     [Retry(3)]
     public void Update_twice_current_per_second()
     {
-        ManualTimestamper manualTimestamper = new();
-        MeasuredProgress measuredProgress = new(manualTimestamper);
+        (ProgressLogger measuredProgress, ManualTimestamper manualTimestamper) = CreateProgressWithManualTimestamper();
         measuredProgress.Update(0L);
         measuredProgress.SetMeasuringPoint();
         manualTimestamper.Add(TimeSpan.FromMilliseconds(100));
@@ -84,8 +84,7 @@ public void Update_twice_current_per_second()
     [Test]
     public void Current_starting_from_non_zero()
     {
-        ManualTimestamper manualTimestamper = new();
-        MeasuredProgress measuredProgress = new(manualTimestamper);
+        (ProgressLogger measuredProgress, ManualTimestamper manualTimestamper) = CreateProgressWithManualTimestamper();
         measuredProgress.Update(10L);
         measuredProgress.SetMeasuringPoint();
         manualTimestamper.Add(TimeSpan.FromMilliseconds(100));
@@ -96,8 +95,7 @@ public void Current_starting_from_non_zero()
     [Test]
     public void Update_thrice_result_per_second()
     {
-        ManualTimestamper manualTimestamper = new();
-        MeasuredProgress measuredProgress = new(manualTimestamper);
+        (ProgressLogger measuredProgress, ManualTimestamper manualTimestamper) = CreateProgressWithManualTimestamper();
         measuredProgress.Update(0L);
         measuredProgress.SetMeasuringPoint();
         manualTimestamper.Add(TimeSpan.FromMilliseconds(100));
@@ -114,8 +112,7 @@ public void Update_thrice_result_per_second()
     [Test]
     public void After_ending_does_not_update_total_or_current()
     {
-        ManualTimestamper manualTimestamper = new();
-        MeasuredProgress measuredProgress = new(manualTimestamper);
+        (ProgressLogger measuredProgress, ManualTimestamper manualTimestamper) = CreateProgressWithManualTimestamper();
         measuredProgress.Update(0L);
         measuredProgress.SetMeasuringPoint();
         manualTimestamper.Add(TimeSpan.FromMilliseconds(100));
@@ -138,15 +135,52 @@ public void After_ending_does_not_update_total_or_current()
     [Test]
     public void Has_ended_returns_true_when_ended()
     {
-        MeasuredProgress measuredProgress = new();
-        measuredProgress.MarkEnd();
-        Assert.That(measuredProgress.HasEnded, Is.True);
+        ProgressLogger progressLogger = CreateProgress();
+        progressLogger.MarkEnd();
+        Assert.That(progressLogger.HasEnded, Is.True);
     }
 
     [Test]
     public void Has_ended_returns_false_when_ended()
     {
-        MeasuredProgress measuredProgress = new();
-        Assert.That(measuredProgress.HasEnded, Is.False);
+        ProgressLogger progressLogger = CreateProgress();
+        Assert.That(progressLogger.HasEnded, Is.False);
     }
+
+    [Test]
+    public void Print_Progress()
+    {
+        ManualTimestamper manualTimestamper = new();
+        ILogManager logManager = Substitute.For<ILogManager>();
+        InterfaceLogger iLogger = Substitute.For<InterfaceLogger>();
+        iLogger.IsInfo.Returns(true);
+        ILogger logger = new(iLogger);
+        logManager.GetClassLogger(Arg.Any<string>()).Returns(logger);
+
+        ProgressLogger measuredProgress = new("Progress", logManager, manualTimestamper);
+
+        measuredProgress.Reset(0L, 100);
+        measuredProgress.SetMeasuringPoint();
+        measuredProgress.IncrementSkipped(10);
+        measuredProgress.CurrentQueued = 99;
+        manualTimestamper.Add(TimeSpan.FromMilliseconds(100));
+        measuredProgress.Update(1L);
+
+        measuredProgress.LogProgress();
+
+        iLogger.Received(1).Info("Progress              1 /        100 (  0.99 %) [⡆                                    ] queue       99 | skipped      90 Blk/s | current      10 Blk/s");
+    }
+
+    private ProgressLogger CreateProgress()
+    {
+        return new("", LimboLogs.Instance);
+    }
+
+    private (ProgressLogger, ManualTimestamper) CreateProgressWithManualTimestamper()
+    {
+        ManualTimestamper manualTimestamper = new();
+        ProgressLogger progressLogger = new("", LimboLogs.Instance, manualTimestamper);
+        return (progressLogger, manualTimestamper);
+    }
+
 }