@mbtest/mountebank 2.9.2-beta.9050

package/src/util/middleware.js

@@ -0,0 +1,256 @@
+'use strict';
+
+const helpers = require('../util/helpers.js'),
+    errors = require('./errors.js');
+
+/**
+ * Express middleware functions to inject into the HTTP processing
+ * @module
+ */
+
+/**
+ * Returns a middleware function to transforms all outgoing relative links in the response body
+ * to absolute URLs, incorporating the current host name and port
+ * @param {number} port - The port of the current instance
+ * @returns {Function}
+ */
+function useAbsoluteUrls (port) {
+    return function (request, response, next) {
+        const setHeaderOriginal = response.setHeader,
+            sendOriginal = response.send,
+            host = request.headers.host || `localhost:${port}`,
+            absolutize = link => `http://${host}${link}`,
+            isObject = helpers.isObject;
+
+        response.setHeader = function () {
+            const args = Array.prototype.slice.call(arguments);
+
+            if (args[0] && args[0].toLowerCase() === 'location') {
+                args[1] = absolutize(args[1]);
+            }
+            setHeaderOriginal.apply(this, args);
+        };
+
+        response.send = function () {
+            const args = Array.prototype.slice.call(arguments),
+                body = args[0],
+                changeLinks = function (obj) {
+                    if (obj._links) {
+                        Object.keys(obj._links).forEach(function (rel) {
+                            if (obj._links[rel].href) {
+                                obj._links[rel].href = absolutize(obj._links[rel].href);
+                            }
+                        });
+                    }
+                },
+                traverse = function (obj, fn, parent) {
+                    if (parent === 'stubs' || parent === 'response') {
+                        // Don't change _links within stubs or within the response
+                        // sent back to protocol implementations
+                        return;
+                    }
+                    fn(obj);
+                    Object.keys(obj).forEach(key => {
+                        if (obj[key] && isObject(obj[key])) {
+                            traverse(obj[key], fn, key);
+                        }
+                    });
+                };
+
+            if (isObject(body)) {
+                traverse(body, changeLinks);
+
+                // Special case stubs _links. Hard to manage in the traverse function because stubs is an array
+                // and we want to change stubs[]._links but not stubs[]._responses.is.body._links
+                if (Array.isArray(body.stubs)) {
+                    body.stubs.forEach(changeLinks);
+                }
+                else if (Array.isArray(body.imposters)) {
+                    body.imposters.forEach(imposter => {
+                        if (Array.isArray(imposter.stubs)) {
+                            imposter.stubs.forEach(changeLinks);
+                        }
+                    });
+                }
+            }
+            sendOriginal.apply(this, args);
+        };
+
+        next();
+    };
+}
+
+/**
+ * Returns a middleware function to return a 404 if the imposter does not exist
+ * @param {Object} imposters - The imposters repository
+ * @returns {Function}
+ */
+function createImposterValidator (imposters) {
+    return async function validateImposterExists (request, response, next) {
+        const exists = await imposters.exists(request.params.id);
+
+        if (exists) {
+            next();
+        }
+        else {
+            response.statusCode = 404;
+            response.send({
+                errors: [errors.MissingResourceError('Try POSTing to /imposters first?')]
+            });
+        }
+    };
+}
+
+/**
+ * Returns a middleware function that logs the requests made to the server
+ * @param {Object} log - The logger
+ * @param {string} format - The log format
+ * @returns {Function}
+ */
+function logger (log, format) {
+    function shouldLog (request) {
+        const isStaticAsset = (['.js', '.css', '.gif', '.png', '.ico'].some(function (fileType) {
+                return request.url.indexOf(fileType) >= 0;
+            })),
+            isHtmlRequest = (request.headers.accept || '').indexOf('html') >= 0,
+            isXHR = request.headers['x-requested-with'] === 'XMLHttpRequest';
+
+        return !(isStaticAsset || isHtmlRequest || isXHR);
+    }
+
+    return function (request, response, next) {
+        if (shouldLog(request)) {
+            const message = format.replace(':method', request.method).replace(':url', request.url);
+            if (request.url.indexOf('_requests') > 0) {
+                // Protocol implementations communicating with mountebank
+                log.debug(message);
+            }
+            else {
+                log.info(message);
+            }
+        }
+        next();
+    };
+}
+
+/**
+ * Returns a middleware function that passes global variables to all render calls without
+ * having to pass them explicitly
+ * @param {Object} vars - the global variables to pass
+ * @returns {Function}
+ */
+function globals (vars) {
+    return function (request, response, next) {
+        const originalRender = response.render;
+        response.render = function () {
+            const args = Array.prototype.slice.call(arguments),
+                variables = args[1] || {};
+
+            Object.keys(vars).forEach(function (name) {
+                variables[name] = vars[name];
+            });
+            args[1] = variables;
+            originalRender.apply(this, args);
+        };
+        next();
+    };
+}
+
+/**
+ * The mountebank server uses header-based content negotiation to return either HTML or JSON
+ * for each URL.  This breaks down on IE browsers as they fail to send the correct Accept header,
+ * and since we default to JSON (to make the API easier to use), that leads to a poor experience
+ * for IE users.  We special case IE to html by inspecting the user agent, making sure not to
+ * interfere with XHR requests that do add the Accept header
+ * @param {Object} request - The http request
+ * @param {Object} response - The http response
+ * @param {Function} next - The next middleware function to call
+ */
+function defaultIEtoHTML (request, response, next) {
+    // IE has inconsistent Accept headers, often defaulting to */*
+    // Our default is JSON, which fails to render in the browser on content-negotiated pages
+    if (request.headers['user-agent'] && request.headers['user-agent'].indexOf('MSIE') >= 0) {
+        if (!(request.headers.accept && request.headers.accept.match(/application\/json/))) {
+            request.headers.accept = 'text/html';
+        }
+    }
+    next();
+}
+
+/**
+ * Returns a middleware function that defaults the content type to JSON if not set to make
+ * command line testing easier (e.g. you don't have to set the Accept header with curl) and
+ * parses the JSON before reaching a controller, handling errors gracefully.
+ * @param {Object} log - The logger
+ * @returns {Function}
+ */
+function json (log) {
+    return function (request, response, next) {
+        // Disable body parsing, if already parsed
+        if (request.headers['content-type'] === 'application/json' && helpers.isObject(request.body)) {
+            next();
+            return;
+        }
+
+        request.body = '';
+        request.setEncoding('utf8');
+        request.on('data', chunk => {
+            request.body += chunk;
+        });
+        request.on('end', function () {
+            if (request.body === '') {
+                next();
+            }
+            else {
+                try {
+                    request.body = JSON.parse(request.body);
+                    request.headers['content-type'] = 'application/json';
+                    next();
+                }
+                catch (e) {
+                    log.error('Invalid JSON: ' + request.body);
+                    response.statusCode = 400;
+                    response.send({
+                        errors: [errors.InvalidJSONError({ source: request.body })]
+                    });
+                }
+            }
+        });
+    };
+}
+
+function validateApiKey (expectedApiKey, log) {
+    return function (request, response, next) {
+        if (!expectedApiKey) {
+            next();
+            return;
+        }
+
+        if (!request.headers['x-api-key']) {
+            log.error('The x-api-key header is required but was not provided');
+            response.statusCode = 401;
+            response.send({
+                errors: [errors.UnauthorizedError()]
+            });
+            return;
+        }
+
+        const crypto = require('crypto');
+        const hash = crypto.createHash('sha512');
+        if (crypto.timingSafeEqual(
+            hash.copy().update(request.headers['x-api-key']).digest(),
+            hash.copy().update(expectedApiKey).digest()
+        )) {
+            next();
+        }
+        else {
+            log.error('The x-api-key header value does not match the expected API key');
+            response.statusCode = 401;
+            response.send({
+                errors: [errors.UnauthorizedError()]
+            });
+        }
+    };
+}
+
+module.exports = { useAbsoluteUrls, createImposterValidator, logger, globals, defaultIEtoHTML, json, validateApiKey };

package/src/util/scopedLogger.js

@@ -0,0 +1,47 @@
+'use strict';
+
+/** @module */
+
+const inherit = require('./inherit.js'),
+    util = require('util');
+
+function wrap (wrappedLogger, logger) {
+    ['debug', 'info', 'warn', 'error'].forEach(level => {
+        wrappedLogger[level] = function () {
+            const args = Array.prototype.slice.call(arguments);
+            args[0] = wrappedLogger.scopePrefix + args[0];
+
+            // Format here rather than use winston's splat formatter
+            // to get rid of inconsistent "meta" log elements
+            const message = util.format.apply(null, args);
+            logger[level](message);
+        };
+    });
+    wrappedLogger.baseLogger = logger;
+}
+
+/**
+ * Returns a logger that prefixes each message of the given logger with a given scope
+ * @param {Object} logger - The logger to add a scope to
+ * @param {string} scope - The prefix for all log messages
+ * @returns {Object}
+ */
+function create (logger, scope) {
+    function formatScope (scopeText) {
+        return scopeText.indexOf('[') === 0 ? scopeText : `[${scopeText}] `;
+    }
+
+    const wrappedLogger = inherit.from(logger, {
+        scopePrefix: formatScope(scope),
+        withScope: nestedScopePrefix => create(logger, `${wrappedLogger.scopePrefix}${nestedScopePrefix} `),
+        changeScope: newScope => {
+            wrappedLogger.scopePrefix = formatScope(newScope);
+            wrap(wrappedLogger, logger);
+        }
+    });
+
+    wrap(wrappedLogger, logger);
+    return wrappedLogger;
+}
+
+module.exports = { create };

package/src/views/_footer.ejs

@@ -0,0 +1,20 @@
+      </div>
+    </div>
+
+    <hr />
+
+    <footer>
+      <nav class='horizontal'>
+        <ul>
+          <li>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</li>
+          <li><a href='/releases'>releases</a></li>
+          <li><a href='https://github.com/mountebank-testing/mountebank/blob/master/CONTRIBUTING.md'>contributing</a></li>
+          <li><a href='/license'>license</a></li>
+          <li><a href='https://github.com/mountebank-testing/mountebank'>source</a></li>
+          <li><a href='https://github.com/mountebank-testing/mountebank/issues'>issues</a></li>
+        </ul>
+      </nav>
+    </footer>
+
+  </body>
+</html>

package/src/views/_header.ejs

@@ -0,0 +1,113 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>mountebank - <%= title %></title>
+    <meta charset='utf-8'>
+    <meta name='description' content='<%= description %>' />
+    <meta name='author' content='Brandon Byars' />
+
+    <link rel='stylesheet' href='/stylesheets/jqueryui/1.10.4/themes/smoothness/jquery-ui.css' />
+    <link rel='stylesheet' type='text/css' href='/stylesheets/application.css' />
+    <!--[if IE]>
+    <link rel='stylesheet' type='text/css' href='/stylesheets/ie.css' />
+    <![endif]-->
+
+    <link rel='shortcut icon' href='/images/favicon.ico' type='image/x-icon' />
+
+    <script src='/scripts/jquery/jquery-3.6.1.min.js'></script>
+    <script src='/scripts/urlHashHandler.js'></script>
+  </head>
+  <body>
+    <div id='main'>
+      <header>
+        <a href='/'><img src='/images/mountebank.png' alt='mountebank' /></a>
+        <p>mountebank - over the wire test doubles</p>
+
+        <form method='GET' action='http://www.google.com/search'>
+          <input type='hidden' name='domains' value='www.mbtest.dev' />
+          <input type='hidden' name='sitesearch' value='www.mbtest.dev' />
+          <input type='search' name='q' id='q' results='5' autosave='mb' placeholder='Search...'/>
+          <input type='submit' value='Search...' id='searchButton' />
+        </form>
+
+        <nav class='horizontal'>
+          <ul>
+            <li><a href='/'>home</a></li>
+            <li><a href='/imposters'>imposters</a></li>
+            <li><a href='/logs'>logs</a></li>
+            <li><a href='/config'>config</a></li>
+            <li><a href='/metrics' title='Prometheus metrics'>metrics</a></li>
+            <li><a href='/feed' class='feed-icon' title='subscribe for release updates'></a></li>
+          </ul>
+        </nav>
+      </header>
+
+      <hr />
+
+      <div id='sidenav'>
+        <h3>the apothecary</h3>
+        <nav class='vertical'>
+          <ul>
+            <li><a href='/docs/gettingStarted'>getting started</a></li>
+            <li><a href='/docs/mentalModel'>mental model</a></li>
+            <li><a href='/docs/communityExtensions'>3rd party plugins</a></li>
+            <li><a href='/docs/commandLine'>command line</a></li>
+            <li><a href='/docs/security'>security</a></li>
+            <li><a href='/faqs'>faqs</a></li>
+            <li><a href='/support'>support</a></li>
+          </ul>
+
+          <p>api:</p>
+          <ul>
+            <li><a href='/docs/api/overview'>overview</a></li>
+            <li><a href='/docs/api/contracts'>contracts</a></li>
+            <li><a href='/docs/api/mocks'>mock verification</a></li>
+            <li><a href='/docs/api/stubs'>stub responses</a></li>
+            <li>
+              <ul>
+                <li><a href='/docs/api/proxies'>proxies</a></li>
+                <li><a href='/docs/api/injection'>injection</a></li>
+                <li><a href='/docs/api/behaviors'>behaviors</a></li>
+                <li><a href='/docs/api/faults'>faults</a></li>
+              </ul>
+            </li>
+            <li><a href='/docs/api/predicates'>stub predicates</a></li>
+            <li>
+              <ul>
+                <li><a href='/docs/api/xpath'>xpath</a></li>
+                <li><a href='/docs/api/json'>json</a></li>
+                <li><a href='/docs/api/jsonpath'>jsonpath</a></li>
+              </ul>
+            </li>
+            <li><a href='/docs/api/errors'>errors</a></li>
+          </ul>
+
+          <p>builtin protocols:</p>
+          <ul>
+            <li><a href='/docs/protocols/http'>http</a></li>
+            <li><a href='/docs/protocols/https'>https</a></li>
+            <li><a href='/docs/protocols/tcp'>tcp</a></li>
+            <li><a href='/docs/protocols/smtp'>smtp</a></li>
+          </ul>
+
+          <p>community plugins:</p>
+          <ul>
+            <li><a href='https://gitlab.com/dAnjou/mountebank-ldap'>ldap</a></li>
+            <li><a href='https://github.com/vamsib/mountebank-ws'>websockets</a></li>
+            <li><a href='https://github.com/bashj79/mb-graphql'>graphql</a></li>
+            <li><a href='https://github.com/telekom/mb-netmgmt'>snmp</a></li>
+            <li><a href='https://github.com/telekom/mb-netmgmt'>telnet</a></li>
+            <li><a href='https://github.com/telekom/mb-netmgmt'>ssh</a></li>
+            <li><a href='https://github.com/telekom/mb-netmgmt'>netconf</a></li>
+            <li><a href='/docs/protocols/custom'>create your own</a></li>
+          </ul>
+
+          <p>the book:<br /><br />
+              <a href='https://www.manning.com/books/testing-microservices-with-mountebank?utm_source=mb&amp;utm_medium=affiliate&amp;utm_campaign=book_byars_testing_12_20_18&amp;a_aid=mb&amp;a_bid=ee3288f4'>
+                  <img src='/images/book.jpg' alt='Testing Microservices with Mountebank' width='130' height='163' />
+              </a>
+          </p>
+        </nav>
+      </div>
+
+      <div id='content'>

package/src/views/_imposter.ejs

@@ -0,0 +1,8 @@
+<tr id='imposter-<%= imposter.port %>'>
+  <td style='width: 15em;'><a href='<%= imposter._links.self.href %>'>
+    <%= imposter.name || imposter.protocol + ':' + imposter.port %>
+  </a></td>
+  <td style='width: 6em;'><%= imposter.protocol %></td>
+  <td style='width: 5em;'><%= imposter.port %></td>
+  <td style='width: 6em;'><%= imposter.numberOfRequests %></td>
+</tr>

package/src/views/config.ejs

@@ -0,0 +1,71 @@
+<%
+title = 'configuration'
+description = 'The version, command line parameters, and process information about this running mb process'
+%>
+
+<%- include('_header') -%>
+
+<%
+function isJSONObject (value) {
+  return typeof value === 'object' && !Array.isArray(value);
+}
+
+function prettyPrint (value) {
+  return isJSONObject(value) ? JSON.stringify(value, null, 2) : value;
+}
+%>
+
+<h1>Config</h1>
+
+<table>
+  <tr>
+    <td>version</td>
+    <td><%= version %></td>
+  </tr>
+<% Object.keys(options).forEach(key =>{ %>
+  <tr>
+    <td><%= key %></td>
+    <td><% if (isJSONObject(options[key])) { -%><pre><code><% } -%><%= prettyPrint(options[key]) %><% if (isJSONObject(options[key])) { -%></code></pre><% } -%>
+    </td>
+  </tr>
+<% }); -%>
+</table>
+
+<h2>Process Information</h2>
+
+<table>
+  <tr>
+    <td>node version</td>
+    <td><%= process.nodeVersion %></td>
+  </tr>
+  <tr>
+    <td>architecture</td>
+    <td><%= process.architecture %></td>
+  </tr>
+  <tr>
+    <td>platform</td>
+    <td><%= process.platform %></td>
+  </tr>
+  <tr>
+    <td>rss</td>
+    <td><%= process.rss %></td>
+  </tr>
+  <tr>
+    <td>heapTotal</td>
+    <td><%= process.heapTotal %></td>
+  </tr>
+  <tr>
+    <td>heapUsed</td>
+    <td><%= process.heapUsed %></td>
+  </tr>
+  <tr>
+    <td>uptime</td>
+    <td><%= process.uptime %></td>
+  </tr>
+  <tr>
+    <td>cwd</td>
+    <td><%= process.cwd %></td>
+  </tr>
+</table>
+
+<%- include('_footer') -%>