123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331 |
- 'use strict'
- const path = require('path')
- const yargs = require('yargs')
- const fs = require('graceful-fs')
- const Server = require('./server')
- const helper = require('./helper')
- const constant = require('./constants')
- const cfg = require('./config')
- function processArgs (argv, options, fs, path) {
- Object.getOwnPropertyNames(argv).forEach(function (name) {
- let argumentValue = argv[name]
- if (name !== '_' && name !== '$0') {
- if (Array.isArray(argumentValue)) {
- argumentValue = argumentValue.pop() // If the same argument is defined multiple times, override.
- }
- options[helper.dashToCamel(name)] = argumentValue
- }
- })
- if (helper.isString(options.autoWatch)) {
- options.autoWatch = options.autoWatch === 'true'
- }
- if (helper.isString(options.colors)) {
- options.colors = options.colors === 'true'
- }
- if (helper.isString(options.failOnEmptyTestSuite)) {
- options.failOnEmptyTestSuite = options.failOnEmptyTestSuite === 'true'
- }
- if (helper.isString(options.failOnFailingTestSuite)) {
- options.failOnFailingTestSuite = options.failOnFailingTestSuite === 'true'
- }
- if (helper.isString(options.formatError)) {
- let required
- try {
- required = require(options.formatError)
- } catch (err) {
- console.error('Could not require formatError: ' + options.formatError, err)
- }
- // support exports.formatError and module.exports = function
- options.formatError = required.formatError || required
- if (!helper.isFunction(options.formatError)) {
- console.error(`Format error must be a function, got: ${typeof options.formatError}`)
- process.exit(1)
- }
- }
- if (helper.isString(options.logLevel)) {
- const logConstant = constant['LOG_' + options.logLevel.toUpperCase()]
- if (helper.isDefined(logConstant)) {
- options.logLevel = logConstant
- } else {
- console.error('Log level must be one of disable, error, warn, info, or debug.')
- process.exit(1)
- }
- } else if (helper.isDefined(options.logLevel)) {
- console.error('Log level must be one of disable, error, warn, info, or debug.')
- process.exit(1)
- }
- if (helper.isString(options.singleRun)) {
- options.singleRun = options.singleRun === 'true'
- }
- if (helper.isString(options.browsers)) {
- options.browsers = options.browsers.split(',')
- }
- if (options.reportSlowerThan === false) {
- options.reportSlowerThan = 0
- }
- if (helper.isString(options.reporters)) {
- options.reporters = options.reporters.split(',')
- }
- if (helper.isString(options.removedFiles)) {
- options.removedFiles = options.removedFiles.split(',')
- }
- if (helper.isString(options.addedFiles)) {
- options.addedFiles = options.addedFiles.split(',')
- }
- if (helper.isString(options.changedFiles)) {
- options.changedFiles = options.changedFiles.split(',')
- }
- if (helper.isString(options.refresh)) {
- options.refresh = options.refresh === 'true'
- }
- let configFile = argv.configFile
- if (!configFile) {
- // default config file (if exists)
- if (fs.existsSync('./karma.conf.js')) {
- configFile = './karma.conf.js'
- } else if (fs.existsSync('./karma.conf.coffee')) {
- configFile = './karma.conf.coffee'
- } else if (fs.existsSync('./karma.conf.ts')) {
- configFile = './karma.conf.ts'
- } else if (fs.existsSync('./.config/karma.conf.js')) {
- configFile = './.config/karma.conf.js'
- } else if (fs.existsSync('./.config/karma.conf.coffee')) {
- configFile = './.config/karma.conf.coffee'
- } else if (fs.existsSync('./.config/karma.conf.ts')) {
- configFile = './.config/karma.conf.ts'
- }
- }
- options.configFile = configFile ? path.resolve(configFile) : null
- if (options.cmd === 'run') {
- options.clientArgs = parseClientArgs(process.argv)
- }
- return options
- }
- function parseClientArgs (argv) {
- // extract any args after '--' as clientArgs
- let clientArgs = []
- argv = argv.slice(2)
- const idx = argv.indexOf('--')
- if (idx !== -1) {
- clientArgs = argv.slice(idx + 1)
- }
- return clientArgs
- }
- // return only args that occur before `--`
- function argsBeforeDoubleDash (argv) {
- const idx = argv.indexOf('--')
- return idx === -1 ? argv : argv.slice(0, idx)
- }
- function describeRoot () {
- return yargs
- .usage('Karma - Spectacular Test Runner for JavaScript.\n\n' +
- 'Run --help with particular command to see its description and available options.\n\n' +
- 'Usage:\n' +
- ' $0 <command>')
- .command('init [configFile]', 'Initialize a config file.', describeInit)
- .command('start [configFile]', 'Start the server / do a single run.', describeStart)
- .command('run [configFile]', 'Trigger a test run.', describeRun)
- .command('stop [configFile]', 'Stop the server.', describeStop)
- .command('completion', 'Shell completion for karma.', describeCompletion)
- .demandCommand(1, 'Command not specified.')
- .strictCommands()
- .describe('help', 'Print usage and options.')
- .describe('version', 'Print current version.')
- }
- function describeInit (yargs) {
- yargs
- .usage('Karma - Spectacular Test Runner for JavaScript.\n\n' +
- 'INIT - Initialize a config file.\n\n' +
- 'Usage:\n' +
- ' $0 init [configFile]')
- .strictCommands(false)
- .version(false)
- .positional('configFile', {
- describe: 'Name of the generated Karma configuration file',
- type: 'string'
- })
- .describe('log-level', '<disable | error | warn | info | debug> Level of logging.')
- .describe('colors', 'Use colors when reporting and printing logs.')
- .describe('no-colors', 'Do not use colors when reporting or printing logs.')
- }
- function describeStart (yargs) {
- yargs
- .usage('Karma - Spectacular Test Runner for JavaScript.\n\n' +
- 'START - Start the server / do a single run.\n\n' +
- 'Usage:\n' +
- ' $0 start [configFile]')
- .strictCommands(false)
- .version(false)
- .positional('configFile', {
- describe: 'Path to the Karma configuration file',
- type: 'string'
- })
- .describe('port', '<integer> Port where the server is running.')
- .describe('auto-watch', 'Auto watch source files and run on change.')
- .describe('detached', 'Detach the server.')
- .describe('no-auto-watch', 'Do not watch source files.')
- .describe('log-level', '<disable | error | warn | info | debug> Level of logging.')
- .describe('colors', 'Use colors when reporting and printing logs.')
- .describe('no-colors', 'Do not use colors when reporting or printing logs.')
- .describe('reporters', 'List of reporters (available: dots, progress, junit, growl, coverage).')
- .describe('browsers', 'List of browsers to start (eg. --browsers Chrome,ChromeCanary,Firefox).')
- .describe('capture-timeout', '<integer> Kill browser if does not capture in given time [ms].')
- .describe('single-run', 'Run the test when browsers captured and exit.')
- .describe('no-single-run', 'Disable single-run.')
- .describe('report-slower-than', '<integer> Report tests that are slower than given time [ms].')
- .describe('fail-on-empty-test-suite', 'Fail on empty test suite.')
- .describe('no-fail-on-empty-test-suite', 'Do not fail on empty test suite.')
- .describe('fail-on-failing-test-suite', 'Fail on failing test suite.')
- .describe('no-fail-on-failing-test-suite', 'Do not fail on failing test suite.')
- .option('format-error', {
- describe: 'A path to a file that exports the format function.',
- type: 'string'
- })
- }
- function describeRun (yargs) {
- yargs
- .usage('Karma - Spectacular Test Runner for JavaScript.\n\n' +
- 'RUN - Run the tests (requires running server).\n\n' +
- 'Usage:\n' +
- ' $0 run [configFile] [-- <clientArgs>]')
- .strictCommands(false)
- .version(false)
- .positional('configFile', {
- describe: 'Path to the Karma configuration file',
- type: 'string'
- })
- .describe('port', '<integer> Port where the server is listening.')
- .describe('no-refresh', 'Do not re-glob all the patterns.')
- .describe('fail-on-empty-test-suite', 'Fail on empty test suite.')
- .describe('no-fail-on-empty-test-suite', 'Do not fail on empty test suite.')
- .describe('log-level', '<disable | error | warn | info | debug> Level of logging.')
- .describe('colors', 'Use colors when reporting and printing logs.')
- .describe('no-colors', 'Do not use colors when reporting or printing logs.')
- .option('removed-files', {
- describe: 'Comma-separated paths to removed files. Useful when automatic file watching is disabled.',
- type: 'string'
- })
- .option('changed-files', {
- describe: 'Comma-separated paths to changed files. Useful when automatic file watching is disabled.',
- type: 'string'
- })
- .option('added-files', {
- describe: 'Comma-separated paths to added files. Useful when automatic file watching is disabled.',
- type: 'string'
- })
- }
- function describeStop (yargs) {
- yargs
- .usage('Karma - Spectacular Test Runner for JavaScript.\n\n' +
- 'STOP - Stop the server (requires running server).\n\n' +
- 'Usage:\n' +
- ' $0 stop [configFile]')
- .strictCommands(false)
- .version(false)
- .positional('configFile', {
- describe: 'Path to the Karma configuration file',
- type: 'string'
- })
- .describe('port', '<integer> Port where the server is listening.')
- .describe('log-level', '<disable | error | warn | info | debug> Level of logging.')
- }
- function describeCompletion (yargs) {
- yargs
- .usage('Karma - Spectacular Test Runner for JavaScript.\n\n' +
- 'COMPLETION - Bash/ZSH completion for karma.\n\n' +
- 'Installation:\n' +
- ' $0 completion >> ~/.bashrc')
- .version(false)
- }
- function printRunnerProgress (data) {
- process.stdout.write(data)
- }
- exports.process = () => {
- const argv = describeRoot().parse(argsBeforeDoubleDash(process.argv.slice(2)))
- return processArgs(argv, { cmd: argv._.shift() }, fs, path)
- }
- exports.run = async () => {
- const cliOptions = exports.process()
- const cmd = cliOptions.cmd // prevent config from changing the command
- const cmdNeedsConfig = cmd === 'start' || cmd === 'run' || cmd === 'stop'
- if (cmdNeedsConfig) {
- let config
- try {
- config = await cfg.parseConfig(
- cliOptions.configFile,
- cliOptions,
- {
- promiseConfig: true,
- throwErrors: true
- }
- )
- } catch (karmaConfigException) {
- // The reject reason/exception isn't used to log a message since
- // parseConfig already calls a configured logger method with an almost
- // identical message.
- // The `run` function is a private application, not a public API. We don't
- // need to worry about process.exit vs throw vs promise rejection here.
- process.exit(1)
- }
- switch (cmd) {
- case 'start': {
- const server = new Server(config)
- await server.start()
- return server
- }
- case 'run':
- return require('./runner')
- .run(config)
- .on('progress', printRunnerProgress)
- case 'stop':
- return require('./stopper').stop(config)
- }
- } else {
- switch (cmd) {
- case 'init':
- return require('./init').init(cliOptions)
- case 'completion':
- return require('./completion').completion(cliOptions)
- }
- }
- }
- // just for testing
- exports.processArgs = processArgs
- exports.parseClientArgs = parseClientArgs
- exports.argsBeforeDoubleDash = argsBeforeDoubleDash
|