Favouring variables instead of magic numbers in tests

Author: LeeCampbell

src/HdrHistogram.UnitTests/ConcurrentHistogramTestBase.cs

@@ -10,7 +10,7 @@ public abstract class ConcurrentHistogramTestBase : HistogramTestBase
         [Test]
         public void Can_support_multiple_concurrent_recorders()
         {
-            var target = Create(1, long.MaxValue - 1, 3);
+            var target = Create(DefautltLowestDiscernibleValue, DefaultHighestTrackableValue, DefaultSignificantFigures);
             const int loopcount = 10 * 1000 * 1000;
             var concurrency = Environment.ProcessorCount;
             var expected = loopcount * concurrency;

src/HdrHistogram.UnitTests/HdrHistogram.UnitTests.csproj

@@ -50,10 +50,12 @@
   </ItemGroup>
   <ItemGroup>
     <Compile Include="ConcurrentHistogramTestBase.cs" />
+    <Compile Include="HistogramEncodingTestBase.cs" />
     <Compile Include="IntConcurrentHistogramTests.cs" />
+    <Compile Include="IntHistogramEncodingTests.cs" />
     <Compile Include="LongConcurrentHistogramTests.cs" />
     <Compile Include="HistogramAssert.cs" />
-    <Compile Include="HistogramEncodingTest.cs" />
+    <Compile Include="LongHistogramEncodingTests.cs" />
     <Compile Include="HistogramIterationValueComparer.cs" />
     <Compile Include="Persistence\LongConcurrentHistogramLogReaderWriterTests.cs" />
     <Compile Include="Persistence\HistogramLogExtensions.cs" />
@@ -75,6 +77,7 @@
     <Compile Include="Recording\RecorderTestWithLongConcurrentHistogram.cs" />
     <Compile Include="Recording\RecorderTestWithLongHistogram.cs" />
     <Compile Include="Recording\RecorderTestWithLShortHistogram.cs" />
+    <Compile Include="ShortHistogramEncodingTests.cs" />
     <Compile Include="ShortHistogramTests.cs" />
     <Compile Include="TimeStampTests.cs" />
   </ItemGroup>

src/HdrHistogram.UnitTests/HgrmPercentileDistrubutionOutputTests.cs

@@ -27,7 +27,6 @@ public void PercentileDistrubution_hgrm_output_is_in_correct_format(
             histogram.OutputPercentileDistribution(writer, percentileTicksPerHalfDistance, scaling);
             var actual = writer.ToString();
 
-            
             Assert.AreEqual(expected, actual);
         }
 
@@ -68,7 +67,7 @@ private string GetEmbeddedFileText(string filename)
             }
         }
 
-        private static void LoadHistogram(HistogramBase histogram)
+        private static void LoadHistogram(IRecorder histogram)
         {
             for (int i = 0; i < 10000; i += 1000)
             {

…ogram.UnitTests/HistogramEncodingTest.cs …m.UnitTests/HistogramEncodingTestBase.cssrc/HdrHistogram.UnitTests/HistogramEncodingTest.cs renamed to src/HdrHistogram.UnitTests/HistogramEncodingTestBase.cs src/HdrHistogram.UnitTests/HistogramEncodingTest.cs renamed to src/HdrHistogram.UnitTests/HistogramEncodingTestBase.cs

@@ -1,100 +1,86 @@
-/*
- * Written by Matt Warren, and released to the public domain,
- * as explained at
- * http://creativecommons.org/publicdomain/zero/1.0/
- *
- * This is a .NET port of the original Java version, which was written by
- * Gil Tene as described in
- * https://github.com/HdrHistogram/HdrHistogram
- */
-
-using HdrHistogram.Encoding;
+using HdrHistogram.Encoding;
 using HdrHistogram.Utilities;
 using NUnit.Framework;
 
 namespace HdrHistogram.UnitTests
 {
-    [TestFixture]
-    public sealed class LongHistogramEncodingTests
+    public abstract class HistogramEncodingTestBase
     {
-        private static readonly HistogramEncoderV2 EncoderV2 = new Encoding.HistogramEncoderV2();
-        private const long HighestTrackableValue = 3600L * 1000 * 1000; // e.g. for 1 hr in usec units
+        protected const long DefautltLowestDiscernibleValue = 1;
+        protected const long DefaultHighestTrackableValue = 7716549600;//TimeStamp.Hours(1); // e.g. for 1 hr in system clock ticks (StopWatch.Frequency)
+        protected const int DefaultSignificantFigures = 3;
 
-        
+        private static readonly HistogramEncoderV2 EncoderV2 = new Encoding.HistogramEncoderV2();
 
         [Test]
         public void Given_a_populated_Histogram_When_encoded_and_decoded_Then_data_is_preserved()
         {
-            var source = Create(HighestTrackableValue, 3);
+            var source = Create(DefaultHighestTrackableValue, DefaultSignificantFigures);
             Load(source);
             var result = EncodeDecode(source);
-            HistogramAssert.AreEqual(source, result);
+            HistogramAssert.AreValueEqual(source, result);
         }
 
         [Test]
         public void Given_a_populated_Histogram_When_encoded_and_decoded_with_compression_Then_data_is_preserved()
         {
-            var source = Create(HighestTrackableValue, 3);
+            var source = Create(DefaultHighestTrackableValue, DefaultSignificantFigures);
             Load(source);
             var result = CompressedEncodeDecode(source);
-            HistogramAssert.AreEqual(source, result);
+            HistogramAssert.AreValueEqual(source, result);
         }
 
         [Test]
         public void Given_a_Histogram_populated_with_full_range_of_values_When_encoded_and_decoded_Then_data_is_preserved()
         {
-            var source = Create(HighestTrackableValue, 3);
+            var source = Create(DefaultHighestTrackableValue, DefaultSignificantFigures);
             LoadFullRange(source);
             var result = EncodeDecode(source);
-            HistogramAssert.AreEqual(source, result);
+            HistogramAssert.AreValueEqual(source, result);
         }
 
         [Test]
         public void Given_a_Histogram_populated_with_full_range_of_values_When_encoded_and_decoded_with_compression_Then_data_is_preserved()
         {
-            var source = Create(HighestTrackableValue, 3);
+            var source = Create(DefaultHighestTrackableValue, DefaultSignificantFigures);
             LoadFullRange(source);
             var result = CompressedEncodeDecode(source);
-            HistogramAssert.AreEqual(source, result);
+            HistogramAssert.AreValueEqual(source, result);
         }
 
-        private LongHistogram Create(long highestTrackableValue, int numberOfSignificantDigits)
-        {
-            return new LongHistogram(highestTrackableValue, numberOfSignificantDigits);
-        }
+        protected abstract HistogramBase Create(long highestTrackableValue, int numberOfSignificantDigits);
 
-        private static LongHistogram EncodeDecode(LongHistogram source)
+        private static HistogramBase EncodeDecode(HistogramBase source)
         {
             var targetBuffer = ByteBuffer.Allocate(source.GetNeededByteBufferCapacity());
             source.Encode(targetBuffer, EncoderV2);
             targetBuffer.Position = 0;
-            return (LongHistogram)HistogramEncoding.DecodeFromByteBuffer(targetBuffer, 0);
+            return HistogramEncoding.DecodeFromByteBuffer(targetBuffer, 0);
         }
 
-        private static LongHistogram CompressedEncodeDecode(LongHistogram source)
+        private static HistogramBase CompressedEncodeDecode(HistogramBase source)
         {
             var targetBuffer = ByteBuffer.Allocate(source.GetNeededByteBufferCapacity());
             source.EncodeIntoCompressedByteBuffer(targetBuffer);
             targetBuffer.Position = 0;
-            return (LongHistogram)HistogramEncoding.DecodeFromCompressedByteBuffer(targetBuffer, 0);
+            return HistogramEncoding.DecodeFromCompressedByteBuffer(targetBuffer, 0);
         }
 
-        private static void Load(LongHistogram source)
+        private static void Load(IRecorder source)
         {
             for (long i = 0L; i < 10000L; i++)
             {
                 source.RecordValue(1000L * i);
             }
         }
 
-        private static void LoadFullRange(LongHistogram source)
+        protected virtual void LoadFullRange(IRecorder source)
         {
-            for (long i = 0L; i < HighestTrackableValue; i += 100L)
+            for (long i = 0L; i < DefaultHighestTrackableValue; i += 100L)
             {
                 source.RecordValue(i);
             }
-            source.RecordValue(HighestTrackableValue);
+            source.RecordValue(DefaultHighestTrackableValue);
         }
-
     }
-}
+}