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(postman): update rustman and collection generation docs (#3615)

Browse Source
This commit is contained in:
Pa1NarK
2024-02-13 12:49:46 +05:30
committed by GitHub
parent 09c2a5c2a9
commit 02652a2519
2 changed files with 15 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
crates/test_utils/README.md
View File

@ -2,7 +2,8 @@
The heart of `newman`(with directory support) and `UI-tests` The heart of `newman`(with directory support) and `UI-tests`
> If you're developing a collection and you want to learn more about it, click [_**here**_](/README.md) > [!NOTE]
> If you're developing a collection and you want to learn more about it, click [_**here**_](/postman/README.md)
## Newman ## Newman
@ -14,10 +15,14 @@ The heart of `newman`(with directory support) and `UI-tests`
- Add the connector credentials to the `connector_auth.toml` / `auth.toml` by creating a copy of the `sample_auth.toml` from `router/tests/connectors/sample_auth.toml` - Add the connector credentials to the `connector_auth.toml` / `auth.toml` by creating a copy of the `sample_auth.toml` from `router/tests/connectors/sample_auth.toml`
- Export the auth file path as an environment variable: - Export the auth file path as an environment variable:
```shell ```shell
export CONNECTOR_AUTH_FILE_PATH=/path/to/auth.toml export CONNECTOR_AUTH_FILE_PATH=/path/to/auth.toml
``` ```
> [!IMPORTANT]
> You might also need to export the `GATEWAY_MERCHANT_ID`, `GPAY_CERTIFICATE` and `GPAY_CERTIFICATE_KEYS` as environment variables for certain collections with necessary values. Make sure you do that before running the tests
### Supported Commands ### Supported Commands
Required fields: Required fields:
@ -40,18 +45,21 @@ Optional fields:
- Example: `--header "key1:value1" --header "key2:value2"` - Example: `--header "key1:value1" --header "key2:value2"`
- `--verbose` -- A boolean to print detailed logs (requests and responses) - `--verbose` -- A boolean to print detailed logs (requests and responses)
**Note:** Passing `--verbose` will also print the connector as well as admin API keys in the logs. So, make sure you don't push the commands with `--verbose` to any public repository. > [!Note]
> Passing `--verbose` will also print the connector as well as admin API keys in the logs. So, make sure you don't push the commands with `--verbose` to any public repository.
### Running tests ### Running tests
- Tests can be run with the following command: - Tests can be run with the following command:
```shell ```shell
cargo run --package test_utils --bin test_utils -- --connector-name=<connector_name> --base-url=<base_url> --admin-api-key=<admin_api_key> \ cargo run --package test_utils --bin test_utils -- --connector-name=<connector_name> --base-url=<base_url> --admin-api-key=<admin_api_key> \
# optionally # optionally
--folder "<folder_name_1>,<folder_name_2>,...<folder_name_n>" --verbose --folder "<folder_name_1>,<folder_name_2>,...<folder_name_n>" --verbose
``` ```
**Note**: You can omit `--package test_utils` at the time of running the above command since it is optional. > [!Note]
> You can omit `--package test_utils` at the time of running the above command since it is optional.
## UI tests ## UI tests

7
postman/README.md
View File

@ -26,10 +26,11 @@ This directory contains the Postman collection for all Hyperswitch supported con
- Make sure that you update the `tests` section where the necessary `javascript` code has to written/updated to test the feature (assertion checks where you verify the results obtained with the expected outcome) - Make sure that you update the `tests` section where the necessary `javascript` code has to written/updated to test the feature (assertion checks where you verify the results obtained with the expected outcome)
- If certain `tests` need to be run at the time of making a request, make sure you add them to the `Pre-request Script` section of the request - If certain `tests` need to be run at the time of making a request, make sure you add them to the `Pre-request Script` section of the request
- Make sure that the request body does not contain any comments else the `newman dir-export` command will fail which is used to export the collection to its directory structure
--- ---
- After all the development is done, make sure you right click and run the collection in respective environments to make sure that the collection runs successfully - After all the development is done, make sure you right click and run the collection in respective environments to make sure that the collection runs successfully
- Export the collection as `v2.1` and save it `postman/collection-json` directory - Export the collection as `v2.1` and save it `postman/collection-json` directory with file name following the format `<connector_name>.postman_collection.json`
- Export the postman-collection to its directory structure by using the command `newman dir-export /path/to/collection.json` and move the folder to `postman/collection-dir` (for more info, refer to [Newman-Fork](https://github.com/juspay/hyperswitch/tree/main/crates/test_utils#newman)) - Export the postman-collection to its directory structure by using the command `newman dir-export /path/to/collection.json` and move the folder to `postman/collection-dir` (for more info, refer to [Newman-Fork](/crates/test_utils/README.md#newman)) with the folder renamed with name of the connector
- You can run the dir postman collection from newman using `rustman` by referring [here](https://github.com/juspay/hyperswitch/tree/main/crates/test_utils#running-tests) - You can run the postman collection from directory structure by referring [here](/crates/test_utils/README.md#running-tests)