Hyperledger Caliper for Peerplays (#2)

* Caliper v0.4.0, d9f2cc8cf9419d9b7c06c4c91077514d27d3b546
* Peerplays connector
* Docker img for private network, connector and workload fixes
* Peerplays connector fixes and integration tests
* Peerplays integration tests for read-only calls
* Peerplays integration tests for transactions
* Improvements to support both mainnet and testnet
* Develop branch tests

Author: obucina

caliper-peerplays-tests/.gitignore

@@ -0,0 +1,4 @@
+**/node_modules/
+**/*.log
+**/report.html
+package-lock.json

caliper-peerplays-tests/README.md

@@ -0,0 +1,21 @@
+# Hyperledger Caliper tests for Peerplays
+
+## Initializing
+To initialize test environment, run
+```
+npm i
+```
+Test environment uses packages from ../caliper-peerplays
+
+## Running tests
+
+Run basic-private-net tests.
+This test is the same as Hyperledger Caliper integration test
+```
+BENCHMARK=basic-private-net ./run-tests.sh
+```
+
+Run develop-private-net tests.
+```
+BENCHMARK=develop-private-net ./run-tests.sh
+```

caliper-peerplays-tests/develop-private-net_tests/benchconfig.yaml

@@ -0,0 +1,34 @@
+#
+# 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.
+#
+
+test:
+    workers:
+        type: local
+        number: 2
+    rounds:
+    - label: claim_balance
+      txNumber: 1
+      rateControl: { type: 'fixed-rate', opts: { tps: 1 } }
+      workload:
+          module: ./claim_balance.js
+    - label: query
+      txNumber: 200
+      rateControl: { type: 'fixed-feedback-rate', opts: { tps: 10, maximum_transaction_load: 5 } }
+      workload:
+          module: ./query.js
+    - label: transfer
+      txNumber: 100
+      rateControl: { type: 'linear-rate', opts: { startingTps: 5, finishingTps: 20 } }
+      workload:
+          module: ./transfer.js

caliper-peerplays-tests/develop-private-net_tests/caliper.yaml

@@ -0,0 +1,49 @@
+#
+# 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.
+#
+
+caliper:
+    benchconfig: benchconfig.yaml
+    networkconfig: networkconfig.json
+    txupdatetime: 500
+    workspace: ./
+    report:
+        path: report.html
+    logging:
+        template: '%timestamp%%level%%module%%message%%metadata%'
+        formats:
+            timestamp: 'YYYY.MM.DD-HH:mm:ss.SSS ZZ'
+            label: false
+            json: false
+            pad: true
+            align: false
+            attributeformat:
+                level: ' %attribute%'
+                module: ' [%attribute%] '
+                metadata: ' (%attribute%)'
+            colorize:
+                all: true
+                colors:
+                    info: green
+                    error: red
+                    warn: yellow
+                    debug: grey
+        targets:
+            console:
+                target: console
+                enabled: true
+                options:
+                    level: info
+            file:
+                target: file
+                enabled: false

caliper-peerplays-tests/develop-private-net_tests/claim_balance.js

@@ -0,0 +1,76 @@
+/*
+ * 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';
+
+const {WorkloadModuleBase} = require('@hyperledger/caliper-core');
+const {ChainConfig} = require("peerplaysjs-lib");
+
+class PeerplaysClaimBalanceWorkload extends WorkloadModuleBase {
+    constructor() {
+        super();
+    }
+
+    async initializeWorkloadModule(workerIndex, totalWorkers, roundIndex, roundArguments, sutAdapter, sutContext) {
+        await super.initializeWorkloadModule(workerIndex, totalWorkers, roundIndex, roundArguments, sutAdapter, sutContext);
+    }
+
+    async submitTransaction() {
+        if (this.workerIndex == 0) {
+            let args = [
+                {
+                    api_name: null,
+                    method: 'balance_claim',
+                    params: [
+                        {
+                            fee: {
+                                amount: 0,
+                                asset_id: '1.3.0'
+                            },
+                            deposit_to_account: '1.2.18',
+                            balance_to_claim: '1.15.0',
+                            balance_owner_key: 'TEST6MRyAjQq8ud7hVNYcfnVPJqcVpscN5So8BhtHuGYqET5GDW5CV',
+                            total_claimed: {
+                                amount: 1000000000000000,
+                                asset_id: '1.3.0'
+                            }
+                        }
+                    ],
+                    readOnly: false
+                }
+            ];
+            await this.sutAdapter.sendRequests(args);
+        } else {
+            let args = [
+                {
+                    api_name: 'database',
+                    method: 'get_account_balances',
+                    params: ['nathan', []],
+                    readOnly: true
+                }
+            ];
+            await this.sutAdapter.sendRequests(args);
+        }
+    }
+
+    async cleanupWorkloadModule() {
+        //
+    }
+}
+
+function createWorkloadModule() {
+    return new PeerplaysClaimBalanceWorkload();
+}
+
+module.exports.createWorkloadModule = createWorkloadModule;

caliper-peerplays-tests/develop-private-net_tests/config/caliper-peerplays-develop-clique.Dockerfile

@@ -0,0 +1,39 @@
+#
+# 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.
+#
+
+FROM datasecuritynode/peerplays:develop
+
+RUN /usr/local/bin/witness_node --create-genesis-json /peerplays/genesis.json --data-dir=/peerplays/witness_node_data_dir && \
+    sed -i 's/"initial_timestamp".*/"initial_timestamp": "2020-03-03T03:03:03",/' /peerplays/genesis.json && \
+    sed -i 's/"maintenance_interval".*/"maintenance_interval": 600,/' /peerplays/genesis.json && \
+    sed -i 's/"committee_proposal_review_period".*/"committee_proposal_review_period": 600,/' /peerplays/genesis.json && \
+    sed -i 's/"son_deregister_time".*/"son_deregister_time": 600,/' /peerplays/genesis.json && \
+    sed -i 's/"son_heartbeat_frequency".*/"son_heartbeat_frequency": 120,/' /peerplays/genesis.json && \
+    sed -i 's/"son_bitcoin_min_tx_confirmations".*/"son_bitcoin_min_tx_confirmations": 1/' /peerplays/genesis.json && \
+    sed -i 's/.*p2p-endpoint.*/p2p-endpoint = 0.0.0.0:9777/' /peerplays/witness_node_data_dir/config.ini && \
+    sed -i 's/.*seed-node[^s].*/\# seed-node = /' /peerplays/witness_node_data_dir/config.ini && \
+    sed -i 's/.*seed-nodes.*/seed-nodes = \[\]/' /peerplays/witness_node_data_dir/config.ini && \
+    sed -i 's/.*rpc-endpoint.*/rpc-endpoint = 0.0.0.0:8090/' /peerplays/witness_node_data_dir/config.ini && \
+    sed -i 's/.*genesis-json.*/genesis-json = genesis.json/' /peerplays/witness_node_data_dir/config.ini && \
+    sed -i '/^plugins/ s/$/ peerplays_sidechain/' /peerplays/witness_node_data_dir/config.ini && \
+    sed -i 's/.*enable-stale-production.*/enable-stale-production = true/' /peerplays/witness_node_data_dir/config.ini && \
+    sed -i 's/.*witness-id[^s].*/# witness-id = /' /peerplays/witness_node_data_dir/config.ini && \
+    sed -i 's/.*witness-ids.*/witness-ids = \["1.6.1", "1.6.2", "1.6.3", "1.6.4", "1.6.5", "1.6.6", "1.6.7", "1.6.8", "1.6.9", "1.6.10", "1.6.11"\]/' /peerplays/witness_node_data_dir/config.ini && \
+    sed -i 's/^private-key.*$/private-key = \["TEST6MRyAjQq8ud7hVNYcfnVPJqcVpscN5So8BhtHuGYqET5GDW5CV", "5KQwrPbwdL6PhXujxW37FSSQZ1JiwsST4cqQzDeyXtP79zkvFD3"\]/' /peerplays/witness_node_data_dir/config.ini && \
+    sed -i 's/^debug-private-key.*$/debug-private-key = \["TEST6MRyAjQq8ud7hVNYcfnVPJqcVpscN5So8BhtHuGYqET5GDW5CV", "5KQwrPbwdL6PhXujxW37FSSQZ1JiwsST4cqQzDeyXtP79zkvFD3"\]/' /peerplays/witness_node_data_dir/config.ini
+
+EXPOSE 8090
+EXPOSE 9777
+
+ENTRYPOINT cd /peerplays && witness_node --data-dir=/peerplays/witness_node_data_dir

caliper-peerplays-tests/develop-private-net_tests/config/config.ini

@@ -0,0 +1,157 @@
+# Endpoint for P2P node to listen on
+p2p-endpoint = 0.0.0.0:9777
+
+# P2P nodes to connect to on startup (may specify multiple times)
+# seed-node = 
+
+# JSON array of P2P nodes to connect to on startup
+seed-nodes = []
+
+# Pairs of [BLOCK_NUM,BLOCK_ID] that should be enforced as checkpoints.
+# checkpoint = 
+
+# Endpoint for websocket RPC to listen on
+rpc-endpoint = 0.0.0.0:8090
+
+# Endpoint for TLS websocket RPC to listen on
+# rpc-tls-endpoint = 
+
+# The TLS certificate file for this server
+# server-pem = 
+
+# Password for this certificate
+# server-pem-password = 
+
+# File to read Genesis State from
+genesis-json = genesis.json
+
+# Block signing key to use for init witnesses, overrides genesis file
+# dbg-init-key = 
+
+# JSON file specifying API permissions
+# api-access = 
+
+# Whether to enable tracking of votes of standby witnesses and committee members. Set it to true to provide accurate data to API clients, set to false for slightly better performance.
+# enable-standby-votes-tracking = 
+
+# Space-separated list of plugins to activate
+# plugins = 
+
+# Enable block production, even if the chain is stale.
+enable-stale-production = true
+
+# Percent of witnesses (0-99) that must be participating in order to produce blocks
+required-participation = false
+
+# ID of witness controlled by this node (e.g. "1.6.5", quotes are required, may specify multiple times)
+# witness-id = 
+
+# IDs of multiple witnesses controlled by this node (e.g. ["1.6.5", "1.6.6"], quotes are required)
+witness-ids = ["1.6.1", "1.6.2", "1.6.3", "1.6.4", "1.6.5", "1.6.6", "1.6.7", "1.6.8", "1.6.9", "1.6.10", "1.6.11"]
+
+# Tuple of [PublicKey, WIF private key] (may specify multiple times)
+private-key = ["TEST6MRyAjQq8ud7hVNYcfnVPJqcVpscN5So8BhtHuGYqET5GDW5CV","5KQwrPbwdL6PhXujxW37FSSQZ1JiwsST4cqQzDeyXtP79zkvFD3"]
+
+# Tuple of [PublicKey, WIF private key] (may specify multiple times)
+debug-private-key = ["TEST6MRyAjQq8ud7hVNYcfnVPJqcVpscN5So8BhtHuGYqET5GDW5CV","5KQwrPbwdL6PhXujxW37FSSQZ1JiwsST4cqQzDeyXtP79zkvFD3"]
+
+# Account ID to track history for (may specify multiple times)
+# track-account = 
+
+# Keep only those operations in memory that are related to account history tracking
+partial-operations = 1
+
+# Maximum number of operations per account will be kept in memory
+max-ops-per-account = 100
+
+# Elastic Search database node url(http://localhost:9200/)
+# elasticsearch-node-url = 
+
+# Number of bulk documents to index on replay(10000)
+# elasticsearch-bulk-replay = 
+
+# Number of bulk documents to index on a syncronied chain(100)
+# elasticsearch-bulk-sync = 
+
+# Use visitor to index additional data(slows down the replay(false))
+# elasticsearch-visitor = 
+
+# Pass basic auth to elasticsearch database('')
+# elasticsearch-basic-auth = 
+
+# Add a prefix to the index(peerplays-)
+# elasticsearch-index-prefix = 
+
+# Save operation as object(false)
+# elasticsearch-operation-object = 
+
+# Start doing ES job after block(0)
+# elasticsearch-start-es-after-block = 
+
+# Save operation as string. Needed to serve history api calls(true)
+# elasticsearch-operation-string = 
+
+# Mode of operation: only_save(0), only_query(1), all(2) - Default: 0
+# elasticsearch-mode = 
+
+# Elasticsearch node url(http://localhost:9200/)
+# es-objects-elasticsearch-url = 
+
+# Basic auth username:password('')
+# es-objects-auth = 
+
+# Number of bulk documents to index on replay(10000)
+# es-objects-bulk-replay = 
+
+# Number of bulk documents to index on a synchronized chain(100)
+# es-objects-bulk-sync = 
+
+# Store proposal objects(true)
+# es-objects-proposals = 
+
+# Store account objects(true)
+# es-objects-accounts = 
+
+# Store asset objects(true)
+# es-objects-assets = 
+
+# Store balances objects(true)
+# es-objects-balances = 
+
+# Store limit order objects(true)
+# es-objects-limit-orders = 
+
+# Store feed data(true)
+# es-objects-asset-bitasset = 
+
+# Add a prefix to the index(ppobjects-)
+# es-objects-index-prefix = 
+
+# Keep only current state of the objects(true)
+# es-objects-keep-only-current = 
+
+# Start doing ES job after block(0)
+# es-objects-start-es-after-block = 
+
+# Track market history by grouping orders into buckets of equal size measured in seconds specified as a JSON array of numbers
+bucket-size = [15,60,300,3600,86400]
+
+# How far back in time to track history for each bucket size, measured in the number of buckets (default: 1000)
+history-per-size = 1000
+
+# Block number after which to do a snapshot
+# snapshot-at-block = 
+
+# Block time (ISO format) after which to do a snapshot
+# snapshot-at-time = 
+
+# Pathname of JSON file where to store the snapshot
+# snapshot-to = 
+
+
+# ==============================================================================
+# logging options
+# ==============================================================================
+#
+# Logging configuration is loaded from logging.ini by default.
+# If logging.ini exists, logging configuration added in this file will be ignored.