redux-actions-assertions

Assertions for redux actions testing.

This library adds assertions for redux actions testing.
It use redux-mock-store to mock redux store.

Supported Assertion Frameworks/Libraries:

• chai
• expect
• expect.js
• jasmine
• jest
• should
• tape
• pure javascript assertion

If you have not found assertion framework/library that you are using - please add comment into this issue.

What it does:

• Allows to avoid retesting nested action creators;
• Reduces repetitive code of test methods;
• Simplifies initial setup;

Allows to avoid retesting nested action creators

It allows to test only actions that need to be tested.

Example:
We have two actions (A, B). Each one makes async http requests.
Action A makes a request and if the result is successful it triggers Action B.
Action B is also used as an independent action.
Action B can be tested separately.
Therefore, we don't need to test it again in Action A.

Actions:

1function actionA() {
2  return dispatch => {
3    dispatch(actionAStart());
4    return api.getA().then(response => {
5        dispatch(actionAFinish(response));
6        dispatch(actionB());
7      }).catch(err => {
8        dispatch(actionAFailure(err));
9      });
10    };
11}
12
13function actionB() {
14  return dispatch => {
15    dispatch(actionBStart());
16    return api.getB().then(response => {
17        dispatch(actionBFinish(response));
18      }).catch(err => {
19        dispatch(actionBFailure(err));
20      });
21    };
22}

Without:

1const expectedActions = [
2  { type: action_a_start },
3  { type: action_a_success },   
4  { type: action_b_start }, // retesting of action B
5  { type: action_b_success } // retesting of action B];
6const store = mockStore({ todos: [] });
7store.dispatch(actionA()).then(() => {
8  expect(store.getActions()).toEqual(expectedActions);
9}).then(done).catch(done);

With:

1expect(actionA()).withState({ todos: [] }).toDispatch([
2  { type: action_a_start },
3  { type: action_a_success },
4  actionB() // just executing tested action
5], done);

Reduces repetitive code of test methods

It reduces boilerplate of test methods and makes testing fluent.

Without:

1const store = mockStore(/* initial state */);
2const expectedActions = [
3  { type: types.FETCH_TODOS_REQUEST },
4  /* All expected triggered action objects */
5];
6store.dispatch(fetchData()).then(() => {
7  const actions = store.getActions();
8  expect(actions).toEqual(expectedActions);
9}).then(done).catch(done);

With:

1const expectedActions = [
2  /*All expected triggered action objects or action creator functions*/
3];
4expect(fetchData()).toDispatchActions(expectedActions, done);

With using customised store state:

1expect(fetchData()).withState({/*custom state*/}).toDispatchActions(expectedActions, done);

Simplifies initial setup

It provides singe-time global configuration for middlewares and initial store state.

Without:

1const middlewares = [thunk];
2const mockStore = configureStore(middlewares);
3const store = mockStore({ /*initial store object*});

With:

1registerMiddlewares([ thunk ]);
2// to set custom initial state 
3registerInitialStoreState(/*object of function*/);
4// to generate initial state of your application
5registerInitialStoreState(buildInitialStoreState(/*your root reducer*/));

Installation

Using npm:

$ npm install --save-dev redux-actions-assertions

Redux middlewares registration

1// using ES6 modules
2import { registerMiddlewares } from 'redux-actions-assertions';
3
4// using CommonJS modules
5var registerMiddlewares = require('redux-actions-assertions').registerMiddlewares;
6
7// registration
8registerMiddlewares([
9  /* Here you need to list your middlewares */
10]);

Default initial store state registration

By using state object or function:

1// using ES6 modules
2import { registerInitialStoreState } from 'redux-actions-assertions';
3
4// using CommonJS modules
5var registerInitialStoreState = require('redux-actions-assertions').registerInitialStoreState;
6
7// registration
8registerInitialStoreState(/* default initial state object or function */);

By using your root reducer:

1// using ES6 modules
2import { buildInitialStoreState, registerInitialStoreState } from 'redux-actions-assertions';
3
4// using CommonJS modules
5var reduxActionsAssertions = require('redux-actions-assertions');
6var registerInitialStoreState = reduxActionsAssertions.registerInitialStoreState;
7
8// registration
9registerInitialStoreState(buildInitialStoreState(/* root reducer function */));