README
Getting started
How to Build
The generated SDK relies on Node Package Manager (NPM) being available to resolve dependencies. If you don't already have NPM installed, please go ahead and follow instructions to install NPM from here. The SDK also requires Node to be installed. If Node isn't already installed, please install it from here
NPM is installed by default when Node is installed
To check if node and npm have been successfully installed, write the following commands in command prompt:
node --version
npm -version
Now use npm to resolve all dependencies by running the following command in the root directory (of the SDK folder):
npm install
This will install all dependencies in the node_modules
folder.
Once dependencies are resolved, you will need to move the folder ApiUploadTest
in to your node_modules
folder.
How to Use
The following section explains how to use the library in a new project.
1. Open Project Folder
Open an IDE/Text Editor for JavaScript like Sublime Text. The basic workflow presented here is also applicable if you prefer using a different editor or IDE.
Click on File
and select Open Folder
.
Select the folder of your SDK and click on Select Folder
to open it up in Sublime Text. The folder will become visible in the bar on the left.
2. Creating a Test File
Now right click on the folder name and select the New File
option to create a new test file. Save it as index.js
Now import the generated NodeJS library using the following lines of code:
var lib = require('lib');
Save changes.
3. Running The Test File
To run the index.js
file, open up the command prompt and navigate to the Path where the SDK folder resides. Type the following command to run the file:
node index.js
How to Test
These tests use Mocha framework for testing, coupled with Chai for assertions. These dependencies need to be installed for tests to run. Tests can be run in a number of ways:
Method 1 (Run all tests)
- Navigate to the root directory of the SDK folder from command prompt.
- Type
mocha --recursive
to run all the tests.
Method 2 (Run all tests)
- Navigate to the
../test/Controllers/
directory from command prompt. - Type
mocha *
to run all the tests.
Method 3 (Run specific controller's tests)
- Navigate to the
../test/Controllers/
directory from command prompt. - Type
mocha Bad SSLController
to run all the tests in that controller file.
To increase mocha's default timeout, you can change the
TEST_TIMEOUT
parameter's value inTestBootstrap.js
.
Initialization
API client can be initialized as following:
const lib = require('lib');
Class Reference
List of Controllers
BadSSLController
Get singleton instance
The singleton instance of the BadSSLController
class can be accessed from the API Client.
var controller = lib.BadSSLController;
getPinningTest
TODO: Add a method description
function getPinningTest(callback)
Example Usage
controller.getPinningTest(function(error, response, context) {
});
getWrongHost
TODO: Add a method description
function getWrongHost(callback)
Example Usage
controller.getWrongHost(function(error, response, context) {
});
getSelfSigned
TODO: Add a method description
function getSelfSigned(callback)
Example Usage
controller.getSelfSigned(function(error, response, context) {
});
getRevoked
TODO: Add a method description
function getRevoked(callback)
Example Usage
controller.getRevoked(function(error, response, context) {
});
getUntrustedRoot
TODO: Add a method description
function getUntrustedRoot(callback)
Example Usage
controller.getUntrustedRoot(function(error, response, context) {
});
getExpired
TODO: Add a method description
function getExpired(callback)
Example Usage
controller.getExpired(function(error, response, context) {
});