Speed test results should be displayed in user specified scale (#62)

Author: FrankRay78

README.md

@@ -91,6 +91,7 @@ USAGE:
 OPTIONS:
                             DEFAULT
     -h, --help                                     Prints help information.
+    -v, --version                                  Prints version information.
         --loop                                     Performs the speed test on continuous loop.
         --count                                    Stop speed testing after this many times.
         --delay                                    Time between multiple speed tests (HH:MM:SS)
@@ -105,6 +106,7 @@ OPTIONS:
         --downloadsize                             Stop the download test after this many megabytes (IEC MiB).
         --uploadsize                               Stop the upload test after this many megabytes (IEC MiB).
     -u, --unit              BitsPerSecond          The speed unit. <BitsPerSecond, BytesPerSecond>
+        --unit-scale        Auto                   The speed unit scale. <Auto, Base, Kilo, Mega, Giga, Tera, Peta>
         --unit-system       SI                     The speed unit system. <SI, IEC>
                                                    SI steps up in powers of 1000 (KB, MB, GB), common in networking,
                                                    while IEC uses powers of 1024 (KiB, MiB, GiB), standard in computing

USER_GUIDE.md

@@ -5,9 +5,9 @@ Run a simple speed test using the nearest available server:
 NetPace
 ```
 
-Produce minimal CSV output, suitable for scripting or parsing:  
+Produce CSV output with test results in megabits, suitable for parsing:  
 ```bash
-NetPace --csv
+NetPace --csv --unit-scale Mega
 ```
 
 Run download test only:  

src/NetPace.Console.Tests/Expectations/NetPaceConsoleTests.Should_Display_Help.verified.txt

@@ -30,6 +30,7 @@ OPTIONS:
         --downloadsize                             Stop the download test after this many megabytes (IEC MiB).                                                                                        
         --uploadsize                               Stop the upload test after this many megabytes (IEC MiB).                                                                                          
     -u, --unit              BitsPerSecond          The speed unit. <BitsPerSecond, BytesPerSecond>                                                                                                    
+        --unit-scale        Auto                   The speed unit scale. <Auto, Base, Kilo, Mega, Giga, Tera, Peta>                                                                                   
         --unit-system       SI                     The speed unit system. <SI, IEC>                                                                                                                   
                                                    SI steps up in powers of 1000 (KB, MB, GB), common in networking, while IEC uses powers of 1024 (KiB, MiB, GiB), standard in computing and storage.
         --verbosity         Normal                 The verbosity level. <Minimal, Normal, Debug>                                                                                                      

src/NetPace.Console.Tests/Expectations/NetPaceConsoleTests.Should_Perform_Speed_Test_CSV_Fixed_Scale_With_Fractional_Results.verified.txt

@@ -0,0 +1 @@
+

src/NetPace.Console.Tests/Expectations/NetPaceConsoleTests.Should_Perform_Speed_Test_Multiple_Times_With_Fixed_Scale.verified.txt

@@ -0,0 +1,3 @@
+Latency: 75 ms, Download: 0.25 Mbps, Upload: 0.5 Mbps
+Latency: 100 ms, Download: 1 Mbps, Upload: 3 Mbps
+Latency: 150 ms, Download: 2.75 Mbps, Upload: 1.33 Mbps

src/NetPace.Console.Tests/Expectations/NetPaceConsoleTests.Should_Perform_Speed_Test_With_CSV_Multiple_Times_With_Fixed_Scale.verified.txt

@@ -0,0 +1,4 @@
+Timestamp,Latency,Download,Upload
+1980-01-01 10:05:00,75 ms,0.25 Mbps,0.5 Mbps
+1980-01-01 10:05:05,100 ms,1 Mbps,3 Mbps
+1980-01-01 10:05:10,150 ms,2.75 Mbps,1.33 Mbps

src/NetPace.Console.Tests/Expectations/NetPaceConsoleTests.Should_Perform_Speed_Test_With_Fixed_Unit_Scale.verified.txt

@@ -0,0 +1,7 @@
+
+Test Sponsor 1
+http://test1.com
+
+Latency: 100 ms, Download: 0.01 Mbps, Upload: 0.02 Mbps
+
+Try 'NetPace --help' for more information.

src/NetPace.Console.Tests/NetPaceConsoleTests.cs

@@ -141,6 +141,24 @@ public async Task Should_Perform_Speed_Test()
         await Verify(result.Output);
     }
 
+    [Fact]
+    public async Task Should_Perform_Speed_Test_With_Fixed_Unit_Scale()
+    {
+        // Given
+        var registrar = new TypeRegistrar();
+        registrar.Register(typeof(ISpeedTestService), typeof(SpeedTestStub));
+        registrar.Register(typeof(IClock), typeof(ClockStub));
+        registrar.Register(typeof(IWaiter), typeof(NoDelayStub));
+        var app = GetCommandAppTester(registrar);
+
+        // When
+        var result = await app.RunAsync("--unit-scale", "Mega");
+
+        // Then
+        Assert.Equal(0, result.ExitCode);
+        await Verify(result.Output);
+    }
+
     [Fact]
     public async Task Should_Perform_Speed_Test_Continuously()
     {
@@ -203,6 +221,24 @@ public async Task Should_Perform_Speed_Test_Multiple_Times_With_Delay(int count,
         await Verify(result.Output).UseParameters(count, delay);
     }
 
+    [Fact]
+    public async Task Should_Perform_Speed_Test_Multiple_Times_With_Fixed_Scale()
+    {
+        // Given
+        var registrar = new TypeRegistrar();
+        registrar.Register(typeof(ISpeedTestService), typeof(VariableSpeedTester));
+        registrar.Register(typeof(IClock), typeof(IncrementingClockStub));
+        registrar.Register(typeof(IWaiter), typeof(NoDelayStub));
+        var app = GetCommandAppTester(registrar);
+
+        // When
+        var result = await app.RunAsync("--count", "3", "--unit-scale", "Mega", "--verbosity", "Minimal");
+
+        // Then
+        Assert.Equal(0, result.ExitCode);
+        await Verify(result.Output);
+    }
+
     [InlineData("Minimal")]
     [InlineData("Normal")]
     [InlineData("Debug")]
@@ -326,6 +362,24 @@ public async Task Should_Perform_Speed_Test_With_CSV_Multiple_Times_With_Delay(i
         await Verify(result.Output).UseParameters(count, delay);
     }
 
+    [Fact]
+    public async Task Should_Perform_Speed_Test_With_CSV_Multiple_Times_With_Fixed_Scale()
+    {
+        // Given
+        var registrar = new TypeRegistrar();
+        registrar.Register(typeof(ISpeedTestService), typeof(VariableSpeedTester));
+        registrar.Register(typeof(IClock), typeof(IncrementingClockStub));
+        registrar.Register(typeof(IWaiter), typeof(NoDelayStub));
+        var app = GetCommandAppTester(registrar);
+
+        // When
+        var result = await app.RunAsync("--csv", "--count", "3", "--unit-scale", "Mega", "--verbosity", "Minimal");
+
+        // Then
+        Assert.Equal(0, result.ExitCode);
+        await Verify(result.Output);
+    }
+
     [Fact]
     public async Task Should_Perform_Speed_Test_With_CSV_No_Download()
     {
@@ -665,4 +719,5 @@ public async Task Should_Display_Version(string version)
     }
 
     #endregion
+
 }

src/NetPace.Console.Tests/VerifyConfiguration.cs

@@ -1,4 +1,5 @@
 using System.Runtime.CompilerServices;
+using DiffEngine;
 
 namespace NetPace.Console.Tests;
 

src/NetPace.Console/Commands/SpeedTestCommand.cs

@@ -164,8 +164,8 @@ private async Task internalExecuteAsync(bool includeCSVHeader, SpeedTestCommandS
             {
                 settings.IncludeTimestamp ? clock.Now.ToString(settings.DateTimeFormat) : null,
                 $"{fastest.Latency} ms",
-                !settings.NoDownload ? downloadResult.GetSpeedString(settings.SpeedUnit, settings.SpeedUnitSystem) : null,
-                !settings.NoUpload ? uploadResult.GetSpeedString(settings.SpeedUnit, settings.SpeedUnitSystem) : null
+                !settings.NoDownload ? downloadResult.GetSpeedString(settings.SpeedUnit, settings.SpeedUnitSystem, settings.SpeedScale) : null,
+                !settings.NoUpload ? uploadResult.GetSpeedString(settings.SpeedUnit, settings.SpeedUnitSystem, settings.SpeedScale) : null
             }.Where(s => !string.IsNullOrEmpty(s))));
         }
         else
@@ -207,8 +207,8 @@ private async Task internalExecuteAsync(bool includeCSVHeader, SpeedTestCommandS
             {
                 settings.IncludeTimestamp ? clock.Now.ToString(settings.DateTimeFormat) : null,
                 $"Latency: {fastest.Latency} ms",
-                !settings.NoDownload ? $"Download: {downloadResult.GetSpeedString(settings.SpeedUnit, settings.SpeedUnitSystem)}" : null,
-                !settings.NoUpload ? $"Upload: {uploadResult.GetSpeedString(settings.SpeedUnit, settings.SpeedUnitSystem)}" : null
+                !settings.NoDownload ? $"Download: {downloadResult.GetSpeedString(settings.SpeedUnit, settings.SpeedUnitSystem, settings.SpeedScale)}" : null,
+                !settings.NoUpload ? $"Upload: {uploadResult.GetSpeedString(settings.SpeedUnit, settings.SpeedUnitSystem, settings.SpeedScale)}" : null
             }.Where(s => !string.IsNullOrEmpty(s))));