feat: update deploy command to provision db

Author: AjazSumaiya

README.md

@@ -297,7 +297,7 @@ USAGE
   $ aio app create [PATH] [-v] [--version] [-i <value>]
 
 ARGUMENTS
-  PATH  [default: .] Path to the app directory
+  [PATH]  [default: .] Path to the app directory
 
 FLAGS
   -i, --import=<value>  Import an Adobe I/O Developer Console configuration file
@@ -337,7 +337,7 @@ USAGE
   $ aio app delete action [ACTION-NAME] [-v] [--version] [-y]
 
 ARGUMENTS
-  ACTION-NAME  Action `pkg/name` to delete, you can specify multiple actions via a comma separated list
+  [ACTION-NAME]  Action `pkg/name` to delete, you can specify multiple actions via a comma separated list
 
 FLAGS
   -v, --verbose  Verbose output
@@ -543,7 +543,7 @@ USAGE
     <value> |  | ] [--confirm-new-workspace] [--use-jwt] [--github-pat <value> ] [--linter none|basic|adobe-recommended]
 
 ARGUMENTS
-  PATH  [default: .] Path to the app directory
+  [PATH]  [default: .] Path to the app directory
 
 FLAGS
   -e, --extension=<value>...        Extension point(s) to implement
@@ -674,7 +674,7 @@ USAGE
   $ aio app pack [PATH] [-v] [--version] [--lock-file] [-o <value>]
 
 ARGUMENTS
-  PATH  [default: .] Path to the app directory to package
+  [PATH]  [default: .] Path to the app directory to package
 
 FLAGS
   -o, --output=<value>  [default: dist/app.zip] The packaged app output file path
@@ -773,7 +773,7 @@ USAGE
     [--confirm-new-workspace] [--no-service-sync | --confirm-service-sync] [--no-input] [--use-jwt]
 
 ARGUMENTS
-  CONFIG_FILE_PATH  path to an Adobe I/O Developer Console configuration file
+  [CONFIG_FILE_PATH]  path to an Adobe I/O Developer Console configuration file
 
 FLAGS
   -g, --global                      Use the global Adobe Developer Console Org / Project / Workspace configuration,

package.json

@@ -5,7 +5,7 @@
   "author": "Adobe Inc.",
   "bugs": "https://github.com/adobe/aio-cli-plugin-app/issues",
   "dependencies": {
-    "@adobe/aio-cli-lib-app-config": "^4.0.3",
+    "@adobe/aio-cli-lib-app-config": "../aio-cli-lib-app-config",
     "@adobe/aio-cli-lib-console": "^5.0.3",
     "@adobe/aio-lib-core-config": "^5",
     "@adobe/aio-lib-core-logging": "^3",

src/commands/app/deploy.js

@@ -203,6 +203,11 @@ class Deploy extends BuildCommand {
       this.error(err)
     }
 
+    // provision database if configured
+    if (config.manifest?.full?.database?.['auto-provision'] === true) {
+      await this.provisionDatabase(config, spinner, flags)
+    }
+
     if (flags.actions) {
       if (config.app.hasBackend) {
         let filterEntities
@@ -299,6 +304,32 @@ class Deploy extends BuildCommand {
     }
   }
 
+  async provisionDatabase (config, spinner, flags) {
+    const region = config.manifest?.full?.database?.region || 'amer'
+
+    if (!config.manifest?.full?.database?.region) {
+      spinner.info(chalk.green('No region is configured for the database, deploying in default region amer'))
+    }
+
+    const message = `Deploying database for region '${region}'`
+
+    try {
+      spinner.start(message)
+
+      if (flags.verbose) {
+        spinner.info(chalk.dim(`Running: aio app db provision --region ${region} --yes`))
+        spinner.start(message)
+      }
+
+      await this.config.runCommand('app:db:provision', ['--region', region, '--yes'])
+
+      spinner.succeed(chalk.green(`Deployed database for application in region '${region}'`))
+    } catch (error) {
+      spinner.fail(chalk.red('Database deployment failed'))
+      throw error
+    }
+  }
+
   async publishExtensionPoints (deployConfigs, aioConfig, force) {
     const libConsoleCLI = await this.getLibConsoleCLI()
 

test/commands/app/deploy.test.js

@@ -18,6 +18,7 @@ const helpersActual = jest.requireActual('../../../src/lib/app-helper.js')
 const authHelpersActual = jest.requireActual('../../../src/lib/auth-helper')
 
 const open = require('open')
+const ora = require('ora')
 const mockBundleFunc = jest.fn()
 
 jest.mock('../../../src/lib/app-helper.js')
@@ -203,6 +204,7 @@ beforeEach(() => {
   command = new TheCommand([])
   command.error = jest.fn()
   command.log = jest.fn()
+  command.warn = jest.fn()
   command.appConfig = cloneDeep(mockConfigData)
   command.appConfig.actions = { dist: 'actions' }
   command.appConfig.web.distProd = 'dist'
@@ -1628,4 +1630,132 @@ describe('run', () => {
     expect(mockRuntimeLib.deployActions).toHaveBeenCalledTimes(1)
     expect(mockWebLib.deployWeb).toHaveBeenCalledTimes(1)
   })
+
+  test('should deploy successfully when auto-provision database is configured', async () => {
+    // Create app config with database auto-provision enabled
+    const appConfigWithDb = createAppConfig({
+      ...command.appConfig,
+      manifest: {
+        full: {
+          database: {
+            'auto-provision': true
+          }
+        },
+        database: {
+          region: 'emea'
+        }
+      }
+    })
+
+    command.getAppExtConfigs.mockResolvedValueOnce(appConfigWithDb)
+    command.provisionDatabase = jest.fn().mockResolvedValue()
+
+    await command.run()
+
+    expect(command.error).toHaveBeenCalledTimes(0)
+    expect(command.provisionDatabase).toHaveBeenCalledTimes(1)
+    expect(command.provisionDatabase).toHaveBeenCalledWith(
+      appConfigWithDb.application,
+      expect.any(Object), // spinner
+      expect.objectContaining({ 'force-build': true }) // flags
+    )
+    expect(mockRuntimeLib.deployActions).toHaveBeenCalledTimes(1)
+    expect(mockWebLib.deployWeb).toHaveBeenCalledTimes(1)
+  })
+})
+
+describe('database provisioning', () => {
+  const createDatabaseConfig = (region = null, autoProvision = true) => ({
+    manifest: {
+      full: {
+        database: {
+          'auto-provision': autoProvision,
+          ...(region && { region })
+        }
+      }
+    }
+  })
+
+  // Helper function to set up and run test
+  const runProvisionTest = async (config, flags, mockResult) => {
+    const spinner = ora()
+
+    if (mockResult instanceof Error) {
+      command.config.runCommand.mockRejectedValueOnce(mockResult)
+    } else {
+      command.config.runCommand.mockResolvedValueOnce(mockResult)
+    }
+
+    return {
+      result: await command.provisionDatabase(config, spinner, flags).catch(e => { throw e }),
+      spinner
+    }
+  }
+
+  test('should use default region when not specified in manifest', async () => {
+    const config = createDatabaseConfig()
+    const flags = { verbose: false }
+
+    const { spinner } = await runProvisionTest(config, flags)
+
+    expect(spinner.info).toHaveBeenCalledWith(expect.stringContaining('No region is configured for the database, deploying in default region amer'))
+    expect(spinner.start).toHaveBeenCalledWith('Deploying database for region \'amer\'')
+    expect(command.config.runCommand).toHaveBeenCalledWith('app:db:provision', ['--region', 'amer', '--yes'])
+    expect(spinner.succeed).toHaveBeenCalledWith(expect.stringContaining('Deployed database for application in region \'amer\''))
+  })
+
+  test('should use configured region when specified in manifest', async () => {
+    const config = createDatabaseConfig('emea')
+    const flags = { verbose: false }
+
+    const { spinner } = await runProvisionTest(config, flags)
+
+    expect(spinner.info).not.toHaveBeenCalledWith(expect.stringContaining('No region is configured for the database'))
+    expect(spinner.start).toHaveBeenCalledWith('Deploying database for region \'emea\'')
+    expect(command.config.runCommand).toHaveBeenCalledWith('app:db:provision', ['--region', 'emea', '--yes'])
+    expect(spinner.succeed).toHaveBeenCalledWith(expect.stringContaining('Deployed database for application in region \'emea\''))
+  })
+
+  test('should show verbose output when verbose flag is true', async () => {
+    const config = createDatabaseConfig('amer')
+    const flags = { verbose: true }
+
+    const { spinner } = await runProvisionTest(config, flags)
+
+    expect(spinner.info).toHaveBeenCalledWith(expect.stringContaining('Running: aio app db provision --region amer --yes'))
+    expect(spinner.info).not.toHaveBeenCalledWith(expect.stringContaining('No region is configured for the database'))
+    expect(spinner.start).toHaveBeenCalledTimes(2) // Once initially, once after verbose info
+    expect(spinner.succeed).toHaveBeenCalledWith(expect.stringContaining('Deployed database for application in region \'amer\''))
+  })
+
+  test('should handle provision command failure', async () => {
+    const config = createDatabaseConfig('amer')
+    const flags = { verbose: false }
+    const error = new Error('Database provision failed')
+
+    await expect(runProvisionTest(config, flags, error))
+      .rejects.toThrow('Database provision failed')
+
+    expect(command.warn).not.toHaveBeenCalled()
+  })
+
+  test('should show verbose error details when verbose flag is true and provision fails', async () => {
+    const config = createDatabaseConfig('amer')
+    const flags = { verbose: true }
+    const error = new Error('Database provision failed')
+
+    await expect(runProvisionTest(config, flags, error))
+      .rejects.toThrow('Database provision failed')
+
+    expect(command.warn).not.toHaveBeenCalled()
+  })
+
+  test('should fail if invalid region specified', async () => {
+    const config = createDatabaseConfig('invalid-region')
+    const flags = { verbose: false }
+    const error = new Error('Invalid region: invalid-region')
+
+    await expect(runProvisionTest(config, flags, error))
+      .rejects.toThrow('Invalid region: invalid-region')
+  })
 })