@optimizely/ocp-local-env
v1.0.0-beta.14
Published
Local testing environment for Optimizely Connect Platform (OCP) applications
Readme
OCP Local Testing Tool
A comprehensive local development and testing environment for Optimizely Connect Platform (OCP) applications.
Overview
The OCP Local Testing Tool enables developers to build, test, and debug OCP applications locally before publishing them to the Optimizely Connect Platform. It provides a simulated OCP environment with real-time code reloading, interactive testing interfaces, and detailed logging.
Features
- Local OCP Environment: Run your OCP apps locally without deploying to the cloud
- Real-time Code Reloading: Changes to your app code are detected and automatically rebuilt
- Interactive UI: Test functions, jobs, and lifecycle hooks through an intuitive web interface
- Configurable Settings: Simulate different app configurations with a dynamic settings interface
- Detailed Logging: View comprehensive logs for all app activities
- Webhook Testing: Test webhook functions with customizable payloads
- Job Simulation: Manually trigger jobs or simulate scheduled execution
- Lifecycle Testing: Test install, upgrade, and uninstall hooks
Prerequisites
- Node.js v18 or later
- Yarn or npm
- Modern web browser (Chrome, Firefox, Edge, or Safari)
Installation
# Install the OCP Local Testing Tool globally
npm install -g @optimizely/ocp-local-envQuick Start
Navigate to your OCP app directory (containing app.yml)
Run the local testing tool
ocp-local-envThe tool will automatically open your browser to http://localhost:3000
Start developing and testing your OCP app
Development
Running Tests
# Run unit tests
yarn test
# Run E2E tests (requires setup first)
yarn test:e2e:setup # Clone test app and install dependencies
yarn test:e2e # Run Playwright tests
# E2E test options
yarn test:e2e:ui # Run with Playwright UI
yarn test:e2e:debug # Run in debug modeE2E Test App
E2E tests use a real OCP app (hub-shakedown) to test the local testing tool. The app is cloned into e2e/apps/ during setup. You can specify a different test app using the E2E_TEST_APP environment variable.
Documentation
https://docs.developers.optimizely.com/optimizely-connect-platform/docs/local-testing#/versions
Support
For support, please create an issue on the GitHub repository or contact the Optimizely Connect Platform team.
