RegresBot 🤖

AI-Powered Regression Test Generator & Embedded Browser Crawler

RegresBot is a powerful VS Code extension designed to streamline your regression testing workflow. It combines the power of AI with an embedded browser to help you explore, record, and generate high-quality Playwright tests directly within your development environment.

🚀 Key Features

• AI-Powered Exploration: Automatically discover and map user journeys on your web application.
• Embedded Browser: Run and record tests without leaving VS Code.
• Smart Test Generation: Generate robust Playwright scripts based on natural language or recorded interactions.
• Regression Management: Easily track and run regression suites to ensure stability.

🛠 Tech Stack

• Frontend: Vue.js 3 (SFCs, Vite)
• Backend: Python 3.10+ with FastAPI & Uvicorn
• Browser Automation: Playwright
• AI Engine: Integrates with leading LLMs for test logic generation.
• Extension: TypeScript-based VS Code Extension API.

📦 Getting Started

Prerequisites

• Python 3.10 or higher: Ensure Python is installed and added to your PATH.
• Node.js: Required if you plan to build the extension from source.

Installation

1. Open VS Code.
2. Install the RegresBot extension from the Marketplace.
3. Once installed, you will see a RegresBot icon in the Activity Bar (sidebar).

First-Time Setup

1. Click on the RegresBot icon in the sidebar.
2. The extension will check for a Python virtual environment.
3. If not found, a notification will appear. Click Initialize Python Environment.
4. RegresBot will automatically:
   • Create a local venv.
   • Install all necessary dependencies (fastapi, playwright, uvicorn, etc.).
   • Initialize Playwright browsers.

2. Configure API Key

RegresBot requires an OpenAI API key to generate tests:

1. Open the Command Palette (Ctrl+Shift+P).
2. Search for RegresBot: Set OpenAI API Key.
3. Enter your key.
4. Alternatively, click the Set API Key link in the "RegresBot: API Key missing" warning notification.

🖱 How to Use

1. Start the Backend

The backend starts automatically when you open the RegresBot view. If it fails to connect, use the command: RegresBot: Restart AI Backend

2. Explore & Record

Use the embedded chat interface to give instructions to the AI. You can ask it to "Explore the login page" or "Generate a test for the checkout flow".

3. Generate Tests

RegresBot will generate Playwright tests which you can review and save directly into your workspace.

🔧 Troubleshooting

• Environment Setup Failed: Ensure you have Python installed and permissions to create folders in the extension directory.
• Backend Connection Error:
  • Check the Output tab in VS Code and select RegresBot from the dropdown to see detailed logs.
  • Ensure port 8000 is not being used by another application.
  • Run RegresBot: Initialize Python Environment again if dependencies are missing.

🤝 Contributing

Open source contribtions will be available soon.

Developed with ❤️ by the RegresBot Team