Added unit and functional tests

Unit Tests added for
 - iSh, iQsh, iCmd function (commandsUnit.js)
 - iConn methods, stubbed out run method
 - iPgm methods
 - iSql methods
 - xmlToJson function

Functional tests added for
 - iDataQueue Class methods
 - iNetwork Class methods
 - iObj methods
 - iPgm methods
 - iProd methods
 - iSql methods
 - iUserSpace methods
 - iWork methods

Removed test.js
- Moved functional tests from test.js to the appropriate class test

Added utils.js
- contains helper function return transports
- returns iConn objects intialized to transports
- used to dynamically generate functional tests that only differ by iConn object used for transport

Added test/README.md
- provides instructions to setup and run tests
- lists available environment variables to configure tests

Author: abmusse

lib/utils.js

@@ -0,0 +1,12 @@
+/* eslint-disable new-cap */
+const { iConn } = require('./itoolkit.js');
+
+function returnTransports(opt) {
+  const transports = [{ name: 'idb', me: new iConn(opt.database, opt.user, opt.password) },
+    { name: 'rest', me: new iConn(opt.database, opt.user, opt.password, opt) },
+  ];
+
+  return transports;
+}
+
+module.exports = { returnTransports };

test/README.md

@@ -0,0 +1,89 @@
+# Node.js Toolkit Tests
+
+Ensure dependencies are installed
+
+From the root of the project run: `npm install`
+
+***NOTE***
+
+Some tests require creating libraries, objects, tables, etc. 
+
+A before hook is setup to check for theses objects and create if needed.
+
+These hooks are ran with `idb-pconnector` which requires to be run on IBM i.
+
+In any case, the functional tests test for both transports Db2 and REST.
+
+Using Db2 transport requires `idb-connector` which only runs on IBM i systems.
+
+Tests using these hooks will fail on non IBM i systems.
+
+# Running Tests
+
+From the project root
+
+`npm test test/foo`
+
+where foo is the name of subdir such as `unit` or or individual test file.
+
+***NOTE***
+
+If you experience timeout issue with network calls add
+
+`"test": "./node_modules/mocha/bin/mocha" --timeout Xs `
+
+within `package.json` file, where X is the number of seconds before timeout
+
+# Setup Rest interface
+
+- add to the default apache server conf: `/www/apachedft/conf/httpd.conf`
+
+    ```
+    ScriptAlias /cgi-bin/   /QSYS.LIB/QXMLSERVc .LIB/
+    <Directory  /QSYS.LIB/QXMLSERV.LIB/>
+      AllowOverride None
+      order allow,deny
+      allow from all
+      SetHandler cgi-script
+      Options +ExecCGI
+    </Directory>
+
+    ```
+
+- start the server
+
+     ` STRTCPSVR SERVER(*HTTP) HTTPSVR(APACHEDFT)`
+
+- go to `http://HOSTNAME/cgi-bin/xmlcgi.pgm`
+
+    you should see an XML document
+
+- when finished testing you can shutdown server with
+
+    ` ENDTCPSVR SERVER(*HTTP) HTTPSVR(APACHEDFT)`
+
+
+# Configuring Tests
+Each functional test contains an config object that is used to create connections
+
+It is recommend to setup environment variables for these configurations
+
+Instead of hard coding credentials with the test file.
+
+you can set environment varaibales with `export KEY='value'`
+
+---
+- user `TKUSER` defaults to ''
+
+- password `TKPASS` defaults to ''
+
+- database `TKDB` defaults to `*LOCAL`
+
+For Rest Tests
+---
+- HOST `TKHOST` defaults to `localhost`
+
+- PORT `TKPORT` defaults to `80`
+
+- PATH `TKPATH` defaults to `/cgi-bin/xmlcgi.pgm`
+

test/functional/commandsFunctional.js

@@ -0,0 +1,97 @@
+// Copyright (c) International Business Machines Corp. 2019
+// All Rights Reserved
+
+// 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 */
+
+const { expect } = require('chai');
+const {
+  iCmd, iSh, iQsh, xmlToJson,
+} = require('../../lib/itoolkit');
+
+// Set Env variables or set values here.
+const opt = {
+  database: process.env.TKDB || '*LOCAL',
+  user: process.env.TKUSER || '',
+  password: process.env.TKPASS || '',
+  host: process.env.TKHOST || 'localhost',
+  port: process.env.TKPORT || 80,
+  path: process.env.TKPATH || '/cgi-bin/xmlcgi.pgm',
+};
+
+const { returnTransports } = require('../../lib/utils');
+
+const transports = returnTransports(opt);
+
+describe('iSh, iCmd, iQsh, Functional Tests', () => {
+  describe('iCmd()', () => {
+    transports.forEach((transport) => {
+      it(`calls CL command using ${transport.name} transport`, (done) => {
+        const connection = transport.me;
+        connection.add(iCmd('RTVJOBA USRLIBL(?) SYSLIBL(?)'));
+        connection.run((xmlOut) => {
+          const results = xmlToJson(xmlOut);
+          results.forEach((result) => {
+            expect(result.success).to.equal(true);
+          });
+          done();
+        });
+      });
+    });
+  });
+
+  describe('iSh()', () => {
+    transports.forEach((transport) => {
+      it(`calls PASE shell command using ${transport.name} transport`, (done) => {
+        const connection = transport.me;
+
+        connection.add(iSh('system -i wrksyssts'));
+        connection.run((xmlOut) => {
+          const results = xmlToJson(xmlOut);
+          // xs does not return success property for iSh or iQsh
+          // but on error data property = '\n'
+          // so lets base success on contents of data.
+          results.forEach((result) => {
+            expect(result.data).not.to.equal('\n');
+            expect(result.data).to.match(/(System\sStatus\sInformation)/);
+          });
+          done();
+        });
+      });
+    });
+  });
+
+  describe('iQsh()', () => {
+    transports.forEach((transport) => {
+      it(`calls QSH command using ${transport.name} transport`, (done) => {
+        const connection = transport.me;
+        connection.add(iQsh('system wrksyssts'));
+        connection.run((xmlOut) => {
+          const results = xmlToJson(xmlOut);
+          // xs does not return success property for iSh or iQsh
+          // but on error data property = '\n'
+          // so lets base success on contents of data.
+          results.forEach((result) => {
+            expect(result.data).not.to.equal('\n');
+            expect(result.data).to.match(/(System\sStatus\sInformation)/);
+          });
+          done();
+        });
+      });
+    });
+  });
+});

test/functional/iDataQueueFunctional.js

@@ -0,0 +1,135 @@
+// Copyright (c) International Business Machines Corp. 2019
+// All Rights Reserved
+
+// 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 } = require('../../lib/itoolkit');
+const { iDataQueue } = require('../../lib/idataq');
+
+// Set Env variables or set values here.
+const opt = {
+  database: process.env.TKDB || '*LOCAL',
+  user: process.env.TKUSER || '',
+  password: process.env.TKPASS || '',
+  host: process.env.TKHOST || 'localhost',
+  port: process.env.TKPORT || 80,
+  path: process.env.TKPATH || '/cgi-bin/xmlcgi.pgm',
+};
+
+const lib = 'NODETKTEST'; const dqName = 'TESTQ';
+
+const { returnTransports } = require('../../lib/utils');
+
+const transports = returnTransports(opt);
+
+describe('iDataQueue Functional Tests', () => {
+  before('setup library for tests and create DQ', async () => {
+    // eslint-disable-next-line global-require
+    const { DBPool } = require('idb-pconnector');
+
+    const pool = new DBPool({ url: '*LOCAL' }, { incrementSize: 2 });
+
+    const qcmdexec = 'CALL QSYS2.QCMDEXC(?)';
+
+    const createLib = `CRTLIB LIB(${lib}) TYPE(*TEST) TEXT('Used to test Node.js toolkit')`;
+
+    const createDQ = `CRTDTAQ DTAQ(${lib}/${dqName}) MAXLEN(100) AUT(*EXCLUDE) TEXT('TEST DQ FOR NODE TOOLKIT TESTS')`;
+
+    const findLib = 'SELECT SCHEMA_NAME FROM qsys2.sysschemas WHERE SCHEMA_NAME = \'NODETKTEST\'';
+
+    const findDQ = 'SELECT OBJLONGNAME FROM TABLE (QSYS2.OBJECT_STATISTICS(\'NODETKTEST\', \'*DTAQ\')) AS X';
+
+    const libResult = await pool.runSql(findLib);
+
+    const dqResult = await pool.runSql(findDQ);
+
+    if (!libResult.length) {
+      await pool.prepareExecute(qcmdexec, [createLib]).catch((error) => {
+        // eslint-disable-next-line no-console
+        console.log('Unable to Create Lib!');
+        throw error;
+      });
+      // eslint-disable-next-line no-console
+      console.log('CREATED LIB!');
+    }
+    if (!dqResult.length) {
+      await pool.prepareExecute(qcmdexec, [createDQ]).catch((error) => {
+        // eslint-disable-next-line no-console
+        console.log('Unable to Create DQ!');
+        throw error;
+      });
+      // eslint-disable-next-line no-console
+      console.log('CREATED DQ!');
+    }
+  });
+  describe('constructor', () => {
+    it('creates and returns an instance of iDataQueue', () => {
+      const connection = new iConn(opt.database, opt.user, opt.password);
+
+      const dq = new iDataQueue(connection);
+      expect(dq).to.be.instanceOf(iDataQueue);
+    });
+  });
+
+  describe('sendToDataQueue', () => {
+    transports.forEach((transport) => {
+      it(`sends data to specified DQ using ${transport.name} transport`, (done) => {
+        const connection = transport.me;
+
+        const dq = new iDataQueue(connection);
+
+        dq.sendToDataQueue(dqName, lib, 'Hello from DQ!', (output) => {
+          expect(output).to.equal(true);
+          done();
+        });
+      });
+    });
+  });
+
+  describe('receiveFromDataQueue', () => {
+    transports.forEach((transport) => {
+      it(`receives data from specfied DQ using ${transport.name} transport`, (done) => {
+        const connection = transport.me;
+
+        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', () => {
+    transports.forEach((transport) => {
+      it(`clears the specifed DQ using ${transport.name} transport`, (done) => {
+        const connection = transport.me;
+
+        const dq = new iDataQueue(connection);
+
+        dq.clearDataQueue(dqName, lib, (output) => {
+          expect(output).to.equal(true);
+          done();
+        });
+      });
+    });
+  });
+});