Getting Started with Specs

What's a Spec?

A use case describes WHAT an application does, but it does not capture the intentions (expected behavior) that led to the creation of that use case, in other words, WHY this use case exists.

For instance, a scenario for an application that involves payment would be "When paying the full amount, the discount applies" and the use case to support it would be "Pay for a Product".

So, Specs capture the usage intent of an application through its scenarios.

In doing that it also ensures that the scenario will exercise the application with known inputs and validate the expected outputs.

Installing

$ npm install @herbsjs/herbs
$ npm install @herbsjs/herbs-cli

Using

Firts, you need to create a spec file, for example, taskCount.spec.js:

const { spec, scenario, given, check, samples } = require('@herbsjs/herbs').specs
const { herbarium } = require('@herbsjs/herbarium')

// Define the spec
const taskCountSpec = spec({
    'Change count for the task': scenario({
        'Given a valid task': given({ task: 'do it', count: 0 }),
        'When increase count': when((ctx) => (ctx.count++)),
        'Must have a increased count': check((ctx) => { assert.ok(ctx.count === 1) }),
    }),
})

// Export using herbarium
module.exports =
    herbarium.specs
        .add(taskCountSpec, 'taskCountSpec')
        .spec

Then, you can run it:

$ herbs spec

This will run all specs files (ending with .spec.js) in the project.

To learn more about how to use Specs, check the features page.