@mimik/local 5.2.2 → 6.0.0

package/README.md

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

package/index.js

@@ -48,6 +48,8 @@ colors.setTheme({
 
 const INSTALL = 'install';
 
+const getBasePath = (apiDef) => apiDef.basePath || apiDef.servers[0].url;
+
 /**
  * @module local
  * @example
@@ -135,8 +137,11 @@ const INSTALL = 'install';
  * - for `key.json`:
  * ``` javascript
  * {
- *     "username": "username to access the bitbucket account",
- *     "password": "password to access the bitbucket account"
+ *   "gitbub": {
+ *      "username": "username to access the bitbucket account",
+ *      "password": "password to access the bitbucket account"
+ *   },
+ *   "swaggerhub": "key to access private API on swaggerhub"
  * }
  * ```
  * - for `locationConfig.json`:
@@ -198,14 +203,14 @@ const mSTInit = (confType) => {
   const config = init(regType, false, true);
   const start = startSetup(config, startConfig);
 
-  getAPI(start.SWAGGER_FILE_DIRECTORY || DEFAULT_DIRECTORY, config.pack.swaggerFile.account, config.pack.swaggerFile.name, config.pack.swaggerFile.version, config.key)
-    .then((apiFile) => {
+  getAPI(start.SWAGGER_FILE_DIRECTORY || DEFAULT_DIRECTORY, config.pack.swaggerFile, config.key)
+    .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);
       if (confType === TEST) {
         start.CUSTOMER_NAME = SYSTEM_NAME;
-        start.BASE_PATH = apiFile.basePath;
+        start.BASE_PATH = getBasePath(apiDefinition);
         return { file: testJsonFile, content: JSON.stringify(start2env(start), null, 2), type: 'JSON file' };
       }
       return { file: shellFile, content: start2shell(start), type: 'shell script' };
@@ -225,8 +230,8 @@ const mITInit = (confType) => {
   let start = startSetup(config, startConfig);
   let authorization;
 
-  getAPI(start.SWAGGER_FILE_DIRECTORY || DEFAULT_DIRECTORY, config.pack.swaggerFile.account, config.pack.swaggerFile.name, config.pack.swaggerFile.version, config.key)
-    .then((apiFile) => {
+  getAPI(start.SWAGGER_FILE_DIRECTORY || DEFAULT_DIRECTORY, config.pack.swaggerFile, config.key)
+    .then((apiDefinition) => {
       console.log('- mST base url: ' + `${mSTBaseUrl}`.info);
       console.log('- mIT base url: ' + config.MITBaseUrl.info);
       if (startConfig.standAlone === 'yes') {
@@ -235,7 +240,7 @@ const mITInit = (confType) => {
         if (confType === TEST) {
           start.CUSTOMER_NAME = SYSTEM_NAME;
           start.CUSTOMER_CODE = DUMMY_CUSTOMER_CODE;
-          start.BASE_PATH = apiFile.basePath;
+          start.BASE_PATH = getBasePath(apiDefinition);
           return { file: testJsonFile, content: JSON.stringify(start2env(start), null, 2), type: 'JSON file' };
         }
         return { file: shellFile, content: start2shell(start), type: 'shell script' };
@@ -262,7 +267,7 @@ const mITInit = (confType) => {
                 if (confType === TEST) {
                   start.CUSTOMER_NAME = customer.name;
                   start.CUSTOMER_CODE = customer.code;
-                  start.BASE_PATH = apiFile.basePath;
+                  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' };
@@ -292,8 +297,8 @@ const serverInit = (confType) => {
   let start = startSetup(config, startConfig);
   let authorization;
 
-  getAPI(start.SWAGGER_FILE_DIRECTORY || DEFAULT_DIRECTORY, config.pack.swaggerFile.account, config.pack.swaggerFile.name, config.pack.swaggerFile.version, config.key)
-    .then((apiFile) => {
+  getAPI(start.SWAGGER_FILE_DIRECTORY || DEFAULT_DIRECTORY, config.pack.swaggerFile, config.key)
+    .then((apiDefinition) => {
       console.log('- mST base url: ' + `${mSTBaseUrl}`.info);
       console.log('- mIT base url: ' + config.MITBaseUrl.info);
       if (standAlone || !isMSTSet) {
@@ -302,7 +307,7 @@ const serverInit = (confType) => {
         if (confType === TEST) {
           start.CUSTOMER_NAME = customer.name;
           start.CUSTOMER_CODE = DUMMY_CUSTOMER_CODE;
-          start.BASE_PATH = apiFile.basePath;
+          start.BASE_PATH = getBasePath(apiDefinition);
           return { file: testJsonFile, content: JSON.stringify(start2env(start), null, 2), type: 'JSON file' };
         }
         return { file: shellFile, content: start2shell(start), type: 'shell script' };
@@ -333,7 +338,7 @@ const serverInit = (confType) => {
               if (confType === TEST) {
                 start.CUSTOMER_NAME = customer.name;
                 start.CUSTOMER_CODE = customer.code;
-                start.BASE_PATH = apiFile.basePath;
+                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' };

package/lib/common.js

@@ -9,12 +9,17 @@ const locationFile = '../locationConfig.json';
 const keyFile = '../key.json';
 const customerConfigFile = '../customerConfig.json';
 
-const API_PROVIDER = 'https://api.bitbucket.org/2.0/repositories';
+const API_PROVIDER_BITBUCKET = 'https://api.bitbucket.org/2.0/repositories';
+const API_PROVIDER_SWAGGERHUB = 'https://api.swaggerhub.com/apis';
 const API_SOURCE = '/src';
 const SWAGGER = 'swagger';
-const EXTENSION = '.yml';
-const SWAGGER_EXT = `${SWAGGER}.json`;
+const EXTENSION_YML = '.yml';
+const EXTENSION_JSON = '.json';
+const POSTFIX = `${SWAGGER}${EXTENSION_JSON}`;
 const DEFAULT_DIRECTORY = './api';
+const SWAGGERHUB = 'swaggerhub';
+const BITBUCKET = 'bitbucket';
+const RESOLVED = 'resolved=true';
 
 const AWS_S3 = 'awsS3';
 const AWS_KINESIS = 'awsKinesis';
@@ -45,6 +50,10 @@ const LITERAL = true;
 const IGNORE = '!';
 
 const correlationId = `test-local@0/${new Date().toISOString()}`;
+const languageDescription = `${process.release.name} ${process.version}`;
+const platformDescription = `${process.platform}; ${process.arch}`;
+const inBracket = `(${platformDescription}; ${languageDescription})`;
+const userAgent = `test-local ${inBracket}`;
 
 const DEFAULT_MST = {
   basePath: '/mST/v1',
@@ -145,11 +154,15 @@ module.exports = {
   locationFile,
   keyFile,
   customerConfigFile,
-  API_PROVIDER,
+  API_PROVIDER_BITBUCKET,
+  API_PROVIDER_SWAGGERHUB,
+  BITBUCKET,
+  SWAGGERHUB,
   API_SOURCE,
   SWAGGER,
-  EXTENSION,
-  SWAGGER_EXT,
+  EXTENSION_YML,
+  POSTFIX,
+  RESOLVED,
   DEFAULT_DIRECTORY,
   testJsonFile,
   shellFile,
@@ -158,6 +171,7 @@ module.exports = {
   exampleStartFile,
   exampleTestStartFile,
   correlationId,
+  userAgent,
   LITERAL,
   IGNORE,
   TEST,

package/lib/rp-axios-wrapper.js

@@ -1,35 +1,51 @@
 const axios = require('axios');
 const http = require('http');
 
-const rp = (options) => axios(options)
-  .then((res) => {
-    if (options.resolveWithFullResponse) return res;
-    return res.data;
-  })
-  .catch((err) => {
-    const { response } = err;
+const { correlationId, userAgent } = require('./common');
 
-    if (!response) {
-      const error = new Error('system Error');
+const rp = (origOptions) => {
+  const options = origOptions;
 
-      error.statusCode = 500;
-      error.title = http.STATUS_CODES[error.statusCode];
-      error.info = {
-        code: err.code,
-        address: err.address,
-        port: err.port,
-        syscall: err.syscall,
-      };
-      throw error;
-    }
-    const { data } = response;
-    const error = new Error(data ? data.message || response.statusText : response.statusText);
+  if (options.headers) {
+    options.headers['user-agent'] = userAgent;
+    if (!options.headers['x-correlation-id']) options.headers['x-correlationId'] = correlationId;
+  }
+  else {
+    options.headers = {
+      'user-agent': userAgent,
+      'x-correlationId': correlationId,
+    };
+  }
+  return axios(options)
+    .then((res) => {
+      if (options.resolveWithFullResponse) return res;
+      return res.data;
+    })
+    .catch((err) => {
+      const { response } = err;
+
+      if (!response) {
+        const error = new Error('system Error');
+
+        error.statusCode = 500;
+        error.title = http.STATUS_CODES[error.statusCode];
+        error.info = {
+          code: err.code,
+          address: err.address,
+          port: err.port,
+          syscall: err.syscall,
+        };
+        throw error;
+      }
+      const { data } = response;
+      const error = new Error(data ? data.message || response.statusText : response.statusText);
 
-    error.statusCode = response.status;
-    error.title = response.statusText;
-    if (data && data.info) error.info = data.info;
-    throw error;
-  });
+      error.statusCode = response.status;
+      error.title = response.statusText;
+      if (data && data.info) error.info = data.info;
+      throw error;
+    });
+};
 
 module.exports = {
   rp,

package/lib/tasks.js

@@ -28,12 +28,15 @@ const {
   mIDConfigFile,
   ERR_CHECK,
   SUCCESS_CHECK,
-  SWAGGER_EXT,
+  POSTFIX,
   API_SOURCE,
   SWAGGER,
-  EXTENSION,
-  API_PROVIDER,
-  correlationId,
+  API_PROVIDER_SWAGGERHUB,
+  API_PROVIDER_BITBUCKET,
+  SWAGGERHUB,
+  BITBUCKET,
+  RESOLVED,
+  EXTENSION_YML,
   LITERAL,
   DEFAULT_SUMOLOG,
   DEFAULT_S3LOG,
@@ -253,10 +256,8 @@ const startSetup = (config, origStart) => {
  * @function getAPI
  * @category async
  * @param {PATH<string>} directory - Directory to store the API file.
- * @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} basicAuth - username password to access the bitbucket account
+ * @param {object} swaggerFile - Information from package.swaggeFile.
+ * @param {string} key - `bitbucket` with username password to access the bitbucket account or string to access `swaggerhub`.
  * .
  * @return {Promise}.
  * @fulfil {object} The API file itself.
@@ -264,88 +265,124 @@ const startSetup = (config, origStart) => {
  *
  * The directory will be created if it does not exist.
  */
-const getAPI = (directory, account, type, version, basicAuth) => {
-  const fileExists = (fname) => {
-    try { fs.statSync(fname); }
-    catch (err) { return false; }
-    return true;
-  };
+const getAPI = (directory, swaggerFile, key) => {
+  const {
+    account,
+    name,
+    version,
+    provider,
+  } = swaggerFile;
+  const swaggerOptions = (spec) => ({
+    spec,
+    allowMetaPatches: false,
+    skipNormalization: true,
+    mode: 'strict',
+  });
 
   process.stdout.write('- getting API definition in (' + directory.info + ')');
-  try { fs.mkdirSync(directory); }
+  const apiFilename = path.join(directory, `${account}${SWAGGER_SEP}${name}${SWAGGER_SEP}${version}${SWAGGER_SEP}${POSTFIX}`);
+  let apiDefinition;
+
+  try {
+    if (fs.existsSync(apiFilename)) {
+      console.log(': ' + apiFilename.info + ' ' + 'already setup'.warn);
+      apiDefinition = fs.readFileSync(apiFilename, 'utf8');
+    }
+  }
   catch (err) {
-    if (err.code !== 'EEXIST') {
-      console.log(': ' + ERR_CHECK.error);
+    console.log(': ' + ERR_CHECK.error);
+    return Promise.reject(err);
+  }
+  if (apiDefinition) {
+    try { apiDefinition = json.parse(apiDefinition); }
+    catch (err) {
+      console.log(ERR_CHECK.error);
       return Promise.reject(err);
     }
-  }
-  const apiFilename = path.join(directory, `${account}${SWAGGER_SEP}${type}${SWAGGER_SEP}${version}${SWAGGER_SEP}${SWAGGER_EXT}`);
-
-  if (fileExists(apiFilename)) {
-    console.log(': ' + apiFilename.info + ' ' + 'already setup'.warn);
-    let apiDefinition;
-
-    try { apiDefinition = json.parse(fs.readFileSync(apiFilename).toString()); }
-    catch (errRead) { return Promise.reject(errRead); }
-    return SwaggerClient.resolve({
-      spec: apiDefinition,
-      allowMetaPatches: false,
-      skipNormalization: true,
-      mode: 'strict',
-    })
+    return SwaggerClient.resolve(swaggerOptions(apiDefinition))
+      .catch((err) => {
+        console.log(' ' + ERR_CHECK.error);
+        throw err;
+      })
       .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);
+        console.log(' ' + SUCCESS_CHECK.success);
         return apiDefinitionResult.spec;
       })
       .catch((err) => {
-        console.log(ERR_CHECK.error);
         const error = err;
 
         error.message = `${error.message} - { "apiFilename": "${apiFilename}" }`;
+        console.log(' ' + ERR_CHECK.error);
         throw error;
       });
   }
-  const url = `${API_PROVIDER}/${account}/${type}${API_SOURCE}/${version}/${SWAGGER}${EXTENSION}`;
-
-  process.stdout.write(' at (' + `${url}`.info + '): ');
-  const options = {
+  try {
+    if (!fs.existsSync(directory)) {
+      fs.mkdirSync(directory);
+    }
+  }
+  catch (err) {
+    console.log(': ' + ERR_CHECK.error);
+    return Promise.reject(err);
+  }
+  const prov = provider || BITBUCKET;
+  const opts = {
     method: 'GET',
-    url,
+    headers: {},
   };
 
-  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 {
+    switch (prov) {
+      case SWAGGERHUB: {
+        opts.url = `${API_PROVIDER_SWAGGERHUB}/${account}/${name}/${version}?${RESOLVED}`;
+        if (key[SWAGGERHUB]) opts.headers.Authorization = key[SWAGGERHUB];
+        break;
+      }
+      case BITBUCKET: {
+        if (!key[BITBUCKET] || !key[BITBUCKET].username || !key[BITBUCKET].password) {
+          throw new Error('missing username/password for accessing Bitbucket');
+        }
+        if (key[BITBUCKET].username === DEFAULT_BITBUCKET_USERNAME || key[BITBUCKET].password === DEFAULT_BITBUCKET_PASSWORD) {
+          throw new Error('missing username/password for accessing Bitbucket');
+        }
+        opts.headers.Authorization = `Basic ${Base64.encode(`${key[BITBUCKET].username}:${key[BITBUCKET].password}`)}`;
+        opts.url = `${API_PROVIDER_BITBUCKET}/${account}/${name}${API_SOURCE}/${version}/${SWAGGER}${EXTENSION_YML}`;
+        break;
+      }
+      default: {
+        throw new Error('invalid API provider');
+      }
+    }
   }
-  try { options.headers = { authorization: `Basic ${Base64.encode(`${basicAuth.username}:${basicAuth.password}`)}` }; }
   catch (err) {
-    console.log(ERR_CHECK.error);
+    console.log(': ' + ERR_CHECK.error);
     return Promise.reject(err);
   }
-  return rp(options)
-    .then((result) => SwaggerClient.resolve({
-      spec: yaml.load(result),
-      allowMetaPatches: false,
-      skipNormalization: true,
-      mode: 'strict',
-    }))
+  process.stdout.write(' at (' + `${opts.url}`.info + '): ');
+  return rp(opts)
+    .then((result) => {
+      let resultJSON = result;
+
+      if (typeof result !== 'object') resultJSON = yaml.load(result);
+      return SwaggerClient.resolve(swaggerOptions(resultJSON));
+    })
     .then((apiDefinitionResult) => {
       if (apiDefinitionResult.errors.length !== 0) {
-        throw new Error('Errors while resolving definition');
+        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}" }`;
+      console.log(ERR_CHECK.error);
       throw error;
     });
 };
@@ -354,7 +391,7 @@ const gettingSystemCustomer = (authorization, mSTbaseUrl) => {
   process.stdout.write('- getting customer (' + SYSTEM_NAME.info + '): ');
   return rp({
     method: 'GET',
-    headers: { authorization, 'x-correlation-id': correlationId },
+    headers: { authorization },
     url: `${mSTbaseUrl}/customers/${SYSTEM_NAME}`,
   })
     .then((responseGET) => {
@@ -374,7 +411,7 @@ const settingUpCustomer = (customer, authorization, mSTbaseUrl, update) => {
 
   return rp({
     method: 'GET',
-    headers: { authorization, 'x-correlation-id': correlationId },
+    headers: { authorization },
     url: `${mSTbaseUrl}/customers/${customer.name}`,
   })
     .catch((err) => {
@@ -387,7 +424,7 @@ const settingUpCustomer = (customer, authorization, mSTbaseUrl, update) => {
       console.log('creating new customer'.info);
       return rp({
         method: 'POST',
-        headers: { authorization, 'x-correlation-id': correlationId },
+        headers: { authorization },
         url: `${mSTbaseUrl}/customers`,
         data: customer,
       })
@@ -407,7 +444,7 @@ const settingUpCustomer = (customer, authorization, mSTbaseUrl, update) => {
       console.log('already setup and update is true in mSTConfig.json, updating'.info);
       return rp({
         method: 'PUT',
-        headers: { authorization, 'x-correlation-id': correlationId },
+        headers: { authorization },
         url: `${mSTbaseUrl}/customers/${customer.name}`,
         data: customer,
       })
@@ -427,7 +464,7 @@ const settingUpServer = (serverType, serverId, customer, authorization, mSTbaseU
   return rp({
     method: 'POST',
     url: `${mSTbaseUrl}/clients`,
-    headers: { authorization, 'x-correlation-id': correlationId },
+    headers: { authorization },
     data: {
       externalId: serverId,
       type: serverType,
@@ -486,7 +523,7 @@ const settingUpAdminClient = (serverType, adminExternalId, customer, authorizati
   return rp({
     method: 'POST',
     url: `${mSTbaseUrl}/clients`,
-    headers: { authorization, 'x-correlation-id': correlationId },
+    headers: { authorization },
     data: {
       externalId: adminExternalId,
       type: 'admin',
@@ -503,7 +540,7 @@ const settingUpAdminClient = (serverType, adminExternalId, customer, authorizati
     return rp({
       method: 'GET',
       url: `${mSTbaseUrl}/clients/${adminExternalId}`,
-      headers: { authorization, 'x-correlation-id': correlationId },
+      headers: { authorization },
     }).catch((errGET) => {
       console.log(ERR_CHECK.error);
       throw errGET;
@@ -526,7 +563,6 @@ const getAdminToken = (audienceType, admin, mSTbaseUrl) => {
   }
   return rp({
     method: 'POST',
-    headers: { 'x-correlation-id': correlationId },
     url: `${mSTbaseUrl}/oauth/token`,
     data: {
       client_id: admin.id,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mimik/local",
-  "version": "5.2.2",
+  "version": "6.0.0",
   "description": "Local setup configuration for normal and test opreration",
   "main": "index.js",
   "scripts": {
@@ -32,13 +32,13 @@
     "@mimik/eslint-plugin-dependencies": "^2.4.5",
     "@mimik/eslint-plugin-document-env": "^1.0.5",
     "@mimik/git-hooks": "^1.5.7",
-    "axios": "1.3.5",
+    "axios": "1.3.6",
     "bluebird": "3.7.2",
     "chai": "4.3.7",
     "colors": "1.4.0",
     "comment-json": "4.2.3",
     "debug": "4.3.4",
-    "eslint": "8.38.0",
+    "eslint": "8.39.0",
     "eslint-config-airbnb": "19.0.4",
     "eslint-plugin-import": "2.27.5",
     "eslint-plugin-jsx-a11y": "6.7.1",
@@ -54,7 +54,7 @@
     "mochawesome": "7.1.3",
     "nyc": "15.1.0",
     "rewire": "6.0.0",
-    "sinon": "15.0.3",
+    "sinon": "15.0.4",
     "supertest": "6.3.3",
     "swagger-client": "3.19.6",
     "uuid": "9.0.0"