github.com/hgoscenski/xk6-mongo

MongoDB k6 extension

K6 extension to perform tests on mongo.

Currently Supported Commands

• Supports inserting a document.
• Supports inserting document batch.
• Supports find a document based on filter.
• Supports find all documents of a collection.
• Supports delete first document based on filter.
• Supports deleting all documents for a specific filter.
• Supports dropping a collection.

xk6-mongo

A k6 extension for interacting with mongoDb while testing.

Build

To build a custom k6 binary with this extension, first ensure you have the prerequisites:

• Go toolchain
• Git

• Download xk6:

  go install go.k6.io/xk6/cmd/xk6@latest
  

• Build the k6 binary:

  xk6 build --with  github.com/GhMartingit/xk6-mongo
  

  This will create a k6 binary that includes the xk6-mongo extension in your local folder. This k6 binary can now run a k6 test.

Development

To make development a little smoother, use the Makefile in the root folder. The default target will format your code, run tests, and create a k6 binary with your local code rather than from GitHub.

git clone [e-mail]/GhMartingit/xk6-mongo.git
cd xk6-mongo
make build

Using the k6 binary with xk6-mongo, run the k6 test as usual:

./k6 run test.js

Examples:

Document Insertion Test

import xk6_mongo from 'k6/x/mongo';


const client = xk6_mongo.newClient('mongodb://localhost:27017');
export default ()=> {

    let doc = {
        correlationId: `test--mongodb`,
        title: 'Perf test experiment',
        url: 'example.com',
        locale: 'en',
        time: `${new Date(Date.now()).toISOString()}`
    };

    client.insert("testdb", "testcollection", doc);
}