Groovy CPI Studio

Run SAP Cloud Integration Groovy scripts locally while editing them in the native VS Code editor. Created and maintained by Leonardo Pavanelli as an independent community project.

The current release is 1.0.0 (MVP). Interactive debugging is planned for a future release and is not part of this baseline.

Preview

Native Groovy editing in VS Code

Keep the regular VS Code editor, syntax highlighting, file navigation, and your existing development workflow.

Configure the CPI message

Prepare the input Body, typed Headers and Properties, and select the CPI script function to invoke.

Inspect execution results

Review the returned Body, Headers, Properties, structured Message Log records, attachments, and console output.

Requirements

• Desktop VS Code 1.95 or newer.
• Java 8 or newer available through groovyCpiStudio.javaPath, JAVA_HOME, or PATH.
• A trusted workspace. Scripts run with your local user permissions and are not sandboxed.

Groovy 4.0.29 and the local Message, MessageLog, and MessageLogFactory mocks are bundled in the extension. A separate Groovy installation is not required.

Usage

1. Open a .groovy script containing a CPI-style function such as processData(Message message).
2. Select the Groovy CPI Studio icon in the editor title, or run Groovy CPI Studio: Open Studio from the Command Palette.
3. Enter Body, Headers, Properties, and the Script Function in the Input panel.
4. Select Execute Script or press Alt+Enter.
5. Inspect the returned Message and logs in the Output panel or the Groovy CPI Studio Output channel.

The current editor buffer is executed, including unsaved changes. The last input is stored in VS Code workspace state and no test files are written beside the script.

Supported CPI APIs

The MVP supports the core body/header/property methods of com.sap.gateway.ip.core.customdev.util.Message, including both getHeader(name) and getHeader(name, type), and the public property, custom-header, and text-attachment methods of com.sap.it.api.msglog.MessageLog.

Attachments on Message, SOAP APIs, Camel internals, tenant services, credentials, and other proprietary SAP APIs are intentionally not simulated. Unsupported calls fail explicitly instead of silently succeeding.

Development

npm install
npm run build
npm test
npm run package

The Gradle Wrapper downloads build dependencies and copies the compiled runner plus Groovy runtime JARs to resources/runtime. Installed VSIX packages do not download runtime dependencies.

Release history is documented in CHANGELOG.md.

Author and license

Groovy CPI Studio is authored by Leonardo Pavanelli and distributed under the Apache License 2.0. Community contributions are welcome under the same license.

The extension bundles Apache Groovy 4.0.29 under the Apache License 2.0. The upstream license notice is included in resources/runtime/licenses.

Independent project and trademark notice

This is an independent community project. It is not an official product of, affiliated with, sponsored by, or endorsed by either SAP SE, the Apache Software Foundation, or the Apache Groovy project.

Apache, Apache Groovy, and Groovy are trademarks or registered trademarks of the Apache Software Foundation. The use of Apache Groovy in this project identifies the compatible language runtime and does not imply ownership, sponsorship, or endorsement.

SAP and SAP product names are trademarks of SAP SE. This project references public SAP APIs for compatibility testing and does not redistribute proprietary SAP runtime binaries.