itoolkit 1.0.0-rc.1 → 1.0.1

package/.eslintrc.js

@@ -1,13 +1,39 @@
-module.exports =  { 
-    "extends": "airbnb-base",
-    env: {
-        node: true
-    },
-    rules: {
-        // Tweak rules set by airbnb config
-        'no-console': 'off', // allow console
-        'import/no-extraneous-dependencies': ["error", {"optionalDependencies": true}], // Allow optional dep import
-        // Warn unresolved imports ie: idb-connector import will be unresolved when on non IBM i system.
-        'import/no-unresolved': ['off', { commonjs: true }],
+module.exports = {
+  extends: 'airbnb-base',
+  plugins: [
+    'mocha',
+  ],
+  env: {
+    node: true,
+  },
+  rules: {
+    // Tweak rules set by airbnb config
+    // We need to allow use of console.log for verbose mode
+    'no-console': 'off',
+    // airbnb config forbids optionalDependencies
+    // https://github.com/airbnb/javascript/blob/c5bee75b1b358a3749f1a6d38ee6fad73de28e29/packages/eslint-config-airbnb-base/rules/imports.js#L95
+    "import/no-extraneous-dependencies": [ "error", { "optionalDependencies": true }],
+    // Project uses opt deps like odbc and idb-connector which may not exist
+    "import/no-unresolved": 'off',
+  },
+  overrides: [
+    {
+      files: ['test/**/*.js'],
+      env: {
+        node: true,
+        mocha: true,
+      },
+      extends: 'plugin:mocha/recommended',
+      rules: {
+        // These are set by airbnb-base, but go against Mocha conventions
+        // See https://mochajs.org/#arrow-functions
+        // and https://github.com/airbnb/javascript/issues/433
+        'func-names': 'off',
+        'prefer-arrow-callback': 'off',
+
+        // The following rules cause problems for our existing tests, so they are disabled for now:
+        'mocha/no-skipped-tests': 'off',
       },
+    },
+  ],
 };

package/CHANGELOG.md

@@ -1,6 +1,81 @@
 # Changelog
 
-All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+## [1.0.1](https://github.com/IBM/nodejs-itoolkit/compare/v1.0.0...v1.0.1) (2022-10-31)
+
+- fix: Missing braces in README Example (#286)
+- fix: Typo in ssh transport error message (#287)
+- test: Remove redundant ProgramCall test (#284)
+- test: Constrain eslint rules
+- test: Fix eslint errors issues in eslintrc
+- test: Configure tests to use Mocha env in eslintrc
+- test: Adjust AirBnB rules for Mocha tests
+- test: Use eslint-plugin-mocha for tests
+- test: Remove arrow functions from mocha functions (#283)
+- ci: Add eslint action (#244)
+- docs: Update setup transport interface links (#292)
+- fix: Emit deprecation warning for iPgm.addReturn (#295)
+- build(deps-dev): bump standard-version from 7.1.0 to 8.0.1 (#299)
+- build(deps): bump lodash from 4.17.15 to 4.17.19 (#302)
+- chore: Unmark as stale if issue has been updated (#311)
+- fix: Make exempt labels plural for stale action (#312)
+- test: Check the XMLSERVICE version for QSH support (#303)
+- fix: Update standard-version to resolve CVE-2020-8116 (#310)
+- refactor: Handle optional dependencies better (#306)
+- test: Fix mocha/no-identical-title eslint issue (#296)
+- test: Fix mocha/no-hooks-for-single-case eslint issue (#297)
+- fix: eslint GH action failure (#336)
+- docs: Add comma to separate password and url key
+- build(deps): Update deps to the latest version (#347)
+- docs: Add omit as valid value for io (#346)
+- docs: Reference alternate XML parser (#345)
+- build: readthedocs build error (#349)
+- build(deps): Add fast-xml-parser (#351)
+- build(deps): Upgrade ssh2 to latest version (#355)
+- fix: Better optional deps handling (#353)
+- ci: Add npm publish action (#358)
+- docs: Update cosine example to pass by value (#359)
+
+## [1.0.0](https://github.com/IBM/nodejs-itoolkit/compare/1.0.0-alpha.1...1.0.0) (2020-05-08)
+
+
+### ⚠ BREAKING CHANGES
+
+* Remove iSql.connect() and iSql.setOptions()
+* Remove iConn.setTimeout()
+
+### Features
+
+* Allow DS for service program return value ([#217](https://github.com/IBM/nodejs-itoolkit/issues/217)) ([30e9f8a](https://github.com/IBM/nodejs-itoolkit/commit/30e9f8a69da829935dcee72dbd394032feef0e27))
+* Specify supported Node versions ([#264](https://github.com/IBM/nodejs-itoolkit/issues/264)) ([63ec53c](https://github.com/IBM/nodejs-itoolkit/commit/63ec53c0ac17e9d4130b79074a61075ce0ac897e))
+* use standard-version [#85](https://github.com/IBM/nodejs-itoolkit/issues/85) ([45f66a7](https://github.com/IBM/nodejs-itoolkit/commit/45f66a7f9ac5b5d37c907f5d088cb517cd4d3d66))
+
+
+### Bug Fixes
+
+* Add missing '?' in xml prolog ([bff8649](https://github.com/IBM/nodejs-itoolkit/commit/bff864991f73f5789c5dec563821c86eb1aab3fa))
+* data type issue in Toolkit.getSysStatus and Toolkit.getSysStatusExt ([#190](https://github.com/IBM/nodejs-itoolkit/issues/190)) ([15397c2](https://github.com/IBM/nodejs-itoolkit/commit/15397c279d51b9282ef948b7d61d7d403690ce6f))
+* Define errno structure correctly ([#192](https://github.com/IBM/nodejs-itoolkit/issues/192)) ([b1561f7](https://github.com/IBM/nodejs-itoolkit/commit/b1561f76e5803409c485f8b965745a060462852b)), closes [#191](https://github.com/IBM/nodejs-itoolkit/issues/191)
+* Deprecated functional tests rest transport options ([#255](https://github.com/IBM/nodejs-itoolkit/issues/255)) ([903dd3f](https://github.com/IBM/nodejs-itoolkit/commit/903dd3f70f635f37bb2abba4a61b5a99a4f16ba3))
+* eslint errors ([#243](https://github.com/IBM/nodejs-itoolkit/issues/243)) ([df40eb0](https://github.com/IBM/nodejs-itoolkit/commit/df40eb0c4898214493b22b9054d9eea57e6bccd9))
+* Faulty error thrown by ProgramCall.addParam ([#124](https://github.com/IBM/nodejs-itoolkit/issues/124)) ([75d081c](https://github.com/IBM/nodejs-itoolkit/commit/75d081c86ae35f0557ea7b5a1f8886018de6ff36))
+* Formatting errors in bug report template ([24a9262](https://github.com/IBM/nodejs-itoolkit/commit/24a92626e97f407dc7de998e2c65d6500d289eaf))
+* Homepage link in package.json ([#267](https://github.com/IBM/nodejs-itoolkit/issues/267)) ([d5787ce](https://github.com/IBM/nodejs-itoolkit/commit/d5787cef2ade2d8fa298986a73040158dd2b6f84))
+* HTTP transport should take a URL ([#252](https://github.com/IBM/nodejs-itoolkit/issues/252)) ([34e4e37](https://github.com/IBM/nodejs-itoolkit/commit/34e4e3765667a6060d82bd6dabf2bcd4569aa765))
+* iConn unit test failure ([52f0330](https://github.com/IBM/nodejs-itoolkit/commit/52f0330801a8b5bbdbac19af4ff60ee80927a9e3))
+* iConn unit test failure ([#274](https://github.com/IBM/nodejs-itoolkit/issues/274)) ([9e72857](https://github.com/IBM/nodejs-itoolkit/commit/9e728572fcfd734059d3a09e6934760518183250))
+* Improper TOC nesting in main README ([#175](https://github.com/IBM/nodejs-itoolkit/issues/175)) ([db5d44c](https://github.com/IBM/nodejs-itoolkit/commit/db5d44cdcc79dbded8d3fa6f0717ed268d5d7606))
+* minimist CVE ([#231](https://github.com/IBM/nodejs-itoolkit/issues/231)) ([6d02c43](https://github.com/IBM/nodejs-itoolkit/commit/6d02c43c38cf3c5fcc2e5ee559ea123ba97b12f2))
+* Move iConn compatibility code to iConn itself ([#218](https://github.com/IBM/nodejs-itoolkit/issues/218)) ([73d798d](https://github.com/IBM/nodejs-itoolkit/commit/73d798deaf1ca840d2c0d5742ded40712fe33955))
+* ssh transport econnreset ([#272](https://github.com/IBM/nodejs-itoolkit/issues/272)) ([d5e71c1](https://github.com/IBM/nodejs-itoolkit/commit/d5e71c159319574a937ee415df4c636d7f347ba7))
+* ssh transport silent failure ([#225](https://github.com/IBM/nodejs-itoolkit/issues/225)) ([6e3b8a0](https://github.com/IBM/nodejs-itoolkit/commit/6e3b8a0f11539ee04540cf12d97cd6b67b3ed967))
+* Test hooks timeout when using rest transport ([#253](https://github.com/IBM/nodejs-itoolkit/issues/253)) ([60fdd5b](https://github.com/IBM/nodejs-itoolkit/commit/60fdd5b75ba165646d8f888344aa1924c39272b1))
+* TODOs in Deprecated.js ([#240](https://github.com/IBM/nodejs-itoolkit/issues/240)) ([cd47476](https://github.com/IBM/nodejs-itoolkit/commit/cd474766d769d7832cf38fca40a5ed14b19f4bfa))
+* **idb:** Improve cleanup handling ([#233](https://github.com/IBM/nodejs-itoolkit/issues/233)) ([c2bb115](https://github.com/IBM/nodejs-itoolkit/commit/c2bb1152e13785a975597da41d6ca7df94bf4c09))
+* Use encodeURIComponent for URL params ([2c98b22](https://github.com/IBM/nodejs-itoolkit/commit/2c98b229148adbc3475d2eba1c1f397cd7367447)), closes [#72](https://github.com/IBM/nodejs-itoolkit/issues/72) [#71](https://github.com/IBM/nodejs-itoolkit/issues/71)
+
+
+* Remove iConn.setTimeout() ([c978c41](https://github.com/IBM/nodejs-itoolkit/commit/c978c41ad28f5e4db152bd4bd5e56ba3824ea650))
+* Remove iSql.connect() and iSql.setOptions() ([066e8ba](https://github.com/IBM/nodejs-itoolkit/commit/066e8ba43e0c68ff6165b4be8f1d00eac1242f38))
 
 ## [1.0.0-alpha.1](https://github.com/IBM/nodejs-itoolkit/compare/1.0.0-alpha.0...1.0.0-alpha.1) (2019-07-10)
 
@@ -151,4 +226,3 @@ All notable changes to this project will be documented in this file. See [standa
 ### [0.1.5](https://github.com/IBM/nodejs-itoolkit/compare/0.1.4...0.1.5) (2019-01-08)
 
 ### 0.1.4 (2018-09-17)
-

package/README.md

@@ -47,11 +47,11 @@ XMLSERVICE will run the command and respond with XML output.
 </myscript>
 ```
 
-`itoolkit` can run the same CL command with:
+`itoolkit`, with the help of an XML parser, can run the same CL command with:
 
 ```js
 const { Connection, CommandCall } = require('itoolkit');
-const { parseString } = require('xml2js');
+const { XMLParser } = require('fast-xml-parser');
 
 const connection = new Connection({
   transport: 'ssh',
@@ -66,12 +66,12 @@ connection.run((error, xmlOutput) => {
   if (error) {
     throw error;
   }
-  parseString(xmlOutput, (parseError, result) => {
-    if (parseError) {
-      throw parseError;
-    }
-    console.log(JSON.stringify(result));
-  });
+
+  const Parser = new XMLParser();
+  const result = Parser.parse(xmlOutput);
+
+  console.log(JSON.stringify(result));
+});
 ```
 
 The purpose of this package is to simplify the process of creating XMLSERVICE input, invoking XMLSERVICE, and returning XMLSERVICE output from Node.js.

package/lib/Connection.js

@@ -129,7 +129,6 @@ class Connection {
     return this.verbose;
   }
 
-
   /**
    * @returns {object} The ``transportOptions`` property from the ``Connection`` object.
    */

package/lib/Deprecated.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.
 
-
 // This file contains the classes that are deprecated in v1.0. The implementations for all of the
 // functions in these classes prior to v1.0 are moved into the other classes. The classes contained
 // in this file are now wrappers for those calls to enable backward compatability with
@@ -23,6 +22,7 @@
 // these methods through these deprecated class names, we can simple disable this file.
 
 /* eslint-disable max-classes-per-file */
+/* eslint-disable default-param-last */
 
 const deprecate = require('depd');
 const { parseString } = require('xml2js');
@@ -45,7 +45,6 @@ const { ProgramCall } = require('./ProgramCall');
 const { CommandCall } = require('./CommandCall');
 const { Connection } = require('./Connection');
 
-
 // DEPRECATED: For now, routes call to ProgramCall, but will be removed at a later time.
 class iPgm {
   /**
@@ -143,6 +142,7 @@ class iPgm {
         data[key] = options[key];
       });
     }
+    iPgmDeprecate('As of v1.0, \'iPgm.addReturn()\' is deprecated. Please use \'ProgramCall.addReturn()\' instead.');
     return this.ProgramCall.addReturn(data);
   }
 
@@ -588,7 +588,6 @@ class iConn {
     return this.connection.debug(flag);
   }
 
-
   /**
    * @deprecated Replaced by ``Connection.getTransportOptions()`` and will be removed in the
    * next major version.
@@ -4346,7 +4345,7 @@ function iSh(sh, options) {
  * @returns {object[]} - The array of result objects.
  */
 function xmlToJson(xml) {
-  xmlToJsonDeprecate('As of v1.0, \'xmlToJson\' is deprecated. Use xml2js npm package instead.');
+  xmlToJsonDeprecate('As of v1.0, \'xmlToJson\' is deprecated. Use the fast-xml-parser npm package instead.');
 
   const cmdRegG = /<cmd.*?>[\s\S]+?<\/cmd>/g;
   const shRegG = /<sh.*?>[\s\S]+?<\/sh>/g;

package/lib/ProgramCall.js

@@ -103,8 +103,8 @@ class ProgramCall {
   * @property {string} value - The value of the data.
   * @property {string} [name] - The name of the parameter.
   * @property {data[]} [fields] - The array of data objects for a ds.
-  * @property {string} [io] - Whether the parameter is used for input, output, or both.
-  * Valid values are ``in``, ``out``, or ``both``.
+  * @property {string} [io] - Whether the parameter is used for input, output, both, or *OMIT.
+  * Valid values are ``in``, ``out``, ``both``, and ``omit``.
   * @property {string} [by] - Whether to pass the parameter by reference or value.
   * Valid values are ``ref`` or ``val``. NOTE: Pass by value requires ``XMLSERVICE >= 1.9.9.3``.
   * @property {string} [dim] - Sets ds array dimension value.

package/lib/transports/httpTransport.js

@@ -17,7 +17,7 @@
 
 const http = require('http');
 
-const httpCall = (config, xmlInput, done) => {
+function httpCall(config, xmlInput, done) {
   const {
     database = '*LOCAL',
     username = null,
@@ -85,6 +85,6 @@ const httpCall = (config, xmlInput, done) => {
   });
   request.write(queryString);
   request.end();
-};
+}
 
 exports.httpCall = httpCall;

package/lib/transports/idbTransport.js

@@ -15,11 +15,23 @@
 // 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 idbCall = (config, xmlInput, cb) => {
-  const {
-    dbconn, dbstmt, IN, CLOB, CHAR, SQL_ATTR_DBC_SYS_NAMING, SQL_FALSE,
+let idb = null;
+
+try {
+  /* eslint-disable import/no-unresolved */
   // eslint-disable-next-line global-require
-  } = require('idb-connector');
+  idb = require('idb-connector');
+} catch (e) {
+  if (e.code !== 'MODULE_NOT_FOUND') {
+    throw e;
+  }
+}
+
+function idbCall(config, xmlInput, cb) {
+  // idb transport is not available bail out
+  if (idb === null) {
+    cb(new Error('idb-connector was not found, ensure idb-connector is installed properly (idb-connector is only available on IBM i).'), null);
+  }
 
   const {
     database = '*LOCAL',
@@ -34,9 +46,9 @@ const idbCall = (config, xmlInput, cb) => {
   let xmlOutput = '';
   const sql = `call ${xslib}.iPLUGR512K(?,?,?)`;
   // eslint-disable-next-line new-cap
-  const conn = new dbconn();
+  const conn = new idb.dbconn();
 
-  conn.setConnAttr(SQL_ATTR_DBC_SYS_NAMING, SQL_FALSE);
+  conn.setConnAttr(idb.SQL_ATTR_DBC_SYS_NAMING, idb.SQL_FALSE);
 
   if (typeof verbose === 'boolean') {
     conn.debug(verbose);
@@ -53,12 +65,12 @@ const idbCall = (config, xmlInput, cb) => {
     return;
   }
   // eslint-disable-next-line new-cap
-  const stmt = new dbstmt(conn);
+  const stmt = new idb.dbstmt(conn);
 
   const parameters = [
-    [ipc, IN, CHAR],
-    [ctl, IN, CHAR],
-    [xmlInput, IN, CLOB],
+    [ipc, idb.IN, idb.CHAR],
+    [ctl, idb.IN, idb.CHAR],
+    [xmlInput, idb.IN, idb.CLOB],
   ];
 
   // Before returning to caller, we must clean up
@@ -106,6 +118,6 @@ const idbCall = (config, xmlInput, cb) => {
       });
     });
   });
-};
+}
 
 exports.idbCall = idbCall;

package/lib/transports/odbcTransport.js

@@ -15,9 +15,23 @@
 // 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.
 
-function odbcCall(config, xmlInput, done) {
+let odbc = null;
+
+try {
+  /* eslint-disable import/no-unresolved */
   // eslint-disable-next-line global-require
-  const odbc = require('odbc');
+  odbc = require('odbc');
+} catch (e) {
+  if (e.code !== 'MODULE_NOT_FOUND') {
+    throw e;
+  }
+}
+
+function odbcCall(config, xmlInput, done) {
+  // odbc transport is not available bail out
+  if (odbc === null) {
+    done(new Error('odbc transport was not found, ensure odbc is installed properly.'), null);
+  }
 
   const {
     host = 'localhost',

package/lib/transports/sshTransport.js

@@ -15,10 +15,9 @@
 // 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.
 
-function sshCall(config, xmlIn, done) {
-  // eslint-disable-next-line global-require
-  const { Client } = require('ssh2');
+const { Client } = require('ssh2');
 
+function sshCall(config, xmlIn, done) {
   const {
     verbose = false,
   } = config;
@@ -71,12 +70,12 @@ function sshCall(config, xmlIn, done) {
         }
 
         if (signal) {
-          client.emit('error', new Error(`xmlserivce-cli was signaled with: ${signal}`));
+          client.emit('error', new Error(`xmlservice-cli was signaled with: ${signal}`));
           return;
         }
 
         if (code !== 0) {
-          client.emit('error', new Error(`xmlserivce-cli exited abnormally with code: ${code}`));
+          client.emit('error', new Error(`xmlservice-cli exited abnormally with code: ${code}`));
           return;
         }
         client.end();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "itoolkit",
-  "version": "1.0.0-rc.1",
+  "version": "1.0.1",
   "description": "XMLSERVICE wrapper to access to all things IBM i",
   "main": "lib/itoolkit.js",
   "directories": {
@@ -8,8 +8,8 @@
     "test": "test"
   },
   "scripts": {
-    "test": "./node_modules/mocha/bin/mocha --recursive test/unit",
-    "test-integration": "./node_modules/mocha/bin/mocha --timeout 5s test/functional/*.js",
+    "test": "./node_modules/mocha/bin/mocha.js --recursive test/unit",
+    "test-integration": "./node_modules/mocha/bin/mocha.js --timeout 5s test/functional/*.js",
     "lint": "./node_modules/eslint/bin/eslint.js lib/ test/",
     "release": "standard-version"
   },
@@ -44,19 +44,20 @@
     "xml2js": "^0.4.23"
   },
   "devDependencies": {
-    "chai": "^4.2.0",
-    "eslint": "^6.2.0",
-    "eslint-config-airbnb-base": "^14.0.0",
-    "eslint-plugin-import": "^2.18.2",
-    "mocha": "^6.2.3",
-    "sinon": "^7.4.1",
-    "standard-version": "^7.0.0"
+    "chai": "^4.3.6",
+    "eslint": "^8.26.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-mocha": "^10.1.0",
+    "mocha": "^10.1.0",
+    "sinon": "^14.0.1"
   },
   "optionalDependencies": {
-    "idb-connector": "^1.2.2",
-    "idb-pconnector": "^1.0.7",
-    "ssh2": "^0.8.2",
-    "odbc": "^2.1.3"
+    "idb-connector": "^1.2.18",
+    "idb-pconnector": "^1.1.0",
+    "odbc": "^2.4.6",
+    "ssh2": "^1.11.0",
+    "fast-xml-parser": "^4.0.11"
   },
   "engines": {
     "node": ">= 8.0"

package/test/README.md

@@ -12,11 +12,9 @@ Ensure dependencies are installed by running `npm install` from the project root
 
 Integration tests require additional setup and configuration. Some tests require objects to preexist on the IBM i. The test case will check if the object exists and log instructions if the object is not found.
 
-## Setup Rest interface
-- view the [README](../README.md#rest)
+## [Setup Rest interface](https://nodejs-itoolkit.readthedocs.io/en/latest/Connection.html#rest)
 
-## Setup SSH interface
-- view the [README](../README.md#ssh)
+## [Setup SSH interface](https://nodejs-itoolkit.readthedocs.io/en/latest/Connection.html#ssh)
 
 ## Configuring Tests
 

package/test/functional/CommandCallFunctional.js

@@ -15,21 +15,19 @@
 // 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 { parseString } = require('xml2js');
-const { CommandCall, Connection } = require('../../lib/itoolkit');
+const { CommandCall, Connection, ProgramCall } = require('../../lib/itoolkit');
 const { config, printConfig } = require('./config');
+const { isQSHSupported } = require('./checkVersion');
 
-
-describe('CommandCall Functional Tests', () => {
-  before(() => {
+describe('CommandCall Functional Tests', function () {
+  before(function () {
     printConfig();
   });
 
-  describe('CL command tests', () => {
-    it('calls CL command', (done) => {
+  describe('CL command tests', function () {
+    it('calls CL command', function (done) {
       const connection = new Connection(config);
       connection.add(new CommandCall({ command: 'RTVJOBA USRLIBL(?) SYSLIBL(?)', type: 'cl' }));
       connection.run((error, xmlOut) => {
@@ -43,8 +41,8 @@ describe('CommandCall Functional Tests', () => {
     });
   });
 
-  describe('SH command tests', () => {
-    it('calls PASE shell command', (done) => {
+  describe('SH command tests', function () {
+    it('calls PASE shell command', function (done) {
       const connection = new Connection(config);
       connection.add(new CommandCall({ command: 'system -i wrksyssts', type: 'sh' }));
       connection.run((error, xmlOut) => {
@@ -60,9 +58,10 @@ describe('CommandCall Functional Tests', () => {
     });
   });
 
-  describe('QSH command tests', () => {
-    it('calls QSH command', (done) => {
+  describe('QSH command tests', function () {
+    it('calls QSH command', function (done) {
       const connection = new Connection(config);
+      connection.add(new ProgramCall('MYPGMTOOLONG'));
       connection.add(new CommandCall({ command: 'system wrksyssts', type: 'qsh' }));
       connection.run((error, xmlOut) => {
         expect(error).to.equal(null);
@@ -70,6 +69,15 @@ describe('CommandCall Functional Tests', () => {
         // 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/ProgramCallFunctional.js

@@ -15,77 +15,18 @@
 // 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 { parseString } = require('xml2js');
 const { ProgramCall, Connection } = require('../../lib/itoolkit');
 const { config, printConfig } = require('./config');
 
-
-describe('ProgramCall Functional Tests', () => {
-  before(() => {
+describe('ProgramCall Functional Tests', function () {
+  before(function () {
     printConfig();
   });
 
-  describe('Test ProgramCall()', () => {
-    it('calls QWCRSVAL program checks if it ran successfully', (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('Test ProgramCall()', () => {
-    it('calls QWCRSVAL program and returns arbitrarily named parameter', (done) => {
+  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' });
@@ -106,7 +47,6 @@ describe('ProgramCall Functional Tests', () => {
       };
 
       const errno = {
-        name: 'errno',
         type: 'ds',
         io: 'both',
         len: 'rec2',
@@ -140,10 +80,10 @@ describe('ProgramCall Functional Tests', () => {
     });
   });
 
-  describe.skip('Test ProgramCall()', () => {
+  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('Should be successful with addReturn arbitrary attribute specified', (done) => {
+    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' });

package/test/functional/checkObjectExists.js

@@ -1,9 +1,13 @@
+/* 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) {
-  /* eslint-disable global-require */
+  // 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();
@@ -68,6 +72,9 @@ function checkObjectExistsSSH(config, object = {}, callback) {
 }
 
 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};`;
@@ -110,6 +117,10 @@ function checkObjectExistsODBC(config, object = {}, callback) {
 }
 
 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 */