VSCode Extension for TestRail

All Test Case Management (TCM) systems, including TestRail, require users to write tests directly in the TCM. This approach leads to manual QA teams being isolated from development teams who mostly live in Git.

Railflow VSCode Extension for TestRail enables users to write TestRail Tests in a rich Text Editor like experience within VSCode, version control tests using any SCM like GIT, and upload and download Tests to TestRail.

The Railflow VSCode Extension is one of our newest and most popular products and has completely transformed the Manual QA and Development team relationships.

The VSCode Extensions provides a few main TestRail workflows within the VSCode interface

Tests : Download Tests
Tests: Write and Edit tests using a Rich Text Editor
Tests: Batch upload tests from VSCode to TestRail
Version Control using GIT or any other SCM
Offline mode - Write tests locally and commit/upload as needed

Installation

Install: Install the Railflow VSCode Extension from VSCode Marketplace (opens in a new tab)

Configuration

Configure: Configure the Railflow VSCode Addon by navigating to Extenions > Railflow TestRail Extension > Extensions Settings > (Workspace Tab) . Fill out form with with TestRail URL, username, password or apikey, and Railflow license key.

Sync Project

In order to version control TestRail tests, you need to first download/sync tests using Railflow VSCode Extension. Once the extension has downloaded tests to the local folder, you can add/edit tests and then commit them to Git. This whole workflow is surprising simple

Initialize: Create an empty local folder and import into VSCode Workspace using Open Folder option

Sync Tests: Navigate to Railflow Extenion > Import TestRail Project and select the project from the dropdown. The sync may take some time and depends on the total number of tests in the project. You can see the sync activity in the VSCode Output tab.

Once the import action is complete, you should be able to see the TestRail project's test suites, section, and test within the extension's navigation tree.

ℹ️

When a project is imported, the Railflow VSCode extension creates a series of folder and files locally to represent the Project, Suite, Section, and Test entities in TestRail.

Each entity has a config.json that contains useful metadata for the entity. This metadata is used by the Railflow extension to render the UX within VSCode. You should rarely have the need to edit the config.json directly.

Tests & Sections

Once a project has been imported, you can easily add/edit new tests or sections.

The Project, Suite, and Test entities expose useful menus to navigate to TestRail, Finder, and Add new entities.

Rich Text Test Editor

Writing test cases in an exercise in effective communication. Having the ability to format and structure TestRail test description using rich text controls and not having to memorize TestRail markdown syntax creates a pleasant test development user experience for TestRail users.

Railflow VSCode Extension exposes a TestRail like UX using the latest in React UX libraries, including highly interactive markdown controls. Simply write and format your test cases, checkin to GIT and upload to TestRail

Version Control

Once the tests and sections have been created or edited, simply commit them to GIT and then upload to TestRail using the Project, Suite, and Test context menus.

Offline Test Development

While TestRail is a great TCM, using TestRail SAAS or even TestRail on-prem can run into occassional problems where the system could be down for hours due to maintenance. This can be incredibly distruptive for teams. Having the ability to write test cases in an offline mode can help mitigate some of this pain.

Google Sheets Add On ReadyAPI Plugin