@axway/axway-central-cli 2.18.0 → 2.19.0-rc.0

package/dist/commands/install/agents.js

@@ -17,6 +17,7 @@ var _types = require("../../common/types");
 var _utils = require("../../common/utils");
 var awsAgents = _interopRequireWildcard(require("./awsAgents"));
 var gitHubAgents = _interopRequireWildcard(require("./gitHubSaasAgents"));
+var gitLabAgents = _interopRequireWildcard(require("./gitLabAgents"));
 var azureAgents = _interopRequireWildcard(require("./azureAgents"));
 var edgeAgents = _interopRequireWildcard(require("./edgeAgents"));
 var apigeeSaaSAgents = _interopRequireWildcard(require("./apigeexSaasAgents"));
@@ -40,6 +41,7 @@ const agentInstallFlows = {
   [_types.GatewayTypes.EDGE_GATEWAY_ONLY]: edgeAgents.EdgeGWOnlyInstallMethods,
   [_types.GatewayTypes.AWS_GATEWAY]: awsAgents.AWSInstallMethods,
   [_types.GatewayTypes.GITHUB]: gitHubAgents.GitHubSaaSInstallMethods,
+  [_types.GatewayTypes.GITLAB]: gitLabAgents.GitLabInstallMethods,
   [_types.GatewayTypes.APIGEEX_GATEWAY]: apigeeSaaSAgents.APIGEEXSaaSInstallMethods,
   [_types.GatewayTypes.AZURE_GATEWAY]: azureAgents.AzureInstallMethods,
   [_types.GatewayTypes.ISTIO]: istioAgents.IstioInstallMethods

package/dist/commands/install/gitLabAgents.js

@@ -0,0 +1,174 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.testables = exports.installPreprocess = exports.gitLabPrompts = exports.gatewayConnectivity = exports.completeInstall = exports.askConfigType = exports.askBundleType = exports.GitLabInstallMethods = exports.ConfigFiles = void 0;
+var _chalk = _interopRequireDefault(require("chalk"));
+var _snooplogg = _interopRequireDefault(require("snooplogg"));
+var _basicPrompts = require("../../common/basicPrompts");
+var _types = require("../../common/types");
+var _utils = require("../../common/utils");
+var helpers = _interopRequireWildcard(require("./helpers"));
+var _gitLabTemplates = require("./helpers/templates/gitLabTemplates");
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+// @ts-ignore
+const {
+  log
+} = (0, _snooplogg.default)('central: install: agents: gitLab:');
+const daImage = `${_types.PublicDockerRepoBaseUrl}${_types.BasePaths.DockerAgentPublicRepo}/${_types.AgentNames.GITLAB_DA}`;
+
+// ConfigFiles - all the config file that are used in the setup
+const ConfigFiles = exports.ConfigFiles = {
+  DAEnvVars: `${helpers.configFiles.DA_ENV_VARS}`
+};
+const gitLabPrompts = exports.gitLabPrompts = {
+  ACCESS_TOKEN: 'Enter the GitLab Access Token the agent will use',
+  BASE_URL: 'Enter the GitLab base URL that the agent will use',
+  REPOSITORY_ID: 'Enter the GitLab Repository ID the agent will use',
+  REPOSITORY_BRANCH: 'Enter the Repository Branch the agent will use',
+  PATHS: 'Enter a Path within the repository that the agent will use',
+  FILTERS: 'Enter a filter that the agent will use (Optional)',
+  DA_FREQUENCY: 'How often should the discovery run, leave blank for integrating in CI/CD process',
+  QUEUE: 'Do you want to discover immediately after installation',
+  ENTER_MORE_PATHS: 'Do you want to enter another path ?',
+  ENTER_MORE_FILTERS: 'Do you want to enter another filter ?'
+};
+const askBundleType = async () => {
+  return _types.BundleType.DISCOVERY;
+};
+exports.askBundleType = askBundleType;
+const askConfigType = async () => {
+  return _types.AgentConfigTypes.DOCKERIZED;
+};
+
+// Questions for the gitLab configuration
+exports.askConfigType = askConfigType;
+const askForGitLabToken = async () => await (0, _basicPrompts.askInput)({
+  msg: gitLabPrompts.ACCESS_TOKEN,
+  validate: (0, _basicPrompts.validateRegex)(helpers.GitLabRegexPatterns.gitLabAccessTokenRegex, helpers.invalidValueExampleErrMsg('AccessToken', 'mockToken'))
+});
+const askForGitLabBaseURL = async () => await (0, _basicPrompts.askInput)({
+  msg: gitLabPrompts.BASE_URL
+});
+const askForGitLabRepositoryID = async () => await (0, _basicPrompts.askInput)({
+  msg: gitLabPrompts.REPOSITORY_ID,
+  validate: (0, _basicPrompts.validateRegex)(helpers.GitLabRegexPatterns.gitHubRepositoryIDRegex, helpers.invalidValueExampleErrMsg('RepositoryID', '12312'))
+});
+const askForGitLabRepositoryBranch = async () => await (0, _basicPrompts.askInput)({
+  msg: gitLabPrompts.REPOSITORY_BRANCH
+});
+const askForGitLabPaths = async () => {
+  let askPaths = true;
+  let paths = [];
+  console.log(_chalk.default.gray("An array of paths within the repository that the agent will gather files for looking for specs"));
+  while (askPaths) {
+    const path = await (0, _basicPrompts.askInput)({
+      msg: gitLabPrompts.PATHS,
+      allowEmptyInput: false,
+      validate: (0, _basicPrompts.validateRegex)(helpers.GitLabRegexPatterns.gitLabPathRegex, helpers.invalidValueExampleErrMsg('File Path', '/apis'))
+    });
+    paths.push(path);
+    askPaths = (await (0, _basicPrompts.askList)({
+      msg: gitLabPrompts.ENTER_MORE_PATHS,
+      default: _types.YesNo.No,
+      choices: _types.YesNoChoices
+    })) === _types.YesNo.Yes;
+  }
+  return paths;
+};
+const askForGitLabFilters = async () => {
+  let askFilters = true;
+  let filters = [];
+  console.log(_chalk.default.gray("An array of regular expressions that a file name must match to be discovered"));
+  while (askFilters) {
+    const filter = await (0, _basicPrompts.askInput)({
+      msg: gitLabPrompts.FILTERS,
+      allowEmptyInput: true
+    });
+    filters.push(filter);
+    askFilters = (await (0, _basicPrompts.askList)({
+      msg: gitLabPrompts.ENTER_MORE_FILTERS,
+      default: _types.YesNo.No,
+      choices: _types.YesNoChoices
+    })) === _types.YesNo.Yes;
+  }
+  return filters;
+};
+const gatewayConnectivity = async installConfig => {
+  let gitLabAgentValues = new _gitLabTemplates.GitLabAgentValues();
+  if (installConfig.switches.isDockerInstall) {
+    console.log('\nCONNECTION TO GitHub API GATEWAY:');
+    console.log(_chalk.default.gray("The Discovery Agent needs to connect to the GitHub API Gateway to discover API's for publishing to Amplify Central"));
+    gitLabAgentValues.token = await askForGitLabToken();
+    gitLabAgentValues.baseURL = await askForGitLabBaseURL();
+    gitLabAgentValues.repositoryID = await askForGitLabRepositoryID();
+    gitLabAgentValues.repositoryBranch = await askForGitLabRepositoryBranch();
+    gitLabAgentValues.paths = await askForGitLabPaths();
+    gitLabAgentValues.filters = await askForGitLabFilters();
+  }
+  return gitLabAgentValues;
+};
+exports.gatewayConnectivity = gatewayConnectivity;
+const dockerSuccessMsg = installConfig => {
+  let dockerInfo;
+  const runDaLinuxMsg = `docker run -it --env-file ${helpers.pwd}/${helpers.configFiles.DA_ENV_VARS} -v ${helpers.pwd}:/keys ${helpers.eolChar}`;
+  const runDaWinMsg = `docker run -it --env-file ${helpers.pwdWin}/${helpers.configFiles.DA_ENV_VARS} -v ${helpers.pwdWin}:/keys ${helpers.eolCharWin}`;
+  const startDaLinuxMsg = `\nStart the Discovery Agent on a Linux based machine`;
+  const startDaWinMsg = `\nStart the Discovery Agent on a Windows machine`;
+  if (installConfig.switches.isDaEnabled) {
+    dockerInfo = `To utilize the discovery agent, pull the latest Docker image and run it using the supplied environment file, (${helpers.configFiles.DA_ENV_VARS}):`;
+  }
+  console.log(_chalk.default.whiteBright(dockerInfo), '\n');
+  if (installConfig.switches.isDaEnabled) {
+    const daImageVersion = `${daImage}:${installConfig.daVersion}`;
+    console.log(_chalk.default.white('Pull the latest image of the Discovery Agent:'));
+    console.log(_chalk.default.cyan(`docker pull ${daImageVersion}`));
+    console.log(_chalk.default.white(_utils.isWindows ? startDaWinMsg : startDaLinuxMsg));
+    console.log(_chalk.default.cyan(_utils.isWindows ? runDaWinMsg : runDaLinuxMsg));
+    console.log('\t', _chalk.default.cyan(`-v /data ${daImageVersion}`));
+  }
+};
+const generateSuccessHelpMsg = installConfig => {
+  const configType = installConfig.deploymentType;
+  if (configType === _types.AgentConfigTypes.DOCKERIZED) {
+    dockerSuccessMsg(installConfig);
+  }
+};
+const installPreprocess = async installConfig => {
+  return installConfig;
+};
+exports.installPreprocess = installPreprocess;
+const completeInstall = async installConfig => {
+  /**
+  * Create agent resources
+  */
+  const gitLabAgentValues = installConfig.gatewayConfig;
+
+  // Add final settings to gitLabAgentValues
+  gitLabAgentValues.centralConfig = installConfig.centralConfig;
+  gitLabAgentValues.daVersion = installConfig.daVersion;
+  if (installConfig.switches.isDockerInstall) {
+    if (installConfig.switches.isDaEnabled) {
+      (0, _utils.writeTemplates)(ConfigFiles.DAEnvVars, gitLabAgentValues, helpers.gitLabDAEnvVarTemplate);
+    }
+  }
+  console.log('Configuration file(s) have been successfully created.\n');
+  generateSuccessHelpMsg(installConfig);
+};
+exports.completeInstall = completeInstall;
+const GitLabInstallMethods = exports.GitLabInstallMethods = {
+  GetBundleType: askBundleType,
+  GetDeploymentType: askConfigType,
+  AskGatewayQuestions: gatewayConnectivity,
+  InstallPreprocess: installPreprocess,
+  FinalizeGatewayInstall: completeInstall,
+  ConfigFiles: Object.values(ConfigFiles),
+  GatewayDisplay: _types.GatewayTypes.GITLAB
+};
+const testables = exports.testables = {
+  gitLabPrompts,
+  ConfigFiles
+};

package/dist/commands/install/helpers/index.js

@@ -128,6 +128,18 @@ Object.keys(_istioTemplates).forEach(function (key) {
     }
   });
 });
+var _gitLabTemplates = require("./templates/gitLabTemplates");
+Object.keys(_gitLabTemplates).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _gitLabTemplates[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _gitLabTemplates[key];
+    }
+  });
+});
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 const streamPipeline = exports.streamPipeline = _util.default.promisify(_stream.default.pipeline);
 const unzip = async filePath => {

package/dist/commands/install/helpers/regex.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.resourceRegex = exports.percentageRegex = exports.namespaceRegex = exports.maskingRegex = exports.invalidResourceMsg = exports.invalidPercentage = exports.invalidNamespace = exports.invalidDosaName = exports.invalidDomainName = exports.frequencyRegex = exports.dosaRegex = exports.domainNameRegex = exports.GitHubRegexPatterns = exports.AzureRegexPatterns = exports.AWSRegexPatterns = exports.APIGEEXRegexPatterns = void 0;
+exports.resourceRegex = exports.percentageRegex = exports.namespaceRegex = exports.maskingRegex = exports.invalidResourceMsg = exports.invalidPercentage = exports.invalidNamespace = exports.invalidDosaName = exports.invalidDomainName = exports.frequencyRegex = exports.dosaRegex = exports.domainNameRegex = exports.GitLabRegexPatterns = exports.GitHubRegexPatterns = exports.AzureRegexPatterns = exports.AWSRegexPatterns = exports.APIGEEXRegexPatterns = void 0;
 const resourceRegex = exports.resourceRegex = '^(?:[a-z0-9]*(?:\\.(?=[a-z0-9])|-+(?=[a-z0-9]))?)+[a-z0-9]$';
 const namespaceRegex = exports.namespaceRegex = '^[a-z0-9]?(?:[-a-z0-9]*[a-z0-9]){1,100}?$';
 const domainNameRegex = exports.domainNameRegex = '^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])\\.)+([A-Za-z]){2,}$';
@@ -51,4 +51,9 @@ const GitHubRegexPatterns = exports.GitHubRegexPatterns = {
   gitHubRepositoryOwnerRegex: '^(?!-)(?!.*--)[a-zA-Z0-9-]{1,37}(?<!-)$',
   gitHubRepositoryNameRegex: '^[\w-\.]+$',
   gitHubFilePathRegex: '^\/.*$'
+};
+const GitLabRegexPatterns = exports.GitLabRegexPatterns = {
+  gitLabAccessTokenRegex: '^[0-9a-zA-Z\-]{20}$',
+  gitHubRepositoryIDRegex: '^[0-9]*$',
+  gitLabPathRegex: '^\/.*$'
 };

package/dist/commands/install/helpers/templates/gitLabTemplates.js

@@ -0,0 +1,69 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.gitLabDAEnvVarTemplate = exports.GitLabAgentValues = void 0;
+var _types = require("../../../../common/types");
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return typeof key === "symbol" ? key : String(key); }
+function _toPrimitive(input, hint) { if (typeof input !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (typeof res !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); } /**
+                                                                                                                                                                                                                                                                                                                                                                                           * @description Values to provide to the gitLab templates.
+                                                                                                                                                                                                                                                                                                                                                                                           */
+class GitLabAgentValues {
+  constructor() {
+    _defineProperty(this, "token", void 0);
+    _defineProperty(this, "baseURL", void 0);
+    _defineProperty(this, "repositoryID", void 0);
+    _defineProperty(this, "repositoryBranch", void 0);
+    _defineProperty(this, "paths", void 0);
+    _defineProperty(this, "filters", void 0);
+    _defineProperty(this, "daQueueName", void 0);
+    _defineProperty(this, "daVersion", void 0);
+    _defineProperty(this, "centralConfig", void 0);
+    this.token = '';
+    this.baseURL = '';
+    this.repositoryID = '';
+    this.repositoryBranch = '';
+    this.daQueueName = '';
+    this.daVersion = '';
+    this.paths = [];
+    this.filters = [];
+    this.centralConfig = new _types.CentralAgentConfig();
+  }
+}
+exports.GitLabAgentValues = GitLabAgentValues;
+const gitLabDAEnvVarTemplate = () => {
+  return `# GitLab configs
+GITLAB_TOKEN={{token}}
+GITLAB_BASE_URL={{baseURL}}
+GITLAB_REPOSITORY_ID={{repositoryID}}
+GITLAB_REPOSITORY_BRANCH={{repositoryBranch}}
+GITLAB_PATHS={{paths}}
+GITLAB_FILTERS={{filters}}
+
+# Amplify Central configs
+CENTRAL_AGENTNAME={{centralConfig.daAgentName}}
+CENTRAL_AUTH_CLIENTID={{centralConfig.dosaAccount.clientId}}
+CENTRAL_AUTH_PRIVATEKEY={{centralConfig.dosaAccount.templatePrivateKey}}
+CENTRAL_AUTH_PUBLICKEY={{centralConfig.dosaAccount.templatePublicKey}}
+CENTRAL_ENVIRONMENT={{centralConfig.environment}}
+CENTRAL_ORGANIZATIONID={{centralConfig.orgId}}
+{{#compare . centralConfig.ampcTeamName "" operator="!=" }}
+CENTRAL_TEAM={{centralConfig.ampcTeamName}}
+{{/compare}}
+CENTRAL_SINGLEURL={{centralConfig.singleEntryPointUrl}}
+{{#compare . centralConfig.region "US" operator="!="}}
+CENTRAL_URL={{centralConfig.url}}
+{{/compare}}
+
+# Logging configs
+# Define the logging level: info, debug, error
+LOG_LEVEL=info
+# Specify where to send the log: stdout, file, both
+LOG_OUTPUT=stdout
+# Define where the log files are written
+LOG_FILE_PATH=logs
+`;
+};
+exports.gitLabDAEnvVarTemplate = gitLabDAEnvVarTemplate;

package/dist/common/types.js

@@ -215,6 +215,7 @@ let AgentNames = exports.AgentNames = /*#__PURE__*/function (AgentNames) {
   AgentNames["AWS_DA"] = "aws-apigw-discovery-agent";
   AgentNames["AWS_TA"] = "aws-apigw-traceability-agent";
   AgentNames["GITHUB_DA"] = "github-discovery-agent";
+  AgentNames["GITLAB_DA"] = "gitlab-discovery-agent";
   AgentNames["APIGEEX_DA"] = "apigee-discovery-agent";
   AgentNames["APIGEEX_TA"] = "apigee-traceability-agent";
   AgentNames["AZURE_DA"] = "azure-discovery-agent";
@@ -229,6 +230,7 @@ let GatewayTypes = exports.GatewayTypes = /*#__PURE__*/function (GatewayTypes) {
   GatewayTypes["APIGEEX_GATEWAY"] = "Apigee X Gateway";
   GatewayTypes["AZURE_GATEWAY"] = "Azure API Gateway";
   GatewayTypes["GITHUB"] = "GitHub";
+  GatewayTypes["GITLAB"] = "GitLab";
   GatewayTypes["ISTIO"] = "Istio";
   GatewayTypes["EDGE_GATEWAY_ONLY"] = "Amplify API Gateway only";
   return GatewayTypes;
@@ -243,6 +245,7 @@ let DataPlaneNames = exports.DataPlaneNames = /*#__PURE__*/function (DataPlaneNa
   DataPlaneNames["APIGEE"] = "Apigee";
   DataPlaneNames["AWS"] = "AWS";
   DataPlaneNames["GITHUB"] = "GitHub";
+  DataPlaneNames["GITLAB"] = "GitLab";
   DataPlaneNames["AZURE"] = "Azure";
   DataPlaneNames["EDGE"] = "Edge";
   DataPlaneNames["KONG"] = "Kong";
@@ -256,6 +259,7 @@ const GatewayTypeToDataPlane = exports.GatewayTypeToDataPlane = {
   [GatewayTypes.EDGE_GATEWAY_ONLY]: DataPlaneNames.EDGE,
   [GatewayTypes.AWS_GATEWAY]: DataPlaneNames.AWS,
   [GatewayTypes.GITHUB]: DataPlaneNames.GITHUB,
+  [GatewayTypes.GITLAB]: DataPlaneNames.GITLAB,
   [GatewayTypes.AZURE_GATEWAY]: DataPlaneNames.AZURE,
   [GatewayTypes.ISTIO]: 'Istio',
   [GatewayTypes.APIGEEX_GATEWAY]: DataPlaneNames.APIGEE

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@axway/axway-central-cli",
-	"version": "2.18.0",
+	"version": "2.19.0-rc.0",
 	"description": "Manage APIs, services and publish to the Unified Catalog",
 	"homepage": "https://platform.axway.com",
 	"author": {