Add threshold check for contract code coverage

ethereum-optimism / optimism

Optimism is Ethereum, scaled.

https://optimism.io

MIT License

5.64k stars 3.27k forks source link

Add threshold check for contract code coverage #1554

Closed elenadimitrova closed 3 years ago

elenadimitrova commented 3 years ago

We run solidity-coverage to produce contract code coverage metrics. We should check these against thresholds for branch coverage to ensure we don't fall below the current state of experimental branch (experimental will soon be merged to develop but at the time of writing it's the branch you should be targeting). For this threshold check, it's recommended to use istanbul check-coverage although we're open to alternative suggestions.

neelriyer commented 3 years ago

@elenadimitrova, I'd like to work on this if possible. I just had a few questions:

solidity-coverage doesn't seem to be used as a shell command anymore. How are you producing the contract code coverage metrics?
I can't seem to access the ref link on linear.app for some reason? Could you share a public link?

Thanks!

elenadimitrova commented 3 years ago

Thanks @spiyer99 ! Answers below:

We are using hardhat to run solidity coverage, here https://github.com/ethereum-optimism/optimism/blob/experimental/packages/contracts/package.json#L27
The reference link holds duplicate content as this issue description. It is for internal use only (links to our backlog tool and I've removed it now so not confusing)

elenadimitrova commented 3 years ago

Hi @spiyer99 are you working on this or shall I? We really need it :)

neelriyer commented 3 years ago

@elenadimitrova sorry a few things came up for me. Feel free to work on it.

elenadimitrova commented 3 years ago

Done as part of #1646