Ruby Raider

Projects

A project is a folder that holds your tests, the pages they use, and their settings. Raider Desktop creates it with Ruby Raider, so the same folder also works from the command line and in CI.

The welcome screen offers three ways in: Create, Open and Quick record.

Create a project

  1. On the welcome screen, click Create, or press ⌘⇧N (Ctrl+Shift+N) from anywhere in the app.
  2. Enter a Project name. Use letters, numbers, underscores and hyphens, with no spaces, for example my_project. This becomes the folder name.
  3. Choose a CI provider: GitHub Actions or Azure Pipelines. The project gets a ready-made pipeline file for it.
  4. Pick any Add-ons:
    • Accessibility testing (axe) adds an accessibility check to your tests.
    • Include example tests adds sample pages and tests you can run straight away. Turn it off for an empty project.
  5. Click Create and choose the folder to save the project in.

When it is done, the project opens on its Tests tab.

Every project is a website project that uses Selenium and RSpec, so you can record into it straight away. Tests are Ruby files.

Create needs ruby_raider 4.0.0 or later on your computer. If it is missing or older, the page says "Raider needs Ruby Raider 4.0 or later installed." Run gem install ruby_raider in a terminal, then come back to the page.

Open a project

  1. On the welcome screen, click Open, or press ⌘O (Ctrl+O).
  2. Choose the project folder.

Any Ruby Raider web project works, whether you made it in the app or with the raider new command. Mobile (Appium) projects are not supported in this version of Raider Desktop: opening one shows "Mobile projects are not supported" and a button to open another project.

Projects on an older ruby_raider

Raider records and runs tests only in projects on ruby_raider 4.0 or later. When a project uses an older one, the Tests tab says "This project needs ruby_raider 4.0".

  1. Click Update ruby_raider.
  2. Confirm. Raider changes the ruby_raider line in the project's Gemfile to '~> 4.0' and runs bundle update ruby_raider in the project.
  3. The project reloads. Tests you recorded with Raider are rewritten to the new locators and assertions. Specs you edited by hand are left alone, and page objects and helpers you wrote may need changes of their own; see Writing tests.

If the update cannot finish, the message says so. When the Gemfile already pins ~> 4.0, run bundle update ruby_raider in the project yourself to finish.

Quick record

Quick record records a website as a test without creating a project first. Raider keeps it in a project in its own folder, which you can save somewhere else later.

  1. On the welcome screen, click Quick record.
  2. Enter the Website address the recording starts on.
  3. Enter a Test name.
  4. Click Start. The page opens and recording begins.

While you work in a quick recording, a banner says "This project lives in Raider's own folder." To keep it with your other work, click Save project to… in that banner and choose a folder. Stop recording first: the button waits until the test is saved or discarded.

Your quick recordings are listed under Quick recordings on the welcome screen. Click one to keep going.

Where project files live

Where new pages, specs and helpers go inside the project is set under Paths on the Scaffolding tab; see Scaffolding.