@wopee-io/wopee.wdio 4.0.0

package/docs/configuration.md

@@ -0,0 +1,241 @@
+## Service level configuration
+
+```typescript
+/**
+ * Options for configuring the Wopee Service.
+ */
+export interface WopeeServiceOptions {
+  /**
+   * Options for permanent storage of screenshots.
+   */
+  permanentStorage?: LocalSaveScreenshotAdapterOptions;
+
+  /**
+   * Options for screenshot validation using VRT (Visual Regression Testing).
+   */
+  screenshotValidation?: VrtAdapterOptions;
+
+  /**
+   * Cropping options.
+   */
+  cropping?: CroppingOptions;
+
+  /**
+   * Landscape or portrait.
+   */
+  isLandscape: boolean;
+
+  /**
+   * Save or not screenshot locally.
+   */
+  saveScreenshot: boolean;
+
+  /**
+   * Track or not screenshot to Wopee platform.
+   */
+  validateScreenshot: boolean;
+}
+```
+
+where `LocalSaveScreenshotAdapterOptions` is defined as
+
+```typescript
+/**
+ * Configuration options for the local screenshot tracking adapter.
+ */
+export interface LocalSaveScreenshotAdapterOptions {
+  /**
+   * The root folder where the screenshots will be saved.
+   */
+  rootFolder?: string;
+
+  /**
+   * The format string used to generate image names.
+   */
+  formatImageName?: string;
+}
+```
+
+with default values of
+
+```typescript
+/**
+ * Default options for the local screenshot saving adapter.
+ * These options are used to configure how screenshots are saved locally.
+ */
+export const DEFAULT_LOCAL_SAVE_SCREENSHOT_OPTIONS: Partial<LocalSaveScreenshotAdapterOptions> = {
+  rootFolder: './.tmp/',
+  formatImageName: '{name}-{browserName}-{width}x{height}-dpr-{dpr}',
+};
+```
+
+with options for `formatImageName` generated on the fly from running session, except from `name` which is given to tracking function as mandatory argument, being
+
+```typescript
+/**
+ * Options for formatting file names associated with browser screenshots.
+ */
+export interface FormatFileOptions {
+  /**
+   * The name of the browser.
+   */
+  browserName: string;
+
+  /**
+   * The version of the browser.
+   */
+  browserVersion: string;
+
+  /**
+   * The device's pixel ratio (DPR).
+   */
+  dpr: number;
+
+  /**
+   * The screen height in pixels.
+   */
+  height: number;
+
+  /**
+   * A descriptive name associated with the instance.
+   */
+  name: string;
+
+  /**
+   * The screen width in pixels.
+   */
+  width: number;
+}
+```
+
+and `VrtAdapterOptions` defined as
+
+```typescript
+/**
+ * Configuration options for the Visual Regression Testing (VRT) Adapter.
+ */
+export interface VrtAdapterOptions {
+  /**
+   * The API key required for authentication with the VRT service.
+   */
+  apiKey: string;
+
+  /**
+   * The URL of the VRT service's API endpoint.
+   */
+  apiUrl: string;
+
+  /**
+   * The Universally Unique Identifier (UUID) of the VRT project.
+   */
+  projectUuid: string;
+
+  /**
+   * Optional: The name of the branch being used in the VRT.
+   */
+  branchName?: string;
+
+  /**
+   * Optional: Whether to enable soft assertion mode for VRT.
+   * Soft assertions allow tests to continue running after visual differences are detected.
+   */
+  enableSoftAssert?: boolean;
+
+  /**
+   * Optional: The identifier for the CI/CD build associated with the testing process.
+   * This helps track and associate groups of tests as specific collections or suites.
+   */
+  ciBuildId?: string;
+
+  /**
+   * Optional: The name of the browser.
+   */
+  browser?: string;
+
+  /**
+   * Optional: A comment or description for the validation.
+   */
+  comment?: string;
+
+  /**
+   * Optional: The name of the device.
+   */
+  device?: string;
+
+  /**
+   * Optional: The name of the operating system.
+   */
+  os?: string;
+
+  /**
+   * Optional: Tolerance level for pixel-to-pixel differences during validation.
+   */
+  pixelToPixelDiffTolerance?: number;
+
+  /**
+   * Optional: The viewport information.
+   */
+  viewport?: string;
+
+  /**
+   * Optional: Custom tags for additional metadata.
+   */
+  customTags?: string;
+}
+```
+
+with default values of
+
+```typescript
+/**
+ * Default configuration options for the screenshot tracking adapter.
+ */
+export const DEFAULT_VRT_ADAPTER_OPTIONS: Partial<VrtAdapterOptions> = {
+  branchName: 'master',
+  ciBuildId: 'init',
+  enableSoftAssert: true,
+  pixelToPixelDiffTolerance: 0.0,
+};
+```
+
+and
+
+```typescript
+export interface CroppingOptions {
+  xCropLeft?: number;
+  xCropRight?: number;
+  yCropTop?: number;
+  yCropBottom?: number;
+}
+```
+
+with default values of
+
+```typescript
+const DEFAULT_LOCAL_SAVE_SCREENSHOT_OPTIONS: Partial<CroppingOptions> = {
+  xCropLeft: 0,
+  xCropRight: 0,
+  yCropTop: 0,
+  yCropBottom: 0,
+};
+```
+
+## WebdriverIO level configuration
+
+Simple add `wopee` service with respective confutation described in section [Service level configuration](#service-level-configuration)
+
+```
+services: [
+    [
+        'wopee',
+        {
+            screenshotValidation: {
+                apiUrl: process.env.apiUrl,
+                apiKey: process.env.apiKey,
+                projectUuid: process.env.project,
+            },
+            isLandscape: true,
+        },
+    ],
+],
+```

package/docs/mobile_native.md

@@ -0,0 +1,31 @@
+## Mobile native applications
+
+Full page screenshot support for mobule native application is provided via `trackFullPageMobileNative`.
+
+```typescript
+export async function trackFullPageMobileNative(
+  trackFullPageMobileNativeOptions: TrackFullPageMobileNativeOptions,
+): Promise<ScreenshotOutput>;
+```
+
+where `TrackFullPageMobileNativeOptions` is defined as
+
+```
+interface TrackFullPageMobileNativeOptions {
+  numberOfSwipes: number;
+  swipeStartX: number;
+  swipeStartY: number;
+  swipeStopX: number;
+  swipeStopY: number;
+  fullPageScrollTimeout?: number;
+  stepName: string;
+  scenarioName?: string;
+  browser?: string;
+  comment?: string;
+  customTags?: string;
+  device?: string;
+  os?: string;
+  pixelToPixelDiffTolerance?: number;
+  viewport?: string;
+}
+```

package/node_modules/@autonomous-testing/sdk/.commitlintrc.json

@@ -0,0 +1,3 @@
+{
+    "extends": ["@commitlint/config-angular"]
+}

package/node_modules/@autonomous-testing/sdk/.eslintignore

@@ -0,0 +1,2 @@
+build/
+node_modules/

package/node_modules/@autonomous-testing/sdk/.eslintrc

@@ -0,0 +1,21 @@
+{
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+        "project": "tsconfig.json",
+        "sourceType": "module"
+    },
+    "plugins": ["@typescript-eslint/eslint-plugin"],
+    "extends": ["plugin:@typescript-eslint/recommended", "plugin:prettier/recommended"],
+    "root": true,
+    "env": {
+        "node": true
+    },
+    "rules": {
+        "@typescript-eslint/ban-ts-comment": "off",
+        "@typescript-eslint/explicit-function-return-type": "off",
+        "@typescript-eslint/explicit-module-boundary-types": "off",
+        "@typescript-eslint/interface-name-prefix": "off",
+        "@typescript-eslint/no-explicit-any": "off",
+        "@typescript-eslint/no-unused-vars": ["error", { "argsIgnorePattern": "^_" }]
+    }
+}

package/node_modules/@autonomous-testing/sdk/.github/actions/npm_clean_install/action.yaml

@@ -0,0 +1,35 @@
+name: Clean install Node.js dependencies
+description: Install Node.js and all dependencies.
+
+inputs:
+    nodejs-version:
+        description: 'Node.js version.'
+        required: false
+        default: '21'
+    npm-token:
+        description: 'Token for @autonomous-testing:=https://npm.pkg.github.com.'
+        required: true
+
+runs:
+    using: 'composite'
+
+    steps:
+        - name: Setup node
+          uses: actions/setup-node@v4
+          with:
+              node-version: ${{inputs.nodejs-version}}
+
+        - name: Cache
+          id: cache
+          uses: actions/cache@v4
+          with:
+              path: node_modules
+              key: nodejs-${{inputs.nodejs-version}}-${{hashFiles('package-lock.json')}}
+              restore-keys: nodejs-${{inputs.nodejs-version}}-
+
+        - name: Npm clean install
+          if: steps.cache.outputs.cache-hit != 'true'
+          shell: bash
+          env:
+              NPM_TOKEN: ${{inputs.npm-token}}
+          run: npm clean-install

package/node_modules/@autonomous-testing/sdk/.github/workflows/ci_cd.yaml

@@ -0,0 +1,137 @@
+name: ci-cd
+
+on:
+    pull_request:
+        branches:
+            - 'dev'
+    push:
+        branches:
+            - 'dev'
+
+jobs:
+    npm-clean-install:
+        runs-on: builder
+
+        steps:
+            - name: Check-out
+              uses: actions/checkout@v4
+              with:
+                  fetch-depth: 1
+
+            - name: Install
+              uses: ./.github/actions/npm_clean_install
+              with:
+                  npm-token: ${{ secrets.CI_CD }}
+
+    static-check:
+        needs: [npm-clean-install]
+        if: github.event_name == 'pull_request'
+        runs-on: builder
+
+        steps:
+            - name: Check-out
+              uses: actions/checkout@v4
+              with:
+                  fetch-depth: 0
+
+            - name: Install
+              uses: ./.github/actions/npm_clean_install
+              with:
+                  npm-token: ${{ secrets.CI_CD }}
+
+            - name: Commitlint
+              if: ${{ always() }}
+              shell: bash
+              run: |
+                  npx commitlint \
+                    --from ${{ github.event.pull_request.base.sha }} \
+                    --to ${{ github.event.pull_request.head.sha }} \
+                    --verbose
+
+            - name: Eslint
+              if: ${{ always() }}
+              shell: bash
+              run: make eslint
+
+            - name: Prettier
+              if: ${{ always() }}
+              shell: bash
+              run: make prettier.check
+
+    before-build-test:
+        needs: [npm-clean-install]
+        runs-on: builder
+
+        steps:
+            - name: Check-out
+              uses: actions/checkout@v4
+              with:
+                  fetch-depth: 1
+
+            - name: Install
+              uses: ./.github/actions/npm_clean_install
+              with:
+                  npm-token: ${{ secrets.CI_CD }}
+
+            - name: Unit tests
+              shell: bash
+              run: make test.unit
+
+    build:
+        needs: [npm-clean-install]
+        runs-on: builder
+
+        steps:
+            - name: Check-out
+              uses: actions/checkout@v4
+              with:
+                  fetch-depth: 1
+
+            - name: Install
+              uses: ./.github/actions/npm_clean_install
+              with:
+                  npm-token: ${{ secrets.CI_CD }}
+
+            - name: Build
+              run: make build
+
+    after-build-test:
+        needs: [build]
+        runs-on: builder
+
+        steps:
+            - name: Check-out
+              uses: actions/checkout@v4
+              with:
+                  fetch-depth: 1
+
+            - name: Install
+              uses: ./.github/actions/npm_clean_install
+              with:
+                  npm-token: ${{ secrets.CI_CD }}
+
+            - name: E2E test
+              run: echo no-test
+
+    release:
+        needs: [before-build-test, after-build-test]
+        if: github.event_name == 'push'
+        runs-on: builder
+
+        steps:
+            - name: Check-out
+              uses: actions/checkout@v4
+              with:
+                  fetch-depth: 1
+
+            - name: Install
+              uses: ./.github/actions/npm_clean_install
+              with:
+                  npm-token: ${{ secrets.CI_CD }}
+
+            - name: Release
+              shell: bash
+              env:
+                  GH_TOKEN: ${{secrets.CI_CD}}
+                  NPM_TOKEN: ${{secrets.CI_CD}}
+              run: make release

package/node_modules/@autonomous-testing/sdk/.prettierignore

@@ -0,0 +1,3 @@
+CHANGELOG.md
+build/
+node_modules/

package/node_modules/@autonomous-testing/sdk/.prettierrc

@@ -0,0 +1,12 @@
+{
+    "arrowParens": "always",
+    "importOrder": [],
+    "importOrderSeparation": true,
+    "importOrderSortSpecifiers": true,
+    "printWidth": 120,
+    "endOfLine": "auto",
+    "singleQuote": true,
+    "tabWidth": 4,
+    "trailingComma": "all",
+    "plugins": ["@trivago/prettier-plugin-sort-imports"]
+}

package/node_modules/@autonomous-testing/sdk/README.md

@@ -0,0 +1,57 @@
+# Wopee SDK
+
+## Codebase structure
+
+The codebase is loosely following ports/adapters (hexagonal) architecture principles, i.e., split inmplementation details and business logic whenever possible.
+
+```
+lib/
+├── core/
+│   ├── domain/
+│   │   └── valueObjects/
+│   └── ports/
+├── infrastructure/
+│   ├── adapters/
+│   │   ├── apolloTrackAdapter/
+│   │   ├── consoleLogger/
+│   │   └── noLogger/
+│   └── services/
+│       ├── apolloTrackAdapterService/
+│       └── loggerService/
+└── shared/
+    ├── metadata/
+    └── utils
+        └── zodHelper
+```
+
+## Driven Ports
+
+-   **LoggerPort**: A generalized logging interface for various frameworks and packages, supporting uniform logging across the repository.
+
+-   **ImageTrackerPort**: A unified interface for image tracking operations, supporting seamless integration with different storage mechanisms.
+
+## Adapters
+
+-   **ApolloTrackAdapter**: Implements `ImageTrackerPort`, providing integration with Wopee API.
+
+-   **ConsoleLogger**: Implements `LoggerPort`, providing simple logging to the console output.
+
+-   **NoLogger**: Implements `LoggerPort`, providing option to completely disable logging.
+
+### Services
+
+#### ApolloTrackAdapterService
+
+Streamlise the creation of ApolloTrackerAdapter.
+
+#### LoggerService
+
+Streamlise the craetion of adapters implementing LoggerPort.
+
+## Shared
+
+### utils
+
+#### ZodHelper
+
+Implementing common wrappers around zod.

package/node_modules/@autonomous-testing/sdk/build/core/domain/index.d.ts

@@ -0,0 +1,2 @@
+export * from './valueObjects/index.js';
+//# sourceMappingURL=index.d.ts.map

package/node_modules/@autonomous-testing/sdk/build/core/domain/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./valueObjects/index.js"), exports);
+//# sourceMappingURL=index.js.map

package/node_modules/@autonomous-testing/sdk/build/core/domain/valueObjects/imageTrackingResult.interface.d.ts

@@ -0,0 +1,3 @@
+export interface ImageTrackingResult {
+}
+//# sourceMappingURL=imageTrackingResult.interface.d.ts.map

package/node_modules/@autonomous-testing/sdk/build/core/domain/valueObjects/imageTrackingResult.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=imageTrackingResult.interface.js.map

package/node_modules/@autonomous-testing/sdk/build/core/domain/valueObjects/index.d.ts

@@ -0,0 +1,4 @@
+import { ImageTrackingResult } from './imageTrackingResult.interface.js';
+import { TrackPayload } from './trackPayload.interface.js';
+export { ImageTrackingResult, TrackPayload };
+//# sourceMappingURL=index.d.ts.map

package/node_modules/@autonomous-testing/sdk/build/core/domain/valueObjects/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/node_modules/@autonomous-testing/sdk/build/core/domain/valueObjects/trackPayload.interface.d.ts

@@ -0,0 +1,3 @@
+export interface TrackPayload {
+}
+//# sourceMappingURL=trackPayload.interface.d.ts.map

package/node_modules/@autonomous-testing/sdk/build/core/domain/valueObjects/trackPayload.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=trackPayload.interface.js.map

package/node_modules/@autonomous-testing/sdk/build/core/index.d.ts

@@ -0,0 +1,3 @@
+export * from './ports/index.js';
+export * from './domain/index.js';
+//# sourceMappingURL=index.d.ts.map

package/node_modules/@autonomous-testing/sdk/build/core/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./ports/index.js"), exports);
+__exportStar(require("./domain/index.js"), exports);
+//# sourceMappingURL=index.js.map

package/node_modules/@autonomous-testing/sdk/build/core/ports/imageTracker.d.ts

@@ -0,0 +1,6 @@
+import { ImageTrackingResult } from '../domain/valueObjects/imageTrackingResult.interface.js';
+import { TrackPayload } from '../domain/valueObjects/trackPayload.interface.js';
+export declare abstract class ImageTrackerPort {
+    abstract track(payload: TrackPayload): Promise<ImageTrackingResult>;
+}
+//# sourceMappingURL=imageTracker.d.ts.map

package/node_modules/@autonomous-testing/sdk/build/core/ports/imageTracker.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ImageTrackerPort = void 0;
+class ImageTrackerPort {
+}
+exports.ImageTrackerPort = ImageTrackerPort;
+//# sourceMappingURL=imageTracker.js.map

package/node_modules/@autonomous-testing/sdk/build/core/ports/index.d.ts

@@ -0,0 +1,4 @@
+import { ImageTrackerPort } from './imageTracker.js';
+import { LoggerPort } from './logger.js';
+export { ImageTrackerPort, LoggerPort };
+//# sourceMappingURL=index.d.ts.map

package/node_modules/@autonomous-testing/sdk/build/core/ports/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LoggerPort = exports.ImageTrackerPort = void 0;
+const imageTracker_js_1 = require("./imageTracker.js");
+Object.defineProperty(exports, "ImageTrackerPort", { enumerable: true, get: function () { return imageTracker_js_1.ImageTrackerPort; } });
+const logger_js_1 = require("./logger.js");
+Object.defineProperty(exports, "LoggerPort", { enumerable: true, get: function () { return logger_js_1.LoggerPort; } });
+//# sourceMappingURL=index.js.map

package/node_modules/@autonomous-testing/sdk/build/core/ports/logger.d.ts

@@ -0,0 +1,7 @@
+export declare abstract class LoggerPort {
+    abstract debug(message: string): void;
+    abstract error(message: string): void;
+    abstract info(message: string): void;
+    abstract warning(message: string): void;
+}
+//# sourceMappingURL=logger.d.ts.map

package/node_modules/@autonomous-testing/sdk/build/core/ports/logger.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LoggerPort = void 0;
+class LoggerPort {
+}
+exports.LoggerPort = LoggerPort;
+//# sourceMappingURL=logger.js.map