...
...
...
...
...
...
...
...
...
...
Trouble Ticket CTK (API REST Specification TMF661 - R16.5.0)
...
Product Catalog Management CTK (API REST Specification TMF660 - R16.5.0)
...
Customer Management CTK (API REST Specification TMF659 - R16.5.0
...
Product Ordering CTK (API REST Specification TMF622 - R16.5.0
...
Service Qualification (to be ready very soon)
...
Product Inventory (to be ready very soon)
...
The following instructions describe how to install and run an Open API CTK
...
:
...
...
Newman (needed for CTK test execution), this is the command line version of 'Postman'; installation instructions available at: https://www.getpostman.com/docs/newman_intro
...
(This example is covering Product Offering Qualification for the 18.0 Release, but the steps to run a CTK are similar, unless stated on the readme.md that comes with the CTK).
1.
Installing and Running Conformance Test Kit
The CTK is dependent on the installation of node.js and npm to work.
Node.js and NPM can be downloaded and installed from:
...
Once Node.js and
...
npm are installed
...
1 Import CTK from TM Forum
- Download postman collection file for specific API from the following page: https://projects.tmforum.org/wiki/display/API/Open+API+Table
- Store downloaded file into the folder in your system where Newman runs
2 Configure environment
- Download environment file from TMForum (TMFENV)
- Modify environment file to refer to the endpoint where the implementation to be certified is running (see step 3 below)
- Store modified file into the folder in your system where Newman runs
3 You need to create your testing environment. The environment is a text file without extension written in JSON. It has the following format:
{
"id": "b0294beb-2229-65b4-7eba-b6d57d0a59c4",
"name": "theName",
"values": [
{
"key": "Host",
"value": "http://writeyourhosthere",
"type": "text",
"name": "Host",
"enabled": true
},
{
"key": "tmForumAPI1",
"value": "{{Host}}/tmForumAPI1",
"type": "text",
"name": "testedAPI",
"enabled": true
}
],
"timestamp": 1432767028962,
"synced": false,
"syncedFilename": ""
}
You can use this as a template. Create a file with this format, replace the values for the name, the host and your API addresses and put it in the same folder as the postman collections.
4 Now download the right script for your platform (either Windows or Linux/Mac), put it in the same folder and run script execution command.
5 A folder name results will be created and filled with the output of the tests. You should see something like the following:
Iteration 1 of 1
request [object Object]
request typeobject
201 651ms POST /customer http://env-0693795.jelastic.servint.net:8080/DSTestedApi/api/api/testedApi/v2/testedApi
? Content-Type is present application/json
? Status code is 201
? Response contains ID 13208
? Response contains HREF
? POST Body Response equals Request Body
201 187ms POST /testedApi copy http://env-0693795.jelastic.servint.net:8080/DSTestedApi/api/testedApi/v2/testedApi
? Content-Type is present application/json
? Status code is 201
? Response contains ID 13263
? Response contains HREF
? POST Body Response equals Request Body
200 62ms /current copy http://env-0693795.jelastic.servint.net:8080/DSTestedApi/subscriber/api/current
204 67ms delete hub by id copy http://env-0693795.jelastic.servint.net:8080/DSTestedApiManagement/api/testedApi/v2/hub/13262
? Successful DELETE request13262
Summary:
Parent Pass Count FailCount
-------------------------------------------------------------
Folder customer test 18 0
Folder hub test 8 0
Total 26 0
download and unzip the TMF679-ProductOfferingQualification ZIP file within your test directory.
You should see the following files between many others :
Windows-RUNCTK.ps1
Linux-RUNCTK.sh
2.
For Windows:
Right click Windows-RUNCTK.ps1 and select run with PowerShell, press Y and Enter, wait for the dependencies to be installed go to Step 2.
For Linux and Mac:
You need to give executable permission for the Linux-RUNCTK.sh file, you can do that by opening a terminal and typing:
bash Linux-RUNCTK.sh
Wait for NPM to install the dependencies and go to step 2.
3.
Enter the URL for the base of your API, for example, if you can get a resource on:
You should input:
https://tm-forum-open-api-reference-implementation.mybluemix.net/tmf-api/productOfferingQualificationManagement/v1
The script will now run for a few minutes and when it ends, you will have a resultsHTML.html file inside the folder, this is the file you need to forward to TMForum to get your certification if your API passed every test, the file should look like this:
If there are no failures
...
then you have passed the CTK and your API is conformant with all
the Mandatory features.
The
...
following link points to the TM Forum Open API Self Certification Web Page in which conformance results are published: TM Forum Open API Self Certification Web Page
You can also submit a link to your webpage along with your test results .
...