program-bdd-demo

Program BDD Demo

A demo app using storybook, cucumber.js, selenium, redux, relay and some other latest technologies.

The purpose of the demo app is to learn and find the best development patterns.

• NPM package
• Component Library

Install

npm install program-bdd-demo --Save

How to use

npm install
npm run storybook

• Publish to github pages: npm run publish-storybook (add git remote repo before running this command)
• Publish to npm: npm publish (will need to run npm adduser if npm user is not present)

01. Setup Storybook

I use the basic setup by react cdk. With the generator, we'll have a minimal react storybook running locally, which will also give the common react setups such as babel, mocha, enzyme, sinon, webpack, etc.

npm install -g yo generator-react-cdk
yo react-cdk program-bdd-demo
cd program-bdd-demo
npm install
npm run storybook

Here is a the article on how react cdk works by Arunoda Susiripala: Say Hello to React CDK Note you'll need to add 'webpack-hot-middleware' as devDependencies as it's missing from the package tempalte. I've opened a PR and still waiting for it to be merged.

02. Setup Coverage Reporting

For coverage reporting, I use Istanbul. Istanbul is a coverage tool that computes statement, line, function and branch coverage with module loader hooks to transparently add coverage when running tests. It supports all JS coverage use cases including unit tests, server side functional tests and browser tests

Note the latest Istanbul release 0.4.4 doesn't work well with babel 6x and node 6x version. So we'll have to manually install the alpha version of Istanbul.

npm install istanbul@^1.0.0-alpha -D

To have a visual view of the coverage, I'll use codecov. Codecov is an online tool for gathering and analyzing the coverage reports.

npm install codecov -D

To be able to see the report at codecov, we'll need to push the repo to github first, then visit https://codecov.io/gh/vidaaudrey/program-bdd-demo to get the repository token (remember to change the repo name to yours).

To store the token in the node env, run export CODECOV-TOKEN=[your repo token], then add below script to package.json to upload the coverage report to codecov.

"report-coverage": "codecov"

03. Semantic Release, Git Commit Hook, Commitizen

To better manage the versions and git commit, we are going to use following packages:

• Semantic Release
• Commitizen
• GitHooks

Add below script to package.json. It will help run the coverage test before any git commit. And only if the tests pass the minimum threshold, the coverage result will be uploaded to codecov and the commit will be successful.

"config": {
  "ghooks": {
    "pre-commit": "npm run test:cover && npm run check-coverage",
    "post-commit": "npm run report-coverage",
  }
},

We'll also replace git commit command with git-cz which will use commitizen to structure the commit messages. To make it easy to remember, add "commit": "git-cz", to npm script.

Now when the dev process would be:

• Make changes
• Add file to commit by git add FILE
• Run npm run commit
• Fill the commit type, scope, breaking changes, etc. Semantic Release will help manage the versions based on the changes. If there is any breaking changes, Semantic Release will bump the major version.
• Ghooks will run the coverage test, and if the tests doesn't meet the minimum requirements on statements, function, branches, and lines, the commit will not be successful.
• Once the commit is successful, we'll upload the coverage report to codecov for further analysis.

04. Use dotenv to manage environment variables

As the project grows, we'll need a better strategy to manage the environment variables. dotenv is very good option for this purpose.
Add add below script to npm so we can setup the environment variable as early:

"postinstall": "node .scripts/env.config.js",

Now install the dotenv package:

npm install dotenv -S

05. BDD setup

Cucumber is a tool for running automated tests written in plain language. Run

npm install cucumber -D
npm install zombie -D

Write a feature

//features/app.feature
Feature: Search Google
  As a user, I want to user Google to search

  Scenario: Visit Page
    Given I am on Google home page
    Then I should see "Google" as the page title

  Scenario: Search By Keyword
    Given I am on Google home page
    When I input the keywords and start search
    Then I should see the search results

Create a world where the feature will be running:

//features/support/world.js
const Zombie = require('zombie');
const browser = new Zombie();

// browser, visit will be available in the step definition
function World() {
  this.browser = browser;

  this.visit = function (url, callback) {
    this.browser.visit(url, callback);
  };
}

module.exports = function () {
  this.World = World;
};

Add the step definition

//features/step_definition/my_step_definitions.js
const URL = 'http://google.com';

const mySteps = function() {
  this.Given(/^I am on Google home page$/, function(callback) {
    return this.visit(URL, callback);
  });

  this.Then(/^I should see "(.*)" as the page title$/, function(title, callback) {
    const pageTitle = this.browser.text('title');
    if (title === pageTitle) {
      callback();
    } else {
      callback(new Error("Expected to be on page with title " + title));
    }
  });

  this.When(/^I input the keywords and start search$/, function(callback) {
    this.browser.fill('q', 'coursera')
      .pressButton('input[type=submit]', callback);
  });

  this.Then(/^I should see the search results$/, function(callback) {
    this.browser.assert.success();
    callback();
  });
};

module.exports = mySteps;

To be able to run the cucumber-js from terminal, we'll also add "bdd": "cucumber-js" to the script of package.json, then run

npm run bdd

You'll see the result.