import ms = require('ms'); import {parse, startChain, param} from 'parameter-reducers'; import * as ta from 'type-assertions'; import {getMySqlConfigSync} from '@databases/mysql-config'; import getDatabase, {Options, killDatabase} from '.'; import {execBuffered, spawnBuffered} from 'modern-spawn'; const seconds = (keys: string[], name: TName) => { return param.parsedString(keys, name, (str, key) => { if (/^\d+$/.test(str)) { return {valid: true, value: parseInt(str, 10)}; } try { const value = ms(str); if (value !== undefined) { return {valid: true, value: Math.round(value / 1000)}; } } catch (ex) { // return default error message } return { valid: false, reason: `Expected ${key} to be a valid number of seconds`, }; }); }; const params = startChain() .addParam(param.flag(['-d', '--debug'], 'debug')) .addParam(param.string(['--image'], 'image')) .addParam(param.string(['--containerName'], 'containerName')) .addParam(param.integer(['-p', '--externalPort'], 'externalPort')) .addParam(seconds(['--connectTimeout'], 'connectTimeoutSeconds')) .addParam(param.flag(['-r', '--refresh'], 'refreshImage')) .addParam(param.string(['--user'], 'mysqlUser')) .addParam(param.string(['--password'], 'mysqlPassword')) .addParam(param.string(['--db'], 'mysqlDb')); async function runMigrationsAndAddToEnv(databaseURL: string, debug?: boolean) { const config = getMySqlConfigSync(); const DEFAULT_ENV_VAR = process.env.MYSQL_TEST_ENV_VAR || config.connectionStringEnvironmentVariable; process.env[DEFAULT_ENV_VAR] = databaseURL; const migrationsScript = process.env.MYSQL_TEST_MIGRATIONS_SCRIPT ? process.env.MYSQL_TEST_MIGRATIONS_SCRIPT.split(' ') : config.test.migrationsScript; if (migrationsScript) { console.warn('Running mysql migrations'); if (typeof migrationsScript === 'string') { await execBuffered(migrationsScript, { debug: debug || config.test.debug || false, }).getResult(); } else { await spawnBuffered(migrationsScript[0], migrationsScript.slice(1), { debug: debug || config.test.debug || false, }).getResult(); } } } export async function start(args: string[]) { const parseResult = parse(params, args); if (!parseResult.valid) { console.error(parseResult.reason); return 1; } if (parseResult.rest.length) { console.error(`Unexpected option ${parseResult.rest[0]}`); return 1; } ta.assert< ta.Equal< Pick< Partial, | 'debug' | 'image' | 'containerName' | 'externalPort' | 'connectTimeoutSeconds' | 'refreshImage' | 'mysqlUser' | 'mysqlPassword' | 'mysqlDb' > & {environmentVariable?: string}, typeof parseResult.parsed > >(); const {databaseURL} = await getDatabase({ ...parseResult.parsed, detached: true, }); await runMigrationsAndAddToEnv(databaseURL, parseResult.parsed.debug); console.info(databaseURL); return 0; } export async function run(args: string[]) { const parseResult = parse(params, args); if (!parseResult.valid) { console.error(parseResult.reason); return 1; } const rest = parseResult.rest[0] === '--' ? parseResult.rest.slice(1) : parseResult.rest; if (!rest.length) { console.error(`You must specify a command to run`); return 1; } const {databaseURL, kill} = await getDatabase({ ...parseResult.parsed, detached: true, }); await runMigrationsAndAddToEnv(databaseURL, parseResult.parsed.debug); const result = await spawnBuffered( parseResult.rest[0], parseResult.rest.slice(1), { debug: true, }, ); await kill(); return result.status ?? 0; } const stopParams = startChain() .addParam(param.flag(['-d', '--debug'], 'debug')) .addParam(param.string(['--containerName'], 'containerName')); export async function stop(args: string[]) { const parseResult = parse(stopParams, args); if (!parseResult.valid) { console.error(parseResult.reason); return 1; } if (parseResult.rest.length) { console.error(`Unexpected option ${parseResult.rest[0]}`); return 1; } ta.assert< ta.Equal< Pick, 'debug' | 'containerName'>, typeof parseResult.parsed > >(); await killDatabase({ ...parseResult.parsed, detached: true, }); return 0; } // prettier-ignore export function help(command?: string) { switch (command) { case 'start': console.info(`usage: mysql-test start [-h] ...`); console.info(``); console.info(`Start temporary databases for running tests, using docker`); console.info(``); console.info(`Optional arguments:`); console.info(` -d, --debug Print all the output of child commands.`); console.info(` --image Override the MySQL docker image.`); console.info(` --containerName Specify a custom name for the container.`); console.info(` -p, --externalPort Specify the port to run on.`); console.info(` --connectTimeout How long should we allow for the container`); console.info(` to start. You can specify a raw number in`); console.info(` seconds, or a time string like "1 minute"`); console.info(` -r, --refresh Update the cached docker conatiner`); console.info(` --user The mysql user`); console.info(` --password The mysql password`); console.info(` --db The mysql database`); console.info(` -h, --help Show this help message and exit.`); break; case 'run': console.info(`usage: mysql-test run your-command`); console.info(``); console.info(`Run your command with a MySQL database that is disposed of when your command exits`); console.info(``); console.info(`Optional arguments:`); console.info(` -d, --debug Print all the output of child commands.`); console.info(` --image Override the MySQL docker image.`); console.info(` --containerName Specify a custom name for the container.`); console.info(` -p, --externalPort Specify the port to run on.`); console.info(` --connectTimeout How long should we allow for the container`); console.info(` to start. You can specify a raw number in`); console.info(` seconds, or a time string like "1 minute"`); console.info(` -r, --refresh Update the cached docker conatiner`); console.info(` --user The mysql user`); console.info(` --password The mysql password`); console.info(` --db The mysql database`); console.info(` -h, --help Show this help message and exit.`); break; case 'stop': console.info(`usage: mysql-test stop [-h] ...`); console.info(``); console.info(`Stop temporary databases created via mysql-test start`); console.info(``); console.info(`Optional arguments:`); console.info(` -d, --debug Print all the output of child commands.`); console.info(` --containerName Specify a custom name for the container.`); break; default: console.info(`usage: mysql-test [-h] ...`); console.info(``); console.info(`Start temporary databases for running tests using docker`); console.info(``); console.info(`Commands`); console.info(` start Starts a MySQL database`); console.info(` run Run a command with a MySQL database that is disposed of at the end`); console.info(` stop Stops a MySQL database`); console.info(` help Print documentation for commands`); console.info(``); console.info(`Optional arguments:`); console.info(` -h, --help Show this help message and exit.`); console.info(``); console.info(`For detailed help about a specific command, use: mysql-test help `); break; } }