44 | 47 | {route.route || 'New Route'} 48 |
49 | ); 50 | PanelArray.push( 51 |npm install to download required packages
32 | 4. node server.js to run the server
33 |
34 | ### npm global install
35 |
36 | 1. npm install -g mocknode
37 | 2. run mocknode to start the server
38 |
39 | ### npm local install
40 |
41 | 1. npm install --save mocknode
42 | 2. add an npm script entry in the package.json "mocknode": "mocknode"
43 | 3. run npm run mocknode to start the server
44 |
45 | and open [https://localhost:3000/mocknode/](https://localhost:3000/mocknode/) in your browser to configure mocknode
46 |
47 |
48 | Mocknode has a downstream dependency on buffertools which executes a node-gyp during install.
49 | A common problem with node-gyp exists [nodejs/node-gyp#809](https://github.com/nodejs/node-gyp/issues/809). If there are node-gyp errors during 'npm install' an easy fix is to remove the gyp installed on your OS.
50 |
51 | ## The Port
52 |
53 | The order of preference for the port on which mocknode runs is:
54 |
55 | env variable of process > port option passed > 3000
56 |
57 | mocknode --port 4000 starts the server on port 4000, unless a PORT env variable exists for the process.
58 |
59 |
60 | ## Mocknode configuration
61 |
62 | Open [https://localhost:3000/mocknode/](https://localhost:3000/mocknode/) in your browser to configure mocknode
63 |
64 | 
65 |
66 | All your changes are saved in the config.json file and the stubs folder. This ensures all your changes are saved if you restart mocknode. You can easily backup all of your configuration by making a copy of these files.
67 |
68 | ## Installation directory
69 |
70 | If you have installed mocknode as a global npm package
71 |
72 | mocknode --location prints the installation path of mocknode.
73 |
74 | ## Logs
75 |
76 | mocknode stores logs in the logs/ folder of the installation directory
77 | 1. access.log - logs all requests to mocknode
78 | 2. change.log - logs all configuration change requests made to mocknode
79 |
80 | ## Export and Import config
81 |
82 | The config.json file and stubs folder hold all the configuration of mocknode.
83 |
84 | mocknode --export creates a mocknode-config.tar file which can be used to setup another instance of mocknode.
85 | mocknode --import [file_path] imports a config.tar file to configure mocknode.
86 |
87 | ## HTTP API
88 |
89 | Mocknode exposes a series of endpoints which can help you integrate it with your code - [ test scripts for example ]
90 |
91 |
92 | | enpoint | method | params |
93 | | :------------------------------ | --------:| :------------: |
94 | | /mocknode/api/config | GET | - |
95 | | /mocknode/api/stubconfig | GET | - |
96 | | /mocknode/api/getstub | GET | name |
97 | | /mocknode/api/modifyroute | POST | route config |
98 | | /mocknode/api/deleteroute | GET | route |
99 | | /mocknode/api/modifystub | POST | stub config |
100 | | /mocknode/api/deletestub | GET | name |
101 | | /mocknode/api/modifydynamicstub | POST | stub config |
102 | | /mocknode/api/deletedynamicstub | GET | name |
103 |
104 |
105 | mocknode interface uses the above endpoints to interact with the server, inspect the network of the browser to better understand the parameters used in each api.
106 |
107 | ### Troubleshooting
108 |
109 | The config files and the stubs folder mentioned above have all the information regarding your configuration.
110 |
111 |
112 | ### License
113 |
114 | MIT
115 |
--------------------------------------------------------------------------------
/src/routingManager.jsx:
--------------------------------------------------------------------------------
1 | import React from 'react';
2 | import Store from 'store';
3 | import {Input, ButtonToolbar, ButtonGroup, Button, Grid, Row, Col, Modal} from 'react-bootstrap';
4 | import {isWebUri} from 'valid-url';
5 |
6 | class RoutingManager extends React.Component {
7 | constructor(props, context) {
8 | super(props, context);
9 | this.handleChange = this.handleChange.bind(this);
10 | this.validate = this.validate.bind(this);
11 | this.updateRoute = this.updateRoute.bind(this);
12 | this.deleteRoute = this.deleteRoute.bind(this);
13 | this.manageStubs = this.manageStubs.bind(this);
14 |
15 | this.state = Object.assign(
16 | {formValid: false, old_route: this.props.route},
17 | this.props, {handle: this.props.newRoute ? "proxy" : this.props.handle},
18 | {proxy: this.props.newRoute ? window.location.origin : this.props.proxy}
19 | );
20 | };
21 | componentWillReceiveProps(nextProps){
22 | this.setState({newRoute: nextProps.newRoute, old_route: nextProps.route});
23 | }
24 | validate(state){
25 | let validity = state.route && state.route.charAt(0) == '/' && state.route.charAt(state.route.length - 1) == '/'
26 | && state.route.length > 2 && !/[^a-zA-Z0-9\_\-\/]/.test( state.route ) &&
27 | ((state.handle == "proxy" && state.proxy && isWebUri(state.proxy) && state.proxy.charAt(state.proxy.length - 1) != '/')
28 | || (state.handle == "stub" && state.stub)
29 | || (state.handle == "dynamicStub" && state.dynamicStub));
30 | this.setState({formValid: validity})
31 | }
32 | handleChange(elem, event){
33 | let partialState = {};
34 | partialState[elem] = event ? event.target.value : window.event.target.value;
35 | this.setState(partialState);
36 | this.validate(Object.assign(this.state, partialState));
37 | }
38 | updateRoute(){
39 | Store.changeConfig(this.state);
40 | }
41 | deleteRoute(){
42 | if (confirm("Are you sure you want to delete the route : "+ (this.props.route || "new route") + " ? All the stubs related to this route will be deleted.")) {
43 | this.props.delete();
44 | if (!this.props.newRoute) {
45 | Store.deleteRoute(this.props.route);
46 | }
47 | }
48 | }
49 | manageStubs(page, type) {
50 | Store.routeOfInterest = this.state.old_route;
51 | Store.updatePage(page);
52 | }
53 | render(){
54 | let routeInput,
55 | stublist;
56 | if (this.state.handle == "proxy") {
57 | routeInput = ;
58 | } else if (this.state.handle == "stub") {
59 | let options = this.state.stubs.map((stub, i) => );
60 | routeInput = (
61 | req to form a javascript expression this.setState({helpModal: true})}>help on conditions}/>
77 |
78 |
79 | {options}
80 |
81 | Remove Condition
82 |
83 | The req is a javascript object which you can use to form conditions
If the incoming request has query strings use req.query.key to read the value.
If the incoming request is a post use req.body.key to read the value.
Use req.path == '/path' to match a url which ends with '/path'
List of all properties available in the req object :
baseURL119 |
body
cookies
headers
hostname
ip
ips
method
originalUrl
params
path
protocol
query
route
signedCookies
stale
subdomains
xhr
These properties are being provided by expressjs module
120 |See more about these properties here
121 |