# app-simulators > Configurable Application simulator for integration testing Latest version **0.1.2** (published 2017-12-25) · ISC license · 0 weekly downloads ## Install ```sh npm install app-simulators pnpm add app-simulators yarn add app-simulators bun add app-simulators ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.1.2 | | Published | 2017-12-25 | | First published | 2017-12-25 | | Weekly downloads | 0 | | License | ISC | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 21 | | Known vulnerabilities | 0 (+26 in 2 direct dependencies) | | Install scripts | no | | Author | skuttleman@gmail.com | | Maintainers | skuttleman | ## Links - npm: https://www.npmjs.com/package/app-simulators - npm.io page: https://npm.io/package/app-simulators ## Dependencies (21) - [cors](https://npm.io/package/cors.md) ^2.8.3 - [path](https://npm.io/package/path.md) ^0.12.7 - [uuid](https://npm.io/package/uuid.md) ^3.1.0 - [axios](https://npm.io/package/axios.md) ^0.16.2 - [babel](https://npm.io/package/babel.md) ^6.16.0 - [react](https://npm.io/package/react.md) ^15.5.0 - [redux](https://npm.io/package/redux.md) ^3.7.0 - [express](https://npm.io/package/express.md) ^4.15.3 - [fun-util](https://npm.io/package/fun-util.md) ^1.2.0 - [react-dom](https://npm.io/package/react-dom.md) ^15.5.0 - [express-ws](https://npm.io/package/express-ws.md) ^3.0.0 - [body-parser](https://npm.io/package/body-parser.md) ^1.17.2 - [react-redux](https://npm.io/package/react-redux.md) ^4.3.0 - [redux-thunk](https://npm.io/package/redux-thunk.md) ^2.2.0 - [react-router](https://npm.io/package/react-router.md) ^3.0.0 - [express-outbound](https://npm.io/package/express-outbound.md) ^1.0.0 - [react-codemirror](https://npm.io/package/react-codemirror.md) ^1.0.0 - [babel-preset-react](https://npm.io/package/babel-preset-react.md) ^6.16.0 - [react-router-redux](https://npm.io/package/react-router-redux.md) ^4.0.8 - [babel-preset-es2015](https://npm.io/package/babel-preset-es2015.md) ^6.16.0 - [babel-preset-stage-1](https://npm.io/package/babel-preset-stage-1.md) ^6.16.0 ## Recent versions - 0.1.2 (latest) — 2017-12-25 - 0.1.1 — 2017-12-25 - 0.1.0 — 2017-12-25 ## README # App Simulator A REST/WebSocket application simulator for integration testing. Isolate your application during automated testing by simulating its dependencies. ## Features - Simulate your external REST dependencies with a simple javascript configuration - Each simulated endpoint can be updated and reset at runtime - Each simulated endpoint tracks requests it receives - A built-in UI for updating/resetting simulators - Simulate active WebSocket connections ## Example `$ npm install --save-dev app-simulators` ```js // simulator.js const createSimulators = require('app-simulators'); const simulators = createSimulators({ simulators: { '/users': { //url for simulator status: 200, // intial status for static response - defaults to 200 response: [{ userId: 1, name: 'Jones' }, { userId: 2, name: 'Smith' }], // initial response body for static response - defaults to no body delay: 0.1, // time to wait (in seconds) before responding - defaults to 0 headers: { 'Custom-Header': 'Custom Header Value' }, // headers added to response method: 'get', // http request method - defaults to 'get' group: 'Users', // used for grouping simulators in the UI name: 'Retrieve Users', // name of service being simulated - displayed in UI description: 'This endpoint is used to retreive the list of active users' // description - displayed in UI }, '/users/:userId': [{ // url can have multiple simulators - methods should be unique method: 'put', group: 'Users' }, { method: 'post', status: 201, group: 'Users' }, { method: 'delete', group: 'Users' }], '/dynamic/service': { respond({ query, body }) { // define a custom handler to return status, body, delay, and headers (syncronously or in a Promise) if (query['some-query-param'] === undefined) { return { status: 400, delay: 0.5 }; } return doSomethingAsync(body) .then(result => ({ body: result, headers: { Cool: 'very' } })); }, delay: 0.1, // the status, body, delay, and headers are overwritten by the result of the "respond" function - if keys exist name: 'Dynamic Simulator' }, '/websocket': { socket: true, //identifies simulator as a persisten websocket connection instead of http simulator echo: true, //automatically send back any message received - defaults to false onmessage(socket, message, send) { // optional handler for when a message is received send('this broadcasts to everyone'); send('this goes to the socket the unique id', 'some-uuid'); socket.send('this goes to the socket connection that sent the message'); send('this also goes to the socket connection that sent the message', socket.id); }, onopen(socket, id, send) {}, // optional handler for when a connection is established onclose(socket, status, send) {} // optional handler for when a connection is closed } } }); simulators.listen(8080, () => console.log('Simulators are running on port:', 8080)); ``` `$ node simulator.js` With the simulators running, configure your app's environment to point to the simulators. Each simulator is mounted to `/simulators/`: `$ USERS_SERVICE=http://localhost:8080/simulators/users DYNAMIC_SERVICE=http://localhost:8080/simulators/dynamic/service ./run-my-app.sh` ## REST API The following API can be used to alter/interact with the simulators at runtime. ### Cross-Simulator API #### GET /api/simulators Returns a list of running simulators. This is used to build the UI. ```json [ { "path": "/some/simulator", "method": "POST", "name": "Some Simulator", "group": "", "description": "", "socket": false } ] ``` #### DELETE /api/reset-all Resets all requests and responses for all running simulators. ### HTTP Simulator API Each configured HTTP Simulator has the following interface for updating the simulators once they are running. #### GET /api/requests// Returns a list of requests the simulator received in order of ```json [ { "query": {}, "body": {}, "url": "/simulators/some/simulator", "params": {}, "timestamp": "yyyy-mm-ddThh:MM:ss.SSSZ" } ] ``` #### DELETE /api/requests// Deletes the requests received for that simulator. #### GET /api/response// Gets the current response for the simulator (without including the request in the `GET /api/requests//` response). ```json { "body": { "configured": "response" }, "status": 418, "headers": {}, "delay": 0.01 } ``` #### PUT /api/response// Sets the response for the simulator. Keys left out of the payload will not be updated. ```json { "body": { "new": "body" }, "delay": 0 } ``` Note that the "status" and "headers" will not be updated by this request. #### DELETE /api/response// Reset the simulator back its original behavior. ### WebSocket Simulators Each configured WebSocket Simulator has the following interface for updating the simulators once they are running. #### GET /api/messages/ Returns the socket messages received. ```json [ { "message": { "some": "message" }, "from": "some-uuid", "timestamp": "yyyy-mm-ddThh:MM:ss.SSSZ" } ] ``` #### POST /api/messages/?to= Send the post body as a socket message to the specified socket ID. If the `to` parameter is not included, the message is broadcast to all active connections for the given . #### DELETE /api/messages/ Resets the socket messages received. #### GET /api/clients/ Returns a list of UUID's for the currently connected clients. ```json [ "some-uuid", "some-other-uuid" ] ``` ## Changelog - 0.1.0 - API test coverage - Example app - Bare bones UI - README.md --- _Source: https://npm.io/package/app-simulators · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._