testarmada-midway/lib/server-controller.js

Mocking server to create reliable test data for test execution and development

/**
* MIT License
*
* Copyright (c) 2018-present, Walmart Inc.,
*
* 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.
*
*/
/********
 Always initiate the static file handler to enable respondWithFile.
 *********/
var Path = require('path');
var MidwayUtils = require('./utils/common-utils');
var requestHandler = require('./route-handlers/request-handler');
var responseHandler = require('./route-handlers/response-handler');
var Hapi = require('hapi');
var MidwayServerRoutes = require('./server-routes/midway-routes-manager');
var MidwayPluginController = require('./utils/midway-plugin-controller');
var MetricsManager = require('./utils/metrics-manager');
var GenerateCertManager = require('./utils/generate-certificate-manager');
var Logger = require('testarmada-midway-logger');
var Argv = require('./utils/configuration-parameters').argv;
var Constants = require('./constants');
var internals = {};

internals.start = function (startOptions, callback) {
  var midwayOptions = startOptions || {};
  var DEFAULT_MOCK_DIRECTORY = Path.join(process.cwd(), Constants.MIDWAY_DEFAULT_MOCKED_DATA_LOC);

  midwayOptions.startTime = new Date();
  midwayOptions.port = Argv.midwayPort || midwayOptions.port || 8080;
  midwayOptions.httpsPort = Argv.midwayHttpsPort || midwayOptions.httpsPort;
  midwayOptions.host = (Argv.midwayHost || midwayOptions.host || 'localhost').replace(/.*?:\/\//g, '');
  midwayOptions.project = midwayOptions.project || Constants.DEFAULT;
  midwayOptions.proxyPort = Argv.proxyPort || midwayOptions.proxyPort;
  midwayOptions.proxyHost = Argv.proxyHost || midwayOptions.proxyHost || 'localhost';
  midwayOptions.mockedDirectory = Argv.mockedData || midwayOptions.mockedDirectory || DEFAULT_MOCK_DIRECTORY;
  midwayOptions.sessions = Argv.midwaySessions || midwayOptions.sessions || 0;
  midwayOptions.resolvedPath = MidwayUtils.checkDirectoryExists(midwayOptions.mockedDirectory) ? midwayOptions.mockedDirectory
    : DEFAULT_MOCK_DIRECTORY;
  midwayOptions.respondWithFileHandler = require('./file-handler/file-handler')(midwayOptions.resolvedPath);

  if (midwayOptions.collectMetrics === undefined) {
    midwayOptions.collectMetrics = true;
  }

  // Set kairosdb url if passed in midway options and metrics is true
  if (midwayOptions.collectMetrics === true && midwayOptions[Constants.KAIROS_DB_URL]) {
    MidwayUtils.setKairosDbUrl(midwayOptions[Constants.KAIROS_DB_URL]);

    // Enable only if the metrics db url is passed in MidwayOptions ('metricsDB')
    MetricsManager.enableMetrics(midwayOptions.collectMetrics);
  }

  Logger.info('Starting midway server on http at http://' + midwayOptions.host + ':' + midwayOptions.port + '/midway');
  if (midwayOptions.httpsPort) {
    Logger.info('Starting midway server on https at https://' + midwayOptions.host + ':' + midwayOptions.httpsPort + '/midway');
  }

  createHapiServer(midwayOptions, function (server) {
    internals.addServerRoutesAndSessions(midwayOptions, server);
    MidwayUtils.initFileHandler(midwayOptions.respondWithFileHandler);

    MidwayPluginController.runHapiWithPlugins(server, midwayOptions, callback);
  });
};

internals.stop = function (server, callback) {
  MidwayUtils.setServerRunningStatus(false);
  var options = { timeout: 0 };
  server.stop(options, function (err) {
    if (err) {
      if (callback) {
        return callback(err);
      }
    }
    Logger.debug('Midway server stopped');
    if (callback) {
      return callback();
    }
  });
};

internals.addServerRoutesAndSessions = function (midwayOptions, server) {
  if (!MidwayUtils.isServerRunning()) {
    MidwayUtils.setServerRunningStatus(true);
    MidwayUtils.setServerProperties(midwayOptions);

    // Add midway server apis and plugins
    MidwayServerRoutes.addMidwayServerAPIs();
    Logger.debug('Sessions to add: ' + midwayOptions.sessions);

    // Intercept the response here using responseHandler
    if (server) {
      server.ext('onPostHandler', responseHandler);
    }

    // TODO this needs to be refactored and requestHandler should be generic
    // TODO a request handler specific to session should be added and named differently
    if (midwayOptions.sessions) {
      // Intercept the request and response here
      if (server) {
        server.ext('onRequest', requestHandler);
      }
      // add midway session routes
      MidwayServerRoutes.addRoutesToSessions(midwayOptions);
    }

    // Initialize URL Call Counts
    MidwayUtils.initializeSessionURLCallCount();
  }
};

function createHapiServer(midwayOptions, callback) {
  var server = new Hapi.Server();
  if (midwayOptions.httpsPort) {
    GenerateCertManager.genCerts(midwayOptions.resolvedPath, function (err, tls) {
      server.connection({ port: midwayOptions.port, labels: 'http' });
      server.connection({ port: midwayOptions.httpsPort, labels: 'https', tls: tls });
      return callback(server);
    });
  } else {
    server.connection({ port: midwayOptions.port, labels: 'http' });
    return callback(server);
  }
}


module.exports = internals;