itoolkit 1.0.1 → 1.1.0-rc.0

package/test/functional/ProgramCallFunctional.js

@@ -1,106 +0,0 @@
-// Copyright (c) International Business Machines Corp. 2019
-
-// Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
-// associated documentation files (the "Software"), to deal in the Software without restriction,
-// including without limitation the rights to use, copy, modify, merge, publish, distribute,
-// sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
-// furnished to do so, subject to the following conditions:
-
-// The above copyright notice and this permission notice shall be included in all copies or
-// substantial portions of the Software.
-
-// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
-// NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
-// DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-const { expect } = require('chai');
-const { parseString } = require('xml2js');
-const { ProgramCall, Connection } = require('../../lib/itoolkit');
-const { config, printConfig } = require('./config');
-
-describe('ProgramCall Functional Tests', function () {
-  before(function () {
-    printConfig();
-  });
-
-  describe('addParam', function () {
-    it('calls QWCRSVAL program checks if it ran successfully', function (done) {
-      const connection = new Connection(config);
-
-      const program = new ProgramCall('QWCRSVAL', { lib: 'QSYS' });
-
-      const outBuf = {
-        type: 'ds',
-        io: 'out',
-        fields: [
-          { type: '10i0', value: 0 },
-          { type: '10i0', value: 0 },
-          { type: '36h', value: '' },
-          { type: '10A', value: '' },
-          { type: '1A', value: '' },
-          { type: '1A', value: '' },
-          { type: '10i0', value: 0 },
-          { type: '10i0', value: 0 },
-        ],
-      };
-
-      const errno = {
-        type: 'ds',
-        io: 'both',
-        len: 'rec2',
-        fields: [
-          {
-            name: 'bytes_provided',
-            type: '10i0',
-            value: 0,
-            setlen: 'rec2',
-          },
-          { name: 'bytes_available', type: '10i0', value: 0 },
-          { name: 'msgid', type: '7A', value: '' },
-          { type: '1A', value: '' },
-        ],
-      };
-
-      program.addParam(outBuf);
-      program.addParam({ type: '10i0', value: 66 });
-      program.addParam({ type: '10i0', value: 1 });
-      program.addParam({ type: '10A', value: 'QCCSID' });
-      program.addParam(errno);
-      connection.add(program);
-      connection.run((error, xmlOut) => {
-        expect(error).to.equal(null);
-        parseString(xmlOut, (parseError, result) => {
-          expect(parseError).to.equal(null);
-          expect(result.myscript.pgm[0].success[0]).to.include('+++ success QSYS QWCRSVAL');
-          done();
-        });
-      });
-    });
-  });
-
-  describe.skip('addReturn', function () {
-    // ZZSRV6 program requires XMLSERVICE built with tests
-    // Skip for now, we need to add before hook to check ZZSRV6 is available
-    it.skip('calls ZZVARY4 and checks the return value', function (done) {
-      const connection = new Connection(config);
-
-      const program = new ProgramCall('ZZSRV6', { lib: 'XMLSERVICE', func: 'ZZVARY4' });
-
-      program.addParam({ type: '10A', varying: '4', value: 'Gill' });
-      const testValue = 'NEW_NAME';
-      program.addReturn('0', '20A', { varying: '4', name: testValue });
-      connection.add(program);
-      connection.run((error, xmlOut) => {
-        expect(error).to.equal(null);
-        parseString(xmlOut, (parseError, result) => {
-          expect(parseError).to.equal(null);
-          expect(result.myscript.pgm[0].success[0]).to.include('+++ success');
-          expect(result.myscript.pgm[0].return[0].data[0]._).to.equal('my name is Gill');
-          done();
-        });
-      });
-    });
-  });
-});

package/test/functional/checkObjectExists.js

@@ -1,193 +0,0 @@
-/* eslint-disable default-param-last */
-
-const lib = 'NODETKTEST';
-const createLib = `CRTLIB LIB(${lib}) TYPE(*TEST) TEXT('Used to test Node.js toolkit')`;
-const findLib = `SELECT SCHEMA_NAME FROM qsys2.sysschemas WHERE SCHEMA_NAME = '${lib}'`;
-
-function checkObjectExistsSSH(config, object = {}, callback) {
-  // ssh2 is an optional dependency, since users may not use this transport
-  // thus we can't globally require it
-  // eslint-disable-next-line global-require, import/no-extraneous-dependencies
-  const { Client } = require('ssh2');
-
-  const client = new Client();
-  const checkLibCommand = `system 'CHKOBJ OBJ(QSYS/${lib}) OBJTYPE(*LIB)'`;
-  const checkObjectCommand = `system 'CHKOBJ OBJ(${lib}/${object.name}) OBJTYPE(${object.type})'`;
-
-  // if client.connect has an error it will be handled here
-  client.on('error', (error) => {
-    callback(error, false);
-  });
-
-  client.on('ready', () => {
-    client.exec(checkLibCommand, (checkLibError, checkLibStream) => {
-      /* eslint-disable no-console */
-      console.log(`executing ${checkLibCommand}`);
-      if (checkLibError) {
-        callback(checkLibError, false);
-        return;
-      }
-      checkLibStream.stderr.on('data', (data) => {
-        console.log(`STDERR: ${data}`);
-      });
-      checkLibStream.on('exit', (checkLibCode) => {
-        if (checkLibCode !== 0) {
-          if (config.verbose) { console.log(`Command exited abnormally with code: ${checkLibCode}`); }
-          const libError = new Error(`${lib} lib was not found!\nCreate it by running: ${createLib}`);
-          client.end();
-          client.destroy();
-          callback(libError, false);
-          return;
-        }
-        client.exec(checkObjectCommand, (checkObjectError, checkObjectStream) => {
-          if (config.verbose) { console.log(`executing ${checkObjectCommand}`); }
-          if (checkObjectError) {
-            client.end();
-            client.destroy();
-            callback(checkLibError, false);
-            return;
-          }
-          checkObjectStream.stderr.on('data', (data) => {
-            console.log(`STDERR: ${data}`);
-          });
-          checkObjectStream.on('exit', (checkObjectCode) => {
-            if (checkObjectCode !== 0) {
-              client.end();
-              client.destroy();
-              console.log(`Command exited abnormally with code: ${checkObjectCode}`);
-              const objectError = new Error(`${object.name} was not found!\nCreate it by running: ${object.createObject}`);
-              callback(objectError);
-              return;
-            }
-            client.end();
-            client.destroy();
-            callback(null, true);
-          });
-        });
-      });
-    });
-  });
-
-  client.connect(config);
-}
-
-function checkObjectExistsODBC(config, object = {}, callback) {
-  // odbc is an optional dependency, since users may not use this transport
-  // thus we can't globally require it
-  // eslint-disable-next-line global-require, import/no-extraneous-dependencies
-  const odbc = require('odbc');
-
-  const connectionString = config.dsn || `DRIVER=IBM i Access ODBC Driver;SYSTEM=${config.host};UID=${config.username};PWD=${config.password};`;
-
-  odbc.connect(connectionString, (connectError, connection) => {
-    if (connectError) {
-      callback(connectError, false);
-      return;
-    }
-    connection.query(findLib, (findLibError, libResult) => {
-      if (findLibError) {
-        callback(findLibError, false);
-        return;
-      }
-      if (config.verbose) {
-        console.log('find lib result set: ', libResult);
-      }
-      if (!libResult.length) {
-        const libError = new Error(`${lib} lib was not found!\nCreate it by running:${createLib}`);
-        callback(libError, false);
-        return;
-      }
-      connection.query(object.findObject, (findObjectError, result) => {
-        if (findObjectError) {
-          callback(findObjectError, false);
-          return;
-        }
-        if (config.verbose) {
-          console.log('find lib result set: ', result);
-        }
-        if (!result.length) {
-          const resultError = new Error(`${object.name} was not found! Create it by running: ${object.createObject}`);
-          callback(resultError, false);
-          return;
-        }
-        callback(null, true);
-      });
-    });
-  });
-}
-
-function checkObjectExistsIDB(config, object = {}, callback) {
-  // idb-connector is an optional dependency, since users may not use this transport
-  // thus we can't globally require it
-  // eslint-disable-next-line max-len
-  // eslint-disable-next-line global-require, import/no-extraneous-dependencies, import/no-unresolved
-  const { dbconn, dbstmt } = require('idb-connector');
-
-  /* eslint-disable new-cap */
-  const connection = new dbconn();
-  connection.conn('*LOCAL');
-  const statement = new dbstmt(connection);
-
-  statement.exec(findLib, (libResult, error) => {
-    if (error) {
-      callback(error, null);
-      return;
-    }
-    if (config.verbose) {
-      console.log('find lib result set: ', libResult);
-    }
-    if (!libResult.length) {
-      const libError = new Error(`${lib} lib was not found! Create it by running: ${createLib}`);
-      callback(libError, null);
-      return;
-    }
-    statement.closeCursor();
-    statement.exec(object.findObject, (result, findObjecError) => {
-      if (findObjecError) {
-        callback(findObjecError, null);
-        return;
-      }
-      if (config.verbose) {
-        console.log('find object result set: ', result);
-      }
-      if (!result.length) {
-        const resultError = new Error(`${object.name} was not found! Create it by running: ${object.createObject}`);
-        callback(resultError, null);
-        return;
-      }
-      statement.close();
-      connection.disconn();
-      connection.close();
-      callback(null, true);
-    });
-  });
-}
-
-function checkObjectExists(config, name, type, callback) {
-  const object = { type };
-
-  if (type === '*DTAARA') {
-    object.name = name;
-    object.createObject = `CRTDTAARA DTAARA(${lib}/${name}) TYPE(*CHAR) TEXT('TEST DATA AREA FOR NODE TOOLKIT') VALUE('Hello From Test Data Area!')`;
-  } else if (type === '*DTAQ') {
-    object.name = name;
-    object.createObject = `CRTDTAQ DTAQ(${lib}/${name}) MAXLEN(100) AUT(*EXCLUDE) TEXT('TEST DQ FOR NODE TOOLKIT TESTS')`;
-  }
-
-  object.findObject = `SELECT OBJNAME FROM TABLE (QSYS2.OBJECT_STATISTICS('${lib}', '${type}')) AS X WHERE OBJNAME = '${name}'`;
-  // eslint-disable-next-line no-param-reassign
-  config.transportOptions.verbose = config.verbose;
-
-  if (config.transport === 'idb') {
-    checkObjectExistsIDB(config.transportOptions, object, callback);
-  } else if (config.transport === 'odbc') {
-    checkObjectExistsODBC(config.transportOptions, object, callback);
-  } else if (config.transport === 'ssh') {
-    checkObjectExistsSSH(config.transportOptions, object, callback);
-  } else {
-    // we cannot check object existence using the rest transport
-    callback(null, true);
-  }
-}
-
-module.exports.checkObjectExists = checkObjectExists;

package/test/functional/checkVersion.js

@@ -1,17 +0,0 @@
-/**
- * Checks if XMLSERVICE version supports QSH.
- * XMLSERVICE >= 1.9.8 supports QSH
- * @param {string} version - expects sematic version i.e. 1.2.3
- */
-function isQSHSupported(version) {
-  // maps array of strings to numbers i.e. ['1', '2', '3'] -> [1, 2, 3]
-  const semver = version.split('.').map(Number);
-  if (semver[0] === 1 && semver[1] < 9) {
-    return false;
-  } if (semver[0] === 1 && semver[1] === 9 && semver[2] < 8) {
-    return false;
-  }
-  return true;
-}
-
-module.exports.isQSHSupported = isQSHSupported;

package/test/functional/config.js

@@ -1,35 +0,0 @@
-const { readFileSync } = require('fs');
-
-let privateKey;
-if (process.env.TKPK) {
-  privateKey = readFileSync(process.env.TKPK, 'utf-8');
-}
-
-const config = {
-  transport: process.env.TKTRANSPORT || 'ssh',
-  verbose: !!process.env.TKVERBOSE,
-  transportOptions: {
-    database: process.env.TKDB || '*LOCAL',
-    username: process.env.TKUSER || '',
-    password: process.env.TKPASS || '',
-    host: process.env.TKHOST || 'localhost',
-    port: process.env.TKPORT,
-    path: process.env.TKPATH || '/cgi-bin/xmlcgi.pgm',
-    url: process.env.TKURL,
-    privateKey,
-    // passphrase is used by the ssh transport to decrypt the private key
-    passphrase: process.env.TKPHRASE,
-    dsn: process.env.TKDSN,
-  },
-};
-
-function printConfig() {
-/* eslint-disable no-console */
-  console.log('-----------------------');
-  console.log('transport:', config.transport);
-  console.log(`verbose: ${config.verbose ? 'on' : 'off'}`);
-  console.log('-----------------------');
-}
-
-module.exports.config = config;
-module.exports.printConfig = printConfig;

package/test/functional/deprecated/commandsFunctional.js

@@ -1,108 +0,0 @@
-// Copyright (c) International Business Machines Corp. 2019
-
-// Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
-// associated documentation files (the "Software"), to deal in the Software without restriction,
-// including without limitation the rights to use, copy, modify, merge, publish, distribute,
-// sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
-// furnished to do so, subject to the following conditions:
-
-// The above copyright notice and this permission notice shall be included in all copies or
-// substantial portions of the Software.
-
-// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
-// NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
-// DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-/* eslint-disable new-cap */
-
-const { expect } = require('chai');
-const { parseString } = require('xml2js');
-const {
-  iCmd, iSh, iQsh, iConn, iPgm,
-} = require('../../../lib/itoolkit');
-
-const { config, printConfig } = require('../config');
-const { isQSHSupported } = require('../checkVersion');
-
-// deprecated tests are in place to test compatability using deprecated classes and functions
-// these tests use deprecated iConn Class to create a connnection
-// iConn only supported idb and rest transports
-if (config.transport !== 'idb' && config.transport !== 'rest') {
-  throw new Error('Only idb and rest transports are available for deprecated tests');
-}
-const {
-  database, username, password, host, port = 80, path,
-} = config.transportOptions;
-
-let restOptions = null;
-if (config.transport === 'rest') {
-  restOptions = {
-    host,
-    port,
-    path,
-  };
-}
-
-describe('iSh, iCmd, iQsh, Functional Tests', function () {
-  before(function () {
-    printConfig();
-  });
-
-  describe('iCmd()', function () {
-    it('calls CL command', function (done) {
-      const connection = new iConn(database, username, password, restOptions);
-      connection.add(iCmd('RTVJOBA USRLIBL(?) SYSLIBL(?)'));
-      connection.run((xmlOut) => {
-        parseString(xmlOut, (parseError, result) => {
-          expect(parseError).to.equal(null);
-          expect(result.myscript.cmd[0].success[0]).to.include('+++ success RTVJOBA USRLIBL(?) SYSLIBL(?)');
-          done();
-        });
-      });
-    });
-  });
-
-  describe('iSh()', function () {
-    it('calls PASE shell command', function (done) {
-      const connection = new iConn(database, username, password, restOptions);
-      connection.add(iSh('system -i wrksyssts'));
-      connection.run((xmlOut) => {
-        // xs does not return success property for sh or qsh command calls
-        // but on error sh or qsh node will not have any inner data
-        parseString(xmlOut, (parseError, result) => {
-          expect(parseError).to.equal(null);
-          expect(result.myscript.sh[0]._).to.match(/(System\sStatus\sInformation)/);
-          done();
-        });
-      });
-    });
-  });
-
-  describe('iQsh()', function () {
-    it('calls QSH command', function (done) {
-      const connection = new iConn(database, username, password, restOptions);
-      connection.add(new iPgm('MYPGMTOOLONG'));
-      connection.add(iQsh('system wrksyssts'));
-      connection.run((xmlOut) => {
-        // xs does not return success property for sh or qsh command calls
-        // but on error sh or qsh node will not have any inner data
-        parseString(xmlOut, (parseError, result) => {
-          expect(parseError).to.equal(null);
-          const match = result.myscript.pgm[0].version[0].match(/\d\.\d\.\d/);
-          if (!match) {
-            throw Error('Unable to determine XMLSERVICE version');
-          }
-          if (!isQSHSupported(match[0])) {
-            // skip if QSH is unsupported
-            console.log(`XMLSERVICE version ${match[0]} does not support QSH`);
-            this.skip();
-          }
-          expect(result.myscript.qsh[0]._).to.match(/(System\sStatus\sInformation)/);
-          done();
-        });
-      });
-    });
-  });
-});

package/test/functional/deprecated/iDataQueueFunctional.js

@@ -1,103 +0,0 @@
-// Copyright (c) International Business Machines Corp. 2019
-
-// Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
-// associated documentation files (the "Software"), to deal in the Software without restriction,
-// including without limitation the rights to use, copy, modify, merge, publish, distribute,
-// sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
-// furnished to do so, subject to the following conditions:
-
-// The above copyright notice and this permission notice shall be included in all copies or
-// substantial portions of the Software.
-
-// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
-// NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
-// DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-/* eslint-disable new-cap */
-
-const { expect } = require('chai');
-const { iConn, iDataQueue } = require('../../../lib/itoolkit');
-const { config, printConfig } = require('../config');
-const { checkObjectExists } = require('../checkObjectExists');
-
-// deprecated tests are in place to test compatability using deprecated classes and functions
-// these tests use deprecated iConn Class to create a connnection.
-// iConn only supported idb and rest transports
-if (config.transport !== 'idb' && config.transport !== 'rest') {
-  throw new Error('Only idb and rest transports are available for deprecated tests');
-}
-
-const {
-  database, username, password, host, port = 80, path,
-} = config.transportOptions;
-
-let restOptions = null;
-if (config.transport === 'rest') {
-  restOptions = {
-    host,
-    port,
-    path,
-  };
-}
-
-const lib = 'NODETKTEST'; const dqName = 'TESTQ';
-
-describe('iDataQueue Functional Tests', function () {
-  before('check if data queue exists for tests', function (done) {
-    printConfig();
-    checkObjectExists(config, dqName, '*DTAQ', (error) => {
-      if (error) { throw error; }
-      done();
-    });
-  });
-
-  describe('constructor', function () {
-    it('creates and returns an instance of iDataQueue', function () {
-      const connection = new iConn(database, config.user, password);
-
-      const dq = new iDataQueue(connection);
-      expect(dq).to.be.instanceOf(iDataQueue);
-    });
-  });
-
-  describe('sendToDataQueue', function () {
-    it('sends data to specified DQ', function (done) {
-      const connection = new iConn(database, username, password, restOptions);
-
-      const dq = new iDataQueue(connection);
-
-      dq.sendToDataQueue(dqName, lib, 'Hello from DQ!', (output) => {
-        expect(output).to.equal(true);
-        done();
-      });
-    });
-  });
-
-  describe('receiveFromDataQueue', function () {
-    it('receives data from specfied DQ', function (done) {
-      const connection = new iConn(database, username, password, restOptions);
-
-      const dq = new iDataQueue(connection);
-
-      dq.receiveFromDataQueue(dqName, lib, 100, (output) => {
-        expect(output).to.be.a('string').and.to.equal('Hello from DQ!');
-        done();
-      });
-    });
-  });
-
-  describe('clearDataQueue', function () {
-    it('clears the specifed DQ', function (done) {
-      const connection = new iConn(database, username, password, restOptions);
-
-      const dq = new iDataQueue(connection);
-
-      dq.clearDataQueue(dqName, lib, (output) => {
-        expect(output).to.equal(true);
-        done();
-      });
-    });
-  });
-});