Name	Name	Last commit message	Last commit date
parent directory ..
jest-configuration	jest-configuration
resources	resources
services	services
stubs	stubs
utils	utils
ApplicationConstants.js	ApplicationConstants.js
README.md	README.md
TestFrameworkException.js	TestFrameworkException.js
messages.json	messages.json
package.json	package.json

SuiteCloud Unit Testing

Suitecloud Unit Testing allows you to use unit testing with Jest for your SuiteCloud projects.

Features

Provides a default configuration to run unit tests with Jest in SuiteCloud projects.
Supports unit testing for SuiteScript 2.x files.
Provides stubs for all SuiteScript 2.x modules.
Allows you to create custom stubs for any module used in SuiteScript 2.x files.

For more information about the available SuitScript 2.x modules, see SuiteScript 2.x Modules.
For a complete list of available stubs, see Available Stubs.

Prerequisites

Node.js version 22 LTS
Having a SuiteCloud project

Getting Started

If you use SuiteCloud CLI for Node.js, you can install SuiteCloud Unit Testing when running the project:create command by following the questions prompted. This way, your project is initialized with SuiteCloud Unit Testing, and all the dependencies are being taken care of.

⚠ SuiteCloud Unit Testing is installed as a devDependency.

However, if you want to configure SuiteCloud Unit Testing manually, do the following:

Inside of your SuiteCloud project folder, create a src folder.
Move your project files inside of the src folder.
To initialize the NPM package, from the root of your SuiteCloud project folder, run npm init.

💡 A package.json file is created in your SuiteCloud project folder.

In your package.json file, add the following code:

{
    "scripts": {
        "test": "jest"
    }
}

From the root of your SuiteCloud project folder, run the following command:
```
npm install --save-dev @oracle/suitecloud-unit-testing jest
```
Create a __tests__ folder, inside of the root of your SuiteCloud project folder.

Create a sample-test.js file, inside of the __tests__ folder, with the following content:

describe('Basic jest test with simple assert', () => {
    it('should assert strings are equal', () => {
        const a = 'foobar';
        const b = 'foobar';
        expect(a).toMatch(b);
    });
});

From the root of your SuiteCloud project folder, run npm test to run your test. You should see an output similar to the following:
```
PASS  __tests__/sample-test.js
Basic jest test with simple assert
    √ should assert strings are equal (2ms)
```

You successfully ran your first test for a SuiteCloud project!

Additional Configuration

To properly run your tests against the SuiteScript 2.x files of your SuiteCloud project, create a jest.config.js file inside of the root of your SuiteCloud project folder.

The jest.config.js file must follow a specific structure. Depending on your SuiteCloud project type, check one of the following examples:

For Account Customization Projects:

const SuiteCloudJestConfiguration = require("@oracle/suitecloud-unit-testing/jest-configuration/SuiteCloudJestConfiguration");

module.exports = SuiteCloudJestConfiguration.build({
    projectFolder: 'src', // or your SuiteCloud project folder
    projectType: SuiteCloudJestConfiguration.ProjectType.ACP,
    rootDir: '.' // optional: automatically detected in monorepos
});

For SuiteApps:

const SuiteCloudJestConfiguration = require("@oracle/suitecloud-unit-testing/jest-configuration/SuiteCloudJestConfiguration");

module.exports = SuiteCloudJestConfiguration.build({
    projectFolder: 'src', // or your SuiteCloud project folder
    projectType: SuiteCloudJestConfiguration.ProjectType.SUITEAPP,
    rootDir: '.' // optional: automatically detected in monorepos
});

Project Structure and Root Directory Configuration

The rootDir property is optional with enhanced workspace detection. The configuration automatically:

Detects common monorepo/workspace setups (pnpm, Yarn/npm workspaces, Lerna)
Defaults to current directory in standalone projects
Configures proper module resolution across workspaces
Scopes test execution to the current package directory

Example project structures:

Standard Project Structure:
└── my-netsuite-project/        👈 rootDir: "."
    ├── node_modules/
    ├── src/
    ├── __tests__/
    └── jest.config.js

Monorepo Structure:
└── monorepo/                   
    ├── node_modules/           
    ├── package.json           # With workspaces configuration
    └── packages/
        └── my-suiteapp/       👈 rootDir automatically detected
            ├── src/
            ├── __tests__/
            └── jest.config.js

When working in a monorepo:

Tests are automatically scoped to your current package directory
Module resolution is configured across the workspace
No manual rootDir configuration is required
Supports pnpm, Yarn/npm workspaces, and Lerna configurations