@argos-ci/cypress 0.0.1

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/README.md

@@ -0,0 +1,62 @@
+# @argos-ci/cypress
+
+[Cypress](https://cypress.io) commands and utilities for [Argos](https://argos-ci.com) visual testing.
+
+[![npm version](https://img.shields.io/npm/v/@argos-ci/cypress.svg)](https://www.npmjs.com/package/@argos-ci/cypress)
+[![npm dm](https://img.shields.io/npm/dm/@argos-ci/cypress.svg)](https://www.npmjs.com/package/@argos-ci/cypress)
+[![npm dt](https://img.shields.io/npm/dt/@argos-ci/cypress.svg)](https://www.npmjs.com/package/@argos-ci/cypress)
+
+## Installation
+
+```sh
+npm install --save-dev @argos-ci/cypress
+```
+
+And add this line to your `cypress/support/index.js` file.
+
+```js
+import "@argos-ci/cypress/support";
+```
+
+## Usage
+
+`cy.argosScreenshot` - command stabilizes the UI and takes a screenshot.
+
+_How to take a screenshot with `cy.argosScreenshot` command_
+
+```js
+describe("Homepage", () => {
+  it("should be stable", () => {
+    // Screenshot a full page
+    cy.argosScreenshot("home");
+
+    // Screenshot a component
+    cy.get("main div.breadcrumb").argosScreenshot("home-breadcrumb");
+  });
+});
+```
+
+### Configuration
+
+`cy.argosScreenshot([name][, options])`
+
+- `name` - The screenshot name; must be unique; default value to test title
+- `options` - Send to [cy.screenshot command options](https://docs.cypress.io/api/commands/screenshot)
+
+## Helper attributes
+
+The `data-visual-test` attributes allow you to control how elements behave in the Argos screenshot.
+
+It is often used to hide changing element like dates.
+
+- `[data-visual-test="transparent"]` - Make the element transparent (`opacity: 0`)
+- `[data-visual-test="removed"]` - Remove the element (`display: none`)
+- `[data-visual-test="blackout"]` - Blacked out the element
+
+_How to use an helper to hide a div from a screenshot_
+
+```html
+<div id="clock" data-visual-test="transparent">
+  <!-- the clock code -->
+</div>
+```

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@argos-ci/cypress",
+  "description": "Visual testing solution to avoid visual regression. Cypress commands and utilities for Argos visual testing.",
+  "version": "0.0.1",
+  "author": "Smooth Code",
+  "license": "MIT",
+  "repository": "github:argos-ci/argos-cypress",
+  "keywords": [
+    "cypress",
+    "argos",
+    "automation",
+    "test automation",
+    "testing",
+    "visual testing",
+    "regression",
+    "visual regression"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "module",
+  "main": "./support.js",
+  "types": "./support.d.ts",
+  "exports": {
+    "./support": {
+      "require": "./support.js",
+      "types": "./support.d.ts",
+      "default": "./support.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "scripts": {
+    "test": "cypress run",
+    "test:open": "cypress open --e2e -b chrome",
+    "format": "prettier --write \"**/*.{js,md,json}\" ",
+    "lint": "eslint --ignore-path .gitignore .",
+    "release": "standard-version && conventional-github-releaser --preset angular"
+  },
+  "dependencies": {
+    "cypress-wait-until": "^1.7.2"
+  },
+  "devDependencies": {
+    "conventional-github-releaser": "^3.1.5",
+    "cypress": "^10.6.0",
+    "eslint": "^8.23.0",
+    "eslint-plugin-cypress": "^2.12.1",
+    "eslint-plugin-html": "^7.1.0",
+    "prettier": "^2.7.1",
+    "standard-version": "^9.5.0"
+  }
+}

package/support.d.ts

@@ -0,0 +1,16 @@
+declare namespace Cypress {
+  interface Chainable {
+    /**
+     * Stabilize the UI and takes a screenshot of the application under test.
+     *
+     * @see https://on.cypress.io/screenshot
+     * @example
+     *    cy.argosScreenshot("my-screenshot")
+     *    cy.get(".post").argosScreenshot()
+     */
+    argosScreenshot: (
+      name: string,
+      options: Partial<Loggable & Timeoutable & ScreenshotOptions>
+    ) => Chainable<null>;
+  }
+}

package/support.js

@@ -0,0 +1,90 @@
+import "cypress-wait-until";
+
+const GLOBAL_STYLES = `
+  /* Hide carets */
+  * { caret-color: transparent !important; }
+
+  /* Hide scrollbars */
+  ::-webkit-scrollbar {
+    display: none !important;
+  }
+
+  /* Generic hide */
+  [data-visual-test="transparent"] {
+    color: transparent !important;
+    font-family: monospace !important;
+    opacity: 0 !important;
+  }
+
+  [data-visual-test="removed"] {
+    display: none !important;
+  }
+`;
+
+/**
+ * Injected style to hide elements and fix unstable rendering.
+ */
+function injectStyles(document) {
+  const css = document.createElement("style");
+  css.type = "text/css";
+  css.textContent = GLOBAL_STYLES;
+  document.body.appendChild(css);
+}
+
+/**
+ * Check if an element is visible.
+ */
+function isVisible(element) {
+  return Boolean(
+    element.offsetWidth ||
+      element.offsetHeight ||
+      element.getClientRects().length
+  );
+}
+
+/**
+ * Wait until there is no `[aria-busy="true"]` element on the page.
+ */
+function waitUntilNoBusy() {
+  cy.waitUntil(() =>
+    cy.document().then((document) => {
+      const busy = Array.from(document.querySelectorAll('[aria-busy="true"]'));
+      return busy.every((element) => !isVisible(element));
+    })
+  );
+}
+
+/**
+ * Takes a screenshot for Argos.
+ */
+Cypress.Commands.add(
+  "argosScreenshot",
+  { prevSubject: ["optional", "element", "window", "document"] },
+  (subject, name, options = {}) => {
+    if (typeof name === "object" && name !== null) {
+      options = name;
+      name = null;
+    }
+
+    const screenshotName = `argos/${name ?? cy.state("runnable").fullTitle()}`;
+    Cypress.log({
+      name: "argosScreenshot",
+      displayName: `Argos Screenshot`,
+      message: screenshotName,
+    });
+    // Inject styles
+    cy.document().then((doc) => injectStyles(doc));
+    // Wait until there is no `[aria-busy="true"]` element on the page.
+    waitUntilNoBusy();
+    // Wait for fonts to be loaded
+    cy.document().its("fonts.status").should("equal", "loaded");
+
+    // Screenshot
+    cy.wrap(subject).screenshot(screenshotName, {
+      capture: "viewport",
+      overwrite: true,
+      blackout: ['[data-visual-test="blackout"]', ...(options.blackout ?? [])],
+      ...options,
+    });
+  }
+);