pact-cypress-adapter

KO | EN

gitlite — search

#javascript #hacktoberfest #ai #llm #golang #go #android #machine-learning #deep-learning #awesome #kubernetes #awesome-list #pytorch #open-source

pact-cypress-adapter

(★ 27)

Cypress Pact Plugin

pact-cypress-adapter Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Pact Cypress Adapter

[![Build and test](https://github.com/pactflow/cypress-pact-adapter/actions/workflows/test-and-build.yaml/badge.svg)](https://github.com/pactflow/cypress-pact-adapter/actions/workflows/test-and-build.yaml) [![npm version](https://badge.fury.io/js/@pactflow%2Fpact-cypress-adapter.svg)](https://badge.fury.io/js/@pactflow%2Fpact-cypress-adapter)

Generate Pact contracts from your existing Cypress tests.

> Accelerate your entry into contract testing with the Cypress development experience you know and love. — With Pact Cypress Adapter you can get the extra layer of testing safety, easily using existing mocks you’ve created with Cypress.
>
> Read our [blog post](https://pactflow.io/blog/use-cypress-in-contract-testing/) to find out more, otherwise dive-right in.

## Installation

Use your favourite Node package manager:

```bash
npm i -D @pactflow/pact-cypress-adapter
yarn add -D @pactflow/pact-cypress-adapter
pnpm add -D @pactflow/pact-cypress-adapter
```

## Setup

Configure the Pact plugin in your `cypress.config.{js,ts}` file using the `setupNodeEvents` function:

```js
const { defineConfig } = require('cypress')

module.exports = defineConfig({
  e2e: {
    setupNodeEvents(on, config) {
      const pactCypressPlugin = require('@pactflow/pact-cypress-adapter/dist/plugin')
      const fs = require('fs')
      pactCypressPlugin(on, config, fs)
      return config
    }
  }
})
```

Then, update your `cypress/support/e2e.js` file to include the Pact Cypress commands:

```js
import '@pactflow/pact-cypress-adapter'
```

<details>
<summary>Legacy Setup (Cypress 9.x and below)</summary>

> [!NOTE]
>
> This setup is for legacy Cypress versions. If you're using a recent version of Cypress, use the setup above.

Setup your cypress plugin at `cypress/plugins/index.js`:

```js
const pactCypressPlugin = require('@pactflow/pact-cypress-adapter/dist/plugin')
const fs = require('fs')

module.exports = (on, config) => {
  pactCypressPlugin(on, config, fs)
}
```

Finally, update `cypress/support/index.js` file to include cypress-pact commands:

```js
import '@pactflow/pact-cypress-adapter'
```

</details>

## Configuration

By default, this plugin omits most Cypress auto-generated HTTP headers.

### Add more headers to blocklist

To exclude other headers in your pact, add them as a list of strings in your `cypress.config.{js,ts}` file under the `expose.headersBlocklist` key:

```js
const { defineConfig } = require('cypress')

module.exports = defineConfig({
  expose: {
    headersBlocklist: ['ignore-me-globally']
  },
  e2e: {
    setupNodeEvents(on, config) {
      // ... plugin setup
    }
  }
})
```

**Note:** Header blocklist can also be set up at test level. See [cy.setupPactHeaderBlocklist](#cysetuppactheaderblocklistheaders)

### Ignore cypress auto-generated header blocklist

To stop Cypress auto-generated HTTP headers from being omitted by the plugin, set `expose.ignoreDefaultBlocklist` to `true`:

```js
const { defineConfig } = require('cypress')

module.exports = defineConfig({
  expose: {
    headersBlocklist: ['ignore-me-globally'],
    ignoreDefaultBlocklist: true
  },
  e2e: {
    setupNodeEvents(on, config) {
      // ... plugin setup
    }
  }
})
```

<details>
<summary>Legacy Configuration (using env, deprecated in Cypress 15.10.0+)</summary>

If you're using Cypress 15.9.x or earlier, you can use the `env` configuration instead of `expose`:

```js
const { defineConfig } = require('cypress')

module.exports = defineConfig({
  env: {
    headersBlocklist: ['ignore-me-globally'],
    ignoreDefaultBlocklist: true
  },
  e2e: {
    setupNodeEvents(on, config) {
      // ... plugin setup
    }
  }
})
```

For Cypress versions 9.x and below, use `cypress.json`:

```js
{
    ...otherCypressConfig,
    "env": {
        "headersBlocklist": ["ignore-me-globally"],
        "ignoreDefaultBlocklist": true
    }
}
```

**Migration Note:** `Cypress.env()` is deprecated as of Cypress 15.10.0 and will be removed in Cypress 16. Please migrate to `expose` configuration above. The adapter supports both for backward compatibility.

</details>

## Commands

### cy.setupPact

Configure your consumer and provider name

```js
before(() => {
  cy.setupPact('ui-consumer', 'api-provider')
})
```

### cy.usePactWait

Listen to aliased `cy.intercept` network call(s), record network request and response to a pact file.
[Usage and example](https://docs.cypress.io/api/commands/intercept) about `cy.intercept`

```js
before(() => {
  cy.setupPact('ui-consumer', 'api-provider')
  cy.intercept('GET', '/users').as('getAllUsers')
})

//... cypress test

after(() => {
  cy.usePactWait(['getAllUsers'])
})
```

### cy.setupPactHeaderBlocklist

Add a list of headers that will be excluded in a pact at test case level

```js
before(() => {
    cy.setupPact('ui-consumer', 'api-provider')
    cy.intercept('GET', '/users', headers: {'ignore-me': 'ignore me please'}).as('getAllUsers')
    cy.setupPactHeaderBlocklist(['ignore-me'])
})

//... cypress test

after(() => {
    cy.usePactWait(['getAllUsers'])
})
```

### cy.usePactRequest and cy.usePactGet

Use `cy.usePactRequest` to initiate network calls and use `cy.usePactGet` to record network request and response to a pact file.

Convenience wrapper for `cy.request(options).as(alias)`

- Accepts a valid Cypress request options argument [Cypress request options argument](https://docs.cypress.io/api/commands/request#Arguments)

**Example**

```js
before(() => {
  cy.setupPact('ui-consumer', 'api-provider')
  cy.usePactRequest(
    {
      method: 'GET',
      url: '/users'
    },
    'getAllUsers'
  )
})

//... cypress test

after(() => {
  cy.usePactGet(['getAllUsers'])
})
```

## Example Project

Check out a comprehensive React app example demonstrating Pact Cypress Adapter at [`example/todo-example/`](example/todo-example/).

The example showcases:

- Modern Cypress configuration using `cypress.config.js`
- Two testing patterns: `cy.intercept()` for mocked responses and `cy.usePactRequest()` for real API calls
- Custom commands to reduce boilerplate
- Best practices for test isolation and contract testing

pact-cypress-adapter

pact-cypress-adapter Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

pact-cypress-adapter

pact-cypress-adapter Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README