npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@saucelabs/cypress-plugin

v3.6.0

Published

Sauce Cypress Plugin to report your results directly to Sauce Labs

Downloads

3,002

Readme

sauce-cypress-plugin

This Cypress plugins reports each spec to your Sauce Labs account.

When you run tests with the Cypress CLI, using this plugin, test results and artifacts are uploaded to Sauce Labs.

Requirements

  • Node 22
  • Cypress

Installation

Install from npm:

npm install @saucelabs/cypress-plugin

Configuration

Sauce Labs Credentials

SAUCE_USERNAME and SAUCE_ACCESS_KEY environment variables need to be set for the plugin to report your results to Sauce Labs. Your Sauce Labs Username and Access Key are available from your dashboard.

Plugin Setup (Cypress 10 and above)

sauce-cypress-plugin is configurable through your cypress config file, e.g. cypress.config.{js, cjs, mjs,ts}.

Example cypress.config.cjs:

const { defineConfig } = require("cypress");

module.exports = defineConfig({
  e2e: {
    setupNodeEvents(on, config) {
      require("@saucelabs/cypress-plugin").default(on, config, {
        region: "us-west-1",
        build: "myBuild",
        tags: ["example1"],
      });
      return config;
    },
  },
});

Example cypress.config.mjs:

import { defineConfig } from "cypress";
import reporter from "@saucelabs/cypress-plugin";

export default defineConfig({
  e2e: {
    setupNodeEvents(on, config) {
      reporter.default(on, config, {
        region: "us-west-1",
        build: "myBuild",
        tags: ["example1"],
      });
      return config;
    },
  },
});

Example cypress.config.ts:

import { defineConfig } from "cypress";
import Reporter, { Region } from "@saucelabs/cypress-plugin";

export default defineConfig({
  e2e: {
    setupNodeEvents(on, config) {
      Reporter(on, config, {
        region: Region.USWest1, // us-west-1 is the default
        build: "myBuild",
        tags: ["example1"],
      });
      return config;
    },
  },
});

Plugin Setup (Cypress 9 and below)

Register the plugin in your project's cypress/plugins/index.js:

module.exports = (on, config) => {
  // Other plugins you may already have.
  // ...
  require("@saucelabs/cypress-plugin").default(on, config, {
    region: "us-west-1",
    build: "myBuild",
    tags: ["example1"],
  });
  return config;
};

Plugin Options

| Name | Description | Type | | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | | build | Sets a build ID. Default: '' | string | | tags | Tags to add to the uploaded Sauce job. Default: [] | string[] | | region | Sets the region. Default: us-west-1 | us-west-1 | eu-central-1 | | artifactUploadDir | If specified, automatically upload files from this directory, per spec. e.g. files in {artifactUploadDir}/{specName}/ would be uploaded to the job that ran spec_name. The directory is relative to your cypress config file. The directory will be deleted at the beginning of the next run. Default: undefined | string |

Run a Test 🚀

Trigger cypress to run a test

cypress run

The jobs will be reported to Sauce Labs

Jobs reported to Sauce Labs:

  ┌────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
  │  Spec                                        Sauce Labs job URL                                                │
  ├────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤
  │  cypress/e2e/1-getting-started/todo.cy.js    https://app.saucelabs.com/tests/b30ffb871827408c81e454103b946c99  │
  └────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘

Upload Assets Task

This task allows you to upload assets (such as images or logs) to a specific Sauce Labs job associated with the test spec.

| Parameter | Type | Description | | ------------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | spec | string | Path to the spec file being executed, typically provided by __filename. | | assets | Asset | Asset[] | Can be a single Asset object or an array of Asset objects to be uploaded to Sauce Labs. Each Asset should contain a filename and either a path or data. | | assets[].path | string | Required. Path to the file on the local filesystem (e.g., "pics/this-is-fine.png"). | | assets[].filename | string | Optional. The name of the file to upload, as it should appear in Sauce Labs (e.g., "this-is-fine.png"). If not provided, the file path basename is used by default. |

Example Usage

it("upload assets", () => {
  // Single file upload.
  cy.task("sauce:uploadAssets", {
    spec: __filename,
    assets: { path: "pics/this-is-fine.png" },
  });

  // Multiple files upload.
  cy.task("sauce:uploadAssets", {
    spec: __filename,
    assets: [
      { path: "pics/this-is-fine.png" },
      { path: "test.txt", filename: "test.log" },
    ],
  });
});

Real-life Example

tests/integration/ folder will present an integration example with Cypress' Kitchensink tests set.

Development

Running Locally

Best way to test locally is to npm link into an existing cypress project.

Debug

Once you npm link, you can run your cypress tests with the environment variable DEBUG="@saucelabs/cypress-plugin:*" to see additional debug output.