How to use execMethod method in Jest

1'use strict';2const _chai = require('chai');3_chai.use(require('sinon-chai'));4_chai.use(require('chai-as-promised'));5const expect = _chai.expect;6const _rewire = require('rewire');7const Promise = require('bluebird');8const {9    testValues: _testValues,10    asyncHelper: _asyncHelper,11    SuperSpyBuilder,12    ObjectMock,13} = require('@vamship/test-utils');14const { ArgError } = require('@vamship/error-types').args;15const RemoteClient = require('../../src/remote-client');16const SshClient = _rewire('../../src/ssh-client');17describe('SshClient', () => {18    function _buildOptions(options) {19        options = options || {20            host: _testValues.getString('host'),21            port: _testValues.getNumber(1024, 22),22            username: _testValues.getString('username'),23            password: _testValues.getString('password'),24        };25        return options;26    }27    function _createSshClient(options) {28        options = options || {29            host: _testValues.getString('host'),30            port: _testValues.getNumber(1024, 22),31            username: _testValues.getString('username'),32            password: _testValues.getString('password'),33        };34        return new SshClient(options);35    }36    let _superSpy = null;37    let _sshClientMock = null;38    let _streamMock = null;39    beforeEach(() => {40        _superSpy = new SuperSpyBuilder(RemoteClient, SshClient);41        _superSpy.inject();42        const stderr = new ObjectMock().addMock('on', (event, callback) => {43            return addHandler('stderr', callback);44        });45        _streamMock = new ObjectMock().addMock('on', (event, callback) => {46            return addHandler(event, callback);47        });48        _streamMock.instance.stderr = stderr.instance;49        _streamMock.__handlers = {};50        function addHandler(event, callback) {51            let handlerList = _streamMock.__handlers[event];52            if (!handlerList) {53                handlerList = [];54                _streamMock.__handlers[event] = handlerList;55            }56            handlerList.push(callback);57            return _streamMock.instance;58        }59        _sshClientMock = new ObjectMock()60            .addMock('on', (event, callback) => {61                _sshClientMock.__handlers[event] = callback;62                return _sshClientMock.instance;63            })64            .addMock('connect')65            .addMock('exec', () => _sshClientMock.__execResult)66            .addMock('continue')67            .addMock('end');68        _sshClientMock.__handlers = {};69        _sshClientMock.__execResult = true;70        SshClient.__set__('_ssh2', {71            Client: _sshClientMock.ctor,72        });73    });74    afterEach(() => {75        _superSpy.restore();76    });77    describe('ctor()', () => {78        it('should invoke the super constructor with correct parameters', () => {79            const superMethod = _superSpy.mocks.super;80            expect(superMethod.stub).to.not.have.been.called;81            const options = _buildOptions();82            const client = _createSshClient(options);83            expect(client).to.be.an.instanceOf(RemoteClient);84            expect(superMethod.stub).to.have.been.calledOnce;85            expect(superMethod.stub).to.have.been.calledWithExactly(options);86        });87        it('should return an object with the expected methods and properties', () => {88            const client = _createSshClient();89            expect(client).to.be.an('object');90            expect(client.run).to.be.a('function');91        });92    });93    describe('run()', () => {94        it('should throw an error if invoked without valid command(s)', () => {95            const message = 'Invalid command(s) (arg #1)';96            const inputs = _testValues.allButSelected('string', 'array');97            inputs.forEach((command) => {98                const wrapper = () => {99                    const client = _createSshClient();100                    return client.run(command);101                };102                expect(wrapper).to.throw(ArgError, message);103            });104        });105        it('should return a promise when invoked', () => {106            const client = _createSshClient();107            const ret = client.run([_testValues.getString('command')]);108            expect(ret).to.be.an('object');109            expect(ret.then).to.be.a('function');110        });111        it('should create a new ssh client', () => {112            const client = _createSshClient();113            const sshCtor = _sshClientMock.ctor;114            expect(sshCtor).to.not.have.been.called;115            client.run([_testValues.getString('command')]);116            return _asyncHelper117                .wait(10)()118                .then(() => {119                    expect(sshCtor).to.have.been.calledOnce;120                    expect(sshCtor).to.be.calledWithExactly();121                });122        });123        it('should setup minimal event handlers on the client', () => {124            const client = _createSshClient();125            expect(_sshClientMock.__handlers.ready).to.be.undefined;126            expect(_sshClientMock.__handlers.error).to.be.undefined;127            client.run([_testValues.getString('command')]);128            return _asyncHelper129                .wait(10)()130                .then(() => {131                    expect(_sshClientMock.__handlers.ready).to.be.a('function');132                    expect(_sshClientMock.__handlers.error).to.be.a('function');133                });134        });135        it('should attempt to make a connection using the correct connection options', () => {136            const client = _createSshClient();137            const connectMethod = _sshClientMock.mocks.connect;138            expect(connectMethod.stub).to.not.have.been.called;139            client.run([_testValues.getString('command')]);140            return _asyncHelper141                .wait(10)()142                .then(() => {143                    return client.getConnectionOptions();144                })145                .then((connOpts) => {146                    expect(connectMethod.stub).to.have.been.calledOnce;147                    expect(connectMethod.stub.args[0][0]).to.deep.equal(148                        connOpts149                    );150                });151        });152        it('should reject the promise if the connection does not succeed', () => {153            const client = _createSshClient();154            const connectMethod = _sshClientMock.mocks.connect;155            const error = 'something went wrong!';156            expect(connectMethod.stub).to.not.have.been.called;157            const response = client.run([_testValues.getString('command')]);158            _asyncHelper159                .wait(10)()160                .then(() => {161                    const errorHandler = _sshClientMock.__handlers.error;162                    errorHandler(error);163                });164            return expect(response).to.be.rejectedWith(error);165        });166        it('should execute the commands on the remote host if connection succeeds', () => {167            const client = _createSshClient();168            const execMethod = _sshClientMock.mocks.exec;169            const commands = [_testValues.getString('command')];170            expect(execMethod.stub).to.not.have.been.called;171            client.run(commands);172            return _asyncHelper173                .wait(10)()174                .then(() => {175                    const readyHandler = _sshClientMock.__handlers.ready;176                    readyHandler();177                })178                .then(_asyncHelper.wait(10))179                .then(() => {180                    const callback = execMethod.stub.args[0][1];181                    callback(null, _streamMock.instance);182                })183                .then(() => {184                    expect(execMethod.stub).to.have.been.called;185                    expect(execMethod.stub.callCount).to.equal(commands.length);186                });187        });188        it('should execute commands without pause if the client allows it', () => {189            const client = _createSshClient();190            const execMethod = _sshClientMock.mocks.exec;191            const commands = [192                _testValues.getString('command'),193                _testValues.getString('command'),194                _testValues.getString('command'),195            ];196            expect(_sshClientMock.__handlers.continue).to.be.undefined;197            expect(execMethod.stub).to.not.have.been.called;198            client.run(commands);199            return _asyncHelper200                .wait(10)()201                .then(() => {202                    const readyHandler = _sshClientMock.__handlers.ready;203                    readyHandler();204                })205                .then(() => {206                    expect(_sshClientMock.__handlers.continue).to.be.a(207                        'function'208                    );209                    return Promise.mapSeries(commands, (command, index) => {210                        const callback = execMethod.stub.args[index][1];211                        callback(null, _streamMock.instance);212                        _streamMock.__handlers.close[index](0);213                        return _asyncHelper.wait(1)();214                    });215                })216                .then(() => {217                    expect(execMethod.stub).to.have.been.called;218                    expect(execMethod.stub.callCount).to.equal(commands.length);219                });220        });221        it('should ignore unsolicited continue events from the client', () => {222            const client = _createSshClient();223            const execMethod = _sshClientMock.mocks.exec;224            const commands = [225                _testValues.getString('command'),226                _testValues.getString('command'),227                _testValues.getString('command'),228            ];229            expect(_sshClientMock.__handlers.continue).to.be.undefined;230            expect(execMethod.stub).to.not.have.been.called;231            client.run(commands);232            return _asyncHelper233                .wait(10)()234                .then(() => {235                    const readyHandler = _sshClientMock.__handlers.ready;236                    readyHandler();237                })238                .then(() => {239                    expect(_sshClientMock.__handlers.continue).to.be.a(240                        'function'241                    );242                    return Promise.mapSeries(commands, (command, index) => {243                        const callback = execMethod.stub.args[index][1];244                        callback(null, _streamMock.instance);245                        _streamMock.__handlers.close[index](0);246                        // Unsolicited continue.247                        _sshClientMock.__handlers.continue();248                        return _asyncHelper.wait(1)();249                    });250                })251                .then(() => {252                    expect(execMethod.stub).to.have.been.called;253                    expect(execMethod.stub.callCount).to.equal(commands.length);254                });255        });256        it('should pause for the continue event if the client requests a pause', () => {257            const client = _createSshClient();258            const execMethod = _sshClientMock.mocks.exec;259            const commands = [260                _testValues.getString('command'),261                _testValues.getString('command'),262                _testValues.getString('command'),263            ];264            // Client asks for wait before continuing265            _sshClientMock.__execResult = false;266            expect(_sshClientMock.__handlers.continue).to.be.undefined;267            expect(execMethod.stub).to.not.have.been.called;268            client.run(commands);269            return _asyncHelper270                .wait(10)()271                .then(() => {272                    const readyHandler = _sshClientMock.__handlers.ready;273                    readyHandler();274                })275                .then(() => {276                    expect(_sshClientMock.__handlers.continue).to.be.a(277                        'function'278                    );279                    return Promise.mapSeries(commands, (command, index) => {280                        expect(execMethod.stub).to.have.been.called;281                        expect(execMethod.stub.callCount).to.equal(index + 1);282                        const callback = execMethod.stub.args[index][1];283                        callback(null, _streamMock.instance);284                        _streamMock.__handlers.close[index](0);285                        _sshClientMock.__handlers.continue();286                        return _asyncHelper.wait(1)();287                    });288                });289        });290        it.only('should accept a string command instead of an array', () => {291            const client = _createSshClient();292            const execMethod = _sshClientMock.mocks.exec;293            const commands = _testValues.getString('command');294            expect(execMethod.stub).to.not.have.been.called;295            client.run(commands);296            return _asyncHelper297                .wait(10)()298                .then(() => {299                    const readyHandler = _sshClientMock.__handlers.ready;300                    readyHandler();301                })302                .then(_asyncHelper.wait(10))303                .then(() => {304                    expect(execMethod.stub).to.have.been.calledOnce;305                    expect(execMethod.stub.args[0][0]).to.equal(commands);306                    const callback = execMethod.stub.args[0][1];307                    callback(null, _streamMock.instance);308                    _streamMock.__handlers.close[0](0);309                    return _asyncHelper.wait(1)();310                });311        });312        it('should resolve the promise after all commands have been executed successfully', () => {313            const client = _createSshClient();314            const execMethod = _sshClientMock.mocks.exec;315            const endMethod = _sshClientMock.mocks.end;316            const commands = [317                _testValues.getString('command'),318                _testValues.getString('command'),319                _testValues.getString('command'),320            ];321            expect(endMethod.stub).to.not.have.been.calledOnce;322            const response = client.run(commands);323            _asyncHelper324                .wait(10)()325                .then(() => {326                    const readyHandler = _sshClientMock.__handlers.ready;327                    readyHandler();328                })329                .then(() => {330                    return Promise.mapSeries(commands, (command, index) => {331                        const callback = execMethod.stub.args[index][1];332                        callback(null, _streamMock.instance);333                        _streamMock.__handlers.close[index](0);334                        return _asyncHelper.wait(1)();335                    });336                });337            return expect(response).to.be.fulfilled.then((result) => {338                expect(endMethod.stub).to.have.been.calledOnce;339                expect(endMethod.stub).to.have.been.calledWithExactly();340                expect(result).to.be.an('object');341                expect(result.commandCount).to.equal(commands.length);342                expect(result.successCount).to.equal(commands.length);343                expect(result.failureCount).to.equal(0);344                expect(result.results)345                    .to.be.an('array')346                    .and.to.have.length(commands.length);347            });348        });349        it('should abort command execution after the first command fails', () => {350            const client = _createSshClient();351            const execMethod = _sshClientMock.mocks.exec;352            const endMethod = _sshClientMock.mocks.end;353            const error = 'something went wrong';354            const commands = [355                _testValues.getString('command'),356                _testValues.getString('command'),357                _testValues.getString('command'),358                _testValues.getString('command'),359                _testValues.getString('command'),360                _testValues.getString('command'),361                _testValues.getString('command'),362                _testValues.getString('command'),363            ];364            const successCount = _testValues.getNumber(commands.length - 1);365            expect(endMethod.stub).to.not.have.been.calledOnce;366            const response = client.run(commands);367            _asyncHelper368                .wait(10)()369                .then(() => {370                    const readyHandler = _sshClientMock.__handlers.ready;371                    readyHandler();372                })373                .then(() => {374                    return Promise.mapSeries(commands, (command, index) => {375                        if (index <= successCount) {376                            const callback = execMethod.stub.args[index][1];377                            if (index === successCount) {378                                callback(error);379                            } else {380                                callback(null, _streamMock.instance);381                                _streamMock.__handlers.close[index](0);382                            }383                        }384                        return _asyncHelper.wait(1)();385                    });386                });387            return expect(response).to.be.fulfilled.then((result) => {388                expect(endMethod.stub).to.have.been.calledOnce;389                expect(endMethod.stub).to.have.been.calledWithExactly();390                expect(result).to.be.an('object');391                expect(result.commandCount).to.equal(commands.length);392                expect(result.successCount).to.equal(successCount);393                expect(result.failureCount).to.equal(1);394                expect(result.results)395                    .to.be.an('array')396                    .and.to.have.length(successCount + 1);397            });398        });399        it('should treat a non zero exit code as a failure for a command', () => {400            const client = _createSshClient();401            const execMethod = _sshClientMock.mocks.exec;402            const commands = [403                _testValues.getString('command'),404                _testValues.getString('command'),405                _testValues.getString('command'),406                _testValues.getString('command'),407                _testValues.getString('command'),408                _testValues.getString('command'),409                _testValues.getString('command'),410                _testValues.getString('command'),411            ];412            const successCount = _testValues.getNumber(commands.length - 1);413            const exitCode = _testValues.getNumber(-10, -1);414            const response = client.run(commands);415            _asyncHelper416                .wait(10)()417                .then(() => {418                    const readyHandler = _sshClientMock.__handlers.ready;419                    readyHandler();420                })421                .then(() => {422                    return Promise.mapSeries(commands, (command, index) => {423                        if (index <= successCount) {424                            const callback = execMethod.stub.args[index][1];425                            callback(null, _streamMock.instance);426                            if (index === successCount) {427                                _streamMock.__handlers.close[index](exitCode);428                            } else {429                                _streamMock.__handlers.close[index](0);430                            }431                        }432                        return _asyncHelper.wait(1)();433                    });434                });435            return expect(response).to.be.fulfilled.then((result) => {436                expect(result).to.be.an('object');437                expect(result.commandCount).to.equal(commands.length);438                expect(result.successCount).to.equal(successCount);439                expect(result.failureCount).to.equal(1);440                expect(result.results)441                    .to.be.an('array')442                    .and.to.have.length(successCount + 1);443                result.results.forEach((result, index) => {444                    if (index === successCount) {445                        expect(result.success).to.be.false;446                        expect(result.exitCode).to.equal(exitCode);447                    } else {448                        expect(result.success).to.be.true;449                        expect(result.exitCode).to.equal(0);450                    }451                });452            });453        });454        it('should include the output from stderr and stdout for each command', () => {455            const client = _createSshClient();456            const execMethod = _sshClientMock.mocks.exec;457            const commands = [458                _testValues.getString('command'),459                _testValues.getString('command'),460                _testValues.getString('command'),461            ];462            const stdoutResponses = [463                _testValues.getString('stdout'),464                _testValues.getString('stdout'),465                _testValues.getString('stdout'),466            ];467            const stderrResponses = [468                _testValues.getString('stderr'),469                _testValues.getString('stderr'),470                _testValues.getString('stderr'),471            ];472            const response = client.run(commands);473            _asyncHelper474                .wait(10)()475                .then(() => {476                    const readyHandler = _sshClientMock.__handlers.ready;477                    readyHandler();478                })479                .then(() => {480                    return Promise.mapSeries(commands, (command, index) => {481                        const callback = execMethod.stub.args[index][1];482                        callback(null, _streamMock.instance);483                        _streamMock.__handlers.data[index](484                            stdoutResponses[index]485                        );486                        _streamMock.__handlers.stderr[index](487                            stderrResponses[index]488                        );489                        _streamMock.__handlers.close[index](0);490                        return _asyncHelper.wait(1)();491                    });492                });493            return expect(response).to.be.fulfilled.then((result) => {494                result.results.forEach((result, index) => {495                    expect(result.command).to.equal(commands[index]);496                    expect(result.exitCode).to.equal(0);497                    expect(result.success).to.be.true;498                    expect(result.stdout).to.equal(stdoutResponses[index]);499                    expect(result.stderr).to.equal(stderrResponses[index]);500                });501            });502        });503    });...

...16    contractId = req.body.contract_id;17    return res.send();18});19router.post('/createAccount', function(req, res) {20	execMethod("createAccount", "createWallet", [], null, false, function(error, body) {21		if (error) {22			return res.send("Failed to create account.");23		}24		let walletAddress = body['data']['address'];25		console.log(2);26		request.post({url: serverRoot + 'participate', headers: {"Content-type": "application/json"}, json: {"wallet": walletAddress}}, function(err, response, body) {27			console.log(3);28			if (error) {29				body['status'] = 'error';30				body['message'] = error;31				return res.send(body);32			}33            console.log("body", body);34			body['data'] = {'wallet': walletAddress, 'transaction': body['data']};35			return res.send(body);36		});37	});38});39router.post('/participate', function(req, res) {40	console.log("req.body2", req.body);41	// Delegate transaction (give gas to end user)42	execMethod("participate", "transaction", [], req.body.wallet, true, function(error, body) {43		return res.send(body);44	});45});46// For Admin47router.get('/admin', function(req, res, next) {48  res.render('admin', {title: 'Lottery for admin'});49});50router.post('/startLottery', function(req, res) {51	execMethod("startLottery", "transaction", [], adminWallet, false, function(error, body) {52		res.send(body);53	});54});55router.get('/checkVote', function(req, res) {56	execMethod("vote_num", "call", [req.query.address], null, false, function(error, body) {57		res.send(body);58	});59});60router.post('/closeLottery', function(req, res) {61	execMethod("close", "transaction", [], adminWallet, false, function(error, body) {62		res.send(body);63	});64});65router.post('/startSelection', function(req, res) {66	execMethod("startSelection", "transaction", [], adminWallet, false, function(error, body) {67		res.send(body);68	});69});70router.get('/selectWinners', function(req, res) {71	execMethod("selectWinners", "call", [req.query.seed], null, false, function(error, body) {72		res.send(body);73	});74});75router.get('/getLotterySeed', function(req, res) {76	execMethod("win_seed", "call", [], null, false, function(error, body) {77		res.send(body);78	});79});80router.get('/getWinnerCount', function(req, res) {81	execMethod("winner_count", "call", [], null, false, function(error, body) {82		res.send(body);83	});84});85function execMethod(method, endpoint = "call", args = [], wallet = null, delegate = false, cb) {86	let requestData = {};87	if (endpoint == "call" || endpoint == "transaction"){88		requestData = {89			'id': contractId,90			'method': method,91			'args': JSON.stringify(args),92			'wallet': wallet,93			'fee': 'high',94			'delegate': delegate95		};96	} else if (endpoint != "createWallet") {97		return cb("Invalid API call", null);98	}99	let url = `${apiRoot}${endpoint}?auth=${auth}`;...

...8        const stdout = null;9        const stderr = "stderr";10        callback(error, stdout, stderr);11        execMethod = jest.fn();12        execMethod(commandString);13    });14});15it("Check DB config using Host & User only ", async () => {16    const dummyMysqlConfig = {17        host: "127.0.0.1",18        user: "root",19    };20    const dummyPathToCreationScript = "FILE";21    await expect(22        importCreationScript(dummyMysqlConfig, dummyPathToCreationScript)23    ).rejects.toBe("stderr");24    expect(execMethod).toHaveBeenCalledWith('mysql -h 127.0.0.1 -u root  < FILE');25});26it("Check DB config using Port ", async () => {...

...16  findMissingLetterSolution1,17  findMissingLetterSolution2,18} = require("../challenge/0004-find-the-missing-letter");19const { execMethod } = require("../helpers/exec-method");20execMethod("#MySolution", findMissingLetter(["a", "b", "c", "d", "f"]));21execMethod("#MySolution", findMissingLetter(["O", "Q", "R", "S"]));22execMethod("#Solution1", findMissingLetterSolution1(["a", "b", "c", "d", "f"]));23execMethod("#Solution1", findMissingLetterSolution1(["O", "Q", "R", "S"]));24execMethod("#Solution2", findMissingLetterSolution2(["a", "b", "c", "d", "f"]));...

...8  createPhoneNumberSolution2,9  createPhoneNumberSolution3,10} = require("../challenge/0002-create-phone-number");11const { execMethod } = require("../helpers/exec-method");12execMethod("#MySolution", createPhoneNumber([1, 8, 2, 6, 7, 8, 9, 6, 4, 1]));13execMethod(14  "#Solution1",15  createPhoneNumberSolution1([1, 8, 2, 6, 7, 8, 9, 6, 4, 1])16);17execMethod(18  "#Solution2",19  createPhoneNumberSolution2([1, 8, 2, 6, 7, 8, 9, 6, 4, 1])20);21execMethod(22  "#Solution3",23  createPhoneNumberSolution3([1, 8, 2, 6, 7, 8, 9, 6, 4, 1])...

...7  highAndLowSolution1,8  highAndLowSolution2,9} = require("../challenge/0001-highest-and-lowest");10const { execMethod } = require("../helpers/exec-method");11execMethod("#MyVersion", highAndLow("8 3 -5 42 -1 0 0 -9 4 7 4 -4"));12execMethod("#Solution1", highAndLowSolution1("8 3 -5 42 -1 0 0 -9 4 7 4 -4"));...

...5    } else {6        _.defer(function() {$.chartWebView.evalJS('newChart(' +JSON.stringify(options) +');');});7    }8}9function execMethod(execObject) {10    $.chartWebView.evalJS('chartExec('+JSON.stringify(execObject)+');');11}12exports.loadChart = loadChart;...

1var invert = require('invert-obj');2function ExecMethod (execMethod) {3  this.message = execMethod;4}5ExecMethod.prototype.value = function () {6  return this.message;7};8ExecMethod.Keys = {9  'UNDEFINED_UNSPECIFIED_': '0',10  'MANUAL': '1',11  'AUTOMATED': '2',12};13ExecMethod.Tag = '2405';14ExecMethod.Type = 'INT';15ExecMethod.Values = invert(ExecMethod.Keys);...