feat: Add support for single feature file and single scenario execution

Author: Igor Muchychka

.all-contributorsrc

@@ -165,6 +165,13 @@
       "avatar_url": "https://avatars3.githubusercontent.com/u/689118?v=4",
       "profile": "http://www.goshine-dev.co.uk/",
       "contributions": []
+    },
+    {
+      "login": "marikaner",
+      "name": "marikaner",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/868536?v=4",
+      "profile": "https://github.com/marikaner",
+      "contributions": []
     }
   ]
 }

lib/nightwatch-api.js

@@ -153,6 +153,23 @@ module.exports = class NightwatchApi {
     this.modulePaths = modulePaths
   }
 
+  isSingleFeatureFile (featureFile) {
+    let stat
+    try {
+      stat = fs.statSync(featureFile)
+    } catch (err) {
+      featureFile = featureFile.replace(/:\d+$/, '')
+      if (!featureFile.match(/\.feature$/)) featureFile += '.feature'
+      try {
+        stat = fs.statSync(featureFile)
+      } catch (err) {
+        throw new Error(`Feature file or folder ${featureFile} was not found!`)
+      }
+    }
+
+    return stat.isFile()
+  }
+
   overrideOriginalSourceGetter (convert) {
     const self = this
     const originalClientRunnerGetTestSource = Nightwatch.ClientRunner.prototype.getTestSource
@@ -163,14 +180,13 @@ module.exports = class NightwatchApi {
       const originalSettings = cloneDeep(this.settings)
 
       if (this.argv._source && this.argv._source.length) {
-        this.argv._source[0] = convert(this.argv._source[0])
+        this.argv._source = this.argv._source.map(convert)
       } else if (this.argv.test) {
         this.argv.test = convert(this.argv.test)
       } else {
         this.settings.src_folders = self.modulePaths
       }
       self.nightwatchArgv = this.argv
-
       self.testSource = Nightwatch.ClientRunner.prototype.getTestSource.apply(this, arguments)
 
       if (this.parallelMode) {
@@ -182,6 +198,14 @@ module.exports = class NightwatchApi {
       this.settings.src_folders = this.settings.src_folders || []
       return Nightwatch.ClientRunner.prototype.getTestSource.apply(this, arguments)
     }
+
+    Nightwatch.ClientRunner.prototype.singleSourceFile = function () {
+      if (this.singleTestRun()) {
+        return self.isSingleFeatureFile(this.argv.test)
+      }
+
+      return (Array.isArray(this.argv._source) && this.argv._source.length === 1) && self.isSingleFeatureFile(this.argv._source[0])
+    }
   }
 
   addHookTests (revert) {

lib/runner.js

@@ -15,15 +15,58 @@ module.exports = class Runner {
     this.originalFeaturePath = {}
   }
 
-  generateDummyTestModules () {
-    this.featureFiles.forEach((featureSource) => {
-      const featureFiles = glob.sync(path.join(featureSource, '**/*.feature'))
+  getSourceFile (featureSource) {
+    if (featureSource.startsWith('@')) {
+      return featureSource.substr(1, featureSource.length - 1)
+    }
+    return featureSource
+  }
 
-      featureFiles.forEach((featureFile) => {
-        const dummyTestModuleFile = this.featurePathToDummyPath(featureFile)
-        mkdirp.sync(path.dirname(dummyTestModuleFile))
-        fs.writeFileSync(dummyTestModuleFile, '')
+  getFeatureFilesFromRerunFile (rerunFile) {
+    const data = fs.readFileSync(this.getSourceFile(rerunFile))
+    return data.toString()
+      .split('\n')
+      .map(featurePath => featurePath.trim().replace(/(:\d*)/g, ''))
+      // filter empty paths
+      .filter(featurePath => featurePath)
+  }
+
+  getFeatureDirectories () {
+    return this.featureFiles
+      .map(featureSource => {
+        if (featureSource.startsWith('@')) {
+          return this.getFeatureFilesFromRerunFile(featureSource)
+            .map(featurePath => path.dirname(featurePath))
+        } else if (fs.statSync(featureSource).isDirectory()) {
+          return featureSource
+        }
+        return path.dirname(featureSource)
       })
+      // flatten
+      .reduce((paths, currentPaths) => paths.concat(currentPaths), [])
+  }
+
+  getFeatureFiles () {
+    return this.featureFiles
+      .map(featureSource => {
+        if (featureSource.startsWith('@')) {
+          return this.getFeatureFilesFromRerunFile(featureSource)
+        } else if (fs.statSync(featureSource).isDirectory()) {
+          return glob.sync(path.join(featureSource, '**/*.feature'))
+        }
+        return [featureSource]
+      })
+      // flatten
+      .reduce((paths, currentPaths) => paths.concat(currentPaths), [])
+      // make unique list
+      .filter((featureFilePath, idx, paths) => paths.indexOf(featureFilePath === idx))
+  }
+
+  generateDummyTestModules () {
+    this.getFeatureFiles().forEach((featureFile) => {
+      const dummyTestModuleFile = this.featurePathToDummyPath(featureFile)
+      mkdirp.sync(path.dirname(dummyTestModuleFile))
+      fs.writeFileSync(dummyTestModuleFile, '')
     })
   }
 
@@ -42,11 +85,26 @@ module.exports = class Runner {
   }
 
   featurePathToDummyPath (featureFile) {
-    if (!featureFile.match(/\.feature$/)) featureFile += '.feature'
+    const lineNumberMatch = featureFile.match(/:(\d+)$/)
+    let lineNumber
+    if (lineNumberMatch) {
+      lineNumber = parseInt(lineNumberMatch[1])
+      featureFile = featureFile.replace(/:\d+$/, '')
+    }
+    try {
+      fs.statSync(featureFile)
+    } catch (err) {
+      if (!featureFile.match(/\.feature$/)) featureFile += '.feature'
+      try {
+        fs.statSync(featureFile)
+      } catch (err) {
+        throw new Error(`Feature file or folder ${featureFile} was not found!`)
+      }
+    }
 
     const dummyPath = path.join(dummyTestModulesFolder, featureFile.replace(/\.feature$/, '.js'))
 
-    this.originalFeaturePath[dummyPath] = featureFile
+    this.originalFeaturePath[dummyPath] = lineNumber ? `${featureFile}:${lineNumber}` : featureFile
 
     return dummyPath
   }
@@ -92,14 +150,17 @@ module.exports = class Runner {
     this.cucumberApi = new CucumberApi(options)
     this.jsonReport = this.cucumberApi.getJSONReportName(options.cucumberArgs)
     this.featureFiles = this.cucumberApi.getFeatureFiles(options.cucumberArgs)
-    this.featureFiles.forEach((featureSource) => {
-      try {
-        fs.statSync(featureSource)
-      } catch (err) {
-        throw new Error(`Feature source ${featureSource} doesn't exists`)
-      }
-    })
-    const dummyPaths = this.featureFiles.map((srcPath) => path.join(dummyTestModulesFolder, srcPath))
+    this.featureFiles
+      .map(this.getSourceFile)
+      .forEach((featureSource) => {
+        try {
+          fs.statSync(featureSource)
+        } catch (err) {
+          throw new Error(`Feature source ${featureSource} doesn't exists`)
+        }
+      })
+
+    const dummyPaths = this.getFeatureDirectories().map(srcPath => path.join(dummyTestModulesFolder, srcPath))
 
     this.generateDummyTestModules()
 

site/data/index.md

@@ -103,14 +103,65 @@ For more examples check out the [example repository](https://github.com/mucsi96/
 
 # Running tests
 
-You can run the test by executing
+You can run the tests by executing
 
 ```bash
 node_modules/.bin/nightwatch
 ```
 
 ![alt-tag](https://raw.githubusercontent.com/mucsi96/nightwatch-cucumber/master/img/nightwatch-cucumber-output.png)
 
+Using NPM scripts its more easy. Let's assume you have following `package.json`.
+
+```json
+{
+  ...
+  "scripts": {
+    "test": "nightwatch",
+    ...
+  }
+  ...
+}
+```
+
+You can run the tests by executing
+
+```bash
+npm test
+```
+
+### Executing individual feature files or scenarios
+
+Single feature file
+
+```bash
+npm test -- features/google-search.feature
+```
+
+or
+
+```bash
+npm test -- features/google-search
+```
+
+Multiple feature files
+
+```bash
+npm test -- features/google-search features/duckduckgo-search
+```
+
+Single feature file and one folder
+
+```bash
+npm test -- features/google/google-search features/duckduckgo
+```
+
+Single scenario by its line number
+
+```bash
+npm test -- features/google-search.feature:11
+```
+
 # Features
 
 ## Supported Nightwatch command line options
@@ -123,8 +174,8 @@ node_modules/.bin/nightwatch
 | `--env`          |	`-e`     | ✅ |	default              |	Which testing environment to use - defined in nightwatch.conf.js |
 | `--verbose`      |           | ✅ |                      | Shows extended selenium command logging during the session |
 | `--version`      |	`-v`     | ✅ |                      |	Shows the version number |
-| `--test`         |	`-t`     | 🚧 |	                     |	Runs only the specified test suite/module. By default the runner will attempt to run all tests in the src_folders settings folder(s) and their subfolders. |
-| `--testcase`     |           | 🚧 |	                     |	Used only together with --test. Runs the specified testcase from the current suite/module. |
+| `--test`         |	`-t`     | ✅ |	                     |	Runs only the specified feature file. By default the runner will attempt to run all feature files. |
+| `--testcase`     |           | ⛔ |	                    |	Used only together with --test. Runs the specified testcase from the current suite/module. |
 | `--group`        | `-g`      | ✅ |                      |	Runs only the specified group of tests (subfolder). Tests are grouped by being placed in the same subfolder. |
 | `--skipgroup`    | `-s`      | ✅ |                      |	Skip one or several (comma separated) group of tests. |
 | `--filter`       | 	`-f`     | 🚧 |	                     |	Specify a filter (glob expression) as the file name format to use when loading the test files. |
@@ -230,8 +281,11 @@ As input you need to provide a Cucumber JSON report generated by this package. Y
 ```json
 {
   ...
-  "test": "nightwatch",
-  "posttest": "node create-html-report.js",
+  "scripts": {
+    "test": "nightwatch",
+    "posttest": "node create-html-report.js",
+    ...
+  }
   ...
 }
 ```