This repository contains the UDX NGSI-LD Test Suite, used to verify the compliance of Context Brokers(Data Plane) with the UDX (Unified Data Exchange) NGSI-LD API Specification.
Details
- Install Postman Application:
- On Windows
- Open a web browser and visit the Postman Download Page.
- Click on the Download button for your system (e.g., Windows x64 ). The website usually detects your operating system automatically, but you can manually select the appropriate version if needed.
- The Postman setup file (e.g., Postman-win64-setup.exe) will start downloading.
- Once the download is complete, go to the folder where the file was saved (usually the Downloads folder).
- Double-click the downloaded Postman-win64-setup.exe file to start the installation process.
- The installer will launch, and Postman will start installing automatically. No manual steps are required during the installation.
- Wait for the installation process to complete.
- After installation, Postman will launch automatically. If it doesn’t, you can find it in the Start Menu or on your Desktop.
- On Ubuntu
- Most Ubuntu distributions come with Snap pre-installed.
- To verify, run this command in your terminal:
snap --version - If Snap is not installed, install it with:
sudo apt updatesudo apt install snapd - Run the following command in your terminal:
sudo snap install postman - Once installed, you can check if Postman is available by running:
snap list postman - Open Postman from your application menu, or run:
postman
- On Windows
- Clone the Repo:
- Pre-requisites
- Install Git:
- If Git is not already installed, download and install it from Git's official website or use the following commands:
$ sudo apt update $ sudo apt install git - On Windows, install Git via the official installer or package manager.
- Run the following command to check if Git is installed:
git --version
- Install Git:
- Pre-requisites
- Clone a Repository
- Go to the repository on your Git hosting platform ( i.e., https://github.com/datakaveri/udx-compliance-specification).
- Click the Code or Clone button.
- Copy the repository's HTTPS ( i.e., https://github.com/datakaveri/udx-compliance-specification.git)
- Open a Terminal or Command Prompt
- Navigate to the directory where you want to clone the repository using the cd command (e.g.,
cd /path/to/your/desired/folder). - Use the following command to clone the repository:
git clone <repository-url>- Replace with the copied URL, i.e.:
git clone https://github.com/datakaveri/udx-compliance-specification.git
- Replace with the copied URL, i.e.:
The first operation that you have to clone the Repository on your own machine and follow the following steps:
Import environment file i,e IS 18003 Part 3- UDX - Resource Access Service.postman_environment.json in postman
-
Open Postman
- Launch the Postman application on your computer or open the Postman web version in your browser.
- Go to the Environments Section
- Click on the Environments button (gear icon) in the top-left corner of the Postman interface.
- Navigate to the Import Option
- On the Postman home page, look for the Import button and click on it.
- You can find it in the top-right corner of the interface, near the New button.
-
Choose the File
- A pop-up window will appear with multiple import options. Select the File tab
- Click the Upload Files button and browse your system to locate the environment file (.json format).
- Once you've located the file, select it and click Open or Choose (depending on your operating system).
-
Import the File
- After selecting the file, Postman will display its name and details.
- Click the Import button to proceed.
-
Verify the Imported Environment
- Once imported, the Environment will appear in the Environment tab on the left-hand side of the Postman interface.
- Click on it to view or edit its key-value pairs.
In the IS 18003 Part 3- UDX - Resource Access Service.postman_environment.json file, configure the following
parameters:
| Key | Value Example | Description |
|---|---|---|
| auth-url | authvertx.iudx.io | URL of DX Auth Server |
| baseUrl | https://rs.iudx.io | URL of DX Resource Server |
| secureResourceToken | eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9. eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ. SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c |
Jwt token issued by the Dx auth sever |
| openResourceToken | eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9. eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ. SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c |
Jwt token issued by the Dx auth sever |
| enabled | true/false | Enable or disable the key |
Import collection file i,e IS 18003 Part 3- UDX - Resource Access Service.postman_collection.json in postman
-
Open Postman
- Launch the Postman application on your computer or open the Postman web version in your browser.
- Go to the Collections Section
- Click on the Collections button (gear icon) in the top-left corner of the Postman interface.
- Navigate to the Import Option
- On the Postman home page, look for the Import button and click on it.
- You can find it in the top-left corner of the interface, near the New button.
-
Choose the File
- A pop-up window will appear with multiple import options. Select the File tab.
- Click the Upload Files button and browse your system to locate the collection file. Supported file types include .json and .postman_collection.
- Once you've located the file, select it and click Open or Choose (depending on your operating system).
-
Import the File
- After selecting the file, Postman will display its name and details.
- Click the Import button to proceed.
-
Verify the Imported Collection
- Once imported, the Collection will appear in the Collections tab on the left-hand side of the Postman interface.
- Expand the collection to view its requests and folders.
There are several ways to run a Postman collection, with some of the commonly used methods mentioned below:
- Open Postman
- Launch the Postman application on your computer or access the Postman web interface.
- Go to the Collections Tab
- On the left-hand sidebar, click the Collections tab.
- Expand the collection containing the API request you want to run.
- Select the API Request
- Locate the desired API request within the collection.
- Click on the request name to open it in the main request editor.
- Choose an Environment
- select the appropriate environment from the Environment dropdown in the top-right corner of the interface.
- Verify Request Details
- Review the request details in the editor, including the following:
- Method (e.g., GET, POST, PUT).
- URL: Ensure it is correct and complete.
- Headers: Verify or modify if needed.
- Body: For POST/PUT requests, check the payload (if applicable).
- Review the request details in the editor, including the following:
- Send the Request
- Click the "Send" button located near the top of the Postman interface.
- Postman will execute the request and display the response in the Response section below.
- Open Postman
- Launch the Postman application on your computer or access the Postman web interface.
- Go to the Collections Tab
- On the left-hand sidebar, click the Collections tab.
- Select the desired collection
- Configure the options such as iterations, environment, and delay, then click Run to execute.
- In G3 (Subscription), components 085a, 087a,089a 091a, and 093a require a data broker (RabbitMQ). Ensure RabbitMQ is installed and running for proper functionality.
Copyright 2024 IUDX Programme Unit, Society of Innovation and Development, Indian Institute of Science, Bangalore
The content of this repository and the files contained are released under the Apache License a (Apache License 2.0).