covert.mjs

#!/usr/bin/env node

import process from 'process';

import { console     } from '../base/index.mjs';
import { Covert      } from './source/Covert.mjs';
import { Linter      } from './source/Linter.mjs';
import { ENVIRONMENT } from './source/ENVIRONMENT.mjs';



const REVIEWS = [];
const SOURCES = {};

const init = (callback) => {

	import(ENVIRONMENT.project + '/review/index.mjs').then((mod) => {

		let reviews = mod['REVIEWS'] || [];
		if (reviews.length > 0) {
			reviews.forEach((review) => {
				REVIEWS.push(review);
			});
		}

		let sources = mod['SOURCES'] || {};
		if (Object.keys(sources).length > 0) {

			Object.keys(sources).forEach((id) => {
				SOURCES[id] = sources[id];
			});

		}

		callback(true);

	}).catch((err) => {

		console.error('Syntax Error:');
		console.error(err);

		callback(false);

	});

};

const show_help = () => {

	console.info('');
	console.info('Covert');
	console.info('');

	console.log('');
	console.log('Usage: covert [Action] [Identifier...] [--Flag=Value...]');
	console.log('');
	console.log('Usage Notes:');
	console.log('');
	console.log('    Identifier can also have a wildcard ("*") prefix or suffix.  ');
	console.log('    If no Identifier is given, all available Reviews are matched.');
	console.log('');
	console.log('Available Actions:');
	console.log('');
	console.log('    Action     | Description                                              ');
	console.log('    -----------|----------------------------------------------------------');
	console.log('    check      | Checks reviews and lints and their tests.                ');
	console.log('    inspect    | Short syntax for scan "..." --debug=true --inspect="...".');
	console.log('    scan       | Scans reviews and executes their tests.                  ');
	console.log('    time       | Scans reviews and benchmarks their test timelines.       ');
	console.log('');
	console.log('Available Flags:');
	console.log('');
	console.log('    Flag       | Default | Values         | Description                                                          ');
	console.log('    -----------|---------|----------------|----------------------------------------------------------------------');
	console.log('    --debug    | false   | true, false    | Enable/Disable debug messages. Defaulted with false.                 ');
	console.log('    --inspect  | null    | "(Test Name)"  | Enable/Disable inspector to debug a single test. Defaulted with null.');
	console.log('    --internet | true    | true, false    | Enable/Disable internet usage. Defaulted with true.                  ');
	console.log('    --network  | null    | 1G, 2G, 3G, 4G | Simulate network behaviour. Defaulted with null.                     ');
	console.log('    --report   | null    | "(File Path)"  | Save a copy of the Covert Report to a file. Defaulted with null.     ');
	console.log('    --timeout  | 10s     | (Number)s      | Override test completion timeout. Defaulted with 10s.                ');
	console.log('');
	console.log('Examples:');
	console.log('');
	console.log('    cd /path/to/stealth;');
	console.log('    cd ./stealth;');
	console.log('');
	console.log('    covert check stealth/client/* --debug=true;');
	console.log('    covert scan stealth/connection/*;');
	console.log('    covert time stealth/connection/DNS --network=2G;');
	console.log('');
	console.log('    covert scan stealth/Session --debug=true --inspect="Session.prototype.get()";');
	console.log('    covert scan --internet=false;');
	console.log('');
	console.log('    # The following two commands are equivalent');
	console.log('    covert scan stealth/connection/DNS --debug=true --inspect="DNS.receive()/client/A" --internet=true --timeout="60s"');
	console.log('    covert inspect stealth/connection/DNS "DNS.receive()/client/A"');
	console.log('');


	if (ENVIRONMENT.flags.debug === true) {

		console.log('Available Reviews:');
		console.log('');

		let namespace = null;

		REVIEWS.forEach((review) => {

			let ns = review.id.split('/')[0];

			console.log('    ' + review.id);

			if (namespace === null) {
				namespace = ns;
			} else if (namespace !== ns) {
				console.log('');
				namespace = ns;
			}

		});

		console.log('');

	}

};



init((result) => {

	if (result === false || REVIEWS.length === 0) {

		console.error('');
		console.error('covert: Covert\'s index.mjs is an invalid ECMAScript Module.');
		console.error('covert: Exported constant REVIEWS must be an Array of Reviews.');
		console.error('covert: Exported constant SOURCES must be an Object of Identifier Mappings.');
		console.error('');

		console.log('');
		console.info('covert: Change the current working directory to the Project\'s root folder.');
		console.info('covert: Ensure that "./review/index.mjs" is a valid ECMAScript Module.');
		console.log('');

		process.exit(1);

	} else if (ENVIRONMENT.action === 'check') {

		let linter = new Linter({
			action:   ENVIRONMENT.action       || null,
			debug:    ENVIRONMENT.flags.debug  || false,
			patterns: ENVIRONMENT.patterns     || [],
			project:  ENVIRONMENT.project      || null,
			report:   ENVIRONMENT.flags.report || null,
			reviews:  REVIEWS,
			sources:  SOURCES
		});

		linter.on('disconnect', (reviews) => {

			if (ENVIRONMENT.flags.report !== null) {

				linter.destroy();
				process.exit(0);

			} else {

				if (reviews.length > 0) {
					process.exit(linter.destroy() || 0);
				} else {
					process.exit(1);
				}

			}

		});

		linter.connect();

	} else if (ENVIRONMENT.action === 'inspect') {

		let patterns = ENVIRONMENT.patterns.slice();
		if (patterns.length === 2) {

			let covert = new Covert({
				action:   'scan',
				debug:    true,
				inspect:  patterns[1],
				internet: true,
				network:  ENVIRONMENT.flags.network  || null,
				patterns: [ patterns[0] ],
				project:  ENVIRONMENT.project        || null,
				report:   ENVIRONMENT.flags.report   || null,
				reviews:  REVIEWS,
				sources:  SOURCES,
				timeout:  '60s'
			});

			covert.on('disconnect', (reviews) => {

				if (ENVIRONMENT.flags.report !== null) {

					covert.destroy();
					process.exit(0);

				} else {

					if (reviews.length > 0) {
						process.exit(covert.destroy() || 0);
					} else {
						process.exit(1);
					}

				}

			});

			covert.connect();

		} else if (patterns.length === 1) {

			let reviews = REVIEWS.filter((review) => review.matches(patterns[0]));
			if (reviews.length > 0) {

				console.info('Covert: Review Pattern matches ' + reviews.length + ' Review(s).');
				console.error('Covert: No Test Pattern selected.');

				console.log('');
				console.log('Covert: Listing available Test(s) ...');
				console.log('');

				reviews.forEach((review) => {

					let tests = review.flatten();

					console.info('- Review "' + review.id + '" has ' + tests.length + ' tests.');

					tests.forEach((test) => {
						console.log('- Test "' + test.name + '" has ' + test.results.length + ' assert() calls.');
					});

				});

			} else {

				console.error('Covert: Review Pattern matches no Review(s).');
				console.error('Covert: No Test Pattern selected.');

			}

			process.exit(1);

		} else if (patterns.length === 0) {

			console.error('Covert: No Review Pattern selected.');
			console.error('Covert: No Test Pattern selected.');

			console.log('');
			console.log('Covert: Listing available Review(s) ...');
			console.log('');

			REVIEWS.forEach((review) => {

				let tests = review.flatten();

				console.log('- Review "' + review.id + '" has ' + tests.length + ' tests.');

			});

			process.exit(1);

		}

	} else if (ENVIRONMENT.action === 'scan' || ENVIRONMENT.action === 'time') {

		let covert = new Covert({
			action:   ENVIRONMENT.action         || null,
			debug:    ENVIRONMENT.flags.debug    || false,
			inspect:  ENVIRONMENT.flags.inspect  || null,
			internet: ENVIRONMENT.flags.internet || null,
			network:  ENVIRONMENT.flags.network  || null,
			patterns: ENVIRONMENT.patterns       || [],
			project:  ENVIRONMENT.project        || null,
			report:   ENVIRONMENT.flags.report   || null,
			reviews:  REVIEWS,
			sources:  SOURCES,
			timeout:  ENVIRONMENT.flags.timeout  || null
		});

		covert.on('disconnect', (reviews) => {

			if (ENVIRONMENT.flags.report !== null) {

				covert.destroy();
				process.exit(0);

			} else {

				if (reviews.length > 0) {
					process.exit(covert.destroy() || 0);
				} else {
					process.exit(1);
				}

			}

		});

		covert.connect();

	} else {

		show_help();
		process.exit(1);

	}

});