Differential D11724 Diff 34281 arcanist/engine/JestUnitTestEngine.php

Changeset View

Standalone View

arcanist/engine/JestUnitTestEngine.php

This file was added.

				<?php

				final class JestUnitTestEngine extends ArcanistUnitTestEngine {
				const PROCESSOR = '/home/joey/github/abc/bitcoin-abc/web/cashtab/node_modules/jest-phabricator/build/index.js';
				Lint: Generic.Files.LineLength.MaxExceeded Inline Actions Line exceeds maximum limit of 100 characters; contains 113 characters Lint: Generic.Files.LineLength.MaxExceeded: Line exceeds maximum limit of 100 characters; contains 113 characters
				const JEST_PATH = '/home/joey/github/abc/bitcoin-abc/web/cashtab/node_modules/jest/bin/jest.js';
				Lint: Generic.Files.LineLength.TooLong Inline Actions Line exceeds 80 characters; contains 98 characters Lint: Generic.Files.LineLength.TooLong: Line exceeds 80 characters; contains 98 characters
				const TOO_MANY_FILES_TO_COVER = 100;
				const GIGANTIC_DIFF_THRESHOLD = 200;

				public function getEngineConfigurationName() {
				return 'jest';
				}

				private function getRoot() {
				return $this->getWorkingCopy()->getProjectRoot();
				}

				private function getOutputJSON() {
				return $this->getRoot() . '/output.json';
				}

				private function getFutureResults($future) {
				list($stdout, $stderr) = $future->resolvex();
				$output_JSON = $this->getOutputJSON();
				$report_path_exists = file_exists($output_JSON);
				$raw_results = null;

				if ($report_path_exists) {
				$raw_results = json_decode(
				Filesystem::readFile($output_JSON),
				true
				)['coverageMap'];
				Filesystem::remove($output_JSON);
				} else {
				$raw_results = json_decode($stdout, true);
				}

				if (!is_array($raw_results)) {
				throw new Exception("Unit test script emitted invalid JSON: {$stdout}");
				}

				$results = array();
				echo json_encode($raw_results);
				Lint: Generic.WhiteSpace.ScopeIndent.IncorrectExact Inline Actions Line indented incorrectly; expected 4 spaces, found 5 Lint: Generic.WhiteSpace.ScopeIndent.IncorrectExact: Line indented incorrectly; expected 4 spaces, found 5
				foreach ($raw_results as $result) {
				echo json_encode($result);
				$test_result = new ArcanistUnitTestResult();
				echo json_encode($test_result);
				$test_result->setName($result['name']);
				$succeed = isset($result['status']) && $result['status'] == 'passed';
				$test_result->setResult(
				$succeed ?
				ArcanistUnitTestResult::RESULT_PASS :
				ArcanistUnitTestResult::RESULT_FAIL
				);

				if (isset($result['coverage'])) {
				$coverage = array();
				$root = $this->getRoot() . '/';
				foreach ($result['coverage'] as $file_path => $coverage_data) {
				if (substr($file_path, 0, strlen($root)) == $root) {
				$file_path = substr($file_path, strlen($root));
				}
				$coverage[$file_path] = $coverage_data;
				}
				Lint: Generic.WhiteSpace.ScopeIndent.IncorrectExact Inline Actions Line indented incorrectly; expected 8 spaces, found 7 Lint: Generic.WhiteSpace.ScopeIndent.IncorrectExact: Line indented incorrectly; expected 8 spaces, found 7
				$test_result->setCoverage($coverage);
				Lint: Generic.WhiteSpace.ScopeIndent.IncorrectExact Inline Actions Line indented incorrectly; expected 8 spaces, found 7 Lint: Generic.WhiteSpace.ScopeIndent.IncorrectExact: Line indented incorrectly; expected 8 spaces, found 7
				}
				Lint: Generic.WhiteSpace.ScopeIndent.IncorrectExact Inline Actions Line indented incorrectly; expected 6 spaces, found 5 Lint: Generic.WhiteSpace.ScopeIndent.IncorrectExact: Line indented incorrectly; expected 6 spaces, found 5
				$test_result->setUserData($result['message']);
				Lint: Generic.WhiteSpace.ScopeIndent.IncorrectExact Inline Actions Line indented incorrectly; expected 6 spaces, found 5 Lint: Generic.WhiteSpace.ScopeIndent.IncorrectExact: Line indented incorrectly; expected 6 spaces, found 5
				$results[] = $test_result;
				Lint: Generic.WhiteSpace.ScopeIndent.IncorrectExact Inline Actions Line indented incorrectly; expected 6 spaces, found 5 Lint: Generic.WhiteSpace.ScopeIndent.IncorrectExact: Line indented incorrectly; expected 6 spaces, found 5
				}
				Lint: Generic.WhiteSpace.ScopeIndent.IncorrectExact Inline Actions Line indented incorrectly; expected 4 spaces, found 3 Lint: Generic.WhiteSpace.ScopeIndent.IncorrectExact: Line indented incorrectly; expected 4 spaces, found 3

				return $results;
				}

				private function runCommands($commands) {
				$futures = array();
				foreach ($commands as $command) {
				$bin = $command['bin'];
				$options = implode(' ', $command['options']);
				$paths = $command['paths'];
				$futures[] = new ExecFuture("{$bin} {$options} %Ls", $paths);
				}

				$console = PhutilConsole::getConsole();

				// Pass stderr through so we can give the user updates on test
				// status as tests run.
				$completed = array();
				$iterator = new FutureIterator($futures);
				foreach ($iterator->setUpdateInterval(0.2) as $_) {
				foreach ($futures as $key => $future) {
				if (isset($completed[$key])) {
				continue;
				}
				if ($future->isReady()) {
				$completed[$key] = true;
				}
				list(, $stderr) = $future->read();
				$console->writeErr('%s', $stderr);
				break;
				}
				}
				// Finish printing output for remaining futures
				foreach ($futures as $key => $future) {
				if (!isset($completed[$key])) {
				list(, $stderr) = $future->read();
				$console->writeErr('%s', $stderr);
				}
				}
				$results = array();
				foreach ($futures as $future) {
				$results[] = $this->getFutureResults($future);
				}

				if (empty($results)) {
				return array();
				}
				return call_user_func_array('array_merge', $results);
				}

				private function runJSTests() {
				$console = PhutilConsole::getConsole();
				$root = $this->getRoot();

				$result_arrays = [];
				$paths = $this->getPaths();
				$jest_paths = array();
				foreach ($paths as $path) {
				$ext = idx(pathinfo($path), 'extension');
				if ($ext === 'js' \|\| $ext === 'json') {
				// Filter deleted modules because Jest can't do anything with them.
				if (file_exists("$root/$path")) {
				$jest_paths[] = "$root/$path";
				}
				}
				}

				$commands = [];
				if (count($jest_paths) > self::GIGANTIC_DIFF_THRESHOLD) {
				$console->writeOut("Too many files, skipping JavaScript tests.\n");
				$result_arrays[] = array();
				} else {
				if (count($jest_paths) > 0) {
				$console->writeOut("Running JavaScript tests.\n");
				$commands[] = array(
				'bin' => self::JEST_PATH,
				'options' => $this->getJestOptions($jest_paths),
				'paths' => $jest_paths,
				);
				}

				try {
				$result_arrays[] = $this->runCommands($commands);
				$console->writeOut("try loop?\n");
				} catch (Exception $e) {
				$console->writeOut("exception loop\n");
				$console->writeErr('%s', $e);
				// Ignore the exception in case of failing tests
				// As Jest should have already printed the results.
				$result = new ArcanistUnitTestResult();
				$result->setName('JavaScript tests');
				$result->setResult(ArcanistUnitTestResult::RESULT_FAIL);
				$result->setDuration(0);
				$result_arrays[] = array($result);
				}
				}

				$console->writeOut("Finished tests.\n");
				//$console->writeErr(implode(', ', $result_arrays));
				return call_user_func_array('array_merge', $result_arrays);
				}

				private function getJestOptions($paths) {
				$output_JSON = $this->getOutputJSON();
				$options = array(
				'--colors',
				'--config=web/cashtab/package.json',
				'--json',
				'--passWithNoTests true',
				'--outputFile=' . $output_JSON,
				'--testResultsProcessor=' . self::PROCESSOR
				);

				// Checks for the number of files to cover, in case it's too big skips coverage
				Lint: Generic.Files.LineLength.TooLong Inline Actions Line exceeds 80 characters; contains 83 characters Lint: Generic.Files.LineLength.TooLong: Line exceeds 80 characters; contains 83 characters
				// A better solution would involve knowing what's the machine buffer size limit
				Lint: Generic.Files.LineLength.TooLong Inline Actions Line exceeds 80 characters; contains 83 characters Lint: Generic.Files.LineLength.TooLong: Line exceeds 80 characters; contains 83 characters
				// for exec and check if the command can stay within it.
				if (count($paths) < self::TOO_MANY_FILES_TO_COVER) {
				$options[] = '--findRelatedTests ' . join(' ', $paths);
				$options[] = '--coverage';
				$options[] = '--collectCoverageOnlyFrom '. join(' ', $paths);
				}

				return $options;
				}

				/** @Override */
				Lint: Generic.Commenting.DocComment.ContentAfterOpen Inline Actions The open comment tag must be the only content on the line Lint: Generic.Commenting.DocComment.ContentAfterOpen: The open comment tag must be the only content on the line
				Lint: Generic.Commenting.DocComment.MissingShort Inline Actions Missing short description in doc comment Lint: Generic.Commenting.DocComment.MissingShort: Missing short description in doc comment
				Lint: Generic.Commenting.DocComment.ContentBeforeClose Inline Actions The close comment tag must be the only content on the line Lint: Generic.Commenting.DocComment.ContentBeforeClose: The close comment tag must be the only content on the line
				public function run() {
				return self::runJSTests();
				}
				}