Package Exports

cypress-contract-stubs
cypress-contract-stubs/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (cypress-contract-stubs) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Cypress Contract Stubs

The cypress-contract-stubs add support for using Spring Cloud Contract Stub entries when testing with Cypress. This plugin can download artifacts from nexus and nexus3 artifact repositories and cache them locally. Provide commands to automatically intercept application requests with stubs matched without the need of using the stub runner server.

Get started

Installation

Install the plugin by running:

npm install --save-dev cypress-contract-stubs

Plugin configuration

Add it to your plugin file: cypress/plugins/index.js

const { contractStubsPlugin } = require('cypress-contract-stubs');

module.exports = async (on, config) => {
  await contractStubsPlugin(on, config);
  
  return config;
}

Add configuration for remote and local stubs to your cypress.json file.

The default mode is remote and the default type is nexus3. You can also configure default stub server and repository for the artifacts.

{
  "env": {
    "stubs_server": "http://nexus3.proxy.internal",
    "stubs_repository": "maven-releases",
    "stubs": [
      {
        "id": "internal.contracts:artifact-name:+:stubs"
      },
      {
        "mode": "remote",
        "id": "internal.contracts:artifact-name:+:stubs",
        "type": "nexus",
        "server": "http://nexus.proxy.internal",
        "repository": "releases"
      },
      {
        "mode": "local",
        "file": "artifact-name-1.318-SNAPSHOT-stubs.jar"
      },
      {
        "mode": "local",
        "file": "artifact-name-stubs.jar",
        "path": "cypress/fixtures"
      }
    ]
  }
}

Note: The plugin will download the latest artifact version if the + or latest is added to the stubs id coordinate

Commands configuration

Add it to your support file: cypress/support/index.js

import 'cypress-contract-stubs/commands';

In your test files, will be available the following commands:

cy.interceptStubs Intercept network requests with matched stubs
cy.contractStubs Get all available stub entries
cy.contractStub Get stub entry by options (if more stubs match the criteria will be returned the first occurrence)

cy.interceptStubs();
cy.contractStubs().then((stubs) => console.log(stubs));
cy.contractStub({ name: 'stubName' }).then((stub) => console.log(stub));

Intercept network request

Automatic intercept

To automatically intercept network requests use:

cy.interceptStubs(); // Intercept all stub requests
cy.interceptStubs(['stubName']); // Intercept stub requests filtered by names

cy.visit('/')

The command setup an intercept for each stub present with the syntax defined in WireMock documentation

Manual intercept

To manually intercept network request use:

cy.contractStub({ name: 'stubName' }).then((stub) => {
  const { name, request, response } = stub;
  
  cy.intercept(request.url, (req) => {
    req.reply(response.status, response.body, response.headers)
  }).as(name);
});

cy.visit('/')

Debug

Set an environment variable DEBUG=cypress:stubs:* to log all stubs plugin operations.

Check the Cypress documentation for more info about printing debug logs.

Small print

License: MIT - do anything with the code, but don't blame me if it does not work.

Support: if you find any problems with this module, email / tweet / open an issue on Github

MIT License

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.