Traceability Toolkit

Overview

Traceability Toolkit is a Visual Studio Code extension for working with Cypress BDD .feature files.

The extension currently provides four commands:

Traceability Toolkit: Extract Test Cases
Traceability Toolkit: Find Duplicate Test Cases
Traceability Toolkit: Map Jira IDs
Traceability Toolkit: Map Jira IDs (Preview Mode)

The extension focuses on:

Test case inventory generation
Duplicate scenario detection
Jira ID synchronization
Traceability reporting
Audit-friendly CSV and log output

Commands

Traceability Toolkit: Extract Test Cases

Purpose

Scans all .feature files under a selected feature root folder and exports test case information to a CSV file.

User Flow

Open a VS Code workspace.
Run Traceability Toolkit: Extract Test Cases.
Select the feature files root folder.
The extension scans all .feature files recursively.
A CSV file is generated and automatically opened in VS Code.

Output Folder

extracted-testcases/

Output File Format

test-cases-YYYY-MM-DD_HH-MM-SS-SSS.csv

Exported Columns

Module
Feature
FeatureTags
JiraId
Scenario
Tags
Steps
FeatureFile
FilePath

What Is Extracted

Feature names
Feature tags
Scenario names
Scenario Outline names
Scenario tags
Jira IDs embedded in scenario titles
Scenario steps
Examples sections
Example table rows
Feature file name
Relative file path

Notes

Comments are ignored.
Blank lines are ignored.
Jira IDs are extracted into a dedicated JiraId column.
Scenario names are exported without Jira ID prefixes.
Scenario and Scenario Outline are both supported.

Example Output Location

workspace-root/
└── extracted-testcases/
    └── test-cases-2026-09-27_13-22-18-125.csv

Traceability Toolkit: Find Duplicate Test Cases

Purpose

Identifies duplicate Scenario and Scenario Outline names across feature files.

User Flow

Open a VS Code workspace.
Run Traceability Toolkit: Find Duplicate Test Cases.
Select the feature files root folder.
The extension scans all .feature files recursively.
A duplicate report CSV is generated and automatically opened.

Output Folder

duplicate-testcases/

Output File Format

duplicate-testcases-YYYY-MM-DD_HH-MM-SS-SSS.csv

Exported Columns

scenario
occurrence_count
feature_file_path

Detection Rules

Jira IDs are ignored when comparing scenario names.
Scenario and Scenario Outline are both checked.
Duplicates inside the same feature file are detected.
Duplicates across different feature files are detected.
One report row is generated per duplicate scenario.

Example Output Location

workspace-root/
└── duplicate-testcases/
    └── duplicate-testcases-2026-09-27_13-22-18-125.csv

Traceability Toolkit: Map Jira IDs

Purpose

Synchronizes Jira IDs from a CSV file into Scenario and Scenario Outline titles within feature files.

User Flow

Run Traceability Toolkit: Map Jira IDs.
Select the feature files root folder.
Select the Jira mapping CSV file.
Review the warning message.
Click Continue.
Feature files are updated where applicable.
Report and log files are generated.

Input CSV Format

The CSV file must contain exactly the following header:

JiraId,ScenarioName

Example:

JiraId,ScenarioName
NEW-1001,Bill Pay
NEW-1002,Login

Example Update

Before:

Scenario: Bill Pay

After:

Scenario: NEW-1001 Bill Pay

Example Existing Jira Replacement

Before:

Scenario: OLD-999 Bill Pay

After:

Scenario: NEW-1001 Bill Pay

Output Folders

jira-id-mapping-reports/
jira-id-mapping-logs/

Report File

jira-id-mapping-report-output-YYYY-MM-DD_HH-MM-SS-SSS.csv

Log File

jira-id-mapping-YYYY-MM-DD_HH-MM-SS-SSS.log

Report Columns

JiraId
ScenarioName
Status

Report Status Values

Scenario Updated
Existing Jira Id In Scenario Updated
Already Correct Jira Id Present In Scenario
Scenario Not Found In Feature Files - Skipped
Duplicate Scenario Names Found in Feature File/Files - Skipped
Invalid CSV Mapping - Multiple Jira IDs Found For Same Scenario - Skipped

Safety Warning

Before updating files, the extension warns the user that:

Scenario titles may be modified.
Scenario Outline titles may be modified.
A Git commit is strongly recommended.
Generated reports and logs should be reviewed.

Traceability Toolkit: Map Jira IDs (Preview Mode)

Purpose

Calculates Jira ID updates without modifying any feature files.

What Preview Mode Does

Loads and validates the CSV mapping file.
Scans all feature files.
Detects duplicate scenario names.
Detects invalid CSV mappings.
Calculates all Jira ID changes.
Generates a report CSV.
Generates a log file.

What Preview Mode Does Not Do

Does not modify feature files on disk.

Recommended Workflow

Run Traceability Toolkit: Map Jira IDs (Preview Mode).
Review the generated report CSV.
Review the generated log file.
Run Traceability Toolkit: Map Jira IDs.

Supported Feature File Elements

Processes:

Feature:
Scenario:
Scenario Outline:
Given
When
Then
And
But
Examples:

It also extracts:

@FeatureTag
@ScenarioTag

Generated Artifacts

Extract Test Cases

extracted-testcases/

Duplicate Test Cases

duplicate-testcases/

Jira Mapping Reports

jira-id-mapping-reports/

Jira Mapping Logs

jira-id-mapping-logs/

Command Reference

Command	Description
Traceability Toolkit: Extract Test Cases	Export test case inventory from feature files
Traceability Toolkit: Find Duplicate Test Cases	Detect duplicate scenario names
Traceability Toolkit: Map Jira IDs	Apply Jira IDs to feature files
Traceability Toolkit: Map Jira IDs (Preview Mode)	Calculate changes without modifying files

Best Practices

Commit your workspace to Git before running Jira ID updates.
Run Preview Mode before running Map Jira IDs.
Review generated reports after each run.
Review generated log files for calculated changes.
Resolve duplicate scenarios before running Jira synchronization.

Author

Syed Talha Ahmed

Version

Current Version: 0.0.1