Test node-oracledb

May 22, 2025 ยท View on GitHub

This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl and Apache License 2.0 as shown at https://www.apache.org/licenses/LICENSE-2.0. You may choose either license.

If you elect to accept the software under the Apache License, Version 2.0, the following applies:

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Contents

  1. Preparations
  2. Run tests
  3. Enable tests that require extra configuration
  4. Contribute New Tests
  5. Troubleshoot

1. Preparations

See INSTALL for installation details.

On macOS, run a command like:

ln -s $HOME/Downloads/instantclient_19_8/libclntsh.dylib $(npm root)/oracledb/build/Release

Note: the test suite is on GitHub.

1.1 Create a working directory

mkdir <some-directory>
cd <some-directory>

1.2 Clone node-oracledb from GitHub

Clone the project repository:

cd <some-directory>
git clone https://github.com/oracle/node-oracledb.git

1.3 Build

cd <some-directory>/node-oracledb
npm install

Running npm install within the node-oracledb/ directory will recompile oracledb and install all its dependent modules. These are listed in the devDependencies field of package.json file. Thus, 'mocha', and 'eslint' modules are installed by this command.

The test suite uses mocha.

1.4 Configure Database credentials

Set the following environment variables to provide credentials for the test suite.

  • NODE_ORACLEDB_USER provides the username of the schema user which you used for testing. Use the parameter createUser specified in test/dbconfig.js to create a new user within the test suite. Test suite does create such users.

  • NODE_ORACLEDB_PASSWORD provides the password of the schema user which you used for testing. if you're generating a password for the user, use the predefined function testsUtil.generateRandomPassword.

  • NODE_ORACLEDB_CONNECTIONSTRING provides the connection string that points to your database's location.

  • NODE_ORACLEDB_EXTERNALAUTH provides the options for external authentication tests. Setting this environment variable to "true" will enable the tests that require external authentication. To ensure external authentication tests works, firstly make sure the Oracle external authentication service is correctly configured. See Documentation for External Authentication for details.

  • NODE_ORACLEDB_DBA_PRIVILEGE provides the options for DBA privilege. Setting this environment variable to "true" will enable the tests and utilities that require DBA privilege.

  • NODE_ORACLEDB_DBA_USER provides the username of the DBA user which you used for testing, disabled if NODE_ORACLEDB_DBA_PRIVILEGE is not true.

  • NODE_ORACLEDB_DBA_PASSWORD provides the password of the DBA user which you used for testing, disabled if NODE_ORACLEDB_DBA_PRIVILEGE is not true.

  • NODE_ORACLEDB_PROXY_SESSION_USER provides the username of a schema user that can connect through the schema user which you used for testing using proxy authentication. Setting this environment variable will enable the tests that require proxy authentication.

  • NODE_ORACLEDB_QA. This boolean environment variable serves as the toggle switch of certain tests. Some tests, such as callTimeout.js, use hard-coded variables as assertion condition. The test results may be inconsistent in different network situations.

  • NODE_ORACLEDB_DRCP provides an option for skipping the test run when DRCP is enabled. Setting this environment variable to true will skip certain test case runs due to DRCP restrictions.

  • NODE_ORACLEDB_IMPLICIT_POOL provides an option for skipping the test run when Implicit connection pooling is enabled. Setting this environment variable to true will skip certain test case runs due to Implicit connection pooling restrictions.

  • NODE_ORACLEDB_DRIVER_MODE provides an option to set the 'Thin' or 'Thick' modes of node-oracledb. Setting this environment variable to thick will enable Thick mode. Setting it to thin will retain the Thin mode. The default mode is Thin.

  • 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.

  • NODE_ORACLEDB_CLIENT_LIB_DIR provides an optional path for the Oracle Client libraries to be used in Windows and macOS platforms, when using Thick mode in node-oracledb.

  • NODE_ORACLEDB_IMPL_CONNECTIONSTRING provides the DRCP Implicit connection pooling connection string. Use this to test DRCP Implicit connection pooling.

Note: the test suite requires the schema to have these privileges: CREATE TABLE, CREATE SESSION, CREATE PROCEDURE, CREATE SEQUENCE, CREATE TRIGGER, and CREATE TYPE. Certain tests require CREATE DOMAIN, CREATE VIEW privileges as well.

1.5 Set NODE_PATH

export NODE_PATH=<some-directory>/node-oracledb/lib

2. Run tests

See mochajs.org for more information on running tests with mocha.

2.1 Run the complete test suite

cd node-oracledb
npm test

2.2 Run specified tests

cd node_oracledb
./node_modules/.bin/mocha test/<test-names>

3. Enable tests that requires extra configuration

The following test(s) are automatically skipped if their required environment variable(s) are not properly set.

3.1 externalProxyAuth.js

This test aims to test the combined usage of external authentication and proxy authentication. To run this test, you need to complete the following prerequisite setups.

  • Enable external authentication on the schema user which you used for testing. See Documentation for External Authentication for more information on external authentication. Then use the following command to enable external authentication in the test suite.

    export NODE_ORACLEDB_EXTERNALAUTH true

  • Enable proxy authentication on another schema user specified by environment variable NODE_ORACLEDB_PROXY_SESSION_USER that connects through the schema user which you used for testing. See Documentation for Pool Proxy Authentication for more information on proxy authentication. Then use the following command to enable proxy authentication in the test suite.

    export NODE_ORACLEDB_PROXY_SESSION_USER "Your_Proxy_Authenticating_User"

3.2 SODA tests

To execute SODA tests, Oracle Database users require the SODA_APP role granted to them by a DBA. If SODA_APP is not granted, SODA tests will be skipped.

To grant the SODA_APP role to a Oracle Database user, typically a DBA would execute:

```
grant SODA_APP to <Oracle Database user>

```

4. Contribute New Tests

See CONTRIBUTING for general information on contribution requirements.

For easy correlation between results and test code, each test is assigned a number. The Test List shows the numbering of tests.

In order to include your tests in the suite, add each new test file name to test/opts/mocha.opts.

5. Troubleshoot

You may encounter some troubles when running the test suite. These troubles might be caused by the concurrency issue of Mocha framework, network latencies, or database server issues. This section gives some issues that we ever saw and our solutions.

5.1 ORA-00054: resource busy and acquire with NOWAIT specified or timeout expired

This error occurs when Node.js programs try to change database objects which hold locks. The workaround would be:

(1) Use unique DB object names for each test to avoid interference between test files. (2) Try not to use 'beforeEach' blocks for object operations to avoid the interference between cases.

5.2 ORA-00018: maximum number of sessions exceeded

This error occurs when the test suite takes up more sessions than the configured limit. You can alter the session limit on the database server side. If you do not have access to change the database session setting, you could use the below script to deliberately add an interval between tests.

arr=$(ls test/*js)
for case in ${arr[@]}
do
  var="$NODE_PATH/../node_modules/.bin/mocha --timeout 10000 $case"
  eval $var
  sleep 1
done

5.3 ORA-28865: SSL connection closed

You may encounter this error when the test suite sends more connection requests per second than the database is configured to handle.

There are two solutions:

  • Solution 1: Change database RATE_LIMIT configuration. This parameter defines the connection count allowed per second. See RATE_LIMIT for more information.

  • Solution 2: Set the RETRY_COUNT and RETRY_DELAY parameters in connectString.

For example, below is the connectString which could be defined in tnsnames.ora file.

dbaccess = (description=(RETRY_COUNT=20)(RETRY_DELAY=3)
          (address=(protocol=tcps)(port=1521)(host=<db-host>))
          (connect_data=(service_name=<service-name>))
          (security=(my_wallet_directory=<wallet-location>)(ssl_server_cert_dn=<ssl-server-cert-dn>))
       )

5.4 ORA-03114: not connected to ORACLE

We first encountered this error with test/callTimeout.js. It uses some hard-coded variables as assertion conditions, which may lead to assertion fails in slow networks.

The solution is to comment out the line sqlnet.recv_timeout=<minutes> from the sqlnet.ora file.