Skip to content

Project Connections File

Warning

Credentials for connections are stored in plain text in the project connections file. For this reason, we recommend that this file is not included in version control (it is included in the .gitignore file by default), and credentials should be revokable and have the minimum set of permissions necessary for the Adapter to function (Usually Read-Only is sufficient).

The project connections file is a JSON named connections.json located in the project's root directory. This document describes what data is present in the file.

Note

If the file is not ignored by git, mp-test and mp-build will append the file to the project's .gitignore file.

connections (array of objects)

This property stores a list of connection objects.

Example
config.json
1
2
3
4
5
6
7
8
{
    "connections" : [
          {
             ...
            }
        ]
    ...
 }

credential (object)

An object that contains credential information.

Example
config.json
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
    "connections" : [
          {
            "credential":{
               "token": {
                   "password": true,
                   "required": true,
                   "value": "password"
                 }
              "credential_kind_key": "my_app_credential"
              }
             ...
            }
        ]
    ...
 }

identifiers (object)

An object that contains one or more identifiers. The identifiers should match the adapter instance identifiers defined in the Object Model.

Example
config.json
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
{
    "connections" : [
          {
            "identifiers": {
                "container_memory_limit": {
                  "part_of_uniqueness": false,
                  "required": true,
                  "value": "2048"
                },
                "enable_sotrage_collection": {
                  "part_of_uniqueness": false,
                  "required": true,
                  "value": "False"
                },
              }
              ...
            }
        ]
    ...
 }

custom_collection_number (int, optional)

The collection number mp-test passes to the adapter instance. This is helpful when testing adapter behaviours that are triggered based on collection number (for example, an expensive computation that can doesn't need to happen every collection).

Example
config.json
1
2
3
4
5
6
7
{
    "connections" : [
            "custom_collection_number": 10,
            ...
        ]
    ...
}

custom_collection_window (int, optional)

The collection window duration mp-test passed to the adapter instance. This is helpful when testing behaviours that are triggered based on collection window duration.

Example
config.json
1
2
3
4
5
6
7
{
    "connections" : [
            "custom_collection_window": 20,
            ...
        ]
    ...
}

name (string)

The name of the connection. This is used as the connection identifier and can be used to specify a connection name when using mp-test.

Example 
{
"connections" : [
{
...
name:"host-1"
},
{
...
name:"host-2"
}
]
...
}

suite_api_hostname (string)

The suite API host name used for this connection. If there isn't one, the values should be 'null'.

Example 
{
"connections" : [
{
...
suite_api_hostname: "my-host.example.com"
}
]
...
}
Note

If this property is not provided for the connection, then it will fall back to the property defined outside of the connections.

{
    "connections" : [
          {
             ...
          }
        ]
    ...
    suite_api_hostname: "my-default-host.example.com",
    suite_api_password: "my_password",
    suite_api_username: "my_username",
 }

suite_api_password (string)

The suite API password used to log in to the specified host. If there isn't one, the values should be 'null'.

Example 
{
"connections" : [
{
...
suite_api_password: "my_password",
}
]
...
}
Note

If this property is not provided for the connection, then it will fall back to the property defined outside of the connections.

{
    "connections" : [
          {
             ...
          }
        ]
    ...
    suite_api_hostname: "my-default-host.example.com",
    suite_api_password: "my_password",
    suite_api_username: "my_username",
 }

suite_api_username (string)

The suite API username used to log in to the specified host. If there isn't one, the values should be 'null'.

Example 
{
"connections" : [
{
...
suite_api_username: "my_username",
}
]
...
}
Note

If this property is not provided for the connection, then it will fall back to the property defined outside of the connections.

{
    "connections" : [
          {
             ...
          }
        ]
    ...
    suite_api_hostname: "my-default-host.example.com",
    suite_api_password: "my_password",
    suite_api_username: "my_username",
 }