dev-contract-test v0.0.4
contract-tester
Tool to do contract testing from Front-end perspective.
Why contract testing?
With rise of popular Javascript frameworks like Angular, React, Ember and more. Single page applications work with REST backend over JSON. And there is always a chance that something time to time changed from backend, be it part of change in functionality, refactoring or any other reason.
For example:
As a front-end developer, your frontend app consumes JSON exposed by REST api. JSON schema as contract is in agreement between frontend and backend, and app is working just fine. But suddenly, for some reason the frontend app is behaving wierd. Data in your app/component is not rendering properly or not rendering at all. But you havn't changed a bit in your code. Is this due to something changed in api from backend?
Here comes the contract-tester to rescue.
How does it works?
contract tester works in 2 modes -
- Record - Records the JSON from backend api and saves it as physcial JSON file.
- Play - Compares the JSON saved (that worked fine) with the api now (that has something changed).
In case of discrepancies, tool with throw error and notifies where mismatch is.
Example?
This is when things worked -
{ "Title":"Frozen", "Year":"2013" }
But when schema changed -
{ "Title":"Frozen", "YearOfRelease":"2013" }
from 'Year' to 'YearOfRelease', things BROKE.