feat(cli): add agents-settings-list-agents command and centralize command config

Author: liranfarage89

node/src/commands/agents-settings-list-agents.js

@@ -0,0 +1,19 @@
+const Env0ApiClient = require('../lib/api-client');
+const logger = require('../lib/logger');
+const { options } = require('../config/constants');
+
+const { API_KEY, API_SECRET, ORGANIZATION_ID } = options;
+
+const agentsSettingsListAgents = async options => {
+  const apiClient = new Env0ApiClient();
+
+  await apiClient.init(options[API_KEY], options[API_SECRET]);
+
+  const result = await apiClient.callApi('get', 'agents', {
+    params: { organizationId: options[ORGANIZATION_ID] }
+  });
+
+  logger.info(JSON.stringify(result, null, 2));
+};
+
+module.exports = agentsSettingsListAgents;

node/src/commands/run-command.js

@@ -1,18 +1,17 @@
 const DeployUtils = require('../lib/deploy-utils');
 const configManager = require('../lib/config-manager');
-const deploy = require('./deploy');
-const destroy = require('./destroy');
-const approve = require('./approve');
-const cancel = require('./cancel');
+const { commands } = require('../config/commands');
 const { options } = require('../config/constants');
 const logger = require('../lib/logger');
 const _ = require('lodash');
 const { argumentsMap } = require('../config/arguments');
 
 const { API_KEY, API_SECRET, ORGANIZATION_ID, PROJECT_ID, ENVIRONMENT_NAME, REQUIRES_APPROVAL } = options;
 
-const assertRequiredOptions = options => {
-  const requiredOptions = [API_KEY, API_SECRET, ORGANIZATION_ID, PROJECT_ID, ENVIRONMENT_NAME];
+const assertRequiredOptions = (command, options) => {
+  const defaultRequiredOptions = [API_KEY, API_SECRET, ORGANIZATION_ID, PROJECT_ID, ENVIRONMENT_NAME];
+  const commandConfig = commands[command] || {};
+  const requiredOptions = commandConfig.requiredOptions || defaultRequiredOptions;
 
   let missingOptions = [];
   requiredOptions.forEach(opt => !Object.keys(options).includes(opt) && missingOptions.push(opt));
@@ -34,24 +33,21 @@ const assertRequiresApprovalOption = requiresApproval => {
 
 const runCommand = async (command, options, variables) => {
   options = configManager.read(options);
-  assertRequiredOptions(options);
+  assertRequiredOptions(command, options);
   assertRequiresApprovalOption(options[REQUIRES_APPROVAL]);
 
   logger.setSecrets(options);
 
   logger.info(`Running ${command} with the following arguments:`);
   Object.keys(options).forEach(opt => logger.info(`$ ${opt}: ${options[opt]}`));
 
-  const commands = {
-    destroy: destroy,
-    deploy: deploy,
-    approve: approve,
-    cancel: cancel
-  };
+  const commandConfig = commands[command];
 
-  await DeployUtils.init(options);
+  if (commandConfig && commandConfig.useDeployUtils) {
+    await DeployUtils.init(options);
+  }
 
-  await commands[command](options, variables);
+  await commandConfig.handler(options, variables);
   logger.info(`Command ${command} has finished successfully.`);
 };
 

node/src/config/arguments.js

@@ -26,7 +26,7 @@ const argumentsMap = {
     description: 'env0 API Key',
     prompt: 'env0 API Key',
     secret: true,
-    group: ['deploy', 'destroy', 'approve', 'cancel', 'configure']
+    group: ['deploy', 'destroy', 'approve', 'cancel', 'configure', 'agents-settings-list-agents']
   },
   [API_SECRET]: {
     name: API_SECRET,
@@ -35,15 +35,15 @@ const argumentsMap = {
     description: 'env0 API Secret',
     prompt: 'env0 API Secret',
     secret: true,
-    group: ['deploy', 'destroy', 'approve', 'cancel', 'configure']
+    group: ['deploy', 'destroy', 'approve', 'cancel', 'configure', 'agents-settings-list-agents']
   },
   [ORGANIZATION_ID]: {
     name: ORGANIZATION_ID,
     alias: 'o',
     type: String,
     description: 'env0 Organization ID',
     prompt: 'Organization ID',
-    group: ['deploy', 'destroy', 'approve', 'cancel', 'configure']
+    group: ['deploy', 'destroy', 'approve', 'cancel', 'configure', 'agents-settings-list-agents']
   },
   [PROJECT_ID]: {
     name: PROJECT_ID,

node/src/config/commands.js

@@ -1,10 +1,21 @@
 const { argumentsMap, allArguments, baseArguments } = require('./arguments');
 const { options } = require('./constants');
+const deploy = require('../commands/deploy');
+const destroy = require('../commands/destroy');
+const approve = require('../commands/approve');
+const cancel = require('../commands/cancel');
+const agentsSettingsListAgents = require('../commands/agents-settings-list-agents');
 
 const { API_KEY, API_SECRET, ORGANIZATION_ID, PROJECT_ID, ENVIRONMENT_NAME, BLUEPRINT_ID, SKIP_STATE_REFRESH, REQUIRES_APPROVAL } = options;
 
+const BASE_REQUIRED_OPTIONS = [API_KEY, API_SECRET, ORGANIZATION_ID, PROJECT_ID, ENVIRONMENT_NAME];
+const ORG_REQUIRED_OPTIONS = [API_KEY, API_SECRET, ORGANIZATION_ID];
+
 const commands = {
   deploy: {
+    handler: deploy,
+    requiredOptions: BASE_REQUIRED_OPTIONS,
+    useDeployUtils: true,
     options: allArguments,
     help: [
       {
@@ -14,6 +25,9 @@ const commands = {
     ]
   },
   destroy: {
+    handler: destroy,
+    requiredOptions: BASE_REQUIRED_OPTIONS,
+    useDeployUtils: true,
     options: [...baseArguments, argumentsMap[REQUIRES_APPROVAL], argumentsMap[SKIP_STATE_REFRESH]],
     help: [
       {
@@ -23,6 +37,9 @@ const commands = {
     ]
   },
   approve: {
+    handler: approve,
+    requiredOptions: BASE_REQUIRED_OPTIONS,
+    useDeployUtils: true,
     options: baseArguments,
     help: [
       {
@@ -32,6 +49,9 @@ const commands = {
     ]
   },
   cancel: {
+    handler: cancel,
+    requiredOptions: BASE_REQUIRED_OPTIONS,
+    useDeployUtils: true,
     options: baseArguments,
     help: [
       {
@@ -40,6 +60,18 @@ const commands = {
       }
     ]
   },
+  'agents-settings-list-agents': {
+    handler: agentsSettingsListAgents,
+    requiredOptions: ORG_REQUIRED_OPTIONS,
+    useDeployUtils: false,
+    options: baseArguments,
+    help: [
+      {
+        desc: 'Lists organization agents',
+        example: `$ env0 agents-settings-list-agents -k <${API_KEY}> -s <${API_SECRET}> -o <${ORGANIZATION_ID}>\n`
+      }
+    ]
+  },
   configure: {
     options: [...baseArguments, argumentsMap[BLUEPRINT_ID]],
     help: [