itoolkit 1.0.1 → 1.1.0-rc.0

package/test/unit/ProgamCallUnit.js

@@ -1,281 +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 { ProgramCall } = require('../../lib/itoolkit');
-
-const outBuf = [
-  { 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: '10i0', value: 0 },
-  { type: '10i0', value: 0, setlen: 'rec2' },
-  { type: '7A', value: '' },
-  { type: '1A', value: '' },
-];
-
-describe('ProgramCall Class Unit Tests', function () {
-  describe('constructor', function () {
-    it('creates and returns an instance of ProgramCall with lib and function set', function () {
-      const pgm = new ProgramCall('QTOCNETSTS');
-      expect(pgm).to.be.instanceOf(ProgramCall);
-    });
-  });
-
-  describe('toXML', function () {
-    it('returns pgm XML', function () {
-      const pgm = new ProgramCall(
-        'QTOCNETSTS',
-        {
-          lib: 'QSYS',
-          func: 'QtoRtvTCPA',
-          error: 'on',
-        },
-      );
-
-      const expectedXML = '<pgm name=\'QTOCNETSTS\' lib=\'QSYS\' func=\'QtoRtvTCPA\' error=\'on\'></pgm>';
-
-      expect(pgm.toXML()).to.be.a('string').and.to.equal(expectedXML);
-    });
-  });
-
-  describe('addParam', function () {
-    it('appends param to pgm xml', function () {
-      const pgm = new ProgramCall(
-        'QTOCNETSTS',
-        {
-          lib: 'QSYS',
-          func: 'QtoRtvTCPA',
-          error: 'fast',
-        },
-      );
-
-      pgm.addParam({ type: 'ds', io: 'out', fields: outBuf });
-
-      let expectedXML = '<pgm name=\'QTOCNETSTS\' lib=\'QSYS\' func=\'QtoRtvTCPA\' error=\'fast\'>'
-      + '<parm io=\'out\'><ds><data type=\'10i0\'>0</data><data type=\'10i0\'>'
-      + '0</data><data type=\'36h\'></data><data type=\'10A\'></data>'
-      + '<data type=\'1A\'></data><data type=\'1A\'></data><data type=\'10i0\'>'
-      + '0</data><data type=\'10i0\'>0</data></ds></parm></pgm>';
-
-      expect(pgm.toXML()).to.equal(expectedXML);
-
-      pgm.addParam({ value: 66, type: '10i0' });
-
-      expectedXML = '<pgm name=\'QTOCNETSTS\' lib=\'QSYS\' func=\'QtoRtvTCPA\' error=\'fast\'>'
-      + '<parm io=\'out\'><ds><data type=\'10i0\'>0</data><data type=\'10i0\'>'
-      + '0</data><data type=\'36h\'></data><data type=\'10A\'></data>'
-      + '<data type=\'1A\'></data><data type=\'1A\'></data><data type=\'10i0\'>'
-      + '0</data><data type=\'10i0\'>0</data></ds></parm>'
-      + '<parm><data type=\'10i0\'>66</data></parm></pgm>';
-
-      expect(pgm.toXML()).to.equal(expectedXML);
-
-      pgm.addParam({ value: 1, type: '10i0' });
-
-      expectedXML = '<pgm name=\'QTOCNETSTS\' lib=\'QSYS\' func=\'QtoRtvTCPA\' error=\'fast\'>'
-      + '<parm io=\'out\'><ds><data type=\'10i0\'>0</data><data type=\'10i0\'>'
-      + '0</data><data type=\'36h\'></data><data type=\'10A\'></data>'
-      + '<data type=\'1A\'></data><data type=\'1A\'></data><data type=\'10i0\'>'
-      + '0</data><data type=\'10i0\'>0</data></ds></parm>'
-      + '<parm><data type=\'10i0\'>66</data></parm>'
-      + '<parm><data type=\'10i0\'>1</data></parm></pgm>';
-
-      expect(pgm.toXML()).to.equal(expectedXML);
-
-      pgm.addParam({ value: 'QCCSID', type: '10A' });
-
-      expectedXML = '<pgm name=\'QTOCNETSTS\' lib=\'QSYS\' func=\'QtoRtvTCPA\' error=\'fast\'>'
-      + '<parm io=\'out\'><ds><data type=\'10i0\'>0</data><data type=\'10i0\'>'
-      + '0</data><data type=\'36h\'></data><data type=\'10A\'></data>'
-      + '<data type=\'1A\'></data><data type=\'1A\'></data><data type=\'10i0\'>'
-      + '0</data><data type=\'10i0\'>0</data></ds></parm>'
-      + '<parm><data type=\'10i0\'>66</data></parm>'
-      + '<parm><data type=\'10i0\'>1</data></parm>'
-      + '<parm><data type=\'10A\'>QCCSID</data></parm></pgm>';
-
-      expect(pgm.toXML()).to.equal(expectedXML);
-
-      pgm.addParam({
-        type: 'ds', io: 'both', len: 'rec2', fields: errno,
-      });
-
-      expectedXML = '<pgm name=\'QTOCNETSTS\' lib=\'QSYS\' func=\'QtoRtvTCPA\' error=\'fast\'>'
-      + '<parm io=\'out\'><ds><data type=\'10i0\'>0</data><data type=\'10i0\'>'
-      + '0</data><data type=\'36h\'></data><data type=\'10A\'></data>'
-      + '<data type=\'1A\'></data><data type=\'1A\'></data><data type=\'10i0\'>'
-      + '0</data><data type=\'10i0\'>0</data></ds></parm>'
-      + '<parm><data type=\'10i0\'>66</data></parm>'
-      + '<parm><data type=\'10i0\'>1</data></parm>'
-      + '<parm><data type=\'10A\'>QCCSID</data></parm>'
-      + '<parm io=\'both\'><ds len=\'rec2\'><data type=\'10i0\'>0</data>'
-      + '<data type=\'10i0\' setlen=\'rec2\'>0</data><data type=\'7A\'>'
-      + '</data><data type=\'1A\'></data></ds></parm></pgm>';
-
-      expect(pgm.toXML()).to.equal(expectedXML);
-    });
-
-    it('regular <parm> contains by=\'val\'', function () {
-      const pgm = new ProgramCall('MYPGM', { lib: 'MYLIB', func: 'MY_PROCEDURE' });
-
-      pgm.addParam({ value: '', type: '1A', by: 'val' });
-      pgm.addReturn({ name: 'output', type: '2A', value: '' });
-
-      const lookAtXML = pgm.toXML();
-      expect(lookAtXML).to.match(/<parm .*by='val'.*>/);
-    });
-
-    it('data structure <parm> contains by=\'val\'', function () {
-      const pgm = new ProgramCall('MYPGM', { lib: 'MYLIB', func: 'MY_PROCEDURE' });
-
-      const params = [
-        { type: '3s0', value: 0 },
-        { type: '7s0', value: 0, name: 'ds_fld2' },
-      ];
-
-      pgm.addParam({
-        name: 'inds', type: 'ds', by: 'val', fields: params,
-      });
-      pgm.addReturn({ name: 'output', type: '2A', value: '' });
-
-      const lookAtXML = pgm.toXML();
-      expect(lookAtXML).to.match(/<parm .*by='val'.*>/);
-    });
-
-    it('regular <parm> contains by=\'val\', with io=\'both\'', function () {
-      const pgm = new ProgramCall('MYPGM', { lib: 'MYLIB', func: 'MY_PROCEDURE' });
-
-      pgm.addParam({
-        value: '', type: '1A', by: 'val', io: 'both',
-      });
-      pgm.addReturn({ name: 'output', type: '2A', value: '' });
-
-      const lookAtXML = pgm.toXML();
-      expect(lookAtXML).to.match(/<parm .*by='val'.*>/);
-      expect(lookAtXML).to.match(/<parm .*io='both'.*>/);
-    });
-
-    it('data structure <parm> contains by=\'val\', with io=\'both\'', function () {
-      const pgm = new ProgramCall('MYPGM', { lib: 'MYLIB', func: 'MY_PROCEDURE' });
-
-      const params = [
-        { type: '3s0', value: 0 },
-        { type: '7s0', value: 0, name: 'ds_fld2' },
-      ];
-
-      pgm.addParam({
-        name: 'inds', type: 'ds', by: 'val', io: 'both', fields: params,
-      });
-      pgm.addReturn({ name: 'output', type: '2A', value: '' });
-
-      const lookAtXML = pgm.toXML();
-      expect(lookAtXML).to.match(/<parm .*by='val'.*>/);
-      expect(lookAtXML).to.match(/<parm .*io='both'.*>/);
-    });
-
-    it('add nested data structure parameter', function () {
-      const pgm = new ProgramCall('MYPGM', { lib: 'MYLIB' });
-
-      const nestedDs = {
-        name: 'outer-ds',
-        type: 'ds',
-        fields: [
-          {
-            name: 'sub-ds1',
-            type: 'ds',
-            fields: [
-              { type: '10i0', value: 0 },
-              { type: '4A', value: 'test' },
-            ],
-          },
-          {
-            name: 'sub-ds2',
-            type: 'ds',
-            fields: [
-              { type: '20i0', value: 1 },
-              { type: '6A', value: 'test 2' },
-            ],
-          },
-        ],
-      };
-
-      pgm.addParam(nestedDs);
-      const expectedXML = '<pgm name=\'MYPGM\' lib=\'MYLIB\' error=\'fast\'>'
-                             + '<parm name=\'outer-ds\'>'
-                              + '<ds name=\'outer-ds\'>'
-                              + '<ds name=\'sub-ds1\'>'
-                              + '<data type=\'10i0\'>0</data>'
-                              + '<data type=\'4A\'>test</data>'
-                              + '</ds>'
-                              + '<ds name=\'sub-ds2\'>'
-                              + '<data type=\'20i0\'>1</data>'
-                              + '<data type=\'6A\'>test 2</data>'
-                              + '</ds>'
-                              + '</ds>'
-                             + '</parm>'
-                           + '</pgm>';
-      expect(pgm.toXML()).to.equal(expectedXML);
-    });
-  });
-
-  describe('addReturn', function () {
-    it('appends return to pgm xml', function () {
-      const pgm = new ProgramCall(
-        'QTOCNETSTS',
-        {
-          lib: 'QSYS',
-          func: 'QtoRtvTCPA',
-          error: 'fast',
-        },
-      );
-
-      pgm.addReturn({ type: '20A', value: '0' });
-
-      const expectedXML = '<pgm name=\'QTOCNETSTS\' lib=\'QSYS\' func=\'QtoRtvTCPA\' '
-      + 'error=\'fast\'><return><data type=\'20A\'>0</data></return></pgm>';
-
-      expect(pgm.toXML()).to.equal(expectedXML);
-    });
-
-    it('appends return with ds to pgm xml', function () {
-      const pgm = new ProgramCall('TEST');
-
-      const ds = {
-        name: 'test_ds',
-        type: 'ds',
-        io: 'out',
-        fields: [
-          { type: '10i0', value: 0 },
-          { type: '10A', value: '' },
-        ],
-      };
-      pgm.addReturn(ds);
-
-      const expectedXML = "<pgm name='TEST' error='fast'><return><ds name='test_ds'>"
-      + "<data type='10i0'>0</data><data type='10A'></data></ds></return></pgm>";
-
-      expect(pgm.toXML()).to.equal(expectedXML);
-    });
-  });
-});

package/test/unit/deprecated/commandsUnit.js

@@ -1,87 +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 { iSh, iQsh, iCmd } = require('../../../lib/itoolkit');
-
-describe('iSh, iCmd, iQsh, Unit Tests', function () {
-  describe('iSh function', function () {
-    it('accepts command input and returns <sh> XML output', function () {
-      const sh = iSh('ls -lah');
-
-      const expectedXML = '<sh error=\'fast\'>ls -lah</sh>';
-
-      expect(sh).to.be.a('string').and.to.equal(expectedXML);
-    });
-
-    it('accepts command input and options returns <sh> with optional attributes', function () {
-      const options = {
-        error: 'on', before: '65535', after: '37', rows: 'on',
-      };
-
-      const sh = iSh('ls -lah', options);
-
-      const expectedXML = '<sh rows=\'on\' before=\'65535\' after=\'37\' error=\'on\'>ls -lah</sh>';
-
-      expect(sh).to.be.a('string').and.to.equal(expectedXML);
-    });
-  });
-
-  describe('iCmd function', function () {
-    it('accepts command input and returns <cmd> XML output', function () {
-      const cmd = iCmd('RTVJOBA USRLIBL(?) SYSLIBL(?)');
-
-      const expectedXML = '<cmd exec=\'rexx\' error=\'fast\'>RTVJOBA USRLIBL(?) SYSLIBL(?)</cmd>';
-
-      expect(cmd).to.be.a('string').and.to.equal(expectedXML);
-    });
-
-    it('accepts command input and options returns <cmd> with optional attributes', function () {
-      const options = {
-        exec: 'cmd', error: 'on', before: '65535', after: '37', hex: 'on',
-      };
-
-      const cmd = iCmd('RTVJOBA USRLIBL(?) SYSLIBL(?)', options);
-
-      const expectedXML = '<cmd exec=\'cmd\' hex=\'on\' before=\'65535\' after=\'37\' error=\'on\''
-                          + '>RTVJOBA USRLIBL(?) SYSLIBL(?)</cmd>';
-
-      expect(cmd).to.be.a('string').and.to.equal(expectedXML);
-    });
-  });
-
-  describe('iQsh function', function () {
-    it('accepts command input and returns <qsh> XML output', function () {
-      const qsh = iQsh('RTVJOBA USRLIBL(?) SYSLIBL(?)');
-
-      const expectedXML = '<qsh error=\'fast\'>RTVJOBA USRLIBL(?) SYSLIBL(?)</qsh>';
-
-      expect(qsh).to.be.a('string').and.to.equal(expectedXML);
-    });
-
-    it('accepts command input and options returns <qsh> with optional attributes', function () {
-      const options = {
-        error: 'on', before: '65535', after: '37', rows: 'on',
-      };
-      const qsh = iQsh('ls -lah', options);
-
-      const expectedXML = '<qsh rows=\'on\' before=\'65535\' after=\'37\' error=\'on\'>ls -lah</qsh>';
-
-      expect(qsh).to.be.a('string').and.to.equal(expectedXML);
-    });
-  });
-});

package/test/unit/deprecated/iConnUnit.js

@@ -1,158 +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 sinon = require('sinon');
-const { iConn, iSh } = require('../../../lib/itoolkit');
-
-describe('iConn Class Unit Tests', function () {
-  describe('constructor', function () {
-    it('creates and returns an instance of iConn with idb transport', function () {
-      const database = process.env.TKDB || '*LOCAL';
-      const username = process.env.TKUSER || '';
-      const password = process.env.TKPASS || '';
-
-      const connection = new iConn(database, username, password);
-
-      expect(connection).to.be.instanceOf(iConn);
-      expect(connection.connection.transportOptions).to.be.an('Object');
-      expect(connection.connection.transportOptions.database).to.equal(database);
-      expect(connection.connection.transportOptions.username).to.equal(username);
-      expect(connection.connection.transportOptions.password).to.equal(password);
-      expect(connection.connection.transport).to.equal('idb');
-      expect(connection.connection.commandList).to.be.an('Array');
-      expect(connection.connection.commandList.length).to.equal(0);
-      expect(connection.connection.verbose).to.equal(false);
-    });
-
-    it('creates and returns an instance of iConn with rest transport', function () {
-      const database = process.env.TKDB || '*LOCAL';
-      const username = process.env.TKUSER || '';
-      const password = process.env.TKPASS || '';
-
-      const options = {
-        host: process.env.TKHOST || 'localhost',
-        port: process.env.TKPORT || 80,
-        path: process.env.TKPATH || '/cgi-bin/xmlcgi.pgm',
-        xslib: 'QXMLSERV',
-        ipc: '*NA',
-        ctl: '*here',
-      };
-
-      const connection = new iConn(database, username, password, options);
-
-      expect(connection).to.be.instanceOf(iConn);
-      expect(connection.connection.transportOptions).to.be.an('Object');
-      expect(connection.connection.transportOptions.database).to.equal(database);
-      expect(connection.connection.transportOptions.username).to.equal(username);
-      expect(connection.connection.transportOptions.password).to.equal(password);
-      expect(connection.connection.transport).to.equal('rest');
-      expect(connection.connection.transportOptions.ctl).to.equal('*here');
-      expect(connection.connection.transportOptions.ipc).to.equal('*NA');
-      expect(connection.connection.transportOptions.xslib).to.equal('QXMLSERV');
-      expect(connection.connection.commandList).to.be.an('Array');
-      expect(connection.connection.commandList.length).to.equal(0);
-      expect(connection.connection.verbose).to.equal(false);
-    });
-  });
-
-  describe('add', function () {
-    it('appends to xml service request to the command list using iConn class', function () {
-      const database = process.env.TKDB || '*LOCAL';
-      const username = process.env.TKUSER || '';
-      const password = process.env.TKPASS || '';
-      const connection = new iConn(database, username, password);
-
-      connection.add(iSh('ls -lah'));
-      expect(connection.connection.commandList.length).to.equal(1);
-      expect(connection.connection.commandList[0]).to.equal('<sh error=\'fast\'>ls -lah</sh>');
-    });
-  });
-
-  describe('debug', function () {
-    it('turns verbose mode on/off using iConn class', function () {
-      const database = process.env.TKDB || '*LOCAL';
-      const username = process.env.TKUSER || '';
-      const password = process.env.TKPASS || '';
-      const connection = new iConn(database, username, password);
-
-      connection.debug(true);
-      expect(connection.debug()).to.equal(true);
-      connection.debug(false);
-      expect(connection.debug()).to.equal(false);
-    });
-  });
-
-  describe('getTransportOptions', function () {
-    it('returns conn (object) property from iConn instance', function () {
-      const database = process.env.TKDB || '*LOCAL';
-      const username = process.env.TKUSER || '';
-      const password = process.env.TKPASS || '';
-
-      const connection = new iConn(database, username, password);
-
-      // iConn.getConnection() calls -> Connection.getTransportOptions()
-      const options = connection.getConnection();
-
-      expect(options).to.be.an('Object');
-      expect(options.database).to.equal(database);
-      expect(options.username).to.equal(username);
-      expect(options.password).to.equal(password);
-    });
-  });
-
-  describe('run', function () {
-    it('(iConn) invokes transport to execute xml input and returns xml output in callback', function () {
-      const database = process.env.TKDB || '*LOCAL';
-      const username = process.env.TKUSER || '';
-      const password = process.env.TKPASS || '';
-
-      const connection = new iConn(database, username, password);
-      const xmlOut = `<?xml version='1.0'?><myscript><sql>
-      <query error='fast' conn='conn1' stmt='stmt1'>
-      <success><![CDATA[+++ success SELECT LSTNAM, STATE FROM QIWS.QCUSTCDT]]></success>
-      </query>
-      <fetch block='all' desc='on' stmt='stmt1'>
-      <row><data desc='LSTNAM'>Henning</data><data desc='STATE'>TX</data></row>
-      <row><data desc='LSTNAM'>Jones</data><data desc='STATE'>NY</data></row>
-      <row><data desc='LSTNAM'>Vine</data><data desc='STATE'>VT</data></row>
-      <row><data desc='LSTNAM'>Johnson</data><data desc='STATE'>GA</data></row>
-      <row><data desc='LSTNAM'>Tyron</data><data desc='STATE'>NY</data></row>
-      <row><data desc='LSTNAM'>Stevens</data><data desc='STATE'>CO</data></row>
-      <row><data desc='LSTNAM'>Alison</data><data desc='STATE'>MN</data></row>
-      <row><data desc='LSTNAM'>Doe</data><data desc='STATE'>CA</data></row>
-      <row><data desc='LSTNAM'>Thomas</data><data desc='STATE'>WY</data></row>
-      <row><data desc='LSTNAM'>Williams</data><data desc='STATE'>TX</data></row>
-      <row><data desc='LSTNAM'>Lee</data><data desc='STATE'>NY</data></row>
-      <row><data desc='LSTNAM'>Abraham</data><data desc='STATE'>MN</data></row>
-      <success>+++ success stmt1</success>
-      </fetch>
-      <free><success>+++ success </success>
-      </free>
-      </sql>
-      </myscript>`;
-
-      sinon.stub(connection, 'run').yields(xmlOut);
-
-      connection.run((result) => {
-        expect(result).to.equal(xmlOut);
-      });
-    });
-  });
-});