@mimik/local 1.6.1 → 4.4.3

package/index.js

@@ -8,29 +8,35 @@ const eslint = require('gulp-eslint');
 const git = require('gulp-git');
 const jsdoc2md = require('jsdoc-to-markdown');
 const mocha = require('gulp-spawn-mocha');
+const _ = require('lodash');
+
+const { commitCheckMsg } = require('@mimik/git-hooks');
 
 const {
   colors,
   exitError,
-  retrieve,
   start2env,
   start2shell,
+  baseUrl,
 } = require('./lib/helpers');
 const {
-  testStartFile,
-  exampleStartFile,
-  startFile,
   defaultDirectory,
   testJsonFile,
   shellFile,
   DUMMY_CUSTOMER_CODE,
+  LITERAL,
+  SYSTEM_NAME,
+  TEST,
+  IGNORE,
 } = require('./lib/common');
 const {
+  getStartParams,
   init,
   startSetup,
   getAPI,
   getAdminToken,
   settingUpDummyServer,
+  gettingSystemCustomer,
   settingUpServer,
   settingUpCustomer,
   settingUpAdminClient,
@@ -43,7 +49,6 @@ colors.setTheme({
   info: ['grey', 'bold'],
 });
 
-const system = 'System';
 /**
  * @module local
  * @example
@@ -52,7 +57,7 @@ const system = 'System';
  * @description Set of function for local deployment.
  *
  * The following files are expected to exist:
- * In the directory above the server root directory: five files `mSTConfig.json`, `mIDConfig.json`, `mITConfig.json`,`sumo.json`, `customerConfig.json` are being set. If the don't exist at the launch of the script, default will be setup.
+ * 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.
  * - for `mSTConfig.json`:
  * ``` javascript
  *  {
@@ -93,7 +98,7 @@ const system = 'System';
  *  }
  * ```
  * Similar properties than for mSTConfig on `domainName` and `port` apply.
- * - for `sumo.json`:
+ * - for `sumoLog.json`:
  * ``` javascript
  *  {
  *    "<serverType>": {
@@ -105,10 +110,50 @@ const system = 'System';
  *      "code": "code for sumologic, everything after the last / in the sumologic URL"
  *  }
  * ```
- * A property may be define for each `serverType` involved. If the serverType does not exist the default will be picked.
+ * - for `kinesisLog.json`:
+ * ``` javascript
+ *  {
+ *    "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"
+ *  }
+ * ```
+ * - for `s3Log.json`:
+ * ``` javascript
+ * {
+ *    "region": "region of the S3 implementation",
+ *    "accessKeyId": "Access key id for S3",
+ *    "secretAccessKey": "secret access key for S3",
+ *    "bucketname": "name of the S3 bucket used to store the information",
+ *    "maxEvents": "number of events buffered before sending to S3 (integer)",
+ *    "timeout": "number of seconds before timeout to send to S3 (integer)",
+ *    "maxSize": "max size in Bytes before sending to S3 (integer)"
+ * }
+ * ```
+ * - for `key.json`:
+ * ``` javascript
+ * {
+ *     "apiKey": "key to access API definition on the API provider"
+ * }
+ * ```
+ * - for `locationConfig.json`:
+ * ``` javascript
+ * {
+ *     "url": "url of the location provider"
+ *     "key": "key to make request to the location provider"
+ * }
+ * ```
+ * A property may be defined for each `serverType` involved. If the serverType does not exist the default will be picked.
  * - for `customerConfig.json`:
  * See `mST` `README.md` file for an example of a customer configuration. This may have to be updated to reflect the new servers.
- * - in the `local` directory of the server root directory: two files `start.json` and `testStart.json` may exit, if `testStart.json` is missing, `start.json` will be used as testStart.json. The configuration of these files depends on the configuration parameters of the server. The following is an example of start.json file for `mIT`:
+ * - 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 following is an example of start.json file for `mIT`:
  * ``` javascript
  *  {
  *    "NODE_ENV": "local",
@@ -126,6 +171,7 @@ const system = 'System';
  * There are reserved environement variable 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
  *
  * If SERVER_ID is not set in the start.json or testStart.json file, SERVER_ID will be assigned with a uuid.v4.
@@ -148,38 +194,84 @@ const system = 'System';
  */
 
 const mSTInit = (confType) => {
-  let regType = 'Local configuration setup ';
-  let startConfig;
-
-  process.stdout.write(regType);
-  if (confType === 'test') {
-    const test = 'for ' + 'test '.info;
-
-    process.stdout.write(test);
-    regType += test;
-    startConfig = retrieve(regType, testStartFile, { sourceFilename: exampleStartFile, altFilename: startFile });
-  }
-  else {
-    startConfig = retrieve(regType, startFile, { sourceFilename: exampleStartFile });
-  }
+  const { regType, startConfig } = getStartParams(confType);
   const config = init(regType);
   const start = startSetup(config, startConfig);
 
-  getAPI(start.SWAGGER_FILE_DIRECTORY || defaultDirectory, config.pack.name, config.pack.swaggerFile.version)
+  getAPI(start.SWAGGER_FILE_DIRECTORY || defaultDirectory, config.pack.swaggerFile.account, config.pack.swaggerFile.name, config.pack.swaggerFile.version, config.key.apiKey)
     .then((apiFile) => {
       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);
-      if (confType === 'test') {
-        start.CUSTOMER_NAME = system;
+      if (confType === TEST) {
+        start.CUSTOMER_NAME = SYSTEM_NAME;
         start.BASE_PATH = apiFile.basePath;
         return { file: testJsonFile, content: JSON.stringify(start2env(start), null, 2), type: 'JSON file' };
       }
-      let shell = '#!/bin/sh\n';
+      return { file: shellFile, content: start2shell(start), type: 'shell script' };
+    })
+    .then((response) => {
+      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));
+};
 
-      shell += start2shell(start);
-      shell += 'node index\n';
-      return { file: shellFile, content: shell, type: 'shell script' };
+const mITInit = (confType) => {
+  const { regType, startConfig } = getStartParams(confType);
+  const config = init(regType, startConfig.standAlone);
+  const { mSTBaseUrl } = config;
+  const { type } = config.pack.mimik;
+  let start = startSetup(config, startConfig);
+  let authorization;
+
+  getAPI(start.SWAGGER_FILE_DIRECTORY || defaultDirectory, config.pack.swaggerFile.account, config.pack.swaggerFile.name, config.pack.swaggerFile.version, config.key.apiKey)
+    .then((apiFile) => {
+      console.log('- mST base url: ' + `${mSTBaseUrl}`.info);
+      console.log('- mIT base url: ' + config.MITBaseUrl.info);
+      if (startConfig.standAlone === 'yes') {
+        console.log('- service ' + type.info + ' is in ' + 'stand alone'.warn + ' mode');
+        start = settingUpDummyServer(type, start.SERVER_ID, null, start);
+        if (confType === TEST) {
+          start.CUSTOMER_NAME = SYSTEM_NAME;
+          start.CUSTOMER_CODE = DUMMY_CUSTOMER_CODE;
+          start.BASE_PATH = apiFile.basePath;
+          return { file: testJsonFile, content: JSON.stringify(start2env(start), null, 2), type: 'JSON file' };
+        }
+        return { file: shellFile, content: start2shell(start), type: 'shell script' };
+      }
+      return getAdminToken(
+        { type: 'mST', audience: `${baseUrl('mST', regType, config.mST, LITERAL)}/clients/Generic-mST` },
+        { id: config.mST.admin.clientId, secret: config.mST.admin.clientSecret },
+        mSTBaseUrl,
+      )
+        .then((mSTAdminToken) => {
+          authorization = mSTAdminToken;
+          return gettingSystemCustomer(authorization, mSTBaseUrl);
+        })
+        .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);
+                if (adminAudience) return getAdminToken(adminAudience, adminType.data, mSTBaseUrl);
+                return undefined;
+              })
+              .then((adminToken) => {
+                if (confType === TEST) {
+                  start.CUSTOMER_NAME = customer.name;
+                  start.CUSTOMER_CODE = customer.code;
+                  start.BASE_PATH = apiFile.basePath;
+                  start.MST_TOKEN = authorization;
+                  start.ADMIN_TOKEN = adminToken;
+                  return { file: testJsonFile, content: JSON.stringify(start2env(start), null, 2), type: 'JSON file' };
+                }
+                if (adminToken) console.log('- admin token for the service: ' + adminToken.info);
+                console.log('- mST token: ' + authorization.info);
+                return { file: shellFile, content: start2shell(start), type: 'shell script' };
+              });
+          }));
     })
     .then((response) => {
       fs.writeFileSync(response.file, response.content);
@@ -189,60 +281,56 @@ const mSTInit = (confType) => {
 };
 
 const serverInit = (confType) => {
-  let regType = 'Local configuration setup ';
-  let startConfig;
+  const { regType, startConfig } = getStartParams(confType);
 
-  process.stdout.write(regType);
-  if (confType === 'test') {
-    const test = 'for ' + 'test '.info;
+  const standAlone = startConfig.standAlone === 'yes';
+  const isMSTDisabled = startConfig.DISABLE_MST === 'yes';
 
-    process.stdout.write(test);
-    regType += test;
-    startConfig = retrieve(regType, testStartFile, { sourceFilename: exampleStartFile, altFilename: startFile });
-  }
-  else {
-    startConfig = retrieve(regType, startFile, { sourceFilename: exampleStartFile });
-  }
-  const config = init(regType, startConfig.standAlone);
+  const config = init(regType, standAlone, isMSTDisabled);
   const { mSTBaseUrl, customer } = config;
-  const { type } = config.pack;
+  const { type } = config.pack.mimik;
   let start = startSetup(config, startConfig);
   let authorization;
 
-  getAPI(start.SWAGGER_FILE_DIRECTORY || defaultDirectory, config.pack.name, config.pack.swaggerFile.version)
+  getAPI(start.SWAGGER_FILE_DIRECTORY || defaultDirectory, config.pack.swaggerFile.account, config.pack.swaggerFile.name, config.pack.swaggerFile.version, config.key.apiKey)
     .then((apiFile) => {
       console.log('- mST base url: ' + `${mSTBaseUrl}`.info);
       console.log('- mIT base url: ' + config.MITBaseUrl.info);
-      if (startConfig.standAlone === 'yes') {
+      if (standAlone || isMSTDisabled) {
         console.log('- service ' + type.info + ' is in ' + 'stand alone'.warn + ' mode');
         start = settingUpDummyServer(type, start.SERVER_ID, customer, start);
-        if (confType === 'test') {
+        if (confType === TEST) {
           start.CUSTOMER_NAME = customer.name;
           start.CUSTOMER_CODE = DUMMY_CUSTOMER_CODE;
           start.BASE_PATH = apiFile.basePath;
           return { file: testJsonFile, content: JSON.stringify(start2env(start), null, 2), type: 'JSON file' };
         }
-        let shell = '#!/bin/sh\n';
-
-        shell += start2shell(start);
-        shell += 'node index\n';
-        return { file: shellFile, content: shell, type: 'shell script' };
+        return { file: shellFile, content: start2shell(start), type: 'shell script' };
       }
-      return getAdminToken('mST', { id: config.mST.admin.clientId, secret: config.mST.admin.clientSecret }, mSTBaseUrl)
+      return getAdminToken(
+        { type: 'mST', audience: `${baseUrl('mST', regType, config.mST, LITERAL)}/clients/Generic-mST` },
+        { id: config.mST.admin.clientId, secret: config.mST.admin.clientSecret },
+        mSTBaseUrl,
+      )
         .then((mSTAdminToken) => {
           authorization = mSTAdminToken;
           return settingUpCustomer(customer, authorization, mSTBaseUrl, config.mST.update);
         })
-        .then((code) => {
-          customer.code = code;
+        .then((updatedCustomer) => {
+          customer.code = updatedCustomer.code;
+          customer.config = updatedCustomer.config;
           return 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((admin) => getAdminToken(type, admin, mSTBaseUrl))
+            .then((adminType) => {
+              const adminAudience = _.find(adminType.audiences, (audienceItem) => audienceItem.type === type);
+              if (adminAudience) return getAdminToken(adminAudience, adminType.data, mSTBaseUrl);
+              return undefined;
+            })
             .then((adminToken) => {
-              if (confType === 'test') {
+              if (confType === TEST) {
                 start.CUSTOMER_NAME = customer.name;
                 start.CUSTOMER_CODE = customer.code;
                 start.BASE_PATH = apiFile.basePath;
@@ -252,7 +340,7 @@ const serverInit = (confType) => {
 
                 if (startConfig.oauthImplicitNeeded === 'yes') {
                   return settingUpAdminClient('mID', `admin_${customer.name}_${start.NODE_ENV}_mID`, customer, start.MST_TOKEN, mSTBaseUrl)
-                    .then((admin) => getAdminToken('mID', admin, 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);
@@ -261,13 +349,9 @@ const serverInit = (confType) => {
                 }
                 return testResponse;
               }
-              console.log('- admin token for the service: ' + adminToken.info);
+              if (adminToken) console.log('- admin token for the service: ' + adminToken.info);
               console.log('- mST token: ' + authorization.info);
-              let shell = '#!/bin/sh\n';
-
-              shell += start2shell(start);
-              shell += 'node index\n';
-              return { file: shellFile, content: shell, type: 'shell script' };
+              return { file: shellFile, content: start2shell(start), type: 'shell script' };
             });
         });
     })
@@ -298,14 +382,14 @@ const serverInit = (confType) => {
  *
  * | Filename | Description |
  * | -------- | ----------- |
- * | `../sumo.json` | The sumologic endpoints and code
+ * | `../sumoLog.json` | The sumologic endpoints and code
+ * | `../kinesisLog.json` | The Kinesis information
+ * | `../s3Log.json` | The S3 information
  * | `../mSTConfig.json` | The config for mST
  * | `../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
  */
-const mSTTestSetup = () => mSTInit('test');
+const mSTTestSetup = () => mSTInit(TEST);
 
 /**
  *
@@ -327,18 +411,110 @@ const mSTTestSetup = () => mSTInit('test');
  *
  * | Filename | Description |
  * | -------- | ----------- |
- * | `../sumo.json` | The sumologic endpoints and code
+ * | `../sumoLog.json` | The sumologic endpoints and code
+ * | `../kinesisLog.json` | The Kinesis information
+ * | `../s3Log.json` | The S3 information
  * | `../mSTConfig.json` | The config for mST
  * | `../mITConfig.json` | The config for mIT
- * | `../mIDConfig.json` | The config for mID
- * | `../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 mSTSetup = () => mSTInit();
 
 /**
  *
- * Setup a service (not mST) for test.
+ * Setup mIT for test.
+ *
+ * @function testSetup
+ * @category sync
+ *
+ * @return `null`.
+ *
+ * Will exit 1 if there is an error.
+ *
+ * Two modes are available:
+ * 1. stand alone
+ * 2. with mST
+ *
+ * The environment variable STAND_ALONE will select the mode.
+ * When in stand alone, 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 that service
+ * 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
+ *
+ * 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
+ * 3. register the service in mST
+ * 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 .
+ *
+ * The following files are needed to perform these actions:
+ *
+ * | Filename | Description |
+ * | -------- | ----------- |
+ * | `../sumoLog.json` | The sumologic endpoints and code
+ * | `../kinesisLog.json` | The Kinesis information
+ * | `../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
+ */
+const mITTestSetup = () => mITInit(TEST);
+
+/**
+ *
+ * Setup mIT.
+ *
+ * @function setup
+ * @category sync
+ *
+ * @return `null`.
+ *
+ * Will exit 1 if there is an error.
+ *
+ * Two modes are available:
+ * 1. stand alone
+ * 2. with mST
+ *
+ * The environment variable STAND_ALONE will select the mode.
+ * When in stand alone, 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 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
+ *
+ * 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
+ * 3. register the service in mST
+ * 4. generate a shell script to start the server
+ *
+ * The following files are needed to perform these actions:
+ *
+ * | Filename | Description |
+ * | -------- | ----------- |
+ * | `../sumoLog.json` | The sumologic endpoints and code
+ * | `../kinesisLog.json` | The Kinesis information
+ * | `../s3Log.json` | The S3 information
+ * | `../mSTConfig.json` | The config for mST
+ * | `../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 mITSetup = () => mITInit();
+
+/**
+ *
+ * Setup a service (not mST, mIT) for test.
  *
  * @function testSetup
  * @category sync
@@ -351,14 +527,14 @@ const mSTSetup = () => mSTInit();
  * 1. stand alone
  * 2. with mST, mID are other dependent servers
  *
- * The environment variable STAND_ALONE will select the the mode.
+ * The environment variable STAND_ALONE will select the mode.
  * When in stand alone, 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 that service
  * 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 like 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:
  *
@@ -375,18 +551,20 @@ const mSTSetup = () => mSTInit();
  *
  * | Filename | Description |
  * | -------- | ----------- |
- * | `../sumo.json` | The sumologic endpoints and code
+ * | `../sumoLog.json` | The sumologic endpoints and code
+ * | `../kinesisLog.json` | The Kinesis information
+ * | `../s3Log.json` | The S3 information
  * | `../mSTConfig.json` | The config for mST
  * | `../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
  */
-const testSetup = () => serverInit('test');
+const testSetup = () => serverInit(TEST);
 
 /**
  *
- * Setup a service (not mST).
+ * Setup a service (not mST, mIT).
  *
  * @function setup
  * @category sync
@@ -395,7 +573,21 @@ const testSetup = () => serverInit('test');
  *
  * Will exit 1 if there is an error.
  *
- * The following actions are being performed:
+ * Two modes are available:
+ * 1. stand alone
+ * 2. with mST, mID are other dependent servers
+ *
+ * The environment variable STAND_ALONE will select the mode.
+ * When in stand alone, 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 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
+ *
+ * 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
@@ -408,32 +600,33 @@ const testSetup = () => serverInit('test');
  * | Filename | Description |
  * | -------- | ----------- |
  * | `../sumo.json` | The sumologic endpoints and code
+ * | `../kinesisLog.json` | The Kinesis information
+ * | `../s3Log.json` | The S3 information
  * | `../mSTConfig.json` | The config for mST
  * | `../mITConfig.json` | The config for mIT
  * | `../mIDConfig.json` | The config for mID
  * | `../customerConfig.json` | The mST customer config
- * | `./config.json` | The config of the service
  * | `./local/start.json` | The local configuration. If it does not exist start-example.json will be used to create start.json
  */
 const setup = () => serverInit();
 
-const rootPath = (pathName) => {
+const rootPath = (pathName, ignore) => {
   const rootDir = path.join(__dirname, '..', '..', '..');
 
-  if (pathName) return path.join(rootDir, pathName);
+  if (pathName) {
+    if (ignore) return `${IGNORE}${path.join(rootDir, pathName)}`;
+    return path.join(rootDir, pathName);
+  }
+  if (ignore) return `${IGNORE}${rootDir}`;
   return rootDir;
 };
 const files = [
-  rootPath('index.js'),
-  rootPath('configuration/*.js'),
-  rootPath('controllers/*.js'),
-  rootPath('processors/*.js'),
-  rootPath('models/*.js'),
-  rootPath('lib/**.js'),
-  rootPath('util/**.js'),
+  rootPath('src/**/*.js'),
   rootPath('Gulpfile.js'),
   rootPath('local/**.js'),
-  rootPath('test/**.js'),
+  rootPath('test/**/*.js'),
+  rootPath('tools/**/*.js'),
+  rootPath('tools/**/{node_modules,node_modules/**}', true),
 ];
 
 /**
@@ -468,14 +661,13 @@ const test = () => {
  */
 const lint = () => gulp.src(files, { allowEmpty: true })
   .pipe(eslint({}))
-  .pipe(eslint.format())
-  .pipe(eslint.failOnError());
+  .pipe(eslint.format());
 
 const createDocs = (done) => {
-  jsdoc2md.render({ files: rootPath('configuration/config.js') })
+  jsdoc2md.render({ files: rootPath('src/configuration/config.js') })
     .then((output) => fs.writeFileSync(rootPath('README.md'), output))
-    .catch((err) => log.error('docs creation failed:', err.message));
-  return done();
+    .catch((err) => log.error('docs creation failed:', err.message))
+    .finally(() => done());
 };
 
 const add = () => gulp.src(rootPath('README.md'))
@@ -492,13 +684,91 @@ const add = () => gulp.src(rootPath('README.md'))
  */
 const docs = gulp.series(createDocs, add);
 
+const dotFiles = () => {
+  const eslintrc = {
+    env: {
+      node: true,
+    },
+    plugins: [
+      '@mimik/document-env',
+      '@mimik/dependencies',
+    ],
+    extends: 'airbnb',
+    parserOptions: {
+      ecmaVersion: 2020,
+    },
+    rules: {
+      'import/no-extraneous-dependencies': ['error', { devDependencies: true }],
+      'brace-style': [1, 'stroustrup', { allowSingleLine: true }],
+      'no-confusing-arrow': [0], // arrow isnt confusing
+      'max-len': [1, 180, { ignoreComments: true }],
+      'linebreak-style': 0,
+      quotes: [1, 'single'],
+      semi: [1, 'always'],
+      'no-process-env': ['error'],
+      '@mimik/document-env/validate-document-env': 2,
+      '@mimik/dependencies/case-sensitive': 2,
+      '@mimik/dependencies/no-cycles': 2,
+      '@mimik/dependencies/no-unresolved': 2,
+      '@mimik/dependencies/require-json-ext': 2,
+    },
+    overrides: [
+      {
+        files: [
+          'src/configuration/config.js',
+          'test/**/*.js',
+          'tools/**/*.js',
+        ],
+        rules: {
+          'no-process-env': 'off',
+        },
+      },
+      {
+        files: [
+          'test/**/*.js',
+          'tools/**/*.js',
+        ],
+        rules: {
+          '@mimik/document-env/validate-document-env': 'off',
+        },
+      },
+    ],
+    settings: {
+      react: {
+        version: 'latest',
+      },
+    },
+    globals: {
+      module: true,
+      require: true,
+      const: false,
+      it: false,
+      describe: false,
+      before: true,
+      after: true,
+      JSON: true,
+    },
+  };
+  const nycrc = {
+    exclude: ['gulpfile.js'],
+    reporter: ['lcov', 'text'],
+  };
+
+  fs.writeFileSync(rootPath('.eslintrc'), JSON.stringify(eslintrc, null, 2));
+  fs.writeFileSync(rootPath('.nycrc'), JSON.stringify(nycrc, null, 2));
+};
+
 module.exports = {
   mSTTestSetup,
   mSTSetup,
+  mITTestSetup,
+  mITSetup,
   testSetup,
   setup,
   test,
   lint,
   docs,
   add,
+  dotFiles,
+  commitCheckMsg,
 };