Cucumber Java Easy Runner
A VS Code extension that allows you to easily run Cucumber feature files in Java projects. You can run feature files, scenarios, and example rows directly from the VS Code interface in projects using the Cucumber-JVM framework.
✨ Features
- 🥒 Run the entire feature file: Right-click on a feature file in the explorer or in the context menu when open in the editor to run the entire feature file
- 🔍 Run a single scenario: Right-click on a specific scenario or scenario outline to run only that scenario
- 📋 Run example rows: Select a specific example row in a Scenario Outline to run only that example
- 🔄 Automatic configuration: Automatically detects glue path, no manual configuration required
- ⚡ Fast execution: Provides fast execution by directly using the Cucumber CLI in Maven projects
- 🚫 No dependencies: Works without additional plugins or dependencies
🚀 Usage
1. Running a Feature File
- Right-click on a
.feature file in the file explorer and select "Cucumber: Run Feature", or
- Right-click in an open feature file and select "Cucumber: Run Feature"
Example of context menu:
┌─────────────────────────────┐
│ ✂️ Cut │
│ 📋 Copy │
│ 📋 Paste │
│ ──────────────────────── │
│ ▶️ Cucumber: Run Feature │
│ ▶️ Cucumber: Run Scenario │
│ ▶️ Cucumber: Run Example │
│ ──────────────────────── │
│ 📝 Open to the Side │
└─────────────────────────────┘
2. Running a Specific Scenario
- Right-click inside a scenario in an open feature file and select "Cucumber: Run Scenario"
Example feature file with cursor position for running a scenario:
Feature: Shopping Cart
Scenario: Adding an item to cart <- Right-click here to run this scenario
Given I am on the product page
When I click "Add to Cart"
Then the item should be added to my cart
And the cart count should be updated
Scenario: Removing an item from cart
Given I have an item in my cart
When I remove the item
Then my cart should be empty
3. Running a Specific Example
- Right-click on a data row in an Examples table in an open feature file and select "Cucumber: Run Example"
Example of running a specific data row:
Scenario Outline: User login with different credentials
Given I am on the login page
When I enter "<username>" and "<password>"
Then I should see the "<result>" message
Examples:
| username | password | result |
| admin | admin123 | Welcome! | <- Right-click on this row to run this example
| user1 | pass123 | Welcome! |
| invalid | wrong | Access Denied|
📦 Installation
You can install the extension from the VS Code Marketplace or manually install the .vsix file:
From VS Code Marketplace
- Open VS Code
- Go to Extensions view (View -> Extensions or Ctrl+Shift+X)
- Search for "Cucumber Java Easy Runner"
- Click Install
Manual Installation
- Download the
.vsix file from Releases
- Open the Extensions view in VS Code
- Click on the "..." menu and select "Install from VSIX"
- Select the downloaded
.vsix file
⚙️ Requirements
- Java JDK 8 or higher
- Maven 3.6 or higher must be installed
- Project must have a Maven structure
- Cucumber-JVM dependencies must be defined in your project
🔧 Configuration
This extension works out of the box with standard Maven project structures. However, if you have a custom setup, you can configure some options:
- The extension will automatically detect the glue path for your step definitions
- If the automatic detection fails, you'll be prompted to enter your glue path manually
❓ Troubleshooting
- Glue path not found error: You will be asked to manually specify your glue path, e.g.
com.example.steps
- Test execution error: Make sure that the Maven structure is correct and that Cucumber dependencies are defined in pom.xml
- No Cucumber version found: Ensure that your project has Cucumber dependencies in the pom.xml file
🛠️ Development
If you want to develop this extension:
# Install dependencies
npm install
# Compile the extension
npm run compile
# Create the VSIX package
npx vsce package
🔄 Reporting Issues
If you encounter any issues, please report them on the GitHub Issues page.
📄 License
MIT
Developer: Hakkı Etem
