testdriverai 6.1.10 → 6.2.0

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

@@ -1,370 +0,0 @@
----
-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)\
-  [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` 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
-
-You can customize the AMI for your specific needs:
-
-1. **Launch an instance** from our base AMI
-2. **Make your changes** (install software, configure settings)
-3. **Create a new AMI** from your modified instance
-4. **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/dashcam.mdx

@@ -1,118 +0,0 @@
----
-title: "Dashcam Replays"
-sidebarTitle: "Dashcam"
-description: "Learn how to use Dashcam to record and replay test sessions in TestDriver."
-icon: "video"
----
-
-[Dashcam](https://www.dashcam.io), from the makers of TestDriver, is a powerful feature in TestDriver that allows you to record and replay your test sessions. This is particularly useful for debugging, sharing test runs with team members, or reviewing the steps taken during a test. For the full docs see the [Dashcam docs](https://docs.dashcam.io/dashcam/).
-
-## Recording a Test Session
-
-To record a test session, you can use the `dashcam` command in your lifecycle scripts. There are two main lifecycle scripts where you can integrate Dashcam: `lifecycle/prerun.yaml` and `lifecycle/postrun.yaml`.
-
-## Ways to use Dashcam
-
-Dashcam comes as a standalone app and a Chrome extension. You can use either or both to capture your test sessions.
-
-<Info>
-  To capture web logs, make sure to install the Dashcam Chrome extension on the
-  browser you are testing with. We recommend installing it via CLI to Chrome for
-  Testing. You can also find the extension [in the Chrome
-  Webstore](https://chromewebstore.google.com/detail/dashcam/dkcoeknmlfnfimigfagbcjgpokhdcbbp)
-</Info>
-
-### Installing the Dashcam Chrome extension via command line in prerun.yaml
-
-In this lifecycle script, we install Chrome for Testing with a user profile that has the password manager disabled and sets up TestDriver Dashcam for replays and logs.
-
-```yaml lifecycle/prerun.yaml [expandable]
-- prompt: launch chrome for testing and setup dashcam
-    commands:
-      # this script installs chrome for testing with a userprofile that has password manager disabled and sets up TestDriver Dashcam for replays and logs
-      - command: exec
-        lang: pwsh
-        code: |
-          cd $env:TEMP
-          Write-Host "Changed directory to TEMP: $env:TEMP"
-
-          Write-Host "Running 'npm init -y'..."
-          npm init -y
-
-          Write-Host "Installing dependencies: @puppeteer/browsers and dashcam-chrome..."
-          npm install @puppeteer/browsers dashcam-chrome
-
-          Write-Host "Installing Chromium via '@puppeteer/browsers'..."
-          npx @puppeteer/browsers install chrome
-
-          # Define paths
-          $extensionPath = Join-Path (Get-Location) "node_modules/dashcam-chrome/build"
-          $profilePath = Join-Path $env:TEMP "chrome-profile-$(Get-Random)"
-
-          Write-Host "Extension path: $extensionPath"
-          Write-Host "Chrome user data dir: $profilePath"
-
-          # Validate extension path
-          if (-not (Test-Path $extensionPath)) {
-              Write-Host "Extension not found at $extensionPath"
-          }
-
-          $chromeArgs = @(
-            "--start-maximized",
-            "--load-extension=$extensionPath",
-            "--user-data-dir=$profilePath",
-            "--no-first-run",
-            "--no-default-browser-check",
-            "--disable-infobars"
-            "${TD_WEBSITE}"
-          ) -join ' '
-
-          Start-Process "cmd.exe" -ArgumentList "/c", "npx @puppeteer/browsers launch chrome -- $chromeArgs"
-
-          Write-Host "Script complete."
-          exit 0
-```
-
-### Using the Chrome extension and capturing web logs
-
-Now in the same `lifecycle/prerun.yaml` script, we set up Dashcam to track web logs and application logs. You can customize the patterns to match your needs. Testing Desktop? You can skip the web logs and just track application logs.
-
-```yaml lifecycle/prerun.yaml
-...
-- command: exec
-    lang: pwsh
-    code: |
-        dashcam track --name="Web Logs" --type="web" --pattern="*"
-        dashcam track --name=TestDriver --type=application --pattern="C:\Users\testdriver\Documents\testdriver.log"
-```
-
-### Starting Dashcam
-
-The final step in our `lifecycle/prerun.yaml` script is to start Dashcam recording.
-
-```yaml lifecycle/prerun.yaml
-...
-- command: exec
-    lang: pwsh
-    code: dashcam start
-```
-
-### Publishing replays to a project in your account
-
-Lastly, in the `lifecycle/postrun.yaml` script, we publish the recorded Dashcam session to a project in your Dashcam account. Make sure to replace `<YOUR_PROJECT_ID>` with the actual ID of your project.
-
-```yaml lifecycle/postrun.yaml
-- prompt: send dashcam recording to server
-    # this script tells TestDriver Dashcam to send the recording to the server
-  commands:
-    - command: exec
-        lang: pwsh
-        code: dashcam -t '${TD_THIS_FILE}' -p -k <YOUR_PROJECT_ID> # optional add `-k MYFOLDERID` for the id of a folder in your Projects page at app.testdriver.ai
-```
-
-<Info>
-  `${TD_THIS_FILE}` is an environment variable set by TestDriver that contains
-  the name of the current test file being executed. This will be used as the
-  title of the Dashcam recording. For more info see [parallel testing
-  docs](/features/parallel-testing).
-</Info>

package/interfaces/cli/commands/generate.js

@@ -1,3 +0,0 @@
-const { createOclifCommand } = require("../utils/factory.js");
-
-module.exports = createOclifCommand("generate");