The MongoDB Tool sends a query to a MongoDB database and returns the JSON-format results from that query. JSON tools such as JSON Data Banks and JSON Assertors can be added as "outputs" to MongoDB tools in order to display and/or validate the query results.
In this section:
Requirements
- The following MongoDB versions are supported:
- 2.6
- 3.0
- 3.2
- 3.4
- 3.6
- 4.0
- 4.2
- 4.4
- This tool requires SOAtest/Virtualize 2020.1 or later.
Installation
The tool can be installed from the UI or the command line.
UI Installation
- Choose Parasoft> Preferences.
- Choose System Properties and click Add JARs.
- Browse to the com.parasoft.soavirt.tool.mongodbtool.jar file and click Open.
- Apply the changes and restart SOAtest/Virtualize.
Command Line Installation
Add the com.parasoft.soavirt.tool.mongodbtool.jar file to the system.properties.classpath property in your settings properties file. For example:
system.properties.classpath=<path to jar>/com.parasoft.soavirt.tool.mongodbtool.jar
Usage
You can add MongoDB tools as standalone tools with the SOAtest Add Test wizard. You can also add them as Virtualize provisioning action tools. Before the tool can be run, you must configure the MongoDB connection, as well as the query you want to run. Once a MongoDB tool is added to a suite, you can add any JSON tool as an output.
Configuration
You can configure the following settings on the Tool Settings tab and the Input tab.
Tool Settings Tab
Connection Settings
| Hosts | Comma separated list specifying the host(s) and port(s) of the MongoDB server(s) to query. If empty, the default value will be used. Default is Example:
|
|---|---|
| Use SSL | Specifies whether SSL should be used when connecting to the MongoDB server. If empty, the default value will be used. Default is false. |
| Read Preference | Specifies the preference in which the tool reads operations to the members of a replica set. See the MongoDB documentation for additional information about read preference options. Default is |
Authentication Settings
| Authentication Mechanism | Specify the authentication mechanism used to connect to the MongoDB server. The following values are acceptable:
|
|---|---|
| Username | Specifies the username with which to authenticate to a MongoDB database that uses authentication. |
| Password | Specifies the password with which to authenticate to a MongoDB database that uses authentication. |
| Authentication Database | Specifies the authentication database to use. If empty, the default value will be used. This setting is ignored when the authentication mechanism is set to LDAP. Default is admin. |
Query Settings
| Database | Specifies the name of the MongoDB database to query |
|---|---|
| Collection | Specifies the name of the MongoDB collection to query. |
| Query | Specifies the query in the strict mode of the MongoDB Extended JSON language (see the MongoDB Documentation for details). If empty, the default value will be used. Default is all documents. |
| Projection | Specifies the projection in the strict mode of the MongoDB Extended JSON language (see the MongoDB Documentation for details). If empty, the default value will be used. Default is all fields. |
Update Settings
| Operation | Specifies a document handling operation. Options are:
If empty, the default value will be used. Default is |
|---|---|
| Upsert | Applies only when the Operation setting described above is set to |
| Multi | Applies only when the Operation setting described above is set to |
Input Tab
The MongoDB Tool uses JSON input entered on this tab for insert and update operations. Input entered here is ignored for find and delete operations. See Update Settings for more information about these operations.
In the case of insert operations, the input on this tab represents the new document to be inserted into the MongoDB collection. For update operations, the input on this tab represents a command with MongoDB update operators such as $set and $inc. The MongoDB tool can be chained to the JSON output of other tools to use that JSON output as its own input (for example to insert a new document from the response of a REST API call).
Example Query 1
The following query returns all the items in the product collection.
Example Query 2
The following query returns all fields of product id 101 from the products collection.
Example Query 3
The following query returns only the sku field for product id 101 from the products collection.
Using Output Tools to View and Process Query Results
Any tools that operate on JSON can be added as outputs to a MongoDB tool. For example, you might want to add a JSON Data Bank to view the results and/or a JSON Assertor to validate the results. To add an output:
- Right-click the appropriate MongoDB Tool node, then choose Add Output.
- In the Add Output dialog, choose a JSON tool in the right pane and click Finish.
After the MongoDB tool is executed, output will be passed to the chained tool. You can then perform additional tool configuration as needed (e.g., to specify assertions, extractions, etc.).
Change Log
The following updates to this extensions were made.
1.3
Added ability to insert, update, and delete MongoDB documents.
1.2
Added support for MongoDB 4.0, 4.2, 4.4.
1.1
Added support for multiple hosts.
Scripts that specify the host and/or port connection settings will not persist after upgrading the tool.
The host and port connection settings have been merged into a single field. If you used a script to define your host and/or port connection, you will need to add a new script to configure these settings in the Hosts field after upgrading to this version. See Connection Settings for additional information.
- Added support outputting results as traffic.
- Added support for read preference configuration.
1.0
- Initial release.
Third-Party Content
This plugin includes items that have been sourced from third parties as outlined below.
- mongo-java-driver (Apache License 2.0)
Additional license details are available in this plugin's licenses folder.
