Raider Desktop

Website · Report Bug · Request Feature

For more information and updates on releases, see https://ruby-raider.com

You can download the latest release of the app here.

Warning

Raider Desktop is currently available for macOS only. Windows and Linux versions are planned for future releases.

Raider Desktop is the UI desktop companion for Ruby Raider, designed to simplify and accelerate your automation workflow. It provides recording, editing, and the ability to manage your ruby raider projects, in order to make test automation easier and more efficient.

Table of Contents

• For Users
  • Prerequisites
  • Core Features
    • Creating a New Ruby Raider Project
    • The Recorder Page
    • The Dashboard Page
    • The Settings Page
    • Common Errors
• For Developers
  • Getting Started
  • Installation (for Development)
  • Running the Application
• Building the Application

For Users

This section provides information for users of the Raider Desktop application.

Prerequisites

For the application to work correctly, you must have rbenv installed with a Ruby version higher than 3.0.0. If you do not meet these requirements, you will see a modal on the app, and not all functionality will be available.

Core Features

Creating a New Ruby Raider Project

1. From the landing page, click on "Create New Project".
2. On the "New Project" screen, provide a Project Name.
3. Select your desired Automation Framework (e.g., Selenium, Appium) and Test Framework (e.g., Rspec, Cucumber).
4. If you select Appium, you will also need to specify the Mobile Platform (Android or iOS).
5. Click "Create Project" and select a directory where the project will be saved.
6. The application will generate a complete Ruby Raider project structure for you.

Opening an Existing Project

1. From the landing page, click on "Open Existing Project".
2. Use the file dialog to navigate to and select the root folder of your existing Ruby Raider project.
3. The project will be loaded into the application, and you can view its file structure on the Overview page.

The Recorder Page

The Recorder is the heart of Raider Desktop, allowing you to record user interactions and automatically generate test scripts.

• Test Suites Panel: On the left, you can create, delete, and manage your test suites. Each suite can contain multiple tests.
• Recording Controls: At the top of the screen, you can set the initial URL for your test, start/stop the recording, and run tests.
• Recorded Steps: The central panel displays the steps of your test as they are recorded. You can toggle between a human-readable "Friendly View" and the actual "Code View".
• Running Tests: You can run a single test or an entire suite. The output of the test run will be displayed in the "Test Output" panel.
• Import/Export: You can import and export individual tests, entire suites, or the whole project for easy sharing and backup.

The Dashboard Page

The Dashboard provides a high-level overview of your project.

• Project Dashboard: This tab displays key statistics about your project, such as the number of test suites and tests.
• Recording Dashboard: This tab shows information related to your recording sessions and test runs.

The Settings Page

The Settings page allows you to configure various aspects of the application and your projects.

• General Settings: Configure application-wide settings, such as the display language.
• Project Settings:
  • For web projects, you can set the default browser and the base URL for your tests.
  • For mobile projects (Appium), you can configure mobile capabilities such as platform version, device name, and app path.
• Recording Settings:
  • Waits: Adjust implicit and explicit wait times to control how the recorder waits for elements to appear on the page.
  • Selector Priorities: Define the order of attributes the recorder should prioritize when generating selectors for elements (e.g., id, name, data-testid, css). You can add, remove, and reorder the priorities.

Common Errors

"rbenv not found"

This error indicates that rbenv is not installed or not properly configured in your shell. rbenv is a tool that helps you manage multiple Ruby versions.

Installation:

• macOS (using Homebrew):

  brew install rbenv

• Other platforms: Please refer to the official rbenv installation guide.

After installation, make sure to initialize rbenv in your shell by running:

rbenv init

Follow the instructions provided by the command to set up rbenv in your shell configuration file (e.g., .zshrc, .bash_profile).

Permission Denied

If you encounter a "Permission Denied" error when running tests or saving files, it means the application does not have the necessary write permissions for the project folder.

You can grant the required permissions by running the following command in your terminal:

sudo chown -R $(whoami) /path/to/your/project/folder

Replace /path/to/your/project/folder with the actual path to your project directory. This command changes the owner of the folder to the current user, ensuring you have full read, write, and execute permissions.

macOS: "App cannot be opened because the developer cannot be verified."

When you first open RaiderUI on macOS, you might see a warning that the application cannot be opened because it is from an unidentified developer. This is a standard security feature in macOS for applications downloaded from outside the App Store.

To resolve this, you need to grant an exception for the app:

1. Open System Settings.
2. Go to Privacy & Security.
3. Scroll down to the "Security" section.
4. You will see a message about "RaiderUI" being blocked. Click the "Open Anyway" button next to it.
5. A confirmation dialog will appear. Click "Open" to launch the application.

You will only need to do this once. After that, you can open the app normally.

For Developers

This section is for developers who want to contribute to the Raider Desktop project.

Getting Started

Follow these instructions to get the project up and running on your local machine for development and testing purposes.

Before you begin, ensure you have the following installed:

• Node.js (which includes npm)
• Ruby

Additionally, for the application to function correctly, you must have the ruby_raider gem installed:

gem install ruby_raider

Installation (for Development)

1. Clone the repository to your local machine:

   git clone https://github.com/your-username/raider_desktop.git

2. Navigate into the project directory:

   cd raider_desktop

3. Install the project dependencies using npm:

   npm install

Running the Application

To start the application in development mode, run the following command. This will launch the Electron app.

npm run dev

Building the Application

To build the application for your specific operating system, use one of the following commands:

# For Windows
npm run build:win

# For macOS
npm run build:mac

# For Linux
npm run build:linux