@mbtest/mountebank 2.9.2-beta.9050

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 mountebank
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,94 @@
+# Project in transition
+
+Currently the project is in transition to a collaborative group effort under a github organisation.
+
+Work is being done to migrate and upgrade all CI/CD integrations from personal accounts to organisation accounts.
+
+Pull requests are welcome, but don't expect anything to be merged until CI/CD infrastucture is up and running.
+
+Many thanks goes to [Brandon Byars](https://github.com/bbyars) for all the effort building mountebank in the first place and maintaining the project for more than a decade and finally being helpfull and collaborative during this transition phase.
+
+# Welcome, friend
+
+mountebank is the only open source service virtualization tool that competes with the commercial offerings
+in terms of protocol diversity, capability, and performance. Here's what
+[Capital One wrote](https://medium.com/capital-one-tech/moving-one-of-capital-ones-largest-customer-facing-apps-to-aws-668d797af6fc)
+about their mobile cloud migration (emphasis theirs):
+
+>In fact, halfway through we discovered our corporate mocking software couldn’t handle the
+>sheer amount of performance testing we were running as part of this effort (_we completely crushed
+>some pretty industrial enterprise software in the process_). As a result, we made the call to move
+>the entire program over to a Mountebank OSS-based solution with a custom provision to give us the ability
+>to expand/shrink our mocking needs on demand.
+
+At the moment, the following protocols are implemented, either directly in the tool or as a community extension:
+* http
+* https
+* tcp (text and binary)
+* smtp
+* ldap
+* grpc
+* websockets
+* graphql
+* snmp
+* telnet
+* ssh
+* netconf
+
+mountebank supports mock verification, stubbing with advanced predicates, JavaScript injection,
+and record-playback through proxying.
+
+![how it works](https://github.com/mountebank-testing/mountebank/blob/master/src/public/images/overview.gif?raw=true)
+
+See [getting started](http://localhost:2525/docs/gettingStarted) guide for more information once you have it running locally.
+
+## Install and Run
+
+Install:
+
+    npm install -g mountebank
+
+Run:
+
+    mb
+
+There are a number of [command line options](http://localhost:2525/docs/commandLine) if you need
+to customize mountebank.
+
+All pre-release versions of mountebank are available with the `beta` [npm tag](https://www.npmjs.com/package/mountebank).
+No `beta` version is published unless it has passed all tests.
+
+## Learn More
+
+After installing and running, view the docs in your browser at <http://localhost:2525>.
+
+You can always learn more and support mountebank development by buying the book:
+
+[![Testing Microservices with Mountebank](https://github.com/mountebank-testing/mountebank/blob/master/src/public/images/book.jpg)](https://www.manning.com/books/testing-microservices-with-mountebank?a_aid=mb&a_bid=ee3288f4)
+
+## Building
+
+There are two packages: mountebank itself, and a test package called mbTest (which houses all
+out-of-process tests against mountebank). First ensure all dependencies are installed for both packages:
+
+    npm install
+
+Then, run all tests:
+
+    npm test
+
+Several other test configurations exist. You can see the CI pipeline in .circleci/config.yml.
+
+There are some tests that require network access.
+A few of these tests verify the correct behavior under DNS failures.  If your ISP
+is kind enough to hijack the NXDOMAIN DNS response in an attempt to allow you to conveniently peruse their
+advertising page, those tests will fail.  I suggest that, under such circumstances, you talk to your ISP
+and let them know that their policies are causing mountebank tests to fail. You can also set
+the environment variable `MB_AIRPLANE_MODE=true`, which will avoid tests requiring your DNS resolver.
+
+[npm-badge]: https://nodei.co/npm/mountebank.png?downloads=true&downloadRank=true&stars=true
+[npm]: https://www.npmjs.com/package/mountebank
+[codeclimate-badge]: https://codeclimate.com/github/mountebank-testing/mountebank/badges/gpa.svg
+[codeclimate]: https://codeclimate.com/github/mountebank-testing/mountebank
+[codeclimate-coverage-badge]: https://codeclimate.com/github/mountebank-testing/mountebank/badges/coverage.svg
+[codeclimate-coverage]: https://codeclimate.com/github/mountebank-testing/mountebank/coverage

package/bin/mb

@@ -0,0 +1,136 @@
+#!/usr/bin/env node
+
+'use strict';
+
+const mountebank = require('../src/mountebank'),
+    api = require('../src/cli/api'),
+    cli = require('../src/cli/cli'),
+    fs = require('fs-extra');
+
+function processExists (pid) {
+    try {
+        // "As a special case, signal 0 can be used to test existence of process"
+        // https://nodejs.org/api/process.html#process_process_kill_pid_signal
+        process.kill(pid, 0);
+        return true;
+    }
+    catch (e) {
+        return false;
+    }
+}
+
+function serverAt (options) {
+    async function start () {
+        // Set in case npm dependencies do anything with this
+        if (!process.env.NODE_ENV) {
+            process.env.NODE_ENV = 'production';
+        }
+
+        const server = await mountebank.create(options);
+
+        function shutdown () {
+            server.close(() => {
+                try {
+                    if (fs.existsSync(options.pidfile)) {
+                        fs.unlinkSync(options.pidfile);
+                    }
+                }
+                finally {
+                    process.exit(); // eslint-disable-line no-process-exit
+                }
+            });
+        }
+
+        process.on('SIGINT', shutdown);
+        process.on('SIGTERM', shutdown);
+
+        if (options.configfile) {
+            await api.loadConfig(options, server);
+        }
+
+        // Useful for build plugins that need to wait for mb to be fully initialized
+        // They can wait for the pidfile to be written
+        fs.writeFileSync(options.pidfile, process.pid.toString());
+    }
+
+    function stop () {
+        if (!fs.existsSync(options.pidfile)) {
+            return Promise.resolve(true);
+        }
+
+        const pid = fs.readFileSync(options.pidfile);
+        if (!processExists(pid)) {
+            fs.unlinkSync(options.pidfile);
+            return Promise.resolve(true);
+        }
+
+        return new Promise(resolve => {
+            const startTime = new Date(),
+                timeout = 1000,
+                waitForClose = () => {
+                    const elapsedTime = new Date() - startTime;
+                    if (!fs.existsSync(options.pidfile)) {
+                        resolve();
+                    }
+                    else if (elapsedTime > timeout) {
+                        try {
+                            // For Windows, which doesn't register signal handlers
+                            fs.unlinkSync(options.pidfile);
+                        }
+                        catch (err) { /* ignore */ }
+                        finally {
+                            resolve();
+                        }
+                    }
+                    else {
+                        setTimeout(waitForClose, 100);
+                    }
+                };
+
+            process.kill(pid);
+            waitForClose();
+        });
+    }
+
+    async function restart () {
+        await stop();
+        await start();
+    }
+
+    return {
+        start: start,
+        stop: stop,
+        restart: restart
+    };
+}
+
+try {
+    const server = serverAt(cli.args);
+
+    switch (cli.command) {
+        case 'start':
+            server.start();
+            break;
+        case 'stop':
+            server.stop();
+            break;
+        case 'restart':
+            server.restart();
+            break;
+        case 'save':
+            api.save(cli.args);
+            break;
+        case 'replay':
+            api.replay(cli.args);
+            break;
+        case 'help':
+            cli.help();
+            break;
+        default:
+            cli.error(`Invalid command '${cli.command}'.`);
+            break;
+    }
+}
+catch (err) {
+    cli.error(err.message);
+}

package/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "@mbtest/mountebank",
+  "version": "2.9.2-beta.9050",
+  "author": "Brandon Byars <brandon.byars@gmail.com>",
+  "description": "Over the wire test doubles",
+  "homepage": "http://www.mbtest.dev",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/mountebank-testing/mountebank.git"
+  },
+  "bugs": {
+    "url": "https://github.com/mountebank-testing/mountebank/issues",
+    "email": "brandon.byars@gmail.com"
+  },
+  "bin": {
+    "mb": "./bin/mb"
+  },
+  "main": "./src/mountebank.js",
+  "scripts": {},
+  "files": [
+    "bin",
+    "src",
+    "package.json",
+    "package-lock.json",
+    "README.md",
+    "LICENSE",
+    "releases.json"
+  ],
+  "keywords": [
+    "test",
+    "stub",
+    "mock",
+    "double",
+    "smtp",
+    "email",
+    "http",
+    "https",
+    "tcp",
+    "net",
+    "service virtualization"
+  ],
+  "dependencies": {
+    "@xmldom/xmldom": "0.8.10",
+    "cors": "2.8.5",
+    "csv-parse": "5.5.3",
+    "ejs": "3.1.9",
+    "errorhandler": "1.5.1",
+    "escape-html": "1.0.3",
+    "express": "4.18.2",
+    "fs-extra": "11.2.0",
+    "http-proxy-agent": "7.0.0",
+    "https-proxy-agent": "7.0.2",
+    "jsonpath-plus": "8.0.0",
+    "mailparser": "3.6.7",
+    "mountebank-formatters": "0.0.2",
+    "nodemailer": "6.9.9",
+    "prom-client": "15.1.0",
+    "proper-lockfile": "4.1.2",
+    "safe-regex": "^2.1.1",
+    "safe-stable-stringify": "2.4.3",
+    "smtp-server": "3.13.2",
+    "winston": "3.11.0",
+    "xpath": "0.0.34",
+    "yargs": "17.7.2"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "snyk": true
+}

package/releases.json

@@ -0,0 +1,52 @@
+[
+  { "version": "v1.1.0", "date": "2014-05-09" },
+  { "version": "v1.1.36", "date": "2014-05-20" },
+  { "version": "v1.1.72", "date": "2014-12-31" },
+  { "version": "v1.2.0", "date": "2015-01-03" },
+  { "version": "v1.2.30", "date": "2015-01-24" },
+  { "version": "v1.2.45", "date": "2015-02-16" },
+  { "version": "v1.2.56", "date": "2015-03-14" },
+  { "version": "v1.2.103", "date": "2015-04-12" },
+  { "version": "v1.2.122", "date": "2015-05-04" },
+  { "version": "v1.3.0", "date": "2015-09-20" },
+  { "version": "v1.3.1", "date": "2015-10-11" },
+  { "version": "v1.4.0", "date": "2015-10-14" },
+  { "version": "v1.4.1", "date": "2015-10-23" },
+  { "version": "v1.4.2", "date": "2015-11-07" },
+  { "version": "v1.4.3", "date": "2016-01-16" },
+  { "version": "v1.5.0", "date": "2016-04-11" },
+  { "version": "v1.5.1", "date": "2016-04-18" },
+  { "version": "v1.6.0", "date": "2016-08-15" },
+  { "version": "v1.7.0", "date": "2016-11-29" },
+  { "version": "v1.7.1", "date": "2016-11-30" },
+  { "version": "v1.7.2", "date": "2016-12-2" },
+  { "version": "v1.8.0", "date": "2017-01-03" },
+  { "version": "v1.9.0", "date": "2017-02-26" },
+  { "version": "v1.10.0", "date": "2017-04-02" },
+  { "version": "v1.11.0", "date": "2017-05-20" },
+  { "version": "v1.12.0", "date": "2017-07-22" },
+  { "version": "v1.13.0", "date": "2017-10-27" },
+  { "version": "v1.14.0", "date": "2018-02-18" },
+  { "version": "v1.14.1", "date": "2018-05-16" },
+  { "version": "v1.15.0", "date": "2018-08-26" },
+  { "version": "v1.16.0", "date": "2018-12-21" },
+  { "version": "v2.0.0", "date": "2019-03-15" },
+  { "version": "v2.1.0", "date": "2019-06-19" },
+  { "version": "v2.1.1", "date": "2019-10-13" },
+  { "version": "v2.1.2", "date": "2019-10-19" },
+  { "version": "v2.2.0", "date": "2020-02-09" },
+  { "version": "v2.2.1", "date": "2020-04-26" },
+  { "version": "v2.3.0", "date": "2020-09-07" },
+  { "version": "v2.3.1", "date": "2020-09-26" },
+  { "version": "v2.3.2", "date": "2020-09-27" },
+  { "version": "v2.3.3", "date": "2020-10-18" },
+  { "version": "v2.4.0", "date": "2020-12-29" },
+  { "version":  "v2.5.0", "date":  "2021-09-15" },
+  { "version":  "v2.6.0", "date":  "2022-02-20" },
+  { "version":  "v2.7.0", "date":  "2022-07-17" },
+  { "version":  "v2.8.0", "date":  "2022-10-16" },
+  { "version":  "v2.8.1", "date":  "2022-10-16" },
+  { "version":  "v2.8.2", "date":  "2023-01-22" },
+  { "version":  "v2.9.0", "date":  "2023-08-23" },
+  { "version":  "v2.9.1", "date":  "2023-08-23" }
+]

package/src/cli/api.js

@@ -0,0 +1,112 @@
+'use strict';
+
+const http = require('http');
+
+function curl (options, method, path, body) {
+    return new Promise((resolve, reject) => {
+        const requestOptions = {
+            method: method,
+            path: path,
+            port: options.port,
+            hostname: options.host || 'localhost',
+            headers: {
+                'Content-Type': 'application/json',
+                Connection: 'close'
+            }
+        };
+
+        if (options.apikey) {
+            requestOptions.headers['x-api-key'] = options.apikey;
+        }
+
+        const request = http.request(requestOptions, response => {
+            response.body = '';
+            response.setEncoding('utf8');
+            response.on('data', chunk => { response.body += chunk; });
+            response.on('end', () => {
+                if (response.statusCode === 200) {
+                    response.body = JSON.parse(response.body);
+                    resolve(response);
+                }
+                else {
+                    reject(new Error(`${response.statusCode}\n${response.body}`));
+                }
+            });
+        });
+
+        request.on('error', reject);
+
+        if (body) {
+            request.write(JSON.stringify(body, null, 2));
+        }
+        request.end();
+    });
+}
+
+function putImposters (options, body) {
+    return curl(options, 'PUT', '/imposters', body);
+}
+
+function getImposters (options) {
+    let path = '/imposters?replayable=true';
+    if (options.removeProxies) {
+        path += '&removeProxies=true';
+    }
+    return curl(options, 'GET', path);
+}
+
+function logConnectionErrorAndExit (options, err) {
+    const host = options.host || 'localhost';
+    if (err.code === 'ENOENT') {
+        console.error(`No such file: ${options.configfile}`);
+    }
+    if (err.code === 'ECONNREFUSED') {
+        console.error(`No mb process running on http://${host}:${options.port}`);
+    }
+    else {
+        console.error(err);
+    }
+    process.exit(1); // eslint-disable-line no-process-exit
+}
+
+async function loadConfig (options) {
+    const formatter = require(options.formatter);
+
+    try {
+        const imposters = await formatter.load(options);
+        await putImposters(options, imposters);
+    }
+    catch (e) {
+        logConnectionErrorAndExit(options, e);
+    }
+}
+
+async function save (options) {
+    const formatter = require(options.formatter);
+
+    try {
+        const response = await getImposters(options);
+        await formatter.save(options, response.body);
+    }
+    catch (e) {
+        logConnectionErrorAndExit(options, e);
+    }
+}
+
+async function replay (options) {
+    options.removeProxies = true;
+
+    try {
+        const response = await getImposters(options);
+        await putImposters(options, response.body);
+    }
+    catch (e) {
+        logConnectionErrorAndExit(e, options);
+    }
+}
+
+module.exports = {
+    loadConfig,
+    save,
+    replay
+};