Cycle Testing for Visual Studio Code
Welcome to Cycle Testing for Visual Studio Code! This extension provides support for the CycleScript language. Cycle is required to use this extension.
Features
Feature files (.feature)
- CycleScript syntax highlighting, comment toggling, and snippets
- Syntax errors and warnings
- Autosuggest for Steps, Keywords, and more
- Step documentation on hover
- Opening the Cycle Step Guide
Playlist files (.cycplay)
- Visual editor with a toggle to the text editor
Group test files (.cvt)
- Visual editor with a toggle to the text editor
- JSON syntax highlighting, validation, and autosuggest in the text editor
Project and user settings (.cycproj / .cycuser)
- Visual editor with a toggle to the text editor
- JSON syntax highlighting, validation, and autosuggest in the text editor
API and Blueprint files (.api / .blueprint)
File icons
- A distinct file icon for every Cycle file type, in light and dark variants
Testing and reporting
- Discovering and running Cycle tests from the Testing sidebar (Features, Playlists, and Group Tests)
- Cycle Report Dashboard integration
- Cycle Testing activity bar with Projects, Management, and Resources views
- Creating Cycle files (Features, Playlists, Group Tests, and plugin projects)
- Checking the installed Cycle version
- Links to Cycle resources (Admin Portal, Cycle University, Knowledge Base, User Manual, and downloads)
Installation
Cycle Installation Path Setting
VS Code needs to know where to find Cycle. The extension provides a setting to specify Cycle's installation directory.
By default, Cycle is installed at C:/Program Files (x86)/CycleLabs/Cycle, and the extension setting is defaulted to that value. If you are using Cycle installed in the default location, the extension will work correctly without any additional configuration.
If Cycle is not installed in the default location, you will need to change this setting to point to the directory where Cycle is installed.
When you change the installation path setting, the extension automatically restarts the CycleScript language server and the Report Dashboard so they use the new path. You can also restart the language server manually with the Cycle: Restart Language Server command in the Command Palette (View -> Command Palette... or Ctrl+Shift+P). Once the Command Palette is open, search for the command by typing Cycle.
Authentication
This extension requires an active subscription to Cycle. You must authenticate through Cycle first to enable the Cycle VS Code Extension to run the CycleScript language server.
Language Server Errors
When attempting to restart the language server, you may hit the following error:
Error: spawn EPERM
If this happens, it is most likely due to permissions. Make sure that there are no permissions blocking VS Code from interacting with the Cycle directory or preventing the language server from starting. You may need to check with your InfoSec team.
