@fairdatasociety/fdp-cli/test/utility/index.ts

CLI tool for FDP-Storage

import { join } from 'path'
import { existsSync, unlinkSync } from 'fs'
import { cli } from 'furious-commander'
import { optionParameters, rootCommandClasses } from '../../src/config'
import { errorHandler } from '../../src/utils/error'
import { ENS_OPTION_FDP_PLAY } from '../../src/utils/config'

type describeFunctionArgs = {
  consoleMessages: string[]
  configFolderPath: string
  configFilePath: string
  getNthLastMessage: (n: number) => string
  getLastMessage: () => string
  removeConfig: () => void
  hasMessageContaining: (substring: string) => boolean
}

export async function invokeTestCli(argv: string[]): ReturnType<typeof cli> {
  return await cli({
    rootCommandClasses,
    optionParameters,
    testArguments: argv,
    errorHandler,
  })
}

/**
 * Removes file if exists
 */
export function removeFile(filename: string): void {
  if (existsSync(filename)) {
    unlinkSync(filename)
  }
}

export function describeCommand(
  description: string,
  func: (clauseFields: describeFunctionArgs) => void,
  options?: { configFileName?: string },
): void {
  describe(description, () => {
    const consoleMessages: string[] = []
    const configFileName = options?.configFileName
    const getNthLastMessage = (n: number) => consoleMessages[consoleMessages.length - n]
    const getLastMessage = () => consoleMessages[consoleMessages.length - 1]
    const removeConfig = () => removeFile(configFilePath)
    const hasMessageContaining = (substring: string) =>
      Boolean(consoleMessages.find(consoleMessage => consoleMessage.includes(substring)))
    const configFolderPath = join(__dirname, '..', 'testconfig')

    //set config environment variable
    process.env.FDP_CLI_CONFIG_FOLDER = configFolderPath

    global.console.log = jest.fn(message => {
      consoleMessages.push(message)
    })
    global.console.error = jest.fn(message => {
      consoleMessages.push(message)
    })

    global.process.stdout.write = jest.fn(message => {
      if (typeof message === 'string') {
        consoleMessages.push(message)
      } else {
        consoleMessages.push(new TextDecoder().decode(message))
      }

      return true
    })

    jest.spyOn(process, 'exit').mockImplementation(() => {
      throw new Error('process.exit() was called.')
    })

    jest.spyOn(global.console, 'warn')

    let configFilePath = ''

    // if own config is needed
    if (configFileName) {
      const fileName = `${configFileName}.json`
      configFilePath = join(configFolderPath, fileName)

      //set config environment variable
      process.env.FDP_CLI_CONFIG_FILE = fileName
      process.env.FDP_CLI_CONFIG_FILE_PATH = configFilePath
      process.env.ENS_NETWORK = ENS_OPTION_FDP_PLAY
    }

    beforeEach(() => {
      consoleMessages.length = 0

      // remove config file before each test because the previous test might change the configuration
      // in an inappropriate way
      removeFile(configFilePath)
    })

    func({
      consoleMessages,
      getNthLastMessage,
      getLastMessage,
      hasMessageContaining,
      configFolderPath,
      configFilePath,
      removeConfig,
    })
  })
}