Packages

t

chiseltest

ChiselScalatestTester

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
    Definition Classes
    Assertions
  2. class CheckingEqualizer[L] extends AnyRef
    Definition Classes
    TripleEqualsSupport
  3. class Equalizer[L] extends AnyRef
    Definition Classes
    TripleEqualsSupport
  4. class TestBuilder[T <: MultiIOModule] extends AnyRef

Abstract Value Members

  1. abstract def expectedTestCount(filter: Filter): Int
    Definition Classes
    SuiteMixin
  2. abstract def nestedSuites: IndexedSeq[Suite]
    Definition Classes
    SuiteMixin
  3. abstract def rerunner: Option[String]
    Definition Classes
    SuiteMixin
  4. abstract def run(testName: Option[String], args: Args): Status
    Definition Classes
    SuiteMixin
  5. abstract def runNestedSuites(args: Args): Status
    Attributes
    protected
    Definition Classes
    SuiteMixin
  6. abstract def runTest(testName: String, args: Args): Status
    Attributes
    protected
    Definition Classes
    SuiteMixin
  7. abstract def runTests(testName: Option[String], args: Args): Status
    Attributes
    protected
    Definition Classes
    SuiteMixin
  8. abstract val styleName: String
    Definition Classes
    SuiteMixin
  9. abstract def suiteId: String
    Definition Classes
    SuiteMixin
  10. abstract def suiteName: String
    Definition Classes
    SuiteMixin
  11. abstract def tags: Map[String, Set[String]]
    Definition Classes
    SuiteMixin
  12. abstract def testDataFor(testName: String, theConfigMap: ConfigMap): TestData
    Definition Classes
    SuiteMixin
  13. abstract def testNames: Set[String]
    Definition Classes
    SuiteMixin

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. def !==[T](right: Spread[T]): TripleEqualsInvocationOnSpread[T]
    Definition Classes
    TripleEqualsSupport
  3. def !==(right: Null): TripleEqualsInvocation[Null]
    Definition Classes
    TripleEqualsSupport
  4. def !==[T](right: T): TripleEqualsInvocation[T]
    Definition Classes
    TripleEqualsSupport
  5. final def ##(): Int
    Definition Classes
    AnyRef → Any
  6. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  7. def ===[T](right: Spread[T]): TripleEqualsInvocationOnSpread[T]
    Definition Classes
    TripleEqualsSupport
  8. def ===(right: Null): TripleEqualsInvocation[Null]
    Definition Classes
    TripleEqualsSupport
  9. def ===[T](right: T): TripleEqualsInvocation[T]
    Definition Classes
    TripleEqualsSupport
  10. 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

    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
    Definition Classes
    Any
  12. macro def assert(condition: Boolean, clue: Any)(implicit prettifier: Prettifier, pos: Position): Assertion
    Definition Classes
    Assertions
  13. macro def assert(condition: Boolean)(implicit prettifier: Prettifier, pos: Position): Assertion
    Definition Classes
    Assertions
  14. macro def assertCompiles(code: String)(implicit pos: Position): Assertion
    Definition Classes
    Assertions
  15. macro def assertDoesNotCompile(code: String)(implicit pos: Position): Assertion
    Definition Classes
    Assertions
  16. def assertResult(expected: Any)(actual: Any)(implicit prettifier: Prettifier, pos: Position): Assertion
    Definition Classes
    Assertions
  17. def assertResult(expected: Any, clue: Any)(actual: Any)(implicit prettifier: Prettifier, pos: Position): Assertion
    Definition Classes
    Assertions
  18. def assertThrows[T <: AnyRef](f: ⇒ Any)(implicit classTag: ClassTag[T], pos: Position): Assertion
    Definition Classes
    Assertions
  19. macro def assertTypeError(code: String)(implicit pos: Position): Assertion
    Definition Classes
    Assertions
  20. val assertionsHelper: (ChiselScalatestTester.this)#AssertionsHelper
    Definition Classes
    Assertions
  21. macro def assume(condition: Boolean, clue: Any)(implicit prettifier: Prettifier, pos: Position): Assertion
    Definition Classes
    Assertions
  22. macro def assume(condition: Boolean)(implicit prettifier: Prettifier, pos: Position): Assertion
    Definition Classes
    Assertions
  23. val batchedFailures: ArrayBuffer[Exception]
    Attributes
    protected
    Definition Classes
    TestEnvInterface
  24. def cancel(cause: Throwable)(implicit pos: Position): Nothing
    Definition Classes
    Assertions
  25. def cancel(message: String, cause: Throwable)(implicit pos: Position): Nothing
    Definition Classes
    Assertions
  26. def cancel(message: String)(implicit pos: Position): Nothing
    Definition Classes
    Assertions
  27. def cancel()(implicit pos: Position): Nothing
    Definition Classes
    Assertions
  28. def checkpoint(): Unit

    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
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  30. def conversionCheckedConstraint[A, B](implicit equivalenceOfA: Equivalence[A], cnv: (B) ⇒ A): CanEqual[A, B]
    Definition Classes
    TripleEquals → TripleEqualsSupport
  31. def convertEquivalenceToAToBConstraint[A, B](equivalenceOfB: Equivalence[B])(implicit ev: <:<[A, B]): CanEqual[A, B]
    Definition Classes
    TripleEquals → TripleEqualsSupport
  32. def convertEquivalenceToAToBConversionConstraint[A, B](equivalenceOfB: Equivalence[B])(implicit ev: (A) ⇒ B): CanEqual[A, B]
    Definition Classes
    TripleEquals → TripleEqualsSupport
  33. def convertEquivalenceToBToAConstraint[A, B](equivalenceOfA: Equivalence[A])(implicit ev: <:<[B, A]): CanEqual[A, B]
    Definition Classes
    TripleEquals → TripleEqualsSupport
  34. def convertEquivalenceToBToAConversionConstraint[A, B](equivalenceOfA: Equivalence[A])(implicit ev: (B) ⇒ A): CanEqual[A, B]
    Definition Classes
    TripleEquals → TripleEqualsSupport
  35. def convertToCheckingEqualizer[T](left: T): (ChiselScalatestTester.this)#CheckingEqualizer[T]
    Definition Classes
    TripleEquals → TripleEqualsSupport
  36. implicit def convertToEqualizer[T](left: T): (ChiselScalatestTester.this)#Equalizer[T]
    Definition Classes
    TripleEquals → TripleEqualsSupport
  37. def defaultEquality[A]: Equality[A]
    Definition Classes
    TripleEqualsSupport
  38. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  39. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  40. def fail(cause: Throwable)(implicit pos: Position): Nothing
    Definition Classes
    Assertions
  41. def fail(message: String, cause: Throwable)(implicit pos: Position): Nothing
    Definition Classes
    Assertions
  42. def fail(message: String)(implicit pos: Position): Nothing
    Definition Classes
    Assertions
  43. def fail()(implicit pos: Position): Nothing
    Definition Classes
    Assertions
  44. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  45. def getExpectDetailedTrace(trace: Seq[StackTraceElement], inFile: String): String
    Attributes
    protected
    Definition Classes
    TestEnvInterface
  46. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  47. def intercept[T <: AnyRef](f: ⇒ Any)(implicit classTag: ClassTag[T], pos: Position): T
    Definition Classes
    Assertions
  48. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  49. def lowPriorityConversionCheckedConstraint[A, B](implicit equivalenceOfB: Equivalence[B], cnv: (A) ⇒ B): CanEqual[A, B]
    Definition Classes
    TripleEquals → TripleEqualsSupport
  50. def lowPriorityTypeCheckedConstraint[A, B](implicit equivalenceOfB: Equivalence[B], ev: <:<[A, B]): CanEqual[A, B]
    Definition Classes
    TripleEquals → TripleEqualsSupport
  51. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  52. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  53. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  54. def pending: Assertion with PendingStatement
    Definition Classes
    Assertions
  55. def pendingUntilFixed(f: ⇒ Unit)(implicit pos: Position): Assertion with PendingStatement
    Definition Classes
    Assertions
  56. val scalaTestContext: DynamicVariable[Option[(ChiselScalatestTester.this)#NoArgTest]]
    Attributes
    protected
  57. final val succeed: Assertion
    Definition Classes
    Assertions
  58. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  59. def test[T <: MultiIOModule](dutGen: ⇒ T): (ChiselScalatestTester.this)#TestBuilder[T]

    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

  60. 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.

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

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

    Logs a tester failure at this point.

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

    Definition Classes
    TestEnvInterface
  62. def toString(): String
    Definition Classes
    AnyRef → Any
  63. val topFileName: Option[String]
    Definition Classes
    ChiselScalatestTester → TestEnvInterface
  64. def typeCheckedConstraint[A, B](implicit equivalenceOfA: Equivalence[A], ev: <:<[B, A]): CanEqual[A, B]
    Definition Classes
    TripleEquals → TripleEqualsSupport
  65. implicit def unconstrainedEquality[A, B](implicit equalityOfA: Equality[A]): CanEqual[A, B]
    Definition Classes
    TripleEquals → TripleEqualsSupport
  66. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  67. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  68. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  69. def withClue[T](clue: Any)(fun: ⇒ T): T
    Definition Classes
    Assertions
  70. def withFixture(test: (ChiselScalatestTester.this)#NoArgTest): Outcome
    Definition Classes
    ChiselScalatestTester → TestSuiteMixin

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

  2. def trap[T](f: ⇒ T): Throwable
    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