testdriverai 6.2.2 → 7.1.0

package/docs/sdk-browser-rendering.md

@@ -0,0 +1,167 @@
+# SDK Browser Rendering Feature
+
+## Overview
+
+The TestDriver SDK now supports automatic browser rendering of the sandbox environment, matching the behavior of the existing agent CLI. When connecting to a sandbox, the SDK will automatically open a browser window showing the live VNC session, allowing you to watch test execution in real-time.
+
+## Changes Made
+
+### 1. SDK Core (`sdk.js`)
+
+#### Added Dependencies
+- Imported `createDebuggerProcess` from `./agent/lib/debugger.js` to enable the debugger server
+
+#### New Instance Variables
+- `debuggerProcess`: Reference to the debugger server process
+- `debuggerUrl`: URL of the debugger web interface
+
+#### Enhanced `connect()` Method
+- Automatically starts the debugger server when connecting (unless in headless mode)
+- Calls `_renderSandbox()` after successful connection to open the browser window
+- Supports new `headless` option to disable browser rendering
+
+#### New Methods
+
+**`_renderSandbox(instance)`**
+- Constructs the VNC URL from the sandbox instance details
+- Creates encoded data payload for the debugger
+- Emits the `show-window` event with the debugger URL
+
+**`_openBrowser(url)`**
+- Uses the `open` npm package to launch the default browser
+- Handles errors gracefully with fallback to manual URL copy
+- Uses dynamic import for ES module compatibility
+
+#### Enhanced `_setupLogging()` Method
+- Added event listener for `show-window` events
+- Automatically opens browser when event is emitted
+- Respects CI mode (prints view-only URL instead of opening browser)
+
+### 2. Documentation Updates
+
+#### SDK README (`SDK_README.md`)
+- Updated `connect()` method documentation
+- Added `headless` parameter description
+- Added note about automatic browser rendering behavior
+- Provided examples for both headless and non-headless modes
+
+### 3. Examples
+
+#### `examples/sdk-with-browser.js`
+- Demonstrates default behavior with browser rendering
+- Shows how to use the SDK with visual feedback
+- Includes detailed console output explaining what's happening
+
+#### `examples/sdk-headless.js`
+- Demonstrates headless mode for CI/CD environments
+- Shows how to disable browser rendering
+- Useful for automated testing scenarios
+
+### 4. Tests
+
+#### `testdriver/acceptance-sdk/sandbox-render.test.mjs`
+- Verifies that the `show-window` event is emitted
+- Tests basic interaction with the rendered sandbox
+- Includes timeout handling for sandbox creation
+
+## How It Works
+
+1. **Connection Phase**
+   - When `connect()` is called without `headless: true`
+   - The debugger server is started on port 3000 (by default)
+   - The sandbox is created/connected as usual
+
+2. **Rendering Phase**
+   - After successful connection, `_renderSandbox()` is called
+   - It constructs the VNC URL: `http://{instance.ip}:{vncPort}/vnc_lite.html?token=V3b8wG9`
+   - Creates data payload with resolution, URL, and token
+   - Builds debugger URL: `{debuggerUrl}?data={encodedData}`
+
+3. **Browser Opening**
+   - The `show-window` event is emitted with the debugger URL
+   - The event listener in `_setupLogging()` catches it
+   - The `_openBrowser()` method is called
+   - Default browser opens to the debugger interface
+   - User can watch live test execution
+
+## Usage Examples
+
+### Default Behavior (Browser Opens)
+
+```javascript
+const TestDriver = require('testdriverai');
+
+const client = new TestDriver(process.env.TD_API_KEY, {
+  logging: true
+});
+
+await client.auth();
+await client.connect(); // Browser opens automatically
+
+await client.hoverText('Submit');
+await client.click();
+```
+
+### Headless Mode (No Browser)
+
+```javascript
+const TestDriver = require('testdriverai');
+
+const client = new TestDriver(process.env.TD_API_KEY, {
+  logging: true
+});
+
+await client.auth();
+await client.connect({ headless: true }); // No browser
+
+await client.hoverText('Submit');
+await client.click();
+```
+
+### CI/CD Mode
+
+When `CI` environment variable is set or `config.CI` is true, the SDK will:
+- Print the view-only URL instead of opening a browser
+- Allow monitoring without interrupting the test flow
+
+## Benefits
+
+1. **Visual Feedback**: Developers can watch tests execute in real-time
+2. **Debugging**: Easier to understand test failures by seeing what's happening
+3. **Consistency**: Matches the behavior of the CLI tool
+4. **Flexibility**: Can be disabled for CI/CD with `headless: true`
+5. **No Code Changes**: Existing SDK code continues to work (default behavior adds browser)
+
+## Compatibility
+
+- Works on macOS, Linux, and Windows
+- Requires the `open` npm package (already a dependency)
+- Debugger server starts automatically when needed
+- Falls back gracefully if browser can't be opened (prints URL)
+
+## Testing
+
+Run the test to verify functionality:
+
+```bash
+TD_API_KEY=your_key npx vitest run testdriver/acceptance-sdk/sandbox-render.test.mjs
+```
+
+Or try the examples:
+
+```bash
+# With browser rendering
+TD_API_KEY=your_key node examples/sdk-with-browser.js
+
+# Headless mode
+TD_API_KEY=your_key node examples/sdk-headless.js
+```
+
+## Future Enhancements
+
+Potential improvements:
+- Allow custom debugger port configuration
+- Support for multiple concurrent sandbox windows
+- Option to disable debugger server entirely
+- Custom browser selection
+- Headless mode detection based on environment

package/docs/v6/getting-started/self-hosting.mdx

@@ -0,0 +1,407 @@
+---
+title: "Self-Hosting TestDriver"
+sidebarTitle: "Self-Hosting"
+description: "Complete guide to self-hosting TestDriver instances on AWS"
+icon: "server"
+---
+
+```mermaid
+graph LR
+    A[CLI] <--> B[api.testdriver.ai]
+    B <--> C[Your AWS EC2 Instance]
+```
+
+Self-hosting TestDriver allows you to run tests on your own infrastructure, giving you full control over the environment, security, and configurations. This guide walks you through setting up and managing self-hosted TestDriver instances using AWS.
+
+## Why self host?
+
+Self-hosting TestDriver gives you complete control over your test execution environment:
+
+- **Enhanced security**: Get complete control over ingress and egress rules.
+- **Complete customization**: Modify the TestDriver Golden Image (our pre-configured AMI) to include custom dependencies, software, and configurations at launch time.
+- **Powerful Infrastructure**: Run tests on bare metal infrastructure that support emulators and simulators.
+
+You'll use the [TestDriver CLI repository](https://github.com/testdriverai/cli) which contains all the infrastructure templates and setup scripts needed for self-hosting.
+
+## Overview
+
+By the end of this guide, you'll have a complete self-hosted testing infrastructure that can:
+
+- Spawn TestDriver instances on-demand in your AWS account
+- Run tests on your own AWS infrastructure with custom configurations
+- Integrate seamlessly with GitHub Actions CI/CD workflows
+- Automatically clean up resources after test completion
+
+The setup process involves three main steps:
+
+1. **CloudFormation Infrastructure**: Deploy our `setup/aws/cloudformation.yaml` template to create the foundational AWS resources (VPC, security groups, IAM roles, and a launch template for instance creation).
+2. **On-Demand Instance Spawning**: Use `setup/aws/spawn-runner.sh` with your Launch Template ID to programmatically spawn TestDriver instances whenever you need to run tests.
+3. **GitHub Actions Integration**: Use `.github/workflows/self-hosted.yml` as a template for running tests in CI. This workflow demonstrates the complete lifecycle: spawning an instance, running tests, and shutting down the instance to minimize costs.
+
+## Prerequisites
+
+- AWS account with permissions to run CloudFormation.
+- [AWS CLI](https://aws.amazon.com/cli/) installed locally.
+
+  <Tip>
+    Be sure to run `aws configure` with your credentials
+  </Tip>
+- Access to the TestDriver AMI (Golden Image is `ami-055cd47506a2f39bb`)\
+  [Contact us with your preferred AWS Region for access](https://form.typeform.com/to/UECf9rDx?typeform-source=testdriver.ai).
+- A GitHub repository for committing your tests & workflow.
+
+## Step 1: Set Up AWS Infrastructure
+
+### Deploy CloudFormation Stack
+
+Our [`setup/aws/cloudformation.yaml`](https://github.com/testdriverai/cli/tree/main/setup/aws/cloudformation.yaml) template creates:
+
+- Dedicated VPC with public subnet
+- Security group with proper port access
+- IAM roles and instance profiles
+- EC2 launch template for programmatic instance creation
+
+This is a one-time setup used to generate a template ID for launching instances.
+
+```bash
+# Deploy the CloudFormation stack
+aws cloudformation deploy \
+  --template-file setup/aws/cloudformation.yaml \
+  --stack-name my-testdriver-infrastructure \
+  --parameter-overrides \
+    ProjectTag=testdriver \
+    AllowedIngressCidr=0.0.0.0/0 \
+    InstanceType=c5.xlarge \
+    CreateKeyPair=true \
+  --capabilities CAPABILITY_IAM
+```
+
+<Danger>
+  **Security**: Replace `AllowedIngressCidr=0.0.0.0/0` with your specific IP ranges to lock down access to your VPC.
+</Danger>
+
+### Get Launch Template ID
+
+After CloudFormation completes, find the launch template ID in the stack outputs:
+
+```bash
+aws cloudformation describe-stacks \
+  --stack-name my-testdriver-infrastructure \
+  --query 'Stacks[0].Outputs[?OutputKey==`LaunchTemplateId`].OutputValue' \
+  --output text
+```
+
+<Tip>
+  **Save this ID** – you'll need it for the next step.
+</Tip>
+
+## Step 2: Spawn a New TestDriver Runner
+
+This step is performed **every time you want to run tests**. The `spawn-runner.sh` script launches a new EC2 instance on-demand for test execution.
+
+### Using spawn-runner.sh
+
+Our [`setup/aws/spawn-runner.sh`](https://github.com/testdriverai/cli/tree/main/setup/aws/spawn-runner.sh) script:
+
+- Launches a new EC2 instance using your launch template from Step 1
+- Waits for the instance to become ready
+- Completes the TestDriver handshake
+- Returns instance details (IP, instance ID) for CLI usage
+
+The script accepts parameters as either environment variables or CLI arguments:
+
+```bash
+# Launch an instance using environment variables
+export AWS_REGION=us-east-2
+export AMI_ID=ami-••••••••••  # Your TestDriver AMI (contact us to get one)
+export AWS_LAUNCH_TEMPLATE_ID=lt-••••••••••  # From CloudFormation output from step 1
+export RESOLUTION=1440x900 # Change screen resolution if desired (default is 1440x900)
+
+/bin/bash ./setup/aws/spawn-runner.sh
+```
+
+The script outputs:
+
+```
+PUBLIC_IP=1.2.3.4
+INSTANCE_ID=i-1234567890abcdef0
+AWS_REGION=us-east-2
+```
+
+<Note>
+  **Instance Lifecycle**: Instances spawned by this script will continue running until you manually terminate them. They are automatically tagged with `Name=TestDriverRunner` and `Project=[your ProjectTag value]` for easy identification in the AWS console.
+</Note>
+
+#### Changing Resolution in Lifecycle Files
+
+You can also change the resolution before running tests by adding an [`exec`](/commands/exec) command in your `lifecycle/provision.yaml` file:
+
+```yaml lifecycle/provision.yaml
+version: 6.0.0
+steps:
+  - prompt: set screen resolution
+    commands:
+      - command: exec
+        lang: pwsh
+        code: |
+          C:\testdriver\SetResolution.ps1 -Width 1920 -Height 1080
+```
+
+This approach is useful when you need different resolutions for different test scenarios. See the [Lifecycle Files documentation](/guide/lifecycle) for more information about provision scripts.
+
+### CLI Usage
+
+Once you have an instance IP, run tests directly:
+
+```bash
+# Basic test execution
+npx testdriverai@latest run test.yaml --ip=1.2.3.4
+```
+
+You can use the `PUBLIC_IP` to target the instance you just spawned via `./setup/aws/spawn-runner.sh`:
+
+```sh
+npx testdriverai@latest run testdriver/your-test.yaml \
+  --ip="$PUBLIC_IP" \
+```
+
+### Terminating Instances
+
+After your tests complete, terminate the instance to avoid unnecessary costs:
+
+```bash
+# Terminate the instance
+aws ec2 terminate-instances --instance-ids $INSTANCE_ID --region $AWS_REGION
+```
+
+You can also terminate instances manually through the AWS console by searching for instances tagged with `Name=TestDriverRunner`.
+
+## Step 3: GitHub Actions Integration
+
+This step shows you how to automate the entire test lifecycle in CI/CD.
+
+### Example Workflow
+
+Our [`.github/workflows/self-hosted.yml`](https://github.com/testdriverai/cli/tree/main/.github/workflows/self-hosted.yml) demonstrates the complete workflow: spawning an EC2 instance, running your tests, and shutting down the instance automatically to minimize costs.
+
+The workflow uses the GitHub secrets you configure (see below) to authenticate with AWS and spawn instances on-demand:
+
+```yaml
+name: TestDriver Self-Hosted
+
+on:
+  workflow_dispatch:
+  push:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup AWS Instance
+        id: aws-setup
+        run: |
+          OUTPUT=$(./setup/aws/spawn-runner.sh | tee /dev/stderr)
+          PUBLIC_IP=$(echo "$OUTPUT" | grep "PUBLIC_IP=" | cut -d'=' -f2)
+          INSTANCE_ID=$(echo "$OUTPUT" | grep "INSTANCE_ID=" | cut -d'=' -f2)
+          echo "public-ip=$PUBLIC_IP" >> $GITHUB_OUTPUT
+          echo "instance-id=$INSTANCE_ID" >> $GITHUB_OUTPUT
+        env:
+          AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          AWS_REGION: ${{ secrets.AWS_REGION }}
+          AWS_LAUNCH_TEMPLATE_ID: ${{ secrets.AWS_LAUNCH_TEMPLATE_ID }}
+          AMI_ID: ${{ secrets.AMI_ID }}
+
+      - name: Run TestDriver
+        run: |
+          npx testdriverai run your-test.yaml \
+            --ip="${{ steps.aws-setup.outputs.public-ip }}"
+        env:
+          TD_API_KEY: ${{ secrets.TD_API_KEY }}
+
+      - name: Shutdown AWS Instance
+        if: always()
+        run: |
+          aws ec2 terminate-instances \
+            --region ${{ secrets.AWS_REGION }}
+            --instance-ids ${{ steps.aws-setup.outputs.instance-id }}
+        env:
+          AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
+		  AWS_REGION: ${{ secrets.AWS_REGION }}
+          AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+```
+
+### Required Secrets
+
+Configure these secrets in your GitHub repository:
+
+| Secret                   | Description                         | Example                                                      |
+| ------------------------ | ----------------------------------- | ------------------------------------------------------------ |
+| `AWS_ACCESS_KEY_ID`      | AWS access key                      | `AKIAIOSFODNN7EXAMPLE`                                       |
+| `AWS_REGION`             | AWS Region                          | `us-east-2`                                                  |
+| `AWS_SECRET_ACCESS_KEY`  | AWS secret key                      | `wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY`                   |
+| `AWS_LAUNCH_TEMPLATE_ID` | Launch template from CloudFormation | `lt-07c53ce8349b958d1`                                       |
+| `AMI_ID`                 | TestDriver AMI ID                   | `ami-085f872ca0cd80fed`                                      |
+| `TD_API_KEY`             | TestDriver API key                  | Your API key from [the dashboard](https://app.testdriver.ai) |
+
+## AMI Customization
+
+### Using the Base AMI
+
+Our TestDriver Golden Image (AMI) comes pre-configured with everything you need to run tests:
+
+**Operating System & Environment:**
+
+- Windows Server with desktop environment
+- VNC + web server for remote desktop access through the browser
+
+**Development Tools:**
+
+- Python (with pip)
+- Node.js (with npm)
+- Git
+
+**Test Infrastructure:**
+
+- TestDriver agent and dependencies
+- Optimized settings for test execution
+- Pre-configured networking for TestDriver CLI communication
+
+### Modifying the AMI
+
+<Danger>
+  **Change Default Password First**: The TestDriver AMI includes a default password for initial access. You MUST change this password before saving a new AMI. Never use the default password in production environments.
+</Danger>
+
+You can customize the AMI for your specific needs. Follow these steps carefully:
+
+#### Step 1: Initial Access
+
+Connect to your instance via RDP using the default credentials:
+
+- **Username**: `testdriver`
+- **Default Password**: `changemeABC123`
+
+#### Step 2: Change the Password
+
+Before doing anything else, change the default password:
+
+1. Open PowerShell on the instance
+2. Run the password rotation script:
+   ```powershell
+   C:\testdriver\RotateLocalPasswords.ps1
+   ```
+3. **Save the new password securely** - you'll need it for all future access to this instance
+
+<Note>
+  The password rotation script will generate a secure password for the `testdriver` account. Make sure to save this password in a secure location (password manager, secrets vault, etc.) before proceeding.
+</Note>
+
+#### Step 3: Make Your Customizations
+
+Now that you've secured the instance with a new password:
+
+1. **Make your changes** using the `testdriver` account with your new password
+2. Install additional software as needed
+3. Configure settings specific to your environment
+
+<Tip>
+  **Need to make further customizations or debug issues?** RDP back into the instance using the `testdriver` account with the new password you set in Step 2. This gives you full desktop access to install software, modify configurations, or troubleshoot problems before saving your custom AMI.
+</Tip>
+
+#### Step 4: Save Your Custom AMI
+
+1. **Create a new AMI** from your modified instance using the AWS console or CLI
+2. **Update your workflow** to use the new AMI ID
+
+### Amazon Image Builder
+
+For automated AMI builds, use [Amazon EC2 Image Builder](https://aws.amazon.com/image-builder/):
+
+```yaml
+# Example Image Builder pipeline
+Components:
+  - Name: testdriver-base
+    Version: 1.0.0
+    Platform: Windows
+    Type: BUILD
+    Data: |
+      name: TestDriver Custom Setup
+      description: Custom TestDriver AMI with additional software
+      schemaVersion: 1.0
+      phases:
+        - name: build
+          steps:
+            - name: InstallSoftware
+              action: ExecutePowerShell
+              inputs:
+                commands:
+                  - "# Your custom installation commands here"
+```
+
+## Security Considerations
+
+### Network Security
+
+1. **Restrict CIDR blocks**: Only allow access from your known IP ranges
+2. **Use VPC endpoints**: For private communication with AWS services
+3. **Enable VPC Flow Logs**: For network monitoring and debugging
+
+### AWS Authentication
+
+Use [OIDC for GitHub Actions](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect) instead of long-term credentials:
+
+```yaml
+permissions:
+  id-token: write
+  contents: read
+
+steps:
+  - name: Configure AWS credentials
+    uses: aws-actions/configure-aws-credentials@v4
+    with:
+      role-to-assume: arn:aws:iam::123456789012:role/GitHubActionsRole
+      aws-region: us-east-2
+```
+
+### Instance Security
+
+- **Terminate instances** immediately after use
+- **Monitor costs** with AWS billing alerts
+- **Use least-privilege IAM roles** for instance profiles
+- **Enable CloudTrail** for audit logging
+
+## Troubleshooting
+
+### Common Issues
+
+**Instance not responding in TestDriver CLI:**
+
+When the CLI displays connection errors or timeouts, check:
+
+- **Security group rules**: The CloudFormation template configures all necessary ports (RDP 3389, VNC 5900, and TestDriver communication ports). Verify your security group hasn't been modified.
+- **Instance status checks**: Ensure the instance has passed both system and instance status checks in the AWS console.
+- **AMI compatibility**: Verify the AMI is compatible with your selected instance type (some instance types don't support certain AMIs).
+
+**Connection timeouts:**
+
+- Verify network connectivity from runner to instance
+- Check VPC routing and internet gateway configuration
+- Confirm instance is in correct subnet
+
+**AWS CLI errors:**
+
+- Validate AWS credentials and permissions
+- Check AWS service quotas and limits
+- Verify region consistency across all resources
+
+### Getting Help
+
+For enterprise customers:
+
+- Contact your account manager for AMI access issues
+- Use support channels for infrastructure questions
+- Check the TestDriver documentation for CLI usage

package/docs/{guide → v6/guide}/dashcam.mdx

@@ -83,7 +83,7 @@ Now in the same `lifecycle/prerun.yaml` script, we set up Dashcam to track web l
     lang: pwsh
     code: |
         dashcam track --name="Web Logs" --type="web" --pattern="*"
-        dashcam track --name=TestDriver --type=application --pattern="C:\Users\testdriver\Documents\testdriver.log"
+        dashcam track --name=TestDriver --type=app --pattern="C:\Users\testdriver\Documents\testdriver.log"
 ```
 
 ### Starting Dashcam

package/docs/{guide → v6/guide}/environment-variables.mdx

@@ -11,11 +11,10 @@ import GitignoreWarning from "/snippets/gitignore-warning.mdx";
 The supported environment variables in TestDriver are:
 
 <div className="env-vars-table">
-  | Variable | Type | Description |
-  |:---------------:|:---------:|---------------------------------------------------------------------------------|
-  | TD_ANALYTICS | boolean | Send analytics to TestDriver servers. This helps
-  provide feedback to inform our roadmap. | | TD_API_KEY | string | Set this to
-  spawn VMs with TestDriver Pro. |
+  | Variable        | Type         | Description |
+  |:---------------:|:------------:|:-------------------------------------------------------------------------------:|
+  | `TD_ANALYTICS`  | `boolean`    | Send analytics to TestDriver servers. This helps provide feedback to inform our roadmap. | 
+  | `TD_API_KEY`    | `string`     | Set this to spawn VMs with TestDriver Pro. |
 </div>
 <GitignoreWarning />
 ## Example

package/docs/{guide → v6/guide}/lifecycle.mdx

@@ -88,7 +88,7 @@ steps:
     commands:
       - command: exec
         lang: pwsh
-        code: dashcam track --name=TestDriver --type=application --pattern="C:\Users\testdriver\Documents\testdriver.log"
+        code: dashcam track --name=TestDriver --type=app --pattern="C:\Users\testdriver\Documents\testdriver.log"
       - command: exec
         lang: pwsh
         code: dashcam start