Merge pull request #639 from aklenik/round-config-refactor

Flatten round configuration and consolidate related components
hyperledger-caliper · Nov 11, 2019 · 788f31c · 788f31c
2 parents bf55479 + 7b7b899
commit 788f31c
Show file tree

Hide file tree

Showing 50 changed files with 993 additions and 907 deletions.
diff --git a/packages/caliper-burrow/lib/burrowClientFactory.js b/packages/caliper-burrow/lib/burrowClientFactory.js
@@ -22,28 +22,15 @@ const path = require('path');
  */
 class BurrowClientFactory {
 
-    /**
-     * Require paths to configuration data used when calling new on fabric.js
-     * @param {String} absNetworkFile absolute workerPath
-     * @param {Sting} workspace_root root location
-     */
-    constructor(absNetworkFile, workspace_root){
-        this.absNetworkFile = absNetworkFile;
-        this.workspaceRoot = workspace_root;
-    }
-
-
     /**
      * Spawn the worker and perform required init
      * @returns {Object} the child process
      */
     async spawnWorker() {
-        const child = childProcess.fork(path.join(__dirname, './burrowClientWorker.js'), process.argv.slice(1), { env: process.env});
+        const child = childProcess.fork(path.join(__dirname, './burrowClientWorker.js'), process.argv.slice(2), { env: process.env});
 
         const msg = {
-            type: 'init',
-            absNetworkFile: this.absNetworkFile,
-            networkRoot: this.workspaceRoot
+            type: 'init'
         };
         child.send(msg);
 

diff --git a/packages/caliper-burrow/lib/burrowClientWorker.js b/packages/caliper-burrow/lib/burrowClientWorker.js
@@ -14,41 +14,27 @@
 
 'use strict';
 
-const { CaliperLocalClient, CaliperUtils } = require('@hyperledger/caliper-core');
+const { MessageHandler } = require('@hyperledger/caliper-core');
 const BurrowClient = require('./burrow');
 
-let caliperClient;
 /**
- * Message handler
+ * Handles the init message. Constructs the Burrow adapter.
+ * @param {object} context The context of the message handler object.
+ * @param {object} message The message object.
+ * @return {Promise<BurrowClient>} The initialized adapter instance.
+ * @async
  */
-process.on('message', async (message) => {
+async function initHandler(context, message) {
+    return new BurrowClient(context.networkConfigPath, context.workspacePath);
+}
 
-    if (!message.hasOwnProperty('type')) {
-        process.send({ type: 'error', data: 'unknown message type' });
-        return;
-    }
-
-    try {
-        switch (message.type) {
-        case 'init': {
-            const blockchain = new BurrowClient(message.absNetworkFile, message.networkRoot);
-            caliperClient = new CaliperLocalClient(blockchain);
-            process.send({ type: 'ready', data: { pid: process.pid, complete: true } });
-            break;
-        }
-        case 'test': {
-            let result = await caliperClient.doTest(message);
+const handlerContext = new MessageHandler({
+    init: initHandler
+});
 
-            await CaliperUtils.sleep(200);
-            process.send({ type: 'testResult', data: result });
-            break;
-        }
-        default: {
-            process.send({ type: 'error', data: 'unknown message type [' + message.type + ']' });
-        }
-        }
-    }
-    catch (err) {
-        process.send({ type: 'error', data: err.toString() });
-    }
+/**
+ * Message handler
+ */
+process.on('message', async (message) => {
+    await MessageHandler.handle(handlerContext, message);
 });
diff --git a/packages/caliper-cli/caliper.js b/packages/caliper-cli/caliper.js
@@ -16,9 +16,7 @@
 'use strict';
 
 process.env.SUPPRESS_NO_CONFIG_WARNING = true;
-const cmdUtil = require('./lib/utils/cmdutils');
 const yargs = require('yargs');
-const chalk = require('chalk');
 const version = 'v' + require('./package.json').version;
 
 let results = yargs
@@ -35,11 +33,7 @@ let results = yargs
     .argv;
 
 results.thePromise.then( () => {
-    if (!results.quiet) {
-        cmdUtil.log(chalk.green('\nCommand succeeded\n'));
-    }
     process.exit(0);
 }).catch((error) => {
-    cmdUtil.log(error.stack+chalk.red('\nCommand failed\n'));
     process.exit(1);
 });
diff --git a/packages/caliper-cli/lib/benchmark/lib/runBenchmark.js b/packages/caliper-cli/lib/benchmark/lib/runBenchmark.js
@@ -14,9 +14,8 @@
 
 'use strict';
 
-const {CaliperFlow, CaliperUtils, ConfigUtil} = require('@hyperledger/caliper-core');
-const chalk = require('chalk');
-const cmdUtil = require('../../utils/cmdutils');
+const {CaliperEngine, CaliperUtils, ConfigUtil} = require('@hyperledger/caliper-core');
+const logger = CaliperUtils.getLogger('CLI');
 const path = require('path');
 const fs = require('fs');
 /**
@@ -30,46 +29,66 @@ class RunBenchmark {
     * @param {string} argv argument list from caliper benchmark command
     */
     static async handler(argv) {
-        let workspace = ConfigUtil.get(ConfigUtil.keys.Workspace, './');
-        let benchConfigFile = ConfigUtil.get(ConfigUtil.keys.BenchConfig, undefined);
-        let blockchainConfigFile = ConfigUtil.get(ConfigUtil.keys.NetworkConfig, undefined);
+        let workspacePath = ConfigUtil.get(ConfigUtil.keys.Workspace);
+        let benchmarkConfigPath = ConfigUtil.get(ConfigUtil.keys.BenchConfig);
+        let networkConfigPath = ConfigUtil.get(ConfigUtil.keys.NetworkConfig);
 
         // Workspace is expected to be the root location of working folders
-        workspace = path.resolve(workspace);
-        benchConfigFile = path.isAbsolute(benchConfigFile) ? benchConfigFile : path.join(workspace, benchConfigFile);
-        blockchainConfigFile = path.isAbsolute(blockchainConfigFile) ? blockchainConfigFile : path.join(workspace, blockchainConfigFile);
+        workspacePath = path.resolve(workspacePath);
+        benchmarkConfigPath = CaliperUtils.resolvePath(benchmarkConfigPath, workspacePath);
+        networkConfigPath = CaliperUtils.resolvePath(networkConfigPath, workspacePath);
 
-        if(!benchConfigFile || !fs.existsSync(benchConfigFile)) {
-            throw(new Error(`Benchmark configuration file "${benchConfigFile || 'UNSET'}" does not exist`));
+        if(!benchmarkConfigPath || !fs.existsSync(benchmarkConfigPath)) {
+            let msg = `Benchmark configuration file "${benchmarkConfigPath || 'UNSET'}" does not exist`;
+            logger.error(msg);
+            throw new Error(msg);
         }
 
-        if(!blockchainConfigFile || !fs.existsSync(blockchainConfigFile)) {
-            throw(new Error(`Network configuration file "${blockchainConfigFile || 'UNSET'}" does not exist`));
+        if(!networkConfigPath || !fs.existsSync(networkConfigPath)) {
+            let msg = `Network configuration file "${networkConfigPath || 'UNSET'}" does not exist`;
+            logger.error(msg);
+            throw new Error(msg);
         }
 
+        let benchmarkConfig = CaliperUtils.parseYaml(benchmarkConfigPath);
+        let networkConfig = CaliperUtils.parseYaml(networkConfigPath);
+
         let blockchainType = '';
-        let networkObject = CaliperUtils.parseYaml(blockchainConfigFile);
-        if (networkObject.hasOwnProperty('caliper') && networkObject.caliper.hasOwnProperty('blockchain')) {
-            blockchainType = networkObject.caliper.blockchain;
+        if (networkConfig.caliper && networkConfig.caliper.blockchain) {
+            blockchainType = networkConfig.caliper.blockchain;
         } else {
-            throw new Error('The configuration file [' + blockchainConfigFile + '] is missing its "caliper.blockchain" attribute');
+            let msg = `Network configuration file "${networkConfigPath}" is missing its "caliper.blockchain" attribute`;
+            logger.error(msg);
+            throw new Error(msg);
         }
 
+        let knownError = false;
+
         try {
-            cmdUtil.log(chalk.blue.bold('Benchmark for target Blockchain type ' + blockchainType + ' about to start'));
-            const {AdminClient, ClientFactory} = require('@hyperledger/caliper-' + blockchainType);
-            const adminClient = new AdminClient(blockchainConfigFile, workspace);
-            const clientFactory = new ClientFactory(blockchainConfigFile, workspace);
+            logger.info(`Set workspace path: ${workspacePath}`);
+            logger.info(`Set benchmark configuration path: ${benchmarkConfigPath}`);
+            logger.info(`Set network configuration path: ${networkConfigPath}`);
+            logger.info(`Detected SUT type: ${blockchainType}`);
 
-            const response = await CaliperFlow.run(benchConfigFile, blockchainConfigFile, adminClient, clientFactory, workspace);
+            const {AdminClient, ClientFactory} = require(`@hyperledger/caliper-${blockchainType}`);
+            const blockchainAdapter = new AdminClient(networkConfigPath, workspacePath);
+            const workerFactory = new ClientFactory();
+
+            const engine = new CaliperEngine(benchmarkConfig, networkConfig, blockchainAdapter, workerFactory);
+            const response = await engine.run();
 
             if (response === 0) {
-                cmdUtil.log(chalk.blue.bold('Benchmark run successful'));
+                logger.info('Benchmark successfully finished');
             } else {
-                cmdUtil.log(chalk.red.bold('Benchmark failure'));
-                throw new Error('Benchmark failure');
+                knownError = true;
+                let msg = `Benchmark failed with error code ${response}`;
+                logger.error(msg);
+                throw new Error(msg);
             }
         } catch (err) {
+            if (!knownError) {
+                logger.error(`Unexpected error during benchmark execution: ${err.stack || err}`);
+            }
             throw err;
         }
     }

diff --git a/packages/caliper-cli/lib/bind/bind.js b/packages/caliper-cli/lib/bind/bind.js
@@ -15,7 +15,6 @@
 'use strict';
 
 const { CaliperUtils, ConfigUtil } = require('@hyperledger/caliper-core');
-const chalk = require('chalk');
 const cmdUtil = require('../utils/cmdutils');
 const path = require('path');
 
@@ -107,7 +106,7 @@ class Bind {
             settings = {};
         }
 
-        cmdUtil.log(chalk.blue.bold(`Binding for ${sut}@${sdk}. This might take some time...`));
+        logger.info(`Binding for ${sut}@${sdk}. This might take some time...`);
         try {
             // combine, then convert the arguments to an array
             let npmArgs;

diff --git a/packages/caliper-cli/lib/utils/cmdutils.js b/packages/caliper-cli/lib/utils/cmdutils.js
@@ -23,18 +23,6 @@ const { spawn }= require('child_process');
  */
 class CmdUtil {
 
-
-    /** Simple log method to output to the console
-     * Used to put a single console.log() here, so eslinting is easier.
-     * And if this needs to written to a file at some point it is also eaiser
-     */
-    static log(){
-        Array.from(arguments).forEach((s)=>{
-            // eslint-disable-next-line no-console
-            console.log(s);
-        });
-    }
-
     /**
      * Invokes a given command in a spawned child process and attaches all standard IO.
      * @param {string} cmd The command to be run.

diff --git a/packages/caliper-cli/package.json b/packages/caliper-cli/package.json
@@ -31,7 +31,6 @@
     "@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": {

diff --git a/packages/caliper-composer/lib/composerClientFactory.js b/packages/caliper-composer/lib/composerClientFactory.js
@@ -22,28 +22,15 @@ const path = require('path');
  */
 class ComposerClientFactory {
 
-    /**
-     * Require paths to configuration data used when calling new on fabric.js
-     * @param {String} absNetworkFile absolute workerPath
-     * @param {Sting} workspace_root root location
-     */
-    constructor(absNetworkFile, workspace_root){
-        this.absNetworkFile = absNetworkFile;
-        this.workspaceRoot = workspace_root;
-    }
-
-
     /**
      * Spawn the worker and perform required init
      * @returns {Object} the child process
      */
     spawnWorker() {
-        const child = childProcess.fork(path.join(__dirname, './composerClientWorker.js'), process.argv.slice(1), { env: process.env});
+        const child = childProcess.fork(path.join(__dirname, './composerClientWorker.js'), process.argv.slice(2), { env: process.env});
 
         const msg = {
-            type: 'init',
-            absNetworkFile: this.absNetworkFile,
-            networkRoot: this.workspaceRoot
+            type: 'init'
         };
         child.send(msg);
 

diff --git a/packages/caliper-composer/lib/composerClientWorker.js b/packages/caliper-composer/lib/composerClientWorker.js
@@ -14,41 +14,27 @@
 
 'use strict';
 
-const {CaliperLocalClient, CaliperUtils} = require('@hyperledger/caliper-core');
+const { MessageHandler } = require('@hyperledger/caliper-core');
 const ComposerClient = require('./composer');
 
-let caliperClient;
 /**
- * Message handler
+ * Handles the init message. Constructs the Composer adapter.
+ * @param {object} context The context of the message handler object.
+ * @param {object} message The message object.
+ * @return {Promise<ComposerClient>} The initialized adapter instance.
+ * @async
  */
-process.on('message', async (message) => {
+async function initHandler(context, message) {
+    return new ComposerClient(context.networkConfigPath, context.workspacePath);
+}
 
-    if (!message.hasOwnProperty('type')) {
-        process.send({type: 'error', data: 'unknown message type'});
-        return;
-    }
-
-    try {
-        switch (message.type) {
-        case 'init': {
-            const blockchain = new ComposerClient(message.absNetworkFile, message.networkRoot);
-            caliperClient = new CaliperLocalClient(blockchain);
-            process.send({type: 'ready', data: {pid: process.pid, complete: true}});
-            break;
-        }
-        case 'test': {
-            let result = await caliperClient.doTest(message);
+const handlerContext = new MessageHandler({
+    init: initHandler
+});
 
-            await CaliperUtils.sleep(200);
-            process.send({type: 'testResult', data: result});
-            break;
-        }
-        default: {
-            process.send({type: 'error', data: 'unknown message type [' + message.type + ']'});
-        }
-        }
-    }
-    catch (err) {
-        process.send({type: 'error', data: err.toString()});
-    }
+/**
+ * Message handler
+ */
+process.on('message', async (message) => {
+    await MessageHandler.handle(handlerContext, message);
 });
diff --git a/packages/caliper-core/index.js b/packages/caliper-core/index.js
@@ -20,4 +20,5 @@ module.exports.TxStatus = require('./lib/common/core/transaction-status');
 module.exports.CaliperUtils = require('./lib/common/utils/caliper-utils');
 module.exports.Version = require('./lib/common/utils/version');
 module.exports.ConfigUtil = require('./lib/common/config/config-util');
-module.exports.CaliperFlow = require('./lib/master/caliper-flow');
+module.exports.MessageHandler = require('./lib/worker/client/message-handler');
+module.exports.CaliperEngine = require('./lib/master/caliper-engine');
diff --git a/packages/caliper-core/lib/common/utils/caliper-utils.js b/packages/caliper-core/lib/common/utils/caliper-utils.js
@@ -64,7 +64,7 @@ class CaliperUtils {
      * @param {String} root_path root path to use
      * @return {String} The resolved absolute path.
      */
-    static resolvePath(relOrAbsPath, root_path) {
+    static resolvePath(relOrAbsPath, root_path = undefined) {
         if (!relOrAbsPath) {
             throw new Error('Util.resolvePath: Parameter is undefined');
         }
@@ -73,7 +73,7 @@ class CaliperUtils {
             return relOrAbsPath;
         }
 
-        return path.resolve(root_path, relOrAbsPath);
+        return path.resolve(root_path || Config.get(Config.keys.Workspace), relOrAbsPath);
     }
 
     /**

diff --git a/packages/caliper-core/lib/common/utils/logging-util.js b/packages/caliper-core/lib/common/utils/logging-util.js
@@ -48,7 +48,7 @@ function _messageFormat() {
         output = output.replace(labelRegex, info.label || '');
         output = output.replace(moduleRegex, info.module || '');
         output = output.replace(messageRegex, info.message || '');
-        return output.replace(metadataRegex, info.meta || '');
+        return output.replace(metadataRegex, info.metadata || '');
     });
 }