Merge pull request #1 from jimasp/go-to-step-def

Go to step def

Author: jimasp

CHANGELOG.md

@@ -1,20 +1,3 @@
 # Changelog
 
-## [Pre-release]
-
-## [0.0.1] - 2021-03-05
-
-### Contributors
-
-N/A
-
-### Tested with
-
-- behave 1.2.6
-- Python 3.9.7
-- Linux/Windows
-- Visual Studio Code 1.64.x
-
-### Added/Changed/Removed
-
-N/A
+See [github releases](https://github.com/jimasp/behave-vsc/releases)

README.md

@@ -1,14 +1,14 @@
 # Behave VSC 
 
-## Pre-release v0.0.1
+## Pre-release v0.0.2
 - A simple test runner (and debugger) for running python Behave tests in vscode
 - Built with the new Visual Studio Code Test API  
 - See [Known Issues](#known-issues) and [Troubleshooting](#troubleshooting) below if you have any problems
 
 ## Tested with
-  - behave 1.2.6
-  - Python 3.9.7
-  - Linux/Windows
+- behave 1.2.6
+- Python 3.9.7
+- Linux/Windows
 
 ---
 ## Project Requirements
@@ -38,7 +38,8 @@ paths=behave-tests/features
 ---
 ## Features
 
-- Run/debug behave tests from the test workbench, or from inside a Feature file.
+- Run or Debug behave tests from the test workbench, or from inside a Feature file.
+- Go to step definition from feature file. (Not shown in below gif, just right-click inside feature file on a line containing a step and click "Go to step").
 - Run customisation via [Extension settings](#extension-settings).
 - In run mode, std/err output can be found in the Behave VSC output window, including an equivalent behave command to run the test manually. (In debug mode, errors are shown in the console.)
 
@@ -82,16 +83,16 @@ It will be faster if you select a subset/group of tests to run.
 ---
 ## Troubleshooting
 - Does your setup match the [Requirements](#requirements) section above?
-- Check if the problem is in [Known Issues](#known-issues) above
+- Check if the problem is in [Known Issues](#known-issues) above.
+- Have you tried manually running the outputted behave command from the Behave VSC output window?
 - Do you have runParallel turned on? Try turning it off.
 - Do you have the latest version of the extension?
 - Do you have the correct [Extension Settings](#extension-settings) for your project? (Also if you have removed extension settings from your 
 workspace `.vscode/settings.json`, then do you have any of the extension settings in your user settings?)
-- Have you tried manually running the outputted behave command from the behave-vsc output window?
-- Try disabling other extensions
+- Try disabling other extensions.
 - Have you got the latest version of the extension?
-- Does your project environment match the environment tested for this release? Older releases are kept in the vsix folder in 
-[github](https://github.com/jimasp/behave-vsc/vsix). The details of each release are in the (TODO:release doc)
+- Does your project environment match the environment tested for this release? Older releases are available in 
+[github](https://github.com/jimasp/behave-vsc/releases).
 - See [Contributing](#contributing) below for extension debugging instructions. (Does the issue occur with the example project workspaces, or just 
 in your own project?) 
 

package-lock.json

@@ -21,10 +21,21 @@
 					"description": "Optional csv list of fast skip tags, example: '@skip, @skip-me-too'.\nThis will stop behave being called for those tags. Use if you have a lot of tests to skip."
 				}					
 			}
+		},
+		"commands": [{
+				"command": "behave-vsc.gotoStep",
+				"title": "Go to step"
+		}],
+		"menus": {
+			"editor/context": [{
+				"when": "editorTextFocus && resourceExtname =~ /\\.feature$/",
+				"command": "behave-vsc.gotoStep",
+				"group": "navigation"
+			}]
 		}
 	},
-	"description": "Run/debug behave tests from Sidebar or Feature file",
-	"version": "0.0.1",
+	"description": "Debug/Run Behave tests from Sidebar or Feature file",
+	"version": "0.0.2",
 	"icon": "images/behave-vsc.png",
 	"galleryBanner": {
 		"color": "#2B2B2B",

package.json

@@ -7,6 +7,7 @@ import { getContentFromFilesystem, Scenario, testData, TestFile } from './testTr
 import { runBehaveAll } from './runOrDebug';
 import { getGroupedFeatureSubPath } from './helpers';
 import { getFeatureNameFromFile } from './featureParser';
+import { parseStepsFile, StepDetail, Steps } from './stepsParser';
 
 
 function logRunHandlerDiagOutput() {
@@ -24,6 +25,7 @@ function logActivate(context:vscode.ExtensionContext) {
   config.logger.logInfo(`activated (version ${version})`);
 }
 
+const steps:Steps = new Map<string, StepDetail>();
 
 export interface QueueItem { test: vscode.TestItem; scenario: Scenario }
 
@@ -34,6 +36,7 @@ export async function activate(context: vscode.ExtensionContext) {
   const ctrl = vscode.tests.createTestController(`${config.extensionName}.TestController`, 'Feature Tests');
   context.subscriptions.push(ctrl);
   context.subscriptions.push(startWatchingWorkspace(ctrl));
+  context.subscriptions.push(vscode.commands.registerCommand("behave-vsc.gotoStep", gotoStepHandler));
 
   const runHandler = async (debug: boolean, request: vscode.TestRunRequest, cancellation: vscode.CancellationToken) => {
 
@@ -180,7 +183,7 @@ export async function activate(context: vscode.ExtensionContext) {
   };
 
   const refreshHandler = async() => {
-     await findInitialFiles(ctrl, true);
+     await findInitialFeatureFiles(ctrl, true);
   };
   // @ts-ignore: Property 'refreshHander' does not exist on type 'TestController'
   ctrl.refreshHandler = refreshHandler;
@@ -235,7 +238,7 @@ export async function activate(context: vscode.ExtensionContext) {
   //   vscode.workspace.onDidChangeTextDocument((e: vscode.TextDocumentChangeEvent) => updateNodeForDocument(e.document))
   // );
 
-  return { runHandler: runHandler, config: config, ctrl: ctrl, findInitialFiles: findInitialFiles}; // support extensiontest.ts
+  return { runHandler: runHandler, config: config, ctrl: ctrl, findInitialFiles: findInitialFeatureFiles}; // support extensiontest.ts
 
 } // end activate()
 
@@ -288,7 +291,7 @@ function gatherTestItems(collection: vscode.TestItemCollection) {
 
 
 
-async function findInitialFiles(controller: vscode.TestController, reparse?:boolean) {
+async function findInitialFeatureFiles(controller: vscode.TestController, reparse?:boolean) {
   controller.items.forEach(item => controller.items.delete(item.id));
   const featureFiles1 = await vscode.workspace.findFiles("**/features/*.feature");      
   const featureFiles2 = await vscode.workspace.findFiles("**/features/**/*.feature");
@@ -302,36 +305,142 @@ async function findInitialFiles(controller: vscode.TestController, reparse?:bool
   }
 }
 
+async function findInitialStepsFiles() {
+  steps.clear();
+  const stepFiles1 = await vscode.workspace.findFiles("**/features/steps/*.py");      
+  const stepFiles2 = await vscode.workspace.findFiles("**/features/steps/**/*.py");
+  const stepFiles = stepFiles1.concat(stepFiles2);
+
+  for (const stepFile of stepFiles) {
+    updateSteps(stepFile);
+  }
+}
+
 function startWatchingWorkspace(controller: vscode.TestController) {
 
     // not just .feature files, also support folder changes, could change to just .feature files when refreshhandler() works
     const watcher = vscode.workspace.createFileSystemWatcher('**/features/**');  
 
     watcher.onDidCreate(uri => {
+      
+      if(uri.path.indexOf("/steps/") !== -1) {
+        updateSteps(uri);
+        return;
+      }
+
       if(uri.path.toLowerCase().endsWith(".feature"))
         getOrCreateFile(controller, uri);      
       else if(uri.path.toLowerCase().endsWith("/"))
-        findInitialFiles(controller);
+        findInitialFeatureFiles(controller);
+
     });
+
     watcher.onDidChange(uri => {
+      
+      if(uri.path.indexOf("/steps/") !== -1) {
+        updateSteps(uri);
+        return;
+      }      
+
       if(uri.path.toLowerCase().endsWith(".feature")) {      
         const created = getOrCreateFile(controller, uri);
         if (created) {
           created.data.updateFromDisk(controller, created.file);
         }
       }
       else if(uri.path.toLowerCase().endsWith("/"))
-        findInitialFiles(controller);
+        findInitialFeatureFiles(controller);
+
     });
+
+
     watcher.onDidDelete(uri =>  {
+      
+      if(uri.path.indexOf("/steps/") !== -1) {
+        updateSteps(uri);
+        return;
+      }
+
       if(uri.path.toLowerCase().endsWith(".feature"))
         getOrCreateFile(controller, uri);      
       else if(uri.path.toLowerCase().endsWith("/"))
-        findInitialFiles(controller);
+        findInitialFeatureFiles(controller);
+
     });
 
-    findInitialFiles(controller, true);    
+    findInitialFeatureFiles(controller, true);    
+    findInitialStepsFiles();
 
     return watcher;
 
 }
+
+
+function updateSteps(uri:vscode.Uri) {
+  if(uri.path.toLowerCase().endsWith(".py")) {
+    const content = getContentFromFilesystem(uri);
+    parseStepsFile(uri, content, steps);
+  }
+  else if(uri.path.toLowerCase().endsWith("/"))
+    findInitialStepsFiles();
+}
+
+
+function gotoStepHandler(uri: vscode.Uri) {
+
+  function getStepMatch(stepText:string): StepDetail|null {
+
+    let stepMatch:StepDetail|null = null;
+
+    for(const[key, value] of steps) {
+      const rx = new RegExp(key);
+      const match = rx.exec(stepText);
+      if(match && match.length !== 0)  {
+        stepMatch = value;
+        break;
+      }
+    }
+  
+    return stepMatch;
+  }
+
+  try {  
+    const activeEditor = vscode.window.activeTextEditor;
+    if (!activeEditor) {
+      return;
+    }
+    
+    const line = activeEditor.document.lineAt(activeEditor.selection.active.line).text.trim();
+    const stepRe = /^(\s*)(Given|When|Then|And)(.+)(\s*)$/i;
+    const matches = stepRe.exec(line);
+    if(!matches || !matches[3])
+      return;
+
+    const stepText = matches[3].trim();
+    const stepMatch = getStepMatch(stepText);
+
+    if(!stepMatch) {
+      vscode.window.showInformationMessage("Step not found (is it implemented?)")
+      return;
+    }
+
+    vscode.workspace.openTextDocument(stepMatch.uri).then(doc => {
+      vscode.window.showTextDocument(doc, {preview:false}).then(editor => {
+        if(!editor) {
+          config.logger.logError("Could not open editor for file:" + uri.fsPath)
+          return;
+        }
+        editor.selection =  new vscode.Selection(stepMatch.range.start, stepMatch.range.end);
+        editor.revealRange(stepMatch.range);
+      });
+    });   
+    
+  }
+  catch(e:unknown) {
+    config.logger.logError(e instanceof Error ? (e.stack ? e.stack : e.message) : e as string);
+  }
+  
+  
+}
+
+

src/extension.ts

@@ -5,9 +5,9 @@ import { getContentFromFilesystem } from './testTree';
 
 const featureReStr = "^(\\s*|\\s*#\\s*)Feature:(\\s*)(.+)(\\s*)$";
 const featureReLine = new RegExp(featureReStr);
-const featureReFile = new RegExp(featureReStr, "m");
-const scenarioReLine = /^(\s*)(Scenario|Scenario Outline):(\s*)(.+)(\s*)$/;
-const scenarioOutlineRe = /^(\s*)Scenario Outline:(\s*)(.+)(\s*)$/;
+const featureReFile = new RegExp(featureReStr, "im");
+const scenarioReLine = /^(\s*)(Scenario|Scenario Outline):(\s*)(.+)(\s*)$/i;
+const scenarioOutlineRe = /^(\s*)Scenario Outline:(\s*)(.+)(\s*)$/i;
 
 
 export const getFeatureNameFromFile = (uri:vscode.Uri): string =>  {

src/featureParser.ts

@@ -23,10 +23,9 @@ export async function runBehaveAll(run:vscode.TestRun, queue:QueueItem[], cancel
   try {
     await runAll(run, queue, shared_args, cancellation);
   }
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  catch(e:any) {
-    config.logger.logError(e.stack ? e.stack : e as string); 
-  }    
+  catch(e:unknown) {
+    config.logger.logError(e instanceof Error ? (e.stack ? e.stack : e.message) : e as string);
+  }
 }
 
 
@@ -58,10 +57,9 @@ export async function runOrDebugBehaveScenario(run:vscode.TestRun, queueItem:Que
         await runScenario(run, queueItem, args, cancellation);   
       }
     }
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    catch(e:any) {
-      config.logger.logError(e.stack ? e.stack : e as string); 
-    }    
+    catch(e:unknown) {
+      config.logger.logError(e instanceof Error ? (e.stack ? e.stack : e.message) : e as string);
+    }
 
 
     function formatScenarioName(string:string, isOutline:boolean) {