fix(environmentId): make environmentId a common arg fixes #457 (#458)

thoughtassassin · web-flow · commit ab85b41a902e · 2021-08-28T09:33:40.000-04:00
diff --git a/src/commands/cloudmanager/commerce/bin-magento/indexer/reindex.js b/src/commands/cloudmanager/commerce/bin-magento/indexer/reindex.js
@@ -13,6 +13,7 @@ governing permissions and limitations under the License.
 const BaseCommerceCliCommand = require('../../../../../base-commerce-cli-command')
 const { getProgramId } = require('../../../../../cloudmanager-helpers')
 const commonFlags = require('../../../../../common-flags')
+const commonArgs = require('../../../../../common-args')
 
 class IndexerReindexCommand extends BaseCommerceCliCommand {
   async run () {
@@ -39,7 +40,7 @@ IndexerReindexCommand.flags = {
 }
 
 IndexerReindexCommand.args = [
-  { name: 'environmentId', required: true, description: 'the environment id' },
+  commonArgs.environmentId,
 ]
 
 IndexerReindexCommand.aliases = [
diff --git a/src/commands/cloudmanager/commerce/bin-magento/maintenance/status.js b/src/commands/cloudmanager/commerce/bin-magento/maintenance/status.js
@@ -13,6 +13,7 @@ governing permissions and limitations under the License.
 const BaseCommerceCliCommand = require('../../../../../base-commerce-cli-command')
 const { getProgramId } = require('../../../../../cloudmanager-helpers')
 const commonFlags = require('../../../../../common-flags')
+const commonArgs = require('../../../../../common-args')
 
 class MaintenanceStatusCommand extends BaseCommerceCliCommand {
   async run () {
@@ -39,7 +40,7 @@ MaintenanceStatusCommand.flags = {
 }
 
 MaintenanceStatusCommand.args = [
-  { name: 'environmentId', required: true, description: 'the environment id' },
+  commonArgs.environmentId,
 ]
 
 MaintenanceStatusCommand.aliases = [
diff --git a/src/commands/cloudmanager/commerce/get-command-execution.js b/src/commands/cloudmanager/commerce/get-command-execution.js
@@ -14,6 +14,7 @@ const BaseCommand = require('../../../base-command')
 const { initSdk, formatTime, getProgramId } = require('../../../cloudmanager-helpers')
 const { cli } = require('cli-ux')
 const commonFlags = require('../../../common-flags')
+const commonArgs = require('../../../common-args')
 
 class GetCommandExecutionCommand extends BaseCommand {
   async run () {
@@ -76,7 +77,7 @@ GetCommandExecutionCommand.flags = {
 }
 
 GetCommandExecutionCommand.args = [
-  { name: 'environmentId', required: true, description: 'the environment id' },
+  commonArgs.environmentId,
   { name: 'commandExecutionId', required: true, description: 'the command execution id' },
 ]
 
diff --git a/src/commands/cloudmanager/commerce/list-command-executions.js b/src/commands/cloudmanager/commerce/list-command-executions.js
@@ -19,6 +19,7 @@ const {
 const { cli } = require('cli-ux')
 const { flags } = require('@oclif/command')
 const commonFlags = require('../../../common-flags')
+const commonArgs = require('../../../common-args')
 
 class ListCommandExecutionsCommand extends BaseCommand {
   async run () {
@@ -128,7 +129,7 @@ ListCommandExecutionsCommand.flags = {
 }
 
 ListCommandExecutionsCommand.args = [
-  { name: 'environmentId', required: true, description: 'the environment id' },
+  commonArgs.environmentId,
 ]
 
 module.exports = ListCommandExecutionsCommand
diff --git a/src/commands/cloudmanager/environment/bind-ip-allowlist.js b/src/commands/cloudmanager/environment/bind-ip-allowlist.js
@@ -36,7 +36,7 @@ class BindIPAllowlist extends BaseCommand {
 BindIPAllowlist.description = 'Bind an IP Allowlist to an environment'
 
 BindIPAllowlist.args = [
-  { name: 'environmentId', required: true, description: 'the environment id' },
+  commonArgs.environmentId,
   { name: 'ipAllowlistId', required: true, description: 'the IP allowlist id' },
   commonArgs.service,
 ]
diff --git a/src/commands/cloudmanager/environment/delete.js b/src/commands/cloudmanager/environment/delete.js
@@ -13,6 +13,7 @@ governing permissions and limitations under the License.
 const { initSdk, getProgramId, sanitizeEnvironmentId } = require('../../../cloudmanager-helpers')
 const { cli } = require('cli-ux')
 const commonFlags = require('../../../common-flags')
+const commonArgs = require('../../../common-args')
 const BaseCommand = require('../../../base-command')
 
 class DeleteEnvironmentCommand extends BaseCommand {
@@ -46,7 +47,7 @@ DeleteEnvironmentCommand.flags = {
 }
 
 DeleteEnvironmentCommand.args = [
-  { name: 'environmentId', required: true, description: 'the environment id' },
+  commonArgs.environmentId,
 ]
 
 DeleteEnvironmentCommand.aliases = [
diff --git a/src/commands/cloudmanager/environment/download-logs.js b/src/commands/cloudmanager/environment/download-logs.js
@@ -15,6 +15,7 @@ const { initSdk, getProgramId, sanitizeEnvironmentId } = require('../../../cloud
 const { cli } = require('cli-ux')
 const path = require('path')
 const commonFlags = require('../../../common-flags')
+const commonArgs = require('../../../common-args')
 const BaseCommand = require('../../../base-command')
 
 class DownloadLogs extends BaseCommand {
@@ -57,7 +58,7 @@ class DownloadLogs extends BaseCommand {
 DownloadLogs.description = 'downloads log files for the specified environment, service and log name for one or more days'
 
 DownloadLogs.args = [
-  { name: 'environmentId', required: true, description: 'the environment id' },
+  commonArgs.environmentId,
   { name: 'service', required: true, description: 'the service' },
   { name: 'name', required: true, description: 'the log name' },
   { name: 'days', required: false, description: 'the number of days', default: '1' },
diff --git a/src/commands/cloudmanager/environment/list-available-log-options.js b/src/commands/cloudmanager/environment/list-available-log-options.js
@@ -13,6 +13,7 @@ governing permissions and limitations under the License.
 const { initSdk, getProgramId, sanitizeEnvironmentId, getOutputFormat } = require('../../../cloudmanager-helpers')
 const { cli } = require('cli-ux')
 const commonFlags = require('../../../common-flags')
+const commonArgs = require('../../../common-args')
 const BaseCommand = require('../../../base-command')
 
 class ListAvailableLogOptionsCommand extends BaseCommand {
@@ -53,7 +54,7 @@ class ListAvailableLogOptionsCommand extends BaseCommand {
 ListAvailableLogOptionsCommand.description = 'lists available log options for an environment in a Cloud Manager program'
 
 ListAvailableLogOptionsCommand.args = [
-  { name: 'environmentId', required: true, description: 'the environment id' },
+  commonArgs.environmentId,
 ]
 
 ListAvailableLogOptionsCommand.flags = {
diff --git a/src/commands/cloudmanager/environment/list-ip-allowlist-bindings.js b/src/commands/cloudmanager/environment/list-ip-allowlist-bindings.js
@@ -14,6 +14,7 @@ const { getProgramId, getOutputFormat, columnWithArray } = require('../../../clo
 const { cli } = require('cli-ux')
 const _ = require('lodash')
 const commonFlags = require('../../../common-flags')
+const commonArgs = require('../../../common-args')
 const ListIpAllowlists = require('../program/list-ip-allowlists')
 const BaseCommand = require('../../../base-command')
 
@@ -55,7 +56,7 @@ class ListIPAllowlistBindings extends BaseCommand {
 ListIPAllowlistBindings.description = 'lists IP Allowlists bound to an environment'
 
 ListIPAllowlistBindings.args = [
-  { name: 'environmentId', required: true, description: 'the environment id' },
+  commonArgs.environmentId,
 ]
 
 ListIPAllowlistBindings.flags = {
diff --git a/src/commands/cloudmanager/environment/list-variables.js b/src/commands/cloudmanager/environment/list-variables.js
@@ -14,6 +14,7 @@ const BaseEnvironmentVariablesCommand = require('../../../base-environment-varia
 const BaseVariablesCommand = require('../../../base-variables-command')
 const { getProgramId } = require('../../../cloudmanager-helpers')
 const commonFlags = require('../../../common-flags')
+const commonArgs = require('../../../common-args')
 
 class ListEnvironmentVariablesCommand extends BaseEnvironmentVariablesCommand {
   async run () {
@@ -32,7 +33,7 @@ class ListEnvironmentVariablesCommand extends BaseEnvironmentVariablesCommand {
 ListEnvironmentVariablesCommand.description = 'lists variables set on an environment'
 
 ListEnvironmentVariablesCommand.args = [
-  { name: 'environmentId', required: true, description: 'the environment id' },
+  commonArgs.environmentId,
 ]
 
 ListEnvironmentVariablesCommand.flags = {
diff --git a/src/commands/cloudmanager/environment/open-developer-console.js b/src/commands/cloudmanager/environment/open-developer-console.js
@@ -13,6 +13,7 @@ governing permissions and limitations under the License.
 const { initSdk, getProgramId, sanitizeEnvironmentId } = require('../../../cloudmanager-helpers')
 const { cli } = require('cli-ux')
 const commonFlags = require('../../../common-flags')
+const commonArgs = require('../../../common-args')
 const BaseCommand = require('../../../base-command')
 
 class OpenDeveloperConsoleCommand extends BaseCommand {
@@ -39,7 +40,7 @@ class OpenDeveloperConsoleCommand extends BaseCommand {
 OpenDeveloperConsoleCommand.description = 'opens the Developer Console, if available, in a browser'
 
 OpenDeveloperConsoleCommand.args = [
-  { name: 'environmentId', required: true, description: 'the environment id' },
+  commonArgs.environmentId,
 ]
 
 OpenDeveloperConsoleCommand.flags = {
diff --git a/src/commands/cloudmanager/environment/set-variables.js b/src/commands/cloudmanager/environment/set-variables.js
@@ -17,6 +17,7 @@ const { flags } = require('@oclif/command')
 const Config = require('@adobe/aio-lib-core-config')
 const _ = require('lodash')
 const commonFlags = require('../../../common-flags')
+const commonArgs = require('../../../common-args')
 const { services } = require('../../../constants')
 const { codes: validationCodes } = require('../../../ValidationErrors')
 
@@ -70,7 +71,7 @@ class SetEnvironmentVariablesCommand extends BaseEnvironmentVariablesCommand {
 SetEnvironmentVariablesCommand.description = 'sets variables set on an environment. These are runtime variables available to components running inside the runtime environment. Use set-pipeline-variables to set build-time variables on a pipeline.'
 
 SetEnvironmentVariablesCommand.args = [
-  { name: 'environmentId', required: true, description: 'the environment id' },
+  commonArgs.environmentId,
 ]
 
 SetEnvironmentVariablesCommand.flags = {
diff --git a/src/commands/cloudmanager/environment/tail-log.js b/src/commands/cloudmanager/environment/tail-log.js
@@ -13,6 +13,7 @@ governing permissions and limitations under the License.
 const BaseCommand = require('../../../base-command')
 const { initSdk, getProgramId, sanitizeEnvironmentId } = require('../../../cloudmanager-helpers')
 const commonFlags = require('../../../common-flags')
+const commonArgs = require('../../../common-args')
 
 class TailLog extends BaseCommand {
   async run () {
@@ -38,7 +39,7 @@ class TailLog extends BaseCommand {
 TailLog.description = 'outputs a stream of log data for the specified environment, service and log name'
 
 TailLog.args = [
-  { name: 'environmentId', required: true, description: 'the environment id' },
+  commonArgs.environmentId,
   { name: 'service', required: true, description: 'the service' },
   { name: 'name', required: true, description: 'the log name' },
 ]
diff --git a/src/commands/cloudmanager/environment/unbind-ip-allowlist.js b/src/commands/cloudmanager/environment/unbind-ip-allowlist.js
@@ -38,7 +38,7 @@ UnbindIPAllowlist.description = 'Bind an IP Allowlist to an environment'
 UnbindIPAllowlist.strict = false
 
 UnbindIPAllowlist.args = [
-  { name: 'environmentId', required: true, description: 'the environment id' },
+  commonArgs.environmentId,
   { name: 'ipAllowlistId', required: true, description: 'the IP allowlist id' },
   commonArgs.service,
 ]
diff --git a/src/commands/cloudmanager/ip-allowlist/bind.js b/src/commands/cloudmanager/ip-allowlist/bind.js
@@ -43,7 +43,7 @@ BindIPAllowlist.strict = false
 
 BindIPAllowlist.args = [
   { name: 'ipAllowlistId', required: true, description: 'the IP allowlist id' },
-  { name: 'environmentId', required: true, description: 'the environment id' },
+  commonArgs.environmentId,
   commonArgs.service,
 ]
 
diff --git a/src/commands/cloudmanager/ip-allowlist/unbind.js b/src/commands/cloudmanager/ip-allowlist/unbind.js
@@ -43,7 +43,7 @@ UnbindIPAllowlist.strict = false
 
 UnbindIPAllowlist.args = [
   { name: 'ipAllowlistId', required: true, description: 'the IP allowlist id' },
-  { name: 'environmentId', required: true, description: 'the environment id' },
+  commonArgs.environmentId,
   commonArgs.service,
 ]
 
diff --git a/src/common-args.js b/src/common-args.js
@@ -14,4 +14,5 @@ const { services } = require('./constants')
 
 module.exports = {
   service: { name: 'service', required: true, options: services, description: 'the service name' },
+  environmentId: { name: 'environmentId', required: true, description: 'the environment id' },
 }

Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,7 @@ governing permissions and limitations under the License.`
`13`	`13`	`const BaseCommerceCliCommand = require('../../../../../base-commerce-cli-command')`
`14`	`14`	`const { getProgramId } = require('../../../../../cloudmanager-helpers')`
`15`	`15`	`const commonFlags = require('../../../../../common-flags')`
	`16`	`+const commonArgs = require('../../../../../common-args')`
`16`	`17`
`17`	`18`	`class IndexerReindexCommand extends BaseCommerceCliCommand {`
`18`	`19`	`async run () {`
`@@ -39,7 +40,7 @@ IndexerReindexCommand.flags = {`
`39`	`40`	`}`
`40`	`41`
`41`	`42`	`IndexerReindexCommand.args = [`
`42`		`- { name: 'environmentId', required: true, description: 'the environment id' },`
	`43`	`+ commonArgs.environmentId,`
`43`	`44`	`]`
`44`	`45`
`45`	`46`	`IndexerReindexCommand.aliases = [`
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@ const BaseCommand = require('../../../base-command')`
`14`	`14`	`const { initSdk, formatTime, getProgramId } = require('../../../cloudmanager-helpers')`
`15`	`15`	`const { cli } = require('cli-ux')`
`16`	`16`	`const commonFlags = require('../../../common-flags')`
	`17`	`+const commonArgs = require('../../../common-args')`
`17`	`18`
`18`	`19`	`class GetCommandExecutionCommand extends BaseCommand {`
`19`	`20`	`async run () {`
`@@ -76,7 +77,7 @@ GetCommandExecutionCommand.flags = {`
`76`	`77`	`}`
`77`	`78`
`78`	`79`	`GetCommandExecutionCommand.args = [`
`79`		`- { name: 'environmentId', required: true, description: 'the environment id' },`
	`80`	`+ commonArgs.environmentId,`
`80`	`81`	`{ name: 'commandExecutionId', required: true, description: 'the command execution id' },`
`81`	`82`	`]`
`82`	`83`
Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,7 @@ const {`
`19`	`19`	`const { cli } = require('cli-ux')`
`20`	`20`	`const { flags } = require('@oclif/command')`
`21`	`21`	`const commonFlags = require('../../../common-flags')`
	`22`	`+const commonArgs = require('../../../common-args')`
`22`	`23`
`23`	`24`	`class ListCommandExecutionsCommand extends BaseCommand {`
`24`	`25`	`async run () {`
`@@ -128,7 +129,7 @@ ListCommandExecutionsCommand.flags = {`
`128`	`129`	`}`
`129`	`130`
`130`	`131`	`ListCommandExecutionsCommand.args = [`
`131`		`- { name: 'environmentId', required: true, description: 'the environment id' },`
	`132`	`+ commonArgs.environmentId,`
`132`	`133`	`]`
`133`	`134`
`134`	`135`	`module.exports = ListCommandExecutionsCommand`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ class BindIPAllowlist extends BaseCommand {`
`36`	`36`	`BindIPAllowlist.description = 'Bind an IP Allowlist to an environment'`
`37`	`37`
`38`	`38`	`BindIPAllowlist.args = [`
`39`		`- { name: 'environmentId', required: true, description: 'the environment id' },`
	`39`	`+ commonArgs.environmentId,`
`40`	`40`	`{ name: 'ipAllowlistId', required: true, description: 'the IP allowlist id' },`
`41`	`41`	`commonArgs.service,`
`42`	`42`	`]`