@mimik/local 1.6.0 → 4.4.2

package/.eslintrc

@@ -1,17 +1,29 @@
-// Use this file as a starting point for your project's .eslintrc.
-// Copy this file, and add rule overrides as needed.
 {
+  "plugins": [
+    "@mimik/document-env",
+    "@mimik/dependencies"
+  ],
   "env": {
     "node": true
   },
+  "parserOptions": {
+    "ecmaVersion": 2020
+  },
   "extends": "airbnb",
   "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"]
+    "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
   },
   "settings":{
     "react": {

package/.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npm run commit-ready

package/.husky/pre-push

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npm run test

package/Gulpfile.js

@@ -9,22 +9,21 @@ const jsdoc2md = require('jsdoc-to-markdown');
 const files = [
   'index.js',
   'Gulpfile.js',
-  'coniguration/**.js',
-  'test/**.js',
-  'lib/**.js',
+  'configuration/**/*.js',
+  'test/**/*.js',
+  'lib/**/*.js',
 ];
 
 const createDocs = (done) => {
   jsdoc2md.render({ files: 'index.js' })
     .then((output) => fs.writeFileSync('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 lint = () => gulp.src(files)
   .pipe(eslint({}))
-  .pipe(eslint.format())
-  .pipe(eslint.failOnError());
+  .pipe(eslint.format());
 
 const add = () => gulp.src('README.md')
   .pipe(git.add({ quiet: true }));

package/README.md

@@ -4,7 +4,7 @@
 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
  {
@@ -12,6 +12,7 @@ In the directory above the server root directory: five files `mSTConfig.json`, `
    "protocol": "protocol for the mST server, for example: `http:`, by default `http:`",
    "domainName": "domain name of the mST server",
    "port": "port for the mST server, for example: `8025`",
+   "passphrase": "passphrase to be used to generate public private key pair, if not present mST will user regular key",
    "update": "switch to indicate if mST needs to be updated, default is `false`. If the address is localhost, mST will be updated"
    "admin": {
      "clientId": "id or the client in order to get an admin token for mST, for example: `12345`",
@@ -44,7 +45,7 @@ Similar properties than for mSTConfig on `domainName` and `port` apply.
  }
 ```
 Similar properties than for mSTConfig on `domainName` and `port` apply.
-- for `sumo.json`:
+- for `sumoLog.json`:
 ``` javascript
  {
    "<serverType>": {
@@ -56,10 +57,50 @@ Similar properties than for mSTConfig on `domainName` and `port` apply.
      "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",
@@ -77,6 +118,7 @@ While all the files use the `.json` extension it is still possible to add commen
 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.
@@ -111,6 +153,8 @@ const local = require('@mimik/local');
         * [~mSTSetup()](#module_local..mSTSetup) ⇒
         * [~testSetup()](#module_local..testSetup) ⇒
         * [~setup()](#module_local..setup) ⇒
+        * [~testSetup()](#module_local..testSetup) ⇒
+        * [~setup()](#module_local..setup) ⇒
 
 <a name="module_local..test"></a>
 
@@ -152,11 +196,11 @@ The following files are needed to perform these actions:
 
 | 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  
 **Category**: sync  
 <a name="module_local..mSTSetup"></a>
@@ -178,17 +222,103 @@ The following files are needed to perform these actions:
 
 | 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  
 **Category**: sync  
 <a name="module_local..testSetup"></a>
 
 ### local~testSetup() ⇒
-Setup a service (not mST) for test.
+Setup mIT for test.
+
+**Kind**: inner method of [<code>local</code>](#module_local)  
+**Returns**: `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  
+**Category**: sync  
+<a name="module_local..setup"></a>
+
+### local~setup() ⇒
+Setup mIT.
+
+**Kind**: inner method of [<code>local</code>](#module_local)  
+**Returns**: `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  
+**Category**: sync  
+<a name="module_local..testSetup"></a>
+
+### local~testSetup() ⇒
+Setup a service (not mST, mIT) for test.
 
 **Kind**: inner method of [<code>local</code>](#module_local)  
 **Returns**: `null`.
@@ -199,14 +329,14 @@ Two modes are available:
 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:
 
@@ -223,7 +353,9 @@ The following files are needed to perform these actions:
 
 | 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
@@ -233,14 +365,28 @@ The following files are needed to perform these actions:
 <a name="module_local..setup"></a>
 
 ### local~setup() ⇒
-Setup a service (not mST).
+Setup a service (not mST, mIT).
 
 **Kind**: inner method of [<code>local</code>](#module_local)  
 **Returns**: `null`.
 
 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
@@ -253,10 +399,11 @@ The following files are needed to perform these actions:
 | 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  
 **Category**: sync  

package/configuration/config.js

@@ -1,4 +1,4 @@
-const adminExternalIdBase = 'test-local';
+const adminExternalIdBase = 'admin_default_local';
 
 module.exports = {
   adminExternalIdBase,
@@ -9,7 +9,7 @@ module.exports = {
   customerConfigFile: '../customerConfig.json',
   APIProvider: 'https://api.swaggerhub.com/apis',
   swaggerExt: 'swagger.json',
-  defaultDirectory:'./api',
+  defaultDirectory: './api',
   testJsonFile: './server-test.json',
   shellFile: './server-start.sh',
   startFile: './local/start.json',
@@ -41,10 +41,10 @@ module.exports = {
       audience: 'https://mimik',
     },
     admin: {
-      externalId: `${adminExternalIdBase}-mID`,
+      externalId: `${adminExternalIdBase}_mID`,
     },
   },
-  DEFAULT_SUMO:{
+  DEFAULT_SUMO: {
     default: {
       url: 'https://default-sumo-endPoint',
       code: '--- default code ---',