Install and configure the ptest tool

The following ptest tool installation steps are typical of a Node.js-based application:

1. Extract the domino-db package into a new directory.
2. Install prerequisite packages using the package manager.
3. Create the configuration file.

Extract the domino-db package into a new directory

ptest comes with the domino-db Node.js module. Use the following commands to create a new empty directory and extract the domino-db module into the new directory:

The file name for the domino-db module, shown below as domino-domino-db-1.6.0.tgz may be different depending on the version of the AppDev Pack you are using.

c:\>mkdir domino-db

c:\>cd domino-db

c:\domino-db>\Windows\System32\tar xvf \temp\domino-domino-db-1.6.0.tgz
x package/LICENSE
x package/proton-test/bin/ptest
x package/src/requests/grpc/utils/bulk-attachment.js
x package/src/requests/grpc/utils/bulk-document.js
x package/proton-test/src/commands.js
x package/proton-test/src/connect.js
x package/src/constants.js
x package/src/requests/grpc/utils/convert-from-proto.js
x package/src/requests/grpc/utils/convert-to-proto.js
x package/src/requests/grpc/utils/crypto-helpers.js
x package/src/requests/http/utils/das-query-params.js
x package/src/database.js
x package/src/requests/grpc/database.js
x package/src/requests/http/database.js
x package/src/document.js
x package/src/requests/grpc/document.js
x package/src/requests/http/document.js
x package/src/requests/grpc/generated/domino_grpc_pb.js
x package/src/requests/grpc/generated/domino_pb.js
x package/src/domino-db-error.js
x package/domino-db.js
x package/src/strings/errors.js
x package/src/utils/getter-factory.js
x package/src/requests/grpc/utils/grpc-helpers.js
x package/src/requests/http/utils/http-helpers.js
x package/proton-test/index.js
x package/src/requests/grpc/index.js
x package/src/requests/http/index.js
x package/src/requests/index.js
x package/src/strings/index.js
x package/install.js
x package/src/utils/is-dev-mode.js
x package/src/requests/grpc/generated/pglobals.js
x package/proton-test/src/read.js
x package/src/requests/http/server.js
x package/src/server.js
x package/proton-test/src/utils.js
x package/src/requests/grpc/generated/version.js
x package/package.json
x package/README.md

Install prerequisite packages using the package manager

The files for the domino-db module are located in the package directory. Execute the following commands to install all the required files using NPM, the Node.js Node Package Manager:

c:\domino-db>cd package

c:\domino-db\package>npm install
...
added 809 packages from 462 contributors and audited 878010 packages in 71.722s

Create the configuration file

Next, create the JSON configuration file to provide details about your server to ptest. This configuration file is used only for ptest. The first command creates the .ptest directory in your home directory. And the second command starts notepad to create the configuration file. The name and location of the configuration file must be created as indicated. The contents of the configuration file must be valid JSON.

c:\domino-db\package>mkdir %userprofile%\.ptest
c:\domino-db\package>notepad %userprofile%\.ptest\config.json

Enter the following JSON formatted text into your config.json. Adjust the following as needed:

1. appsdb1: Enter an alias for the Domino server. The configuration file may refer to multiple Domino servers. Use this name in ptest to refer to a collection of server connection attributes.
2. hostName: Enter the host name of the Domino server on which Proton runs.
3. port: Enter the Proton port number used on your Domino server
4. rootCertificateFile: Enter the file that contains your Internal CA's certificate
5. clientCertificateFile: Enter the file that contains the Domino user's certificate
6. clientKeyFile: Enter the file that contains the Domino user's unprotected key

{
 "servers": {
    "appsdb1": {
      "hostName": "appsdb1.jumbocloudservices.com",
      "connection": {
        "port": "3003",
        "secure": true
      },
      "credentials": {
        "rootCertificateFile": "\\certs\\internalca.crt",
        "clientCertificateFile": "\\certs\\jadmin.crt",
        "clientKeyFile": "\\certs\\jadmin-open.key"
      }
    }
  }
}