From 1b48fe5f5e94bdfdef700956e45d478b5706f25e Mon Sep 17 00:00:00 2001
From: Kevin Laeufer
Date: Fri, 14 Aug 2020 16:00:31 -0700
Subject: tests: Decrease Dependency on Deprecated APIs (#1839)

* test: add LeanTransformSpec to replace the old SimpleTransformSpec

SimpleTransformSpec isn't simple anymore!

* AnnotationTests: remove deprecated Compiler code

* LeanTransformSpec: implicitly add right EmitCircuitAnnotation

* AsyncResetSpec: move to new lean spec

* CheckCombLoopsSpec: remove deprecated Compiler code

* ChirrtlMemSpec: remove deprecated compiler code

* CompilerTest: remove use of deprecated Compiler API---
 .../scala/firrtl/testutils/LeanTransformSpec.scala | 50 ++++++++++++++++++++++
 1 file changed, 50 insertions(+)
 create mode 100644 src/test/scala/firrtl/testutils/LeanTransformSpec.scala

(limited to 'src/test/scala/firrtl/testutils')

diff --git a/src/test/scala/firrtl/testutils/LeanTransformSpec.scala b/src/test/scala/firrtl/testutils/LeanTransformSpec.scala
new file mode 100644
index 00000000..c1f0943a
--- /dev/null
+++ b/src/test/scala/firrtl/testutils/LeanTransformSpec.scala
@@ -0,0 +1,50 @@
+package firrtl.testutils
+
+import firrtl.{AnnotationSeq, CircuitState, EmitCircuitAnnotation, ir}
+import firrtl.options.Dependency
+import firrtl.passes.RemoveEmpty
+import firrtl.stage.TransformManager.TransformDependency
+import logger.LazyLogging
+import org.scalatest.flatspec.AnyFlatSpec
+
+class VerilogTransformSpec extends LeanTransformSpec(Seq(Dependency[firrtl.VerilogEmitter]))
+class LowFirrtlTransformSpec extends LeanTransformSpec(Seq(Dependency[firrtl.LowFirrtlEmitter]))
+
+/** The new cool kid on the block, creates a custom compiler for your transform. */
+class LeanTransformSpec(protected val transforms: Seq[TransformDependency]) extends AnyFlatSpec with FirrtlMatchers with LazyLogging {
+  private val compiler = new firrtl.stage.transforms.Compiler(transforms)
+  private val emitterAnnos = LeanTransformSpec.deriveEmitCircuitAnnotations(transforms)
+
+  protected def compile(src: String): CircuitState = compile(src, Seq())
+  protected def compile(src: String, annos: AnnotationSeq): CircuitState = compile(firrtl.Parser.parse(src), annos)
+  protected def compile(c: ir.Circuit): CircuitState = compile(c, Seq())
+  protected def compile(c: ir.Circuit, annos: AnnotationSeq): CircuitState =
+    compiler.transform(CircuitState(c, emitterAnnos ++ annos))
+  protected def execute(input: String, check: String): CircuitState = execute(input, check ,Seq())
+  protected def execute(input: String, check: String, inAnnos: AnnotationSeq): CircuitState = {
+    val finalState = compiler.transform(CircuitState(parse(input), inAnnos))
+    val actual = RemoveEmpty.run(parse(finalState.getEmittedCircuit.value)).serialize
+    val expected = parse(check).serialize
+    logger.debug(actual)
+    logger.debug(expected)
+    actual should be (expected)
+    finalState
+  }
+}
+
+private object LeanTransformSpec {
+  private def deriveEmitCircuitAnnotations(transforms: Iterable[TransformDependency]): AnnotationSeq = {
+    val emitters = transforms.map(_.getObject()).collect{ case e: firrtl.Emitter => e }
+    emitters.map(e => EmitCircuitAnnotation(e.getClass)).toSeq
+  }
+}
+
+/** Use this if you just need to create a standard compiler and want to save some typing. */
+trait MakeCompiler {
+  protected def makeVerilogCompiler(transforms: Seq[TransformDependency] = Seq()) =
+    new firrtl.stage.transforms.Compiler(Seq(Dependency[firrtl.VerilogEmitter]) ++ transforms)
+  protected def makeMinimumVerilogCompiler(transforms: Seq[TransformDependency] = Seq()) =
+    new firrtl.stage.transforms.Compiler(Seq(Dependency[firrtl.MinimumVerilogEmitter]) ++ transforms)
+  protected def makeLowFirrtlCompiler(transforms: Seq[TransformDependency] = Seq()) =
+    new firrtl.stage.transforms.Compiler(Seq(Dependency[firrtl.LowFirrtlEmitter]) ++ transforms)
+}
\ No newline at end of file
-- 
cgit v1.2.3