@argos-ci/webdriverio 0.1.0

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2022 Smooth Code
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/dist/index.cjs

@@ -0,0 +1,8 @@
+// @ts-ignore
+const argosScreenshot = async (...args)=>{
+    // @ts-ignore
+    const { argosScreenshot } = await import('./index.mjs');
+    return argosScreenshot(...args);
+};
+// @ts-ignore
+exports.argosScreenshot = argosScreenshot;

package/dist/index.d.ts

@@ -0,0 +1,27 @@
+type ArgosScreenshotOptions = {
+    /**
+     * Specify ares that should be masked when the screenshot is taken.
+     * Masked elements will be overlaid with a pink box #FF00FF (customized by maskColor)
+     * that completely covers its bounding box.
+     */
+    mask?: {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    }[];
+    /**
+     * Specify the color of the overlay box for masked elements, in CSS color format.
+     * Default color is pink #FF00FF.
+     * @default "#FF00FF"
+     */
+    maskColor?: string;
+};
+/**
+ * Take a screenshot of the current page, optionally masking certain areas.
+ * @param browser A WebdriverIO `browser` object.
+ * @param filepath The path to save the screenshot to.
+ * @param options Options for the screenshot.
+ */
+declare function argosScreenshot(browser: WebdriverIO.Browser, name: string, { mask, maskColor }?: ArgosScreenshotOptions): Promise<Buffer>;
+export { ArgosScreenshotOptions, argosScreenshot };

package/dist/index.mjs

@@ -0,0 +1,92 @@
+import sharp from 'sharp';
+import { resolve } from 'node:path';
+import { mkdir } from 'node:fs/promises';
+
+// Function to create a mask with Sharp
+async function createMask(dimensions, areas, maskColor) {
+    // Start with a black image
+    let mask = sharp({
+        create: {
+            width: dimensions.width,
+            height: dimensions.height,
+            channels: 4,
+            background: {
+                r: 0,
+                g: 0,
+                b: 0,
+                alpha: 0
+            }
+        }
+    });
+    const areasImages = areas.map((coords)=>({
+            input: Buffer.from('<svg><rect x="0" y="0" width="' + coords.width + '" height="' + coords.height + `" fill="${maskColor}"/></svg>`),
+            top: coords.y,
+            left: coords.x
+        }));
+    mask = mask.composite(areasImages);
+    return mask.png().toBuffer();
+}
+async function applyMask(image, mask) {
+    try {
+        return await sharp(image).composite([
+            {
+                input: mask,
+                blend: "over"
+            }
+        ]).png().toBuffer();
+    } catch (err) {
+        throw new Error("Error applying mask", {
+            cause: err
+        });
+    }
+}
+async function getImageDimensions(buffer) {
+    try {
+        const imageInfo = await sharp(buffer).metadata();
+        const { width, height } = imageInfo;
+        if (!width || !height) {
+            throw new Error("Dimensions not found.");
+        }
+        return {
+            width,
+            height
+        };
+    } catch (err) {
+        throw new Error("Error getting image dimensions", {
+            cause: err
+        });
+    }
+}
+async function getFilePath(name) {
+    if (name.endsWith(".png")) return name;
+    const screenshotFolder = resolve(process.cwd(), "screenshots/argos");
+    await mkdir(screenshotFolder, {
+        recursive: true
+    });
+    return resolve(screenshotFolder, name + ".png");
+}
+/**
+ * Take a screenshot of the current page, optionally masking certain areas.
+ * @param browser A WebdriverIO `browser` object.
+ * @param filepath The path to save the screenshot to.
+ * @param options Options for the screenshot.
+ */ async function argosScreenshot(browser, name, { mask, maskColor = "#FF00FF" } = {}) {
+    if (!browser) {
+        throw new Error("A WebdriverIO `browser` object is required.");
+    }
+    if (!name) {
+        throw new Error("The `name` argument is required.");
+    }
+    const filepath = await getFilePath(name);
+    const imageBuffer = await browser.saveScreenshot(filepath);
+    if (!mask) {
+        return imageBuffer;
+    }
+    const dimensions = await getImageDimensions(imageBuffer);
+    const maskBuffer = await createMask(dimensions, mask, maskColor);
+    const maskedBuffer = await applyMask(imageBuffer, maskBuffer);
+    await sharp(maskedBuffer).toFile(filepath);
+    return maskedBuffer;
+}
+
+export { argosScreenshot };

package/package.json

@@ -0,0 +1,67 @@
+{
+  "name": "@argos-ci/webdriverio",
+  "description": "Visual testing solution to avoid visual regression. Webdriver SDK and utilities for Argos visual testing.",
+  "version": "0.1.0",
+  "author": "Smooth Code",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/argos-ci/argos-javascript.git",
+    "directory": "packages/webdriverio"
+  },
+  "keywords": [
+    "webdriverio",
+    "argos",
+    "automation",
+    "test automation",
+    "testing",
+    "visual testing",
+    "regression",
+    "visual regression"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "module",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs",
+      "default": "./dist/index.mjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "peerDependencies": {
+    "webdriverio": "^6 || ^7 || ^8"
+  },
+  "dependencies": {
+    "sharp": "^0.32.5"
+  },
+  "devDependencies": {
+    "@argos-ci/cli": "1.0.5",
+    "@types/mocha": "^10.0.6",
+    "@wdio/cli": "^8.27.1",
+    "@wdio/globals": "^8.27.0",
+    "@wdio/local-runner": "^8.27.0",
+    "@wdio/mocha-framework": "^8.27.0",
+    "@wdio/spec-reporter": "^8.27.0",
+    "@wdio/types": "^8.27.0",
+    "chromedriver": "^120.0.1",
+    "ts-node": "^10.9.2",
+    "wdio-chromedriver-service": "^8.1.1",
+    "webdriverio": "^8.27.0"
+  },
+  "scripts": {
+    "prebuild": "rm -rf dist",
+    "build": "rollup -c",
+    "test": "wdio run ./wdio.conf.ts",
+    "argos-upload": "pnpm exec argos upload screenshots --build-name \"argos-webdriverio-e2e-node-$NODE_VERSION-$OS\"",
+    "e2e": "pnpm run test && pnpm run argos-upload"
+  },
+  "gitHead": "fe6ced21faf2cfceacb073abfe21bce71b977c8a"
+}