gruu-api v0.2.4

gruu-api

Core API for Gruu and Mukla - Minimal, modern and extensible test runners

You might also be interested in always-done.

Table of Contents

• Install
• Usage
• API
  • Gruu
• Related
• Contributing
• Building docs
• Running tests
• Author
• License

(TOC generated by verb using markdown-toc)

Install

Install with npm

$ npm install gruu-api --save

or install using yarn

$ yarn add gruu-api

Usage

For more use-cases see the tests

const gruuApi = require('gruu-api')

API

Gruu

Initialize Gruu constructor with optional options object. Basically it is just dush which is simple event emitter system and has .on, .off, .once, .emit and .use methods. In addition the runner adds .define, .delegate, .add and .run methods. Use .add to define new test and .run to start the suite. One more cool thing is that it emit life-cycle events - start, beforeEach, pass, fail, afterEach and finish. So for example if test fail it will emit fail, beforeEach and afterEach events which you can listen with .on('fail', fn). By default gruu-api does not comes with included reporter, so you can give listener to each event manually or pass options.reporter which is the same thing as plugin - a function that is called immediatelly with (app) signature.

All options are also passed to redolent and each-promise. Tests by default are ran concurrently in opts.settle:true mode (means that it won't stop after the first found error), so .run().then() will be called always.

Params

• options {Object}: see more in Options Section (soon)
• returns {Object}: an object that is returned from dush

Example

const delay = require('delay')
const Gruu = require('gruu-api')

const app = Gruu()

// DEFINE TEST SUITE
app.add('my awesome test', (t) => {
  t.strictEqual(111, 111, 'should be 111 === 111')
})

// note: use node >= 7.6
app.add('failing async test', async (t) => {
  await delay(500)
  t.ok(false)
})

app.add('some failing test', (t) => {
  t.strictEqual('foo', 123)
})

// CUSTOM TAP REPORTER, built as plugin
app.use((app) => {
  // makes error object enhanced
  const metadata = require('stacktrace-metadata')

  app.once('start', (app) => {
    console.log('TAP version 13')
  })
  app.on('pass', (app, test) => {
    console.log('# :)', test.title)
    console.log('ok', test.index, '-', test.title)
  })
  app.on('fail', (app, { title, index, reason }) => {
    console.log('# :(', title)
    console.log('not ok', index, '-', title)

    const err = metadata(reason, app.options)
    delete err.generatedMessage

    // TAP-ish YAML-ish output
    let json = JSON.stringify(err, null, 2)
    json = json.replace(/^\{/, '  ---')
    json = json.replace(/\}$/, '  ...')
    console.log(json)

    // or the whole stack
    // console.log(err.stack)
  })
  app.once('finish', ({ stats }) => {
    console.log('')
    console.log(`1..${stats.count}`)
    console.log('# tests', stats.count)
    console.log('# pass ', stats.pass)

    if (stats.fail) {
      console.log('# fail ', stats.fail)
      console.log('')
      process.exit(1)
    } else {
      console.log('')
      console.log('# ok')
      process.exit(0)
    }
  })
})

// START DEFINED TEST SUITE
app.run().then(
  () => console.log('done')
)

Related

• always-done: Handle completion and errors with elegance! Support for streams, callbacks, promises, child processes, async/await and sync functions. A drop-in replacement… more | homepage
• minibase: Minimalist alternative for Base. Build complex APIs with small units called plugins. Works well with most of the already existing… more | homepage
• try-catch-core: Low-level package to handle completion and errors of sync or asynchronous functions, using once and dezalgo libs. Useful for and… more | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Please read the contributing guidelines for advice on opening issues, pull requests, and coding standards.
If you need some help and can spent some cash, feel free to contact me at CodeMentor.io too.

In short: If you want to contribute to that project, please follow these things

1. Please DO NOT edit README.md, CHANGELOG.md and .verb.md files. See "Building docs" section.
2. Ensure anything is okey by installing the dependencies and run the tests. See "Running tests" section.
3. Always use npm run commit to commit changes instead of git commit, because it is interactive and user-friendly. It uses commitizen behind the scenes, which follows Conventional Changelog idealogy.
4. Do NOT bump the version in package.json. For that we use npm run release, which is standard-version and follows Conventional Changelog idealogy.

Thanks a lot! :)

Building docs

Documentation and that readme is generated using verb-generate-readme, which is a verb generator, so you need to install both of them and then run verb command like that

$ npm install verbose/verb#dev verb-generate-readme --global && verb

Please don't edit the README directly. Any changes to the readme must be made in .verb.md.

Running tests

Clone repository and run the following in that cloned directory

$ npm install && npm test

Author

Charlike Mike Reagent

• github/tunnckoCore
• twitter/tunnckoCore
• codementor/tunnckoCore

License

Copyright © 2016-2017, Charlike Mike Reagent. Released under the MIT License.

This file was generated by verb-generate-readme, v0.4.3, on March 16, 2017.
Project scaffolded using charlike cli.