Improvements to unit test for Environment commands

Author: dishantlangayan

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

@@ -2,10 +2,11 @@ import { runCommand } from '@oclif/test'
 import { expect } from 'chai'
 import * as sinon from 'sinon'
 
-import { ScConnection } from '../../../../src/util/sc-connection.js'
+import { ScConnection } from '../../../../src/util/sc-connection'
+import { setEnvVariables } from '../../../util/test-utils'
 
 describe('platform:env:create', () => {
-  process.env.SC_ACCESS_TOKEN = 'TEST'
+  setEnvVariables()
   let scConnStub: sinon.SinonStub
   const envName: string = 'MyTestEnvironment'
 

test/commands/platform/env/delete.test.ts

@@ -2,27 +2,11 @@ import { runCommand } from '@oclif/test'
 import { expect } from 'chai'
 import * as sinon from 'sinon'
 
-import { ScConnection } from '../../../../src/util/sc-connection.js'
-
-function anEnv(name: string, isDefault: boolean, isProd: boolean) {
-  return {
-    bgColor: '#DA162D',
-    createdBy: 'someuser',
-    createdTime: '2024-09-05T19:54:42.766',
-    description: `This is a description for the the environment ${name}`,
-    fgColor: '#FFFFFF',
-    icon: 'ROCKET_LAUNCH',
-    id: `id${name}`,
-    isDefault,
-    isProduction: isProd,
-    name,
-    updatedBy: 'someuser',
-    updatedTime: '2024-09-05T19:54:42.766',
-  }
-}
+import { ScConnection } from '../../../../src/util/sc-connection'
+import { anEnv, setEnvVariables } from '../../../util/test-utils'
 
 describe('platform:env:delete', () => {
-  process.env.SC_ACCESS_TOKEN = 'TEST'
+  setEnvVariables()
   let scConnDeleteStub: sinon.SinonStub
   let scConnGetStub: sinon.SinonStub
   const envName: string = 'MyTestEnvironment'

test/commands/platform/env/display.test.ts

@@ -1,30 +1,13 @@
 import { runCommand } from '@oclif/test'
 import { expect } from 'chai'
 import * as sinon from 'sinon'
-import { table } from 'table'
 
-import { camelCaseToTitleCase } from '../../../../src/util/internal.js'
-import { ScConnection } from '../../../../src/util/sc-connection.js'
-
-function anEnv(name: string, isDefault: boolean, isProd: boolean) {
-  return {
-    bgColor: '#DA162D',
-    createdBy: 'someuser',
-    createdTime: '2024-09-05T19:54:42.766',
-    description: `This is a description for the the environment ${name}`,
-    fgColor: '#FFFFFF',
-    icon: 'ROCKET_LAUNCH',
-    id: `id${name}`,
-    isDefault,
-    isProduction: isProd,
-    name,
-    updatedBy: 'someuser',
-    updatedTime: '2024-09-05T19:54:42.766',
-  }
-}
+import { camelCaseToTitleCase, renderKeyValueTable } from '../../../../src/util/internal'
+import { ScConnection } from '../../../../src/util/sc-connection'
+import { anEnv, setEnvVariables } from '../../../util/test-utils'
 
 describe('platform:env:display', () => {
-  process.env.SC_ACCESS_TOKEN = 'TEST'
+  setEnvVariables()
   let scConnStub: sinon.SinonStub
 
   beforeEach(() => {
@@ -62,16 +45,7 @@ describe('platform:env:display', () => {
       ...Object.entries(envs.data[0]).map(([key, value]) => [camelCaseToTitleCase(key), value]),
     ]
 
-    const config = {
-      columns: {
-        1: { width: 50, wrapWord: true }
-      },
-      drawHorizontalLine(lineIndex: number, rowCount: number) {
-        return lineIndex === 0 || lineIndex === 1 || lineIndex === rowCount;
-      }
-    }
-
     const { stdout } = await runCommand(`platform:env:display --name=${envName}`)
-    expect(stdout).to.contain(table(tableRows, config))
+    expect(stdout).to.contain(renderKeyValueTable(tableRows, { 1: { width: 50, wrapWord: true } }))
   })
 })

test/commands/platform/env/list.test.ts

@@ -1,27 +1,14 @@
 import { runCommand } from '@oclif/test'
 import { expect } from 'chai'
 import * as sinon from 'sinon'
-import { table } from 'table'
 
 import { Environment } from '../../../../src/types/environment'
+import { renderTable } from '../../../../src/util/internal'
 import { ScConnection } from '../../../../src/util/sc-connection'
-
-function anEnv(name: string, isDefault: boolean, isProd: boolean) {
-  return {
-    createdBy: 'someuser',
-    createdTime: '2024-09-05T19:54:42.766',
-    description: `This is a description for the environment ${name}`,
-    id: `id${name}`,
-    isDefault,
-    isProduction: isProd,
-    name,
-    updateddBy: 'someuser',
-    updatedTime: '2024-09-05T19:54:42.766',
-  }
-}
+import { anEnv, setEnvVariables } from '../../../util/test-utils'
 
 describe('platform:env:list', () => {
-  process.env.SC_ACCESS_TOKEN = 'TEST'
+  setEnvVariables()
   let scConnStub: sinon.SinonStub
 
   beforeEach(() => {
@@ -59,14 +46,9 @@ describe('platform:env:list', () => {
         item.description]),
     ]
 
-    const config = {
-      columns: {
-        4: { width: 50, wrapWord: true }
-      }
-    }
     // Run command
     const { stdout } = await runCommand('platform:env:list')
-    expect(stdout).to.contain(table(envArray, config))
+    expect(stdout).to.contain(renderTable(envArray, { 4: { width: 50, wrapWord: true } }))
   })
 
   it('runs platform:env:list --pageSize=5 --pageNumber=1', async () => {
@@ -96,14 +78,8 @@ describe('platform:env:list', () => {
         item.description]),
     ]
 
-    const config = {
-      columns: {
-        4: { width: 50, wrapWord: true }
-      }
-    }
-
     // Run command
     const { stdout } = await runCommand('platform:env:list --pageSize=5 --pageNumber=1')
-    expect(stdout).to.contain(table(envArray, config))
+    expect(stdout).to.contain(renderTable(envArray, { 4: { width: 50, wrapWord: true } }))
   })
 })

test/commands/platform/env/update.test.ts

@@ -2,27 +2,11 @@ import { runCommand } from '@oclif/test'
 import { expect } from 'chai'
 import * as sinon from 'sinon'
 
-import { ScConnection } from '../../../../src/util/sc-connection.js'
-
-function anEnv(name: string, isDefault: boolean, isProd: boolean) {
-  return {
-    bgColor: '#DA162D',
-    createdBy: 'someuser',
-    createdTime: '2024-09-05T19:54:42.766',
-    description: `This is a description for the the environment ${name}`,
-    fgColor: '#FFFFFF',
-    icon: 'ROCKET_LAUNCH',
-    id: `id${name}`,
-    isDefault,
-    isProduction: isProd,
-    name,
-    updatedBy: 'someuser',
-    updatedTime: '2024-09-05T19:54:42.766',
-  }
-}
+import { ScConnection } from '../../../../src/util/sc-connection'
+import { anEnv, setEnvVariables } from '../../../util/test-utils'
 
 describe('platform:env:update', () => {
-  process.env.SC_ACCESS_TOKEN = 'TEST'
+  setEnvVariables()
   let scConnUpdateStub: sinon.SinonStub
   let scConnGetStub: sinon.SinonStub
   const envName: string = 'MyTestEnvironment'
@@ -56,7 +40,7 @@ describe('platform:env:update', () => {
         }
       }
     }
-    
+
     const updateSuccessMsg = `Environment with id 'id${envName}' has been updated successfully.`
     scConnGetStub.returns(Promise.resolve(envs))
     scConnUpdateStub.returns(updateSuccessMsg)

test/util/test-utils.ts

@@ -0,0 +1,20 @@
+export function setEnvVariables(): void {
+    process.env.SC_ACCESS_TOKEN = 'TEST'
+}
+
+export function anEnv(name: string, isDefault: boolean, isProd: boolean) {
+  return {
+    bgColor: '#DA162D',
+    createdBy: 'someuser',
+    createdTime: '2024-09-05T19:54:42.766',
+    description: `This is a description for the the environment ${name}`,
+    fgColor: '#FFFFFF',
+    icon: 'ROCKET_LAUNCH',
+    id: `id${name}`,
+    isDefault,
+    isProduction: isProd,
+    name,
+    updatedBy: 'someuser',
+    updatedTime: '2024-09-05T19:54:42.766',
+  }
+}