k6 extension to test and benchmark FrostFS related protocols.
xk6-frostfs
Build
To build a k6
binary with this extension, first ensure you have the prerequisites:
- Install
xk6
framework for extending k6
:
go install go.k6.io/xk6/cmd/xk6@latest
- Clone this repository
git clone github.com/TrueCloudLab/xk6-frostfs
cd xk6-frostfs
- Build the binary:
xk6 build --with github.com/TrueCloudLab/xk6-frostfs=.
- Run k6:
./k6 run test-script.js
API
Native
Create native client with connect
method. Arguments:
- frostfs 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/frostfs/native';
const frostfs_cli = native.connect("s01.frostfs.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 FrostFS object instance with prepared
headers. Invoke put(headers)
method on this object to upload it into FrostFS.
It returns dictionary with success
boolean flag, object_id
string and
error
string.
S3
Create s3 client with connect
method. Arguments:
Credentials are taken from default AWS configuration files and ENVs.
import s3 from 'k6/x/frostfs/s3';
const s3_cli = s3.connect("http://s3.frostfs.devenv:8080")
You can also provide additional options:
import s3 from 'k6/x/frostfs/s3';
const s3_cli = s3.connect("http://s3.frostfs.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