testdriverai 7.2.43 → 7.2.45

package/.github/workflows/acceptance-windows-scheduled.yaml

@@ -12,33 +12,42 @@ on:
 
 jobs:
   test-windows:
+    uses: ./.github/workflows/windows-self-hosted.yaml
+    secrets:
+      TD_API_KEY: ${{ secrets.TD_API_KEY }}
+      TD_WEBSITE: ${{ secrets.TD_WEBSITE }}
+      AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
+      AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+
+  sentry-and-publish:
+    needs: test-windows
     runs-on: ubuntu-latest
+    if: always()
     
     steps:
-    - uses: actions/checkout@v4
-    
-    - name: Setup Node.js
-      uses: actions/setup-node@v4
-      with:
-        node-version: '20'
-        cache: 'npm'
-    
-    - name: Install dependencies
-      run: npm ci
-
     - name: Install Sentry CLI
       run: npm install -g @sentry/cli
 
-    - name: Run Windows tests with Sentry Cron monitoring
+    - name: Report to Sentry Cron
       run: |
-        sentry-cli monitors run testdriver-windows-acceptance -- npx vitest run test/testdriver/*.test.mjs
+        sentry-cli monitors run testdriver-windows-acceptance -- echo "Windows tests completed"
       env:
         SENTRY_DSN: ${{ secrets.SENTRY_DSN }}
-        TD_API_KEY: ${{ secrets.TD_API_KEY }}
-        TD_OS: windows
+
+    - name: Download test results
+      uses: actions/download-artifact@v4
+      with:
+        name: test-results-windows
 
     - name: Upload test results to Sentry Prevent
       if: ${{ !cancelled() }}
       uses: getsentry/prevent-action@v0
       with:
         token: ${{ secrets.SENTRY_PREVENT_TOKEN }}
+
+    - name: Publish Test Results
+      uses: EnricoMi/publish-unit-test-result-action@v2
+      if: always()
+      with:
+        files: test-report.junit.xml
+        check_name: Test Results (Windows Scheduled)

package/.github/workflows/acceptance.yaml

@@ -49,30 +49,32 @@ jobs:
         check_name: Test Results (Linux)
 
   test-windows:
-    runs-on: ubuntu-latest
     if: contains(github.event.pull_request.labels.*.name, 'test-windows')
+    uses: ./.github/workflows/windows-self-hosted.yaml
+    with:
+      test_pattern: 'test/testdriver/assert.test.mjs'
+    secrets:
+      TD_API_KEY: ${{ secrets.TD_API_KEY }}
+      TD_WEBSITE: ${{ secrets.TD_WEBSITE }}
+      AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
+      AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+
+  publish-windows-results:
+    needs: test-windows
+    runs-on: ubuntu-latest
+    if: always() && contains(github.event.pull_request.labels.*.name, 'test-windows')
     
     steps:
-    - uses: actions/checkout@v4
-    
-    - name: Setup Node.js
-      uses: actions/setup-node@v4
+    - name: Download test results
+      uses: actions/download-artifact@v4
       with:
-        node-version: '20'
-        cache: 'npm'
-    
-    - name: Install dependencies
-      run: npm ci
-    
-    - name: Run Windows tests
-      run: npx vitest run test/testdriver/*.test.mjs
-      env:
-        TD_API_KEY: ${{ secrets.TD_API_KEY }}
-        TD_OS: windows
+        name: test-results-windows
 
     - name: Upload test results to Sentry Prevent
       if: ${{ !cancelled() }}
       uses: getsentry/prevent-action@v0
+      with:
+        token: ${{ secrets.SENTRY_PREVENT_TOKEN }}
 
     - name: Publish Test Results
       uses: EnricoMi/publish-unit-test-result-action@v2

package/.github/workflows/windows-self-hosted.yaml

@@ -0,0 +1,68 @@
+name: Windows Self-Hosted Tests
+
+on:
+  workflow_call:
+    inputs:
+      test_pattern:
+        description: 'Test file pattern to run'
+        required: false
+        type: string
+        default: 'test/testdriver/*.test.mjs'
+    secrets:
+      TD_API_KEY:
+        required: true
+      TD_WEBSITE:
+        required: false
+      AWS_ACCESS_KEY_ID:
+        required: true
+      AWS_SECRET_ACCESS_KEY:
+        required: true
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+    
+    - name: Set up Node.js
+      uses: actions/setup-node@v4
+      with:
+        node-version: '20'
+        cache: 'npm'
+    
+    - name: Install dependencies
+      run: npm ci
+    
+    - name: Run Windows tests with self-hosted instances
+      run: npx vitest run ${{ inputs.test_pattern }}
+      env:
+        TD_API_KEY: ${{ secrets.TD_API_KEY }}
+        TD_WEBSITE: ${{ secrets.TD_WEBSITE }}
+        TD_OS: windows
+        AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
+        AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+        AWS_REGION: us-east-2
+        AWS_LAUNCH_TEMPLATE_ID: lt-0ef9bf26a945fb442
+        AMI_ID: ami-063f575bb80f1e818
+        RESOLUTION: 1920x1080
+    
+    - name: Upload test results
+      if: always()
+      uses: actions/upload-artifact@v4
+      with:
+        name: test-results-windows
+        path: test-report.junit.xml
+        retention-days: 30
+    
+    - name: Upload TestDriver AI CLI logs
+      if: always()
+      uses: actions/upload-artifact@v4
+      with:
+        name: testdriverai-cli-logs-windows
+        path: /tmp/testdriverai-cli-*.log
+        if-no-files-found: warn
+        retention-days: 30

package/docs/v7/aws-setup.mdx

@@ -5,33 +5,63 @@ description: "Deploy TestDriver on your AWS infrastructure using CloudFormation"
 icon: "aws"
 ---
 
-This guide walks you through setting up self-hosted TestDriver instances on AWS. By the end, you'll have a complete infrastructure that can spawn test environments on-demand and integrate with your CI/CD pipelines.
+This guide walks you through setting up self-hosted TestDriver instances on AWS. By the end, you'll have fully automated test infrastructure that spawns and terminates instances on-demand.
 
 ```mermaid
 graph LR
-    A[Vitest] <--> B[api.testdriver.ai]
-    B <--> C[Your AWS EC2 Instance]
+    A[Vitest Test] --> B[setup-aws hook]
+    B --> C[Spawns EC2]
+    C --> D[Runs Test]
+    D --> E[Terminates EC2]
 ```
 
+## How It Works
+
+TestDriver automatically manages AWS EC2 instances for your tests:
+
+1. **Deploy CloudFormation** — One-time infrastructure setup
+2. **Configure Vitest** — Add one line to your config
+3. **Run Tests** — Instances spawn automatically, run tests, and terminate
+
+That's it! No manual instance management needed.
+
 # Quickstart
 
-<Card 
-  title="Launch Stack" 
-  icon="aws" 
-  href="https://console.aws.amazon.com/cloudformation/home#/stacks/create/review?templateURL=https://v7-cloudformation-template.s3.us-east-2.amazonaws.com/cloudformation.yaml" 
-  horizontal 
-  arrow
->
-  Deploy TestDriver infrastructure with one click
-</Card>
+<Steps>
+  <Step title="Deploy Infrastructure">
+    <Card 
+      title="Launch CloudFormation Stack" 
+      icon="aws" 
+      href="https://console.aws.amazon.com/cloudformation/home#/stacks/create/review?templateURL=https://v7-cloudformation-template.s3.us-east-2.amazonaws.com/cloudformation.yaml" 
+      horizontal 
+      arrow
+    >
+      One-click AWS setup
+    </Card>
+  </Step>
+  
+  <Step title="Add to Vitest Config">
+    ```javascript vitest.config.mjs
+    setupFiles: ['testdriverai/vitest/setup', 'testdriverai/vitest/setup-aws']
+    ```
+  </Step>
+  
+  <Step title="Run Tests">
+    ```bash
+    TD_OS=windows AWS_REGION=us-east-2 \
+      AWS_LAUNCH_TEMPLATE_ID=lt-xxx AMI_ID=ami-xxx \
+      npx vitest run
+    ```
+  </Step>
+</Steps>
 
 ## Overview
 
-The setup process involves three main steps:
+The setup process is simple:
 
-1. **CloudFormation Infrastructure** — Deploy our template to create VPC, security groups, IAM roles, and launch templates
-2. **On-Demand Instance Spawning** — Use `spawn-runner.sh` to launch TestDriver instances when you need to run tests
-3. **CI/CD Integration** — Automate the lifecycle in GitHub Actions: spawn instance → run tests → terminate instance
+1. **Deploy CloudFormation** — Creates VPC, security groups, IAM roles, and launch templates
+2. **Configure Vitest** — Add `setup-aws` to automatically manage instance lifecycle
+3. **Run Tests** — Set `TD_OS=windows` with AWS credentials and instances spawn/terminate automatically
 
 
 ## Prerequisites
@@ -127,35 +157,39 @@ Our CloudFormation template creates all the AWS infrastructure you need:
   </Tab>
 </Tabs>
 
-## Step 2: Spawn Test Instances
-
-Use the [`spawn-runner.sh`](https://github.com/testdriverai/testdriverai/blob/main/setup/aws/spawn-runner.sh) script to launch instances on-demand. This script:
-
-- Launches a new EC2 instance using your launch template
-- Waits for the instance to be ready
-- Validates SSM connectivity
-- Returns instance details for test execution
-
-```bash
-AWS_REGION=us-east-2 AMI_ID=ami-0504bf50fad62f312 AWS_LAUNCH_TEMPLATE_ID=lt-your-template-id sh setup/aws/spawn-runner.sh
-```
-
-Output:
-```
-PUBLIC_IP=1.2.3.4
-INSTANCE_ID=i-1234567890abcdef0
-AWS_REGION=us-east-2
+## Step 2: Configure Vitest
+
+Add the AWS setup hook to your `vitest.config.mjs`:
+
+```javascript vitest.config.mjs
+import { defineConfig } from 'vitest/config';
+import { config } from 'dotenv';
+import TestDriver from 'testdriverai/vitest';
+
+config(); // Load .env file
+
+export default defineConfig({
+  test: {
+    testTimeout: 900000,
+    hookTimeout: 900000,
+    maxConcurrency: 3,
+    reporters: [
+      'default',
+      TestDriver(),
+      ['junit', { outputFile: 'test-report.junit.xml' }]
+    ],
+    setupFiles: ['testdriverai/vitest/setup', 'testdriverai/vitest/setup-aws'],
+  },
+});
 ```
 
-### Run Tests Against Your Instance
-
-Specify the instance IP using the `TD_IP` environment variable:
+<Note>
+  **That's it!** The `setup-aws` hook automatically spawns and terminates instances when `TD_OS=windows` is set. No manual instance management needed.
+</Note>
 
-```bash
-TD_API_KEY=your-api-key TD_IP=1.2.3.4 npx vitest run
-```
+## Step 3: Write Your Tests
 
-In your test file, pass the IP to TestDriver:
+Tests should use `context.ip || process.env.TD_IP` for the IP configuration:
 
 ```javascript
 import { describe, it } from "vitest";
@@ -164,7 +198,7 @@ import { TestDriver } from "testdriverai/lib/vitest/hooks.mjs";
 describe("My Test", () => {
   it("should run on self-hosted instance", async (context) => {
     const testdriver = TestDriver(context, {
-      ip: process.env.TD_IP,
+      ip: context.ip || process.env.TD_IP,
     });
 
     await testdriver.provision.chrome({ url: "https://example.com" });
@@ -173,40 +207,42 @@ describe("My Test", () => {
 });
 ```
 
-### Terminate Instances
+<Note>
+  **How it works**: When `TD_OS=windows` with AWS credentials, `context.ip` is automatically set by the setup hook. When running without AWS setup (cloud-hosted), both are undefined and TestDriver uses the cloud. When `TD_IP` is provided manually, it takes precedence.
+</Note>
 
-Always terminate instances after tests complete to avoid unnecessary costs:
+## Step 4: Run Tests
+
+### Locally
 
 ```bash
-aws ec2 terminate-instances \
-  --instance-ids i-1234567890abcdef0 \
-  --region us-east-2
+TD_OS=windows \
+AWS_REGION=us-east-2 \
+AWS_LAUNCH_TEMPLATE_ID=lt-xxx \
+AMI_ID=ami-0504bf50fad62f312 \
+npx vitest run
 ```
 
 <Note>
-  Instances are tagged with `Name=TestDriverRunner` and your `ProjectTag` for easy identification in the AWS console.
+  Each test gets its own fresh EC2 instance that's automatically terminated after completion.
 </Note>
 
-## Step 3: GitHub Actions Integration
+### In GitHub Actions
 
-Automate the full lifecycle in your CI/CD pipeline. This workflow spawns an instance, runs tests, and terminates the instance:
+Automate testing with self-hosted instances in your CI/CD pipeline. TestDriver automatically spawns a fresh instance for each test, runs the test, and terminates the instance.
 
 ```yaml .github/workflows/test.yml
-name: TestDriver Self-Hosted
+name: TestDriver Self-Hosted Windows Tests
 
 on:
   push:
     branches: [main]
   pull_request:
 
-# Prevent concurrent runs from competing for resources
-concurrency:
-  group: ${{ github.workflow }}-${{ github.ref }}
-  cancel-in-progress: true
-
 jobs:
   test:
     runs-on: ubuntu-latest
+    
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
@@ -215,43 +251,34 @@ jobs:
         uses: actions/setup-node@v4
         with:
           node-version: '20'
+          cache: 'npm'
 
       - name: Install dependencies
-        run: npm install
-
-      - 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
+        run: npm ci
+
+      - name: Run Windows tests with self-hosted instances
+        run: npx vitest run test/testdriver/*.test.mjs
         env:
+          TD_API_KEY: ${{ secrets.TD_API_KEY }}
+          TD_OS: windows
           AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
           AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
-          AWS_REGION: ${{ secrets.AWS_REGION }}
+          AWS_REGION: us-east-2
           AWS_LAUNCH_TEMPLATE_ID: ${{ secrets.AWS_LAUNCH_TEMPLATE_ID }}
           AMI_ID: ${{ secrets.AMI_ID }}
 
-      - name: Run Tests
-        run: npx vitest run
-        env:
-          TD_API_KEY: ${{ secrets.TD_API_KEY }}
-          TD_IP: ${{ steps.aws-setup.outputs.public-ip }}
-
-      - name: Shutdown AWS Instance
+      - name: Upload test results
         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_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
-          AWS_REGION: ${{ secrets.AWS_REGION }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: test-results
+          path: test-report.junit.xml
 ```
 
+<Note>
+  **Automatic Instance Management**: Setting `TD_OS=windows` with AWS credentials enables automatic instance spawning. Each test gets its own fresh instance that's terminated after the test completes.
+</Note>
+
 ### Required GitHub Secrets
 
 | Secret | Description | Example |
@@ -263,46 +290,58 @@ jobs:
 | `AMI_ID` | TestDriver AMI ID | `ami-0504bf50fad62f312` |
 | `TD_API_KEY` | Your TestDriver API key | From [console.testdriver.ai](https://console.testdriver.ai) |
 
-### Example Workflow
-
-For a complete real-world example with matrix-based test execution and dynamic test file discovery, see the [`self-hosted.yml`](https://github.com/testdriverai/testdriverai/blob/main/setup/aws/self-hosted.yml) workflow in the TestDriver repository.
-
 <Tip>
-  **Local Testing**: You can test your GitHub Actions workflow locally using [nektos/act](https://github.com/nektos/act). The `self-hosted.yml` workflow includes commented lines for installing the AWS CLI when running with `act`.
+  Add these as **GitHub Repository Secrets** under Settings → Secrets and variables → Actions
 </Tip>
 
-## Manual Instance Management
+### Example Workflows
 
-You can manage TestDriver instances manually through the AWS Console or CLI. This is useful for debugging, development, or running tests outside of CI/CD.
+For complete production examples, see:
+- **[Scheduled Tests](https://github.com/testdriverai/testdriverai/blob/main/.github/workflows/acceptance-windows-scheduled.yaml)** — Daily automated test runs
+- **[Reusable Workflow](https://github.com/testdriverai/testdriverai/blob/main/.github/workflows/windows-self-hosted.yaml)** — Shared configuration for PR and scheduled tests
 
-### Starting an Instance
+## Advanced Usage
 
-```bash
-aws ec2 run-instances \
-  --region us-east-2 \
-  --image-id ami-0504bf50fad62f312 \
-  --launch-template LaunchTemplateId=lt-your-template-id \
-  --tag-specifications 'ResourceType=instance,Tags=[{Key=Name,Value=testdriver-manual}]'
-```
+### Using an Existing Instance
 
-### Stopping an Instance
+If you already have a running instance, you can skip automatic spawning by providing `TD_IP`:
 
 ```bash
-aws ec2 stop-instances --region us-east-2 --instance-ids i-1234567890abcdef0
+TD_OS=windows TD_IP=1.2.3.4 npx vitest run
 ```
 
-### Starting a Stopped Instance
+The `setup-aws` hook will detect `TD_IP` is already set and skip spawning a new instance.
+
+### Manual Instance Management
+
+For advanced use cases, you can manually spawn instances using the [`spawn-runner.sh`](https://github.com/testdriverai/testdriverai/blob/main/setup/aws/spawn-runner.sh) script:
 
 ```bash
-aws ec2 start-instances --region us-east-2 --instance-ids i-1234567890abcdef0
+AWS_REGION=us-east-2 \
+AMI_ID=ami-0504bf50fad62f312 \
+AWS_LAUNCH_TEMPLATE_ID=lt-xxx \
+bash setup/aws/spawn-runner.sh
 ```
 
-### Terminating Instances
+Output:
+```
+PUBLIC_IP=1.2.3.4
+INSTANCE_ID=i-1234567890abcdef0
+AWS_REGION=us-east-2
+```
+
+Then manually terminate when done:
 
 ```bash
-aws ec2 terminate-instances --region us-east-2 --instance-ids i-1234567890abcdef0
+aws ec2 terminate-instances \
+  --instance-ids i-1234567890abcdef0 \
+  --region us-east-2
 ```
 
+For complete production examples, see:
+- **[Scheduled Tests](https://github.com/testdriverai/testdriverai/blob/main/.github/workflows/acceptance-windows-scheduled.yaml)** — Daily automated test runs
+- **[Reusable Workflow](https://github.com/testdriverai/testdriverai/blob/main/.github/workflows/windows-self-hosted.yaml)** — Shared configuration for PR and scheduled tests
+
 ### Connecting to an Instance
 
 You can connect to running instances via:
@@ -355,28 +394,6 @@ You can customize the AMI to include additional software or configurations:
   **Security**: Never use the default password in production. Always rotate passwords before creating custom AMIs.
 </Warning>
 
-### Changing Screen Resolution
-
-Set resolution via environment variable when spawning:
-
-```bash
-export RESOLUTION=1920x1080
-./setup/aws/spawn-runner.sh
-```
-
-Or in a lifecycle provision script:
-
-```yaml lifecycle/provision.yaml
-version: 7.0.0
-steps:
-  - prompt: set screen resolution
-    commands:
-      - command: exec
-        lang: pwsh
-        code: |
-          C:\testdriver\SetResolution.ps1 -Width 1920 -Height 1080
-```
-
 ## Security Best Practices
 
 ### Network Security
@@ -430,22 +447,3 @@ See [GitHub's OIDC documentation](https://docs.github.com/en/actions/deployment/
 - Validate credentials and permissions
 - Check service quotas and limits
 - Verify region consistency across all resources
-
-## Getting Help
-
-<CardGroup cols={2}>
-  <Card
-    title="Contact Support"
-    icon="envelope"
-    href="https://calendly.com/d/cq23-qyn-3v6/testdriver-ai-demo"
-  >
-    Get help with self-hosted setup and configuration
-  </Card>
-  <Card
-    title="Self-Hosted Overview"
-    icon="server"
-    href="/v7/self-hosted"
-  >
-    Learn more about self-hosted benefits and pricing
-  </Card>
-</CardGroup>

package/interfaces/cli/commands/init.js

@@ -199,7 +199,7 @@ export async function login(testdriver) {
 
   // Find the username field
   const usernameField = await testdriver.find(
-    'Username, label above the username input field on the login form'
+    'username input'
   );
   await usernameField.click();