Skip to main content
Version: 1.0.4

Quick Start Guide

Get started with AutoRunner by creating a project, writing a BDD scenario, and executing your first test run.

What You Will Learn​

This guide walks you through the complete workflow — from creating an automation project to viewing test results. You will have a working test suite running in under 10 minutes.

Prerequisites​

Before starting, ensure you have:

  • An active RabbitQA account with AutoRunner module access
  • At least one project created in Platform
  • A test framework installed in your environment (e.g., Gauge, Cucumber)

Step 1: Create an Automation Project​

  1. Navigate to AutoRunner from the main sidebar.
  2. Click the Projects tab in the top navigation.
  3. Click the Create Project button in the upper-right corner.
  4. Enter a project name, select a framework (e.g., Gauge, Cucumber), choose a project type (Web, Desktop, Mobile, Service), and optionally add a description.
  5. Click Create to save the project.

Create Project

For detailed project configuration including repository integration, team access, and health KPIs, see Projects.

Framework Selection

Choose the framework that matches your existing test codebase. If you are starting fresh, Gauge and Cucumber offer the best BDD experience with AutoRunner's built-in editor.

Step 2: Create a Test Suite​

  1. Open your newly created project by clicking its card.
  2. Click the Suites tab.
  3. Click Create Suite to open the suite configuration panel.
  4. Configure the suite name, driver (Chrome, Firefox, Edge, etc.), environment, and optional tags.
  5. Click Save to create the suite.

Create Suite

Step 3: Write a BDD Scenario​

  1. Inside your suite, click the Scenarios tab.
  2. Click New Scenario to open the BDD editor.
  3. Write your first Gherkin scenario in the Monaco editor:
Feature: User Login

  Scenario: Successful login with valid credentials
    Given I navigate to the login page
    When I enter username "[email protected]"
    And I enter password "SecurePass123"
    And I click the "Sign In" button
    Then I should see the dashboard page
    And the welcome message should display "Hello, Test User"
  1. Click Save to store the scenario.

For advanced scenario authoring techniques, tags, and the AI-assisted scenario generator, see BDD Scenarios.

Step 4: Run the Test​

  1. Return to the suite detail page.
  2. Click the Run button in the toolbar.
  3. Verify the driver, environment, and parallel execution settings in the confirmation dialog.
  4. Click Start Run to begin execution.

Start Run

The run status will progress through: PENDING > QUEUED > RUNNING > COMPLETED / FAILED / STOPPED / TIMEOUT.

For detailed run configuration including retries, live monitoring, and parallel execution, see Test Runner.

Step 5: View Results​

  1. Once the run completes, click on the run entry in the Runs tab.
  2. The run detail page displays pass/fail summary, step-by-step results, logs, screenshots, and performance metrics.
  3. Click on any failed step to see the error message and stack trace.

Run Results

Quick Run

Use the Quick Run dropdown in the Dashboard to start a run directly from the main page without navigating to the suite first.

Troubleshooting​

Run stuck in PENDING status​

  • Verify that the test engine containers are running
  • Check the engine configuration in project settings
  • Ensure the selected driver is available and properly configured

Run fails immediately with FAILED status​

  • Open the run logs to check for framework-specific errors
  • Verify that your step definitions match the Gherkin steps
  • Ensure environment variables and connection strings are correct

Scenarios not appearing in the suite​

  • Confirm that scenarios are saved (not just drafted)
  • Check that the scenario tags match the suite filter criteria
  • Refresh the page to reload the scenario list

Next Steps​