From b1c99c75bc1e975eefd1000aa01844b2b2c88d2c Mon Sep 17 00:00:00 2001 From: Attila Klenik Date: Mon, 21 Oct 2019 19:43:59 +0000 Subject: [PATCH] [Release 0.2.0] Preparing packages for release Signed-off-by: Attila Klenik --- .travis/use_verdaccio.sh | 6 +- CHANGELOG.md | 15 +++++ README.md | 33 +++++++---- package.json | 15 +---- packages/caliper-burrow/README.md | 57 +++++++++++++++++++ packages/caliper-burrow/package.json | 22 +++---- packages/caliper-cli/README.md | 57 +++++++++++++++++++ packages/caliper-cli/package.json | 35 +++++------- packages/caliper-composer/README.md | 57 +++++++++++++++++++ packages/caliper-composer/package.json | 20 +++---- packages/caliper-core/README.md | 57 +++++++++++++++++++ packages/caliper-core/package.json | 14 ++--- packages/caliper-ethereum/README.md | 57 +++++++++++++++++++ packages/caliper-ethereum/index.js | 24 ++++---- packages/caliper-ethereum/lib/ethereum.js | 28 +++++---- .../lib/ethereumClientFactory.js | 28 +++++---- .../lib/ethereumClientWorker.js | 28 +++++---- packages/caliper-ethereum/package.json | 35 ++++++------ packages/caliper-fabric/README.md | 57 +++++++++++++++++++ packages/caliper-fabric/package.json | 25 +++----- packages/caliper-fisco-bcos/package.json | 4 +- packages/caliper-iroha/README.md | 57 +++++++++++++++++++ packages/caliper-iroha/package.json | 22 +++---- packages/caliper-sawtooth/README.md | 57 +++++++++++++++++++ packages/caliper-sawtooth/package.json | 21 +++---- .../caliper-tests-integration/package.json | 21 +++---- 26 files changed, 639 insertions(+), 213 deletions(-) create mode 100644 packages/caliper-burrow/README.md create mode 100644 packages/caliper-cli/README.md create mode 100644 packages/caliper-composer/README.md create mode 100644 packages/caliper-core/README.md create mode 100644 packages/caliper-ethereum/README.md create mode 100644 packages/caliper-fabric/README.md create mode 100644 packages/caliper-iroha/README.md create mode 100644 packages/caliper-sawtooth/README.md diff --git a/.travis/use_verdaccio.sh b/.travis/use_verdaccio.sh index c94d9b429..8e1399ddc 100755 --- a/.travis/use_verdaccio.sh +++ b/.travis/use_verdaccio.sh @@ -29,6 +29,10 @@ export CALL_METHOD="npx caliper" echo "---- Publishing packages locally" cd ./packages/caliper-tests-integration/ +# clean up the bootstrap modules, they interfere +rm -rf node_modules +# reinstall the dev deps (pm2, verdaccio, etc) +npm i --only=dev npm run start_verdaccio npm run npm_publish_local @@ -46,6 +50,4 @@ npx caliper bind echo "---- Running Integration test for adaptor ${BENCHMARK}" npm run run_tests -# shouldn't leave the CLI among the deps -npm uninstall --save @hyperledger/caliper-cli npm run cleanup diff --git a/CHANGELOG.md b/CHANGELOG.md index 18884ead7..73e1ee111 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,18 @@ +## 0.2.0 (October 25, 2019) + +* __REMOVED:__ The Zookeeper-based distributed clients feature has been removed, and will be reimplemented in 0.3.0 ([PR#588](https://github.com/hyperledger/caliper/pull/588)). +* __DEPRECATED:__ The HL Composer adapter has been marked as deprecated and __will be removed__ in 0.3.0. +* __BREAKING:__ Added rigorous and strict validation for Fabric network configuration files. Some attributes became mutually exclusive, which might break your previous configuration files that relied on precedence between attributes ([PR#595](https://github.com/hyperledger/caliper/pull/595)). +* __BREAKING:__ Improved the logging configuration flexibility. The default log message structure has changed, which might break your dependent (e.g. log mining) applications ([PR#598](https://github.com/hyperledger/caliper/pull/595), [PR#607](https://github.com/hyperledger/caliper/pull/607)). +* __BREAKING:__ Made report file path configurable. The default report path has changed, which might break your dependent applications ([PR#601](https://github.com/hyperledger/caliper/pull/601)). +* Added support for Ethereum ([PR#432](https://github.com/hyperledger/caliper/pull/432)) +* Added support for Hyperledger Besu ([PR#616](https://github.com/hyperledger/caliper/pull/616)) +* Added support for FISCO BCOS ([PR#515](https://github.com/hyperledger/caliper/pull/515)) +* Added the `querySmartContract` function to the `Blockchain` interface ([PR#578](https://github.com/hyperledger/caliper/pull/578)). _The old `queryState` function will be deprecated and removed in the upcoming releases (once every adapter supports the new function)!_ +* Introduced observers for continuous status updates about the running benchmark ([PR#588](https://github.com/hyperledger/caliper/pull/588)). +* Added a Prometheus-based observer and monitor ([PR#588](https://github.com/hyperledger/caliper/pull/588)). +* Fixed bug that prevented using mutual TLS with the Fabric gateway mode ([PR#604](https://github.com/hyperledger/caliper/pull/604)) + ## 0.1.0 (September 5, 2019) Initial release of Caliper. diff --git a/README.md b/README.md index 35fe20053..aa84ec979 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,37 @@ -# Hyperledger Caliper +# ![Hyperledger Caliper](https://wiki.hyperledger.org/download/attachments/2392434/Hyperledger_Caliper_Logo_Color.svg?version=1&modificationDate=1548883186000&api=v2) + +[![Build Status](https://travis-ci.org/hyperledger/caliper.svg?branch=master)](https://travis-ci.org/hyperledger/caliper) +[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/2381/badge)](https://bestpractices.coreinfrastructure.org/projects/2381) +[![license](https://img.shields.io/badge/license-Apache%202.0-blue)](https://github.com/aklenik/caliper/blob/master/LICENSE) +[![node (scoped)](https://img.shields.io/node/v/@hyperledger/caliper-cli)](https://www.npmjs.com/package/@hyperledger/caliper-cli) +[![npm (scoped)](https://img.shields.io/npm/v/@hyperledger/caliper-cli?label=version)](https://www.npmjs.com/package/@hyperledger/caliper-cli) +[![npm](https://img.shields.io/npm/dt/@hyperledger/caliper-cli?label=npm%20downloads)](https://www.npmjs.com/package/@hyperledger/caliper-cli) +[![Docker Pulls](https://img.shields.io/docker/pulls/hyperledger/caliper)](https://hub.docker.com/r/hyperledger/caliper) +[![Rocket.Chat](https://img.shields.io/badge/rocket.chat-caliper-red)](https://chat.hyperledger.org/channel/caliper) +[![Mailing list](https://img.shields.io/badge/mailing%20list-caliper-blue)](https://lists.hyperledger.org/g/caliper/topics) Welcome to the Hyperledger Caliper project. Caliper is a blockchain performance benchmark framework, which allows users to test different blockchain solutions with predefined use cases, and get a set of performance test results. Currently supported blockchain solutions: -* [fabric v1.0+](https://github.com/hyperledger/fabric), the latest version that has been verified is v1.4.1 -* [sawtooth 1.0+](https://github.com/hyperledger/sawtooth-core) -* [Iroha 1.0 beta-3](https://github.com/hyperledger/iroha) -* [Burrow 1.0](https://github.com/hyperledger/burrow) -* [FISCO BCOS v2.0.0](https://github.com/FISCO-BCOS/FISCO-BCOS) -[Hyperledger Composer](https://github.com/hyperledger/composer) is also supported. +* [Hyperledger Fabric v1.X](https://github.com/hyperledger/fabric) +* [Hyperledger Sawtooth 1.0+](https://github.com/hyperledger/sawtooth-core) +* [Hyperledger Iroha 1.0 beta-3](https://github.com/hyperledger/iroha) +* [Hyperledger Burrow 1.0](https://github.com/hyperledger/burrow) +* [Ethereum](https://github.com/ethereum/go-ethereum) +* [Hyperledger Besu](https://github.com/hyperledger/besu), utilizing the Ethereum adapter. +* [FISCO BCOS](https://github.com/FISCO-BCOS/FISCO-BCOS) +* [Hyperledger Composer](https://github.com/hyperledger/composer) support has been deprecated, and will be removed in 0.3.0. Currently supported performance indicators: * Success rate * Transaction/Read throughput -* Transaction/Read latency(minimum, maximum, average, percentile) -* Resource consumption (CPU, Memory, Network IO,...) +* Transaction/Read latency (minimum, maximum, average) +* Resource consumption (CPU, Memory, Network IO, ...) See the [PSWG white paper](https://www.hyperledger.org/resources/publications/blockchain-performance-metrics) to find out the definitions and corresponding measurement methods. -For more information on using Caliper please consult the [documentation site](https://hyperledger.github.io/caliper/) +For more information on using Caliper, please consult the [documentation site](https://hyperledger.github.io/caliper/) ## Install and usage See the [related documentation page](https://hyperledger.github.io/caliper/vLatest/installing-caliper/). @@ -31,6 +43,7 @@ If you have any issues using Caliper that the documentation does not help you so * [Issues](https://github.com/hyperledger/caliper/issues) Feel free to raise an issue if you are facing a Caliper related problem Caliper interacts with multiple blockchain technologies and consequently it *might* be an issue with the underlying blockchain technology being interacted with. You can seek specific help on these technologies within the following Rocket Chat channels: +* [Hyperledger Besu](https://chat.hyperledger.org/channel/besu) * [Hyperledger Burrow](https://chat.hyperledger.org/channel/burrow) * [Hyperledger Composer](https://chat.hyperledger.org/channel/composer) * [Hyperledger Fabric](https://chat.hyperledger.org/channel/fabric) diff --git a/package.json b/package.json index bbac04d70..babfbe352 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "caliper", "description": "Performance benchmarking for Hyperledger blockchain technologies. You must install [Lerna](https://lernajs.io) to build this multi-package repository.", - "version": "0.1.0", + "version": "0.2.0", "repository": { "type": "git", "url": "https://github.com/hyperledger/caliper" @@ -13,15 +13,10 @@ "licchk": "license-check-and-add", "test": "lerna run test" }, - "engineStrict": true, "engines": { "node": ">=8.10.0", "npm": ">=5.6.0" }, - "files": [ - "*", - "src/comm/template/report.html" - ], "dependencies": {}, "devDependencies": { "lerna": "2.0.0", @@ -69,11 +64,5 @@ } } }, - "license": "Apache-2.0", - "licenses": [ - { - "type": "Apache-2.0", - "url": "https://github.com/hyperledger/caliper/blob/master/LICENSE" - } - ] + "license": "Apache-2.0" } diff --git a/packages/caliper-burrow/README.md b/packages/caliper-burrow/README.md new file mode 100644 index 000000000..fb830458a --- /dev/null +++ b/packages/caliper-burrow/README.md @@ -0,0 +1,57 @@ +# ![Hyperledger Caliper](https://wiki.hyperledger.org/download/attachments/2392434/Hyperledger_Caliper_Logo_Color.svg?version=1&modificationDate=1548883186000&api=v2) + +[![Build Status](https://travis-ci.org/hyperledger/caliper.svg?branch=master)](https://travis-ci.org/hyperledger/caliper) +[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/2381/badge)](https://bestpractices.coreinfrastructure.org/projects/2381) +[![license](https://img.shields.io/badge/license-Apache%202.0-blue)](https://github.com/aklenik/caliper/blob/master/LICENSE) +[![node (scoped)](https://img.shields.io/node/v/@hyperledger/caliper-cli)](https://www.npmjs.com/package/@hyperledger/caliper-cli) +[![npm (scoped)](https://img.shields.io/npm/v/@hyperledger/caliper-cli?label=version)](https://www.npmjs.com/package/@hyperledger/caliper-cli) +[![npm](https://img.shields.io/npm/dt/@hyperledger/caliper-cli?label=npm%20downloads)](https://www.npmjs.com/package/@hyperledger/caliper-cli) +[![Docker Pulls](https://img.shields.io/docker/pulls/hyperledger/caliper)](https://hub.docker.com/r/hyperledger/caliper) +[![Rocket.Chat](https://img.shields.io/badge/rocket.chat-caliper-red)](https://chat.hyperledger.org/channel/caliper) +[![Mailing list](https://img.shields.io/badge/mailing%20list-caliper-blue)](https://lists.hyperledger.org/g/caliper/topics) + +Welcome to the Hyperledger Caliper project. Caliper is a blockchain performance benchmark framework, which allows users to test different blockchain solutions with predefined use cases, and get a set of performance test results. + +Currently supported blockchain solutions: +* [Hyperledger Fabric v1.X](https://github.com/hyperledger/fabric) +* [Hyperledger Sawtooth 1.0+](https://github.com/hyperledger/sawtooth-core) +* [Hyperledger Iroha 1.0 beta-3](https://github.com/hyperledger/iroha) +* [Hyperledger Burrow 1.0](https://github.com/hyperledger/burrow) +* [Ethereum](https://github.com/ethereum/go-ethereum) +* [Hyperledger Besu](https://github.com/hyperledger/besu), utilizing the Ethereum adapter. +* [FISCO BCOS](https://github.com/FISCO-BCOS/FISCO-BCOS) +* [Hyperledger Composer](https://github.com/hyperledger/composer) support has been deprecated, and will be removed in 0.3.0. + +Currently supported performance indicators: +* Success rate +* Transaction/Read throughput +* Transaction/Read latency (minimum, maximum, average) +* Resource consumption (CPU, Memory, Network IO, ...) + +See the [PSWG white paper](https://www.hyperledger.org/resources/publications/blockchain-performance-metrics) to find out the definitions and corresponding measurement methods. + +For more information on using Caliper, please consult the [documentation site](https://hyperledger.github.io/caliper/) + +## Install and usage +See the [related documentation page](https://hyperledger.github.io/caliper/vLatest/installing-caliper/). + +## How to contact us + +If you have any issues using Caliper that the documentation does not help you solve, please reach out to us through the following methods: +* [RocketChat](https://chat.hyperledger.org/channel/caliper) Please feel free to contact us on Rocket Chat (instant messaging). We monitor that channel as close as possible, but even if you don't have a problem that needs resolving, why not jump on and say hi ... we'd love to hear from you about your experiences and any new features you think we should work on. +* [Issues](https://github.com/hyperledger/caliper/issues) Feel free to raise an issue if you are facing a Caliper related problem + +Caliper interacts with multiple blockchain technologies and consequently it *might* be an issue with the underlying blockchain technology being interacted with. You can seek specific help on these technologies within the following Rocket Chat channels: +* [Hyperledger Besu](https://chat.hyperledger.org/channel/besu) +* [Hyperledger Burrow](https://chat.hyperledger.org/channel/burrow) +* [Hyperledger Composer](https://chat.hyperledger.org/channel/composer) +* [Hyperledger Fabric](https://chat.hyperledger.org/channel/fabric) +* [Hyperledger Iroha](https://chat.hyperledger.org/channel/iroha) +* [Hyperledger Sawtooth](https://chat.hyperledger.org/channel/sawtooth) + +## How to contribute + +We welcome contributions to the Caliper code base. Please see [Contributing](/CONTRIBUTING.md) for more information. + +## License +Hyperledger Project source code files are made available under the Apache License, Version 2.0 (Apache-2.0), located in the [LICENSE](LICENSE) file. Hyperledger Project documentation files are made available under the Creative Commons Attribution 4.0 International License (CC-BY-4.0), available at http://creativecommons.org/licenses/by/4.0/. diff --git a/packages/caliper-burrow/package.json b/packages/caliper-burrow/package.json index 42ce8bf2b..0de5b0723 100644 --- a/packages/caliper-burrow/package.json +++ b/packages/caliper-burrow/package.json @@ -1,10 +1,11 @@ { "name": "@hyperledger/caliper-burrow", - "description": "Hyperledger Burrow adaptor for Caliper, enabling the running of a performance benchmarks that interact with Burrow", - "version": "0.1.0", + "description": "Hyperledger Burrow adaptor for Caliper, enabling the running of performance benchmarks that interact with Burrow", + "version": "0.2.0", "repository": { "type": "git", - "url": "https://github.com/hyperledger/caliper" + "url": "https://github.com/hyperledger/caliper", + "directory": "packages/caliper-burrow" }, "scripts": { "pretest": "npm run licchk", @@ -17,10 +18,8 @@ "node": ">=8.10.0", "npm": ">=5.6.0" }, - "engine-strict": true, - "engineStrict": true, "dependencies": { - "@hyperledger/caliper-core": "^0.1.0" + "@hyperledger/caliper-core": "0.2.0" }, "devDependencies": { "@monax/burrow": "0.23.0", @@ -29,7 +28,7 @@ "mocha": "3.4.2", "nyc": "11.1.0", "rewire": "^4.0.0", - "sinon": "2.3.8", + "sinon": "^7.3.2", "license-check-and-add": "2.3.6" }, "license-check-and-add-config": { @@ -46,6 +45,7 @@ "file_type_method": "EXCLUDE", "file_types": [ ".yml", + ".md", ".log" ], "insert_license": false, @@ -81,11 +81,5 @@ "functions": 7, "lines": 5 }, - "license": "Apache-2.0", - "licenses": [ - { - "type": "Apache-2.0", - "url": "https://github.com/hyperledger/caliper/blob/master/LICENSE" - } - ] + "license": "Apache-2.0" } diff --git a/packages/caliper-cli/README.md b/packages/caliper-cli/README.md new file mode 100644 index 000000000..fb830458a --- /dev/null +++ b/packages/caliper-cli/README.md @@ -0,0 +1,57 @@ +# ![Hyperledger Caliper](https://wiki.hyperledger.org/download/attachments/2392434/Hyperledger_Caliper_Logo_Color.svg?version=1&modificationDate=1548883186000&api=v2) + +[![Build Status](https://travis-ci.org/hyperledger/caliper.svg?branch=master)](https://travis-ci.org/hyperledger/caliper) +[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/2381/badge)](https://bestpractices.coreinfrastructure.org/projects/2381) +[![license](https://img.shields.io/badge/license-Apache%202.0-blue)](https://github.com/aklenik/caliper/blob/master/LICENSE) +[![node (scoped)](https://img.shields.io/node/v/@hyperledger/caliper-cli)](https://www.npmjs.com/package/@hyperledger/caliper-cli) +[![npm (scoped)](https://img.shields.io/npm/v/@hyperledger/caliper-cli?label=version)](https://www.npmjs.com/package/@hyperledger/caliper-cli) +[![npm](https://img.shields.io/npm/dt/@hyperledger/caliper-cli?label=npm%20downloads)](https://www.npmjs.com/package/@hyperledger/caliper-cli) +[![Docker Pulls](https://img.shields.io/docker/pulls/hyperledger/caliper)](https://hub.docker.com/r/hyperledger/caliper) +[![Rocket.Chat](https://img.shields.io/badge/rocket.chat-caliper-red)](https://chat.hyperledger.org/channel/caliper) +[![Mailing list](https://img.shields.io/badge/mailing%20list-caliper-blue)](https://lists.hyperledger.org/g/caliper/topics) + +Welcome to the Hyperledger Caliper project. Caliper is a blockchain performance benchmark framework, which allows users to test different blockchain solutions with predefined use cases, and get a set of performance test results. + +Currently supported blockchain solutions: +* [Hyperledger Fabric v1.X](https://github.com/hyperledger/fabric) +* [Hyperledger Sawtooth 1.0+](https://github.com/hyperledger/sawtooth-core) +* [Hyperledger Iroha 1.0 beta-3](https://github.com/hyperledger/iroha) +* [Hyperledger Burrow 1.0](https://github.com/hyperledger/burrow) +* [Ethereum](https://github.com/ethereum/go-ethereum) +* [Hyperledger Besu](https://github.com/hyperledger/besu), utilizing the Ethereum adapter. +* [FISCO BCOS](https://github.com/FISCO-BCOS/FISCO-BCOS) +* [Hyperledger Composer](https://github.com/hyperledger/composer) support has been deprecated, and will be removed in 0.3.0. + +Currently supported performance indicators: +* Success rate +* Transaction/Read throughput +* Transaction/Read latency (minimum, maximum, average) +* Resource consumption (CPU, Memory, Network IO, ...) + +See the [PSWG white paper](https://www.hyperledger.org/resources/publications/blockchain-performance-metrics) to find out the definitions and corresponding measurement methods. + +For more information on using Caliper, please consult the [documentation site](https://hyperledger.github.io/caliper/) + +## Install and usage +See the [related documentation page](https://hyperledger.github.io/caliper/vLatest/installing-caliper/). + +## How to contact us + +If you have any issues using Caliper that the documentation does not help you solve, please reach out to us through the following methods: +* [RocketChat](https://chat.hyperledger.org/channel/caliper) Please feel free to contact us on Rocket Chat (instant messaging). We monitor that channel as close as possible, but even if you don't have a problem that needs resolving, why not jump on and say hi ... we'd love to hear from you about your experiences and any new features you think we should work on. +* [Issues](https://github.com/hyperledger/caliper/issues) Feel free to raise an issue if you are facing a Caliper related problem + +Caliper interacts with multiple blockchain technologies and consequently it *might* be an issue with the underlying blockchain technology being interacted with. You can seek specific help on these technologies within the following Rocket Chat channels: +* [Hyperledger Besu](https://chat.hyperledger.org/channel/besu) +* [Hyperledger Burrow](https://chat.hyperledger.org/channel/burrow) +* [Hyperledger Composer](https://chat.hyperledger.org/channel/composer) +* [Hyperledger Fabric](https://chat.hyperledger.org/channel/fabric) +* [Hyperledger Iroha](https://chat.hyperledger.org/channel/iroha) +* [Hyperledger Sawtooth](https://chat.hyperledger.org/channel/sawtooth) + +## How to contribute + +We welcome contributions to the Caliper code base. Please see [Contributing](/CONTRIBUTING.md) for more information. + +## License +Hyperledger Project source code files are made available under the Apache License, Version 2.0 (Apache-2.0), located in the [LICENSE](LICENSE) file. Hyperledger Project documentation files are made available under the Creative Commons Attribution 4.0 International License (CC-BY-4.0), available at http://creativecommons.org/licenses/by/4.0/. diff --git a/packages/caliper-cli/package.json b/packages/caliper-cli/package.json index 4b62075f7..ab80ccac3 100644 --- a/packages/caliper-cli/package.json +++ b/packages/caliper-cli/package.json @@ -1,10 +1,11 @@ { "name": "@hyperledger/caliper-cli", "description": "Hyperledger Caliper CLI, for convenience running of a performance benchmark to test blockchain technologies", - "version": "0.1.0", + "version": "0.2.0", "repository": { "type": "git", - "url": "https://github.com/hyperledger/caliper" + "url": "https://github.com/hyperledger/caliper", + "directory": "packages/caliper-cli" }, "bin": { "caliper": "caliper.js" @@ -17,21 +18,20 @@ "lint": "npx eslint .", "nyc": "nyc mocha --recursive -t 10000" }, - "engineStrict": true, "engines": { "node": ">=8.10.0", "npm": ">=5.6.0" }, "dependencies": { - "@hyperledger/caliper-core" : "^0.1.0", - "@hyperledger/caliper-burrow": "^0.1.0", - "@hyperledger/caliper-composer": "^0.1.0", - "@hyperledger/caliper-fabric": "^0.1.0", - "@hyperledger/caliper-iroha": "^0.1.0", - "@hyperledger/caliper-sawtooth": "^0.1.0", - "@hyperledger/caliper-ethereum": "^0.1.0", - "@hyperledger/caliper-fisco-bcos": "^0.1.0", - "chalk": "^1.1.3", + "@hyperledger/caliper-core" : "0.2.0", + "@hyperledger/caliper-burrow": "0.2.0", + "@hyperledger/caliper-composer": "0.2.0", + "@hyperledger/caliper-fabric": "0.2.0", + "@hyperledger/caliper-iroha": "0.2.0", + "@hyperledger/caliper-sawtooth": "0.2.0", + "@hyperledger/caliper-ethereum": "0.2.0", + "@hyperledger/caliper-fisco-bcos": "0.2.0", + "chalk": "1.1.3", "yargs": "10.0.3" }, "devDependencies": { @@ -40,7 +40,7 @@ "mocha": "3.4.2", "nyc": "11.1.0", "rewire": "^4.0.0", - "sinon": "2.3.8", + "sinon": "^7.3.2", "license-check-and-add": "2.3.6" }, "license-check-and-add-config": { @@ -57,6 +57,7 @@ "file_type_method": "EXCLUDE", "file_types": [ ".yml", + ".md", ".log" ], "insert_license": false, @@ -92,11 +93,5 @@ "functions": 7, "lines": 5 }, - "license": "Apache-2.0", - "licenses": [ - { - "type": "Apache-2.0", - "url": "https://github.com/hyperledger/caliper/blob/master/LICENSE" - } - ] + "license": "Apache-2.0" } diff --git a/packages/caliper-composer/README.md b/packages/caliper-composer/README.md new file mode 100644 index 000000000..fb830458a --- /dev/null +++ b/packages/caliper-composer/README.md @@ -0,0 +1,57 @@ +# ![Hyperledger Caliper](https://wiki.hyperledger.org/download/attachments/2392434/Hyperledger_Caliper_Logo_Color.svg?version=1&modificationDate=1548883186000&api=v2) + +[![Build Status](https://travis-ci.org/hyperledger/caliper.svg?branch=master)](https://travis-ci.org/hyperledger/caliper) +[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/2381/badge)](https://bestpractices.coreinfrastructure.org/projects/2381) +[![license](https://img.shields.io/badge/license-Apache%202.0-blue)](https://github.com/aklenik/caliper/blob/master/LICENSE) +[![node (scoped)](https://img.shields.io/node/v/@hyperledger/caliper-cli)](https://www.npmjs.com/package/@hyperledger/caliper-cli) +[![npm (scoped)](https://img.shields.io/npm/v/@hyperledger/caliper-cli?label=version)](https://www.npmjs.com/package/@hyperledger/caliper-cli) +[![npm](https://img.shields.io/npm/dt/@hyperledger/caliper-cli?label=npm%20downloads)](https://www.npmjs.com/package/@hyperledger/caliper-cli) +[![Docker Pulls](https://img.shields.io/docker/pulls/hyperledger/caliper)](https://hub.docker.com/r/hyperledger/caliper) +[![Rocket.Chat](https://img.shields.io/badge/rocket.chat-caliper-red)](https://chat.hyperledger.org/channel/caliper) +[![Mailing list](https://img.shields.io/badge/mailing%20list-caliper-blue)](https://lists.hyperledger.org/g/caliper/topics) + +Welcome to the Hyperledger Caliper project. Caliper is a blockchain performance benchmark framework, which allows users to test different blockchain solutions with predefined use cases, and get a set of performance test results. + +Currently supported blockchain solutions: +* [Hyperledger Fabric v1.X](https://github.com/hyperledger/fabric) +* [Hyperledger Sawtooth 1.0+](https://github.com/hyperledger/sawtooth-core) +* [Hyperledger Iroha 1.0 beta-3](https://github.com/hyperledger/iroha) +* [Hyperledger Burrow 1.0](https://github.com/hyperledger/burrow) +* [Ethereum](https://github.com/ethereum/go-ethereum) +* [Hyperledger Besu](https://github.com/hyperledger/besu), utilizing the Ethereum adapter. +* [FISCO BCOS](https://github.com/FISCO-BCOS/FISCO-BCOS) +* [Hyperledger Composer](https://github.com/hyperledger/composer) support has been deprecated, and will be removed in 0.3.0. + +Currently supported performance indicators: +* Success rate +* Transaction/Read throughput +* Transaction/Read latency (minimum, maximum, average) +* Resource consumption (CPU, Memory, Network IO, ...) + +See the [PSWG white paper](https://www.hyperledger.org/resources/publications/blockchain-performance-metrics) to find out the definitions and corresponding measurement methods. + +For more information on using Caliper, please consult the [documentation site](https://hyperledger.github.io/caliper/) + +## Install and usage +See the [related documentation page](https://hyperledger.github.io/caliper/vLatest/installing-caliper/). + +## How to contact us + +If you have any issues using Caliper that the documentation does not help you solve, please reach out to us through the following methods: +* [RocketChat](https://chat.hyperledger.org/channel/caliper) Please feel free to contact us on Rocket Chat (instant messaging). We monitor that channel as close as possible, but even if you don't have a problem that needs resolving, why not jump on and say hi ... we'd love to hear from you about your experiences and any new features you think we should work on. +* [Issues](https://github.com/hyperledger/caliper/issues) Feel free to raise an issue if you are facing a Caliper related problem + +Caliper interacts with multiple blockchain technologies and consequently it *might* be an issue with the underlying blockchain technology being interacted with. You can seek specific help on these technologies within the following Rocket Chat channels: +* [Hyperledger Besu](https://chat.hyperledger.org/channel/besu) +* [Hyperledger Burrow](https://chat.hyperledger.org/channel/burrow) +* [Hyperledger Composer](https://chat.hyperledger.org/channel/composer) +* [Hyperledger Fabric](https://chat.hyperledger.org/channel/fabric) +* [Hyperledger Iroha](https://chat.hyperledger.org/channel/iroha) +* [Hyperledger Sawtooth](https://chat.hyperledger.org/channel/sawtooth) + +## How to contribute + +We welcome contributions to the Caliper code base. Please see [Contributing](/CONTRIBUTING.md) for more information. + +## License +Hyperledger Project source code files are made available under the Apache License, Version 2.0 (Apache-2.0), located in the [LICENSE](LICENSE) file. Hyperledger Project documentation files are made available under the Creative Commons Attribution 4.0 International License (CC-BY-4.0), available at http://creativecommons.org/licenses/by/4.0/. diff --git a/packages/caliper-composer/package.json b/packages/caliper-composer/package.json index e17304d18..03926466b 100644 --- a/packages/caliper-composer/package.json +++ b/packages/caliper-composer/package.json @@ -1,9 +1,11 @@ { "name": "@hyperledger/caliper-composer", - "version": "0.1.0", + "description": "Hyperledger Composer adaptor for Caliper, enabling the running of performance benchmarks that interact with Composer", + "version": "0.2.0", "repository": { "type": "git", - "url": "https://github.com/hyperledger/caliper" + "url": "https://github.com/hyperledger/caliper", + "directory": "packages/caliper-composer" }, "scripts": { "pretest": "npm run licchk", @@ -12,13 +14,12 @@ "lint": "npx eslint .", "nyc": "nyc mocha --recursive -t 10000" }, - "engineStrict": true, "engines": { "node": ">=8.10.0", "npm": ">=5.6.0" }, "dependencies": { - "@hyperledger/caliper-core": "0.1.0", + "@hyperledger/caliper-core": "0.2.0", "ora": "^1.2.0" }, "devDependencies": { @@ -32,7 +33,7 @@ "mocha": "3.4.2", "nyc": "11.1.0", "rewire": "^4.0.0", - "sinon": "2.3.8", + "sinon": "^7.3.2", "license-check-and-add": "2.3.6" }, "license-check-and-add-config": { @@ -49,6 +50,7 @@ "file_type_method": "EXCLUDE", "file_types": [ ".yml", + ".md", ".log" ], "insert_license": false, @@ -84,11 +86,5 @@ "functions": 7, "lines": 5 }, - "license": "Apache-2.0", - "licenses": [ - { - "type": "Apache-2.0", - "url": "https://github.com/hyperledger/caliper/blob/master/LICENSE" - } - ] + "license": "Apache-2.0" } diff --git a/packages/caliper-core/README.md b/packages/caliper-core/README.md new file mode 100644 index 000000000..fb830458a --- /dev/null +++ b/packages/caliper-core/README.md @@ -0,0 +1,57 @@ +# ![Hyperledger Caliper](https://wiki.hyperledger.org/download/attachments/2392434/Hyperledger_Caliper_Logo_Color.svg?version=1&modificationDate=1548883186000&api=v2) + +[![Build Status](https://travis-ci.org/hyperledger/caliper.svg?branch=master)](https://travis-ci.org/hyperledger/caliper) +[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/2381/badge)](https://bestpractices.coreinfrastructure.org/projects/2381) +[![license](https://img.shields.io/badge/license-Apache%202.0-blue)](https://github.com/aklenik/caliper/blob/master/LICENSE) +[![node (scoped)](https://img.shields.io/node/v/@hyperledger/caliper-cli)](https://www.npmjs.com/package/@hyperledger/caliper-cli) +[![npm (scoped)](https://img.shields.io/npm/v/@hyperledger/caliper-cli?label=version)](https://www.npmjs.com/package/@hyperledger/caliper-cli) +[![npm](https://img.shields.io/npm/dt/@hyperledger/caliper-cli?label=npm%20downloads)](https://www.npmjs.com/package/@hyperledger/caliper-cli) +[![Docker Pulls](https://img.shields.io/docker/pulls/hyperledger/caliper)](https://hub.docker.com/r/hyperledger/caliper) +[![Rocket.Chat](https://img.shields.io/badge/rocket.chat-caliper-red)](https://chat.hyperledger.org/channel/caliper) +[![Mailing list](https://img.shields.io/badge/mailing%20list-caliper-blue)](https://lists.hyperledger.org/g/caliper/topics) + +Welcome to the Hyperledger Caliper project. Caliper is a blockchain performance benchmark framework, which allows users to test different blockchain solutions with predefined use cases, and get a set of performance test results. + +Currently supported blockchain solutions: +* [Hyperledger Fabric v1.X](https://github.com/hyperledger/fabric) +* [Hyperledger Sawtooth 1.0+](https://github.com/hyperledger/sawtooth-core) +* [Hyperledger Iroha 1.0 beta-3](https://github.com/hyperledger/iroha) +* [Hyperledger Burrow 1.0](https://github.com/hyperledger/burrow) +* [Ethereum](https://github.com/ethereum/go-ethereum) +* [Hyperledger Besu](https://github.com/hyperledger/besu), utilizing the Ethereum adapter. +* [FISCO BCOS](https://github.com/FISCO-BCOS/FISCO-BCOS) +* [Hyperledger Composer](https://github.com/hyperledger/composer) support has been deprecated, and will be removed in 0.3.0. + +Currently supported performance indicators: +* Success rate +* Transaction/Read throughput +* Transaction/Read latency (minimum, maximum, average) +* Resource consumption (CPU, Memory, Network IO, ...) + +See the [PSWG white paper](https://www.hyperledger.org/resources/publications/blockchain-performance-metrics) to find out the definitions and corresponding measurement methods. + +For more information on using Caliper, please consult the [documentation site](https://hyperledger.github.io/caliper/) + +## Install and usage +See the [related documentation page](https://hyperledger.github.io/caliper/vLatest/installing-caliper/). + +## How to contact us + +If you have any issues using Caliper that the documentation does not help you solve, please reach out to us through the following methods: +* [RocketChat](https://chat.hyperledger.org/channel/caliper) Please feel free to contact us on Rocket Chat (instant messaging). We monitor that channel as close as possible, but even if you don't have a problem that needs resolving, why not jump on and say hi ... we'd love to hear from you about your experiences and any new features you think we should work on. +* [Issues](https://github.com/hyperledger/caliper/issues) Feel free to raise an issue if you are facing a Caliper related problem + +Caliper interacts with multiple blockchain technologies and consequently it *might* be an issue with the underlying blockchain technology being interacted with. You can seek specific help on these technologies within the following Rocket Chat channels: +* [Hyperledger Besu](https://chat.hyperledger.org/channel/besu) +* [Hyperledger Burrow](https://chat.hyperledger.org/channel/burrow) +* [Hyperledger Composer](https://chat.hyperledger.org/channel/composer) +* [Hyperledger Fabric](https://chat.hyperledger.org/channel/fabric) +* [Hyperledger Iroha](https://chat.hyperledger.org/channel/iroha) +* [Hyperledger Sawtooth](https://chat.hyperledger.org/channel/sawtooth) + +## How to contribute + +We welcome contributions to the Caliper code base. Please see [Contributing](/CONTRIBUTING.md) for more information. + +## License +Hyperledger Project source code files are made available under the Apache License, Version 2.0 (Apache-2.0), located in the [LICENSE](LICENSE) file. Hyperledger Project documentation files are made available under the Creative Commons Attribution 4.0 International License (CC-BY-4.0), available at http://creativecommons.org/licenses/by/4.0/. diff --git a/packages/caliper-core/package.json b/packages/caliper-core/package.json index 0b8ed89d9..845a5fc1c 100644 --- a/packages/caliper-core/package.json +++ b/packages/caliper-core/package.json @@ -1,10 +1,11 @@ { "name": "@hyperledger/caliper-core", "description": "Core Hyperledger Caliper module, used for running performance benchmarks that interact with blockchain technologies", - "version": "0.1.0", + "version": "0.2.0", "repository": { "type": "git", - "url": "https://github.com/hyperledger/caliper" + "url": "https://github.com/hyperledger/caliper", + "directory": "packages/caliper-core" }, "scripts": { "pretest": "npm run licchk", @@ -13,7 +14,6 @@ "lint": "npx eslint .", "nyc": "nyc mocha --recursive -t 10000" }, - "engineStrict": true, "engines": { "node": ">=8.10.0", "npm": ">=5.6.0" @@ -102,11 +102,5 @@ "functions": 1, "lines": 1 }, - "license": "Apache-2.0", - "licenses": [ - { - "type": "Apache-2.0", - "url": "https://github.com/hyperledger/caliper/blob/master/LICENSE" - } - ] + "license": "Apache-2.0" } diff --git a/packages/caliper-ethereum/README.md b/packages/caliper-ethereum/README.md new file mode 100644 index 000000000..fb830458a --- /dev/null +++ b/packages/caliper-ethereum/README.md @@ -0,0 +1,57 @@ +# ![Hyperledger Caliper](https://wiki.hyperledger.org/download/attachments/2392434/Hyperledger_Caliper_Logo_Color.svg?version=1&modificationDate=1548883186000&api=v2) + +[![Build Status](https://travis-ci.org/hyperledger/caliper.svg?branch=master)](https://travis-ci.org/hyperledger/caliper) +[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/2381/badge)](https://bestpractices.coreinfrastructure.org/projects/2381) +[![license](https://img.shields.io/badge/license-Apache%202.0-blue)](https://github.com/aklenik/caliper/blob/master/LICENSE) +[![node (scoped)](https://img.shields.io/node/v/@hyperledger/caliper-cli)](https://www.npmjs.com/package/@hyperledger/caliper-cli) +[![npm (scoped)](https://img.shields.io/npm/v/@hyperledger/caliper-cli?label=version)](https://www.npmjs.com/package/@hyperledger/caliper-cli) +[![npm](https://img.shields.io/npm/dt/@hyperledger/caliper-cli?label=npm%20downloads)](https://www.npmjs.com/package/@hyperledger/caliper-cli) +[![Docker Pulls](https://img.shields.io/docker/pulls/hyperledger/caliper)](https://hub.docker.com/r/hyperledger/caliper) +[![Rocket.Chat](https://img.shields.io/badge/rocket.chat-caliper-red)](https://chat.hyperledger.org/channel/caliper) +[![Mailing list](https://img.shields.io/badge/mailing%20list-caliper-blue)](https://lists.hyperledger.org/g/caliper/topics) + +Welcome to the Hyperledger Caliper project. Caliper is a blockchain performance benchmark framework, which allows users to test different blockchain solutions with predefined use cases, and get a set of performance test results. + +Currently supported blockchain solutions: +* [Hyperledger Fabric v1.X](https://github.com/hyperledger/fabric) +* [Hyperledger Sawtooth 1.0+](https://github.com/hyperledger/sawtooth-core) +* [Hyperledger Iroha 1.0 beta-3](https://github.com/hyperledger/iroha) +* [Hyperledger Burrow 1.0](https://github.com/hyperledger/burrow) +* [Ethereum](https://github.com/ethereum/go-ethereum) +* [Hyperledger Besu](https://github.com/hyperledger/besu), utilizing the Ethereum adapter. +* [FISCO BCOS](https://github.com/FISCO-BCOS/FISCO-BCOS) +* [Hyperledger Composer](https://github.com/hyperledger/composer) support has been deprecated, and will be removed in 0.3.0. + +Currently supported performance indicators: +* Success rate +* Transaction/Read throughput +* Transaction/Read latency (minimum, maximum, average) +* Resource consumption (CPU, Memory, Network IO, ...) + +See the [PSWG white paper](https://www.hyperledger.org/resources/publications/blockchain-performance-metrics) to find out the definitions and corresponding measurement methods. + +For more information on using Caliper, please consult the [documentation site](https://hyperledger.github.io/caliper/) + +## Install and usage +See the [related documentation page](https://hyperledger.github.io/caliper/vLatest/installing-caliper/). + +## How to contact us + +If you have any issues using Caliper that the documentation does not help you solve, please reach out to us through the following methods: +* [RocketChat](https://chat.hyperledger.org/channel/caliper) Please feel free to contact us on Rocket Chat (instant messaging). We monitor that channel as close as possible, but even if you don't have a problem that needs resolving, why not jump on and say hi ... we'd love to hear from you about your experiences and any new features you think we should work on. +* [Issues](https://github.com/hyperledger/caliper/issues) Feel free to raise an issue if you are facing a Caliper related problem + +Caliper interacts with multiple blockchain technologies and consequently it *might* be an issue with the underlying blockchain technology being interacted with. You can seek specific help on these technologies within the following Rocket Chat channels: +* [Hyperledger Besu](https://chat.hyperledger.org/channel/besu) +* [Hyperledger Burrow](https://chat.hyperledger.org/channel/burrow) +* [Hyperledger Composer](https://chat.hyperledger.org/channel/composer) +* [Hyperledger Fabric](https://chat.hyperledger.org/channel/fabric) +* [Hyperledger Iroha](https://chat.hyperledger.org/channel/iroha) +* [Hyperledger Sawtooth](https://chat.hyperledger.org/channel/sawtooth) + +## How to contribute + +We welcome contributions to the Caliper code base. Please see [Contributing](/CONTRIBUTING.md) for more information. + +## License +Hyperledger Project source code files are made available under the Apache License, Version 2.0 (Apache-2.0), located in the [LICENSE](LICENSE) file. Hyperledger Project documentation files are made available under the Creative Commons Attribution 4.0 International License (CC-BY-4.0), available at http://creativecommons.org/licenses/by/4.0/. diff --git a/packages/caliper-ethereum/index.js b/packages/caliper-ethereum/index.js index eadf46894..e2c14574b 100644 --- a/packages/caliper-ethereum/index.js +++ b/packages/caliper-ethereum/index.js @@ -1,16 +1,16 @@ /* - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ 'use strict'; diff --git a/packages/caliper-ethereum/lib/ethereum.js b/packages/caliper-ethereum/lib/ethereum.js index 738c9c69b..9f46c7b41 100644 --- a/packages/caliper-ethereum/lib/ethereum.js +++ b/packages/caliper-ethereum/lib/ethereum.js @@ -1,18 +1,16 @@ -/** - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * @file, definition of the Ethereum class, which implements the Caliper's NBI for Ethereum Web3 interface. - */ +/* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ 'use strict'; diff --git a/packages/caliper-ethereum/lib/ethereumClientFactory.js b/packages/caliper-ethereum/lib/ethereumClientFactory.js index 073573763..3aa499929 100644 --- a/packages/caliper-ethereum/lib/ethereumClientFactory.js +++ b/packages/caliper-ethereum/lib/ethereumClientFactory.js @@ -1,18 +1,16 @@ -/** - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * @file, definition of the Ethereum client factory - */ +/* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ 'use strict'; diff --git a/packages/caliper-ethereum/lib/ethereumClientWorker.js b/packages/caliper-ethereum/lib/ethereumClientWorker.js index c81c25840..d189ade14 100644 --- a/packages/caliper-ethereum/lib/ethereumClientWorker.js +++ b/packages/caliper-ethereum/lib/ethereumClientWorker.js @@ -1,18 +1,16 @@ -/** - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * @file, definition of the Ethereum client worker - */ +/* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ 'use strict'; diff --git a/packages/caliper-ethereum/package.json b/packages/caliper-ethereum/package.json index 086305d12..89f27cf9b 100644 --- a/packages/caliper-ethereum/package.json +++ b/packages/caliper-ethereum/package.json @@ -1,11 +1,15 @@ { "name": "@hyperledger/caliper-ethereum", - "version": "0.1.0", + "description": "Ethereum adaptor for Caliper, enabling the running of performance benchmarks that interact with Ethereum", + "version": "0.2.0", "repository": { "type": "git", - "url": "https://github.com/hyperledger/caliper" + "url": "https://github.com/hyperledger/caliper", + "directory": "packages/caliper-ethereum" }, "scripts": { + "pretest": "npm run licchk", + "licchk": "license-check-and-add", "test": "npm run lint", "lint": "npx eslint .", "nyc": "nyc mocha --recursive -t 10000" @@ -14,14 +18,8 @@ "node": ">=8.10.0", "npm": ">=5.6.0" }, - "engine-strict": true, - "engineStrict": true, - "files": [ - "*", - "src/comm/template/report.html" - ], "dependencies": { - "@hyperledger/caliper-core": "0.1.0" + "@hyperledger/caliper-core": "0.2.0" }, "devDependencies": { "web3": "^1.2.0", @@ -30,7 +28,8 @@ "mocha": "3.4.2", "nyc": "11.1.0", "rewire": "^4.0.0", - "sinon": "2.3.8" + "sinon": "^7.3.2", + "license-check-and-add": "2.3.6" }, "license-check-and-add-config": { "folder": ".", @@ -39,11 +38,15 @@ "exact_paths": [ "node_modules", ".nyc_output", - "coverage" + "coverage", + ".gitignore", + "log" ], "file_type_method": "EXCLUDE", "file_types": [ - ".yml" + ".yml", + ".md", + "log" ], "insert_license": false, "license_formats": { @@ -78,11 +81,5 @@ "functions": 7, "lines": 5 }, - "license": "Apache-2.0", - "licenses": [ - { - "type": "Apache-2.0", - "url": "https://github.com/hyperledger/caliper/blob/master/LICENSE" - } - ] + "license": "Apache-2.0" } diff --git a/packages/caliper-fabric/README.md b/packages/caliper-fabric/README.md new file mode 100644 index 000000000..fb830458a --- /dev/null +++ b/packages/caliper-fabric/README.md @@ -0,0 +1,57 @@ +# ![Hyperledger Caliper](https://wiki.hyperledger.org/download/attachments/2392434/Hyperledger_Caliper_Logo_Color.svg?version=1&modificationDate=1548883186000&api=v2) + +[![Build Status](https://travis-ci.org/hyperledger/caliper.svg?branch=master)](https://travis-ci.org/hyperledger/caliper) +[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/2381/badge)](https://bestpractices.coreinfrastructure.org/projects/2381) +[![license](https://img.shields.io/badge/license-Apache%202.0-blue)](https://github.com/aklenik/caliper/blob/master/LICENSE) +[![node (scoped)](https://img.shields.io/node/v/@hyperledger/caliper-cli)](https://www.npmjs.com/package/@hyperledger/caliper-cli) +[![npm (scoped)](https://img.shields.io/npm/v/@hyperledger/caliper-cli?label=version)](https://www.npmjs.com/package/@hyperledger/caliper-cli) +[![npm](https://img.shields.io/npm/dt/@hyperledger/caliper-cli?label=npm%20downloads)](https://www.npmjs.com/package/@hyperledger/caliper-cli) +[![Docker Pulls](https://img.shields.io/docker/pulls/hyperledger/caliper)](https://hub.docker.com/r/hyperledger/caliper) +[![Rocket.Chat](https://img.shields.io/badge/rocket.chat-caliper-red)](https://chat.hyperledger.org/channel/caliper) +[![Mailing list](https://img.shields.io/badge/mailing%20list-caliper-blue)](https://lists.hyperledger.org/g/caliper/topics) + +Welcome to the Hyperledger Caliper project. Caliper is a blockchain performance benchmark framework, which allows users to test different blockchain solutions with predefined use cases, and get a set of performance test results. + +Currently supported blockchain solutions: +* [Hyperledger Fabric v1.X](https://github.com/hyperledger/fabric) +* [Hyperledger Sawtooth 1.0+](https://github.com/hyperledger/sawtooth-core) +* [Hyperledger Iroha 1.0 beta-3](https://github.com/hyperledger/iroha) +* [Hyperledger Burrow 1.0](https://github.com/hyperledger/burrow) +* [Ethereum](https://github.com/ethereum/go-ethereum) +* [Hyperledger Besu](https://github.com/hyperledger/besu), utilizing the Ethereum adapter. +* [FISCO BCOS](https://github.com/FISCO-BCOS/FISCO-BCOS) +* [Hyperledger Composer](https://github.com/hyperledger/composer) support has been deprecated, and will be removed in 0.3.0. + +Currently supported performance indicators: +* Success rate +* Transaction/Read throughput +* Transaction/Read latency (minimum, maximum, average) +* Resource consumption (CPU, Memory, Network IO, ...) + +See the [PSWG white paper](https://www.hyperledger.org/resources/publications/blockchain-performance-metrics) to find out the definitions and corresponding measurement methods. + +For more information on using Caliper, please consult the [documentation site](https://hyperledger.github.io/caliper/) + +## Install and usage +See the [related documentation page](https://hyperledger.github.io/caliper/vLatest/installing-caliper/). + +## How to contact us + +If you have any issues using Caliper that the documentation does not help you solve, please reach out to us through the following methods: +* [RocketChat](https://chat.hyperledger.org/channel/caliper) Please feel free to contact us on Rocket Chat (instant messaging). We monitor that channel as close as possible, but even if you don't have a problem that needs resolving, why not jump on and say hi ... we'd love to hear from you about your experiences and any new features you think we should work on. +* [Issues](https://github.com/hyperledger/caliper/issues) Feel free to raise an issue if you are facing a Caliper related problem + +Caliper interacts with multiple blockchain technologies and consequently it *might* be an issue with the underlying blockchain technology being interacted with. You can seek specific help on these technologies within the following Rocket Chat channels: +* [Hyperledger Besu](https://chat.hyperledger.org/channel/besu) +* [Hyperledger Burrow](https://chat.hyperledger.org/channel/burrow) +* [Hyperledger Composer](https://chat.hyperledger.org/channel/composer) +* [Hyperledger Fabric](https://chat.hyperledger.org/channel/fabric) +* [Hyperledger Iroha](https://chat.hyperledger.org/channel/iroha) +* [Hyperledger Sawtooth](https://chat.hyperledger.org/channel/sawtooth) + +## How to contribute + +We welcome contributions to the Caliper code base. Please see [Contributing](/CONTRIBUTING.md) for more information. + +## License +Hyperledger Project source code files are made available under the Apache License, Version 2.0 (Apache-2.0), located in the [LICENSE](LICENSE) file. Hyperledger Project documentation files are made available under the Creative Commons Attribution 4.0 International License (CC-BY-4.0), available at http://creativecommons.org/licenses/by/4.0/. diff --git a/packages/caliper-fabric/package.json b/packages/caliper-fabric/package.json index 2339eefcf..845cc2ca6 100644 --- a/packages/caliper-fabric/package.json +++ b/packages/caliper-fabric/package.json @@ -1,10 +1,11 @@ { "name": "@hyperledger/caliper-fabric", - "description": "Hyperledger Fabric adaptor for Caliper, enabling the running of a performance benchmarks that interact with Fabric", - "version": "0.1.0", + "description": "Hyperledger Fabric adaptor for Caliper, enabling the running of performance benchmarks that interact with Fabric", + "version": "0.2.0", "repository": { "type": "git", - "url": "https://github.com/hyperledger/caliper" + "url": "https://github.com/hyperledger/caliper", + "directory": "packages/caliper-fabric" }, "scripts": { "pretest": "npm run licchk", @@ -13,18 +14,13 @@ "lint": "npx eslint .", "nyc": "nyc mocha --recursive -t 10000" }, - "engineStrict": true, "engines": { "node": ">=8.10.0", "npm": ">=5.6.0" }, - "files": [ - "*", - "src/comm/template/report.html" - ], "dependencies": { "@hapi/joi": "^15.1.1", - "@hyperledger/caliper-core": "0.1.0" + "@hyperledger/caliper-core": "0.2.0" }, "devDependencies": { "fabric-ca-client": "^1.4.0", @@ -36,7 +32,7 @@ "mocha": "3.4.2", "nyc": "11.1.0", "rewire": "^4.0.0", - "sinon": "2.3.8", + "sinon": "^7.3.2", "license-check-and-add": "2.3.6" }, "license-check-and-add-config": { @@ -53,6 +49,7 @@ "file_type_method": "EXCLUDE", "file_types": [ ".yml", + ".md", ".log" ], "insert_license": false, @@ -88,11 +85,5 @@ "functions": 1, "lines": 1 }, - "license": "Apache-2.0", - "licenses": [ - { - "type": "Apache-2.0", - "url": "https://github.com/hyperledger/caliper/blob/master/LICENSE" - } - ] + "license": "Apache-2.0" } diff --git a/packages/caliper-fisco-bcos/package.json b/packages/caliper-fisco-bcos/package.json index 60c8eb9d9..1c22e69d8 100644 --- a/packages/caliper-fisco-bcos/package.json +++ b/packages/caliper-fisco-bcos/package.json @@ -1,6 +1,6 @@ { "name": "@hyperledger/caliper-fisco-bcos", - "version": "0.1.0", + "version": "0.2.0", "description": "FISCO BCOS adaptor for Caliper, enabling the running of a performance benchmarks that interact with FISCO BCOS", "repository": { "type": "git", @@ -19,7 +19,7 @@ "npm": ">=5.6.0" }, "dependencies": { - "@hyperledger/caliper-core": "0.1.0", + "@hyperledger/caliper-core": "0.2.0", "nconf": "^0.10.0", "isarray": "^2.0.4", "fs-extra": "^8.0.1", diff --git a/packages/caliper-iroha/README.md b/packages/caliper-iroha/README.md new file mode 100644 index 000000000..fb830458a --- /dev/null +++ b/packages/caliper-iroha/README.md @@ -0,0 +1,57 @@ +# ![Hyperledger Caliper](https://wiki.hyperledger.org/download/attachments/2392434/Hyperledger_Caliper_Logo_Color.svg?version=1&modificationDate=1548883186000&api=v2) + +[![Build Status](https://travis-ci.org/hyperledger/caliper.svg?branch=master)](https://travis-ci.org/hyperledger/caliper) +[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/2381/badge)](https://bestpractices.coreinfrastructure.org/projects/2381) +[![license](https://img.shields.io/badge/license-Apache%202.0-blue)](https://github.com/aklenik/caliper/blob/master/LICENSE) +[![node (scoped)](https://img.shields.io/node/v/@hyperledger/caliper-cli)](https://www.npmjs.com/package/@hyperledger/caliper-cli) +[![npm (scoped)](https://img.shields.io/npm/v/@hyperledger/caliper-cli?label=version)](https://www.npmjs.com/package/@hyperledger/caliper-cli) +[![npm](https://img.shields.io/npm/dt/@hyperledger/caliper-cli?label=npm%20downloads)](https://www.npmjs.com/package/@hyperledger/caliper-cli) +[![Docker Pulls](https://img.shields.io/docker/pulls/hyperledger/caliper)](https://hub.docker.com/r/hyperledger/caliper) +[![Rocket.Chat](https://img.shields.io/badge/rocket.chat-caliper-red)](https://chat.hyperledger.org/channel/caliper) +[![Mailing list](https://img.shields.io/badge/mailing%20list-caliper-blue)](https://lists.hyperledger.org/g/caliper/topics) + +Welcome to the Hyperledger Caliper project. Caliper is a blockchain performance benchmark framework, which allows users to test different blockchain solutions with predefined use cases, and get a set of performance test results. + +Currently supported blockchain solutions: +* [Hyperledger Fabric v1.X](https://github.com/hyperledger/fabric) +* [Hyperledger Sawtooth 1.0+](https://github.com/hyperledger/sawtooth-core) +* [Hyperledger Iroha 1.0 beta-3](https://github.com/hyperledger/iroha) +* [Hyperledger Burrow 1.0](https://github.com/hyperledger/burrow) +* [Ethereum](https://github.com/ethereum/go-ethereum) +* [Hyperledger Besu](https://github.com/hyperledger/besu), utilizing the Ethereum adapter. +* [FISCO BCOS](https://github.com/FISCO-BCOS/FISCO-BCOS) +* [Hyperledger Composer](https://github.com/hyperledger/composer) support has been deprecated, and will be removed in 0.3.0. + +Currently supported performance indicators: +* Success rate +* Transaction/Read throughput +* Transaction/Read latency (minimum, maximum, average) +* Resource consumption (CPU, Memory, Network IO, ...) + +See the [PSWG white paper](https://www.hyperledger.org/resources/publications/blockchain-performance-metrics) to find out the definitions and corresponding measurement methods. + +For more information on using Caliper, please consult the [documentation site](https://hyperledger.github.io/caliper/) + +## Install and usage +See the [related documentation page](https://hyperledger.github.io/caliper/vLatest/installing-caliper/). + +## How to contact us + +If you have any issues using Caliper that the documentation does not help you solve, please reach out to us through the following methods: +* [RocketChat](https://chat.hyperledger.org/channel/caliper) Please feel free to contact us on Rocket Chat (instant messaging). We monitor that channel as close as possible, but even if you don't have a problem that needs resolving, why not jump on and say hi ... we'd love to hear from you about your experiences and any new features you think we should work on. +* [Issues](https://github.com/hyperledger/caliper/issues) Feel free to raise an issue if you are facing a Caliper related problem + +Caliper interacts with multiple blockchain technologies and consequently it *might* be an issue with the underlying blockchain technology being interacted with. You can seek specific help on these technologies within the following Rocket Chat channels: +* [Hyperledger Besu](https://chat.hyperledger.org/channel/besu) +* [Hyperledger Burrow](https://chat.hyperledger.org/channel/burrow) +* [Hyperledger Composer](https://chat.hyperledger.org/channel/composer) +* [Hyperledger Fabric](https://chat.hyperledger.org/channel/fabric) +* [Hyperledger Iroha](https://chat.hyperledger.org/channel/iroha) +* [Hyperledger Sawtooth](https://chat.hyperledger.org/channel/sawtooth) + +## How to contribute + +We welcome contributions to the Caliper code base. Please see [Contributing](/CONTRIBUTING.md) for more information. + +## License +Hyperledger Project source code files are made available under the Apache License, Version 2.0 (Apache-2.0), located in the [LICENSE](LICENSE) file. Hyperledger Project documentation files are made available under the Creative Commons Attribution 4.0 International License (CC-BY-4.0), available at http://creativecommons.org/licenses/by/4.0/. diff --git a/packages/caliper-iroha/package.json b/packages/caliper-iroha/package.json index eacdd50f1..727e90598 100644 --- a/packages/caliper-iroha/package.json +++ b/packages/caliper-iroha/package.json @@ -1,10 +1,11 @@ { "name": "@hyperledger/caliper-iroha", - "description": "Hyperledger Iroha adaptor for Caliper, enabling the running of a performance benchmarks that interact with Iroha", - "version": "0.1.0", + "description": "Hyperledger Iroha adaptor for Caliper, enabling the running of performance benchmarks that interact with Iroha", + "version": "0.2.0", "repository": { "type": "git", - "url": "https://github.com/hyperledger/caliper" + "url": "https://github.com/hyperledger/caliper", + "directory": "packages/caliper-iroha" }, "scripts": { "pretest": "npm run licchk", @@ -17,10 +18,8 @@ "node": ">=8.10.0", "npm": ">=5.6.0" }, - "engine-strict": true, - "engineStrict": true, "dependencies": { - "@hyperledger/caliper-core": "0.1.0" + "@hyperledger/caliper-core": "0.2.0" }, "devDependencies": { "iroha-helpers": "0.6.3", @@ -29,7 +28,7 @@ "mocha": "3.4.2", "nyc": "11.1.0", "rewire": "^4.0.0", - "sinon": "2.3.8", + "sinon": "^7.3.2", "license-check-and-add": "2.3.6" }, "license-check-and-add-config": { @@ -46,6 +45,7 @@ "file_type_method": "EXCLUDE", "file_types": [ ".yml", + ".md", ".log" ], "insert_license": false, @@ -81,11 +81,5 @@ "functions": 7, "lines": 5 }, - "license": "Apache-2.0", - "licenses": [ - { - "type": "Apache-2.0", - "url": "https://github.com/hyperledger/caliper/blob/master/LICENSE" - } - ] + "license": "Apache-2.0" } diff --git a/packages/caliper-sawtooth/README.md b/packages/caliper-sawtooth/README.md new file mode 100644 index 000000000..fb830458a --- /dev/null +++ b/packages/caliper-sawtooth/README.md @@ -0,0 +1,57 @@ +# ![Hyperledger Caliper](https://wiki.hyperledger.org/download/attachments/2392434/Hyperledger_Caliper_Logo_Color.svg?version=1&modificationDate=1548883186000&api=v2) + +[![Build Status](https://travis-ci.org/hyperledger/caliper.svg?branch=master)](https://travis-ci.org/hyperledger/caliper) +[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/2381/badge)](https://bestpractices.coreinfrastructure.org/projects/2381) +[![license](https://img.shields.io/badge/license-Apache%202.0-blue)](https://github.com/aklenik/caliper/blob/master/LICENSE) +[![node (scoped)](https://img.shields.io/node/v/@hyperledger/caliper-cli)](https://www.npmjs.com/package/@hyperledger/caliper-cli) +[![npm (scoped)](https://img.shields.io/npm/v/@hyperledger/caliper-cli?label=version)](https://www.npmjs.com/package/@hyperledger/caliper-cli) +[![npm](https://img.shields.io/npm/dt/@hyperledger/caliper-cli?label=npm%20downloads)](https://www.npmjs.com/package/@hyperledger/caliper-cli) +[![Docker Pulls](https://img.shields.io/docker/pulls/hyperledger/caliper)](https://hub.docker.com/r/hyperledger/caliper) +[![Rocket.Chat](https://img.shields.io/badge/rocket.chat-caliper-red)](https://chat.hyperledger.org/channel/caliper) +[![Mailing list](https://img.shields.io/badge/mailing%20list-caliper-blue)](https://lists.hyperledger.org/g/caliper/topics) + +Welcome to the Hyperledger Caliper project. Caliper is a blockchain performance benchmark framework, which allows users to test different blockchain solutions with predefined use cases, and get a set of performance test results. + +Currently supported blockchain solutions: +* [Hyperledger Fabric v1.X](https://github.com/hyperledger/fabric) +* [Hyperledger Sawtooth 1.0+](https://github.com/hyperledger/sawtooth-core) +* [Hyperledger Iroha 1.0 beta-3](https://github.com/hyperledger/iroha) +* [Hyperledger Burrow 1.0](https://github.com/hyperledger/burrow) +* [Ethereum](https://github.com/ethereum/go-ethereum) +* [Hyperledger Besu](https://github.com/hyperledger/besu), utilizing the Ethereum adapter. +* [FISCO BCOS](https://github.com/FISCO-BCOS/FISCO-BCOS) +* [Hyperledger Composer](https://github.com/hyperledger/composer) support has been deprecated, and will be removed in 0.3.0. + +Currently supported performance indicators: +* Success rate +* Transaction/Read throughput +* Transaction/Read latency (minimum, maximum, average) +* Resource consumption (CPU, Memory, Network IO, ...) + +See the [PSWG white paper](https://www.hyperledger.org/resources/publications/blockchain-performance-metrics) to find out the definitions and corresponding measurement methods. + +For more information on using Caliper, please consult the [documentation site](https://hyperledger.github.io/caliper/) + +## Install and usage +See the [related documentation page](https://hyperledger.github.io/caliper/vLatest/installing-caliper/). + +## How to contact us + +If you have any issues using Caliper that the documentation does not help you solve, please reach out to us through the following methods: +* [RocketChat](https://chat.hyperledger.org/channel/caliper) Please feel free to contact us on Rocket Chat (instant messaging). We monitor that channel as close as possible, but even if you don't have a problem that needs resolving, why not jump on and say hi ... we'd love to hear from you about your experiences and any new features you think we should work on. +* [Issues](https://github.com/hyperledger/caliper/issues) Feel free to raise an issue if you are facing a Caliper related problem + +Caliper interacts with multiple blockchain technologies and consequently it *might* be an issue with the underlying blockchain technology being interacted with. You can seek specific help on these technologies within the following Rocket Chat channels: +* [Hyperledger Besu](https://chat.hyperledger.org/channel/besu) +* [Hyperledger Burrow](https://chat.hyperledger.org/channel/burrow) +* [Hyperledger Composer](https://chat.hyperledger.org/channel/composer) +* [Hyperledger Fabric](https://chat.hyperledger.org/channel/fabric) +* [Hyperledger Iroha](https://chat.hyperledger.org/channel/iroha) +* [Hyperledger Sawtooth](https://chat.hyperledger.org/channel/sawtooth) + +## How to contribute + +We welcome contributions to the Caliper code base. Please see [Contributing](/CONTRIBUTING.md) for more information. + +## License +Hyperledger Project source code files are made available under the Apache License, Version 2.0 (Apache-2.0), located in the [LICENSE](LICENSE) file. Hyperledger Project documentation files are made available under the Creative Commons Attribution 4.0 International License (CC-BY-4.0), available at http://creativecommons.org/licenses/by/4.0/. diff --git a/packages/caliper-sawtooth/package.json b/packages/caliper-sawtooth/package.json index 4e673f6d9..802db0d2f 100644 --- a/packages/caliper-sawtooth/package.json +++ b/packages/caliper-sawtooth/package.json @@ -1,10 +1,11 @@ { "name": "@hyperledger/caliper-sawtooth", - "description": "Hyperledger Sawtooth adaptor for Caliper, enabling the running of a performance benchmarks that interact with Sawtooth", - "version": "0.1.0", + "description": "Hyperledger Sawtooth adaptor for Caliper, enabling the running of performance benchmarks that interact with Sawtooth", + "version": "0.2.0", "repository": { "type": "git", - "url": "https://github.com/hyperledger/caliper" + "url": "https://github.com/hyperledger/caliper", + "directory": "packages/caliper-sawtooth" }, "scripts": { "pretest": "npm run licchk", @@ -13,13 +14,12 @@ "lint": "npx eslint .", "nyc": "nyc mocha --recursive -t 10000" }, - "engineStrict": true, "engines": { "node": ">=8.10.0", "npm": ">=5.6.0" }, "dependencies": { - "@hyperledger/caliper-core": "0.1.0", + "@hyperledger/caliper-core": "0.2.0", "request-promise": "^4.2.1", "protocol-buffers": "^4.1.0" }, @@ -30,7 +30,7 @@ "mocha": "3.4.2", "nyc": "11.1.0", "rewire": "^4.0.0", - "sinon": "2.3.8", + "sinon": "^7.3.2", "license-check-and-add": "2.3.6" }, "license-check-and-add-config": { @@ -47,6 +47,7 @@ "file_type_method": "EXCLUDE", "file_types": [ ".yml", + ".md", ".log" ], "insert_license": false, @@ -82,11 +83,5 @@ "functions": 7, "lines": 5 }, - "license": "Apache-2.0", - "licenses": [ - { - "type": "Apache-2.0", - "url": "https://github.com/hyperledger/caliper/blob/master/LICENSE" - } - ] + "license": "Apache-2.0" } diff --git a/packages/caliper-tests-integration/package.json b/packages/caliper-tests-integration/package.json index ed27cb948..ac11e12ba 100644 --- a/packages/caliper-tests-integration/package.json +++ b/packages/caliper-tests-integration/package.json @@ -1,6 +1,6 @@ { "name": "caliper-tests-integration", - "version": "0.1.0", + "version": "0.2.0", "description": "Integration tests for Hyperledger Caliper", "scripts": { "cleanup": "./scripts/cleanup.sh", @@ -35,15 +35,15 @@ "license-check-and-add": "2.3.6" }, "dependencies": { - "@hyperledger/caliper-cli" : "0.1.0", - "@hyperledger/caliper-core" : "0.1.0", - "@hyperledger/caliper-burrow": "0.1.0", - "@hyperledger/caliper-composer": "0.1.0", - "@hyperledger/caliper-fabric": "0.1.0", - "@hyperledger/caliper-iroha": "0.1.0", - "@hyperledger/caliper-sawtooth": "0.1.0", - "@hyperledger/caliper-ethereum": "0.1.0", - "@hyperledger/caliper-fisco-bcos": "0.1.0" + "@hyperledger/caliper-burrow": "0.2.0", + "@hyperledger/caliper-cli": "0.2.0", + "@hyperledger/caliper-composer": "0.2.0", + "@hyperledger/caliper-core": "0.2.0", + "@hyperledger/caliper-ethereum": "0.2.0", + "@hyperledger/caliper-fabric": "0.2.0", + "@hyperledger/caliper-fisco-bcos": "0.2.0", + "@hyperledger/caliper-iroha": "0.2.0", + "@hyperledger/caliper-sawtooth": "0.2.0" }, "license-check-and-add-config": { "folder": ".", @@ -62,6 +62,7 @@ "fabric_tests/config/.gitignore", "fabric_tests/config/bin", "fabric_tests/config/config", + "fabric_tests/config/crypto-config", "composer_tests/.gitignore", "composer_tests/config/.gitignore", "composer_tests/config/bin",