Enable sandbox for testing and run tests in parallel

[unlsycn]

com-lihaoyi/mill#3347 enables the sandbox for testing by default, and this prevents us from assuming that we are running tests in the workspace root. Instead, we should use the environment variables provided by mill to locate the resources that files in tests should access.

Notably, a match assertion of sourceline and caret has been removed from SimulatorSpec, as we don't have an option to specify the source root of this test, it wouldn't undermine the correctness of the test.

Contributor Checklist

• Did you add Scaladoc to every public function/method?
• Did you add at least one test demonstrating the PR?
• Did you delete any extraneous printlns/debugging code?
• Did you specify the type of improvement?
• Did you add appropriate documentation in docs/src?
• Did you request a desired merge strategy?
• Did you add text to be included in the Release Notes for this change?

Type of Improvement

• Internal or build-related (includes code refactoring/cleanup)

Desired Merge Strategy

• Squash: The PR will be squashed and merged (choose this if you have no preference).
• Rebase: You will rebase the PR onto master and it will be merged with a merge commit.

Release Notes

Reviewer Checklist (only modified by reviewer)

• Did you add the appropriate labels? (Select the most appropriate one based on the "Type of Improvement")
• Did you mark the proper milestone (Bug fix: 3.6.x, 5.x, or 6.x depending on impact, API modification or big change: 7.0)?
• Did you review?
• Did you check whether all relevant Contributor checkboxes have been checked?
• Did you do one of the following when ready to merge:
  • Squash: You/ the contributor Enable auto-merge (squash) and clean up the commit message.
  • Merge: Ensure that contributor has cleaned up their commit history, then merge with Create a merge commit.

[unlsycn]

Hi, I’d appreciate it if anyone could take a look at this.

[seldridge]

Looks good! Thanks!

One question if -I (or long version: --include-dir) can be used to keep a test working.

[seldridge]

This is annoying as this is the exact thing this test is trying to check.

Does this continue to work if simulate is passed firtoolOpts = Array(s"-include-dir=${sys.env.get("MILL_TEST_RESOURCE_DIR").get}") ?

[unlsycn]

IIRC this check depends on elaborate time options like --source-root rather than the firtool option, so the major problem is that we cannot easily modify it without refactoring Simulator.simulate.

[unlsycn]

Is there any advice to change it for passing chisel option? If necessary I'd like to make this change.

[seldridge]

simulator.simulate(...) has a firtoolOpts argument you can use. It also takes a chiselOpts argument if you need to set --source-root.

Or: what is the source locator that is produced? If that is an absolute path already, then it may be as simple as doing --include-dir=/. However, if this uses a synthetic, sandbox directory, then this would be harder.

[unlsycn]

Oh..I see, the arguments are added after this PR, let me update the branch to fix it.

Or: what is the source locator that is produced? If that is an absolute path already, then it may be as simple as doing --include-dir=/. However, if this uses a synthetic, sandbox directory, then this would be harder.

the source locator works fine and the caret is produced by Chisel rather than firtool thus I think --include-dir does not make sense. The problem is --source-root is an elaborate time option but the caret is produced in simulation time, which does not capture it (see

chisel/src/main/scala/chisel3/simulator/PeekPokeAPI.scala

Line 169 in 8498293

ExceptionHelpers.getErrorLineInFile(Seq(), sl)

), thus we may need to parse the option in simulate and keep it in simulation time.