@testdriverai/agent 7.8.0-test.38

package/docs/v6/scenarios/spell-check.mdx

@@ -0,0 +1,22 @@
+---
+title: "Spell Check"
+sidebarTitle: "Spell Check"
+description: "Test spell check functionality with TestDriver"
+icon: "spell-check"
+---
+
+import TestPrereqs from "/snippets/test-prereqs.mdx";
+
+# Testing Spell Check with TestDriver
+
+This scenario demonstrates how to automate testing the spell check functionality of a web application using TestDriver's capabilities. The test will check if the spell checker correctly identifies and suggests corrections for misspelled words in a text input field.
+
+<TestPrereqs />
+
+## Scenario overview
+
+1. Open up a webpage that has text input and a spell check function.
+2. Enter a misspelled word into the text input field.
+3. Trigger the spell check function (for example, by clicking a button or losing focus on the input field).
+4. Verify that the spell checker identifies the misspelled word and provides suggestions for correction.
+5. Optionally, select a suggestion and apply it to the text input field.

package/docs/v6/security/action.mdx

@@ -0,0 +1,84 @@
+---
+title: "Security Features of the TestDriver Action"
+sidebarTitle: "GitHub Action"
+description: "Understand the ephemeral VM runners, secrets handling, and environment-specific security for the TestDriver Action."
+icon: shield-check
+---
+
+import GitignoreWarning from "/snippets/gitignore-warning.mdx";
+
+## Open source
+
+TestDriver CLI is open source, and its source code is available for review. You can find the repository here:
+
+<Card horizontal="true" icon="github">
+  {" "}
+  [GitHub - testdriverai/cli](https://github.com/testdriverai/cli){" "}
+</Card>
+
+## Ephemeral virtual machine runners
+
+TestDriver tests are executed on private virtual machines (VMs) managed by Amazon EC2. These VMs are ephemeral, meaning they only exist for the duration of the test execution. Once the test is complete:
+
+- The VM is destroyed.
+- The hard disk is wiped to ensure no residual data remains.
+
+## Secrets
+
+To securely manage private information, we recommend storing sensitive data as secrets in your GitHub repository. Learn more about [storing secrets in GitHub](https://docs.github.com/en/actions/security-guides/encrypted-secrets).
+
+### Handling secrets
+
+- **Prerun Scripts**: Any secrets supplied within prerun scripts or prompts are transmitted over SSL to the TestDriver API. Prerun scripts are **not persisted**.
+- **Agent Prompts**: Secrets supplied to agent prompts are persisted (see [Agent Security](/security/agent)).
+- **Secure Workflows**: If your workflow requires secret sharing and you encounter issues, please contact us for assistance.
+
+### Common use case
+
+A common workflow involves using prerun scripts to securely access a private staging website via basic authentication. This allows you to log into staging environments without persisting sensitive data on TestDriver servers.
+
+## Environment-specific security
+
+<GitignoreeWarning />
+
+### Production
+
+Testing production environments is the simplest and most secure starting point.
+
+- Production testing doesn't require any private information from your team.
+- Simply provide the tests to TestDriver and point them toward publicly available endpoints.
+- TestDriver doesn't need access to any private or sensitive information for production testing.
+
+### Staging
+
+Testing staging environments may require secure information, such as credentials or tokens.
+
+- Use GitHub secrets to securely store and manage this information.
+- Refer to the **Secrets** section above for guidance on securely implementing tests for staging environments.
+
+### Development
+
+TestDriver can clone feature branches and build code on its virtual machines using workflows similar to GitHub Actions.
+
+#### GitHub token for development
+
+To test development branches of private codebases, you must supply a GitHub personal access token within the GitHub Action. This token is used to:
+
+- Clone the codebase onto the VM.
+- Build and test the code in an isolated environment.
+
+Example configuration:
+
+```yaml
+env:
+  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+```
+
+- The token is transmitted over SSL and is **not persisted**.
+- Learn more about managing the privacy of GitHub access tokens [here](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).
+
+## Notes
+
+- TestDriver's ephemeral VMs ensure that no data persists beyond the test execution.
+- For maximum security, always use GitHub secrets to manage sensitive information.
+- If you have specific security concerns or requirements, feel free to contact us for support.

package/docs/v6/security/agent.mdx

@@ -0,0 +1,73 @@
+---
+title: "Security Features of the TestDriver Agent"
+sidebarTitle: "TestDriver Agent "
+description: "Explore the data collected, persistence, and privacy practices of the TestDriver Agent."
+icon: lock-keyhole
+---
+
+## Source
+
+The TestDriver Agent is open-source and available on NPM. You can browse the source code to see all the data collected and understand how everything works.
+
+## API
+
+The TestDriver Agent doesn't contain any AI models within it. Instead, it uploads desktop context to the TestDriver API, which uses that context to make decisions about what actions to perform.
+
+The TestDriver API leverages OpenAI models behind the scenes. For more information about OpenAI and its privacy practices, visit their [privacy center](https://openai.com/privacy).
+
+## Desktop context collected
+
+During execution, the TestDriver Agent uploads the following information to the API:
+
+- **User Input Prompts**: The commands and prompts you provide to TestDriver.
+- **Active Window and Other Windows**: Information about the active window and other open windows, including application and window titles.
+- **System Information**: Details about the computer system running TestDriver.
+- **Mouse Position**: The current position of the mouse pointer.
+- **Desktop Screenshots**: Screenshots of the primary display.
+
+### Data persistence
+
+- **Desktop Context**: All collected desktop context, except for screenshots, is persisted in the TestDriver database.
+- **Desktop Screenshots**: Screenshots are uploaded to the server for processing but aren't stored in the database.
+
+### Desktop screenshots
+
+TestDriver frequently captures screenshots of the desktop to provide the AI with decision-making context. These screenshots are uploaded to the API but aren't persisted in the database.
+
+- **Primary Display Only**: Screenshots are limited to the primary display.
+- **Privacy Recommendation**: For complete privacy, it's recommended to run TestDriver within a virtual machine on your desktop.
+
+**Important**: TestDriver can't operate without visual context. don't install TestDriver if you are uncomfortable with capturing images of the desktop.
+
+## Collected data details
+
+### Active window
+
+Information about the open windows on the desktop is reported using the `active-window` module. This includes details such as the application name and window titles.
+
+### System information
+
+System details, such as operating system, CPU, and memory, are reported using the `systeminformation` module.
+
+### User prompts
+
+The prompts you input into TestDriver are uploaded to the API and stored in a database. This data is used to provide the AI with a history of context for better decision-making.
+
+## Additional analytics
+
+When running `testdriver init`, you will be asked if you would like to share additional analytics. Sharing usage analytics is **opt-in**, and no extra data will be collected unless explicitly enabled.
+
+To disable additional analytics, set the `TD_ANALYTICS` environment variable to `false`:
+
+```bash
+TD_ANALYTICS=false
+```
+
+## Rate limiting and restrictions
+
+While the TestDriver Agent is free to use, TestDriver reserves the right to rate limit or restrict usage by IP address for any reason.
+
+## Notes
+
+- The TestDriver Agent is essential for providing the AI with the necessary context to operate effectively.
+- For privacy-conscious users, running TestDriver in a virtual machine is recommended to limit exposure of sensitive desktop information.

package/docs/v6/security/platform.mdx

@@ -0,0 +1,77 @@
+---
+title: "Security Features of the Dashboard"
+sidebarTitle: "TestDriver Platform"
+description: "Learn about the security features of the TestDriver web dashboard, including SSL, OAuth, RBAC, and more."
+icon: layer-group
+---
+
+import GitignoreWarning from "/snippets/gitignore-warning.mdx";
+
+## Overview
+
+The TestDriver web dashboard provides a secure interface for managing and reviewing your tests. Tests executed via the GitHub Action are recorded and reported through Dashcam, another application developed by TestDriver. For more details, refer to the [Dashcam documentation](https://dashcam.docs.testdriver.ai).
+
+Dashcam and TestDriver share the same API and web application back end, which includes robust privacy and security features.
+
+## Security features
+
+### SSL
+
+- All data transmitted between your browser and the TestDriver web application is encrypted using HTTPS.
+
+### Authentication
+
+- Users can only authenticate via OAuth, provided by Auth0, ensuring secure and reliable user authentication.
+
+### Team management
+
+- Administrators can add or remove individual team members.
+- Only administrators have the ability to manage team settings.
+- Everyone in the team gets their own API key
+- The team also gets a shared API key which can be used for CI/CD workflows.
+
+### Role-based access control (RBAC)
+
+- The first user to create a team is designated as the administrator.
+- Administrators:
+  - Can manage team settings.
+  - Can't be removed from the team.
+- All other users are normal members with limited access.
+
+### API key rotation
+
+- Teams can rotate their API key for enhanced security.
+- It's recommended to rotate the API key every 90 days to minimize risk.
+- Only the administrators can rotate the shared API key.
+
+<Check>
+  For more details on **Team Management** see the [Team
+  documentation](/account/team).
+</Check>
+
+<GitignoreWarning />
+
+### Secret masking
+
+- Test replay logs and network requests are automatically scanned for sensitive information, such as:
+  - Credit card numbers
+  - Emails
+  - Passwords
+  - API keys
+- Detected secrets are masked with asterisks (`****`) to prevent exposure.
+
+### Encrypted at rest
+
+- Test replays and logs are securely stored on Amazon S3 and encrypted at rest.
+- Test results are only accessible via temporary signed URLs.
+- Signed URLs are generated exclusively for team users and expire after a set duration.
+
+## Notes
+
+- The TestDriver web dashboard is designed with privacy and security as top priorities.
+- For additional security, ensure your team rotates API keys regularly and reviews team member access permissions.
+- If you have specific security concerns or questions, please contact TestDriver support.
+
+<Tip>
+  See complete docs about the dashboard features [here](/account/dashboard)
+</Tip>

package/docs/v6/tutorials/advanced-test.mdx

@@ -0,0 +1,81 @@
+---
+title: "Tutorial: Advanced test"
+description: "Explore advanced testing techniques and features in TestDriver."
+sidebarTitle: "Advanced test"
+icon: "flask-round"
+---
+
+# Advanced test tutorial
+
+Welcome to the Advanced Test Tutorial. In this guide, we will explore advanced testing techniques and features available in TestDriver. This tutorial assumes you have a basic understanding of TestDriver and its functionalities.
+
+## Prerequisites
+
+Before starting, ensure you have completed the basic TestDriver tutorial and have the following:
+
+- TestDriver installed and configured.
+- A sample project to test.
+
+## Advanced features overview
+
+TestDriver provides several advanced features to enhance your testing capabilities:
+
+1. **Custom Assertions**: Create custom assertions to validate specific conditions.
+2. **Parameterized Tests**: Run tests with different sets of input data.
+3. **Test Hooks**: Use hooks to execute code before or after tests.
+4. **Parallel Execution**: Speed up testing by running tests in parallel.
+
+## Step-by-step guide
+
+### Step 1: Setting up custom assertions
+
+Custom assertions allow you to define specific conditions for your tests. Here's an example:
+
+```python
+def assert_custom_condition(value):
+    assert value > 0, "Value must be greater than 0"
+```
+
+### Step 2: Using parameterized tests
+
+Parameterized tests enable you to test multiple scenarios with different inputs. Example:
+
+```python
+import pytest
+
+@pytest.mark.parametrize("input,expected", [(1, True), (0, False)])
+def test_is_positive(input, expected):
+    assert (input > 0) == expected
+```
+
+### Step 3: Implementing test hooks
+
+Test hooks let you execute code before or after tests. Example:
+
+```python
+def setup_function():
+    print("Setting up test environment")
+
+def teardown_function():
+    print("Cleaning up test environment")
+```
+
+### Step 4: Running tests in parallel
+
+Parallel execution can be achieved using pytest-xdist. Install it with:
+
+```bash
+pip install pytest-xdist
+```
+
+Run tests in parallel using:
+
+```bash
+pytest -n 4
+```
+
+## Conclusion
+
+By leveraging these advanced features, you can create more robust and efficient tests for your projects. Experiment with these techniques to find the best fit for your testing needs.
+
+Happy testing!

package/docs/v6/tutorials/basic-test.mdx

@@ -0,0 +1,45 @@
+---
+title: "Tutorial: Basic Test"
+description: "Learn how to create and run a basic test using TestDriver."
+sidebarTitle: "Basic Test"
+icon: "test-tube"
+---
+
+# Basic test tutorial
+
+This tutorial will guide you through the process of creating and running a basic test using TestDriver.
+
+## Prerequisites
+
+Before you begin, ensure you have the following:
+
+- TestDriver installed on your system.
+- Basic understanding of how TestDriver works.
+
+## Step 1: Create a test
+
+To create a test, follow these steps:
+
+1. Open your code editor.
+2. Write the test script using TestDriver's syntax.
+3. Save the test script with a `.yaml` extension.
+
+Example:
+
+```yaml
+
+```
+
+## Step 2: Run the test
+
+To run the test, use the following command:
+
+```bash
+npx testdriverai@latest run example-test.yaml
+```
+
+This will execute the test and display the results in the console.
+
+## Conclusion
+
+You have successfully created and run a basic test using TestDriver. Explore more advanced features to enhance your testing capabilities.