Editor Support

Iridium provides hundreds of steps that are available for use in a feature script. However, knowing what these steps are is a challenge. You can read the source code or example scripts to find out what steps are available, but there is a better way.

ATOM Editor

The Iridium Snippets package for the Atom text editor provides a quick way to search the steps that are available for use in an Iridium feature script.

NOTE: See this support thread for details of using a proxy with Atom.

Follow these instructions to install the Iridium Snippets package in Atom:

  1. Download and install the Atom editor from here.
  2. Open the Atom editor.
  3. Open the Preferences menu. The exact location of this menu differs on each OS, but it can be found in the toolbar.

  1. Click the Install link, search for the package iridium-snippets, and click the Install button.

  1. Click the Open Config Folder button.
  2. Add the following text to the end of the styles.less file, and save the changes.
    autocomplete-suggestion-list {
    max-width: 150% !important;
    .word {
     max-width: 100% !important;
    }
    // Skip this class if you use the autocomplete-plus package for
    // suggestions other than those provided by Iridium as it removes
    // the description column.
    .right-label {
     display: none !important;
    }
    }
    

  1. Restart the Atom editor.
  2. Under a scenario in a .feature file, start typing a sentence like "And I populate". You will see a list of possible steps that can be added to the script. Replace populate with any of the words click, save, select, mouse, open, wait, set, dispatch, dump, delete or press to see the steps that are available for that action.

If you continue typing after the prefix word of populate, click, save etc without using any spaces, Atom will narrow down the list of snippets matching all the characters.

For example, if you type "populatedelay", all snippets that start with "populate" and contain the word "delay" are displayed. It is important to not use any spaces though, as the Atom editor does not recognise multiple words as belonging to a single snippet.

Useful Packages

The fold-functions is quite handy, as it allows you to collapse large test script down to the feature and scenario headings.

Atom Packages and Proxies

Atom doesn't seem to work very well with proxies, but you can install packages manually.

  1. Open ~/.atom/packages in a terminal or command prompt (the full directory is probably C:\Users\<username>\.atom\packages in Windows)
  2. Run git clone https://github.com/mcasperson/iridium-snippets.git

This will checkout the snippets package directly into Atom, bypassing the need to use the Atom package manager.

IntelliJ IDEA

Import the sample project from here into IntelliJ. It includes the Cucumber and Iridium dependencies, and with the Cucumber for Java plugin installed, means that the Iridium step definitions will be integrated into IntelliJ IDEA's support for feature files.

Other Tools

The Tidy Gherkin Chrome extension provides a handy way to autoformat a Gherkin script.

Just be aware that if you test script has a step like this (i.e. a regex with the pipe character):

Then I wait "30" seconds for the page to contain the regex "Your Smart (Home & Contents|Home Only|Contents Only) Insurance Quote"

this tool will incorrectly format it.

results matching ""

    No results matching ""