Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/quangv/mocha-cakes
(inactive) BDD mocha test framework add-on, stories with Cucumber style Given/When/Then syntax for Node.js
https://github.com/quangv/mocha-cakes
Last synced: 24 days ago
JSON representation
(inactive) BDD mocha test framework add-on, stories with Cucumber style Given/When/Then syntax for Node.js
- Host: GitHub
- URL: https://github.com/quangv/mocha-cakes
- Owner: quangv
- License: mit
- Created: 2011-12-17T07:43:19.000Z (almost 13 years ago)
- Default Branch: master
- Last Pushed: 2016-09-18T07:49:43.000Z (about 8 years ago)
- Last Synced: 2024-09-29T07:20:58.284Z (about 1 month ago)
- Language: CoffeeScript
- Homepage:
- Size: 56.6 KB
- Stars: 126
- Watchers: 5
- Forks: 6
- Open Issues: 6
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Project is In-Active
Checkout [mocha-cakes-2](https://github.com/iensu/mocha-cakes-2)
# What is it?
[Gherkin](https://github.com/cucumber/cucumber/wiki/Gherkin)-[Cucumber](http://cukes.info/) syntax add-on for [mocha](https://github.com/visionmedia/mocha) javascript/node test framework for customer acceptance testing.
Provides high-level/functional/acceptance test organization lingo, using _'Feature'_, _Stories_, _'Scenarios'_, _'Given/Then/When'_.
# Mocha-Cakes Commands
Mocha-Cakes adds the following commands:
`Feature`
`Scenario`
`Given`
`When`
`Then`
`And`
`But`
`I`
`System`
`Describe`
You can use these commands to describe your tests & specs, as well as mocha's BDD commands `describe`, `it`, `before`, `beforeEach`, `after`, `afterEach` OR mocha's TDD commands `suite`, `test`, `setup`, `teardown`, `suiteSetup`, `suiteTeardown`
# Mocha-Cakes Commands Breakdown
Mocha-Cakes extends Mocha, by adding on helpful commands and print-outs for Acceptance Tests. (Given, When, Then, etc.)
##Acceptance Tests
`Feature`, `Scenario` (maps to _describe_)
`Given`, `When`, `Then` (maps to _it_, but if first message argument is ommited, it'll be a _describe_)
`And`, `But`, `I` (maps to _it_ but if first message argument is ommited, it'll be a _describe_)
### GWTab
GWTab commands can map to a describe if the message argument is ommited.
```coffeescript
Given 'I am at home', -> # it's an it
home.should.eql 'home'
Given -> # it's a describe
it 'is dark', ->
outside.should.eql 'dark'
```
## Grey-Box, System Tests
`System` (if it has a message it'll be an _it_, if not it'll be a _describe_ with System label, useful for testing (grey box) system resources, database, not directly observable by Customer etc.)
```coffeescript
Given ->
System 'Logged Out', ->
Then ->
System ->
it 'should log in', ->
```
## Pretty Commands for Specs/Unit Tests
`Describe` (maps to _describe_ used for things like filenames)
```coffeescript
Describe 'lib/file.coffee' # filename
describe '+copy()', ->
it 'should copy files...', ->
```
## Custom
Mocha-Cakes 0.7 added the `I` command, to do things like:
```
Given ->
I 'have a test', ->
And 'I have another', ->
Then ->
I 'should be good', ->
But 'make sure I am also', ->
```
# Example
_Coffee-Script: test.coffee_
```coffeescript
require 'mocha-cakes'
Feature "New Feature",
"In order to use cool feature",
"as a new user",
"I want do include this", ->
Scenario "Singing", ->
voice = null
Given "I am a good singing", ->
When "I sing", ->
voice = 'good'
Then "it should sound good", ->
voice.should.eql 'good'
```
Run this test using mocha command:
`mocha test.coffee -R spec -r should --compilers coffee:coffee-script`
# What's going on?
Mocha-cakes gives you access to function names
_"Feature", "Scenario"_ that wraps around mocha's `describe()`.
_"Given", "When", "Then", "And", "But"_ wraps around mocha's `it()`. (If first argument is omitted `Given ->` it'll be a `describe()`)
Also bonus, "Describe" wraps around mocha's _describe()_ also, that could be used at the start of spec files. It prints out in bolded blue header with `-R Spec`. And `System()` is a _describe_ or _it_ depending on if first argument is a string or callback.
So the above would output something like:
```cucumber
Feature: New Feature
In order to use cool feature
as a new user
I want do include this
Scenario: Singing
✓ Given: I am a good singing
✓ When: I sing
✓ Then: it should sound good
✓ sound good
✔ 1 tests complete (3ms)
```
## How to Use
Mocha-Cakes provides GWT commands to mocha, and pretty prints it.
To use just:
1. require 'mocha-cakes'
Then you will have access to the mocha-cakes commands _Feature, Scenario, Given, When, Then, etc._
Also to _see_ the pretty output, use the _spec_ reporter
`mocha acceptance_tests.coffee -R spec -r mocha-cakes --compilers coffee:coffee-script`
Note: You can use mocha-cakes with plain javascript.
## Features
```coffeescript
require 'mocha-cakes'
Feature "Big Buttons",
"As a user",
"I want big buttons",
"So it'll be easier to use", ->
Scenario "On Homepage", ->
Given "I am a new user", ->
When "I go to homepage", ->
And "I scroll down", ->
Then "I see big buttons", ->
But "no small text", ->
Given -> # Describe
When "I scroll down more", ->
And "I reach end of page", ->
Then "all I see is big buttons", ->
Describe 'test.spec.coffee', ->
Scenario false, 'Skip Me', ->
```
_\* Remember, they're all either `describe()`'s or `it()`_
## Mix & Match
Also you could still mix-in regular mocha syntax
```
Feature "Mix & Match" ->
Scenario 'Mix-in Mocha', ->
Given "I'm using Mocha-Cakes", ->
Then ->
describe 'Also using regular mocha', ->
I 'should be able to do this', ->
true.should.be true
it 'should work too', ->
true.should.be true
```
Note you can also test asynchronous code with Mocha-Cakes passing a callback argument to any GWTabi command. (`done` for example)
```
Feature "Async tests with Mocha-Cakes", ->
Given "I want to test async code", ->
When "I pass 'done' to GWT commands", ->
Then "It should wait for 'done' to be done.", (done)->
done()
```
## Reference
[The WHY behind TDD/BDD and the HOW with RSpec](http://www.slideshare.net/bmabey/the-why-behind-tddbdd-and-the-how-with-rspec)
# Use it
Install:
cd my_project
npm install --save-dev mocha-cakes
# Mocha Reporter Support
Mocha-Cakes was developed with the `-R spec` in mind.
You can use Mocha-Cakes also with the `-R doc` reporter.
All other reporters should function, but have not been tested.
If you have any questions, issues or comments, please leave them on [mocha-cakes' github](https://github.com/quangv/mocha-cakes/issues).
Thanks!
---
\*Special Thanks\* to [TJ Holowaychuk](https://github.com/visionmedia) for Mocha, awesome test framework.