Repository files navigation

Communicate with aMockServer from any node or grunt build

• Backlog:                     
• Freature Requests:  
• Issues / Bugs:           
• Chat:                           

MockServer allows you to mock any system you integrate with via HTTP or HTTPS (i.e. (REST) services, web sites, etc). Please note that it is a third party project that needs java.

This npm module allows any grunt or node project to easily communicate with a runningMockServer instance.

As an addition to this module for communicating with a running MockServer there is a second project that can be used to start and stop a MockServer calledmockserver-node.

The MockServer client can be created as follows:

varmockServer=require('mockserver-client'),mockServerClient=mockServer.mockServerClient// MockServer and proxy client

Note: this assumes you have an instance of MockServer running on port 1080.For more information on how to do so checkmockserver-node.

A simple expectation can be set up as follows:

mockServerClient("localhost",1080).mockSimpleResponse('/somePath',{name:'value'},203).then(function(result){// do something next},function(error){// handle error});

A more complex expectation can be set up like this:

mockServerClient("localhost",1080).mockAnyResponse({'httpRequest':{'method':'POST','path':'/somePath','queryStringParameters':[{'name':'test','values':['true']}],'body':{'type':"STRING",'value':'someBody'}},'httpResponse':{'statusCode':200,'body':JSON.stringify({name:'value'}),'delay':{'timeUnit':'MILLISECONDS','value':250}},'times':{'remainingTimes':1,'unlimited':false}}).then(function(result){// do something next},function(error){// handle error});

For the full documentation seeMockServer - Creating Expectations.

It is also possible to verify that request were made:

mockServerClient("localhost",1080).verify({'method':'POST','path':'/somePath','body':'someBody'},1,true).then(function(){// do something next},function(failure){// handle verification failure});

It is furthermore possible to verify that sequences of requests were made in a specific order:

mockServerClient("localhost",1080).verifySequence({'method':'POST','path':'/somePathOne','body':'someBody'},{'method':'GET','path':'/somePathTwo'},{'method':'GET','path':'/somePathThree'}).then(function(){// do something next},function(failure){// handle verification failure});

For the full documentation seeMockServer - Verifying Requests.

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code usingGrunt.

All notable and significant changes are detailed in theMockServer changelog

Task submitted byJames D Bloom