@mimik/local 5.1.6 → 5.2.0

package/README.md

@@ -83,7 +83,8 @@ Similar properties than for mSTConfig on `domainName` and `port` apply.
 - for `key.json`:
 ``` javascript
 {
-    "apiKey": "key to access API definition on the API provider"
+    "username": "username to access the bitbucket account",
+    "password": "password to access the bitbucket account"
 }
 ```
 - for `locationConfig.json`:

package/index.js

@@ -17,7 +17,7 @@ const {
   parse,
 } = require('./lib/helpers');
 const {
-  defaultDirectory,
+  DEFAULT_DIRECTORY,
   testJsonFile,
   shellFile,
   DUMMY_CUSTOMER_CODE,
@@ -135,7 +135,8 @@ const INSTALL = 'install';
  * - for `key.json`:
  * ``` javascript
  * {
- *     "apiKey": "key to access API definition on the API provider"
+ *     "username": "username to access the bitbucket account",
+ *     "password": "password to access the bitbucket account"
  * }
  * ```
  * - for `locationConfig.json`:
@@ -197,7 +198,7 @@ const mSTInit = (confType) => {
   const config = init(regType, false, true);
   const start = startSetup(config, startConfig);
 
-  getAPI(start.SWAGGER_FILE_DIRECTORY || defaultDirectory, config.pack.swaggerFile.account, config.pack.swaggerFile.name, config.pack.swaggerFile.version, config.key.apiKey)
+  getAPI(start.SWAGGER_FILE_DIRECTORY || DEFAULT_DIRECTORY, config.pack.swaggerFile.account, config.pack.swaggerFile.name, config.pack.swaggerFile.version, config.key)
     .then((apiFile) => {
       console.log('- mST base url: ' + config.mSTBaseUrl.info);
       console.log('- mIT base url: ' + config.MITBaseUrl.info);
@@ -224,7 +225,7 @@ const mITInit = (confType) => {
   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)
+  getAPI(start.SWAGGER_FILE_DIRECTORY || DEFAULT_DIRECTORY, config.pack.swaggerFile.account, config.pack.swaggerFile.name, config.pack.swaggerFile.version, config.key)
     .then((apiFile) => {
       console.log('- mST base url: ' + `${mSTBaseUrl}`.info);
       console.log('- mIT base url: ' + config.MITBaseUrl.info);
@@ -291,7 +292,7 @@ const serverInit = (confType) => {
   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)
+  getAPI(start.SWAGGER_FILE_DIRECTORY || DEFAULT_DIRECTORY, config.pack.swaggerFile.account, config.pack.swaggerFile.name, config.pack.swaggerFile.version, config.key)
     .then((apiFile) => {
       console.log('- mST base url: ' + `${mSTBaseUrl}`.info);
       console.log('- mIT base url: ' + config.MITBaseUrl.info);

package/lib/common.js

@@ -8,9 +8,13 @@ const kinesisLogFile = '../kinesisLog.json';
 const locationFile = '../locationConfig.json';
 const keyFile = '../key.json';
 const customerConfigFile = '../customerConfig.json';
-const APIProvider = 'https://api.swaggerhub.com/apis';
-const swaggerExt = 'swagger.json';
-const defaultDirectory = './api';
+
+const API_PROVIDER = 'https://api.bitbucket.org/2.0/repositories';
+const API_SOURCE = '/src';
+const SWAGGER = 'swagger';
+const EXTENSION = '.yml';
+const SWAGGER_EXT = `${SWAGGER}.json`;
+const DEFAULT_DIRECTORY = './api';
 
 const AWS_S3 = 'awsS3';
 const AWS_KINESIS = 'awsKinesis';
@@ -22,6 +26,9 @@ const ALL_MODES = [AWS_S3, AWS_KINESIS, SUMOLOGIC, ALL, NONE];
 const SWAGGER_SEP = '_';
 const TEST = 'test';
 
+const DEFAULT_BITBUCKET_USERNAME = ' ';
+const DEFAULT_BITBUCKET_PASSWORD = ' ';
+
 const SYSTEM_NAME = 'System';
 const TOKEN_SERVICE = 'mST';
 const IT_REGISTRY = 'mIT';
@@ -116,7 +123,8 @@ const DEFAULT_KINESISLOG = {
   streamNameOther: '--- default streamName Other ---',
 };
 const DEFAULT_KEY = {
-  apiKey: null,
+  username: DEFAULT_BITBUCKET_USERNAME,
+  password: DEFAULT_BITBUCKET_USERNAME,
 };
 const DEFAULT_LOCATION = {
   url: null,
@@ -137,9 +145,12 @@ module.exports = {
   locationFile,
   keyFile,
   customerConfigFile,
-  APIProvider,
-  swaggerExt,
-  defaultDirectory,
+  API_PROVIDER,
+  API_SOURCE,
+  SWAGGER,
+  EXTENSION,
+  SWAGGER_EXT,
+  DEFAULT_DIRECTORY,
   testJsonFile,
   shellFile,
   startFile,
@@ -175,4 +186,6 @@ module.exports = {
   TOKEN_SERVICE,
   IT_REGISTRY,
   IDENTITY_SERVICE,
+  DEFAULT_BITBUCKET_USERNAME,
+  DEFAULT_BITBUCKET_PASSWORD,
 };

package/lib/tasks.js

@@ -5,6 +5,9 @@ const path = require('path');
 const Promise = require('bluebird');
 const uuid = require('uuid');
 const _ = require('lodash');
+const yaml = require('js-yaml');
+const SwaggerClient = require('swagger-client');
+const { Base64 } = require('js-base64');
 
 const { rp } = require('./rp-axios-wrapper');
 const { getAllTargets } = require('./commonExt');
@@ -25,8 +28,11 @@ const {
   mIDConfigFile,
   ERR_CHECK,
   SUCCESS_CHECK,
-  swaggerExt,
-  APIProvider,
+  SWAGGER_EXT,
+  API_SOURCE,
+  SWAGGER,
+  EXTENSION,
+  API_PROVIDER,
   correlationId,
   LITERAL,
   DEFAULT_SUMOLOG,
@@ -52,6 +58,8 @@ const {
   TOKEN_SERVICE,
   IDENTITY_SERVICE,
   TEST,
+  DEFAULT_BITBUCKET_USERNAME,
+  DEFAULT_BITBUCKET_PASSWORD,
 } = require('./common');
 const {
   exitError,
@@ -245,14 +253,15 @@ const startSetup = (config, origStart) => {
  * @param {string} account - Account of the API API to retrieve.
  * @param {string} type - Type of microservice associated with the API to retrieve.
  * @param {SEMVER<string>} version - Version fo the API to retrieve.
- * @param {string} apiKey - key to access private API.
+ * @param {string} basicAuth - username password to access the bitbucket account
+ * .
  * @return {Promise}.
  * @fulfil {object} The API file itself.
  * @throws {Promise} An error containing the reason of the failure.
  *
  * The directory will be created if it does not exist.
  */
-const getAPI = (directory, account, type, version, apiKey) => {
+const getAPI = (directory, account, type, version, basicAuth) => {
   const fileExists = (fname) => {
     try { fs.statSync(fname); }
     catch (err) { return false; }
@@ -267,17 +276,37 @@ const getAPI = (directory, account, type, version, apiKey) => {
       return Promise.reject(err);
     }
   }
-  const filename = path.join(directory, `${account}${SWAGGER_SEP}${type}${SWAGGER_SEP}${version}${SWAGGER_SEP}${swaggerExt}`);
+  const apiFilename = path.join(directory, `${account}${SWAGGER_SEP}${type}${SWAGGER_SEP}${version}${SWAGGER_SEP}${SWAGGER_EXT}`);
 
-  if (fileExists(filename)) {
-    let result;
+  if (fileExists(apiFilename)) {
+    console.log(': ' + apiFilename.info + ' ' + 'already setup'.warn);
+    let apiDefinition;
 
-    console.log(': ' + filename.info + ' ' + 'already setup'.warn);
-    try { result = json.parse(fs.readFileSync(filename).toString()); }
+    try { apiDefinition = json.parse(fs.readFileSync(apiFilename).toString()); }
     catch (errRead) { return Promise.reject(errRead); }
-    return Promise.resolve(result);
+    return SwaggerClient.resolve({
+      spec: apiDefinition,
+      allowMetaPatches: false,
+      skipNormalization: true,
+      mode: 'strict',
+    })
+      .then((apiDefinitionResult) => {
+        if (apiDefinitionResult.errors.length !== 0) {
+          throw new Error('Errors while resolving definition');
+        }
+        fs.writeFileSync(apiFilename, JSON.stringify(apiDefinitionResult.spec, null, 2));
+        console.log(SUCCESS_CHECK.success);
+        return apiDefinitionResult.spec;
+      })
+      .catch((err) => {
+        console.log(ERR_CHECK.error);
+        const error = err;
+
+        error.message = `${error.message} - { "apiFilename": "${apiFilename}" }`;
+        throw error;
+      });
   }
-  const url = `${APIProvider}/${account}/${type}/${version}`;
+  const url = `${API_PROVIDER}/${account}/${type}${API_SOURCE}/${version}/${SWAGGER}${EXTENSION}`;
 
   process.stdout.write(' at (' + `${url}`.info + '): ');
   const options = {
@@ -285,20 +314,36 @@ const getAPI = (directory, account, type, version, apiKey) => {
     url,
   };
 
-  if (apiKey) options.headers = { Authorization: apiKey };
+  if (!basicAuth || basicAuth.username === DEFAULT_BITBUCKET_USERNAME || basicAuth.password === DEFAULT_BITBUCKET_PASSWORD) {
+    console.log(ERR_CHECK.error);
+    return Promise.reject(new Error('missing username/password for accessing Bitbucket'));
+  }
+  try { options.headers = { authorization: `Basic ${Base64.encode(`${basicAuth.username}:${basicAuth.password}`)}` }; }
+  catch (err) {
+    console.log(ERR_CHECK.error);
+    return Promise.reject(err);
+  }
   return rp(options)
-    .catch((err) => {
-      console.log(ERR_CHECK.error);
-      throw err;
-    })
-    .then((result) => {
-      try { fs.writeFileSync(filename, json.stringify(result, null, 2)); }
-      catch (err) {
-        console.log(ERR_CHECK.error);
-        throw err;
+    .then((result) => SwaggerClient.resolve({
+      spec: yaml.load(result),
+      allowMetaPatches: false,
+      skipNormalization: true,
+      mode: 'strict',
+    }))
+    .then((apiDefinitionResult) => {
+      if (apiDefinitionResult.errors.length !== 0) {
+        throw new Error('Errors while resolving definition');
       }
+      fs.writeFileSync(apiFilename, JSON.stringify(apiDefinitionResult.spec, null, 2));
       console.log(SUCCESS_CHECK.success);
-      return result;
+      return apiDefinitionResult.spec;
+    })
+    .catch((err) => {
+      console.log(ERR_CHECK.error);
+      const error = err;
+
+      error.message = `${error.message} - { "apiFilename": "${apiFilename}" }`;
+      throw error;
     });
 };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mimik/local",
-  "version": "5.1.6",
+  "version": "5.2.0",
   "description": "Local setup configuration for normal and test opreration",
   "main": "index.js",
   "scripts": {
@@ -29,31 +29,34 @@
     "url": "https://bitbucket.org/mimiktech/local"
   },
   "dependencies": {
+    "@mimik/eslint-plugin-dependencies": "^2.4.5",
+    "@mimik/eslint-plugin-document-env": "^1.0.5",
     "@mimik/git-hooks": "^1.5.7",
-    "axios": "1.2.1",
+    "axios": "1.3.5",
     "bluebird": "3.7.2",
+    "chai": "4.3.7",
     "colors": "1.4.0",
     "comment-json": "4.2.3",
     "debug": "4.3.4",
-    "ip": "1.1.8",
-    "lodash": "4.17.21",
-    "uuid": "9.0.0",
-    "@mimik/eslint-plugin-dependencies": "^2.4.5",
-    "@mimik/eslint-plugin-document-env": "^1.0.5",
-    "chai": "4.3.7",
-    "eslint": "8.30.0",
+    "eslint": "8.38.0",
     "eslint-config-airbnb": "19.0.4",
-    "eslint-plugin-import": "2.26.0",
-    "eslint-plugin-jsx-a11y": "6.6.1",
-    "eslint-plugin-react": "7.31.11",
+    "eslint-plugin-import": "2.27.5",
+    "eslint-plugin-jsx-a11y": "6.7.1",
+    "eslint-plugin-react": "7.32.2",
     "eslint-plugin-react-hooks": "4.6.0",
-    "husky": "8.0.2",
+    "husky": "8.0.3",
+    "ip": "1.1.8",
+    "js-base64": "3.7.5",
+    "js-yaml": "4.1.0",
     "jsdoc-to-markdown": "8.0.0",
+    "lodash": "4.17.21",
     "mocha": "10.2.0",
     "mochawesome": "7.1.3",
     "nyc": "15.1.0",
     "rewire": "6.0.0",
-    "sinon": "15.0.1",
-    "supertest": "6.3.3"
+    "sinon": "15.0.3",
+    "supertest": "6.3.3",
+    "swagger-client": "3.19.6",
+    "uuid": "9.0.0"
   }
 }