ChiselUtestTester

abstract def tests: Tests

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def addDefaultTargetDir(defaultDir: String, annotationSeq: AnnotationSeq): AnnotationSeq

Will add a TargetDirAnnotation with defaultDir with "test_run_dir" path prefix to the annotations if there is not a TargetDirAnnotation already present

final def asInstanceOf[T0]: T0

val batchedFailures: ArrayBuffer[Exception]

def checkpoint(): Unit

If there are any failures, reports them and end the test now.

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def getExpectDetailedTrace(trace: Seq[StackTraceElement], inFile: String): String

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def testCircuit[T <: MultiIOModule](dutGen: ⇒ T, annotationSeq: AnnotationSeq = Seq.empty)(testFn: (T) ⇒ Unit)(implicit testPath: TestPath): Unit

Since utest.test collides with chisel3.tester.RawTester.test, it is renamed to testCircuit, Here is a example to constructs a unit test harness for the Chisel Module PlusOne generated as dutGen.

testCircuit(new PlusOne) { c =>
  // body of the unit test, c is a a reference
  c.io.input.poke(1.U)
  c.io.output.expect(2.U)
}

// WriteVcdAnnotation will ask backend export VCD file
testCircuit(new PlusOne, Seq(WriteVcdAnnotation)) { c =>
  // body of the unit test, c is a a reference
  c.io.input.poke(1.U)
  c.io.output.expect(2.U)
}

def testerExpect(expected: Any, actual: Any, signal: String, msg: Option[String]): Unit

Expect a specific value on a wire, calling testerFail if the expectation isn't met.

def testerFail(msg: String): Unit

Logs a tester failure at this point.

def toString(): String

val topFileName: Option[String]

def utestAfterAll(): Unit

def utestAfterEach(path: Seq[String]): Unit

def utestBeforeEach(path: Seq[String]): Unit

def utestFormatter: Formatter

def utestWrap(path: Seq[String], runBody: ⇒ Future[Any])(implicit ec: ExecutionContext): Future[Any]

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

macro def apply(expr: Unit): Tests