Empty rerun file exits running no scenarios (#1302) (#1568)

Co-authored-by: Aslak Hellesøy <[email protected]>
Co-authored-by: Aurélien Reeves <[email protected]>
Co-authored-by: David Goss <[email protected]>

Author: 4 people

CHANGELOG.md

@@ -28,6 +28,7 @@ Please see [CONTRIBUTING.md](https://github.com/cucumber/cucumber/blob/master/CO
 
 * Progress bar formatter now reports total step count correctly ([#1579](https://github.com/cucumber/cucumber-js/issues/1579)
   [#1669](https://github.com/cucumber/cucumber-js/pull/1669))
+* Rerun functionality will now run nothing if the rerun file is empty from the previous run ([#1302](https://github.com/cucumber/cucumber-js/issues/1302) [#1568](https://github.com/cucumber/cucumber-js/pull/1568))
 * All messages now emitted with project-relative `uri`s
   ([#1534](https://github.com/cucumber/cucumber-js/issues/1534)
   [#1672](https://github.com/cucumber/cucumber-js/pull/1672))

features/rerun_formatter.feature

@@ -95,19 +95,11 @@ Feature: Rerun Formatter
     When I run cucumber-js with `@rerun.txt`
     Then it runs the scenario "C - passing"
 
-  Scenario: empty rerun file
+  Scenario: empty rerun file exits without running any scenarios
     Given an empty file named "@rerun.txt"
     When I run cucumber-js with `@rerun.txt`
-    Then it fails
-    And it runs the scenarios:
-      | NAME          |
-      | A - passing   |
-      | A - failing   |
-      | A - ambiguous |
-      | B - passing   |
-      | B - pending   |
-      | C - passing   |
-      | C - undefined |
+    Then it passes
+    And it runs 0 scenarios
 
   Scenario: rerun with fail fast outputs all skipped scenarios
     When I run cucumber-js with `--fail-fast --format rerun:@rerun.txt`

src/cli/configuration_builder.ts

@@ -210,13 +210,13 @@ export default class ConfigurationBuilder {
         if (filename[0] === '@') {
           const filePath = path.join(this.cwd, arg)
           const content = await fs.readFile(filePath, 'utf8')
-          return _.chain(content).split('\n').map(_.trim).compact().value()
+          return _.chain(content).split('\n').map(_.trim).value()
         }
         return [arg]
       })
       const featurePaths = _.flatten(nestedFeaturePaths)
       if (featurePaths.length > 0) {
-        return featurePaths
+        return _.compact(featurePaths)
       }
     }
     return ['features/**/*.{feature,feature.md}']

src/cli/configuration_builder_spec.ts

@@ -164,6 +164,78 @@ describe('Configuration', () => {
     })
   })
 
+  describe('path to an empty rerun file', () => {
+    it('returns empty featurePaths and support code paths', async function () {
+      // Arrange
+      const cwd = await buildTestWorkingDirectory()
+
+      const relativeRerunPath = '@empty_rerun.txt'
+      const rerunPath = path.join(cwd, '@empty_rerun.txt')
+      await fsExtra.outputFile(rerunPath, '')
+      const argv = baseArgv.concat([relativeRerunPath])
+
+      // Act
+      const {
+        featurePaths,
+        pickleFilterOptions,
+        supportCodePaths,
+      } = await ConfigurationBuilder.build({ argv, cwd })
+
+      // Assert
+      expect(featurePaths).to.eql([])
+      expect(pickleFilterOptions.featurePaths).to.eql([])
+      expect(supportCodePaths).to.eql([])
+    })
+  })
+
+  describe('path to an rerun file with new line', () => {
+    it('returns empty featurePaths and support code paths', async function () {
+      // Arrange
+      const cwd = await buildTestWorkingDirectory()
+
+      const relativeRerunPath = '@empty_rerun.txt'
+      const rerunPath = path.join(cwd, '@empty_rerun.txt')
+      await fsExtra.outputFile(rerunPath, '\n')
+      const argv = baseArgv.concat([relativeRerunPath])
+
+      // Act
+      const {
+        featurePaths,
+        pickleFilterOptions,
+        supportCodePaths,
+      } = await ConfigurationBuilder.build({ argv, cwd })
+
+      // Assert
+      expect(featurePaths).to.eql([])
+      expect(pickleFilterOptions.featurePaths).to.eql([])
+      expect(supportCodePaths).to.eql([])
+    })
+  })
+
+  describe('path to a rerun file with one new line character', () => {
+    it('returns empty featurePaths and support code paths', async function () {
+      // Arrange
+      const cwd = await buildTestWorkingDirectory()
+
+      const relativeRerunPath = '@empty_rerun.txt'
+      const rerunPath = path.join(cwd, '@empty_rerun.txt')
+      await fsExtra.outputFile(rerunPath, '\n\n')
+      const argv = baseArgv.concat([relativeRerunPath])
+
+      // Act
+      const {
+        featurePaths,
+        pickleFilterOptions,
+        supportCodePaths,
+      } = await ConfigurationBuilder.build({ argv, cwd })
+
+      // Assert
+      expect(featurePaths).to.eql([])
+      expect(pickleFilterOptions.featurePaths).to.eql([])
+      expect(supportCodePaths).to.eql([])
+    })
+  })
+
   describe('formatters', () => {
     it('adds a default', async function () {
       // Arrange

src/cli/index.ts

@@ -208,14 +208,18 @@ export default class Cli {
         relativeTo: this.cwd,
       }
     )
-    const pickleIds = await parseGherkinMessageStream({
-      cwd: this.cwd,
-      eventBroadcaster,
-      eventDataCollector,
-      gherkinMessageStream,
-      order: configuration.order,
-      pickleFilter: new PickleFilter(configuration.pickleFilterOptions),
-    })
+    let pickleIds: string[] = []
+
+    if (configuration.featurePaths.length > 0) {
+      pickleIds = await parseGherkinMessageStream({
+        cwd: this.cwd,
+        eventBroadcaster,
+        eventDataCollector,
+        gherkinMessageStream,
+        order: configuration.order,
+        pickleFilter: new PickleFilter(configuration.pickleFilterOptions),
+      })
+    }
     emitSupportCodeMessages({
       eventBroadcaster,
       supportCodeLibrary,