Test your app

Thorough testing ensures your app works as expected before you submit it for review. OCP supports unit testing, local testing, and preview track installations for end-to-end verification.

OCP app templates include Vitest for unit testing, but you can use any unit testing framework as long as you configure it to run using the yarn test command. Unit tests run before uploads and when building your app to run on OCP infrastructure. If any tests fail, you cannot publish your app.

See the basic template, generated from the ocp app init command, for unit test examples, including a state machine-based job.

The OCP local testing tool lets you preview your settings form, test functions with custom payloads, run jobs, and debug issues with detailed logs, without publishing to OCP.

Start the local testing tool:

See Local testing for installation and usage instructions. See Feature comparison for a comparison of local and remote testing.

Install apps into an OCP account from the CLI, even when they are not visible in the App Directory. This applies to preview track versions and legacy development and beta versions.

Deploy to a preview track to publish a version without making it public or auto-upgrading installations pinned to a semver version. With no flags, ocp app deploy deploys to your own track, dev/USERNAME, such as dev/jdoe. This requires runtime: node22 or later and @zaiusinc/app-sdk 3 or later. Run the following command:

The command builds and publishes the app in one step and derives the version from your app content, such as dev/jdoe/95544ac.

Install your app in a test account so that the account follows the track. You do this once:

Without a version, the installation follows your own dev/USERNAME track. Each later ocp app deploy command moves the installation to the version you deployed, so you do not need to reinstall. To return your track to an earlier version, run ocp app rollback.

To share a version with testers, deploy to a shared beta/ track with ocp app deploy --preview-track beta/qa. Alternatively, move a version you already built with ocp app promote --from dev/jdoe --to beta/qa. Testers install with ocp directory install my_app --preview-track beta/qa TRACKER_ID.

See Deploy apps with preview tracks for the full workflow, including promotion, rollback, and limits.

Use pre-release tags, like -dev or -beta, to publish a version without making it public or auto-upgrading existing installations. To build and publish a dev version to OCP in one step, run:

To prepare and publish separately, run:

Install legacy pre-release apps from the CLI:

Replace TRACKER_ID with the tracker ID of the OCP account where you want to install the app. When this command completes, your app is installed and ready to use. Verify the app was installed successfully with the following command:

To uninstall an app from an account, run the following command:

After you install your app into a test account, verify the following in the OCP UI: