![\"Pipeline](\"https://gitlab.com/artdeco/contexttesting/zoroaster/badges/master/pipeline.svg\"\n)
\n\n\n\n![](\"doc/graphics/movzcard.gif\")
](https://contexttesting.com) _Zoroaster_ is a modern JavaScript testing framework for _Node.js_. It introduces the concept of test contexts, which aim in helping to provide documentable and re-usable test infrastructure, across spec files in a single package, as well as across packages. It's a completely new and developer-friendly approach to writing tests, which greatly improves productivity, testing experience and the reliability on tests. In addition, it allows to write _ES6_ module syntax without `Babel`.\n\nFor example, you can make use of `https-context` to set-up a mock HTTP server with configurable responses and `temp-context` to create and remove a temp directory ready for each test without having to worry about repetitively writing the same code across projects. The way tests are written allows to see IDE suggestions for every method and property available in a context. Because these packages are maintained as separate pieces of software, they are also tested which means that there are less chances of an error in test set-ups which could lead to false-positive results.\n\n[![](\"doc/graphics/movflamecolumn.gif\")
](http://www.crystalinks.com/zoroaster.html)[](http://nodejs.tools) Are you fed up with `mocha` or have you had enough `chai` in your life? Is it not time to say good-bye to the old stereotype that the same software must be used every day? Say no more, _Zoroaster_ is here to save our souls and bring a change.\n\n---\n\n```fs\nyarn add -D zoroaster\n```\n\n```fs\nnpm i --save-dev zoroaster\n```\n\n\n\n## Table Of Contents\n\n- [Table Of Contents](#table-of-contents)\n- [Do You Want Testing Framework That...](#do-you-want-testing-framework-that)\n * [Is Very Small And Super Fast](#is-very-small-and-super-fast)\n * [Shares Set-Ups And Tear-Downs Between Files And Packages](#shares-set-ups-and-tear-downs-between-files-and-packages)\n * [Implements Masks To Only Write Inputs/Outputs](#implements-masks-to-only-write-inputsoutputs)\n * [Was Made To Test Forks](#was-made-to-test-forks)\n * [Supports Snapshots And Streams](#supports-snapshots-and-streams)\n- [Quick Example](#quick-example)\n- [Example](#example)\n * [async functions](#async-functions)\n * [Running Example](#running-example)\n- [Wiki](#wiki)\n- [Copyright & License](#copyright--license)\n\n\n\n## Do You Want Testing Framework That...\n\n_Zoroaster_ is the most modern _Node.JS_ testing framework that addresses the full spectrum of developer's needs and innovates the way quality assurance is done on NPM packages.\n\nRead more about testing Node.JS projects on [NodeTools website](https://art-deco.github.io/nodetools/trapcss-nodetools-tutorial.html#creating-tests). In the guide, you can learn to create fully documented, tested and properly COMPILED (with Closure Compiler) pieces of professional Node.JS software.\n\n### Is Very Small And Super Fast\n\n_Zoroaster_ does not have many dependencies and does not install Babel, yet it is able to run tests with `import/export` statements. Having less dependencies in `node_modules` means that any new dependencies needed for the project will be installed immediately without having to wait for linking to complete, and new projects can be started in seconds, resolving all testing framework's dependencies almost instantly. Furthermore, _Zoroaster_ only loads 3 JavaScript files, that is itself (1000 lines of code optimised with _Google Closure Compiler_), the interface for a service context (34 lines) and the _RegExp-based_ algorithm to transpile `import/export` statements (when the `-a` option is passed) which is also optimised. The tests will start and run in milliseconds.\n\n| Framework | Fetching | Linking | Disk | Node_Module Dirs | yarn.lock Lines | Downloads |\n| --------- | -------- | ------- | ------- | ---------------- | --------------- | --------- |\n| Jest | 485 | 7407 | 59.75MB | 420 | 3614 | 3,713,921 |\n| Mocha | 115 | 2016 | 12.17MB | 103 | 785 | 2,523,262 |\n| Jasmine | 13 | 106 | 896KB | 13 | 88 | 1,040,918 |\n| Tape | 33 | 506 | 2.85MB | 33 | 228 | 411,483 |\n| Ava | 462 | 6605 | 34.34MB | 378 | 3281 | 122,355 |\n| Tap | 469 | 7905 | 94.12MB | 407 | 3375 | 101,879 |\n| Zoroaster | 4 | 31 | 448KB | 3 | 27 | 1096 |\n\nCompared to the other frameworks, _Jasmine_ test runner is the next most-lightweight one, followed by modest _Tape_ and good old _Mocha_, however they don't support snapshots and don't work with ES6 modules out of the box. Although there is no browser version of `zoroaster` at the moment, it is still possible to test the source code in the browser, for example by setting up a server that loads HTML pages with JS code, and using the headless Chrome to open those pages and get the result. There will be more support for browsers in the near future.\n\n\n\n### Shares Set-Ups And Tear-Downs Between Files And Packages\n\nOne of the disadvantages of conventional testing frameworks is that they force developers to put setup and tear-down logic directly in test suites, which prevents management of tests by files. Using local scopes to store test states, limited access to the JSDoc and breaking of the DRY (don't repeat yourself) principle makes testing inconvenient. _Zoroaster_ is the first **Context-Testing** framework that approaches the problem from the completely different angle: there is no setups and teardowns on tests, there is a context, which can be initialised and destroyed. Contexts are kept in separate files and can be written as classes, which greatly improves developer experience by allowing to access contexts' documented APIs. The contexts can be tested on their own merit, i.e. there is an inherent possibility to \"test the tests\" to take the quality assurance to the next level. Unlike before and after eachs, test contexts can not only be shared by test suites in different files, but also be published and reused across projects, so that more time is left to actually writing the tests and rather than wasting it on repetitive setups.\n\n\n ![\"Zoroaster](\"doc/z.gif\")
\n
| Mask | Mask Result |
|---|---|
![\"The](\"doc/why/mask1.gif\") \n | ![\"The](\"doc/why/mask-result4.gif\") \n |
The mask uses the makeTestSuite method to create a test suite with multiple tests which perform the same logic, but for different inputs. Here, we use the getTransform property to create a stream which will find a certain marker in the code which points to the location of types.xml file, and read that file to embed JSDoc documentation. We also make use of the TempContext which writes the types property of the mask into a temp file. | \nAfter the mask is setup once, we can add as many tests as we want in the mask result file easily. Because the getTransform property was specified, the transform stream returned by it will be ended with the result's input, and the output collected and compared against the expected property of the mask. We use a custom propStart and propEnd regular expressions that split properties by /*@ (start) and /*@*/ (end), because the default is /* (start) and /**/ (end) which would interfere with generated JSDoc. | \n
\n \n ![\"Art](\"https://gitlab.com/uploads/-/system/group/avatar/7454762/artdeco.png\"\n) \n \n | \n Β© Art Decoβ’ for ContextTesting 2020 | \n\n \n ![\"ContextTesting\"](\"https://avatars1.githubusercontent.com/u/44418436?s=100\") \n \n | \n ![\"AGPL-3.0\"](\".documentary/agpl-3.0.svg\") | \n
|---|
![\"The](\"doc/end.jpg\")
![](\"/.documentary/section-breaks/0.svg?sanitize=true\")
\n![](\"/.documentary/section-breaks/1.svg?sanitize=true\")
\n![](\"/.documentary/section-breaks/2.svg?sanitize=true\")
\n![](\"/.documentary/section-breaks/3.svg?sanitize=true\")
\n![](\"/.documentary/section-breaks/4.svg?sanitize=true\")
\n![](\"/.documentary/section-breaks/5.svg?sanitize=true\")
\n![](\"/.documentary/section-breaks/6.svg?sanitize=true\")
\n![](\"/.documentary/section-breaks/7.svg?sanitize=true\")
\n![](\"/.documentary/section-breaks/8.svg?sanitize=true\")
\n![](\"/.documentary/section-breaks/9.svg?sanitize=true\")
\n![](\"/.documentary/section-breaks/-1.svg?sanitize=true\")
\n