feat(commerce): add app:config:dump command fixes #474 (#477)

Author: rwalter215

src/commands/cloudmanager/commerce/bin-magento/app/config/dump.js

@@ -0,0 +1,50 @@
+/*
+Copyright 2021 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+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 AppConfigDumpCommand extends BaseCommerceCliCommand {
+  async run () {
+    const { args, flags, argv } = this.parse(AppConfigDumpCommand)
+
+    const programId = getProgramId(flags)
+    const configTypes = argv.slice(1)
+
+    const result = await this.runSync(programId, args.environmentId,
+      {
+        type: 'bin/magento',
+        command: 'app:config:dump',
+        options: ['-n', ...configTypes],
+      },
+      1000, 'app:config:dump')
+
+    return result
+  }
+}
+
+AppConfigDumpCommand.strict = false
+
+AppConfigDumpCommand.description = 'commerce config dump'
+
+AppConfigDumpCommand.flags = {
+  ...commonFlags.global,
+  ...commonFlags.programId,
+}
+
+AppConfigDumpCommand.args = [
+  commonArgs.environmentId,
+]
+
+module.exports = AppConfigDumpCommand

test/commands/commerce/bin-magento/app/config/dump.test.js

@@ -0,0 +1,153 @@
+/*
+Copyright 2021 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+
+const { cli } = require('cli-ux')
+const { init, mockSdk } = require('@adobe/aio-lib-cloudmanager')
+const { resetCurrentOrgId, setCurrentOrgId } = require('@adobe/aio-lib-ims')
+const AppConfigDumpCommand = require('../../../../../../src/commands/cloudmanager/commerce/bin-magento/app/config/dump')
+
+beforeEach(() => {
+  resetCurrentOrgId()
+})
+
+test('app:config:dump - missing environmentId', async () => {
+  expect.assertions(2)
+
+  const runResult = AppConfigDumpCommand.run([])
+  await expect(runResult instanceof Promise).toBeTruthy()
+  await expect(runResult).rejects.toThrow(/^Missing 1 required arg/)
+})
+
+test('app:config:dump - missing IMS Context', async () => {
+  expect.assertions(2)
+
+  const runResult = AppConfigDumpCommand.run(['--programId', '3', '60'])
+  await expect(runResult instanceof Promise).toBeTruthy()
+  await expect(runResult).rejects.toThrow('[CloudManagerCLI:NO_IMS_CONTEXT] Unable to find IMS context aio-cli-plugin-cloudmanager.')
+})
+
+test('app:config:dump - api error', async () => {
+  setCurrentOrgId('valid-org-id')
+  mockSdk.postCommerceCommandExecution = jest.fn(() =>
+    Promise.reject(new Error('Command failed.')),
+  )
+  mockSdk.getCommerceCommandExecution = jest.fn()
+  const runResult = AppConfigDumpCommand.run(['--programId', '3', '60'])
+  await expect(runResult instanceof Promise).toBeTruthy()
+  await expect(runResult).rejects.toEqual(new Error('Command failed.'))
+})
+
+test('app:config:dump - success with config types', async () => {
+  let counter = 0
+  setCurrentOrgId('valid-org-id')
+  mockSdk.postCommerceCommandExecution = jest.fn(() =>
+    Promise.resolve({
+      id: '6000',
+    }),
+  )
+  mockSdk.getCommerceCommandExecution = jest.fn(() => {
+    counter++
+    if (counter === 1) {
+      return Promise.resolve({
+        status: 'PENDING',
+        message: 'running config dump',
+      })
+    } else if (counter < 3) {
+      return Promise.resolve({
+        status: 'RUNNING',
+        message: 'running config dump',
+      })
+    }
+    return Promise.resolve({
+      status: 'COMPLETE',
+      message: 'done',
+    })
+  })
+
+  expect.assertions(11)
+
+  const runResult = AppConfigDumpCommand.run(['--programId', '3', '60', 'i18n', 'scopes'])
+  await expect(runResult instanceof Promise).toBeTruthy()
+  await runResult
+  await expect(init.mock.calls.length).toEqual(1)
+  await expect(init).toHaveBeenCalledWith(
+    'valid-org-id',
+    'test-client-id',
+    'fake-token',
+    'https://cloudmanager.adobe.io',
+  )
+  await expect(mockSdk.postCommerceCommandExecution.mock.calls.length).toEqual(1)
+  await expect(mockSdk.postCommerceCommandExecution).toHaveBeenCalledWith('3', '60', {
+    type: 'bin/magento',
+    command: 'app:config:dump',
+    options: ['-n', 'i18n', 'scopes'],
+  })
+  await expect(mockSdk.getCommerceCommandExecution).toHaveBeenCalledWith('3', '60', '6000')
+  await expect(mockSdk.getCommerceCommandExecution).toHaveBeenCalledTimes(3)
+  await expect(cli.action.start.mock.calls[0][0]).toEqual('Starting app:config:dump')
+  await expect(cli.action.start.mock.calls[1][0]).toEqual('Starting app:config:dump')
+  await expect(cli.action.start.mock.calls[2][0]).toEqual('Running app:config:dump')
+  await expect(cli.action.stop.mock.calls[0][0]).toEqual('done')
+})
+
+test('app:config:dump - success without config types', async () => {
+  let counter = 0
+  setCurrentOrgId('valid-org-id')
+  mockSdk.postCommerceCommandExecution = jest.fn(() =>
+    Promise.resolve({
+      id: '6000',
+    }),
+  )
+  mockSdk.getCommerceCommandExecution = jest.fn(() => {
+    counter++
+    if (counter === 1) {
+      return Promise.resolve({
+        status: 'PENDING',
+        message: 'running config dump',
+      })
+    } else if (counter < 3) {
+      return Promise.resolve({
+        status: 'RUNNING',
+        message: 'running config dump',
+      })
+    }
+    return Promise.resolve({
+      status: 'COMPLETE',
+      message: 'done',
+    })
+  })
+
+  expect.assertions(11)
+
+  const runResult = AppConfigDumpCommand.run(['--programId', '3', '60'])
+  await expect(runResult instanceof Promise).toBeTruthy()
+  await runResult
+  await expect(init.mock.calls.length).toEqual(1)
+  await expect(init).toHaveBeenCalledWith(
+    'valid-org-id',
+    'test-client-id',
+    'fake-token',
+    'https://cloudmanager.adobe.io',
+  )
+  await expect(mockSdk.postCommerceCommandExecution.mock.calls.length).toEqual(1)
+  await expect(mockSdk.postCommerceCommandExecution).toHaveBeenCalledWith('3', '60', {
+    type: 'bin/magento',
+    command: 'app:config:dump',
+    options: ['-n'],
+  })
+  await expect(mockSdk.getCommerceCommandExecution).toHaveBeenCalledWith('3', '60', '6000')
+  await expect(mockSdk.getCommerceCommandExecution).toHaveBeenCalledTimes(3)
+  await expect(cli.action.start.mock.calls[0][0]).toEqual('Starting app:config:dump')
+  await expect(cli.action.start.mock.calls[1][0]).toEqual('Starting app:config:dump')
+  await expect(cli.action.start.mock.calls[2][0]).toEqual('Running app:config:dump')
+  await expect(cli.action.stop.mock.calls[0][0]).toEqual('done')
+})