itoolkit 1.0.0 → 1.0.2

package/test/functional/iWorkFunctional.js

@@ -1,219 +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 { Connection, iWork } = require('../../lib/itoolkit');
-const { config, printConfig } = require('./config');
-const { checkObjectExists } = require('./checkObjectExists');
-
-describe('iWork Functional Tests', () => {
-  before(() => {
-    printConfig();
-  });
-
-  describe('getSysValue', () => {
-    it('returns the value of system variable', (done) => {
-      const connection = new Connection(config);
-
-      const work = new iWork(connection);
-
-      work.getSysValue('QCENTURY', (error, output) => {
-        expect(error).to.equal(null);
-        expect(output).to.be.a('string').and.to.equal('1');
-        done();
-      });
-    });
-
-    it('returns an error when the specified system value is invalid', (done) => {
-      const connection = new Connection(config);
-
-      const work = new iWork(connection);
-
-      work.getSysValue('invalid', (error) => {
-        expect(error).to.be.a('error');
-        done();
-      });
-    });
-  });
-
-  describe('getSysStatus', () => {
-    it('returns basic system status information about the signed-on users and batch jobs', (done) => {
-      const connection = new Connection(config);
-      const work = new iWork(connection);
-
-      work.getSysStatus((error, output) => {
-        expect(error).to.equal(null);
-        expect(output).to.be.an('Object');
-        expect(output).to.have.a.property('Current_date_and_time');
-        expect(output).to.have.a.property('System_name');
-        expect(output).to.have.a.property('Users_currently_signed_on');
-        expect(output).to.have.a.property('Users_temporarily_signed_off_(disconnected)');
-        expect(output).to.have.a.property('Users_suspended_by_system_request');
-        expect(output).to.have.a.property('Users_suspended_by_group_jobs');
-        expect(output).to.have.a.property('Users_signed_off_with_printer_output_waiting_to_print');
-        expect(output).to.have.a.property('Batch_jobs_waiting_for_messages');
-        expect(output).to.have.a.property('Batch_jobs_running');
-        expect(output).to.have.a.property('Batch_jobs_held_while_running');
-        expect(output).to.have.a.property('Batch_jobs_ending');
-        expect(output).to.have.a.property('Batch_jobs_waiting_to_run_or_already_scheduled');
-        expect(output).to.have.a.property('Batch_jobs_held_on_a_job_queue');
-        expect(output).to.have.a.property('Batch_jobs_on_a_held_job_queue');
-        expect(output).to.have.a.property('Batch_jobs_on_an_unassigned_job_queue');
-        expect(output).to.have.a.property('Batch_jobs_ended_with_printer_output_waiting_to_print');
-        done();
-      });
-    });
-  });
-
-  describe('getSysStatusExt', () => {
-    it('returns more detailed system status info', (done) => {
-      const connection = new Connection(config);
-
-      const work = new iWork(connection);
-
-      work.getSysStatusExt((error, output) => {
-        expect(error).to.equal(null);
-        expect(output).to.be.an('Object');
-        expect(output).to.have.a.property('Current_date_and_time');
-        expect(output).to.have.a.property('System_name');
-        expect(output).to.have.a.property('Elapsed_time');
-        expect(output).to.have.a.property('Restricted_state_flag');
-        expect(output).to.have.a.property('%_processing_unit_used');
-        expect(output).to.have.a.property('Jobs_in_system');
-        expect(output).to.have.a.property('%_permanent_addresses');
-        expect(output).to.have.a.property('%_temporary_addresses');
-        expect(output).to.have.a.property('System_ASP');
-        expect(output).to.have.a.property('%_system_ASP_used');
-        expect(output).to.have.a.property('Total_auxiliary_storage');
-        expect(output).to.have.a.property('Current_unprotected_storage_used');
-        expect(output).to.have.a.property('Maximum_unprotected_storage_used');
-        expect(output).to.have.a.property('%_DB_capability');
-        expect(output).to.have.a.property('Main_storage_size');
-        expect(output).to.have.a.property('Number_of_partitions');
-        expect(output).to.have.a.property('Partition_identifier');
-        expect(output).to.have.a.property('Current_processing_capacity');
-        expect(output).to.have.a.property('Processor_sharing_attribute');
-        expect(output).to.have.a.property('Number_of_processors');
-        expect(output).to.have.a.property('Active_jobs_in_system');
-        expect(output).to.have.a.property('Active_threads_in_system');
-        expect(output).to.have.a.property('Maximum_jobs_in_system');
-        expect(output).to.have.a.property('%_temporary_256MB_segments_used');
-        expect(output).to.have.a.property('%_temporary_4GB_segments_used');
-        expect(output).to.have.a.property('%_permanent_256MB_segments_used');
-        expect(output).to.have.a.property('%_permanent_4GB_segments_used');
-        expect(output).to.have.a.property('%_current_interactive_performance');
-        expect(output).to.have.a.property('%_uncapped_CPU_capacity_used');
-        expect(output).to.have.a.property('%_shared_processor_pool_used');
-        expect(output).to.have.a.property('Main_storage_size_(long)');
-        done();
-      });
-    });
-  });
-
-  describe('getJobStatus', () => {
-    it('returns status of specified job', (done) => {
-      const connection = new Connection(config);
-
-      const work = new iWork(connection);
-
-      work.getJobStatus('000000', (error, output) => {
-        expect(error).to.equal(null);
-        expect(output).to.be.an('Object');
-        expect(output).to.have.a.property('Job_status');
-        expect(output).to.have.a.property('Fully_qualified_job_name');
-        done();
-      });
-    });
-  });
-
-  describe('getJobInfo', () => {
-    it('returns info on specfed job', (done) => {
-      const connection = new Connection(config);
-
-      const work = new iWork(connection);
-
-      work.getJobInfo('SCPF', 'QSYS', '000000', (error, output) => {
-        expect(error).to.equal(null);
-        expect(output).to.be.an('Object');
-        expect(output).to.have.a.property('Job_name');
-        expect(output).to.have.a.property('User_name');
-        expect(output).to.have.a.property('Job_number');
-        expect(output).to.have.a.property('Job_status');
-        expect(output).to.have.a.property('Job_type');
-        expect(output).to.have.a.property('Job_subtype');
-        expect(output).to.have.a.property('Subsystem_description_name');
-        expect(output).to.have.a.property('Run_priority_(job)');
-        expect(output).to.have.a.property('System_pool_identifier');
-        expect(output).to.have.a.property('Processing_unit_time_used,_if_less_than_2,147,483,647_milliseconds');
-        expect(output).to.have.a.property('Number_of_auxiliary_I/O_requests,_if_less_than_2,147,483,647');
-        expect(output).to.have.a.property('Number_of_interactive_transactions');
-        expect(output).to.have.a.property('Response_time_total');
-        expect(output).to.have.a.property('Function_type');
-        expect(output).to.have.a.property('Function_name');
-        expect(output).to.have.a.property('Active_job_status');
-        expect(output).to.have.a.property('Number_of_database_lock_waits');
-        expect(output).to.have.a.property('Number_of_internal_machine_lock_waits');
-        expect(output).to.have.a.property('Number_of_nondatabase_lock_waits');
-        expect(output).to.have.a.property('Time_spent_on_database_lock_waits');
-        expect(output).to.have.a.property('Time_spent_on_internal_machine_lock_waits');
-        expect(output).to.have.a.property('Time_spent_on_nondatabase_lock_waits');
-        expect(output).to.have.a.property('Current_system_pool_identifier');
-        expect(output).to.have.a.property('Thread_count');
-        expect(output).to.have.a.property('Processing_unit_time_used_-_total_for_the_job');
-        expect(output).to.have.a.property('Number_of_auxiliary_I/O_requests');
-        expect(output).to.have.a.property('Processing_unit_time_used_for_database_-_total_for_the_job');
-        expect(output).to.have.a.property('Page_faults');
-        expect(output).to.have.a.property('Active_job_status_for_jobs_ending');
-        expect(output).to.have.a.property('Memory_pool_name');
-        expect(output).to.have.a.property('Message_reply');
-        expect(output).to.have.a.property('Message_key,_when_active_job_waiting_for_a_message');
-        expect(output).to.have.a.property('Message_queue_name,_when_active_job_waiting_for_a_message');
-        expect(output).to.have.a.property('Message_queue_library_name,_when_active_job_waiting_for_a_message');
-        expect(output).to.have.a.property('Message_queue_library_ASP_device_name,_when_active_job_waiting_for_a_message');
-        done();
-      });
-    });
-  });
-
-  describe('getDataArea', () => {
-    before('check if data area exists for tests', (done) => {
-      checkObjectExists(config, 'TESTDA', '*DTAARA', (error) => {
-        if (error) { throw error; }
-        done();
-      });
-    });
-    it('returns contents of a data area', (done) => {
-      const connection = new Connection(config);
-
-      const work = new iWork(connection);
-
-      work.getDataArea('NODETKTEST', 'TESTDA', 20, (error, output) => {
-        expect(error).to.equal(null);
-        expect(output).to.be.an('Object');
-        expect(output).to.have.a.property('Type_of_value_returned');
-        expect(output).to.have.a.property('Library_name');
-        expect(output).to.have.a.property('Length_of_value_returned');
-        expect(output).to.have.a.property('Number_of_decimal_positions');
-        expect(output).to.have.a.property('Value');
-        done();
-      });
-    });
-  });
-});

package/test/unit/CommandCallUnit.js

@@ -1,88 +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 */
-const { expect } = require('chai');
-const { CommandCall } = require('../../lib/itoolkit');
-
-describe('Command Call Unit Tests', () => {
-  describe('SH command tests', () => {
-    it('accepts command input and returns <sh> XML output', () => {
-      const command = new CommandCall({ command: 'ls -lah', type: 'sh' });
-
-      const expectedXML = '<sh error=\'fast\'>ls -lah</sh>';
-
-      expect(command.toXML()).to.be.a('string').and.to.equal(expectedXML);
-    });
-
-    it('accepts command input and options returns <sh> with optional attributes', () => {
-      const options = {
-        error: 'on', before: '65535', after: '37', rows: 'on',
-      };
-
-      const command = new CommandCall({ command: 'ls -lah', type: 'sh', options });
-
-      const expectedXML = '<sh rows=\'on\' before=\'65535\' after=\'37\' error=\'on\'>ls -lah</sh>';
-
-      expect(command.toXML()).to.be.a('string').and.to.equal(expectedXML);
-    });
-  });
-
-  describe('CL command tests', () => {
-    it('accepts command input and returns <cmd> XML output', () => {
-      const command = new CommandCall({ command: 'RTVJOBA USRLIBL(?) SYSLIBL(?)', type: 'cl' });
-
-      const expectedXML = '<cmd exec=\'rexx\' error=\'fast\'>RTVJOBA USRLIBL(?) SYSLIBL(?)</cmd>';
-
-      expect(command.toXML()).to.be.a('string').and.to.equal(expectedXML);
-    });
-
-    it('accepts command input and options returns <cmd> with optional attributes', () => {
-      const options = {
-        exec: 'cmd', error: 'on', before: '65535', after: '37', hex: 'on',
-      };
-
-      const command = new CommandCall({ command: 'RTVJOBA USRLIBL(?) SYSLIBL(?)', type: 'cl', options });
-
-      const expectedXML = '<cmd exec=\'cmd\' hex=\'on\' before=\'65535\' after=\'37\' error=\'on\''
-                          + '>RTVJOBA USRLIBL(?) SYSLIBL(?)</cmd>';
-
-      expect(command.toXML()).to.be.a('string').and.to.equal(expectedXML);
-    });
-  });
-
-  describe('QSH command tests', () => {
-    it('accepts command input and returns <qsh> XML output', () => {
-      const command = new CommandCall({ command: 'ls -lah', type: 'qsh' });
-
-      const expectedXML = '<qsh error=\'fast\'>ls -lah</qsh>';
-
-      expect(command.toXML()).to.be.a('string').and.to.equal(expectedXML);
-    });
-
-    it('accepts command input and options returns <qsh> with optional attributes', () => {
-      const options = {
-        error: 'on', before: '65535', after: '37', rows: 'on',
-      };
-      const command = new CommandCall({ command: 'ls -lah', type: 'qsh', options });
-
-      const expectedXML = '<qsh rows=\'on\' before=\'65535\' after=\'37\' error=\'on\'>ls -lah</qsh>';
-
-      expect(command.toXML()).to.be.a('string').and.to.equal(expectedXML);
-    });
-  });
-});

package/test/unit/ConnectionUnit.js

@@ -1,195 +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 sinon = require('sinon');
-const { Connection, CommandCall } = require('../../lib/itoolkit');
-
-describe('Connection Class Unit Tests', () => {
-  describe('constructor', () => {
-    it('creates and returns an instance of Connection with idb transport', () => {
-      const options = {
-        transport: 'idb',
-        transportOptions: {
-          database: process.env.TKDB || '*LOCAL',
-          username: process.env.TKUSER || '',
-          password: process.env.TKPASS || '',
-        },
-      };
-      const connection = new Connection(options);
-
-      expect(connection).to.be.instanceOf(Connection);
-      expect(connection.transportOptions).to.be.an('Object');
-      expect(connection.transportOptions.database).to.equal(options.transportOptions.database);
-      expect(connection.transportOptions.username).to.equal(options.transportOptions.username);
-      expect(connection.transportOptions.password).to.equal(options.transportOptions.password);
-      expect(connection.transport).to.equal('idb');
-      expect(connection.verbose).to.equal(false);
-      expect(connection.commandList).to.be.an('Array');
-      expect(connection.commandList.length).to.equal(0);
-    });
-
-    it('creates and returns an instance of Connection with rest transport', () => {
-      const options = {
-        transport: 'rest',
-        transportOptions: {
-          database: process.env.TKDB || '*LOCAL',
-          username: 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',
-          xslib: 'QXMLSERV',
-          ipc: '*NA',
-          ctl: '*here',
-        },
-      };
-
-      const connection = new Connection(options);
-
-      expect(connection).to.be.instanceOf(Connection);
-      expect(connection.transportOptions).to.be.an('Object');
-      expect(connection.transportOptions.database).to.equal(options.transportOptions.database);
-      expect(connection.transportOptions.username).to.equal(options.transportOptions.username);
-      expect(connection.transportOptions.password).to.equal(options.transportOptions.password);
-      expect(connection.transport).to.equal('rest');
-      expect(connection.transportOptions.ctl).to.equal('*here');
-      expect(connection.transportOptions.ipc).to.equal('*NA');
-      expect(connection.transportOptions.xslib).to.equal('QXMLSERV');
-      expect(connection.commandList).to.be.an('Array');
-      expect(connection.commandList.length).to.equal(0);
-      expect(connection.verbose).to.equal(false);
-    });
-  });
-
-  describe('add', () => {
-    it('appends to xml service request to the command list using Connection class', () => {
-      const options = {
-        transport: 'idb',
-        transportOptions: {
-          database: process.env.TKDB || '*LOCAL',
-          username: process.env.TKUSER || '',
-          password: process.env.TKPASS || '',
-        },
-      };
-      const connection = new Connection(options);
-
-      connection.add(new CommandCall({ command: 'ls -lah', type: 'sh' }));
-      expect(connection.commandList.length).to.equal(1);
-      expect(connection.commandList[0]).to.equal('<sh error=\'fast\'>ls -lah</sh>');
-    });
-  });
-
-
-  describe('debug', () => {
-    it('turns verbose mode on/off using Connection class', () => {
-      const options = {
-        transport: 'idb',
-        transportOptions: {
-          database: process.env.TKDB || '*LOCAL',
-          username: process.env.TKUSER || '',
-          password: process.env.TKPASS || '',
-        },
-      };
-      const connection = new Connection(options);
-
-      connection.debug(true);
-      expect(connection.debug()).to.equal(true);
-      connection.debug(false);
-      expect(connection.debug()).to.equal(false);
-    });
-  });
-
-
-  describe('getTransportOptions', () => {
-    it('returns conn (object) property from Connection instance', () => {
-      const options = {
-        transport: 'rest',
-        transportOptions: {
-          database: process.env.TKDB || '*LOCAL',
-          username: 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',
-          ipc: '*NA',
-          ctl: '*here',
-          xslib: 'QXMLSERV',
-        },
-      };
-      const connection = new Connection(options);
-
-      const transportOptions = connection.getTransportOptions();
-
-
-      expect(transportOptions).to.be.an('Object');
-      expect(transportOptions.database).to.equal(options.transportOptions.database);
-      expect(transportOptions.username).to.equal(options.transportOptions.username);
-      expect(transportOptions.password).to.equal(options.transportOptions.password);
-      expect(transportOptions.ctl).to.equal('*here');
-      expect(transportOptions.ipc).to.equal('*NA');
-      expect(transportOptions.xslib).to.equal('QXMLSERV');
-    });
-  });
-
-
-  describe('run', () => {
-    it('(Connection) invokes transport to execute xml input and returns xml output in callback', () => {
-      const options = {
-        transport: 'idb',
-        transportOptions: {
-          database: process.env.TKDB || '*LOCAL',
-          username: process.env.TKUSER || '',
-          password: process.env.TKPASS || '',
-        },
-      };
-      const connection = new Connection(options);
-      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);
-      });
-    });
-  });
-});