Trait

chiseltest

ChiselScalatestTester

Related Doc: package chiseltest

Permalink

trait ChiselScalatestTester extends Assertions with TestSuiteMixin with TestEnvInterface

Self Type
ChiselScalatestTester with TestSuite
Linear Supertypes
TestEnvInterface, TestSuiteMixin, SuiteMixin, Assertions, TripleEquals, TripleEqualsSupport, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ChiselScalatestTester
  2. TestEnvInterface
  3. TestSuiteMixin
  4. SuiteMixin
  5. Assertions
  6. TripleEquals
  7. TripleEqualsSupport
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. class AssertionsHelper extends AnyRef

    Permalink
    Definition Classes
    Assertions
  2. class CheckingEqualizer[L] extends AnyRef

    Permalink
    Definition Classes
    TripleEqualsSupport
  3. class Equalizer[L] extends AnyRef

    Permalink
    Definition Classes
    TripleEqualsSupport
  4. class TestBuilder[T <: MultiIOModule] extends AnyRef

    Permalink

Abstract Value Members

  1. abstract def expectedTestCount(filter: Filter): Int

    Permalink
    Definition Classes
    SuiteMixin
  2. abstract def nestedSuites: IndexedSeq[Suite]

    Permalink
    Definition Classes
    SuiteMixin
  3. abstract def rerunner: Option[String]

    Permalink
    Definition Classes
    SuiteMixin
  4. abstract def run(testName: Option[String], args: Args): Status

    Permalink
    Definition Classes
    SuiteMixin
  5. abstract def runNestedSuites(args: Args): Status

    Permalink
    Attributes
    protected
    Definition Classes
    SuiteMixin
  6. abstract def runTest(testName: String, args: Args): Status

    Permalink
    Attributes
    protected
    Definition Classes
    SuiteMixin
  7. abstract def runTests(testName: Option[String], args: Args): Status

    Permalink
    Attributes
    protected
    Definition Classes
    SuiteMixin
  8. abstract val styleName: String

    Permalink
    Definition Classes
    SuiteMixin
  9. abstract def suiteId: String

    Permalink
    Definition Classes
    SuiteMixin
  10. abstract def suiteName: String

    Permalink
    Definition Classes
    SuiteMixin
  11. abstract def tags: Map[String, Set[String]]

    Permalink
    Definition Classes
    SuiteMixin
  12. abstract def testDataFor(testName: String, theConfigMap: ConfigMap): TestData

    Permalink
    Definition Classes
    SuiteMixin
  13. abstract def testNames: Set[String]

    Permalink
    Definition Classes
    SuiteMixin

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. def !==[T](right: Spread[T]): TripleEqualsInvocationOnSpread[T]

    Permalink
    Definition Classes
    TripleEqualsSupport
  3. def !==(right: Null): TripleEqualsInvocation[Null]

    Permalink
    Definition Classes
    TripleEqualsSupport
  4. def !==[T](right: T): TripleEqualsInvocation[T]

    Permalink
    Definition Classes
    TripleEqualsSupport
  5. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  6. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  7. def ===[T](right: Spread[T]): TripleEqualsInvocationOnSpread[T]

    Permalink
    Definition Classes
    TripleEqualsSupport
  8. def ===(right: Null): TripleEqualsInvocation[Null]

    Permalink
    Definition Classes
    TripleEqualsSupport
  9. def ===[T](right: T): TripleEqualsInvocation[T]

    Permalink
    Definition Classes
    TripleEqualsSupport
  10. def addDefaultTargetDir(defaultDir: String, annotationSeq: AnnotationSeq): AnnotationSeq

    Permalink

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

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

    defaultDir

    a default directory

    annotationSeq

    annotations to add it to, unless one is already there

    Definition Classes
    TestEnvInterface
  11. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  12. macro def assert(condition: Boolean, clue: Any)(implicit prettifier: Prettifier, pos: Position): Assertion

    Permalink
    Definition Classes
    Assertions
  13. macro def assert(condition: Boolean)(implicit prettifier: Prettifier, pos: Position): Assertion

    Permalink
    Definition Classes
    Assertions
  14. macro def assertCompiles(code: String)(implicit pos: Position): Assertion

    Permalink
    Definition Classes
    Assertions
  15. macro def assertDoesNotCompile(code: String)(implicit pos: Position): Assertion

    Permalink
    Definition Classes
    Assertions
  16. def assertResult(expected: Any)(actual: Any)(implicit prettifier: Prettifier, pos: Position): Assertion

    Permalink
    Definition Classes
    Assertions
  17. def assertResult(expected: Any, clue: Any)(actual: Any)(implicit prettifier: Prettifier, pos: Position): Assertion

    Permalink
    Definition Classes
    Assertions
  18. def assertThrows[T <: AnyRef](f: ⇒ Any)(implicit classTag: ClassTag[T], pos: Position): Assertion

    Permalink
    Definition Classes
    Assertions
  19. macro def assertTypeError(code: String)(implicit pos: Position): Assertion

    Permalink
    Definition Classes
    Assertions
  20. val assertionsHelper: (ChiselScalatestTester.this)#AssertionsHelper

    Permalink
    Definition Classes
    Assertions
  21. macro def assume(condition: Boolean, clue: Any)(implicit prettifier: Prettifier, pos: Position): Assertion

    Permalink
    Definition Classes
    Assertions
  22. macro def assume(condition: Boolean)(implicit prettifier: Prettifier, pos: Position): Assertion

    Permalink
    Definition Classes
    Assertions
  23. val batchedFailures: ArrayBuffer[Exception]

    Permalink
    Attributes
    protected
    Definition Classes
    TestEnvInterface
  24. def cancel(cause: Throwable)(implicit pos: Position): Nothing

    Permalink
    Definition Classes
    Assertions
  25. def cancel(message: String, cause: Throwable)(implicit pos: Position): Nothing

    Permalink
    Definition Classes
    Assertions
  26. def cancel(message: String)(implicit pos: Position): Nothing

    Permalink
    Definition Classes
    Assertions
  27. def cancel()(implicit pos: Position): Nothing

    Permalink
    Definition Classes
    Assertions
  28. def checkpoint(): Unit

    Permalink

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

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

    Definition Classes
    TestEnvInterface
  29. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. def conversionCheckedConstraint[A, B](implicit equivalenceOfA: Equivalence[A], cnv: (B) ⇒ A): CanEqual[A, B]

    Permalink
    Definition Classes
    TripleEquals → TripleEqualsSupport
  31. def convertEquivalenceToAToBConstraint[A, B](equivalenceOfB: Equivalence[B])(implicit ev: <:<[A, B]): CanEqual[A, B]

    Permalink
    Definition Classes
    TripleEquals → TripleEqualsSupport
  32. def convertEquivalenceToAToBConversionConstraint[A, B](equivalenceOfB: Equivalence[B])(implicit ev: (A) ⇒ B): CanEqual[A, B]

    Permalink
    Definition Classes
    TripleEquals → TripleEqualsSupport
  33. def convertEquivalenceToBToAConstraint[A, B](equivalenceOfA: Equivalence[A])(implicit ev: <:<[B, A]): CanEqual[A, B]

    Permalink
    Definition Classes
    TripleEquals → TripleEqualsSupport
  34. def convertEquivalenceToBToAConversionConstraint[A, B](equivalenceOfA: Equivalence[A])(implicit ev: (B) ⇒ A): CanEqual[A, B]

    Permalink
    Definition Classes
    TripleEquals → TripleEqualsSupport
  35. def convertToCheckingEqualizer[T](left: T): (ChiselScalatestTester.this)#CheckingEqualizer[T]

    Permalink
    Definition Classes
    TripleEquals → TripleEqualsSupport
  36. implicit def convertToEqualizer[T](left: T): (ChiselScalatestTester.this)#Equalizer[T]

    Permalink
    Definition Classes
    TripleEquals → TripleEqualsSupport
  37. def defaultEquality[A]: Equality[A]

    Permalink
    Definition Classes
    TripleEqualsSupport
  38. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  39. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  40. def fail(cause: Throwable)(implicit pos: Position): Nothing

    Permalink
    Definition Classes
    Assertions
  41. def fail(message: String, cause: Throwable)(implicit pos: Position): Nothing

    Permalink
    Definition Classes
    Assertions
  42. def fail(message: String)(implicit pos: Position): Nothing

    Permalink
    Definition Classes
    Assertions
  43. def fail()(implicit pos: Position): Nothing

    Permalink
    Definition Classes
    Assertions
  44. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  45. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  46. def getExpectDetailedTrace(trace: Seq[StackTraceElement], inFile: String): String

    Permalink
    Attributes
    protected
    Definition Classes
    TestEnvInterface
  47. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  48. def intercept[T <: AnyRef](f: ⇒ Any)(implicit classTag: ClassTag[T], pos: Position): T

    Permalink
    Definition Classes
    Assertions
  49. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  50. def lowPriorityConversionCheckedConstraint[A, B](implicit equivalenceOfB: Equivalence[B], cnv: (A) ⇒ B): CanEqual[A, B]

    Permalink
    Definition Classes
    TripleEquals → TripleEqualsSupport
  51. def lowPriorityTypeCheckedConstraint[A, B](implicit equivalenceOfB: Equivalence[B], ev: <:<[A, B]): CanEqual[A, B]

    Permalink
    Definition Classes
    TripleEquals → TripleEqualsSupport
  52. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  53. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  54. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  55. def pending: Assertion with PendingStatement

    Permalink
    Definition Classes
    Assertions
  56. def pendingUntilFixed(f: ⇒ Unit)(implicit pos: Position): Assertion with PendingStatement

    Permalink
    Definition Classes
    Assertions
  57. var scalaTestContext: DynamicVariable[Option[(ChiselScalatestTester.this)#NoArgTest]]

    Permalink
    Attributes
    protected
  58. final val succeed: Assertion

    Permalink
    Definition Classes
    Assertions
  59. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  60. def test[T <: MultiIOModule](dutGen: ⇒ T): (ChiselScalatestTester.this)#TestBuilder[T]

    Permalink

    Constructs a unit test harness for the Chisel Module generated by dutGen.

    Constructs a unit test harness for the Chisel Module generated by dutGen. General use looks like

    test(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)
    }

    If you need to add options to this unit test you can tack on .withAnnotations modifier or a .withFlags modifier. These modifiers can be used together. You must add import chisel3.tester.experimental.TestOptionBuilder._ to use .withAnnotations

    For example:

    test(new TestModule).withAnnotations(Seq(WriteVcdAnnotation)) { c =>
      // body of the unit test
    }
    T

    The DUT type, must be a subclass of MultiIOModule

    dutGen

    A generator of a Chisel Module

    Note

    This API is experimental and forward compatibility is not yet guaranteed

    See also

    src/test/scala/chisel3/tests/OptionsBackwardCompatibilityTest for examples

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

    Permalink

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

    Expect a specific value on a wire, calling testerFail if the expectation isn't met. Failures queued until the next checkpoint.

    Definition Classes
    TestEnvInterface
  62. def testerFail(msg: String): Unit

    Permalink

    Logs a tester failure at this point.

    Logs a tester failure at this point. Failures queued until the next checkpoint.

    Definition Classes
    TestEnvInterface
  63. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  64. var topFileName: Option[String]

    Permalink
  65. def typeCheckedConstraint[A, B](implicit equivalenceOfA: Equivalence[A], ev: <:<[B, A]): CanEqual[A, B]

    Permalink
    Definition Classes
    TripleEquals → TripleEqualsSupport
  66. implicit def unconstrainedEquality[A, B](implicit equalityOfA: Equality[A]): CanEqual[A, B]

    Permalink
    Definition Classes
    TripleEquals → TripleEqualsSupport
  67. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  68. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  69. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  70. def withClue[T](clue: Any)(fun: ⇒ T): T

    Permalink
    Definition Classes
    Assertions
  71. def withFixture(test: (ChiselScalatestTester.this)#NoArgTest): Outcome

    Permalink
    Definition Classes
    ChiselScalatestTester → TestSuiteMixin

Deprecated Value Members

  1. def trap[T](f: ⇒ T): Throwable

    Permalink
    Definition Classes
    Assertions
    Annotations
    @deprecated
    Deprecated

    The trap method is no longer needed for demos in the REPL, which now abreviates stack traces, and will be removed in a future version of ScalaTest

Inherited from TestEnvInterface

Inherited from TestSuiteMixin

Inherited from SuiteMixin

Inherited from Assertions

Inherited from TripleEquals

Inherited from TripleEqualsSupport

Inherited from AnyRef

Inherited from Any

Ungrouped