itoolkit 1.0.0-rc.1 → 1.0.1

package/test/functional/checkVersion.js

@@ -0,0 +1,17 @@
+/**
+ * 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/deprecated/commandsFunctional.js

@@ -15,17 +15,16 @@
 // 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,
+  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
@@ -46,13 +45,13 @@ if (config.transport === 'rest') {
   };
 }
 
-describe('iSh, iCmd, iQsh, Functional Tests', () => {
-  before(() => {
+describe('iSh, iCmd, iQsh, Functional Tests', function () {
+  before(function () {
     printConfig();
   });
 
-  describe('iCmd()', () => {
-    it('calls CL command', (done) => {
+  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) => {
@@ -65,8 +64,8 @@ describe('iSh, iCmd, iQsh, Functional Tests', () => {
     });
   });
 
-  describe('iSh()', () => {
-    it('calls PASE shell command', (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) => {
@@ -81,15 +80,25 @@ describe('iSh, iCmd, iQsh, Functional Tests', () => {
     });
   });
 
-  describe('iQsh()', () => {
-    it('calls QSH command', (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

@@ -15,7 +15,6 @@
 // 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');
@@ -45,8 +44,8 @@ if (config.transport === 'rest') {
 
 const lib = 'NODETKTEST'; const dqName = 'TESTQ';
 
-describe('iDataQueue Functional Tests', () => {
-  before('check if data queue exists for tests', (done) => {
+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; }
@@ -54,8 +53,8 @@ describe('iDataQueue Functional Tests', () => {
     });
   });
 
-  describe('constructor', () => {
-    it('creates and returns an instance of iDataQueue', () => {
+  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);
@@ -63,8 +62,8 @@ describe('iDataQueue Functional Tests', () => {
     });
   });
 
-  describe('sendToDataQueue', () => {
-    it('sends data to specified DQ', (done) => {
+  describe('sendToDataQueue', function () {
+    it('sends data to specified DQ', function (done) {
       const connection = new iConn(database, username, password, restOptions);
 
       const dq = new iDataQueue(connection);
@@ -76,8 +75,8 @@ describe('iDataQueue Functional Tests', () => {
     });
   });
 
-  describe('receiveFromDataQueue', () => {
-    it('receives data from specfied DQ', (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);
@@ -89,8 +88,8 @@ describe('iDataQueue Functional Tests', () => {
     });
   });
 
-  describe('clearDataQueue', () => {
-    it('clears the specifed 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);

package/test/functional/deprecated/iNetworkFunctional.js

@@ -15,7 +15,6 @@
 // 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');
@@ -42,13 +41,13 @@ if (config.transport === 'rest') {
   };
 }
 
-describe('iNetwork Functional Tests', () => {
-  before(() => {
+describe('iNetwork Functional Tests', function () {
+  before(function () {
     printConfig();
   });
 
-  describe('constructor', () => {
-    it('creates and returns an instance of iNetwork', () => {
+  describe('constructor', function () {
+    it('creates and returns an instance of iNetwork', function () {
       const connection = new iConn(database, config.user, password);
 
       const net = new iNetwork(connection);
@@ -57,8 +56,8 @@ describe('iNetwork Functional Tests', () => {
     });
   });
 
-  describe('getTCPIPAttr', () => {
-    it('retrieves TCP/IP Attributes', (done) => {
+  describe('getTCPIPAttr', function () {
+    it('retrieves TCP/IP Attributes', function (done) {
       const connection = new iConn(database, username, password, restOptions);
 
       const net = new iNetwork(connection);
@@ -99,8 +98,8 @@ describe('iNetwork Functional Tests', () => {
     });
   });
 
-  describe('getNetInterfaceData', () => {
-    it('retrieves IPv4 network interface info', (done) => {
+  describe('getNetInterfaceData', function () {
+    it('retrieves IPv4 network interface info', function (done) {
       const connection = new iConn(database, username, password, restOptions);
 
       const net = new iNetwork(connection);

package/test/functional/deprecated/iObjFunctional.js

@@ -15,7 +15,6 @@
 // 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');
@@ -42,13 +41,13 @@ if (config.transport === 'rest') {
   };
 }
 
-describe('iObj Functional Tests', () => {
-  before(() => {
+describe('iObj Functional Tests', function () {
+  before(function () {
     printConfig();
   });
 
-  describe('constructor', () => {
-    it('creates and returns an instance of iObj', () => {
+  describe('constructor', function () {
+    it('creates and returns an instance of iObj', function () {
       const connection = new iConn(database, config.user, password);
 
       const obj = new iObj(connection);
@@ -57,8 +56,8 @@ describe('iObj Functional Tests', () => {
     });
   });
 
-  describe('retrUsrAuth', () => {
-    it(`returns uses's authority for an object using ${config.transport} tranport`, (done) => {
+  describe('retrUsrAuth', function () {
+    it(`returns uses's authority for an object using ${config.transport} tranport`, function (done) {
       const connection = new iConn(database, username, password, restOptions);
 
       const obj = new iObj(connection);
@@ -101,8 +100,8 @@ describe('iObj Functional Tests', () => {
     });
   });
 
-  describe('rtrCmdInfo', () => {
-    it('returns command info', (done) => {
+  describe('rtrCmdInfo', function () {
+    it('returns command info', function (done) {
       const connection = new iConn(database, username, password, restOptions);
 
       const obj = new iObj(connection);
@@ -153,8 +152,8 @@ describe('iObj Functional Tests', () => {
     });
   });
 
-  describe('retrPgmInfo', () => {
-    it('returns program info', (done) => {
+  describe('retrPgmInfo', function () {
+    it('returns program info', function (done) {
       const connection = new iConn(database, username, password, restOptions);
 
       const obj = new iObj(connection);
@@ -227,8 +226,8 @@ describe('iObj Functional Tests', () => {
     });
   });
 
-  describe('retrSrvPgmInfo', () => {
-    it('returns service program info', (done) => {
+  describe('retrSrvPgmInfo', function () {
+    it('returns service program info', function (done) {
       const connection = new iConn(database, username, password, restOptions);
 
       const obj = new iObj(connection);
@@ -282,8 +281,8 @@ describe('iObj Functional Tests', () => {
     });
   });
 
-  describe('retrUserInfo', () => {
-    it('returns specified user profile info', (done) => {
+  describe('retrUserInfo', function () {
+    it('returns specified user profile info', function (done) {
       const connection = new iConn(database, username, password, restOptions);
 
       const obj = new iObj(connection);
@@ -308,8 +307,8 @@ describe('iObj Functional Tests', () => {
     });
   });
 
-  describe('retrUsrAuthToObj', () => {
-    it(`retrieves info for users who are authorized to an object using ${config.transport} transpsort`, (done) => {
+  describe('retrUsrAuthToObj', function () {
+    it(`retrieves info for users who are authorized to an object using ${config.transport} transpsort`, function (done) {
       const connection = new iConn(database, username, password, restOptions);
 
       const obj = new iObj(connection);
@@ -335,8 +334,8 @@ describe('iObj Functional Tests', () => {
     });
   });
 
-  describe('addToLibraryList', () => {
-    it('appends lib to user\'s lib list', (done) => {
+  describe('addToLibraryList', function () {
+    it('appends lib to user\'s lib list', function (done) {
       const connection = new iConn(database, username, password, restOptions);
 
       const obj = new iObj(connection);

package/test/functional/deprecated/iPgmFunctional.js

@@ -15,7 +15,6 @@
 // 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');
@@ -43,13 +42,13 @@ if (config.transport === 'rest') {
   };
 }
 
-describe('iPgm Functional Tests', () => {
-  before(() => {
+describe('iPgm Functional Tests', function () {
+  before(function () {
     printConfig();
   });
 
-  describe('Test iPgm()', () => {
-    it('calls QWCRSVAL program checks if it ran successfully', (done) => {
+  describe('addParam', function () {
+    it('calls QWCRSVAL program checks if it ran successfully', function (done) {
       const connection = new iConn(database, username, password, restOptions);
 
       const program = new iPgm('QWCRSVAL', { lib: 'QSYS' });
@@ -80,45 +79,10 @@ describe('iPgm Functional Tests', () => {
     });
   });
 
-
-  describe('Test iPgm()', () => {
-    it('calls QWCRSVAL program and returns arbitrarily named parameter', (done) => {
-      const connection = new iConn(database, username, password, restOptions);
-
-      const program = new iPgm('QWCRSVAL', { lib: 'QSYS' });
-
-      const outBuf = [
-        [0, '10i0'],
-        [0, '10i0'],
-        ['', '36h'],
-        ['', '10A'],
-        ['', '1A'],
-        ['', '1A'],
-        [0, '10i0'],
-        [0, '10i0'],
-      ];
-      program.addParam(outBuf, { io: 'out' });
-      program.addParam(66, '10i0');
-      program.addParam(1, '10i0');
-      program.addParam('QCCSID', '10A');
-      const paramValue = 'errno';
-
-      program.addParam(this.errno, { io: 'both', len: 'rec2', name: paramValue });
-      connection.add(program);
-      connection.run((xmlOut) => {
-        parseString(xmlOut, (parseError, result) => {
-          expect(parseError).to.equal(null);
-          expect(result.myscript.pgm[0].success[0]).to.include('+++ success QSYS QWCRSVAL');
-          done();
-        });
-      });
-    });
-  });
-
-  describe.skip('Test iPgm()', () => {
+  describe.skip('addReturn', function () {
     // ZZSRV6 program requires XMLSERVICE built with tests
     // Skip for now, we need to add before hook to check if ZZSRV6 is available
-    it.skip('Should be successful with addReturn arbitrary attribute specified using', (done) => {
+    it.skip('calls ZZVARY4 and checks the return value', function (done) {
       const connection = new iConn(database, username, password, restOptions);
 
       const program = new iPgm('ZZSRV6', { lib: 'XMLSERVICE', func: 'ZZVARY4' });

package/test/functional/deprecated/iProdFunctional.js

@@ -15,7 +15,6 @@
 // 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');
@@ -42,13 +41,13 @@ if (config.transport === 'rest') {
   };
 }
 
-describe('iProd Functional Tests', () => {
-  before(() => {
+describe('iProd Functional Tests', function () {
+  before(function () {
     printConfig();
   });
 
-  describe('constructor', () => {
-    it('creates and returns an instance of iProd', () => {
+  describe('constructor', function () {
+    it('creates and returns an instance of iProd', function () {
       const connection = new iConn(database, config.user, password);
 
       const prod = new iProd(connection);
@@ -57,8 +56,8 @@ describe('iProd Functional Tests', () => {
     });
   });
 
-  describe('getPTFInfo', () => {
-    it('returns info for specified ptf', (done) => {
+  describe('getPTFInfo', function () {
+    it('returns info for specified ptf', function (done) {
       const connection = new iConn(database, username, password, restOptions);
 
       const prod = new iProd(connection);
@@ -99,8 +98,8 @@ describe('iProd Functional Tests', () => {
     });
   });
 
-  describe('getProductInfo', () => {
-    it('returns info for specified product', (done) => {
+  describe('getProductInfo', function () {
+    it('returns info for specified product', function (done) {
       const connection = new iConn(database, username, password, restOptions);
 
       const prod = new iProd(connection);
@@ -130,8 +129,8 @@ describe('iProd Functional Tests', () => {
 
   // REST transport currently failing with 414 URI Too Long response code
   // The requested URL's length exceeds the capacity limit for this server
-  describe('getInstalledProducts', () => {
-    it('returns info for installed products', (done) => {
+  describe('getInstalledProducts', function () {
+    it('returns info for installed products', function (done) {
       const connection = new iConn(database, username, password, restOptions);
 
       const prod = new iProd(connection);

package/test/functional/deprecated/iSqlFunctional.js

@@ -15,10 +15,8 @@
 // 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 { iSql, iConn } = require('../../../lib/itoolkit');
@@ -44,13 +42,13 @@ if (config.transport === 'rest') {
   };
 }
 
-describe('iSql Functional Tests', () => {
-  before(() => {
+describe('iSql Functional Tests', function () {
+  before(function () {
     printConfig();
   });
 
-  describe('prepare & execute', () => {
-    it('prepares & executes stored procedure then fetch results', (done) => {
+  describe('prepare & execute', function () {
+    it('prepares & executes stored procedure then fetch results', function (done) {
       const connection = new iConn(database, username, password, restOptions);
 
       const sql = new iSql();
@@ -81,8 +79,8 @@ describe('iSql Functional Tests', () => {
     });
   });
 
-  describe('addQuery & fetch', () => {
-    it('runs a query and fetches results', (done) => {
+  describe('addQuery & fetch', function () {
+    it('runs a query and fetches results', function (done) {
       const connection = new iConn(database, username, password, restOptions);
 
       const sql = new iSql();
@@ -106,8 +104,8 @@ describe('iSql Functional Tests', () => {
     });
   });
 
-  describe('added test to ensure issue #11 was resolved', () => {
-    it('should parse SQL result set empty data tags correctly', (done) => {
+  describe('added test to ensure issue #11 was resolved', function () {
+    it('should parse SQL result set empty data tags correctly', function (done) {
       const connection = new iConn(database, username, password, restOptions);
 
       const sql = new iSql();
@@ -132,8 +130,8 @@ describe('iSql Functional Tests', () => {
     });
   });
 
-  describe('tables', () => {
-    it('returns meta data for specified table', (done) => {
+  describe('tables', function () {
+    it('returns meta data for specified table', function (done) {
       const connection = new iConn(database, username, password, restOptions);
 
       const sql = new iSql();
@@ -156,8 +154,8 @@ describe('iSql Functional Tests', () => {
     });
   });
 
-  describe('tablePriv', () => {
-    it('returns privilege data for a table', (done) => {
+  describe('tablePriv', function () {
+    it('returns privilege data for a table', function (done) {
       const connection = new iConn(database, username, password, restOptions);
 
       const sql = new iSql();
@@ -182,8 +180,8 @@ describe('iSql Functional Tests', () => {
     });
   });
 
-  describe('columns', () => {
-    it('returns meta data for a column', (done) => {
+  describe('columns', function () {
+    it('returns meta data for a column', function (done) {
       const connection = new iConn(database, username, password, restOptions);
 
       const sql = new iSql();
@@ -219,8 +217,8 @@ describe('iSql Functional Tests', () => {
     });
   });
 
-  describe('columnPriv', () => {
-    it('returns privilege data for a column', (done) => {
+  describe('columnPriv', function () {
+    it('returns privilege data for a column', function (done) {
       const connection = new iConn(database, username, password, restOptions);
 
       const sql = new iSql();
@@ -247,8 +245,8 @@ describe('iSql Functional Tests', () => {
     });
   });
 
-  describe('procedures', () => {
-    it('returns meta data on for a procedure', (done) => {
+  describe('procedures', function () {
+    it('returns meta data on for a procedure', function (done) {
       const connection = new iConn(database, username, password, restOptions);
 
       const sql = new iSql();
@@ -274,8 +272,8 @@ describe('iSql Functional Tests', () => {
     });
   });
 
-  describe('pColumns', () => {
-    it('returns meta data for procedure column', (done) => {
+  describe('pColumns', function () {
+    it('returns meta data for procedure column', function (done) {
       const connection = new iConn(database, username, password, restOptions);
 
       const sql = new iSql();
@@ -312,8 +310,8 @@ describe('iSql Functional Tests', () => {
     });
   });
 
-  describe('primaryKeys', () => {
-    it('returns meta data for a primary key', (done) => {
+  describe('primaryKeys', function () {
+    it('returns meta data for a primary key', function (done) {
       const connection = new iConn(database, username, password, restOptions);
 
       const sql = new iSql();
@@ -337,8 +335,8 @@ describe('iSql Functional Tests', () => {
     });
   });
 
-  describe('foreignKeys', () => {
-    it('returns meta data for a foreign key', (done) => {
+  describe('foreignKeys', function () {
+    it('returns meta data for a foreign key', function (done) {
       const connection = new iConn(database, username, password, restOptions);
 
       const sql = new iSql();
@@ -371,8 +369,8 @@ describe('iSql Functional Tests', () => {
     });
   });
 
-  describe('statistics', () => {
-    it('returns stats info for table', (done) => {
+  describe('statistics', function () {
+    it('returns stats info for table', function (done) {
       const connection = new iConn(database, username, password, restOptions);
 
       const sql = new iSql();
@@ -403,10 +401,10 @@ describe('iSql Functional Tests', () => {
     });
   });
 
-  describe.skip('special', () => {
+  describe.skip('special', function () {
     // TODO: find passing case
     // Below test fails with error code 9- argument value not valid
-    it.skip('returns meta data for special columns', (done) => {
+    it.skip('returns meta data for special columns', function (done) {
       // [catalog, schema, table, row | transaction |session, no | nullable]
       const connection = new iConn(database, username, password, restOptions);
 
@@ -426,9 +424,9 @@ describe('iSql Functional Tests', () => {
     });
   });
 
-  describe.skip('rowCount', () => {
+  describe.skip('rowCount', function () {
     // Skip for now need to create a table for this test  to insert to.
-    it.skip('returns the number of rows affected by statement', (done) => {
+    it.skip('returns the number of rows affected by statement', function (done) {
       const connection = new iConn(database, username, password, restOptions);
 
       const sql = new iSql();