From afdb780aeca80c1fed94dd20fd22037490169472 Mon Sep 17 00:00:00 2001
From: Jim Lawson
Date: Wed, 20 Feb 2019 13:42:02 -0800
Subject: Attempt to deal with timing vagaries in
 UniquifySpec.quicklyrenamedeepbundles (#1000)

* Attempt to deal with timing vagaries in UniquifySpec.quicklyrenamedeepbundles
Switching to Scala 2.12.8 cause this test to start failing on OSX. Try earlier scheme to compare shallow vs deep to reduce brittleness.

* Address review concerns; update comment.
---
 src/test/scala/firrtlTests/UniquifySpec.scala | 37 +++++++++++++++------------
 1 file changed, 21 insertions(+), 16 deletions(-)

(limited to 'src')

diff --git a/src/test/scala/firrtlTests/UniquifySpec.scala b/src/test/scala/firrtlTests/UniquifySpec.scala
index 561f0a84..58290122 100644
--- a/src/test/scala/firrtlTests/UniquifySpec.scala
+++ b/src/test/scala/firrtlTests/UniquifySpec.scala
@@ -286,29 +286,34 @@ class UniquifySpec extends FirrtlFlatSpec {
   }
 
   it should "quickly rename deep bundles" in {
-    // We use a fixed time to determine if this test passed or failed.
+    val depth = 500
+    // We previously used a fixed time to determine if this test passed or failed.
     // This test would pass under normal conditions, but would fail during coverage tests.
-    // Since executions times vary significantly under coverage testing, we check a global
+    // Instead of using a fixed time, we run the test once (with a rename depth of 1), and record the time,
+    //  then run it again with a depth of 500 and verify that the difference is below a fixed threshold.
+    // Additionally, since executions times vary significantly under coverage testing, we check a global
     //  to see if timing measurements are accurate enough to enforce the timing checks.
-    val maxMs = 8000.0
+    val threshold = depth * 2.0
 
     def mkType(i: Int): String = {
       if(i == 0) "UInt<8>" else s"{x: ${mkType(i - 1)}}"
     }
-
-    val depth = 500
-
-    val input =
-      s"""circuit Test:
-         |  module Test :
-         |    input in: ${mkType(depth)}
-         |    output out: ${mkType(depth)}
-         |    out <= in
-         |""".stripMargin
-
-    val (renameMs, _) = Utils.time(compileToVerilog(input))
+    val (baseMs: Double, renameMs: Double) = {
+      for (depth <- List(1, depth)) yield {
+        val input = s"""circuit Test:
+                       |  module Test :
+                       |    input in: ${mkType(depth)}
+                       |    output out: ${mkType(depth)}
+                       |    out <= in
+                       |""".stripMargin
+        val (ms, _) = Utils.time(compileToVerilog(input))
+        ms
+      }
+    } match {
+      case List(base, rename) => (base, rename)
+    }
 
     if (TestOptions.accurateTiming)
-      renameMs shouldBe < (maxMs)
+      renameMs shouldBe < (baseMs * threshold)
   }
 }
-- 
cgit v1.2.3