change flag useRuntimeAuth from camelCase to kebabCase use-runtime-auth, add undeploy as a DeployServiceCommand

Author: shazron

src/DeployServiceCommand.js

@@ -69,7 +69,7 @@ class DeployServiceCommand extends RuntimeBaseCommand {
 
   async setRuntimeApiHostAndAuthHandler (options) {
     let _options = structuredClone(options)
-    if (!_options?.useRuntimeAuth) {
+    if (!_options?.['use-runtime-auth']) {
       const endpoint = process.env.AIO_DEPLOY_SERVICE_URL ?? PropertyDefault.DEPLOYSERVICEURL
       _options = _options ?? {}
       _options.apihost = `${endpoint}/runtime`
@@ -91,7 +91,7 @@ class DeployServiceCommand extends RuntimeBaseCommand {
 
 DeployServiceCommand.flags = {
   ...RuntimeBaseCommand.flags,
-  useRuntimeAuth: Flags.boolean({ char: 'r', description: 'use Runtime auth [default: false]', default: false })
+  'use-runtime-auth': Flags.boolean({ char: 'r', description: 'use Runtime auth [default: false]', default: false })
 }
 
 module.exports = DeployServiceCommand

src/RuntimeBaseCommand.js

@@ -19,12 +19,6 @@ const http = require('http')
 const runtimeLib = require('@adobe/aio-lib-runtime')
 const config = require('@adobe/aio-lib-core-config')
 
-/**
- * @typedef {object} WskCreateOptions
- * @property {boolean} [useRuntimeAuth=false] - Whether to use Runtime authentication
- * @property {object} [wskClientOptions] - The options to pass to the wsk client. If not provided, will be generated from getOptions()
- */
-
 class RuntimeBaseCommand extends Command {
   async getOptions () {
     const { flags } = await this.parse(this.constructor)
@@ -38,7 +32,7 @@ class RuntimeBaseCommand extends Command {
       namespace: config.get('runtime.namespace') || properties.get('NAMESPACE'),
       api_key: flags.auth || config.get('runtime.auth') || properties.get('AUTH'),
       ignore_certs: flags.insecure || config.get('runtime.insecure'),
-      useRuntimeAuth: process.env.USE_RUNTIME_AUTH || flags.useRuntimeAuth
+      'use-runtime-auth': process.env.USE_RUNTIME_AUTH || flags['use-runtime-auth']
     }
 
     // remove any null or undefined keys

src/commands/runtime/deploy/sync.js

@@ -28,6 +28,7 @@ class DeploySync extends DeployServiceCommand {
       }
       const params = {}
       const options = await this.getOptions()
+      delete options['use-runtime-auth']
       const entities = processPackage(packages, deploymentPackages, deploymentTriggers, params, false, options)
       const ow = await this.wsk()
       const logger = this.log

src/commands/runtime/deploy/undeploy.js

@@ -10,15 +10,16 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 
-const RuntimeBaseCommand = require('../../../RuntimeBaseCommand')
+const DeployServiceCommand = require('../../../DeployServiceCommand')
 const { getProjectEntities, undeployPackage, processPackage, setPaths } = require('@adobe/aio-lib-runtime').utils
 const { Flags } = require('@oclif/core')
 
-class DeployUndeploy extends RuntimeBaseCommand {
+class DeployUndeploy extends DeployServiceCommand {
   async run () {
     const { flags } = await this.parse(DeployUndeploy)
     try {
       const options = await this.getOptions()
+      delete options['use-runtime-auth']
       const ow = await this.wsk()
       const logger = this.log
 
@@ -44,7 +45,7 @@ class DeployUndeploy extends RuntimeBaseCommand {
 }
 
 DeployUndeploy.flags = {
-  ...RuntimeBaseCommand.flags,
+  ...DeployServiceCommand.flags,
   manifest: Flags.string({
     char: 'm',
     description: 'the manifest file location' // help description for flag

test/DeployServiceCommand.test.js

@@ -50,7 +50,7 @@ describe('DeployServiceCommand', () => {
 
   test('flags', async () => {
     expect(Object.keys(TheCommand.flags)).toEqual(expect.arrayContaining([
-      'useRuntimeAuth'
+      'use-runtime-auth'
     ]))
   })
 
@@ -134,16 +134,16 @@ describe('DeployServiceCommand', () => {
       expect(result.auth_handler).toBeDefined()
     })
 
-    test('should set runtime API host and auth handler when useRuntimeAuth is false', async () => {
+    test('should set runtime API host and auth handler when use-runtime-auth is false', async () => {
       const mockOptions = { someOption: 'value' }
       const result = await command.setRuntimeApiHostAndAuthHandler(mockOptions)
 
       expect(result.apihost).toBe(`${PropertyDefault.DEPLOYSERVICEURL}/runtime`)
       expect(result.auth_handler).toBeDefined()
     })
 
-    test('should not modify options when useRuntimeAuth is true', async () => {
-      const mockOptions = { useRuntimeAuth: true, someOption: 'value' }
+    test('should not modify options when use-runtime-auth is true', async () => {
+      const mockOptions = { 'use-runtime-auth': true, someOption: 'value' }
       const result = await command.setRuntimeApiHostAndAuthHandler(mockOptions)
 
       expect(result).toEqual(mockOptions)

test/RuntimeBaseCommand.test.js

@@ -238,7 +238,7 @@ describe('instance methods', () => {
 
     test('returns a promise (pass options)', () => {
       RuntimeLib.init.mockReturnValue({})
-      const options = { useRuntimeAuth: true }
+      const options = {}
       return command.wsk(options).then((ow) => {
         expect(ow).toBeDefined()
       })

test/commands/runtime/deploy/undeploy.test.js

@@ -41,7 +41,12 @@ test('flags', async () => {
 // some expected fake values
 const expectedEntities = { fake: 'entities' }
 const expectedEntitiesFromGet = { fakeGet: 'getentities' }
-const expectedOWOptions = { api_key: 'some-gibberish-not-a-real-key', apihost: 'some.host', apiversion: 'v1', namespace: 'some_namespace' }
+const expectedOWOptions = {
+  api_key: 'some-gibberish-not-a-real-key',
+  apihost: 'some.host',
+  apiversion: 'v1',
+  namespace: 'some_namespace'
+}
 const expectedDepPackages = { fake: 'dep-packages' }
 const expectedDepTriggers = [{ fake: 'dep-triggers' }]
 const expectedPackages = { fake: 'packages' }
@@ -75,7 +80,10 @@ describe('instance methods', () => {
     test('run with no flags', async () => {
       command.argv = []
       await command.run()
-      expect(utils.setPaths).toHaveBeenCalledWith({ useragent: pkgNameVersion })
+      expect(utils.setPaths).toHaveBeenCalledWith({
+        'use-runtime-auth': false,
+        useragent: pkgNameVersion
+      })
 
       expect(utils.processPackage).toHaveBeenCalledWith(expectedPackages, {}, {}, {}, true, expectedOWOptions)
       expect(utils.getProjectEntities).not.toHaveBeenCalled()
@@ -88,7 +96,11 @@ describe('instance methods', () => {
     test('run with manifest flag', async () => {
       command.argv = ['-m', 'fake-manifest.yml']
       await command.run()
-      expect(utils.setPaths).toHaveBeenCalledWith({ manifest: 'fake-manifest.yml', useragent: pkgNameVersion })
+      expect(utils.setPaths).toHaveBeenCalledWith({
+        'use-runtime-auth': false,
+        manifest: 'fake-manifest.yml',
+        useragent: pkgNameVersion
+      })
 
       expect(utils.processPackage).toHaveBeenCalledWith(expectedPackages, {}, {}, {}, true, expectedOWOptions)
       expect(utils.getProjectEntities).not.toHaveBeenCalled()