fixed release workflow and added cypress example

Author: WasiqB

.github/workflows/release.yml

@@ -43,4 +43,4 @@ jobs:
       - name: Release
         run: npm run release.ci -- ${{github.event.inputs.releaseType}}
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.PUSH_TOKEN }}

.gitignore

@@ -7,3 +7,8 @@ reports/
 .DS_Store
 yarn.lock
 *.tgz
+
+videos/
+screenshots/
+downloads/
+*.ndjson

examples/cypress/.cypress-cucumber-preprocessorrc.json

@@ -0,0 +1,9 @@
+{
+  "json": {
+    "enabled": true
+  },
+  "messages": {
+    "enabled": false
+  },
+  "stepDefinitions": ["cypress/e2e/[filepath].step.{js,ts}"]
+}

examples/cypress/cucumber-html-report.js

@@ -0,0 +1,73 @@
+const report = require("multiple-cucumber-html-reporter");
+const dayjs = require("dayjs");
+const fs = require("fs");
+
+const data = fs.readFileSync("./reports/cypress-report.json", {
+  encoding: "utf8",
+  flag: "r",
+});
+const runInfo = JSON.parse(data);
+
+const osName = () => {
+  switch (runInfo["osName"]) {
+    case "win32":
+      return "windows";
+    case "linux":
+      return "ubuntu";
+    default:
+      console.log("Undefined OS");
+  }
+};
+
+const browserName = () => {
+  switch (runInfo["browserName"]) {
+    case "chrome":
+      return "Chrome";
+    case "firefox":
+      return "Firefox";
+    case "edge":
+      return "Edge";
+    case "webkit":
+      return "Safari";
+    default:
+      console.log("Undefined Browser");
+  }
+};
+
+report.generate({
+  jsonDir: "./reports/cucumber-json",
+  reportPath: "./reports",
+  metadata: {
+    browser: {
+      name: browserName(),
+      version: runInfo["browserVersion"],
+    },
+    platform: {
+      name: osName(),
+      version: runInfo["osVersion"],
+    },
+  },
+  customData: {
+    title: "Run Info",
+    data: [
+      { label: "Project", value: "Sample " },
+      { label: "Release", value: "1.0.0" },
+      { label: "Cypress Version", value: runInfo["cypressVersion"] },
+      { label: "Node Version", value: runInfo["nodeVersion"] },
+      {
+        label: "Execution Start Time",
+        value: dayjs(runInfo["startedTestsAt"]).format(
+          "YYYY-MM-DD HH:mm:ss.SSS"
+        ),
+      },
+      {
+        label: "Execution End Time",
+        value: dayjs(runInfo["endedTestsAt"]).format("YYYY-MM-DD HH:mm:ss.SSS"),
+      },
+    ],
+  },
+  pageTitle: "Sample",
+  reportName: "Sample",
+  displayDuration: true,
+  displayReportTime: true,
+});

examples/cypress/cypress.config.js

@@ -0,0 +1,73 @@
+const { defineConfig } = require("cypress");
+const fs = require("fs");
+const preprocessor = require("@badeball/cypress-cucumber-preprocessor");
+const browserify = require("@badeball/cypress-cucumber-preprocessor/browserify");
+
+function createReportJsonMeta(results) {
+  fs.writeFileSync(
+    "./reports/generated/results.json",
+    JSON.stringify(
+      {
+        browserName: results.browserName,
+        browserVersion: results.browserVersion,
+        osName: results.osName,
+        osVersion: results.osVersion,
+        nodeVersion: results.config.resolvedNodeVersion,
+        cypressVersion: results.cypressVersion,
+        startedTestsAt: results.startedTestsAt,
+        endedTestsAt: results.endedTestsAt,
+      },
+      null,
+      "\t"
+    )
+  );
+}
+async function setupNodeEvents(on, config) {
+  await preprocessor.addCucumberPreprocessorPlugin(on, config);
+
+  on("file:preprocessor", browserify.default(config));
+  on("after:run", async (results) => {
+    if (results) {
+      createReportJsonMeta(results);
+      let sourcePath = "./reports/cucumber-json";
+      let oldExtension = "cucumber.json";
+      let newExtension =
+        results.browserName + "." + new Date().getTime() + ".json";
+      fs.readdir(sourcePath, (err, files) => {
+        if (err) {
+          cy.log("Issue in the file reading");
+          return;
+        }
+
+        files.forEach((file) => {
+          const oldFilePath = `${sourcePath}/${file}`;
+
+          if (file.endsWith(`.${oldExtension}`)) {
+            const newFilePath = `${sourcePath}/${file.replace(
+              `.${oldExtension}`,
+              `.${newExtension}`
+            )}`;
+            fs.rename(oldFilePath, newFilePath, (err) => {
+              if (err) {
+                cy.log("Issue in the file renaming");
+              }
+            });
+          }
+        });
+      });
+    }
+  });
+
+  return config;
+}
+
+module.exports = defineConfig({
+  e2e: {
+    specPattern: "cypress/e2e/**/*.feature",
+    setupNodeEvents,
+    defaultCommandTimeout: 60000,
+    pageLoadTimeout: 60000,
+    video: false,
+    reporter: "json",
+  },
+});

examples/cypress/cypress/e2e/gmail/gmail.feature

@@ -0,0 +1,6 @@
+Feature: Gmail Opening
+
+  Scenario: Gmail
+
+    Given I open the gmail
+

examples/cypress/cypress/e2e/gmail/gmail.step.js

@@ -0,0 +1,7 @@
+/// <reference types="Cypress"/>
+
+import { Given } from "@badeball/cypress-cucumber-preprocessor";
+
+Given("I open the gmail", function () {
+  cy.visit("https://mail.google.com");
+});

examples/cypress/cypress/e2e/google/google.feature

@@ -0,0 +1,6 @@
+Feature: Google Opening
+
+  Scenario: Google
+
+    Given I open the google
+

examples/cypress/cypress/e2e/google/google.step.js

@@ -0,0 +1,9 @@
+/// <reference types="cypress" />
+
+import { Given } from "@badeball/cypress-cucumber-preprocessor";
+
+// Import the necessary modules
+
+Given("I open the google", function () {
+  cy.visit("https://www.google.co.in");
+});

examples/cypress/cypress/fixtures/example.json

@@ -0,0 +1,5 @@
+{
+  "name": "Using fixtures to represent data",
+  "email": "[email protected]",
+  "body": "Fixtures are a great way to mock data for responses to routes"
+}