diff options
author | Leonid Logvinov <logvinov.leon@gmail.com> | 2018-12-03 20:50:11 +0800 |
---|---|---|
committer | Leonid Logvinov <logvinov.leon@gmail.com> | 2018-12-03 20:50:11 +0800 |
commit | 1785769916d47cf5810ad48d2d03fcccb508f44c (patch) | |
tree | 8d6d2ef636d167748869df8dd2799ff61af75c40 | |
parent | c5e43f8da51296f3132b6baffd0c1ae5038e6f92 (diff) | |
download | dexon-sol-tools-1785769916d47cf5810ad48d2d03fcccb508f44c.tar dexon-sol-tools-1785769916d47cf5810ad48d2d03fcccb508f44c.tar.gz dexon-sol-tools-1785769916d47cf5810ad48d2d03fcccb508f44c.tar.bz2 dexon-sol-tools-1785769916d47cf5810ad48d2d03fcccb508f44c.tar.lz dexon-sol-tools-1785769916d47cf5810ad48d2d03fcccb508f44c.tar.xz dexon-sol-tools-1785769916d47cf5810ad48d2d03fcccb508f44c.tar.zst dexon-sol-tools-1785769916d47cf5810ad48d2d03fcccb508f44c.zip |
Refactour out the contracts testing options into a separate markdown file
-rw-r--r-- | contracts/TESTING.md | 48 | ||||
-rw-r--r-- | contracts/core/README.md | 47 | ||||
-rw-r--r-- | contracts/multisig/README.md | 47 |
3 files changed, 50 insertions, 92 deletions
diff --git a/contracts/TESTING.md b/contracts/TESTING.md new file mode 100644 index 000000000..750b3c62c --- /dev/null +++ b/contracts/TESTING.md @@ -0,0 +1,48 @@ +# Contracts testing options + +## Revert stack traces + +If you want to see helpful stack traces (incl. line number, code snippet) for smart contract reverts, run the tests with: + +``` +yarn test:trace +``` + +**Note:** This currently slows down the test runs and is therefore not enabled by default. + +## Backing Ethereum node + +By default, our tests run against an in-process [Ganache](https://github.com/trufflesuite/ganache-core) instance. In order to run the tests against [Geth](https://github.com/ethereum/go-ethereum), first follow the instructions in the README for the devnet package to start the devnet Geth node. Then run: + +```bash +TEST_PROVIDER=geth yarn test +``` + +## Code coverage + +In order to see the Solidity code coverage output generated by `@0x/sol-cov`, run: + +``` +yarn test:coverage +``` + +## Gas profiler + +In order to profile the gas costs for a specific smart contract call/transaction, you can run the tests in `profiler` mode. + +**Note:** Traces emitted by ganache have incorrect gas costs so we recommend using Geth for profiling. + +``` +TEST_PROVIDER=geth yarn test:profiler +``` + +You'll see a warning that you need to explicitly enable and disable the profiler before and after the block of code you want to profile. + +```typescript +import { profiler } from './utils/profiler'; +profiler.start(); +// Some call to a smart contract +profiler.stop(); +``` + +Without explicitly starting and stopping the profiler, the profiler output will be too busy, and therefore unusable. diff --git a/contracts/core/README.md b/contracts/core/README.md index 7fd2ab220..0004925c1 100644 --- a/contracts/core/README.md +++ b/contracts/core/README.md @@ -79,49 +79,4 @@ yarn test #### Testing options -###### Revert stack traces - -If you want to see helpful stack traces (incl. line number, code snippet) for smart contract reverts, run the tests with: - -``` -yarn test:trace -``` - -**Note:** This currently slows down the test runs and is therefore not enabled by default. - -###### Backing Ethereum node - -By default, our tests run against an in-process [Ganache](https://github.com/trufflesuite/ganache-core) instance. In order to run the tests against [Geth](https://github.com/ethereum/go-ethereum), first follow the instructions in the README for the devnet package to start the devnet Geth node. Then run: - -```bash -TEST_PROVIDER=geth yarn test -``` - -###### Code coverage - -In order to see the Solidity code coverage output generated by `@0x/sol-cov`, run: - -``` -yarn test:coverage -``` - -###### Gas profiler - -In order to profile the gas costs for a specific smart contract call/transaction, you can run the tests in `profiler` mode. - -**Note:** Traces emitted by ganache have incorrect gas costs so we recommend using Geth for profiling. - -``` -TEST_PROVIDER=geth yarn test:profiler -``` - -You'll see a warning that you need to explicitly enable and disable the profiler before and after the block of code you want to profile. - -```typescript -import { profiler } from './utils/profiler'; -profiler.start(); -// Some call to a smart contract -profiler.stop(); -``` - -Without explicitly starting and stopping the profiler, the profiler output will be too busy, and therefore unusable. +Contracts testing options like coverage, profiling, revert traces or backing node choosing - are described [here](../TESTING.md). diff --git a/contracts/multisig/README.md b/contracts/multisig/README.md index 488a0313e..93db63b5b 100644 --- a/contracts/multisig/README.md +++ b/contracts/multisig/README.md @@ -67,49 +67,4 @@ yarn test #### Testing options -###### Revert stack traces - -If you want to see helpful stack traces (incl. line number, code snippet) for smart contract reverts, run the tests with: - -``` -yarn test:trace -``` - -**Note:** This currently slows down the test runs and is therefore not enabled by default. - -###### Backing Ethereum node - -By default, our tests run against an in-process [Ganache](https://github.com/trufflesuite/ganache-core) instance. In order to run the tests against [Geth](https://github.com/ethereum/go-ethereum), first follow the instructions in the README for the devnet package to start the devnet Geth node. Then run: - -```bash -TEST_PROVIDER=geth yarn test -``` - -###### Code coverage - -In order to see the Solidity code coverage output generated by `@0x/sol-cov`, run: - -``` -yarn test:coverage -``` - -###### Gas profiler - -In order to profile the gas costs for a specific smart contract call/transaction, you can run the tests in `profiler` mode. - -**Note:** Traces emitted by ganache have incorrect gas costs so we recommend using Geth for profiling. - -``` -TEST_PROVIDER=geth yarn test:profiler -``` - -You'll see a warning that you need to explicitly enable and disable the profiler before and after the block of code you want to profile. - -```typescript -import { profiler } from './utils/profiler'; -profiler.start(); -// Some call to a smart contract -profiler.stop(); -``` - -Without explicitly starting and stopping the profiler, the profiler output will be too busy, and therefore unusable. +Contracts testing options like coverage, profiling, revert traces or backing node choosing - are described [here](../TESTING.md). |