Merge pull request #161 from Breeding-Insight/feature/BI-2502

Feature/bi 2502

Author: cvacalares

.github/workflows/daily-test.yml

@@ -159,6 +159,9 @@ jobs:
         if: (github.event.inputs.suite=='smoke')
         run: npm run test:chromeDaily
 
+      - name: Run HTML Report generator
+        run: npm run report
+
       - name: Publish Report Artifact
         uses: actions/upload-artifact@v4
         if: always()

.github/workflows/test-branch.yml

@@ -173,6 +173,9 @@ jobs:
         if: (github.event.inputs.suite=='smoke')
         run: npm run test:chromeDaily
 
+      - name: Run HTML Report generator
+        run: npm run report
+
       - id: biWebBranch
         run: INPUT=${{ github.event.inputs.biweb }} && echo "::set-output name=branch::${INPUT/\//-}"
 

.vscode/launch.json

@@ -1,27 +1,24 @@
 {
-  // Use IntelliSense to learn about possible attributes.
-  // Hover to view descriptions of existing attributes.
-  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
   "version": "0.2.0",
   "configurations": [
     {
       "type": "node",
       "request": "launch",
-      "name": "Debug",
+      "name": "Debug Cucumber Tests",
       "program": "${workspaceRoot}/node_modules/@cucumber/cucumber/bin/cucumber-js",
       "args": [
-        "${workspaceRoot}/src/features",
-        "--require",
-        "cucumber.conf.js",
-        "--require",
-        "src/step_definitions",
-        "--world-parameters",
-        "{\"browser\":\"chrome\",\"launch_url\":\"http://localhost\"}",
-        "--format",
-        "json:report/cucumber_report.json",
-        "--tags",
-        "@debug"
-      ]
+        "--require", "cucumber.conf.js",
+        "--require", "src/step_definitions",
+        "src/features",
+        "--format", "json:report/cucumber_report.json",
+        "--tags", "@debug"
+      ],
+      "console": "integratedTerminal",
+      "skipFiles": ["<node_internals>/**"],
+      "env": {
+        "NODE_ENV": "test"
+      },
+      "runtimeArgs": ["--inspect-brk"]
     }
   ]
-}
+}

cucumber.conf.js

@@ -1,82 +1,120 @@
-const fs = require("fs");
+const Nightwatch = require("nightwatch");
 const {
-  setDefaultTimeout,
   After,
   AfterAll,
-  BeforeAll,
   Before,
+  setDefaultTimeout,
 } = require("@cucumber/cucumber");
-const {
-  createSession,
-  closeSession,
-  startWebDriver,
-  stopWebDriver,
-  getNewScreenshots,
-  saveScreenshot,
-} = require("nightwatch-api");
+const fs = require("fs");
+const fsPromises = fs.promises;
+const path = require("path");
+const os = require("os");
 const reporter = require("cucumber-html-reporter");
-const { client } = require("nightwatch-api");
-const run = {
-  browserName: "",
-  platform: "",
-  version: "",
-  BreedingInsight: "",
-};
-
-setDefaultTimeout(600000);
-global.__basedir = __dirname;
-
-Before(async function () {
-  await createSession({ env: this.parameters.browser });
-  await client.resizeWindow(1900, 1200);
-  this.parameters.timeStamp = Date.now();
-  if (process.env.npm_config_url != undefined) {
-    this.parameters.launch_url = process.env.npm_config_url;
+
+require("events").EventEmitter.defaultMaxListeners = 20;
+setDefaultTimeout(300000);
+
+Before(async function ({ pickle }) {
+  fs.mkdirSync("report", { recursive: true });
+  fs.mkdirSync("screenshots", { recursive: true });
+
+  this.tmpUserDataDir = fs.mkdtempSync(
+    path.join(os.tmpdir(), "nw-chrome-profile-")
+  );
+  console.log("tmpUserDataDir:", this.tmpUserDataDir);
+
+  const chromeArgs = [
+    "--no-sandbox",
+    "--disable-dev-shm-usage",
+    "--disable-extensions",
+    "--disable-gpu",
+    "--disable-background-networking",
+    "--disable-sync",
+    "--metrics-recording-only",
+    "--disable-default-apps",
+    "--mute-audio",
+    "--no-first-run",
+    "--ignore-certificate-errors",
+    "--allow-insecure-localhost",
+    "--window-size=1920,1080",
+    "--headless=new",
+  ];
+
+  const webdriver = {};
+  if (this.parameters["webdriver-host"])
+    webdriver.host = this.parameters["webdriver-host"];
+  if (this.parameters["webdriver-port"])
+    webdriver.port = this.parameters["webdriver-port"];
+  if (typeof this.parameters["start-process"] !== "undefined")
+    webdriver.start_process = this.parameters["start-process"];
+
+  const globals = {};
+  if (this.parameters["retry-interval"]) {
+    globals.waitForConditionPollInterval = this.parameters["retry-interval"];
   }
-});
 
-BeforeAll(async () => {
-  await startWebDriver();
-});
+  this.client = Nightwatch.createClient({
+    headless: this.parameters.headless,
+    env: this.parameters.env,
+    timeout: this.parameters.timeout,
+    parallel: !!this.parameters.parallel,
+    output: !this.parameters["disable-output"],
+    enable_global_apis: true,
+    silent: !this.parameters.verbose,
+    always_async_commands: true,
+    webdriver,
+    persist_globals: this.parameters["persist-globals"],
+    config: this.parameters.config,
+    globals: {
+      run: {},
+    },
+    desiredCapabilities: {
+      browserName: "chrome",
+      "goog:chromeOptions": {
+        args: chromeArgs,
+      },
+    },
+  });
 
-AfterAll(async () => {
-  run.browserName = client.capabilities.browserName;
-  switch (client.capabilities.browserName) {
-    case "msedge": //same as chrome
-    case "chrome-headless-shell":
-    case "chrome":
-      run.version = client.capabilities.version;
-      run.platform = client.capabilities.platform;
-      break;
-    case "firefox":
-      run.version = client.capabilities.browserVersion;
-      run.platform = client.capabilities.platformName;
-      break;
-    default:
-      throw new Error("Unrecognized browser.");
+  if (this.client.settings.sync_test_names) {
+    this.client.updateCapabilities({ name: pickle.name });
   }
-  await stopWebDriver();
 
-  // convert JSON object to string
-  const data = JSON.stringify(run);
+  console.log("Launching Chrome with args: ", chromeArgs);
+  console.log("Executing test : " + pickle.name);
 
-  // write JSON string to a file
-  fs.writeFile("run.json", data, (err) => {
-    if (err) {
-      throw err;
-    }
-    console.log("JSON data is saved.");
-  });
+  this.browser = await this.client.launchBrowser();
+  this.browser.globals.timestamp = Date.now();
 });
 
-After(function () {
-  if (run.BreedingInsight == "") {
-    run.BreedingInsight = client.globals.breedingInsightVersion;
+After(async function (testCase) {
+  if (testCase.result.status === "FAILED" && this.browser) {
+    const filename = `screenshots/${testCase.pickle.name}-${Date.now()}.png`;
+    await this.browser.saveScreenshot(filename);
+    this.attach(fs.readFileSync(filename), "image/png");
   }
-  
-  getNewScreenshots().forEach((file) =>
-    this.attach(fs.readFileSync(file), "image/png")
-  );
-  //Note: The following line can be commented out to keep browsers open for debugging purposes on local
-  closeSession();
-});
+
+  if (this.browser) {
+    await this.browser.quit();
+  }
+
+  if (this.tmpUserDataDir) {
+    fs.rmSync(this.tmpUserDataDir, { recursive: true, force: true });
+  }
+
+  if (!this.browser?.globals?.run?.browserName) {
+    const caps = this.browser.capabilities;
+    const globalsRun = this.browser.globals.run;
+
+    globalsRun.browserName = caps.browserName;
+    globalsRun.version = caps.browserVersion;
+    globalsRun.platform = caps.platformName;
+
+    try {
+      await fsPromises.writeFile("report/run.json", JSON.stringify(globalsRun));
+      console.log("Saved run metadata.");
+    } catch (err) {
+      console.error("Error saving run metadata:", err);
+    }
+  }
+});