Add chai-setup script to consistently import additional matchers #537
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Chai requires binding matchers to the global test runner inside hardhat, not doing so leaves certain tests in the PSP to throw due to the matchers not being found.
The fix is to use
chai.use(smock.matchers);
But rather than write in every test file, we should define a setup script:
Which can then be imported in place of Chai, in a consistent manner for all files.
import {expect} from './chai-setup'
Note: in theory there is a require field in the mocha config in hardhat. This doesn’t appear to actually run any scripts before the tests fire. Hardhat also exposes fixtures which could be an alternative approach, but since this is a global environment setup, it seems an import script is fine.
Task ID: OS-1041
Type of change
Checklist:
CHANGELOG.md
file in the root folder.DEPLOYMENT_CHECKLIST
file in the root folder.UPDATE_CHECKLIST
file in the root folder.