Rework config.ts & add unit test

Author: Yukaii

src/config.ts

@@ -19,10 +19,17 @@ const defaultConfig = {
   enterprise: true
 }
 
+function toBooleanConfig(configValue?: string | boolean) {
+  if (configValue && typeof configValue === 'string') {
+    return (configValue === 'true')
+  }
+  return configValue
+}
+
 const envConfig = {
   cookiePath: process.env.HMD_CLI_COOKIE_PATH || process.env.CMD_CLI_COOKIE_PATH,
   serverUrl: process.env.HMD_CLI_SERVER_URL || process.env.CMD_CLI_SERVER_URL,
-  enterprise: (process.env.HMD_CLI_COOKIE_PATH || process.env.HMD_CLI_SERVER_URL)
+  enterprise: (process.env.HMD_CLI_COOKIE_PATH || process.env.HMD_CLI_SERVER_URL) ? true : toBooleanConfig(process.env.HMD_CLI_ENTERPRISE)
 }
 
 // look for a readable config file; we can merge it with the env.
@@ -62,6 +69,7 @@ ${err}
 // prefer environment config over file config
 const config = defaults(envConfig, readConfig, defaultConfig)
 
+// !FIXME This branching never meets because we have defaultConfig
 if (!config.serverUrl) {
   throw new Error(`
 

test/commands/hello.test.ts

@@ -0,0 +1,79 @@
+import {expect} from '@oclif/test'
+import * as fs from 'fs-extra'
+import * as path from 'path'
+
+import {tempDir} from './utils'
+
+const requireConfig = () => require('../src/config').default
+
+const cleanup = () => {
+  // delete config module cache
+  delete require.cache[require.resolve('../src/config')]
+
+  // reset env
+  process.env = {}
+}
+
+const setupConfigFile = () => {
+  const configDir = tempDir()
+  process.env.HMD_CLI_CONFIG_DIR = configDir
+  return path.join(configDir, 'config.json')
+}
+
+describe('Config test', function () {
+  beforeEach(function () {
+    cleanup()
+    this.configFilePath = setupConfigFile()
+  })
+
+  it('should throw no config error if config.json not found and no serverUrl set in env', function () {
+    expect(requireConfig)
+      .to.throw(new RegExp(`Configuration file at ${this.configFilePath} not readable`))
+  })
+
+  it('should throw read error if config.json is not valid JSON', function () {
+    fs.writeFileSync(this.configFilePath, '.', 'utf8')
+
+    expect(requireConfig)
+      .to.throw(/Could not read JSON config file at/)
+  })
+
+  it.skip('should throw error if no serverUrl is set', function () {
+    fs.writeFileSync(this.configFilePath, '{}', 'utf8')
+
+    expect(requireConfig)
+      .to.throw(/Please specify CodiMD server URL either/)
+  })
+
+  it('should set enterprise to true if HMD_CLI_COOKIE_PATH is supplied', function () {
+    process.env.HMD_CLI_COOKIE_PATH = tempDir()
+    fs.writeFileSync(this.configFilePath, '{}', 'utf8')
+
+    const config = requireConfig()
+
+    expect(config.cookiePath).to.eq(process.env.HMD_CLI_COOKIE_PATH)
+    expect(config.enterprise).to.eq(true)
+  })
+
+  it('should set enterprise to true if HMD_CLI_SERVER_URL is supplied', function () {
+    process.env.HMD_CLI_SERVER_URL = tempDir()
+    fs.writeFileSync(this.configFilePath, '{}', 'utf8')
+
+    const config = requireConfig()
+
+    expect(config.serverUrl).to.eq(process.env.HMD_CLI_SERVER_URL)
+    expect(config.enterprise).to.eq(true)
+  })
+
+  it('should set enterprise with HMD_CLI_ENTERPRISE', function () {
+    fs.writeFileSync(this.configFilePath, '{}', 'utf8')
+
+    process.env.HMD_CLI_ENTERPRISE = 'false'
+    expect(requireConfig().enterprise).to.eq(false)
+
+    cleanup()
+
+    process.env.HMD_CLI_ENTERPRISE = 'true'
+    expect(requireConfig().enterprise).to.eq(true)
+  })
+})

test/config.test.ts

@@ -0,0 +1,7 @@
+import * as fs from 'fs-extra'
+import * as os from 'os'
+import * as path from 'path'
+
+export function tempDir() {
+  return fs.mkdtempSync(path.join(os.tmpdir(), 'foo-'))
+}