Joystream/storage-benchmarking-tool

Storage Benchmarking Tool for Joystream Network

Features

• Upload a file to the primary liaison.
• Download a full file from any storage provider.
• Generate random ranges (offsets and base64 hash) based on a full download of a file.
• Download content in random ranges and compare their hashes to previously generated ones.

Setup

# Install Node.js dependencies:
yarn

# Run TypeScript compilation:
yarn build

# Alternatively you can run TypeScript compilation in watch mode.
# This will recompile any *.ts files that have been changed.
yarn build:watch

Usage

# See help on how to use this tool:
./bench.sh -h

Available scripts

• clean - remove coverage data, Jest cache and transpiled files,
• build - transpile TypeScript to ES6,
• build:watch - interactive watch mode to automatically transpile source files,
• lint - lint source files and tests,
• test - run tests,
• test:watch - interactive watch mode to automatically re-run tests

What's included:

• TypeScript 3.5,
• TSLint with Microsoft rules,
• Jest unit testing and code coverage,
• Type definitions for Node.js and Jest,
• Prettier to enforce a consistent code style,
• NPM scripts for common operations,
• .editorconfig for consistent file format.

The main code is located in the src and unit tests in the __tests__ directories.

Unit tests in JavaScript

Writing unit tests in TypeScript can sometimes be troublesome and confusing. Especially when mocking dependencies and using spies.

This is optional, but if you want to learn how to write JavaScript tests for TypeScript modules, read the corresponding wiki page.

License

Licensed under the GNU GPL v3.