api-test-helper

Helper Library to test API

1. Create a new node js project in a new folder.

mkdir newProject
cd newProject
npm init -y
touch data.json
touch index.js

2. Get the test helper package.

npm i https://github.com/lim-ming-tat/api-test-helper-v2.git --save

The following dependency will be added to the package.json

  "dependencies": {
    "api-test-helper": "git+https://github.com/lim-ming-tat/api-test-helper-v2.git"
  }

3. Sample Data, save the following json in data.json file

    {
        "id" : "1",
        "description" : "Simple Parameter Template.",

        "invokeUrl" : "http://www.example.com/",
        "httpMethod" : "GET"
    }

4. Code Sample, save the following code in index.js file

"use strict" 

const helper = require('api-test-helper-v2').apiHelper;

let params = require('./data.json');

var defaultParam = {
    // suppress the successful message, will not suppress error message is any
    suppressMessage: false,
    // display verbose debug message
    debug: false,
    // show execution time
    showElapseTime: false,
    // skip a test
    skipTest: false, 

    batchPrefix: "<<<<<< Start >>>>>>",
    batchSuffix: "<<<<<<  End  >>>>>>",

    // display the session data
    debugSession : false,

    // additional dynamic parameters
    sessionData : null
};

helper.setDefaultParam(defaultParam);

Promise.resolve()
    .then(function() { return helper.startTestTimer() })
    
    .then(function() { return helper.performTest(params) })

    .then(helper.displayTestResult).then(message => console.log("\n" + message))
    .then(helper.displayElapseTime).then(message => console.log("\n" + message + "\n"))
    .catch(function(error) { 
        console.log(error.stack);
    })
;

5. Execute the test.

node index.js

6. Sample execution results and results

>>> 1. Simple Parameter Template. <<< - Success.
>>> 2. Gateway Security Parameter (L2) Template. <<< - Success.

Test Results::: 2/2

7. L0 Parameters Example

{
    "id" : "L0",
    "description" : "Gateway Security Parameter (L0) Template.",

    "invokeUrl" : "https://sample.api.gov.sg:443/division/v1/myResources",
    "httpMethod" : "GET",

    "queryString" : { "clientname" : "node.js.test.l0", "data" : "some data value" },

    "debug" : false
}

8. L1 Parameters Example

{
    "id" : "L1",
    "description" : "Gateway Security Parameter (L1) Template.",

    "authPrefix": "apex_l1_eg",
    "realm" : "http://example.api.gov.sg",
    "appId" : "app-id",
    "secret" : "app-secret",

    "invokeUrl" : "https://example.api.gov.sg:443/division/project/v1/myResources",
    "signatureUrl" : "https://example.e.api.gov.sg:443/division/project/v1/myResources",

    "httpMethod" : "GET",
    "queryString" : { "clientname" : "node.js.test.l1", "data" : "some data value" },

    "ignoreServerCert" : false,
    "caCertFileName" : "COMODO_RSA_Certification_Authority.public.pem",
    "caCertFileType" : "pem"
}

9. L2 Parameters Example

{
    "id" : "L2",
    "description" : "Gateway Security Parameter (L2) Template.",

    "authPrefix": "apex_l2_eg",
    "realm" : "http://example.api.gov.sg",
    "appId" : "app-id",

    "invokeUrl" : "https://example.api.gov.sg:443/division/project/v1/myResources",
    "signatureUrl" : "https://example.e.api.gov.sg:443/division/project/v1/myResources",

    "httpMethod" : "GET",
    "queryString" : { "clientname" : "node.js.test.l2", "data" : "some data value" },

    "privateCertFileName" : "myCert.nopass.pem",
    "privateCertFileType" : "pem"
}

10. L21 Parameters Example

{
    "id" : "L2",
    "description" : "Gateway Security Parameter (L2) Template.",

    "authPrefix": "apex_l2_eg",
    "realm" : "http://example.api.gov.sg",
    "appId" : "app-id",

    "invokeUrl" : "https://example.api.gov.sg:443/division/project/v1/myResources",
    "signatureUrl" : "https://example.e.api.gov.sg:443/division/project/v1/myResources",

    "httpMethod" : "GET",
    "queryString" : { "clientname" : "node.js.test.l2", "data" : "some data value" },


    "privateCertFileName" : "myCert.nopass.pem",
    "privateCertFileType" : "pem",

    "nextHop": {
        "authPrefix": "apex_l1_ig",
        "realm" : "http://example.api.gov.sg",
        "appId" : "app-id",
        "secret" : "app-secret",

        "signatureUrl" : "https://example.i.api.gov.sg:443/division/project/v1/myResources",
        "httpMethod" : "GET"
    }
}

11. Test Result Sample

<<<<<< Start >>>>>>
>>> 1. Simple Parameter Template. <<< - Success.
<<<<<<  End  >>>>>> 

Test Results::: 1/1
Skip Test   ::: 0 

Start Time : 2020-03-20 16:06:01.372
End Time   : 2020-03-20 16:06:01.760
Elapse Time: 388 milliseconds

12. Submit Multi-Part POST

{
    "id" : "1",
    "description" : "Hedwig Test.",

    "authPrefix": "apex_l1_eg",
    "realm" : "http://node.js.test.l2.eg",
    "appId" : "appName",
    "secret" : "AppSecret",

    "invokeUrl" : "https://playlab.api.lab/hedwig-intranet",
    "signatureUrl" : "https://playlab.api.lab/hedwig-intranet",

    "httpMethod" : "POST",

    "multiPartData": { 
        "fileds": { 
            "mail[from]": "[email protected]",
            "mail[to]": "[email protected]",
            "mail[subject]": "multiPartData Test",
            "mail[html]": "test text",
            "mail[text]": "test html"
        },
        "attachments": {
            "files": [ "./401-history.png", "./402-h2.png" ],
            "files1": "./401-history.png",
            "files2": "./402-h2.png"
        }
    }
}

13. For more parameters options, please refer to ./test/sample.json and ./test/sample.security.json for details.
14. For more configuration options, please refer to ./test/unitTest.js for details.