feat: logger

.env

@@ -3,3 +3,4 @@ BROWSER=chromium
 TIMEOUT=8000
 PARALLEL=5
 HEADLESS=true
+LOG_LEVEL=info

.vscode/launch.json

@@ -21,7 +21,8 @@
         "HEADLESS": "false",
         "PARALLEL": "${input:parallel}",
         "TAGS": "${input:tags}",
-        "PATHS": "${file}"
+        "PATHS": "${file}",
+        "LOG_LEVEL": "debug"
       }
     }
   ],

package.json

@@ -80,6 +80,7 @@
     "@cucumber/cucumber": "^10.0.1",
     "@playwright/test": "^1.40.0",
     "@types/fs-extra": "^11.0.4",
+    "@wdio/logger": "^7.26.0",
     "callsites": "^3.1.0",
     "change-case": "^4.1.2",
     "dotenv": "^16.3.1",

src/config/index.ts

@@ -18,6 +18,7 @@ function configure(overrides) {
   const debug = process.env.DEBUG === "true" || overrides?.debug || false;
   const downloadsDir = path.join(baseDir, process.env.DOWNLOADS_DIR || overrides?.downloadsDir || "downloads/");
   const headless = process.env.HEADLESS === "true" || overrides?.headless || false;
+  const logLevel = process.env.LOG_LEVEL || overrides?.logLevel || "error";
   const pages = (overrides?.pages || ["fixtures/pages/**/*.page.ts"]).map(i => path.join(baseDir, i));
   const resultsDir = path.join(baseDir, process.env.RESULTS_DIR || overrides?.resultsDir || "results/");
   const snapshotsDir = path.join(baseDir, process.env.SNAPSHOTS_DIR || overrides?.snapshotsDir || "snapshots/");
@@ -43,7 +44,7 @@ function configure(overrides) {
     fs.removeSync(snapshots[key].diffDir);
     fs.mkdirsSync(snapshots[key].expectedDir);
   });
-  const custom = { baseDir, baseURL, browser, browserOptions, contextOptions, debug, downloadsDir, headless, pages, resultsDir, snapshots, timeout };
+  const custom = { baseDir, baseURL, browser, browserOptions, contextOptions, debug, downloadsDir, headless, logLevel, pages, resultsDir, snapshots, timeout };
 
   // cucumber options defaults
   const config = {

src/config/types.ts

@@ -14,6 +14,8 @@ export interface Config extends IConfiguration {
   /** Custom: Directory to store browser downloads in, relative to the config file */
   downloadsDir: string;
   headless: boolean;
+  /** Custom: Level of logging verbosity */
+  logLevel: "trace" | "debug" | "info" | "warn" | "error" | "silent";
   /** Custom: Array of globs pointing to your page object files, relative to the config file */
   pages: string[];
   /** Custom: Directory to store the reports in, relative to the config file */

src/core/gherkin/world.def.ts

@@ -5,13 +5,16 @@ import {
   After,
   AfterStep,
   Before,
+  BeforeStep,
   ITestStepHookParameter,
   setDefaultTimeout,
   setWorldConstructor,
   Status
 } from "@cucumber/cucumber";
 import { World as This } from "../world";
 
+import chalk from "chalk";
+
 setDefaultTimeout(process.env.DEBUG === "true" ? -1 : undefined);
 setWorldConstructor(This);
 
@@ -20,6 +23,11 @@ Before({}, async function(this: This) {
   this.page = await this.context.newPage();
 });
 
+BeforeStep({}, async function(this: This, params: ITestStepHookParameter) {
+  const { pickleStep } = params;
+  this.logger.debug(`${chalk.yellow("GHERKIN")} ${chalk.green.dim.bold(`${pickleStep.type}: `)}${chalk.green.dim(pickleStep.text)}`);
+});
+
 AfterStep({}, async function(this: This, params: ITestStepHookParameter) {
   const { result, testStepId } = params;
 

src/core/index.ts

@@ -1,2 +1,4 @@
+import log from "@wdio/logger";
 export * from "./page-object";
 export * from "./world";
+export const logger = log("kyoko");

src/core/page-object.ts

@@ -2,15 +2,17 @@ import type { World } from "./world";
 import type { BrowserContext, Page } from "@commands/types";
 
 export class PageObject<ParametersType = any> {
-  readonly attach: World["attach"];
-  parameters: ParametersType;
-  context: BrowserContext;
-  page: Page;
+  protected readonly attach: World["attach"];
+  protected readonly logger: World["logger"];
+  protected parameters: ParametersType;
+  protected context: BrowserContext;
+  protected page: Page;
   url: string;
   title: string;
 
   constructor(world: World) {
     this.attach = world.attach;
+    this.logger = world.logger;
     this.parameters = world.parameters;
     this.context = world.context;
     this.page = world.page;

src/core/world.ts

@@ -6,6 +6,8 @@ import { World as CucumberWorld } from "@cucumber/cucumber";
 import { BrowserContext as BrowserContextClass } from "@commands/context/context";
 import { PageObject } from "./page-object";
 
+import log from "@wdio/logger";
+
 import type { IWorldOptions } from "@cucumber/cucumber";
 import type { BrowserContext, Locator, Page } from "@commands/types";
 import type { Config } from "@config/types";
@@ -16,6 +18,7 @@ export abstract class World<ParametersType = any> extends CucumberWorld<Paramete
   private pageObjects: string[];
   private pageObject: PageObject;
   context: BrowserContext;
+  logger: ReturnType<typeof log>;
   page: Page;
   config: Config;
 
@@ -24,10 +27,18 @@ export abstract class World<ParametersType = any> extends CucumberWorld<Paramete
     const { config, ...parameters } = options.parameters;
     super({ ...options, parameters });
     this.config = config;
+    this.loadLogger();
     this.loadPageObjects();
     this.loadCommands();
   }
 
+  private loadLogger() {
+    const suffix = process.env.CUCUMBER_PARALLEL === "true" ? `[${process.env.CUCUMBER_WORKER_ID}]` : "";
+    this.logger = log(`kyoko${suffix}`);
+    this.logger.setLevel(this.config.logLevel);
+    this.logger.info("Instatiating cucumber world class...");
+  }
+
   private loadPageObjects() {
     this.pageObjects = files.fromGlob(this.config.pages);
   }
@@ -36,6 +47,7 @@ export abstract class World<ParametersType = any> extends CucumberWorld<Paramete
     files.fromGlob([path.join(path.dirname(__dirname), "commands/**/command/*.js")]).filter(Boolean).forEach(file => require(file));
   }
 
+
   findPageObject(page: string, persist = false) {
     const file = this.pageObjects.find(i => path.basename(i).split(".")[0].toLowerCase() === page.toLowerCase());