.circleci/config.yml

@@ -12,25 +12,21 @@ step_install_nvm: &step_install_nvm
       set +e
       export NVM_DIR="/opt/circleci/.nvm"
       [ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"
-      nvm install v12.16.0
-      nvm alias default v12.16.0
+      nvm install v14.19.0
+      nvm alias default v14.19.0
       echo 'export NVM_DIR="/opt/circleci/.nvm"' >> $BASH_ENV
       echo "[ -s \"$NVM_DIR/nvm.sh\" ] && . \"$NVM_DIR/nvm.sh\"" >> $BASH_ENV
 
 jobs:
   unit-test:
     docker:
-      - image: circleci/node:12
+      - image: circleci/node:14
     steps:
       - checkout
       - run:
           name: Delete any old node_modules
           command: |
             rm -rf node_modules/
-      - run:
-          name: Install truffle (globally)
-          command: |
-            sudo npm install -g truffle
       - run:
           name: Install dependencies
           command: |
@@ -45,30 +41,15 @@ jobs:
             bash <(curl -s https://codecov.io/bash)
   e2e-zeppelin:
     machine: true
+    environment:
+          NODE_OPTIONS: --max_old_space_size=8192
     steps:
       - checkout
       - <<: *step_install_nvm
       - run:
           name: Zeppelin E2E
           command: |
             ./scripts/run-zeppelin.sh
-  e2e-metacoin:
-    machine: true
-    steps:
-      - checkout
-      - <<: *step_install_nvm
-      - run:
-          name: MetaCoin E2E
-          command: |
-            ./scripts/run-metacoin.sh
-  e2e-metacoin-windows:
-    executor: win/default
-    steps:
-      - checkout
-      - run:
-          name: Windows Metacoin E2E
-          command: |
-            bash ./scripts/run-metacoin.sh
   e2e-nomiclabs:
     machine: true
     steps:
@@ -84,6 +65,4 @@ workflows:
     jobs:
       - unit-test
       - e2e-zeppelin
-      - e2e-metacoin
-      - e2e-metacoin-windows
       - e2e-nomiclabs

CHANGELOG.md

@@ -1,5 +1,26 @@
 # Changelog
 
+0.7.21 / 2022-04-24
+===================
+  * Add support for UncheckedStatement blocks (https://github.com/sc-forks/solidity-coverage/issues/712)
+  * Lazy load hardhat plugin resources (https://github.com/sc-forks/solidity-coverage/issues/711)
+
+0.7.20 / 2022-02-15
+===================
+  * Remove early V7 Truffle patches  (https://github.com/sc-forks/solidity-coverage/issues/693)
+
+0.7.19 / 2022-02-09
+===================
+  * Update solidity-parser/parser to 0.14.0 - supports solidity user-defined types (https://github.com/sc-forks/solidity-coverage/issues/689)
+
+0.7.18 2022-01-17
+=================
+* Add solcOptimizerDetails option to help workaround "stack too deep" errors (https://github.com/sc-forks/solidity-coverage/issues/683)
+* Add __SOLIDITY_COVERAGE_RUNNING variable on global HH env for identifying solidity-coverage task from other tasks (https://github.com/sc-forks/solidity-coverage/issues/682)
+* Fix hardhat_reset (https://github.com/sc-forks/solidity-coverage/issues/667)
+* Add new hook and make temporary contracts directory configurable (https://github.com/sc-forks/solidity-coverage/issues/664)
+* Use internal visibility for fn level hash method defs (https://github.com/sc-forks/solidity-coverage/issues/660)
+
 0.7.16 / 2021-03-04
 ===================
   * Update @solidity-parser/parser to ^0.12.0 (and support Panic keyword in catch clauses) (https://github.com/sc-forks/solidity-coverage/issues/621)

README.md

@@ -14,67 +14,40 @@
   see [the accompanying article][16].
 + `solidity-coverage` is [Solcover][17]
 
-## Install
-```
-$ npm install --save-dev solidity-coverage
-```
-
-**Resources**:
-+ [0.7.0 release notes][31]
-+ [A guide][29] to upgrading from 0.6.x to 0.7.x
-+ [0.6.3 docs][30]
+## Requirements
 
-### Truffle V5
++ Hardhat >= 2.11.0
 
-**Add** this package to your plugins array in `truffle-config.js` ([Truffle docs][27])
-```javascript
-module.exports = {
-  networks: {...},
-  plugins: ["solidity-coverage"]
-}
-```
-**Run**
+## Install
 ```
-truffle run coverage [command-options]
+$ yarn add solidity-coverage --dev
 ```
 
-### Hardhat
-
-Beginning with v0.7.12, this tool supports Hardhat and runs directly on
-HardhatEVM.
-
 **Require** the plugin in `hardhat.config.js` ([Hardhat docs][26])
 ```javascript
 require('solidity-coverage')
 ```
 
-**Run**
+Or, if you are using TypeScript, add this to your hardhat.config.ts:
+```ts
+import 'solidity-coverage'
+```
+**Resources**:
++ [0.8.0 release notes][31]
+
+## Run
 ```
 npx hardhat coverage [command-options]
 ```
 
-(Additional Hardhat-specific info can be found [here][37])
-
-### @openzeppelin/test-environment
-
-OpenZeppelin have written their own coverage generation scripts for `test-environment` using the solidity-coverage API.
-A working example can be found at [openzeppelin-contracts, here.][35]
-
-## Usage notes:
-+ Coverage runs tests a little more slowly.
-+ Coverage launches its own in-process ganache server.
-+ You can set [ganache options][1] using the `providerOptions` key in your `.solcover.js` [config][15].
-+ Coverage [distorts gas consumption][13]. Tests that check exact gas consumption should be [skipped][24].
-+ :warning:  Contracts are compiled **without optimization**. Please report unexpected compilation faults to [issue 417][25]
-
 ## Command Options
 | Option <img width=200/> | Example <img width=750/>| Description <img width=1000/> |
 |--------------|------------------------------------|--------------------------------|
-| file | `--file="test/registry/*.js"`    | (Truffle) Filename or glob describing a subset of tests to run. (Globs must be enclosed by quotes and use [globby matching patterns][38])|
-| testfiles  | `--testfiles "test/registry/*.ts"` | (Buidler) Test file(s) to run. (Globs must be enclosed by quotes and use [globby matching patterns][38])|
+| testfiles  | `--testfiles "test/registry/*.ts"` | Test file(s) to run. (Globs must be enclosed by quotes and use [globby matching patterns][38])|
 | solcoverjs | `--solcoverjs ./../.solcover.js` | Relative path from working directory to config. Useful for monorepo packages that share settings. (Path must be "./" prefixed) |
-| network    | `--network development` | Use network settings defined in the Truffle or Buidler config |
+| network    | `--network development` | Use network settings defined in the Hardhat config |
 | temp[<sup>*</sup>][14]       | `--temp build`   | :warning: **Caution** :warning:  Path to a *disposable* folder to store compilation artifacts in. Useful when your test setup scripts include hard-coded paths to a build directory. [More...][14] |
+| matrix   | `--matrix` | Generate a JSON object that maps which mocha tests hit which lines of code. (Useful as an input for some fuzzing, mutation testing and fault-localization algorithms.) [More...][39]|
 
 [<sup>*</sup> Advanced use][14]
 
@@ -93,11 +66,14 @@ module.exports = {
 | Option <img width=200/>| Type <img width=200/> | Default <img width=1300/> | Description <img width=800/> |
 | ------ | ---- | ------- | ----------- |
 | silent | *Boolean* | false | Suppress logging output |
-| client | *Object* | `require("ganache-core")` | Useful if you need a specific ganache version. |
-| providerOptions | *Object* | `{ }` | [ganache-core options][1]  |
 | skipFiles | *Array* | `['Migrations.sol']` | Array of contracts or folders (with paths expressed relative to the `contracts` directory) that should be skipped when doing instrumentation. |
 | measureStatementCoverage | *boolean* | `true` | Computes statement (in addition to line) coverage. [More...][34] |
 | measureFunctionCoverage | *boolean* | `true` | Computes function coverage. [More...][34] |
+| measureModifierCoverage | *boolean* | `true` | Computes each modifier invocation as a code branch. [More...][34] |
+| modifierWhitelist | *String[]* | `[]` | List of modifier names (ex: "onlyOwner") to exclude from branch measurement. (Useful for modifiers which prepare something instead of acting as a gate.)) |
+| matrixOutputPath | *String* | `./testMatrix.json` | Relative path to write test matrix JSON object to. [More...][39]|
+| mochaJsonOutputPath | *String* | `./mochaOutput.json` | Relative path to write mocha JSON reporter object to. [More...][39]|
+| abiOutputPath | *String* | `./humanReadableAbis.json` | Relative path to write diff-able ABI data to |
 | istanbulFolder | *String* | `./coverage` |  Folder location for Istanbul coverage reports. |
 | istanbulReporter | *Array* | `['html', 'lcov', 'text', 'json']` | [Istanbul coverage reporters][2]  |
 | mocha | *Object* | `{ }` | [Mocha options][3] to merge into existing mocha config. `grep` and `invert` are useful for skipping certain tests under coverage using tags in the test descriptions.|
@@ -108,10 +84,16 @@ module.exports = {
 | onTestsComplete[<sup>*</sup>][14] | *Function* |  | Hook run *after* the tests complete, *before* Istanbul reports are generated. [More...][23]|
 | onIstanbulComplete[<sup>*</sup>][14] | *Function* |  | Hook run *after* the Istanbul reports are generated, *before* the ganache server is shut down. Useful if you need to clean resources up. [More...][23]|
 | configureYulOptimizer | *Boolean* | false | (Experimental) Setting to `true` should resolve "stack too deep" compiler errors in large projects using ABIEncoderV2 |
-| solcOptimizerDetails | *Object* | (Experimental) Must be used in combination with `configureYulOptimizer`Allows you define the [solc optimizer details][1001]. Useful if the default remedy for stack-too-deep errors doesn't work in your case (See FAQ below). |
+| solcOptimizerDetails | *Object* | `undefined` |(Experimental) Must be used in combination with `configureYulOptimizer`. Allows you configure solc's [optimizer details][1001]. Useful if the default remedy for stack-too-deep errors doesn't work in your case (See FAQ below). |
+| client | *Object* | `require("ganache-core")` | Ganache only: useful if you need a specific ganache version |
+| providerOptions | *Object* | `{ }` | Ganache only: [ganache-core options][1]  |
+
 
 [<sup>*</sup> Advanced use][14]
 
+## Viewing the reports: 
++ You can find the Istanbul reports written to the `./coverage/` folder generated in your root directory.
+
 ## API
 
 Solidity-coverage's core methods and many utilities are available as an API.
@@ -138,7 +120,7 @@ Common problems & questions:
 + [Running in CI][7]
 + [Running out of gas][13]
 + [Running out of time][6]
-+ [Running out of stack] [1002] (Stack too deep)
++ [Running out of stack][1002] (Stack too deep)
 + [Running out of memory][5]
 
 ## Example reports
@@ -187,6 +169,8 @@ $ yarn
 + [@paulrberg](https://github.com/paulrberg)
 + [@adjisb](https://github.com/adjisb)
 + [@Shelvak](https://github.com/Shelvak)
++ [@rynobey](https://github.com/rynobey)
++ [@ZumZoom](https://github.com/ZumZoom)
 
 [1]: https://github.com/trufflesuite/ganache-core#options
 [2]: https://istanbul.js.org/docs/advanced/alternative-reporters/
@@ -226,6 +210,7 @@ $ yarn
 [36]: https://hardhat.org/
 [37]: https://github.com/sc-forks/solidity-coverage/blob/master/HARDHAT_README.md
 [38]: https://github.com/sindresorhus/globby#globbing-patterns
+[39]: https://github.com/sc-forks/solidity-coverage/blob/master/docs/advanced.md#generating-a-test-matrix
 [1001]: https://docs.soliditylang.org/en/v0.8.0/using-the-compiler.html#input-description
 [1002]: https://github.com/sc-forks/solidity-coverage/blob/master/docs/faq.md#running-out-of-stack