@mimik/local 6.0.12 → 7.0.0

package/index.js

@@ -1,43 +1,42 @@
 /* eslint-disable prefer-template, no-console */
-const fs = require('fs');
-const path = require('path');
-const _ = require('lodash');
-
-const { commitCheckMsg } = require('@mimik/git-hooks');
-
-const {
-  colors,
-  exitError,
-  start2env,
-  start2shell,
-  start2process,
-  baseUrl,
-  read,
-  write,
-  parse,
-} = require('./lib/helpers');
-const {
+import {
   DEFAULT_DIRECTORY,
-  testJsonFile,
-  shellFile,
   DUMMY_CUSTOMER_CODE,
+  IGNORE,
   LITERAL,
   SYSTEM_NAME,
   TEST,
-  IGNORE,
-} = require('./lib/common');
-const {
-  getStartParams,
-  init,
-  startSetup,
+  shellFile,
+  testJsonFile,
+} from './lib/common.js';
+import {
+  baseUrl,
+  colors,
+  exitError,
+  parse,
+  read,
+  start2env,
+  start2process,
+  start2shell,
+  write,
+} from './lib/helpers.js';
+import { dirname, join } from 'path';
+import {
   getAPI,
   getAdminToken,
-  settingUpDummyServer,
+  getStartParams,
   gettingSystemCustomer,
-  settingUpServer,
-  settingUpCustomer,
+  init,
   settingUpAdminClient,
-} = require('./lib/tasks');
+  settingUpCustomer,
+  settingUpDummyServer,
+  settingUpServer,
+  startSetup,
+} from './lib/tasks.js';
+import { commitCheckMsg } from '@mimik/git-hooks';
+import { fileURLToPath } from 'url';
+import find from 'lodash.find';
+import fs from 'fs';
 
 colors.setTheme({
   success: 'green',
@@ -47,15 +46,20 @@ colors.setTheme({
 });
 
 const INSTALL = 'install';
+const TAB = 2;
+const FIRST = 0;
+const localDirname = dirname(fileURLToPath(import.meta.url));
 
-const getBasePath = (apiDef) => apiDef.basePath || apiDef.servers[0].url;
+const getBasePath = apiDef => apiDef.basePath || apiDef.servers[FIRST].url;
 
 /**
  * @module local
  * @example
- * const local = require('@mimik/local');
+ * import local from '@mimik/local';
+ * or
+ * import { mSTTestSetup, mSTSetup, mITTestSetup, mITSetup, testSetup, setup, dotFiles, scripts, unScripts, commitCheckMsg, start2process, testJsonFile} from '@mimik/local';
  *
- * @description Set of function for local deployment.
+ * @description Set of functions for local deployment.
  *
  * The following files are expected to exist:
  * In the directory above the server root directory: `mSTConfig.json`, `mIDConfig.json`, `mITConfig.json`,`sumoLog.json`, `kinesisLog.json`, `s3Log.json`, `customerConfig.json`, `key.json`, `locationConfig.json` are being set. If they don't exist at the launch of the script, default will be setup.
@@ -117,9 +121,9 @@ const getBasePath = (apiDef) => apiDef.basePath || apiDef.servers[0].url;
  *    "region": "region of the Kinesis implementation",
  *    "accessKeyId": "access key id of Kinesis",
  *    "secretAccessKey": "secret access key for Kinesis",
- *    "streamNameInfo": "name of the kiniesis stream for info",
- *    "streamNameError": "name of the kiniesis stream for error",
- *    "streamNameOther": "name of the kiniesis stream for all the other levels"
+ *    "streamNameInfo": "name of the Kinesis stream for info",
+ *    "streamNameError": "name of the Kinesis stream for error",
+ *    "streamNameOther": "name of the Kinesis stream for all the other levels"
  *  }
  * ```
  * - for `s3Log.json`:
@@ -157,7 +161,7 @@ const getBasePath = (apiDef) => apiDef.basePath || apiDef.servers[0].url;
  * - in the `local` directory of the server root directory: two files `start.json` and `testStart.json` may exit. `start.json` is used when `npm start` is executed, `testStart.json` is used when `npm test` is executed.
  * If the files don't exist `exampe-start.json` is used to create `start.json` and `testStart.json`.
  * Additionally `example-testStart.json` is used when to create `testStart.json`. The values in `example-testStart.json` take precedence over the values in `example-start.json`.
- * The configuration of these files depends on the configuration parameters of the server. If the files
+ * The configuration of these files depends on the configuration parameters of the server.
  * The following is an example of start.json file for `mIT`:
  * ``` javascript
  *  {
@@ -173,11 +177,11 @@ const getBasePath = (apiDef) => apiDef.basePath || apiDef.servers[0].url;
  *  }
  * ```
  * While all the files use the `.json` extension it is still possible to add comments `//` in the file to make the file more explicit or to remove some parameters.
- * There are reserved environement variable used by the library for configuration:
+ * There are reserved environement variables used by the library for configuration:
  * - `oauthImplicitNeeded`: if the service handles user token the implicit configuration is needed
  * - `mIDNeeded`: if the service has mID as a target
  * - `locationNeeded`: if location translation is needed
- * - `standAlone`: if the service need to be operated without other service. If the service has targets most likely 500 errors will be generated
+ * - `standAlone`: if the service needs to be operated without other service. If the service has targets most likely 500 errors will be generated
  *
  * If SERVER_ID is not set in the start.json or testStart.json file, SERVER_ID will be assigned with a uuid.v4.
  *
@@ -185,7 +189,7 @@ const getBasePath = (apiDef) => apiDef.basePath || apiDef.servers[0].url;
  * This file contains informations needed to start the test:
  * ``` javascript
  *  {
- *    "start": "information needed to setup the environement variable for the test",
+ *    "start": "information needed to setup the environement variables for the test",
  *    "CUSTOMER_NAME": "name of the customer to setup customer config",
  *    "CUSTOMER_CODE": "code of the customer to setup coustomer config, `not available for MST`",
  *    "BASE_PATH": "base path of the API",
@@ -207,11 +211,11 @@ const mSTInit = (confType) => {
     .then((apiDefinition) => {
       console.log('- mST base url: ' + config.mSTBaseUrl.info);
       console.log('- mIT base url: ' + config.MITBaseUrl.info);
-      console.log('- mST config: ' + JSON.stringify(config.mST, null, 2).info);
+      console.log('- mST config: ' + JSON.stringify(config.mST, null, TAB).info);
       if (confType === TEST) {
         start.CUSTOMER_NAME = SYSTEM_NAME;
         start.BASE_PATH = getBasePath(apiDefinition);
-        return { file: testJsonFile, content: JSON.stringify(start2env(start), null, 2), type: 'JSON file' };
+        return { file: testJsonFile, content: JSON.stringify(start2env(start), null, TAB), type: 'JSON file' };
       }
       return { file: shellFile, content: start2shell(start), type: 'shell script' };
     })
@@ -219,7 +223,7 @@ const mSTInit = (confType) => {
       fs.writeFileSync(response.file, response.content);
       console.log(`${regType}status: ` + 'completed'.success + ', ' + response.type.info + ' created at (' + response.file.info + ')');
     })
-    .catch((err) => exitError(regType, err));
+    .catch(err => exitError(regType, err));
 };
 
 const mITInit = (confType) => {
@@ -241,7 +245,7 @@ const mITInit = (confType) => {
           start.CUSTOMER_NAME = SYSTEM_NAME;
           start.CUSTOMER_CODE = DUMMY_CUSTOMER_CODE;
           start.BASE_PATH = getBasePath(apiDefinition);
-          return { file: testJsonFile, content: JSON.stringify(start2env(start), null, 2), type: 'JSON file' };
+          return { file: testJsonFile, content: JSON.stringify(start2env(start), null, TAB), type: 'JSON file' };
         }
         return { file: shellFile, content: start2shell(start), type: 'shell script' };
       }
@@ -254,12 +258,12 @@ const mITInit = (confType) => {
           authorization = mSTAdminToken;
           return gettingSystemCustomer(authorization, mSTBaseUrl);
         })
-        .then((customer) => settingUpServer(type, start.SERVER_ID, customer, authorization, mSTBaseUrl, start)
+        .then(customer => settingUpServer(type, start.SERVER_ID, customer, authorization, mSTBaseUrl, start)
           .then((updatedStart) => {
             start = updatedStart;
             return settingUpAdminClient(type, `admin_${customer.name}_${start.NODE_ENV}_${type}`, customer, authorization, mSTBaseUrl)
               .then((adminType) => {
-                const adminAudience = _.find(adminType.audiences, (audienceItem) => audienceItem.type === type);
+                const adminAudience = find(adminType.audiences, audienceItem => audienceItem.type === type);
                 if (adminAudience) return getAdminToken(adminAudience, adminType.data, mSTBaseUrl);
                 return undefined;
               })
@@ -270,7 +274,7 @@ const mITInit = (confType) => {
                   start.BASE_PATH = getBasePath(apiDefinition);
                   start.MST_TOKEN = authorization;
                   start.ADMIN_TOKEN = adminToken;
-                  return { file: testJsonFile, content: JSON.stringify(start2env(start), null, 2), type: 'JSON file' };
+                  return { file: testJsonFile, content: JSON.stringify(start2env(start), null, TAB), type: 'JSON file' };
                 }
                 if (adminToken) console.log('- admin token for the service: ' + adminToken.info);
                 console.log('- mST token: ' + authorization.info);
@@ -282,7 +286,7 @@ const mITInit = (confType) => {
       fs.writeFileSync(response.file, response.content);
       console.log(`${regType}status: ` + 'completed'.success + ', ' + response.type.info + ' created at (' + response.file.info + ')');
     })
-    .catch((err) => exitError(regType, err));
+    .catch(err => exitError(regType, err));
 };
 
 const serverInit = (confType) => {
@@ -308,7 +312,7 @@ const serverInit = (confType) => {
           start.CUSTOMER_NAME = customer.name;
           start.CUSTOMER_CODE = DUMMY_CUSTOMER_CODE;
           start.BASE_PATH = getBasePath(apiDefinition);
-          return { file: testJsonFile, content: JSON.stringify(start2env(start), null, 2), type: 'JSON file' };
+          return { file: testJsonFile, content: JSON.stringify(start2env(start), null, TAB), type: 'JSON file' };
         }
         return { file: shellFile, content: start2shell(start), type: 'shell script' };
       }
@@ -330,7 +334,7 @@ const serverInit = (confType) => {
           start = updatedStart;
           return settingUpAdminClient(type, `admin_${customer.name}_${start.NODE_ENV}_${type}`, customer, authorization, mSTBaseUrl)
             .then((adminType) => {
-              const adminAudience = _.find(adminType.audiences, (audienceItem) => audienceItem.type === type);
+              const adminAudience = find(adminType.audiences, audienceItem => audienceItem.type === type);
               if (adminAudience) return getAdminToken(adminAudience, adminType.data, mSTBaseUrl);
               return undefined;
             })
@@ -341,14 +345,14 @@ const serverInit = (confType) => {
                 start.BASE_PATH = getBasePath(apiDefinition);
                 start.MST_TOKEN = authorization;
                 start.ADMIN_TOKEN = adminToken;
-                const testResponse = { file: testJsonFile, content: JSON.stringify(start2env(start), null, 2), type: 'JSON file' };
+                const testResponse = { file: testJsonFile, content: JSON.stringify(start2env(start), null, TAB), type: 'JSON file' };
 
                 if (startConfig.oauthImplicitNeeded === 'yes') {
                   return settingUpAdminClient('mID', `admin_${customer.name}_${start.NODE_ENV}_mID`, customer, start.MST_TOKEN, mSTBaseUrl)
-                    .then((mIDAdminType) => getAdminToken(_.find(mIDAdminType.audiences, (audienceItem) => audienceItem.type === 'mID'), mIDAdminType.data, mSTBaseUrl))
+                    .then(mIDAdminType => getAdminToken(find(mIDAdminType.audiences, audienceItem => audienceItem.type === 'mID'), mIDAdminType.data, mSTBaseUrl))
                     .then((mIDAdminToken) => {
                       start.MID_TOKEN = mIDAdminToken;
-                      testResponse.content = JSON.stringify(start2env(start), null, 2);
+                      testResponse.content = JSON.stringify(start2env(start), null, TAB);
                       return testResponse;
                     });
                 }
@@ -364,7 +368,7 @@ const serverInit = (confType) => {
       fs.writeFileSync(response.file, response.content);
       console.log(`${regType}status: ` + 'completed'.success + ', ' + response.type.info + ' created at (' + response.file.info + ')');
     })
-    .catch((err) => exitError(regType, err));
+    .catch(err => exitError(regType, err));
 };
 
 /**
@@ -392,9 +396,9 @@ const serverInit = (confType) => {
  * | `../s3Log.json` | The S3 information
  * | `../mSTConfig.json` | The config for mST
  * | `../mITConfig.json` | The config for mIT
- * | `./local/testStart.json` | The local configuration. If it does not exist start.json and if sart.json does not exist start-example.json will be used to create start.json
+ * | `./local/testStart.json` | The local configuration. If it does not exist start.json will be used and if sart.json does not exist start-example.json will be used to create start.json
  */
-const mSTTestSetup = () => mSTInit(TEST);
+export const mSTTestSetup = () => mSTInit(TEST);
 
 /**
  *
@@ -423,7 +427,7 @@ const mSTTestSetup = () => mSTInit(TEST);
  * | `../mITConfig.json` | The config for mIT
  * | `./local/start.json` | The local configuration. If it does not exist start-example.json will be used to create start.json
  */
-const mSTSetup = () => mSTInit();
+export const mSTSetup = () => mSTInit();
 
 /**
  *
@@ -445,9 +449,9 @@ const mSTSetup = () => mSTInit();
  *
  * 1. retrieve the API from [swaggerhub](https://app.swaggerhub.com/search?type=API&owner=mimik)
  * 2. get an admin token for that service
- * 3. generate a json object store in a file under .
+ * 3. generate a JSON object store in a file under .
  *
- * In standAlone the dependencies will not be reachable and the operation that implies reaching dependencies will most likely generate a 500 error
+ * In standAlone the dependencies will not be reachable and the operation that implies reaching dependencies will most likely generate a 500 error.
  *
  * When mST and other servers are present, the following actions are being performed:
  *
@@ -457,7 +461,7 @@ const mSTSetup = () => mSTInit();
  * 4. register an admin client for that service in mST
  * 5. get an admin token for that service
  * 6. get an admin token for mID if needed
- * 7. generate a json object store in a file under .
+ * 7. generate a JSON object store in a file under .
  *
  * The following files are needed to perform these actions:
  *
@@ -468,9 +472,9 @@ const mSTSetup = () => mSTInit();
  * | `../s3Log.json` | The S3 information
  * | `../mSTConfig.json` | The config for mST
  * | `../mITConfig.json` | The config for mIT
- * | `./local/testStart.json` | The local configuration. If it does not exist start.json and if sart.json does not exist start-example.json will be used to create start.json
+ * | `./local/testStart.json` | The local configuration. If it does not exist start.json will be used and if sart.json does not exist start-example.json will be used to create start.json
  */
-const mITTestSetup = () => mITInit(TEST);
+export const mITTestSetup = () => mITInit(TEST);
 
 /**
  *
@@ -494,13 +498,12 @@ const mITTestSetup = () => mITInit(TEST);
  * 2. get an admin token for that service
  * 3. generate a shell script to start the server
  *
- * In standAlone the dependencies will not be reachable and the operation that implies reaching dependencies will most likely generate a 500 error
+ * In standAlone the dependencies will not be reachable and the operation that implies reaching dependencies will most likely generate a 500 error.
  *
  * When mST is present, the following actions are being performed:
  *
- *
  * 1. retrieve the API from [swaggerhub](https://app.swaggerhub.com/search?type=API&owner=mimik)
- * 2. get an Admin token for mST
+ * 2. get an admin token for mST
  * 3. register the service in mST
  * 4. generate a shell script to start the server
  *
@@ -537,9 +540,9 @@ const mITSetup = () => mITInit();
  *
  * 1. retrieve the API from [swaggerhub](https://app.swaggerhub.com/search?type=API&owner=mimik)
  * 2. get an admin token for that service
- * 3. generate a json object store in a file under .
+ * 3. generate a JSON object store in a file under .
  *
- * In standAlone the dependencies will not be reachable and the operation that implies reaching dependencies will most likely generate a 500 error
+ * In standAlone the dependencies will not be reachable and the operation that implies reaching dependencies will most likely generate a 500 error.
  *
  * When mST and other servers are present, the following actions are being performed:
  *
@@ -563,9 +566,9 @@ const mITSetup = () => mITInit();
  * | `../mITConfig.json` | The config for mIT
  * | `../mIDConfig.json` | The config for mID
  * | `../customerConfig.json` | The mST customer config
- * | `./local/testStart.json` | The local configuration. If it does not exist start.json and if sart.json does not exist start-example.json will be used to create start.json
+ * | `./local/testStart.json` | The local configuration. If it does not exist start.json will be used and if sart.json does not exist start-example.json will be used to create start.json
  */
-const testSetup = () => serverInit(TEST);
+export const testSetup = () => serverInit(TEST);
 
 /**
  *
@@ -589,13 +592,12 @@ const testSetup = () => serverInit(TEST);
  * 2. get an admin token for that service
  * 3. generate a shell script to start the server
  *
- * In standAlone the dependencies will not be reachable and the operation that implies reaching dependencies will most likely generate a 500 error
+ * In standAlone the dependencies will not be reachable and the operation that implies reaching dependencies will most likely generate a 500 error.
  *
  * When mST and other servers are present, the following actions are being performed:
  *
- *
  * 1. retrieve the API from [swaggerhub](https://app.swaggerhub.com/search?type=API&owner=mimik)
- * 2. get an Admin token for mST
+ * 2. get an admin token for mST
  * 3. setup the customer in mST
  * 4. register the service in mST
  * 5. generate a shell script to start the server
@@ -613,28 +615,28 @@ const testSetup = () => serverInit(TEST);
  * | `../customerConfig.json` | The mST customer config
  * | `./local/start.json` | The local configuration. If it does not exist start-example.json will be used to create start.json
  */
-const setup = () => serverInit();
+export const setup = () => serverInit();
 
 const rootPath = (pathName, ignore) => {
-  const rootDir = path.join(__dirname, '..', '..', '..');
+  const rootDir = join(localDirname, '..', '..', '..');
 
   if (pathName) {
-    if (ignore) return `${IGNORE}${path.join(rootDir, pathName)}`;
-    return path.join(rootDir, pathName);
+    if (ignore) return `${IGNORE}${join(rootDir, pathName)}`;
+    return join(rootDir, pathName);
   }
   if (ignore) return `${IGNORE}${rootDir}`;
   return rootDir;
 };
 
-const dotFiles = () => {
-  write(rootPath('.eslintrc'), parse(read(path.join(__dirname, 'dotFiles', 'eslintrc.json'), INSTALL)), 'eslintrc.json', INSTALL, true);
-  write(rootPath('.nycrc'), parse(read(path.join(__dirname, 'dotFiles', 'nycrc.json'), 'nycrc.json', INSTALL)), INSTALL, true);
-  write(rootPath('.gitignore'), read(path.join(__dirname, 'dotFiles', 'gitIgnore.txt'), INSTALL), INSTALL);
+export const dotFiles = () => {
+  write(rootPath('eslint.config.js'), parse(read(join(localDirname, 'dotFiles', 'eslint.config.js'), INSTALL)), 'eslint.config.js', INSTALL, true);
+  write(rootPath('.nycrc'), parse(read(join(localDirname, 'dotFiles', 'nycrc.json'), 'nycrc.json', INSTALL)), INSTALL, true);
+  write(rootPath('.gitignore'), read(join(localDirname, 'dotFiles', 'gitIgnore.txt'), INSTALL), INSTALL);
 };
 
-const scripts = () => {
+export const scripts = () => {
   const packageFilename = rootPath('package.json');
-  const scriptsFile = parse(read(path.join(__dirname, 'scripts.json'), INSTALL), 'scripts.json', INSTALL);
+  const scriptsFile = parse(read(join(localDirname, 'scripts.json'), INSTALL), 'scripts.json', INSTALL);
   const packageFile = parse(read(packageFilename, INSTALL), 'package.json', INSTALL);
 
   Object.keys(scriptsFile.scripts).forEach((script) => {
@@ -644,9 +646,9 @@ const scripts = () => {
   write(packageFilename, packageFile, 'package.json', INSTALL, true);
 };
 
-const unScripts = () => {
+export const unScripts = () => {
   const packageFilename = rootPath('package.json');
-  const scriptsFile = parse(read(path.join(__dirname, 'scripts.json'), INSTALL), 'scripts.json', INSTALL);
+  const scriptsFile = parse(read(join(localDirname, 'scripts.json'), INSTALL), 'scripts.json', INSTALL);
   const packageFile = parse(read(packageFilename, INSTALL), 'package.json', INSTALL);
 
   Object.keys(scriptsFile.scripts).forEach((script) => {
@@ -656,17 +658,19 @@ const unScripts = () => {
   write(packageFilename, packageFile, 'package.json', INSTALL, true);
 };
 
-module.exports = {
-  mSTTestSetup,
-  mSTSetup,
-  mITTestSetup,
-  mITSetup,
-  testSetup,
-  setup,
+export { testJsonFile };
+
+export default {
+  commitCheckMsg,
   dotFiles,
+  mITSetup,
+  mITTestSetup,
+  mSTSetup,
+  mSTTestSetup,
   scripts,
-  unScripts,
-  commitCheckMsg,
+  setup,
   start2process,
   testJsonFile,
+  testSetup,
+  unScripts,
 };

package/lib/common.js

@@ -1,3 +1,5 @@
+import process from 'process';
+
 const packageFile = './package.json';
 const mSTConfigFile = '../mSTConfig.json';
 const mITConfigFile = '../mITConfig.json';
@@ -143,7 +145,7 @@ const DEFAULT_LOCATION = {
 const ERR_CHECK = '✘';
 const SUCCESS_CHECK = '✔︎';
 
-module.exports = {
+export {
   packageFile,
   mSTConfigFile,
   mITConfigFile,

package/lib/commonExt.js

@@ -1,10 +1,13 @@
-const _ = require('lodash');
+import findIndex from 'lodash.findindex';
+import union from 'lodash.union';
 
 // duplicate of functions in mST lib/common.js
 const ALL_TYPE = 'all';
 const CLUSTER_TYPE = 'cluster';
+const NOT_FOUND = -1;
+const FIRST = 0;
 
-const inList = (type, list) => _.findIndex(list, (listItem) => listItem.type === type);
+const inList = (type, list) => findIndex(list, listItem => listItem.type === type);
 
 const setServiceInfo = (sharedWith, type, scopes, customer) => {
   const result = { type };
@@ -16,24 +19,24 @@ const setServiceInfo = (sharedWith, type, scopes, customer) => {
 };
 
 const getAllTargets = (serviceType, custConfig, serviceIndex) => {
-  const index = serviceIndex || serviceIndex === 0 ? serviceIndex : inList(serviceType, custConfig);
+  const index = serviceIndex || serviceIndex === FIRST ? serviceIndex : inList(serviceType, custConfig);
   const targets = [];
   const serviceInfo = (target, st) => {
     if (target.type !== CLUSTER_TYPE) return setServiceInfo(null, target.type, target.scopes, target.customer);
     return setServiceInfo(null, st, target.scopes);
   };
 
-  if (index !== -1) {
-    custConfig[index].targets.forEach((target) => targets.push(serviceInfo(target, serviceType)));
+  if (index !== NOT_FOUND) {
+    custConfig[index].targets.forEach(target => targets.push(serviceInfo(target, serviceType)));
     const allIndex = inList(ALL_TYPE, custConfig);
 
-    if (allIndex !== -1) {
+    if (allIndex !== NOT_FOUND) {
       custConfig[allIndex].targets.forEach((allTarget) => {
         if (!allTarget.except || !allTarget.except.includes(serviceType)) {
           const allTargetIndex = inList(allTarget.type === CLUSTER_TYPE ? serviceType : allTarget.type, targets);
 
-          if (allTargetIndex === -1) targets.push(serviceInfo(allTarget, serviceType));
-          else targets[allTargetIndex].scopes = _.union(targets[allTargetIndex].scopes, allTarget.scopes);
+          if (allTargetIndex === NOT_FOUND) targets.push(serviceInfo(allTarget, serviceType));
+          else targets[allTargetIndex].scopes = union(targets[allTargetIndex].scopes, allTarget.scopes);
         }
       });
     }
@@ -41,6 +44,6 @@ const getAllTargets = (serviceType, custConfig, serviceIndex) => {
   return targets;
 };
 
-module.exports = {
+export {
   getAllTargets,
 };