rust/hyperswitch
1
0
Fork 0
mirror of https://github.com/juspay/hyperswitch.git synced 2025-10-29 00:49:42 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(cypress): update cypress docs (#4505)

Browse Source
This commit is contained in:
Pa1NarK
2024-05-03 16:36:00 +05:30
committed by GitHub
parent 0304e8e76a
commit 17b369cfab
1 changed files with 54 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

62
cypress-tests/readme.md
View File

@ -37,16 +37,11 @@ To run test cases, follow these steps:
export CYPRESS_BASEURL="base_url" export CYPRESS_BASEURL="base_url"
export DEBUG=cypress:cli export DEBUG=cypress:cli
export CYPRESS_ADMINAPIKEY="admin_api_key" export CYPRESS_ADMINAPIKEY="admin_api_key"
export CYPRESS_CONNECToR_AUtH_FILE_PATH="path/to/creds.json"
``` ```
4. Run Cypress test cases 4. Run Cypress test cases
To execute a connector create test, ensure the connector details are included in the `creds.json` file. Then, integrate the path in the `command.js` as follows:
```javascript
import ConnectorAuthDetails from "../../creds.json";
```
To run the tests in a browser in interactive mode run the following command To run the tests in a browser in interactive mode run the following command
```shell ```shell
@ -59,6 +54,9 @@ To run test cases, follow these steps:
npm run cypress:ci npm run cypress:ci
``` ```
> [!NOTE]
> To learn about how creds file should be structured, refer to the [example.creds.json](#example-credsjson) section below.
## Folder Structure ## Folder Structure
The folder structure of this directory is as follows: The folder structure of this directory is as follows:
@ -169,9 +167,7 @@ To add new test scenarios:
For example, to add a scenario for listing mandates in the `Mandateflows`: For example, to add a scenario for listing mandates in the `Mandateflows`:
```javascript ```javascript
// cypress/ConnectorTest/CreateSingleuseMandate.js // cypress/ConnectorTest/CreateSingleuseMandate.js
describe("Payment Scenarios", () => { describe("Payment Scenarios", () => {
it("should complete a successful payment", () => { it("should complete a successful payment", () => {
// Your test logic here // Your test logic here
@ -194,3 +190,53 @@ You can create similar scenarios by calling other functions defined in `command.
## Additional Resources ## Additional Resources
For more information on using Cypress and writing effective tests, refer to the official Cypress documentation: [Cypress Documentation](https://docs.cypress.io/) For more information on using Cypress and writing effective tests, refer to the official Cypress documentation: [Cypress Documentation](https://docs.cypress.io/)
## Example creds.json
```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"
}
}
```