SmartMonkey Test Agent

SmartMonkey Test Agent brings the SmartMonkey Inspector into VS Code as a native webview-based workflow for Android recording and artifact generation.

Instead of running the Inspector in a separate browser window, this extension opens it inside the editor, injects the required SmartMonkey runtime configuration, acquires a managed Android device lease, and keeps generated files in the current workspace.

What It Does

• Opens the SmartMonkey Inspector inside VS Code.
• Boots the Inspector with the extension's remote Appium, helper, and execution endpoints.
• Automatically acquires and releases a managed Android device lease for the session.
• Installs SmartMonkey project assets into the current workspace when they are missing.
• Saves generated scenario, test case, and Appium artifacts into the local workspace.
• Syncs trace sessions, trace artifacts, and trace schema files into smartmonkey/traces.
• Opens generated files directly in VS Code instead of relying on remote container paths.

Commands

The extension contributes two commands:

• SmartMonkey: Open Test Agent
• SmartMonkey: Install Project Assets

Typical Workflow

1. Open a folder-based workspace in VS Code.
2. Run SmartMonkey: Open Test Agent from the Command Palette.
3. The extension installs missing SmartMonkey project assets for the workspace.
4. The Inspector opens in a VS Code webview and requests a managed Android device lease.
5. Choose a project on the landing page and start recording.
6. Generate artifacts from the recorded session.
7. Review the local outputs written into the workspace.

Workspace Outputs

When you use the extension inside a workspace, SmartMonkey writes local files instead of leaving them on the remote helper side:

• Generated artifacts: workspace/
• Trace bundle sync: smartmonkey/traces/
• Agent templates: .github/agents/
• Schema files: smartmonkey/schema/

Key Features

VS Code-native Inspector

The Inspector UI is hosted inside a webview, so recording, reviewing generated files, and opening outputs all stay inside the editor.

Managed Device Leasing

When the Inspector is opened, the extension requests a managed device lease from the SmartMonkey execution service and injects the leased device serial into the Appium capabilities. The lease is released automatically when the panel closes.

Local Artifact Persistence

Generated scenario files, test case markdown, and Appium code are written into the local workspace so they can be reviewed, edited, and committed directly from VS Code.

Trace Synchronization

Recording traces are pulled back from the helper service and stored locally, including session logs, schema data, and binary artifacts.

Requirements

• VS Code 1.95.0 or newer.
• A folder-based workspace if you want local artifact persistence and project asset installation.
• Access to the configured SmartMonkey remote services.