Merge pull request #615 from aklenik/release-0.2.0

[Release 0.2.0] Preparing packages for release
hyperledger-caliper · Oct 25, 2019 · b236ce3 · b236ce3
2 parents 5520b01 + b1c99c7
commit b236ce3
Show file tree

Hide file tree

Showing 26 changed files with 639 additions and 213 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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/.