README.md 1.71 KB
Newer Older
Alexandra Rogova's avatar
Alexandra Rogova committed
1
# Mynij Unit Tests
Alexandra Rogova's avatar
Alexandra Rogova committed
2 3 4 5 6 7 8 9
Unit tests to determine the time and cost of running [Mynij](https://lab.nexedi.com/ARogova/Mynij) separated into different milestones :
  * Milestone 1 : Memory usage, RAM usage and time for basic functions
  * Milestone 2 : Parsing and searching quality

# Results
Our results and a quick analysis can be found here :
  * Milestone 1 : https://alpha.iodide.io/notebooks/3633/?viewMode=report
  * Milestone 2 : https://alpha.iodide.io/notebooks/3900/?viewMode=report
Alexandra Rogova's avatar
Alexandra Rogova committed
10 11 12 13 14

# Run your own tests
You can easily verify the results for yourself. Just follow these instructions :

## Prerequisites
Alexandra's avatar
Alexandra committed
15
All tests were built using [nodejs](https://nodejs.org/en/) (please follow the instructions given on the nodejs website to install) and [puppeteer](https://developers.google.com/web/tools/puppeteer) (init using `node install puppeteer`).
Alexandra Rogova's avatar
Alexandra Rogova committed
16 17 18 19 20

## Downloading
Simply clone this git, all necessary files (including nodejs modules) should be downloaded automatically.

## Running
Alexandra's avatar
Alexandra committed
21 22 23 24 25
  * Executing all tests : for each milestone, launch Milestone[X]/run.js (May take a long time !)
  * Executing a specific test on all available files: launch run.js with `-o test_name`  
  * Executing a specific test on a specific file: launch run.js with `-o test_name -f file_path`
  * A verbose option is available (`-v`) to log all server message to the nodejs console. This is a good way to monitor what's happening with the tests.
  * The config file (Milestone[X]/config.json) is human-readable to allow for easy changes in case you want to modify the result files path or the Mynij instance link.
Alexandra Rogova's avatar
Alexandra Rogova committed
26

Alexandra Rogova's avatar
Alexandra Rogova committed
27 28
## Adding test cases/files
Add your file to the corresponding folder in Milestone[X]/files and the bench should test it automatically.