programming-challenges/cli/commands/run/test.ts

import { Command, Option } from 'clipanion'
import * as typanion from 'typanion'
import chalk from 'chalk'

import { Solution } from '../../services/Solution.js'
import { GitAffected } from '../../services/GitAffected.js'
import { template } from '../../services/Template.js'
import { Test } from '../../services/Test.js'
import { SolutionTestsResult } from '../../services/SolutionTestsResult.js'
import { TemporaryFolder } from '../../services/TemporaryFolder.js'

export class RunTestCommand extends Command {
  public static override paths = [['run', 'test']]

  public static override usage = {
    description:
      'Test if the solution is correct and display where it succeeds and fails.'
  }

  public programmingLanguage = Option.String('--language', {
    description: 'The programming language used to solve the challenge.',
    validator: typanion.isString()
  })

  public challenge = Option.String('--challenge', {
    description: 'The challenge name where you want to test your solution.',
    validator: typanion.isString()
  })

  public solutionName = Option.String('--solution', {
    description: 'The solution name to run.',
    validator: typanion.isString()
  })

  public affected = Option.Boolean('--affected', false, {
    description: 'Only run the tests for the affected files in `git`.'
  })

  public all = Option.Boolean('--all', false, {
    description: 'Run the tests for all the solutions.'
  })

  public base = Option.String('--base', {
    description: 'Base of the current branch (usually master).'
  })

  public async execute(): Promise<number> {
    console.log()
    try {
      await TemporaryFolder.cleanAll()
      if (this.programmingLanguage != null) {
        await template.verifySupportedProgrammingLanguage(
          this.programmingLanguage
        )
      }
      if (this.all) {
        const solutions = await Solution.getManyByProgrammingLanguages(
          this.programmingLanguage != null ? [this.programmingLanguage] : undefined
        )
        return await Test.runManyWithSolutions(solutions)
      }
      if (this.affected) {
        const gitAffected = new GitAffected({
          base: this.base
        })
        const solutions = await gitAffected.getAffectedSolutionsFromGit()
        return await Test.runManyWithSolutions(solutions)
      }
      if (
        this.solutionName == null ||
        this.challenge == null ||
        this.programmingLanguage == null
      ) {
        throw new Error(
          'You must specify all the options (`--challenge`, `--solution`,  `--language`).'
        )
      }
      const solution = await Solution.get({
        name: this.solutionName,
        challengeName: this.challenge,
        programmingLanguageName: this.programmingLanguage
      })
      const result = await solution.test()
      result.print({
        shouldPrintBenchmark: true,
        shouldPrintTableResult: true
      })
      await TemporaryFolder.cleanAll()
      if (result.isSuccess)  {
        console.log(SolutionTestsResult.SUCCESS_MESSAGE)
        return 0
      }
      return 1
    } catch (error) {
      if (error instanceof Error) {
        console.error(`${chalk.bold.red('Error:')} ${error.message}`)
      }
      await TemporaryFolder.cleanAll()
      return 1
    }
  }
}