Make Cycle Features easier for others to understand.

Make Cycle Features easier for others to understand.

Problem

Even well written Cycle Features can sometimes seem unclear to a new user.

Solution

By including comments at the beginning of your Feature and within Scenarios, you can lay out all pertinent details for a reader without needing to use Cycle Steps.

Feature File Header

Every Feature File should start with the Cycle version number included as a comment

  • Cycle version number
  • Application version number
  • Purpose of the Feature File
  • Names of Scenarios or Feature Files that will be imported
  • Names of any resources that will be needed to execute the Feature File
  • Assumptions and usage instructions

Example

# Cycle Version 1.7.0.12
# WMS Version: 2009_1
# Desc: The Feature File is to wave an order via wave operations GUI screen
# Import Feature/Scenarios:
#     JDA_WM_Utilities.feature
#     Wave_Ops.feature
# Resources:
#     Gui_Login-Login.png
#     Wave_Operations-Wave_Operations_Title.png

Within-Scenario comments

Comments can also be added for the sake of clarity before a Step, set of Steps, or Scenario. This is particularly helpful to add descriptive information related to loops, conditionals, and breaks.

    • Related Articles

    • Structuring Feature files.

      Problem With multiple developers writing tests on the same project, inconsistent Feature File structure can lead to overlaps in test coverage and reduce test readability. Solution Adopting a modular approach Many common computer interactions are ...

    • Stay consistent in naming Cycle files, images and variables.

      Problem Teams that use differing names for core elements often encounter difficulties when reading other developer's Cycle tests. Solution Sticking to the following naming conventions will help add clarity and greater readability to Cycle projects: ...

    • Aligning terminal Steps with Operator behavior

      Problem My terminal-based Cycle Steps don't always perfectly coincide with the actions a human operator performs on their device. Solution There are 3 terminal Steps that can provide a clear picture of the business process and end user operation. ...

    • How to make better Cycle tests with Backgrounds and After Scenarios.

      Problem Cycle Features can often require set-ups before a system is in the correct state to begin the test or cleanup after having run to return everything to a clean state. Solution Cycle includes the ability to use two special types of Scenarios ...

    • How to make better xpaths for web tests.

      Problem My web-based steps in Cycle are not finding the elements I want them to, or finding the wrong elements and giving me false-positives. Solution When possible, it is best to define elements to interact with on a web page by a static value that ...