Differential D13949 Diff 33668 src/unit/engine/MochaTestEngine.php

Changeset View

Standalone View

src/unit/engine/MochaTestEngine.php

This file was added.

				<?php
				/**
				joshuaspenceUnsubmitted Done Inline Actions There should be a blank line between `<?php` and any code, see D13534. joshuaspence: There should be a blank line between `<?php` and any code, see D13534.
				* Uses mocha (https://mochajs.org/) to test Javascript code.
				* Uses istanbul (https://gotwarlost.github.io/istanbul/) to cover Javascript
				joshuaspenceUnsubmitted Done Inline Actions Prefer to write this as `[[https://mochajs.org/ \| Mocha]]`. joshuaspence: Prefer to write this as `[[https://mochajs.org/ \| Mocha]]`.
				* code.
				joshuaspenceUnsubmitted Done Inline Actions Prefer to write this as `[[https://gotwarlost.github.io/istanbul/ \| Istanbul]]` joshuaspence: Prefer to write this as `[[https://gotwarlost.github.io/istanbul/ \| Istanbul]]`
				*
				* Assumes that when modifying a file with a path like `SomeDir/SomeFile.js`,
				* that the unit test that verifies the functionality of `SomeFile` is
				* located at `SomeDir/__tests__/SomeFile-test.js`.
				*
				* @concrete-extensible
				*/
				joshuaspenceUnsubmitted Done Inline Actions This isn't quite correct. `@concrete-extensible` only makes sense for non-`final`, non-`abstract` classes. joshuaspence: This isn't quite correct. `@concrete-extensible` only makes sense for non-`final`, non…
				final class MochaTestEngine extends ArcanistUnitTestEngine {

				private $projectRoot;

				/**
				* Return the name of the test engine.
				joshuaspenceUnsubmitted Done Inline Actions See my next comment. joshuaspence: See my next comment.
				* So it can be used in ArcanistConfigurationDrivenUnitTestEngine later.
				*/
				public function getEngineConfigurationName() {
				return 'mocha';
				}

				/**
				joshuaspenceUnsubmitted Done Inline Actions Personally, I find this comment to be fairly useless and somewhat distracting. In this particular case, I don't think the comment provides any explanation that the code does not. joshuaspence: Personally, I find this comment to be fairly useless and somewhat distracting. In this…
				* This test engine supports running all tests.
				*/
				protected function supportsRunAllTests() {
				return true;
				}

				/**
				* Main entry point for the test engine. Determines what files changed
				* and test based on the files that have changed.
				* @return array Array of test results.
				* @throws ArcanistNoEffectException
				* @throws CommandException
				*/
				public function run() {
				/*
				* Determine whether it shall run all the test or more precisely the
				* modified file
				joshuaspenceUnsubmitted Done Inline Actions IMO, this doesn't provide any value. joshuaspence: IMO, this doesn't provide any value.
				tycho.tatitscheffAuthorUnsubmitted Done Inline Actions Will get rid of all this useless comments :) tycho.tatitscheff: Will get rid of all this useless comments :)
				*
				*/
				if (!$this->getRunAllTests()) {
				$pattern_tests = $this->getAllTestsPattern();
				} else {
				$pattern_tests = $this->getGranularTestsPattern();
				}
				/*
				joshuaspenceUnsubmitted Done Inline Actions As above. joshuaspence: As above.
				* Throw an error if there is no test that can be run
				*/
				if (!$pattern_tests) {
				throw new ArcanistNoEffectException(pht('No tests to run.'));
				}
				/*
				joshuaspenceUnsubmitted Done Inline Actions As aabove. joshuaspence: As aabove.
				* Retrieve working copy and project root path
				*/
				$working_copy = $this->getWorkingCopy();
				$this->$projectRoot = $working_copy->getProjectRoot();
				Lint: Use of Undeclared Variable Inline Actions Declare variables prior to use (even if you are passing them as reference parameters). You may have misspelled this variable name. Lint: Use of Undeclared Variable: Declare variables prior to use (even if you are passing them as reference parameters). You may…
				Lint: Naming Conventions Inline Actions Follow naming conventions: variables should be named using lowercase_with_underscores. Lint: Naming Conventions: Follow naming conventions: variables should be named using lowercase_with_underscores.
				/*
				* Create new temp-file paths to receive junit test result
				joshuaspenceUnsubmitted Done Inline Actions As above. joshuaspence: As above.
				* and lcov coverage result only if coverage is activated.
				*/
				$junit_tmp = new TempFile();
				joshuaspenceUnsubmitted Done Inline Actions Why not just `if ($this->getEnableCoverage()) {` ? joshuaspence: Why not just `if ($this->getEnableCoverage()) {` ?
				tycho.tatitscheffAuthorUnsubmitted Done Inline Actions Indeed ! tycho.tatitscheff: Indeed !
				$cover_tmp = null;
				if ($this->getEnableCoverage() !== false) {
				$cover_tmp = Filesystem::resolvePath('./coverage/lcov.info',
				$this->projectRoot);
				}

				$future = $this->buildTestFuture($pattern_tests, $junit_tmp);
				list($err, $stdout, $stderr) = $future->resolve();

				/*
				joshuaspenceUnsubmitted Done Inline Actions As above. joshuaspence: As above.
				* Check that the future output desired files
				*/
				if (!Filesystem::pathExists($junit_tmp)) {
				throw new CommandException(
				pht('Testing Command failed with error #%s!', $err),
				$future->getCommand(),
				$err,
				$stdout,
				$stderr);
				joshuaspenceUnsubmitted Done Inline Actions As above. joshuaspence: As above.
				}
				if ($this->getEnableCoverage() !== false) {
				if (!Filesystem::pathExists($cover_tmp)) {
				throw new CommandException(
				pht('Coverage Command failed with error #%s!', $err),
				$future->getCommand(),
				$err,
				$stdout,
				$stderr);
				}
				}

				return $this->parseTestResults($junit_tmp, $cover_tmp);
				}

				/**
				* Return pattern for retrieving test files
				* If special pattern isn't set in configuration file, it is defaulted
				*/
				private function getAllTestsPattern() {
				joshuaspenceUnsubmitted Done Inline Actions This should (later) come from `arclint`. joshuaspence: This should (later) come from `arclint`.
				tycho.tatitscheffAuthorUnsubmitted Done Inline Actions And get getConfigFromAnySource won't be froward compatible with `.arclint` and D13534 ? I will look forward to see the correct API. tycho.tatitscheff: And get getConfigFromAnySource won't be froward compatible with `.arclint` and D13534 ? I will…
				$pattern = $this->getConfigurationManager()
				->getConfigFromAnySource('unit.mocha.pattern');
				if (!$pattern) {
				$pattern = '/tests/*.spec.js';
				}
				return $pattern;
				}

				/**
				* This test engine supports running all tests.
				*/
				private function getGranularTestsPattern() {
				// TODO : build something really granular.
				Lint: TODO Comment Inline Actions This comment has a TODO. Lint: TODO Comment: This comment has a TODO.
				return $this->getAllTestsPattern();
				}


				private function buildTestFuture($pattern_tests, $junit_tmp) {
				$cmd_line = csprintf(
				'MOCHA_FILE=%s'.
				'mocha test --reporter mocha-junit-reporter -u exports -R %s',
				$junit_tmp);

				if ($this->getEnableCoverage() !== false) {
				$cmd_line = csprintf(
				'MOCHA_FILE=%s'.
				'ISTANBUL_REPORTERS=cobertura'.
				'istanbul cover _mocha'.
				'-- -u exports -R %s',
				$junit_tmp);
				}
				joshuaspenceUnsubmitted Done Inline Actions I'm not sure about `&&`... particularly I'm not sure if this will work on Windows. joshuaspence: I'm not sure about `&&`... particularly I'm not sure if this will work on Windows.
				tycho.tatitscheffAuthorUnsubmitted Done Inline Actions On production I have an other syntax that works on windows too. I will switch for this. tycho.tatitscheff: On production I have an other syntax that works on windows too. I will switch for this.

				return new ExecFuture('%C %s', $cmd_line, $pattern_tests);
				}
				joshuaspenceUnsubmitted Done Inline Actions This is equivalent to `ExecFuture($cmd_line)` joshuaspence: This is equivalent to `ExecFuture($cmd_line)`

				private function parseTestResults($junit_tmp, $cover_tmp) {
				$parser = new ArcanistXUnitTestResultParser();
				$results = $parser->parseTestResults(Filesystem::readFile($junit_tmp));
				if ($this->getEnableCoverage() !== false) {
				$coverage = $this->readCoverage($cover_tmp);
				foreach ($results as $result) {
				$result->setCoverage($coverage);
				}
				}
				return $results;
				}

				/**
				* TODO: This is copied from @{class:NoseTestEngine}.
				Lint: TODO Comment Inline Actions This comment has a TODO. Lint: TODO Comment: This comment has a TODO.
				* I didn't ever try to understand what is going on.
				*/
				public function readCoverage($cover_file) {
				$coverage_dom = new DOMDocument();
				$coverage_dom->loadXML(Filesystem::readFile($cover_file));

				$reports = array();
				$classes = $coverage_dom->getElementsByTagName('class');

				foreach ($classes as $class) {
				$path = $class->getAttribute('filename');
				$root = $this->getWorkingCopy()->getProjectRoot();

				if (!Filesystem::isDescendant($path, $root)) {
				continue;
				}

				// get total line count in file
				$lines_list = phutil_split_lines(Filesystem::readFile($path));
				$line_count = count($lines_list);

				$coverage = '';
				$start_line = 1;
				$lines = $class->getElementsByTagName('line');
				for ($ii = 0; $ii < $lines->length; $ii++) {
				$line = $lines->item($ii);

				$next_line = intval($line->getAttribute('number'));
				for ($start_line; $start_line < $next_line; $start_line++) {
				$coverage .= 'N';
				}

				if (intval($line->getAttribute('hits')) == 0) {
				$coverage .= 'U';
				} else if (intval($line->getAttribute('hits')) > 0) {
				$coverage .= 'C';
				}

				$start_line++;
				}

				if ($start_line < $line_count) {
				foreach (range($start_line, $line_count) as $line_num) {
				$coverage .= 'N';
				}
				}

				$reports[$path] = $coverage;
				}

				return $reports;
				}
				}