Name: EthClientTester
Owner: ConsenSys
Description: Set up and run tests on a Quorum network
Created: 2017-09-18 08:56:28.0
Updated: 2018-01-05 08:41:18.0
Pushed: 2018-01-05 08:48:20.0
Size: 121
Language: JavaScript
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
The aim of this project is to make it easier to create a collection of benchmarking tests, set them up and run them on an Ethereum network.
The EthClientTester does the following:
WIP: If an EthClientProbe (https://github.com/rynobey/EthClientProbe) is running on a node's host, the EthClientTester can collect additional information (for every node running an EthClientProbe), which currently includes:
clone --recursive https://github.com/ConsenSys/EthClientTester.git
thClientTester
install
See https://github.com/rynobey/EthClientProbe for setting up the probe on a node's host.
The configuration of EthClientTester is done by setting parameter values in config.js. These parameters include a list of nodes to monitor and use for traffic generation and a list of tests to perform, as well as some other parameters. Each test procedure is defined in a file containing the preparation and execution procedures for that specific test, and the file itself is located in the tests folder. A quick guide to setting up and running a test using testrpc follows.
1) If you have not done so yet, follow the instructions above to download and install EthClientTester
2) If you don't yet have testrpc installed: npm install -g ethereumjs-testrpc@v4.1.3
3) Start testrpc: testrpc
4) Open config.js in your favourite text editor, and make sure of the following:
a) That your testrpc is listed in the config.nodes array. You will need to specify a name, host address, host port, and whether it will be used to generate traffic or not. Besides listing each node's details, you also need to specify the type of client running on your nodes: config.clientType = 'ethereumjs-testrpc if using testrpc (use 'go-quorum' if client is quorum - support for other clients can be added if requested).
b) That one of the example tests in the EthClientTester/tests/ folder is listed in the config.tests array (it needs to be added using '<testName>.js'. To get started, you can add the ether transfer example test by adding 'etherTransactionExample1.js' to the config.tests array.
Once the EthClientTester is configured, and your network is up and running, you can start the test using node index.js. Running a test involves three phases: initialization, preparation, and execution. Once a test is completed, it will exit. Timestamped status updates, errors, transaction hashes, and recorded host data (if activated) for each node can be found in the EthClientTester/logs directory, in the directory with the name corresponding to the year, month, day, hour, and minute (UTC) when the test was started.
Coming soon