Linting and formatting fixes for test files (#2739)

* Fix type issues * Remove for each loops * Fix no assignment in expression * Ignore testing delete rules * Strongly type paramaters --------- Signed-off-by: Zabil Cheriya Maliackal <[email protected]>
getgauge · Aug 29, 2024 · 052d9ca · 052d9ca
1 parent 0016486
commit 052d9ca
Show file tree

Hide file tree

Showing 58 changed files with 329 additions and 321 deletions.
diff --git a/biome.jsonc b/biome.jsonc
@@ -9,7 +9,6 @@
       "reports",
       ".gauge",
       "examples",
-      "test",
       ".local-chromium",
       "types",
       "lib/api.json"

diff --git a/test/docs-tests/gauge/tests/assert.ts b/test/docs-tests/gauge/tests/assert.ts
@@ -1,4 +1,4 @@
-const assert = require("assert");
+const assert = require("node:assert");
 import { Step, type Table } from "gauge-ts";
 import { below, evaluate, text, textBox, title, toLeftOf } from "taiko";
 import { getElements } from "./selectors";

diff --git a/test/docs-tests/gauge/tests/hooks.ts b/test/docs-tests/gauge/tests/hooks.ts
@@ -1,4 +1,4 @@
-import { basename, join } from "path";
+import { basename, join } from "node:path";
 import {
   AfterScenario,
   AfterSuite,
@@ -26,7 +26,7 @@ export default class Hooks {
   @CustomScreenshotWriter()
   public async takeScreenshot(): Promise<string> {
     const fileName = join(
-      process.env["gauge_screenshots_dir"],
+      process.env.gauge_screenshots_dir,
       `screenshot${Date.now()}.png`,
     );
     await screenshot({ path: fileName });

diff --git a/test/docs-tests/gauge/tests/htmlElementAPI.ts b/test/docs-tests/gauge/tests/htmlElementAPI.ts
@@ -1,5 +1,5 @@
-import assert = require("assert");
-import _path = require("path");
+import assert = require("node:assert");
+import _path = require("node:path");
 import {
   $,
   type DialogHandler,
@@ -40,8 +40,8 @@ export default class HtmlElementAPI {
   @Step("Navigate to <url> with basic auth <username> and <password>")
   public async navigateWithBasicAuth(
     url: string,
-    username: any,
-    password: any,
+    username: string,
+    password: string,
   ) {
     const encodedCredentials = Buffer.from(`${username}:${password}`).toString(
       "base64",
@@ -63,7 +63,7 @@ export default class HtmlElementAPI {
   public async selectDropDownValue(
     value: string | number,
     dropDownName: string,
-    fieldValue: any,
+    fieldValue: string,
   ) {
     const box = dropDown(dropDownName);
     await box.select(value);
@@ -99,7 +99,7 @@ export default class HtmlElementAPI {
   }
 
   @Step("Get value <text> of Text Box <textBoxName>")
-  public async getTextboxValue(text: any, textBoxName: string) {
+  public async getTextboxValue(text: string, textBoxName: string) {
     const field = textBox(textBoxName);
     assert.equal(await field.value(), text);
   }
@@ -111,17 +111,17 @@ export default class HtmlElementAPI {
   }
 
   @Step("Write <text> into Text Box <textBoxName>")
-  public async writeInto(text: string, textBoxName: any) {
+  public async writeInto(text: string, textBoxName: string) {
     await write(text, into(textBoxName));
   }
 
   @Step("Write <text> into TextBox with name <textboxName>")
-  public async writeWithName(text: string, textBoxName: any) {
+  public async writeWithName(text: string, textBoxName: string) {
     await write(text, into(textBox({ name: textBoxName })));
   }
 
   @Step("Write <text> to Text Box <textBoxName>")
-  public async writeTo(text: string, textBoxName: any) {
+  public async writeTo(text: string, textBoxName: string) {
     await write(text, to(textBoxName));
   }
 
@@ -169,7 +169,7 @@ export default class HtmlElementAPI {
   }
 
   @Step("Respond to <url> with <responseBody>")
-  public async interceptResponse(url: string, responseBody: any) {
+  public async interceptResponse(url: string, responseBody: string) {
     await intercept(url, { body: responseBody });
   }
 
@@ -179,7 +179,7 @@ export default class HtmlElementAPI {
   }
 
   @Step("Intercept <url> and continue with postData <mockData>")
-  public async interceptRequest(url: string, mockData: any) {
+  public async interceptRequest(url: string, mockData: string) {
     await intercept(url, (request) => {
       request.continue({ postData: mockData });
     });
@@ -188,15 +188,14 @@ export default class HtmlElementAPI {
   @Step("Navigate to relative path <relativePath>")
   public async navigateToPath(relativePath: string) {
     const absolutePath = _path.resolve(relativePath);
-    await goto("file:///" + absolutePath);
+    await goto(`file:///${absolutePath}`);
   }
 
   @Step("Navigate to relative API reference page for <functionName>")
   public async navigateToApiRefPage(functionName: string) {
-    const relativePath =
-      "../tmp/docs/_site/api/" + functionName + "/index.html";
+    const relativePath = `../tmp/docs/_site/api/${functionName}/index.html`;
     const absolutePath = _path.resolve(relativePath);
-    await goto("file:///" + absolutePath);
+    await goto(`file:///${absolutePath}`);
   }
 
   @ContinueOnFailure()
@@ -259,15 +258,15 @@ export default class HtmlElementAPI {
   }
 
   @Step("Navigate to relative path <path> with timeout <timeout> ms")
-  public async navigateToPathWithTimeout(path: string, timeout: any) {
+  public async navigateToPathWithTimeout(path: string, timeout: number) {
     const absolutePath = _path.resolve(path);
-    await goto("file:///" + absolutePath, {
+    await goto(`file:///${absolutePath}`, {
       navigationTimeout: timeout,
     });
   }
 
   @Step("Navigate to <url> with timeout <timeout> ms")
-  public async navigateToURLWithTimeout(url: string, timeout: any) {
+  public async navigateToURLWithTimeout(url: string, timeout: number) {
     await goto(url, { navigationTimeout: timeout });
   }
 

diff --git a/test/docs-tests/gauge/tests/selectors.ts b/test/docs-tests/gauge/tests/selectors.ts
@@ -3,6 +3,7 @@ import { $, button, link, text, textBox } from "taiko";
 
 function getElementWithSelector(element: string, selector: string) {
   let selectedElement = null;
+  // biome-ignore lint: Required for testing
   let selectedItem;
   try {
     selectedItem = JSON.parse(selector);
@@ -32,10 +33,10 @@ function getElementWithSelector(element: string, selector: string) {
 export function getElements(table: Table) {
   const referenceElements = [];
   const headers = table.getColumnNames();
-  table.getTableRows().forEach((row) => {
+  for (const row of table.getTableRows()) {
     referenceElements.push(
       getElementWithSelector(row.getCell(headers[0]), row.getCell(headers[1])),
     );
-  });
+  }
   return referenceElements;
 }
diff --git a/test/docs-tests/prepare.js b/test/docs-tests/prepare.js
@@ -2,9 +2,9 @@ const chai = require("chai");
 // const expect = chai.expect;
 const chaiAsPromised = require("chai-as-promised");
 chai.use(chaiAsPromised);
-const fs = require("fs");
-const util = require("util");
-const path = require("path");
+const fs = require("node:fs");
+const util = require("node:util");
+const path = require("node:path");
 const { jsDocToJson } = require("../../lib/documentation");
 const _ncp = require("ncp").ncp;
 _ncp.limit = 16;

diff --git a/test/functional-tests/tests/alert.ts b/test/functional-tests/tests/alert.ts
@@ -1,7 +1,7 @@
 // eslint-disable-next-line no-unused-vars
 import { type DataStore, DataStoreFactory, Step } from "gauge-ts";
 import { accept, alert, prompt } from "taiko";
-const assert = require("assert");
+const assert = require("node:assert");
 const scenarioStore: DataStore = DataStoreFactory.getSpecDataStore();
 
 export default class Alert {

diff --git a/test/functional-tests/tests/assert.ts b/test/functional-tests/tests/assert.ts
@@ -1,4 +1,4 @@
-const assert = require("assert");
+const assert = require("node:assert");
 import { Step, type Table } from "gauge-ts";
 import { evaluate, text, textBox, title, toLeftOf } from "taiko";
 import { getElements } from "./selectors";

diff --git a/test/functional-tests/tests/browserAction.ts b/test/functional-tests/tests/browserAction.ts
@@ -15,7 +15,7 @@ import {
   setLocation,
   switchTo,
 } from "taiko";
-const assert = require("assert");
+const assert = require("node:assert");
 const cwd = process.cwd();
 
 export default class Assert {
@@ -80,7 +80,7 @@ export default class Assert {
 
   @Step("Navigate to file with relative Path <filePath>")
   public async navigateToFileWithRelativePath(filePath: string) {
-    await goto("file:///" + cwd + filePath);
+    await goto(`file:///${cwd}${filePath}`);
   }
 
   @Step("Override browser permission with <geolocation> for site <url>")
@@ -98,7 +98,7 @@ export default class Assert {
 
   @Step("Assert location longitude as <longitude> and latitude as <latitude>")
   public async function(longitude: string, latitude: string) {
-    const geolocation: any = await evaluate(
+    const geolocation = (await evaluate(
       () =>
         new Promise((resolve) =>
           navigator.geolocation.getCurrentPosition((position) => {
@@ -108,7 +108,7 @@ export default class Assert {
             });
           }),
         ),
-    );
+    )) as { latitude: number; longitude: number };
     assert.equal(geolocation.longitude, Number.parseFloat(longitude));
     assert.equal(geolocation.latitude, Number.parseFloat(latitude));
   }
@@ -119,7 +119,7 @@ export default class Assert {
   }
 
   @Step("Assert width is <width> and height is <height>")
-  public async assertWidthAndHeight(width: any, height: any) {
+  public async assertWidthAndHeight(width: number, height: number) {
     const innerWidth = await evaluate(() => window.innerWidth);
     const innerHeight = await evaluate(() => window.innerHeight);
     assert.equal(innerWidth, width);

diff --git a/test/functional-tests/tests/dropDown.ts b/test/functional-tests/tests/dropDown.ts
@@ -1,4 +1,4 @@
-const assert = require("assert");
+const assert = require("node:assert");
 import { getElements } from "./selectors";
 
 import { Step, type Table } from "gauge-ts";

diff --git a/test/functional-tests/tests/hooks.ts b/test/functional-tests/tests/hooks.ts
@@ -1,4 +1,4 @@
-import { basename, join } from "path";
+import { basename, join } from "node:path";
 import {
   AfterScenario,
   AfterSuite,
@@ -37,7 +37,7 @@ export default class Hooks {
   @CustomScreenshotWriter()
   public async takeScreenshot(): Promise<string> {
     const fileName = join(
-      process.env["gauge_screenshots_dir"],
+      process.env.gauge_screenshots_dir,
       `screenshot${Date.now()}.png`,
     );
     await screenshot({ path: fileName });

diff --git a/test/functional-tests/tests/htmlElementAPI.ts b/test/functional-tests/tests/htmlElementAPI.ts
@@ -1,5 +1,5 @@
-import assert = require("assert");
-import _path = require("path");
+import assert = require("node:assert");
+import _path = require("node:path");
 import {
   $,
   type DialogHandler,
@@ -41,8 +41,8 @@ export default class HtmlElementAPI {
   @Step("Navigate to <url> with basic auth <username> and <password>")
   public async navigateWithBasicAuth(
     url: string,
-    username: any,
-    password: any,
+    username: string,
+    password: string,
   ) {
     const encodedCredentials = Buffer.from(`${username}:${password}`).toString(
       "base64",
@@ -64,7 +64,7 @@ export default class HtmlElementAPI {
   public async selectDropDownValue(
     value: string | number,
     dropDownName: string,
-    fieldValue: any,
+    fieldValue: string,
   ) {
     const box = dropDown(dropDownName);
     await box.select(value);
@@ -119,7 +119,7 @@ export default class HtmlElementAPI {
   }
 
   @Step("Get value <text> of Text Box <textBoxName>")
-  public async getTextboxValue(text: any, textBoxName: string) {
+  public async getTextboxValue(text: string, textBoxName: string) {
     const field = textBox(textBoxName);
     assert.equal(await field.value(), text);
   }
@@ -131,17 +131,17 @@ export default class HtmlElementAPI {
   }
 
   @Step("Write <text> into Text Box <textBoxName>")
-  public async writeInto(text: string, textBoxName: any) {
+  public async writeInto(text: string, textBoxName: string) {
     await write(text, into(textBoxName));
   }
 
   @Step("Write <text> into TextBox with name <textboxName>")
-  public async writeWithName(text: string, textBoxName: any) {
+  public async writeWithName(text: string, textBoxName: string) {
     await write(text, into(textBox({ name: textBoxName })));
   }
 
   @Step("Write <text> to Text Box <textBoxName>")
-  public async writeTo(text: string, textBoxName: any) {
+  public async writeTo(text: string, textBoxName: string) {
     await write(text, to(textBoxName));
   }
 
@@ -189,7 +189,7 @@ export default class HtmlElementAPI {
   }
 
   @Step("Respond to <url> with <responseBody>")
-  public async interceptResponse(url: string, responseBody: any) {
+  public async interceptResponse(url: string, responseBody: string) {
     await intercept(url, { body: responseBody });
   }
 
@@ -199,7 +199,7 @@ export default class HtmlElementAPI {
   }
 
   @Step("Intercept <url> and continue with postData <mockData>")
-  public async interceptRequest(url: string, mockData: any) {
+  public async interceptRequest(url: string, mockData: string) {
     await intercept(url, (request) => {
       request.continue({ postData: mockData });
     });
@@ -215,7 +215,7 @@ export default class HtmlElementAPI {
   @Step("Navigate to relative path <relativePath>")
   public async navigateToPath(relativePath: string) {
     const absolutePath = _path.resolve(relativePath);
-    await goto("file:///" + absolutePath);
+    await goto(`file:///${absolutePath}`);
   }
 
   @ContinueOnFailure()
@@ -278,15 +278,15 @@ export default class HtmlElementAPI {
   }
 
   @Step("Navigate to relative path <path> with timeout <timeout> ms")
-  public async navigateToPathWithTimeout(path: string, timeout: any) {
+  public async navigateToPathWithTimeout(path: string, timeout: number) {
     const absolutePath = _path.resolve(path);
-    await goto("file:///" + absolutePath, {
+    await goto(`file:///${absolutePath}`, {
       navigationTimeout: timeout,
     });
   }
 
   @Step("Navigate to <url> with timeout <timeout> ms")
-  public async navigateToURLWithTimeout(url: string, timeout: any) {
+  public async navigateToURLWithTimeout(url: string, timeout: number) {
     await goto(url, { navigationTimeout: timeout });
   }