Cypress Tests

Overview

This Tool is a solution designed to automate testing for the Hyperswitch using Cypress, an open-source tool capable of conducting API call tests and UI tests. This README provides guidance on installing Cypress and its dependencies.

Installation

Prerequisites

Before installing Cypress, ensure you have the following prerequisites installed:

• npm (Node Package Manager)
• Node.js (18.x and above)

Run Test Cases on your local

To run test cases, follow these steps:

1. Clone the repository and switch to the project directory:

   git clone https://github.com/juspay/hyperswitch
   cd cypress-tests

2. Install Cypress and its dependencies to cypress-tests directory by running the following command:

   npm install

3. Set environment variables for cypress

   export CYPRESS_CONNECTOR="connector_id"
   export CYPRESS_BASEURL="base_url"
   export DEBUG=cypress:cli
   export CYPRESS_ADMINAPIKEY="admin_api_key"
   export CYPRESS_CONNECTOR_AUTH_FILE_PATH="path/to/creds.json"

4. Run Cypress test cases

   To run the tests in interactive mode run the following command

   npm run cypress

   To run all the tests in headless mode run the following command

   npm run cypress:ci

   To run payment tests in headless mode run the following command

   npm run cypress:payments

   To run payout tests in headless mode run the following command

   npm run cypress:payouts

   To run routing tests in headless mode run the following command

   npm run cypress:routing

Note

To learn about how creds file should be structured, refer to the example.creds.json section below.

Folder Structure

The folder structure of this directory is as follows:

.                                                        # The root directory for the Cypress tests.
├── .gitignore
├── cypress                                              # Contains Cypress-related files and folders.
│   ├── e2e                                              # End-to-end test directory.
│   │   ├── ConnectorTest                                # Directory for test scenarios related to connectors.
│   │   │   ├── your_testcase1_files_here.cy.js
│   │   │   ├── your_testcase2_files_here.cy.js
│   │   │   └── ...
│   │   └── ConnectorUtils                               # Directory for utility functions related to connectors.
│   │       ├── connector_detail_files_here.js
│   │       └── utils.js
│   ├── fixtures                                         # Directory for storing test data API request.
│   │   └── your_fixture_files_here.json
│   ├── support                                          # Directory for Cypress support files.
│   │   ├── commands.js                                  # File containing custom Cypress commands and utilities.
│   │   └── e2e.js
│   └── utils
│       └── utility_files_go_here.js
├── cypress.config.js                                    # Cypress configuration file.
├── cypress.env.json                                     # File is used to store environment-specific configuration values,such as base URLs, which can be accessed within your Cypress tests.
├── package.json                                         # Node.js package file.
├── readme.md                                            # This file
└── yarn.lock

Writing Tests

Adding Connectors

To add a new connector for testing with Hyperswitch, follow these steps:

1.Include the connector details in the creds.json file:

example:

{
  "stripe": {
    "auth_type": "HeaderKey",
    "api_key": "SK_134"
  }
}

2.Add the new connector details to the ConnectorUtils folder (including CardNo and connector-specific information).

Refer to Stripe.js file for guidance:

/cypress-tests/cypress/e2e/ConnectorUtils/Stripe.js

Similarly, create a new file named newconnectorname.js and include all the relevant information for that connector.

3.In util.js, import the new connector details.

Adding Functions

Similarly, add any helper functions or utilities in the command.js in support folder and import them into your tests as needed.

Example: Adding List Mandate function to support ListMandate scenario

Cypress.Commands.add("listMandateCallTest", (globalState) => {
  const customerId = globalState.get("customerId");
  cy.request({
    method: "GET",
    url: `${globalState.get("baseUrl")}/customers/${customerId}/mandates`,
    headers: {
      "Content-Type": "application/json",
      "api-key": globalState.get("apiKey"),
    },
  }).then((response) => {
    const xRequestId = response.headers["x-request-id"];
    if (xRequestId) {
      cy.task("cli_log", "x-request-id ->> " + xRequestId);
    } else {
      cy.task(
        "cli_log",
        "x-request-id is not available in the response headers"
      );
    }
    expect(response.headers["content-type"]).to.include("application/json");
    console.log(response.body);
    let i = 0;
    for (i in response.body) {
      if (response.body[i].mandate_id === globalState.get("mandateId")) {
        expect(response.body[i].status).to.equal("active");
      }
    }
  });
});

Adding Scenarios

To add new test scenarios:

1. Navigate to the ConnectorTest directory.
2. Create a new test file or modify existing ones to add your scenarios.
3. Write your test scenarios using Cypress commands.

For example, to add a scenario for listing mandates in the Mandateflows:

// cypress/ConnectorTest/CreateSingleuseMandate.js
describe("Payment Scenarios", () => {
  it("should complete a successful payment", () => {
    // Your test logic here
  });
});

In this scenario, you can call functions defined in command.js. For instance, to test the listMandateCallTest function:

describe("Payment Scenarios", () => {
  it("list-mandate-call-test", () => {
    cy.listMandateCallTest(globalState);
  });
});

You can create similar scenarios by calling other functions defined in command.js. These functions interact with utility files like connector.js and include necessary assertions to support various connector scenarios.

Additional Resources

For more information on using Cypress and writing effective tests, refer to the official Cypress documentation: Cypress Documentation

Example creds.json

{
  "adyen": {
    "auth_type": "SignatureKey",
    "api_key": "api_key",
    "key1": "key1",
    "api_secret": "api_secret"
  },
  "bankofamerica": {
    "auth_type": "SignatureKey",
    "api_key": "api_key",
    "key1": "key1",
    "api_secret": "api_secret"
  },
  "bluesnap": {
    "auth_type": "BodyKey",
    "api_key": "api_key",
    "key1": "key1"
  },
  "cybersource": {
    "auth_type": "SignatureKey",
    "api_key": "api_key",
    "key1": "key1",
    "api_secret": "api_secret"
  },
  "nmi": {
    "auth_type": "BodyKey",
    "api_key": "api_key",
    "key1": "key1"
  },
  "paypal": {
    "auth_type": "BodyKey",
    "api_key": "api_key",
    "key1": "key1"
  },
  "stripe": {
    "auth_type": "HeaderKey",
    "api_key": "api_key"
  },
  "trustpay": {
    "auth_type": "SignatureKey",
    "api_key": "api_key",
    "key1": "key1",
    "api_secret": "api_secret"
  }
}