Update description flag in create env command

Author: dishantlangayan

src/commands/platform/env/create.ts

@@ -12,7 +12,7 @@ export default class PlatformEnvCreate extends ScCommand<typeof PlatformEnvCreat
   Token Permissions: [ environments:edit ]`
   static override examples = ['<%= config.bin %> <%= command.id %> --name=MyEnvironment --desc="My environment description" --isDefault --isProduction']
   static override flags = {
-    desc: Flags.string({
+    description: Flags.string({
       char: 'd',
       description: 'Description of the environment to create.'
     }),
@@ -36,7 +36,7 @@ export default class PlatformEnvCreate extends ScCommand<typeof PlatformEnvCreat
     const { flags } = await this.parse(PlatformEnvCreate)
 
     const name = flags.name ?? ''
-    const desc = flags.desc ?? ''
+    const desc = flags.description ?? ''
     const isDefault = flags.isDefault ?? false
     const isProduction = flags.isProduction ?? false
 
@@ -46,7 +46,7 @@ export default class PlatformEnvCreate extends ScCommand<typeof PlatformEnvCreat
     const apiUrl: string = `/platform/environments`
     // API body
     const body = {
-      description: desc,
+      ...(desc && { description: desc }),
       isDefault,
       isProduction,
       name,

test/commands/platform/env/create.test.ts

@@ -1,9 +1,11 @@
-import { runCommand } from '@oclif/test'
-import { expect } from 'chai'
+import {runCommand} from '@oclif/test'
+import {expect} from 'chai'
 import * as sinon from 'sinon'
 
-import { ScConnection } from '../../../../src/util/sc-connection'
-import { setEnvVariables } from '../../../util/test-utils'
+import {Environment, EnvironmentDetail} from '../../../../src/types/environment.js'
+import {camelCaseToTitleCase, renderKeyValueTable} from '../../../../src/util/internal'
+import {ScConnection} from '../../../../src/util/sc-connection'
+import {anEnv, setEnvVariables} from '../../../util/test-utils'
 
 describe('platform:env:create', () => {
   setEnvVariables()
@@ -19,15 +21,63 @@ describe('platform:env:create', () => {
   })
 
   it('runs platform:env:create', async () => {
-    const { stdout } = await runCommand('platform:env:create')
+    const {stdout} = await runCommand('platform:env:create')
     expect(stdout).to.contain('')
   })
 
-  it(`runs platform:env:create  --name=${envName}`, async () => {
-    const createOutputMsg = 'Environment created successfully.'
-    scConnStub.returns(createOutputMsg)
+  it(`runs platform:env:create --name=${envName}`, async () => {
+    // Arrange
+    const expectBody = {
+      isDefault: false,
+      isProduction: false,
+      name: envName,
+    }
+    const expectEnv: Environment = anEnv(envName, false, false)
+    const expectResponse: EnvironmentDetail = {
+      data: expectEnv,
+    }
+    scConnStub.returns(expectResponse)
 
-    const { stdout } = await runCommand(`platform:env:create --name=${envName}`)
-    expect(stdout).to.contain(createOutputMsg)
+    const tableRows = [
+      ['Key', 'Value'],
+      ...Object.entries(expectResponse.data).map(([key, value]) => [camelCaseToTitleCase(key), value]),
+    ]
+
+    // Act
+    const {stdout} = await runCommand(`platform:env:create --name=${envName}`)
+
+    // Assert
+    expect(scConnStub.getCall(0).calledWith('/platform/environments', expectBody)).to.be.true
+    expect(stdout).to.contain(renderKeyValueTable(tableRows))
+  })
+
+  it(`runs platform:env:create --name=${envName} --description="This is an environment description."`, async () => {
+    // Arrange
+    const expectBody = {
+      description: 'This is an environment description.',
+      isDefault: false,
+      isProduction: false,
+      name: envName,
+    }
+    const expectEnv: Environment = anEnv(envName, false, false)
+    const expectResponse: EnvironmentDetail = {
+      data: expectEnv,
+    }
+    expectResponse.data.description = expectBody.description
+    scConnStub.returns(expectResponse)
+
+    const tableRows = [
+      ['Key', 'Value'],
+      ...Object.entries(expectResponse.data).map(([key, value]) => [camelCaseToTitleCase(key), value]),
+    ]
+
+    // Act
+    const {stdout} = await runCommand(
+      `platform:env:create --name=${envName} --description="This is an environment description."`,
+    )
+
+    // Assert
+    expect(scConnStub.getCall(0).calledWith('/platform/environments', expectBody)).to.be.true
+    expect(stdout).to.contain(renderKeyValueTable(tableRows))
   })
 })