diff --git a/src/lint/ArcanistLintMessage.php b/src/lint/ArcanistLintMessage.php index c92c5ec8..cc9e58fb 100644 --- a/src/lint/ArcanistLintMessage.php +++ b/src/lint/ArcanistLintMessage.php @@ -1,371 +1,378 @@ setPath($dict['path']); - $message->setLine($dict['line']); - $message->setChar($dict['char']); + + if (isset($dict['line'])) { + $message->setLine($dict['line']); + } + + if (isset($dict['char'])) { + $message->setChar($dict['char']); + } + $message->setCode($dict['code']); $message->setSeverity($dict['severity']); $message->setName($dict['name']); $message->setDescription($dict['description']); if (isset($dict['original'])) { $message->setOriginalText($dict['original']); } if (isset($dict['replacement'])) { $message->setReplacementText($dict['replacement']); } $message->setGranularity(idx($dict, 'granularity')); $message->setOtherLocations(idx($dict, 'locations', array())); if (isset($dict['bypassChangedLineFiltering'])) { $message->setBypassChangedLineFiltering( $dict['bypassChangedLineFiltering']); } return $message; } public function toDictionary() { return array( 'path' => $this->getPath(), 'line' => $this->getLine(), 'char' => $this->getChar(), 'code' => $this->getCode(), 'severity' => $this->getSeverity(), 'name' => $this->getName(), 'description' => $this->getDescription(), 'original' => $this->getOriginalText(), 'replacement' => $this->getReplacementText(), 'granularity' => $this->getGranularity(), 'locations' => $this->getOtherLocations(), 'bypassChangedLineFiltering' => $this->shouldBypassChangedLineFiltering(), ); } public function setPath($path) { $this->path = $path; return $this; } public function getPath() { return $this->path; } public function setLine($line) { $this->line = $this->validateInteger($line, 'setLine'); return $this; } public function getLine() { return $this->line; } public function setChar($char) { $this->char = $this->validateInteger($char, 'setChar'); return $this; } public function getChar() { return $this->char; } public function setCode($code) { $code = (string)$code; $maximum_bytes = 128; $actual_bytes = strlen($code); if ($actual_bytes > $maximum_bytes) { throw new Exception( pht( 'Parameter ("%s") passed to "%s" when constructing a lint message '. 'must be a scalar with a maximum string length of %s bytes, but is '. '%s bytes in length.', $code, 'setCode()', new PhutilNumber($maximum_bytes), new PhutilNumber($actual_bytes))); } $this->code = $code; return $this; } public function getCode() { return $this->code; } public function setSeverity($severity) { $this->severity = $severity; return $this; } public function getSeverity() { return $this->severity; } public function setName($name) { $maximum_bytes = 255; $actual_bytes = strlen($name); if ($actual_bytes > $maximum_bytes) { throw new Exception( pht( 'Parameter ("%s") passed to "%s" when constructing a lint message '. 'must be a string with a maximum length of %s bytes, but is %s '. 'bytes in length.', $name, 'setName()', new PhutilNumber($maximum_bytes), new PhutilNumber($actual_bytes))); } $this->name = $name; return $this; } public function getName() { return $this->name; } public function setDescription($description) { $this->description = $description; return $this; } public function getDescription() { return $this->description; } public function setOriginalText($original) { $this->originalText = $original; return $this; } public function getOriginalText() { return $this->originalText; } public function setReplacementText($replacement) { $this->replacementText = $replacement; return $this; } public function getReplacementText() { return $this->replacementText; } /** * @param dict Keys 'path', 'line', 'char', 'original'. */ public function setOtherLocations(array $locations) { assert_instances_of($locations, 'array'); $this->otherLocations = $locations; return $this; } public function getOtherLocations() { return $this->otherLocations; } public function isError() { return $this->getSeverity() == ArcanistLintSeverity::SEVERITY_ERROR; } public function isWarning() { return $this->getSeverity() == ArcanistLintSeverity::SEVERITY_WARNING; } public function isAutofix() { return $this->getSeverity() == ArcanistLintSeverity::SEVERITY_AUTOFIX; } public function hasFileContext() { return ($this->getLine() !== null); } public function setObsolete($obsolete) { $this->obsolete = $obsolete; return $this; } public function getObsolete() { return $this->obsolete; } public function isPatchable() { return ($this->getReplacementText() !== null) && ($this->getReplacementText() !== $this->getOriginalText()); } public function didApplyPatch() { if ($this->appliedToDisk) { return $this; } $this->appliedToDisk = true; foreach ($this->dependentMessages as $message) { $message->didApplyPatch(); } return $this; } public function isPatchApplied() { return $this->appliedToDisk; } public function setGranularity($granularity) { $this->granularity = $granularity; return $this; } public function getGranularity() { return $this->granularity; } public function setDependentMessages(array $messages) { assert_instances_of($messages, __CLASS__); $this->dependentMessages = $messages; return $this; } public function setBypassChangedLineFiltering($bypass_changed_lines) { $this->bypassChangedLineFiltering = $bypass_changed_lines; return $this; } public function shouldBypassChangedLineFiltering() { return $this->bypassChangedLineFiltering; } /** * Validate an integer-like value, returning a strict integer. * * Further on, the pipeline is strict about types. We want to be a little * less strict in linters themselves, since they often parse command line * output or XML and will end up with string representations of numbers. * * @param mixed Integer or digit string. * @return int Integer. */ private function validateInteger($value, $caller) { if ($value === null) { // This just means that we don't have any information. return null; } // Strings like "234" are fine, coerce them to integers. if (is_string($value) && preg_match('/^\d+\z/', $value)) { $value = (int)$value; } if (!is_int($value)) { throw new Exception( pht( 'Parameter passed to "%s" must be an integer.', $caller.'()')); } return $value; } public function newTrimmedMessage() { if (!$this->isPatchable()) { return clone $this; } // If the original and replacement text have a similar prefix or suffix, // we trim it to reduce the size of the diff we show to the user. $replacement = $this->getReplacementText(); $original = $this->getOriginalText(); $replacement_length = strlen($replacement); $original_length = strlen($original); $minimum_length = min($original_length, $replacement_length); $prefix_length = 0; for ($ii = 0; $ii < $minimum_length; $ii++) { if ($original[$ii] !== $replacement[$ii]) { break; } $prefix_length++; } // NOTE: The two strings can't be the same because the message won't be // "patchable" if they are, so we don't need a special check for the case // where the entire string is a shared prefix. // However, if the two strings are in the form "ABC" and "ABBC", we may // find a prefix and a suffix with a combined length greater than the // total size of the smaller string if we don't limit the search. $max_suffix = ($minimum_length - $prefix_length); $suffix_length = 0; for ($ii = 1; $ii <= $max_suffix; $ii++) { $original_char = $original[$original_length - $ii]; $replacement_char = $replacement[$replacement_length - $ii]; if ($original_char !== $replacement_char) { break; } $suffix_length++; } if ($suffix_length) { $original = substr($original, 0, -$suffix_length); $replacement = substr($replacement, 0, -$suffix_length); } $line = $this->getLine(); $char = $this->getChar(); if ($prefix_length) { $prefix = substr($original, 0, $prefix_length); // NOTE: Prior to PHP7, `substr("a", 1)` returned false instead of // the empty string. Cast these to force the PHP7-ish behavior we // expect. $original = (string)substr($original, $prefix_length); $replacement = (string)substr($replacement, $prefix_length); // If we've removed a prefix, we need to push the character and line // number for the warning forward to account for the characters we threw // away. for ($ii = 0; $ii < $prefix_length; $ii++) { $char++; if ($prefix[$ii] == "\n") { $line++; $char = 1; } } } return id(clone $this) ->setOriginalText($original) ->setReplacementText($replacement) ->setLine($line) ->setChar($char); } } diff --git a/src/lint/renderer/ArcanistConsoleLintRenderer.php b/src/lint/renderer/ArcanistConsoleLintRenderer.php index ea233e3d..a4dfffa9 100644 --- a/src/lint/renderer/ArcanistConsoleLintRenderer.php +++ b/src/lint/renderer/ArcanistConsoleLintRenderer.php @@ -1,312 +1,332 @@ showAutofixPatches = $show_autofix_patches; return $this; } public function setTestableMode($testable_mode) { $this->testableMode = $testable_mode; return $this; } public function getTestableMode() { return $this->testableMode; } public function renderLintResult(ArcanistLintResult $result) { $messages = $result->getMessages(); $path = $result->getPath(); $data = $result->getData(); $line_map = $this->newOffsetMap($data); $text = array(); foreach ($messages as $message) { if (!$this->showAutofixPatches && $message->isAutofix()) { continue; } if ($message->isError()) { $color = 'red'; } else { $color = 'yellow'; } $severity = ArcanistLintSeverity::getStringForSeverity( $message->getSeverity()); $code = $message->getCode(); $name = $message->getName(); $description = $message->getDescription(); if ($message->getOtherLocations()) { $locations = array(); foreach ($message->getOtherLocations() as $location) { $locations[] = idx($location, 'path', $path). (!empty($location['line']) ? ":{$location['line']}" : ''); } $description .= "\n".pht( 'Other locations: %s', implode(', ', $locations)); } $text[] = phutil_console_format( " ** %s ** (%s) __%s__\n%s\n", $severity, $code, $name, phutil_console_wrap($description, 4)); if ($message->hasFileContext()) { $text[] = $this->renderContext($message, $data, $line_map); } } if ($text) { $prefix = phutil_console_format( "**>>>** %s\n\n\n", pht( 'Lint for %s:', phutil_console_format('__%s__', $path))); return $prefix.implode("\n", $text); } else { return null; } } protected function renderContext( ArcanistLintMessage $message, $data, array $line_map) { $context = 3; $message = $message->newTrimmedMessage(); $original = $message->getOriginalText(); $replacement = $message->getReplacementText(); $line = $message->getLine(); $char = $message->getChar(); $old = $data; $old_lines = phutil_split_lines($old); $old_impact = substr_count($original, "\n") + 1; $start = $line; if ($message->isPatchable()) { $patch_offset = $line_map[$line] + ($char - 1); $new = substr_replace( $old, $replacement, $patch_offset, strlen($original)); $new_lines = phutil_split_lines($new); // Figure out how many "-" and "+" lines we have by counting the newlines // for the relevant patches. This may overestimate things if we are adding // or removing entire lines, but we'll adjust things below. $new_impact = substr_count($replacement, "\n") + 1; // If this is a change on a single line, we'll try to highlight the // changed character range to make it easier to pick out. if ($old_impact === 1 && $new_impact === 1) { $old_lines[$start - 1] = substr_replace( $old_lines[$start - 1], $this->highlightText($original), $char - 1, strlen($original)); $new_lines[$start - 1] = substr_replace( $new_lines[$start - 1], $this->highlightText($replacement), $char - 1, strlen($replacement)); } // If lines at the beginning of the changed line range are actually the // same, shrink the range. This happens when a patch just adds a line. do { $old_line = idx($old_lines, $start - 1, null); $new_line = idx($new_lines, $start - 1, null); if ($old_line !== $new_line) { break; } $start++; $old_impact--; $new_impact--; if ($old_impact < 0 || $new_impact < 0) { throw new Exception( pht( 'Modified prefix line range has become negative '. '(old = %d, new = %d).', $old_impact, $new_impact)); } } while (true); // If the lines at the end of the changed line range are actually the // same, shrink the range. This happens when a patch just removes a // line. do { $old_suffix = idx($old_lines, $start + $old_impact - 2, null); $new_suffix = idx($new_lines, $start + $new_impact - 2, null); if ($old_suffix !== $new_suffix) { break; } $old_impact--; $new_impact--; // We can end up here if a patch removes a line which occurs after // another identical line. if ($old_impact <= 0 || $new_impact <= 0) { break; } } while (true); } else { // If we have "original" text and it is contained on a single line, // highlight the affected area. If we don't have any text, we'll mark // the character with a caret (below, in rendering) instead. if ($old_impact == 1 && strlen($original)) { $old_lines[$start - 1] = substr_replace( $old_lines[$start - 1], $this->highlightText($original), $char - 1, strlen($original)); } $old_impact = 0; $new_impact = 0; } $out = array(); $head = max(1, $start - $context); for ($ii = $head; $ii < $start; $ii++) { $out[] = array( 'text' => $old_lines[$ii - 1], 'number' => $ii, ); } for ($ii = $start; $ii < $start + $old_impact; $ii++) { $out[] = array( 'text' => $old_lines[$ii - 1], 'number' => $ii, 'type' => '-', 'chevron' => ($ii == $start), ); } for ($ii = $start; $ii < $start + $new_impact; $ii++) { + // If the patch was at the end of the file and ends with a newline, we + // won't have an actual entry in the array for the last line, even though + // we want to show it in the diff. $out[] = array( - 'text' => $new_lines[$ii - 1], + 'text' => idx($new_lines, $ii - 1, ''), 'type' => '+', 'chevron' => ($ii == $start), ); } $cursor = $start + $old_impact; $foot = min(count($old_lines), $cursor + $context); for ($ii = $cursor; $ii <= $foot; $ii++) { $out[] = array( 'text' => $old_lines[$ii - 1], 'number' => $ii, 'chevron' => ($ii == $cursor), ); } $result = array(); $seen_chevron = false; foreach ($out as $spec) { if ($seen_chevron) { $chevron = false; } else { $chevron = !empty($spec['chevron']); if ($chevron) { $seen_chevron = true; } } + // If the line doesn't actually end in a newline, add one so the layout + // doesn't mess up. This can happen when the last line of the old file + // didn't have a newline at the end. + $text = $spec['text']; + if (!preg_match('/\n\z/', $spec['text'])) { + $text .= "\n"; + } + $result[] = $this->renderLine( idx($spec, 'number'), - $spec['text'], + $text, $chevron, idx($spec, 'type')); // If this is just a message and does not have a patch, put a little // caret underneath the line to point out where the issue is. if ($chevron) { if (!$message->isPatchable() && !strlen($original)) { $result[] = $this->renderCaret($char)."\n"; } } } return implode('', $result); } private function renderCaret($pos) { return str_repeat(' ', 16 + $pos).'^'; } protected function renderLine($line, $data, $chevron = false, $diff = null) { $chevron = $chevron ? '>>>' : ''; return sprintf( ' %3s %1s %6s %s', $chevron, $diff, $line, $data); } public function renderOkayResult() { return phutil_console_format( "** %s ** %s\n", pht('OKAY'), pht('No lint warnings.')); } private function newOffsetMap($data) { $lines = phutil_split_lines($data); $line_map = array(); $number = 1; $offset = 0; foreach ($lines as $line) { $line_map[$number] = $offset; $number++; $offset += strlen($line); } + // If the last line ends in a newline, add a virtual offset for the final + // line with no characters on it. This allows lint messages to target the + // last line of the file at character 1. + if ($lines) { + if (preg_match('/\n\z/', $line)) { + $line_map[$number] = $offset; + } + } + return $line_map; } private function highlightText($text) { if ($this->getTestableMode()) { return '>'.$text.'<'; } else { return (string)tsprintf('##%s##', $text); } } } diff --git a/src/lint/renderer/__tests__/ArcanistConsoleLintRendererTestCase.php b/src/lint/renderer/__tests__/ArcanistConsoleLintRendererTestCase.php index 9014288b..f8928229 100644 --- a/src/lint/renderer/__tests__/ArcanistConsoleLintRendererTestCase.php +++ b/src/lint/renderer/__tests__/ArcanistConsoleLintRendererTestCase.php @@ -1,200 +1,227 @@ array( 'line' => 1, 'char' => 1, 'original' => 'a', 'replacement' => 'z', ), 'inline' => array( 'line' => 1, 'char' => 7, 'original' => 'cat', 'replacement' => 'dog', ), // In this test, the original and replacement texts have a large // amount of overlap. 'overlap' => array( 'line' => 1, 'char' => 1, 'original' => 'tantawount', 'replacement' => 'tantamount', ), 'newline' => array( 'line' => 6, 'char' => 1, 'original' => "\n", 'replacement' => '', ), 'addline' => array( 'line' => 3, 'char' => 1, 'original' => '', 'replacement' => "cherry\n", ), 'addlinesuffix' => array( 'line' => 2, 'char' => 7, 'original' => '', 'replacement' => "\ncherry", ), 'xml' => array( 'line' => 3, 'char' => 6, 'original' => '', 'replacement' => "\n", ), 'caret' => array( 'line' => 2, 'char' => 13, 'name' => 'Fruit Misinformation', 'description' => 'Arguably untrue.', ), 'original' => array( 'line' => 1, 'char' => 4, 'original' => 'should of', ), 'midline' => array( 'line' => 1, 'char' => 1, 'original' => $midline_original, 'replacement' => $midline_replacement, ), 'remline' => array( 'line' => 1, 'char' => 1, 'original' => $remline_original, 'replacement' => $remline_replacement, ), 'extrawhitespace' => array( 'line' => 2, 'char' => 1, 'original' => "\n", 'replacement' => '', ), + + 'eofnewline' => array( + 'line' => 1, + 'char' => 7, + 'original' => '', + 'replacement' => "\n", + ), + + 'eofmultilinechar' => array( + 'line' => 5, + 'char' => 3, + 'original' => '', + 'replacement' => "\nX\nY\n", + ), + + 'eofmultilineline' => array( + 'line' => 6, + 'char' => 1, + 'original' => '', + 'replacement' => "\nX\nY\n", + ), + ); $defaults = array( 'severity' => ArcanistLintSeverity::SEVERITY_WARNING, 'name' => 'Lint Warning', 'path' => 'path/to/example.c', 'description' => 'Consider this.', 'code' => 'WARN123', ); foreach ($map as $key => $test_case) { $data = $this->readTestData("{$key}.txt"); - $data = preg_replace('/~+\s*$/m', '', $data); - $expect = $this->readTestData("{$key}.expect"); $test_case = $test_case + $defaults; $path = $test_case['path']; $severity = $test_case['severity']; $name = $test_case['name']; $description = $test_case['description']; $code = $test_case['code']; $line = $test_case['line']; $char = $test_case['char']; $original = idx($test_case, 'original'); $replacement = idx($test_case, 'replacement'); $message = id(new ArcanistLintMessage()) ->setPath($path) ->setSeverity($severity) ->setName($name) ->setDescription($description) ->setCode($code) ->setLine($line) ->setChar($char) ->setOriginalText($original) ->setReplacementText($replacement); $result = id(new ArcanistLintResult()) ->setPath($path) ->setData($data) ->addMessage($message); $renderer = id(new ArcanistConsoleLintRenderer()) ->setTestableMode(true); try { PhutilConsoleFormatter::disableANSI(true); $actual = $renderer->renderLintResult($result); PhutilConsoleFormatter::disableANSI(false); } catch (Exception $ex) { PhutilConsoleFormatter::disableANSI(false); throw $ex; } - // Trim "~" off the ends of lines. This allows the "expect" file to test - // for trailing whitespace without actually containing trailing - // whitespace. - $expect = preg_replace('/~+$/m', '', $expect); - $this->assertEqual( $expect, $actual, pht( 'Lint rendering for "%s".', $key)); } } private function readTestData($filename) { $path = dirname(__FILE__).'/data/'.$filename; - return Filesystem::readFile($path); + $data = Filesystem::readFile($path); + + // If we find "~~~" at the end of the file, get rid of it and any whitespace + // afterwards. This allows specifying data files with trailing empty + // lines. + $data = preg_replace('/~~~\s*\z/', '', $data); + + // Trim "~" off the ends of lines. This allows the "expect" file to test + // for trailing whitespace without actually containing trailing + // whitespace. + $data = preg_replace('/~$/m', '', $data); + + return $data; } } diff --git a/src/lint/renderer/__tests__/data/eofmultilinechar.expect b/src/lint/renderer/__tests__/data/eofmultilinechar.expect new file mode 100644 index 00000000..5ec8fdbe --- /dev/null +++ b/src/lint/renderer/__tests__/data/eofmultilinechar.expect @@ -0,0 +1,12 @@ +>>> Lint for path/to/example.c: + + + Warning (WARN123) Lint Warning + Consider this. + + 3 3 + 4 4 + 5 5 + >>> + ~ + + X + + Y diff --git a/src/lint/renderer/__tests__/data/eofmultilinechar.txt b/src/lint/renderer/__tests__/data/eofmultilinechar.txt new file mode 100644 index 00000000..8a1218a1 --- /dev/null +++ b/src/lint/renderer/__tests__/data/eofmultilinechar.txt @@ -0,0 +1,5 @@ +1 +2 +3 +4 +5 diff --git a/src/lint/renderer/__tests__/data/eofmultilineline.expect b/src/lint/renderer/__tests__/data/eofmultilineline.expect new file mode 100644 index 00000000..5ec8fdbe --- /dev/null +++ b/src/lint/renderer/__tests__/data/eofmultilineline.expect @@ -0,0 +1,12 @@ +>>> Lint for path/to/example.c: + + + Warning (WARN123) Lint Warning + Consider this. + + 3 3 + 4 4 + 5 5 + >>> + ~ + + X + + Y diff --git a/src/lint/renderer/__tests__/data/eofmultilineline.txt b/src/lint/renderer/__tests__/data/eofmultilineline.txt new file mode 100644 index 00000000..8a1218a1 --- /dev/null +++ b/src/lint/renderer/__tests__/data/eofmultilineline.txt @@ -0,0 +1,5 @@ +1 +2 +3 +4 +5 diff --git a/src/lint/renderer/__tests__/data/eofnewline.expect b/src/lint/renderer/__tests__/data/eofnewline.expect new file mode 100644 index 00000000..5310bdb9 --- /dev/null +++ b/src/lint/renderer/__tests__/data/eofnewline.expect @@ -0,0 +1,9 @@ +>>> Lint for path/to/example.c: + + + Warning (WARN123) Lint Warning + Consider this. + + >>> - 1 abcdef + + abcdef + + ~ diff --git a/src/lint/renderer/__tests__/data/eofnewline.txt b/src/lint/renderer/__tests__/data/eofnewline.txt new file mode 100644 index 00000000..9836135e --- /dev/null +++ b/src/lint/renderer/__tests__/data/eofnewline.txt @@ -0,0 +1 @@ +abcdef~~~ diff --git a/src/lint/renderer/__tests__/data/extrawhitespace.txt b/src/lint/renderer/__tests__/data/extrawhitespace.txt index ba587d4c..00ba812f 100644 --- a/src/lint/renderer/__tests__/data/extrawhitespace.txt +++ b/src/lint/renderer/__tests__/data/extrawhitespace.txt @@ -1,3 +1,3 @@ Adrift upon the sea. -~ +~~~