<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[184521] trunk/Tools</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://trac.webkit.org/projects/webkit/changeset/184521">184521</a></dd>
<dt>Author</dt> <dd>dbates@webkit.org</dd>
<dt>Date</dt> <dd>2015-05-18 16:56:24 -0700 (Mon, 18 May 2015)</dd>
</dl>
<h3>Log Message</h3>
<pre>prepare-ChangeLog reports function above deleted function as deleted; uninitialized value warning
when staged non-empty file for commit
https://bugs.webkit.org/show_bug.cgi?id=145082
Reviewed by Darin Adler.
Fixes two issues when running prepare-ChangeLog:
1. The function above a deleted function is reported as changed.
2. With a Git checkout of WebKit, a Perl uninitialized value warning is emitted when
a new non-empty file is staged for commit (e.g. extractLineRangeBeforeAndAfterChange.pl,
included in this patch).
Simplify code by using unified diff parsing logic for both SVN and Git support. Currently
prepare-ChangeLog has logic to parse normal diff- and unified diff- chunk range lines as
generated by `svn diff` and `git diff`, respectively. The logic for parsing these formats
has correctness issues. We should make use of the VCSUtil::parseChunkRange() to parse
chunk range lines of a unified diff as opposed to having specialized logic in prepare-ChangeLog.
VCSUtil::parseChunkRange() has existing test coverage.
* Scripts/prepare-ChangeLog:
(generateFunctionLists): Only add a line range to %line_ranges_before_changed, %line_ranges_after_changed
when the beginning line number, ending line number >= 1. Modified for-loop condition to iterate over
all the files represented by %line_ranges_before_changed and %line_ranges_after_changed so that we
examine files that only have deletions. Currently this works as a side effect of the behavior of
extractLineRangeAfterChange(), which always returns a well-formed (though nonsensical) line range for
a change that represents a deletion (e.g. extractLineRangeAfterChange("@@ -166,6 +165,0 @@") => [165, 165]).
(diffCommand): Generate a unified diff instead of a normal diff when using a SVN checkout of WebKit.
(extractLineRangeAfterChange): Remove logic to parse a normal diff chunk range line and write
the logic to parse a unified diff chunk range line in terms of VCSUtil::parseChunkRange().
We return (-1, -1) when the change represents a deletion.
(extractLineRangeBeforeChange): Remove logic to parse a normal diff chunk range line and write
the logic to parse a unified diff chunk range line in terms of VCSUtil::parseChunkRange().
We return (-1, -1) when the change represents an addition.
* Scripts/webkitperl/prepare-ChangeLog_unittest/extractLineRangeBeforeAndAfterChange.pl: Added;
unit tests.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkToolsChangeLog">trunk/Tools/ChangeLog</a></li>
<li><a href="#trunkToolsScriptsprepareChangeLog">trunk/Tools/Scripts/prepare-ChangeLog</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunkToolsScriptswebkitperlprepareChangeLog_unittestextractLineRangeBeforeAndAfterChangepl">trunk/Tools/Scripts/webkitperl/prepare-ChangeLog_unittest/extractLineRangeBeforeAndAfterChange.pl</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkToolsChangeLog"></a>
<div class="modfile"><h4>Modified: trunk/Tools/ChangeLog (184520 => 184521)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Tools/ChangeLog 2015-05-18 23:52:24 UTC (rev 184520)
+++ trunk/Tools/ChangeLog 2015-05-18 23:56:24 UTC (rev 184521)
</span><span class="lines">@@ -1,3 +1,41 @@
</span><ins>+2015-05-18 Daniel Bates <dabates@apple.com>
+
+ prepare-ChangeLog reports function above deleted function as deleted; uninitialized value warning
+ when staged non-empty file for commit
+ https://bugs.webkit.org/show_bug.cgi?id=145082
+
+ Reviewed by Darin Adler.
+
+ Fixes two issues when running prepare-ChangeLog:
+ 1. The function above a deleted function is reported as changed.
+ 2. With a Git checkout of WebKit, a Perl uninitialized value warning is emitted when
+ a new non-empty file is staged for commit (e.g. extractLineRangeBeforeAndAfterChange.pl,
+ included in this patch).
+
+ Simplify code by using unified diff parsing logic for both SVN and Git support. Currently
+ prepare-ChangeLog has logic to parse normal diff- and unified diff- chunk range lines as
+ generated by `svn diff` and `git diff`, respectively. The logic for parsing these formats
+ has correctness issues. We should make use of the VCSUtil::parseChunkRange() to parse
+ chunk range lines of a unified diff as opposed to having specialized logic in prepare-ChangeLog.
+ VCSUtil::parseChunkRange() has existing test coverage.
+
+ * Scripts/prepare-ChangeLog:
+ (generateFunctionLists): Only add a line range to %line_ranges_before_changed, %line_ranges_after_changed
+ when the beginning line number, ending line number >= 1. Modified for-loop condition to iterate over
+ all the files represented by %line_ranges_before_changed and %line_ranges_after_changed so that we
+ examine files that only have deletions. Currently this works as a side effect of the behavior of
+ extractLineRangeAfterChange(), which always returns a well-formed (though nonsensical) line range for
+ a change that represents a deletion (e.g. extractLineRangeAfterChange("@@ -166,6 +165,0 @@") => [165, 165]).
+ (diffCommand): Generate a unified diff instead of a normal diff when using a SVN checkout of WebKit.
+ (extractLineRangeAfterChange): Remove logic to parse a normal diff chunk range line and write
+ the logic to parse a unified diff chunk range line in terms of VCSUtil::parseChunkRange().
+ We return (-1, -1) when the change represents a deletion.
+ (extractLineRangeBeforeChange): Remove logic to parse a normal diff chunk range line and write
+ the logic to parse a unified diff chunk range line in terms of VCSUtil::parseChunkRange().
+ We return (-1, -1) when the change represents an addition.
+ * Scripts/webkitperl/prepare-ChangeLog_unittest/extractLineRangeBeforeAndAfterChange.pl: Added;
+ unit tests.
+
</ins><span class="cx"> 2015-05-18 Anders Carlsson <andersca@apple.com>
</span><span class="cx">
</span><span class="cx"> Add ATS keys to MiniBrowser
</span></span></pre></div>
<a id="trunkToolsScriptsprepareChangeLog"></a>
<div class="modfile"><h4>Modified: trunk/Tools/Scripts/prepare-ChangeLog (184520 => 184521)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Tools/Scripts/prepare-ChangeLog 2015-05-18 23:52:24 UTC (rev 184520)
+++ trunk/Tools/Scripts/prepare-ChangeLog 2015-05-18 23:56:24 UTC (rev 184521)
</span><span class="lines">@@ -281,13 +281,13 @@
</span><span class="cx"> $file = makeFilePathRelative($1) if $_ =~ diffHeaderFormat();
</span><span class="cx"> if (defined $file) {
</span><span class="cx"> my ($before_start, $before_end) = extractLineRangeBeforeChange($_);
</span><del>- if ($before_start >= 0 && $before_end >= $before_start) {
</del><ins>+ if ($before_start >= 1 && $before_end >= 1) {
</ins><span class="cx"> push @{$line_ranges_before_changed{$file}}, [ $before_start, $before_end ];
</span><span class="cx"> } elsif (/DO_NOT_COMMIT/) {
</span><span class="cx"> print STDERR "WARNING: file $file contains the string DO_NOT_COMMIT, line $.\n";
</span><span class="cx"> }
</span><span class="cx"> my ($after_start, $after_end) = extractLineRangeAfterChange($_);
</span><del>- if ($after_start >= 0 && $after_end >= 0 && $after_end >= $after_start) {
</del><ins>+ if ($after_start >= 1 && $after_end >= 1) {
</ins><span class="cx"> push @{$line_ranges_after_changed{$file}}, [ $after_start, $after_end ];
</span><span class="cx"> } elsif (/DO_NOT_COMMIT/) {
</span><span class="cx"> print STDERR "WARNING: file $file contains the string DO_NOT_COMMIT, line $.\n";
</span><span class="lines">@@ -299,7 +299,8 @@
</span><span class="cx">
</span><span class="cx"> # For each source file, convert line range to function list.
</span><span class="cx"> print STDERR " Extracting affected function names from source files.\n";
</span><del>- foreach my $file (keys %line_ranges_after_changed) {
</del><ins>+ my %filesToExamine = map { $_ => 1 } (keys(%line_ranges_before_changed), keys(%line_ranges_after_changed));
+ foreach my $file (keys %filesToExamine) {
</ins><span class="cx"> my %saw_function;
</span><span class="cx"> # Find all the functions in the file.
</span><span class="cx"> if ($line_ranges_after_changed{$file}) {
</span><span class="lines">@@ -1772,7 +1773,7 @@
</span><span class="cx"> if (isSVN()) {
</span><span class="cx"> my @escapedPaths = map(escapeSubversionPath($_), @$paths);
</span><span class="cx"> my $escapedPathsString = "'" . join("' '", @escapedPaths) . "'";
</span><del>- $command = SVN . " diff --diff-cmd diff -x -N $escapedPathsString";
</del><ins>+ $command = SVN . " diff --diff-cmd diff -x -u $escapedPathsString";
</ins><span class="cx"> } elsif (isGit()) {
</span><span class="cx"> my $pathsString = "'" . join("' '", @$paths) . "'";
</span><span class="cx"> $command = GIT . " diff --no-ext-diff -U0 " . diffFromToString($gitCommit, $gitIndex, $mergeBase);
</span><span class="lines">@@ -2100,35 +2101,23 @@
</span><span class="cx"> sub extractLineRangeAfterChange($)
</span><span class="cx"> {
</span><span class="cx"> my ($string) = @_;
</span><del>-
- my ($start, $end) = (-1, -1);
-
- if (isSVN() && $string =~ /^\d+(,\d+)?[acd](\d+)(,(\d+))?/) {
- $start = $2;
- $end = $4 || $2;
- } elsif (isGit() && $string =~ /^@@ -\d+(,\d+)? \+(\d+)(,(\d+))? @@/) {
- $start = $2;
- $end = defined($4) ? max($start + $4 - 1, $start) : $start;
</del><ins>+ my $chunkRange = parseChunkRange($string);
+ if (!$chunkRange || !$chunkRange->{newStartingLine} || !$chunkRange->{newLineCount}) {
+ # Deletion; no lines exist after change.
+ return (-1, -1);
</ins><span class="cx"> }
</span><del>-
- return ($start, $end);
</del><ins>+ return ($chunkRange->{newStartingLine}, $chunkRange->{newStartingLine} + $chunkRange->{newLineCount} - 1);
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> sub extractLineRangeBeforeChange($)
</span><span class="cx"> {
</span><span class="cx"> my ($string) = @_;
</span><del>-
- my ($start, $end) = (-1, -1);
-
- if (isSVN() && $string =~ /^(\d+)(,(\d+))?([acd])\d+(,\d+)?/) {
- $start = $1;
- $end = $3 || $1 if $4 ne "a";
- } elsif (isGit() && $string =~ /^@@ -(\d+)(,(\d+))? \+\d+(,\d+)? @@/) {
- $start = $1;
- $end = defined($3) ? max($start + $3 - 1, $start) : $start;
</del><ins>+ my $chunkRange = parseChunkRange($string);
+ if (!$chunkRange || !$chunkRange->{startingLine} || !$chunkRange->{lineCount}) {
+ # Addition; no lines existed before change.
+ return (-1, -1);
</ins><span class="cx"> }
</span><del>-
- return ($start, $end);
</del><ins>+ return ($chunkRange->{startingLine}, $chunkRange->{startingLine} + $chunkRange->{lineCount} - 1);
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> sub testListForChangeLog(@)
</span></span></pre></div>
<a id="trunkToolsScriptswebkitperlprepareChangeLog_unittestextractLineRangeBeforeAndAfterChangepl"></a>
<div class="addfile"><h4>Added: trunk/Tools/Scripts/webkitperl/prepare-ChangeLog_unittest/extractLineRangeBeforeAndAfterChange.pl (0 => 184521)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Tools/Scripts/webkitperl/prepare-ChangeLog_unittest/extractLineRangeBeforeAndAfterChange.pl (rev 0)
+++ trunk/Tools/Scripts/webkitperl/prepare-ChangeLog_unittest/extractLineRangeBeforeAndAfterChange.pl 2015-05-18 23:56:24 UTC (rev 184521)
</span><span class="lines">@@ -0,0 +1,206 @@
</span><ins>+#!/usr/bin/perl -w
+#
+# Copyright (C) 2015 Apple Inc. All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+# 1. Redistributions of source code must retain the above copyright
+# notice, this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright
+# notice, this list of conditions and the following disclaimer in the
+# documentation and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND ANY
+# EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
+# DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+# ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+use strict;
+use warnings;
+
+use Test::More;
+use FindBin;
+use lib File::Spec->catdir($FindBin::Bin, "..");
+use LoadAsModule qw(PrepareChangeLog prepare-ChangeLog);
+
+my @testCaseHashRefs = (
+####
+# Additions
+##
+{
+ # New test
+ testName => "add single line to the beginning of the file",
+ inputText => "@@ -0,0 +1 @@",
+ expectedResults => {
+ beforeChange => [-1, -1],
+ afterChange => [1, 1],
+ }
+},
+{
+ # New test
+ testName => "add two lines to the beginning of the file",
+ inputText => "@@ -0,0 +1,2 @@",
+ expectedResults => {
+ beforeChange => [-1, -1],
+ afterChange => [1, 2],
+ }
+},
+{
+ # New test
+ testName => "add two lines in the middle of the file",
+ inputText => "@@ -4,0 +5,2 @@",
+ expectedResults => {
+ beforeChange => [-1, -1],
+ afterChange => [5, 6],
+ }
+},
+{
+ # New test
+ testName => "append a single line to the end of the file",
+ inputText => "@@ -1,0 +2 @@",
+ expectedResults => {
+ beforeChange => [-1, -1],
+ afterChange => [2, 2],
+ }
+},
+####
+# Deletions
+##
+{
+ # New test
+ testName => "remove the first and only line in the file",
+ inputText => "@@ -1 +0,0 @@",
+ expectedResults => {
+ beforeChange => [1, 1],
+ afterChange => [-1, -1],
+ }
+},
+{
+ # New test
+ testName => "remove seven out of seven lines in the file",
+ inputText => "@@ -1,7 +0,0 @@",
+ expectedResults => {
+ beforeChange => [1, 7],
+ afterChange => [-1, -1],
+ }
+},
+{
+ # New test
+ testName => "remove two lines from the middle of the file",
+ inputText => "@@ -4,2 +3,0 @@",
+ expectedResults => {
+ beforeChange => [4, 5],
+ afterChange => [-1, -1],
+ }
+},
+####
+# Changes
+##
+{
+ # New test
+ testName => "change the first line of the file",
+ inputText => "@@ -1 +1 @@",
+ expectedResults => {
+ beforeChange => [1, 1],
+ afterChange => [1, 1],
+ }
+},
+{
+ # New test
+ testName => "change the first line of the file and then append two more lines",
+ inputText => "@@ -1 +1,3 @@",
+ expectedResults => {
+ beforeChange => [1, 1],
+ afterChange => [1, 3],
+ }
+},
+{
+ # New test
+ testName => "remove seven out of seven lines and then add one line",
+ inputText => "@@ -1,7 +1 @@",
+ expectedResults => {
+ beforeChange => [1, 7],
+ afterChange => [1, 1],
+ }
+},
+{
+ # New test
+ testName => "remove two lines from the middle of the file",
+ inputText => "@@ -4,2 +4,2 @@",
+ expectedResults => {
+ beforeChange => [4, 5],
+ afterChange => [4, 5],
+ }
+},
+{
+ # New test
+ testName => "remove two lines from the middle of the file and then add a line",
+ inputText => "@@ -4,2 +4,3 @@",
+ expectedResults => {
+ beforeChange => [4, 5],
+ afterChange => [4, 6],
+ }
+},
+{
+ # New test
+ testName => "remove two lines from the middle of the file and then delete a line",
+ inputText => "@@ -4,3 +4,2 @@",
+ expectedResults => {
+ beforeChange => [4, 6],
+ afterChange => [4, 5],
+ }
+},
+###
+# Invalid and malformed chunk ranges
+##
+# FIXME: We should make this set of tests more comprehensive.
+{
+ # New test
+ testName => "[invalid] empty string",
+ inputText => "",
+ expectedResults => {
+ beforeChange => [-1, -1],
+ afterChange => [-1, -1],
+ }
+},
+{
+ # New test
+ testName => "[invalid] bogus chunk range",
+ inputText => "this is not a valid chunk range",
+ expectedResults => {
+ beforeChange => [-1, -1],
+ afterChange => [-1, -1],
+ }
+},
+{
+ # New test
+ testName => "[invalid] chunk range missing leading sentinel",
+ inputText => "-4,3 +4,2 @@",
+ expectedResults => {
+ beforeChange => [-1, -1],
+ afterChange => [-1, -1],
+ }
+},
+);
+
+my $testCasesCount = @testCaseHashRefs;
+plan(tests => 2 * $testCasesCount); # Total number of assertions.
+
+foreach my $testCase (@testCaseHashRefs) {
+ my $expectedResults = $testCase->{expectedResults};
+
+ my $testNameStart = "extractLineRangeBeforeChange(): $testCase->{testName}: comparing";
+ my @got = PrepareChangeLog::extractLineRangeBeforeChange($testCase->{inputText});
+ is_deeply(\@got, $expectedResults->{beforeChange}, "$testNameStart return value.");
+
+ $testNameStart = "extractLineRangeAfterChange(): $testCase->{testName}: comparing";
+ @got = PrepareChangeLog::extractLineRangeAfterChange($testCase->{inputText});
+ is_deeply(\@got, $expectedResults->{afterChange}, "$testNameStart return value.");
+}
</ins></span></pre>
</div>
</div>
</body>
</html>