package scalatest
Type Members
- trait FileCheck extends testing.FileCheck with TestingDirectory
A trait that provides FileCheck APIs and integration with Scalatest.
A trait that provides FileCheck APIs and integration with Scalatest.
Example usage:
import chisel3.testing.scalatest.FileCheck.scalatest import org.scalatest.flatspec.AnyFlatSpec import org.scalatest.matches.should.Matchers class Foo extends AnyFlatSpec with Matchers with FileCheck { /** This has access to all FileCheck APIs like `fileCheck`. */ }
- See also
- trait HasConfigMap extends TestSuiteMixin
A Scalatest test suite mix-in that provides access to command line options.
A Scalatest test suite mix-in that provides access to command line options.
This expose any keys/values passed using the
-D<key>=<value
command line option to the test via aMap
.For example, you can invoke Scalatest passing the
foo=bar
option like so:./mill 'chisel[2.13.16].test.testOnly' fooTest -Dfoo=bar
Inside your test, if the
configMap
member function is accessed this will return:Map(foo -> bar)
This is intended to be a building block of more complicated tests that want to customize their execution via the command line. It is advisable to use this sparingly as tests are generally not intended to change when you run them.
- trait TestingDirectory extends TestSuiteMixin
A mix-in for a Scalatest test suite that will setup the output directory for you.
A mix-in for a Scalatest test suite that will setup the output directory for you. E.g., this will create output directories for your tests like the following:
<buildDir> └── <suite-name> └── <scope-1-name> └── ... └── <scope-n-name> ├── <test-1-name> ├── ... └── <test-n-name>
You may change the
buildDir
by overridding a method of the same name in this trait.
This is the documentation for Chisel.
Package structure
The chisel3 package presents the public API of Chisel. It contains the concrete core types
UInt
,SInt
,Bool
,Clock
, andReg
, the abstract typesBits
,Aggregate
, andData
, and the aggregate typesBundle
andVec
.The Chisel package is a compatibility layer that attempts to provide chisel2 compatibility in chisel3.
Utility objects and methods are found in the
util
package.The
testers
package defines the basic interface for chisel testers.