k6 extension to test and benchmark NeoFS related protocols.

---

xk6-neofs

Build

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

• Go
• Git
• Python 3 (for preset scripts)

1. Clone this repository

git clone https://github.com/nspcc-dev/xk6-neofs
cd xk6-neofs

2. Install xk6 framework for extending k6:

make install_xk6

3. Build the binary:

make build

4. Run k6:

./xk6-neofs run test-script.js

Preset

preset_grpc.py and preset_s3.py prepare containers/buckets and objects for the k6 scenarios. Install their Python dependencies into .venv:

make install_preset
source .venv/bin/activate

preset_grpc.py still needs neofs-cli on PATH to create containers.

python ./scenarios/preset/preset_grpc.py --wallet ./wallet.json --config ./config.yml \
  --endpoint 192.168.42.10:8080 --workers 1 --policy "REP 3" \
  --containers 1 --preload_obj 100 --size 4 --out ./grpc.json

See scenarios/run_scenarios.md for S3 presets and full scenario options.

API

Native

Create native client with connect method. Arguments:

• neofs storage node endpoint
• hex encoded private key (empty value produces random key)
• dial timeout in seconds (0 for the default value)
• stream timeout in seconds (0 for the default value)

import native from 'k6/x/neofs/native';
const neofs_cli = native.connect("s01.neofs.devenv:8080", "", 0, 0)

Methods

• putContainer(params). The params is a dictionary (e.g. {acl:'public-read-write',placement_policy:'REP 3',name:'container-name',name_global_scope:'false'}). Returns dictionary with success boolean flag, container_id string, and error string.
• setBufferSize(size). Sets internal buffer size for data upload and download. Default is 64 KiB.
• put(container_id, headers, payload). Returns dictionary with success boolean flag, object_id string, and error string.
• get(container_id, object_id). Returns dictionary with success boolean flag, and error string.
• onsite(container_id, payload). Returns NeoFS object instance with prepared headers. Invoke put(headers) method on this object to upload it into NeoFS. It returns dictionary with success boolean flag, object_id string and error string.

S3

Create s3 client with connect method. Arguments:

• s3 gateway endpoint

Credentials are taken from default AWS configuration files and ENVs.

import s3 from 'k6/x/neofs/s3';
const s3_cli = s3.connect("http://s3.neofs.devenv:8080")

You can also provide additional options:

import s3 from 'k6/x/neofs/s3';
const s3_cli = s3.connect("http://s3.neofs.devenv:8080", {'no_verify_ssl': 'true', 'timeout': '60s'})

• no_verify_ss - Bool. If true - skip verifying the s3 certificate chain and host name (useful if s3 uses self-signed certificates)
• timeout - Duration. Set timeout for requests (in http client). If omitted or zero - timeout is infinite.

Methods

• createBucket(bucket, params). Returns dictionary with success boolean flag and error string. The params is a dictionary (e.g. {acl:'private',lock_enabled:'true',location_constraint:'ru'})
• put(bucket, key, payload). Returns dictionary with success boolean flag and error string.
• get(bucket, key). Returns dictionary with success boolean flag and error string.

Examples

See native protocol and s3 test suit examples in examples dir.

License

• GNU General Public License v3.0