Documentation and test case updates for the new features

Author: sharadraju

doc/src/api_manual/oracledb.rst

@@ -3162,9 +3162,9 @@ Oracledb Methods
         * - Attribute
           - Description
         * - ``binaryDir``
-          - This specifies the directory that contains the node-oracledb Thick mode binary module.
+          - This directory is added to the start of the default search path used by :meth:`~oracledb.initOracleClient()` to load the node-oracledb Thick mode binary module.
 
-            If ``binaryDir`` is not specified, then :meth:`~oracledb.initOracleClient()` looks for the Thick mode binary in either the ``build/Release`` or ``build/Debug`` sub directories under the node-oracledb home directory.
+            The default search path includes ``node_modules/oracledb/build/Release`` and ``node_modules/oracledb/build/Debug``.
 
             .. versionadded:: 6.2
         * - ``configDir``

doc/src/release_notes.rst

@@ -13,45 +13,41 @@ node-oracledb `v6.2.0 <https://github.com/oracle/node-oracledb/compare/v6.1.0...
 Thin Mode Changes
 ++++++++++++++++++
 
-#)  Ensure that the database port is passed as a number to the  network connection.
+#)  Ensure that the database port is passed as a number to the network connection.
     See `Issue #1600 <https://github.com/oracle/node-oracledb/issues/1600>`__
-    and `PR #1601 <https://github.com/oracle/node-oracledb/pull/1601>`__.
-    (Daniel Rodrigues)
+    and `PR #1601 <https://github.com/oracle/node-oracledb/pull/1601>`__
+    (Daniel Rodrigues).
 
-#) Improved statement bind variable placeholder parser performance, handle
+#)  Improved statement bind variable placeholder parser performance, handle
     statements which use the `Alternative Quoting Mechanism
     <https://www.oracle.com/pls/topic/lookup?ctx=dblatest&id=GUID-1824CBAA-6E16-4921-B2A6-112FB02248DA>`__
     ('Q' strings), and fix some issues identifying bind variable placeholders
     in embedded quotes and in JSON syntax.
-    See `Issue #1605 <https://github.com/oracle/node-oracledb/issues/1605>`__.
+    `Issue #1605 <https://github.com/oracle/node-oracledb/issues/1605>`__.
 
 Thick Mode Changes
 ++++++++++++++++++
 
-#)  Implemented enhancement to support listIndexes() method to fetch all the
-    current indexes from the SODA collection.
-
-#)  Fixed bug where a segmentation fault (segfault) occurred while populating
-    object Collection having BLOB property. See
-    `node-oracledb public Slack channel <https://node-oracledb.slack.com/
-    archives/CCM8AMSF7/p1694544451676639>`__.
+#)  Added new property :ref:`binaryDir <odbinitoracleclientattrsopts>` to the
+    options passed to :meth:`~oracledb.initOracleClient()` which indicates the
+    name of the directory that contains the node-oracledb :ref:`Thick mode
+    <enablingthick>` binary module.  `PR #1602
+    <https://github.com/oracle/node-oracledb/pull/1602>`__ (Kwok Chun Man).
 
-#)  Added :meth:`sodaOperation.lock()` method on
-    :ref:`SodaOperation <sodaoperationclass>` object to disable modification
-    on any SODA document. An explicit commit or rollback is required to unlock
-    and modify any corresponding SODA document.
+#)  Fixed a segfault while populating a collection with a BLOB
+    property. See `node-oracledb public Slack channel
+    <https://node-oracledb.slack.com/ archives/CCM8AMSF7/p1694544451676639>`__.
 
+#)  Added ``listIndexes()`` method to fetch all the current indexes from
+    a SODA collection.
 
-#)  Fixed bug that throws an 'ORA-21525' error with dbObjects having one or
-    more 'Number' attributes of precision less than or equal to 18 and scale
-    as 0.
-    `Issue #1594 <https://github.com/oracle/node-oracledb/issues/1594>`__.
+#)  Added :meth:`sodaOperation.lock()` method to disable modification of SODA
+    documents by other connections.
 
-#)  Added new property :ref:`binaryDir <odbinitoracleclientattrsopts>` to the
-    options passed to :meth:`~oracledb.initOracleClient()` which indicates the
-    name of the directory that contains the node-oracledb Thick mode binary
-    module.
-    `PR #1602 <https://github.com/oracle/node-oracledb/pull/1602>`__. (Leman)
+#)  Fixed bug causing an 'ORA-21525' error with :ref:`DbObject Class
+    <dbobjectclass>` objects that have a NUMBER attribute with a scale of 0
+    and precision less than, or equal, to 18.  `Issue #1594
+    <https://github.com/oracle/node-oracledb/issues/1594>`__.
 
 node-oracledb `v6.1.0 <https://github.com/oracle/node-oracledb/compare/v6.0.3...v6.1.0>`__ (30 Aug 2023)
 --------------------------------------------------------------------------------------------------------

test/README.md

@@ -114,6 +114,10 @@ Set the following environment variables to provide credentials for the test suit
 
 * `NODE_ORACLEDB_DRCP` provides an option for skipping test run when DRCP is enabled. Setting this environment variable to `true` will skip certain test case run due to DRCP restrictions.
 
+* `NODE_ORACLEDB_WALLET_LOCATION` provides the local directory name for the wallets that may be required for mutual TLS (mTLS) connections, especially to Oracle Cloud Autonomous Databases optionally. The wallet location can also be provided as a part of the database connect string.
+
+* `NODE_ORACLEDB_WALLET_PASSWORD` provides the password for the wallets that may be required for mutual TLS (mTLS) connections, especially to Oracle Cloud Autonomous Databases.
+
 Note: the test suite requires the schema to have these privileges: CREATE TABLE, CREATE SESSION,
 CREATE PROCEDURE, CREATE SEQUENCE, CREATE TRIGGER, and CREATE TYPE.
 

test/jsonDualityViews4.js

@@ -702,7 +702,7 @@ describe('275. jsonDualityView4.js', function() {
       FROM student_ov s
     `);
 
-      assert.strictEqual(result.rows[0][0].A1, 1);
+      assert.strictEqual(result.rows[0][0].a1, 1);
       await connection.execute('DROP TABLE a PURGE');
     });
   });

test/jsonDualityViews6.js

@@ -406,7 +406,7 @@ describe('277. jsonDualityView6.js', function() {
 
       const result = await connection.execute(`select * from student_ov`);
       assert.strictEqual(result.rows.length, 3);
-      assert.deepEqual(result.rows[0][0]._id, {"STUID":1});
+      assert.deepEqual(result.rows[0][0]._id, {"stuid":1});
       assert.strictEqual(result.rows[0][0].StudentName, "Ajit");
       assert.deepEqual(result.rows[0][0].StudentClass, [{"StudentClassId":1, "StudentId":1,
         "Class":[{"ClassId":1, "Name":"CS101"}]}]);

test/list.txt

@@ -5513,34 +5513,34 @@ oracledb.OUT_FORMAT_OBJECT and resultSet =  true
 287. sodaOperationsLock.js
     287.1 lock on sodaOperations
 
-286. embedded_oid.js
-    286.1 Test embedded oid normal operations
-        286.1.1 create collection with No key present in the input doc
-        286.1.2 Embedded varchar key already present doc
-        286.1.3 Embedded number key already present in the doc
-        286.1.4 test replaceOne, for each replace op, use previously retrieved key
-        286.1.5 test replaceOne, A new string ID is present in the target document
-        286.1.6 test replaceOne, A new integer ID is present in the target document
-        286.1.7 test replaceOneAndGet, for each replace op, use previously retrieved key
-        286.1.8 test replaceOneAndGet, A new string ID is present in the target document
-        286.1.9 test replaceOneAndGet, A new integer ID is present in the target document
-        286.1.10 Negative test for save()
-        286.1.11 Negative test for saveAndGet()
-    286.2 Test QBEs - filter, skip and limit
-        286.2.1 filter()
-        286.2.2 skip() first doc
-        286.2.3 limit() operation to 1 doc
-        286.2.4 remove() previously retrieved key
-        286.2.5 remove() with filter, No key present in the input doc
-
-288. sqlParser.js
-    288.1 parse SQL containing json_object()
-    288.2 bind variables between quoted string
-    288.3 single line comment
-    288.4 constant string
-    288.5 multiple division operation
-    288.6 SQL statement starting with parentheses
-    288.7 statement containing simple strings
-    288.8 binds between comments
-    288.9 non-ascii character in the bind name
-    288.10 apostrophe in single line comment
+288. embedded_oid.js
+    288.1 Test embedded oid normal operations
+        288.1.1 create collection with No key present in the input doc
+        288.1.2 Embedded varchar key already present doc
+        288.1.3 Embedded number key already present in the doc
+        288.1.4 test replaceOne, for each replace op, use previously retrieved key
+        288.1.5 test replaceOne, A new string ID is present in the target document
+        288.1.6 test replaceOne, A new integer ID is present in the target document
+        288.1.7 test replaceOneAndGet, for each replace op, use previously retrieved key
+        288.1.8 test replaceOneAndGet, A new string ID is present in the target document
+        288.1.9 test replaceOneAndGet, A new integer ID is present in the target document
+        288.1.10 Negative test for save()
+        288.1.11 Negative test for saveAndGet()
+    288.2 Test QBEs - filter, skip and limit
+        288.2.1 filter()
+        288.2.2 skip() first doc
+        288.2.3 limit() operation to 1 doc
+        288.2.4 remove() previously retrieved key
+        288.2.5 remove() with filter, No key present in the input doc
+
+289. sqlParser.js
+    289.1 parse SQL containing json_object()
+    289.2 bind variables between quoted string
+    289.3 single line comment
+    289.4 constant string
+    289.5 multiple division operation
+    289.6 SQL statement starting with parentheses
+    289.7 statement containing simple strings
+    289.8 binds between comments
+    289.9 non-ascii character in the bind name
+    289.10 apostrophe in single line comment

test/sodaOpLock.js

@@ -32,7 +32,6 @@
 'use strict';
 
 const oracledb  = require('oracledb');
-const assert    = require('assert');
 const dbConfig  = require('./dbconfig.js');
 const sodaUtil  = require('./sodaUtil.js');
 const testsUtil = require('./testsUtil.js');
@@ -74,9 +73,8 @@ describe('287. sodaOperationsLock.js', () => {
     }
   });
 
-  it('287.1 lock on sodaOperations', async() => {
-       coll.find().lock();
+  it('287.1 lock on sodaOperations', () => {
+    coll.find().lock();
   });
-  
 
 });

test/sqlParser.js

@@ -23,7 +23,7 @@
  * limitations under the License.
  *
  * NAME
- *   288. sqlParser.js
+ *   289. sqlParser.js
  *
  * DESCRIPTION
  *   This test verifies the SQL Parser written for the thin mode
@@ -35,7 +35,7 @@ const oracledb = require('oracledb');
 const assert   = require('assert');
 const dbConfig = require('./dbconfig.js');
 
-describe('288. sqlParser.js', function() {
+describe('289. sqlParser.js', function() {
 
   let conn;
   let isRunnable = false;
@@ -54,16 +54,16 @@ describe('288. sqlParser.js', function() {
     await conn.close();
   });
 
-  it('288.1 parse SQL containing json_object()', async function() {
+  it('289.1 parse SQL containing json_object()', async function() {
     if (conn.oracleServerVersion < 2100000000) {
       this.skip();
     }
     const sql = `SELECT json_object('id':2),:bv1, json {'key': 2} FROM DUAL`;
     const info = await conn.getStatementInfo(sql);
     assert.deepStrictEqual(info.bindNames, ['BV1']);
-  }); // 288.1
+  }); // 289.1
 
-  it('288.2 bind variables between quoted string', async () => {
+  it('289.2 bind variables between quoted string', async () => {
     const sql = `select
       :a,
       q'{This contains ' and " and : just fine}',
@@ -79,42 +79,42 @@ describe('288. sqlParser.js', function() {
       from dual`;
     const info = await conn.getStatementInfo(sql);
     assert.deepStrictEqual(info.bindNames, ["A", "B", "C", "D", "E", "F"]);
-  }); // 288.2
+  }); // 289.2
 
-  it('288.3 single line comment', async () => {
+  it('289.3 single line comment', async () => {
     const sql = `--begin :value2 := :a + :b + :c +:a +3; end;
                 begin :value2 := :a + :c +3; end;`;
     const info = await conn.getStatementInfo(sql);
     assert.deepStrictEqual(info.bindNames, ["VALUE2", "A", "C"]);
-  }); // 288.3
+  }); // 289.3
 
-  it('288.4 constant string', async () => {
+  it('289.4 constant string', async () => {
     const sql = `begin
                   :value := to_date('20021231 12:31:00', :format);
                  end;`;
     const info = await conn.getStatementInfo(sql);
     assert.deepStrictEqual(info.bindNames, ["VALUE", "FORMAT"]);
-  }); // 288.4
+  }); // 289.4
 
-  it('288.5 multiple division operation', async () => {
+  it('289.5 multiple division operation', async () => {
     const sql = `select :a / :b, :c / :d from dual`;
     const info = await conn.getStatementInfo(sql);
     assert.deepStrictEqual(info.bindNames, ["A", "B", "C", "D"]);
-  }); // 288.5
+  }); // 289.5
 
-  it('288.6 SQL statement starting with parentheses', async () => {
+  it('289.6 SQL statement starting with parentheses', async () => {
     const sql = `(select :a from dual) union (select :b from dual)`;
     const info = await conn.getStatementInfo(sql);
     assert.deepStrictEqual(info.bindNames, ["A", "B"]);
-  }); // 288.6
+  }); // 289.6
 
-  it('288.7 statement containing simple strings', async () => {
+  it('289.7 statement containing simple strings', async () => {
     const sql = `select '"string_1"', :bind_1, ':string_2' from dual`;
     const info = await conn.getStatementInfo(sql);
     assert.deepStrictEqual(info.bindNames, ["BIND_1"]);
-  }); // 288.7
+  }); // 289.7
 
-  it('288.8 binds between comments', async () => {
+  it('289.8 binds between comments', async () => {
     const sql = `select
                 /* comment 1 with /* */
                 :a,
@@ -125,21 +125,21 @@ describe('288. sqlParser.js', function() {
                 from dual`;
     const info = await conn.getStatementInfo(sql);
     assert.deepStrictEqual(info.bindNames, ["A", "B", "C"]);
-  }); // 288.8
+  }); // 289.8
 
-  it('288.9 non-ascii character in the bind name', async () => {
+  it('289.9 non-ascii character in the bind name', async () => {
     const sql = `select :méil$ from dual`;
     const info = await conn.getStatementInfo(sql);
     assert.deepStrictEqual(info.bindNames, ["MÉIL$"]);
-  }); // 288.9
+  }); // 289.9
 
-  // gh issue 1605
+  // GitHub issue 1605
   // https://github.com/oracle/node-oracledb/issues/1605
-  it('288.10 apostrophe in single line comment', async () => {
+  it('289.10 apostrophe in single line comment', async () => {
     const sql = `
                 -- Example with ' in comment
                 SELECT :test, 'String' FROM DUAL`;
     const info = await conn.getStatementInfo(sql);
     assert.deepStrictEqual(info.bindNames, ['TEST']);
-  }); // 288.10
+  }); // 289.10
 });