itoolkit 1.0.0 → 1.0.2

package/test/functional/checkObjectExists.js

@@ -1,182 +0,0 @@
-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) {
-  /* eslint-disable global-require */
-  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) {
-  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) {
-  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/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,99 +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-env mocha */
-/* eslint-disable new-cap */
-
-
-const { expect } = require('chai');
-const { parseString } = require('xml2js');
-const {
-  iCmd, iSh, iQsh, iConn,
-} = require('../../../lib/itoolkit');
-
-const { config, printConfig } = require('../config');
-
-// 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', () => {
-  before(() => {
-    printConfig();
-  });
-
-  describe('iCmd()', () => {
-    it('calls CL command', (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()', () => {
-    it('calls PASE shell command', (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()', () => {
-    it('calls QSH command', (done) => {
-      const connection = new iConn(database, username, password, restOptions);
-      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);
-          expect(result.myscript.qsh[0]._).to.match(/(System\sStatus\sInformation)/);
-          done();
-        });
-      });
-    });
-  });
-});

package/test/functional/deprecated/iDataQueueFunctional.js

@@ -1,104 +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-env mocha */
-/* 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', () => {
-  before('check if data queue exists for tests', (done) => {
-    printConfig();
-    checkObjectExists(config, dqName, '*DTAQ', (error) => {
-      if (error) { throw error; }
-      done();
-    });
-  });
-
-  describe('constructor', () => {
-    it('creates and returns an instance of iDataQueue', () => {
-      const connection = new iConn(database, config.user, password);
-
-      const dq = new iDataQueue(connection);
-      expect(dq).to.be.instanceOf(iDataQueue);
-    });
-  });
-
-  describe('sendToDataQueue', () => {
-    it('sends data to specified DQ', (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', () => {
-    it('receives data from specfied DQ', (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', () => {
-    it('clears the specifed DQ', (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();
-      });
-    });
-  });
-});

package/test/functional/deprecated/iNetworkFunctional.js

@@ -1,160 +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-env mocha */
-/* eslint-disable new-cap */
-
-const { expect } = require('chai');
-const { iConn, iNetwork } = require('../../../lib/itoolkit');
-const { config, printConfig } = require('../config');
-
-// 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('iNetwork Functional Tests', () => {
-  before(() => {
-    printConfig();
-  });
-
-  describe('constructor', () => {
-    it('creates and returns an instance of iNetwork', () => {
-      const connection = new iConn(database, config.user, password);
-
-      const net = new iNetwork(connection);
-
-      expect(net).to.be.instanceOf(iNetwork);
-    });
-  });
-
-  describe('getTCPIPAttr', () => {
-    it('retrieves TCP/IP Attributes', (done) => {
-      const connection = new iConn(database, username, password, restOptions);
-
-      const net = new iNetwork(connection);
-
-      net.getTCPIPAttr((output) => {
-        expect(output).to.be.an('Object');
-        expect(output).to.have.a.property('TCP/IPv4_stack_status');
-        expect(output).to.have.a.property('How_long_active');
-        expect(output).to.have.a.property('When_last_started_-_date');
-        expect(output).to.have.a.property('When_last_started_-_time');
-        expect(output).to.have.a.property('When_last_ended_-_date');
-        expect(output).to.have.a.property('When_last_ended_-_time');
-        expect(output).to.have.a.property('Who_last_started_-_job_name');
-        expect(output).to.have.a.property('Who_last_started_-_job_user_name');
-        expect(output).to.have.a.property('Who_last_started_-_job_number');
-        expect(output).to.have.a.property('Who_last_started_-_internal_job_identifier');
-        expect(output).to.have.a.property('Who_last_ended_-_job_name');
-        expect(output).to.have.a.property('Who_last_ended_-_job_user_name');
-        expect(output).to.have.a.property('Who_last_ended_-_job_number');
-        expect(output).to.have.a.property('Who_last_ended_-_internal_job_identifier');
-        expect(output).to.have.a.property('Offset_to_additional_information');
-        expect(output).to.have.a.property('Length_of_additional_information');
-        expect(output).to.have.a.property('Limited_mode');
-        expect(output).to.have.a.property('Offset_to_list_of_Internet_addresses');
-        expect(output).to.have.a.property('Number_of_Internet_addresses');
-        expect(output).to.have.a.property('Entry_length_for_list_of_Internet_addresses');
-        expect(output).to.have.a.property('DNS_protocol');
-        expect(output).to.have.a.property('Retries');
-        expect(output).to.have.a.property('Time_interval');
-        expect(output).to.have.a.property('Search_order');
-        expect(output).to.have.a.property('Initial_domain_name_server');
-        expect(output).to.have.a.property('DNS_listening_port');
-        expect(output).to.have.a.property('Host_name');
-        expect(output).to.have.a.property('Domain_name');
-        expect(output).to.have.a.property('Domain_search_list');
-        done();
-      });
-    });
-  });
-
-  describe('getNetInterfaceData', () => {
-    it('retrieves IPv4 network interface info', (done) => {
-      const connection = new iConn(database, username, password, restOptions);
-
-      const net = new iNetwork(connection);
-
-      net.getNetInterfaceData('127.0.0.1', (output) => {
-        expect(output).to.be.an('Object');
-        expect(output).to.have.a.property('Internet_address');
-        expect(output).to.have.a.property('Internet_address_binary');
-        expect(output).to.have.a.property('Network_address');
-        expect(output).to.have.a.property('Network_address_binary');
-        expect(output).to.have.a.property('Line_description');
-        expect(output).to.have.a.property('Interface_status');
-        expect(output).to.have.a.property('Interface_type_of_service');
-        expect(output).to.have.a.property('Interface_MTU');
-        expect(output).to.have.a.property('Interface_line_type');
-        expect(output).to.have.a.property('Host_address');
-        expect(output).to.have.a.property('Host_address_binary');
-        expect(output).to.have.a.property('Interface_subnet_mask');
-        expect(output).to.have.a.property('Interface_subnet_mask_binary');
-        expect(output).to.have.a.property('Directed_broadcast_address');
-        expect(output).to.have.a.property('Directed_broadcast_address_binary');
-        expect(output).to.have.a.property('Change_date');
-        expect(output).to.have.a.property('Change_time');
-        expect(output).to.have.a.property('Associated_local_interface');
-        expect(output).to.have.a.property('Associated_local_interface_binary');
-        expect(output).to.have.a.property('Packet_rules');
-        expect(output).to.have.a.property('Change_status');
-        expect(output).to.have.a.property('Automatic_start');
-        expect(output).to.have.a.property('TRLAN_bit_sequencing');
-        expect(output).to.have.a.property('Interface_type');
-        expect(output).to.have.a.property('Proxy_ARP_allowed');
-        expect(output).to.have.a.property('Proxy_ARP_enabled');
-        expect(output).to.have.a.property('Configured_MTU');
-        expect(output).to.have.a.property('Network_name');
-        expect(output).to.have.a.property('Interface_name');
-        expect(output).to.have.a.property('Alias_name');
-        expect(output).to.have.a.property('Interface_description');
-        expect(output).to.have.a.property('Offset_to_preferred_interface_list');
-        expect(output).to.have.a.property('Number_of_entries_in_preferred_interface_list');
-        expect(output).to.have.a.property('Length_of_one_preferred_interface_list_entry');
-        expect(output).to.have.a.property('DHCP_created');
-        expect(output).to.have.a.property('DHCP_dynamic_DNS_updates');
-        expect(output).to.have.a.property('DHCP_lease_expiration');
-        expect(output).to.have.a.property('DHCP_lease_expiration_-_date');
-        expect(output).to.have.a.property('DHCP_lease_expiration_-_time');
-        expect(output).to.have.a.property('DHCP_lease_obtained');
-        expect(output).to.have.a.property('DHCP_lease_obtained_-_date');
-        expect(output).to.have.a.property('DHCP_lease_obtained_-_time');
-        expect(output).to.have.a.property('Use_DHCP_unique_identifier');
-        expect(output).to.have.a.property('DHCP_server_IP_address');
-        expect(output).to.have.a.property('Preferred_interface_Internet_address');
-        expect(output).to.have.a.property('Preferred_interface_Internet_address_binary');
-        done();
-      });
-    });
-  });
-});