Replace cucumber-json-formatter with native components

This relates to #795, #827, #870, #966, #967.
badeball · Mar 26, 2023 · 1119d24 · 1119d24
1 parent 0fa9777
commit 1119d24
Show file tree

Hide file tree

Showing 30 changed files with 252 additions and 266 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -41,13 +41,10 @@ jobs:
       - name: Dependencies
         env:
           CYPRESS_INSTALL_BINARY: "0"
-          CUCUMBER_JSON_FORMATTER_URL: https://github.com/cucumber/common/releases/download/json-formatter%2Fgo%2Fv19.0.0/cucumber-json-formatter-linux-amd64
         run: |
           npm install --force && \
           npm install --no-save cypress@${{ matrix.cypress-version }} && \
-          env -u CYPRESS_INSTALL_BINARY npx cypress install && \
-          curl -L $CUCUMBER_JSON_FORMATTER_URL > /usr/bin/cucumber-json-formatter && \
-          chmod +x /usr/bin/cucumber-json-formatter
+          env -u CYPRESS_INSTALL_BINARY npx cypress install
       - name: Build
         run: npm run build
       - name: Test
@@ -75,13 +72,7 @@ jobs:
           key: cypress-windows
       - name: Dependencies
         shell: bash
-        env:
-          CUCUMBER_JSON_FORMATTER_URL: https://github.com/cucumber/common/releases/download/json-formatter%2Fgo%2Fv19.0.0/cucumber-json-formatter-windows-amd64
-        run: |
-          npm install
-          curl -L $CUCUMBER_JSON_FORMATTER_URL > cucumber-json-formatter.exe
-          chmod +x ./cucumber-json-formatter.exe
-          echo $GITHUB_WORKSPACE >> $GITHUB_PATH
+        run: npm install
       - name: Build
         run: npm run build
       # https://github.com/webpack/webpack/issues/12759

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,8 @@ All notable changes to this project will be documented in this file.
 
 - Correctly set `willBeRetried` in messages reports, fixes [#849](https://github.com/badeball/cypress-cucumber-preprocessor/issues/849).
 
+- Replace [cucumber-json-formatter](https://github.com/cucumber/json-formatter) with native components, relates to [#795](https://github.com/badeball/cypress-cucumber-preprocessor/issues/795), [#827](https://github.com/badeball/cypress-cucumber-preprocessor/issues/827), [#870](https://github.com/badeball/cypress-cucumber-preprocessor/issues/870), [#966](https://github.com/badeball/cypress-cucumber-preprocessor/issues/966) and [#967](https://github.com/badeball/cypress-cucumber-preprocessor/issues/967).
+
 ## v15.1.5
 
 - Correctly escape injected values to glob patterns, fixes [#946](https://github.com/badeball/cypress-cucumber-preprocessor/issues/946).

diff --git a/docs/configuration.md b/docs/configuration.md
@@ -59,8 +59,6 @@ Every configuration option has a similar key which can be use to override it, sh
 | `messages.enabled` | `messagesEnabled` | `true`, `false`                          |
 | `messages.output`  | `messagesOutput`  | `cucumber-messages.ndjson`               |
 | `json.enabled`     | `jsonEnabled`     | `true`, `false`                          |
-| `json.formatter`   | `jsonFormatter`   | `/usr/bin/cucumber-json-formatter`       |
-| `json.args     `   | `jsonArgs     `   | `["custom-json-formatter.js"]`           |
 | `json.output`      | `jsonOutput`      | `cucumber-report.json`                   |
 | `html.enabled`     | `htmlEnabled`     | `true`, `false`                          |
 | `html.output`      | `htmlOutput`      | `cucumber-report.html`                   |

diff --git a/docs/faq.md b/docs/faq.md
@@ -2,7 +2,6 @@
 
 * [`--env` / `tags` isn't picked up](#--env--tags-isnt-picked-up)
 * [I get `fs_1.promises.rm is not a function`](#i-get-fs_1promisesrm-is-not-a-function)
-* [I get `spawn cucumber-json-formatter ENOENT`](#i-get-spawn-cucumber-json-formatter-enoent)
 * [Why is `cypress-tags` missing?](#why-is-cypress-tags-missing)
 * [My JSON report isn't generated](#my-json-report-isnt-generated)
 * [JSON reports aren't generated in open / interactive mode](#json-reports-arent-generated-in-open--interactive-mode)
@@ -18,10 +17,6 @@ This might be because you're trying to specify `-e / --env` multiple times, but
 
 Upgrade your node version to at least [v14.14.0](https://nodejs.org/api/fs.html#fspromisesrmpath-options).
 
-## I get `spawn cucumber-json-formatter ENOENT`
-
-You need to install `cucumber-json-formatter` **yourself**, as per [documentation](json-report.md).
-
 ## Why is `cypress-tags` missing?
 
 The `cypress-tags` executable has been removed and made redundant. Specs containing no matching scenarios are [automatically filtered](https://github.com/badeball/cypress-cucumber-preprocessor/blob/master/docs/tags.md#running-a-subset-of-scenarios), provided that `filterSpecs` is set to true.

diff --git a/docs/json-report.md b/docs/json-report.md
@@ -10,10 +10,6 @@ JSON reports can be enabled using the `json.enabled` property. The preprocessor
 }
 ```
 
-This **requires** you to have downloaded and installed the [cucumber-json-formatter](https://github.com/cucumber/json-formatter) **yourself**. Arch Linux users can install it from [AUR](https://aur.archlinux.org/packages/cucumber-json-formatter).
-
-The location of the executable is configurable through the `json.formatter` property, but it will by default search for `cucumber-json-formatter` in your `PATH`.
-
 The report is outputted to `cucumber-report.json` in the project directory, but can be configured through the `json.output` property.
 
 ## Screenshots
@@ -61,13 +57,3 @@ Given("a step", function() {
   attach("Zm9vYmFy", "base64:text/plain");
 });
 ```
-
-## Known issues
-
-Some issues with `cucumber-json-formatter` are known and don't need to be reported again.
-
-- Inaccurate output of `match` on undefined step definition (https://github.com/cucumber/json-formatter/issues/2)
-
-- Inaccurate output of retried scenarios (https://github.com/cucumber/json-formatter/issues/4)
-
-- Inaccurate output of scenario outlined with parameterized name (https://github.com/cucumber/json-formatter/issues/25)
diff --git a/features/attachments.feature b/features/attachments.feature
@@ -9,8 +9,10 @@ Feature: attachments
         }
       }
       """
-    And I've ensured cucumber-json-formatter is installed
 
+  # This test's result will likely change in the future, see
+  # https://github.com/cucumber/cucumber-js/issues/2260 and
+  # https://github.com/cucumber/cucumber-js/pull/2261
   Scenario: string identity
     Given a file named "cypress/e2e/a.feature" with:
       """
@@ -27,7 +29,7 @@ Feature: attachments
       """
     When I run cypress
     Then it passes
-    And there should be a JSON output similar to "fixtures/attachments/string.json"
+    And there should be a JSON output similar to "fixtures/attachments/string-literal.json"
 
   Scenario: array buffer
     Given a file named "cypress/e2e/a.feature" with:
@@ -45,7 +47,7 @@ Feature: attachments
       """
     When I run cypress
     Then it passes
-    And there should be a JSON output similar to "fixtures/attachments/string.json"
+    And there should be a JSON output similar to "fixtures/attachments/string-base64.json"
 
   Scenario: string encoded
     Given a file named "cypress/e2e/a.feature" with:
@@ -64,4 +66,4 @@ Feature: attachments
       """
     When I run cypress
     Then it passes
-    And there should be a JSON output similar to "fixtures/attachments/string.json"
+    And there should be a JSON output similar to "fixtures/attachments/string-base64.json"
diff --git a/features/fixtures/attachments/screenshot.json b/features/fixtures/attachments/screenshot.json
@@ -10,6 +10,7 @@
         "name": "a scenario",
         "steps": [
           {
+            "arguments": [],
             "keyword": "Given ",
             "line": 3,
             "name": "a step",
@@ -28,13 +29,15 @@
             ]
           }
         ],
+        "tags": [],
         "type": "scenario"
       }
     ],
     "id": "a-feature",
     "keyword": "Feature",
     "line": 1,
     "name": "a feature",
+    "tags": [],
     "uri": "cypress/e2e/a.feature"
   }
 ]
diff --git a/features/fixtures/attachments/screenshot.ndjson b/features/fixtures/attachments/screenshot.ndjson
@@ -5,7 +5,7 @@
 {"stepDefinition":{"id":"id","pattern":{"source":"a step","type":"CUCUMBER_EXPRESSION"},"sourceReference":{"uri":"not available","location":{"line":0}}}}
 {"testCase":{"id":"id","pickleId":"id","testSteps":[{"id":"id","pickleStepId":"id","stepDefinitionIds":["id"]}]}}
 {"testCaseStarted":{"id":"id","testCaseId":"id","attempt":0,"timestamp":{"seconds":0,"nanos":0}}}
-{"attachment":{"testStepId":"id","body":"iVBORw0KGgoAAAANSUhEUgAAABQAAAAUCAYAAACNiR0NAAAAM0lEQVR4Aa3BAQEAAAiDMKR/51uC7QYjJDGJSUxiEpOYxCQmMYlJTGISk5jEJCYxiUnsARwEAibDACoRAAAAAElFTkSuQmCC","mediaType":"image/png","contentEncoding":"BASE64"}}
+{"attachment":{"testCaseStartedId": "id", "testStepId":"id","body":"iVBORw0KGgoAAAANSUhEUgAAABQAAAAUCAYAAACNiR0NAAAAM0lEQVR4Aa3BAQEAAAiDMKR/51uC7QYjJDGJSUxiEpOYxCQmMYlJTGISk5jEJCYxiUnsARwEAibDACoRAAAAAElFTkSuQmCC","mediaType":"image/png","contentEncoding":"BASE64"}}
 {"testStepStarted":{"testStepId":"id","testCaseStartedId":"id","timestamp":{"seconds":0,"nanos":0}}}
 {"testStepFinished":{"testStepId":"id","testCaseStartedId":"id","testStepResult":{"status":"PASSED","duration":0},"timestamp":{"seconds":0,"nanos":0}}}
 {"testCaseFinished":{"testCaseStartedId":"id","timestamp":{"seconds":0,"nanos":0},"willBeRetried":false}}

diff --git a/features/fixtures/attachments/string.json → ...s/fixtures/attachments/string-base64.json b/features/fixtures/attachments/string.json → ...s/fixtures/attachments/string-base64.json
@@ -10,6 +10,7 @@
         "name": "a scenario",
         "steps": [
           {
+            "arguments": [],
             "keyword": "Given ",
             "line": 3,
             "name": "a step",
@@ -28,13 +29,15 @@
             ]
           }
         ],
+        "tags": [],
         "type": "scenario"
       }
     ],
     "id": "a-feature",
     "keyword": "Feature",
     "line": 1,
     "name": "a feature",
+    "tags": [],
     "uri": "cypress/e2e/a.feature"
   }
 ]
diff --git a/features/fixtures/retried.json → .../fixtures/attachments/string-literal.json b/features/fixtures/retried.json → .../fixtures/attachments/string-literal.json
@@ -10,28 +10,7 @@
         "name": "a scenario",
         "steps": [
           {
-            "keyword": "Given ",
-            "line": 3,
-            "name": "a step",
-            "result": {
-              "status": "failed",
-              "error_message": "some error"
-            },
-            "match": {
-              "location": "not available:0"
-            }
-          }
-        ],
-        "type": "scenario"
-      },
-      {
-        "description": "",
-        "id": "a-feature;a-scenario",
-        "keyword": "Scenario",
-        "line": 2,
-        "name": "a scenario",
-        "steps": [
-          {
+            "arguments": [],
             "keyword": "Given ",
             "line": 3,
             "name": "a step",
@@ -41,16 +20,24 @@
             },
             "match": {
               "location": "not available:0"
-            }
+            },
+            "embeddings": [
+              {
+                "data": "foobar",
+                "mime_type": "text/plain"
+              }
+            ]
           }
         ],
+        "tags": [],
         "type": "scenario"
       }
     ],
     "id": "a-feature",
     "keyword": "Feature",
     "line": 1,
     "name": "a feature",
+    "tags": [],
     "uri": "cypress/e2e/a.feature"
   }
 ]
diff --git a/features/fixtures/failing-after.json b/features/fixtures/failing-after.json
@@ -10,6 +10,7 @@
         "name": "a scenario",
         "steps": [
           {
+            "arguments": [],
             "keyword": "Given ",
             "line": 3,
             "name": "a step",
@@ -20,26 +21,26 @@
             "match": {
               "location": "not available:0"
             }
-          }
-        ],
-        "after": [
+          },
           {
+            "keyword": "After",
+            "hidden": true,
             "result": {
               "status": "failed",
+              "duration": 0,
               "error_message": "some error"
-            },
-            "match": {
-              "location": "not available:0"
             }
           }
         ],
+        "tags": [],
         "type": "scenario"
       }
     ],
     "id": "a-feature",
     "keyword": "Feature",
     "line": 1,
     "name": "a feature",
+    "tags": [],
     "uri": "cypress/e2e/a.feature"
   }
 ]
diff --git a/features/fixtures/failing-before.json b/features/fixtures/failing-before.json
@@ -8,37 +8,39 @@
         "keyword": "Scenario",
         "line": 2,
         "name": "a scenario",
-        "before": [
+        "steps": [
           {
+            "keyword": "Before",
+            "hidden": true,
             "result": {
               "status": "failed",
+              "duration": 0,
               "error_message": "some error"
-            },
-            "match": {
-              "location": "not available:0"
             }
-          }
-        ],
-        "steps": [
+          },
           {
+            "arguments": [],
             "keyword": "Given ",
             "line": 3,
             "name": "a step",
             "result": {
-              "status": "skipped"
+              "status": "skipped",
+              "duration": 0
             },
             "match": {
               "location": "not available:0"
             }
           }
         ],
+        "tags": [],
         "type": "scenario"
       }
     ],
     "id": "a-feature",
     "keyword": "Feature",
     "line": 1,
     "name": "a feature",
+    "tags": [],
     "uri": "cypress/e2e/a.feature"
   }
 ]
diff --git a/features/fixtures/failing-step.json b/features/fixtures/failing-step.json
@@ -10,36 +10,42 @@
         "name": "a scenario",
         "steps": [
           {
+            "arguments": [],
             "keyword": "Given ",
             "line": 3,
             "name": "a failing step",
             "result": {
               "status": "failed",
+              "duration": 0,
               "error_message": "some error"
             },
             "match": {
               "location": "not available:0"
             }
           },
           {
+            "arguments": [],
             "keyword": "And ",
             "line": 4,
             "name": "another step",
             "result": {
-              "status": "skipped"
+              "status": "skipped",
+              "duration": 0
             },
             "match": {
               "location": "not available:0"
             }
           }
         ],
+        "tags": [],
         "type": "scenario"
       }
     ],
     "id": "a-feature",
     "keyword": "Feature",
     "line": 1,
     "name": "a feature",
+    "tags": [],
     "uri": "cypress/e2e/a.feature"
   }
 ]