<!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>[194749] 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/194749">194749</a></dd>
<dt>Author</dt> <dd>commit-queue@webkit.org</dd>
<dt>Date</dt> <dd>2016-01-07 18:18:01 -0800 (Thu, 07 Jan 2016)</dd>
</dl>
<h3>Log Message</h3>
<pre>prepare-ChangeLog should include radar number
https://bugs.webkit.org/show_bug.cgi?id=152839
<rdar://problem/24093563>
Patch by Joseph Pecoraro <pecoraro@apple.com> on 2016-01-07
Reviewed by Daniel Bates.
When running `prepare-ChangeLog -b ###`, check for a bugzilla comment that
starts with a "<rdar://problem/####>" URL. If found, include that radar URL
in the ChangeLog description after the bug URL.
* Scripts/prepare-ChangeLog:
(main): Update signatures.
(fetchBugXMLData): XML Data is now used for multiple reasons. Extract this to just get the data.
(fetchBugDescriptionFromBugXMLData): Search data for <short_desc>.
(fetchRadarURLFromBugXMLData): Search comment text for radar URL.
(generateNewChangeLogs): Include radar URL if we found one.
* Scripts/webkitperl/prepare-ChangeLog_unittest/fetchRadarURLFromBugXMLData.pl: Added.
Tests for the radar URL extraction.</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_unittestfetchRadarURLFromBugXMLDatapl">trunk/Tools/Scripts/webkitperl/prepare-ChangeLog_unittest/fetchRadarURLFromBugXMLData.pl</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkToolsChangeLog"></a>
<div class="modfile"><h4>Modified: trunk/Tools/ChangeLog (194748 => 194749)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Tools/ChangeLog 2016-01-08 01:52:31 UTC (rev 194748)
+++ trunk/Tools/ChangeLog 2016-01-08 02:18:01 UTC (rev 194749)
</span><span class="lines">@@ -1,3 +1,25 @@
</span><ins>+2016-01-07 Joseph Pecoraro <pecoraro@apple.com>
+
+ prepare-ChangeLog should include radar number
+ https://bugs.webkit.org/show_bug.cgi?id=152839
+ <rdar://problem/24093563>
+
+ Reviewed by Daniel Bates.
+
+ When running `prepare-ChangeLog -b ###`, check for a bugzilla comment that
+ starts with a "<rdar://problem/####>" URL. If found, include that radar URL
+ in the ChangeLog description after the bug URL.
+
+ * Scripts/prepare-ChangeLog:
+ (main): Update signatures.
+ (fetchBugXMLData): XML Data is now used for multiple reasons. Extract this to just get the data.
+ (fetchBugDescriptionFromBugXMLData): Search data for <short_desc>.
+ (fetchRadarURLFromBugXMLData): Search comment text for radar URL.
+ (generateNewChangeLogs): Include radar URL if we found one.
+
+ * Scripts/webkitperl/prepare-ChangeLog_unittest/fetchRadarURLFromBugXMLData.pl: Added.
+ Tests for the radar URL extraction.
+
</ins><span class="cx"> 2016-01-07 Alexey Proskuryakov <ap@apple.com>
</span><span class="cx">
</span><span class="cx"> testRunner.runUIScript crashes while running multiple tests in a row that invokes the same UIScript
</span></span></pre></div>
<a id="trunkToolsScriptsprepareChangeLog"></a>
<div class="modfile"><h4>Modified: trunk/Tools/Scripts/prepare-ChangeLog (194748 => 194749)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Tools/Scripts/prepare-ChangeLog 2016-01-08 01:52:31 UTC (rev 194748)
+++ trunk/Tools/Scripts/prepare-ChangeLog 2016-01-08 02:18:01 UTC (rev 194749)
</span><span class="lines">@@ -76,13 +76,15 @@
</span><span class="cx"> sub diffHeaderFormat();
</span><span class="cx"> sub extractLineRangeAfterChange($);
</span><span class="cx"> sub extractLineRangeBeforeChange($);
</span><del>-sub fetchBugDescriptionFromURL($$);
</del><ins>+sub fetchBugXMLData($$);
+sub fetchBugDescriptionFromBugXMLData($$$);
+sub fetchRadarURLFromBugXMLData($$);
</ins><span class="cx"> sub findChangeLogs($$);
</span><span class="cx"> sub findOriginalFileFromSvn($);
</span><span class="cx"> sub generateFileList(\%$$$);
</span><span class="cx"> sub generateFunctionLists($$$$$);
</span><span class="cx"> sub generateFunctionListsByRanges($$$$);
</span><del>-sub generateNewChangeLogs($$$$$$$$$$$$$);
</del><ins>+sub generateNewChangeLogs($$$$$$$$$$$$$$);
</ins><span class="cx"> sub getLatestChangeLogs($);
</span><span class="cx"> sub get_function_line_ranges($$);
</span><span class="cx"> sub get_function_line_ranges_for_cpp($$);
</span><span class="lines">@@ -129,6 +131,7 @@
</span><span class="cx"> sub main()
</span><span class="cx"> {
</span><span class="cx"> my $bugDescription;
</span><ins>+ my $bugRadarURL;
</ins><span class="cx"> my $bugNumber;
</span><span class="cx"> my $name;
</span><span class="cx"> my $emailAddress;
</span><span class="lines">@@ -221,7 +224,9 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> if ($bugNumber && !$bugDescription) {
</span><del>- $bugDescription = fetchBugDescriptionFromURL($bugURL, $bugNumber);
</del><ins>+ my $bugXMLData = fetchBugXMLData($bugURL, $bugNumber);
+ $bugDescription = fetchBugDescriptionFromBugXMLData($bugURL, $bugNumber, $bugXMLData);
+ $bugRadarURL = fetchRadarURLFromBugXMLData($bugNumber, $bugXMLData);
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> my ($filesInChangeLog, $prefixes) = findChangeLogs($functionLists, $writeChangeLogs);
</span><span class="lines">@@ -233,7 +238,7 @@
</span><span class="cx"> resolveConflictedChangeLogs($changeLogs);
</span><span class="cx"> }
</span><span class="cx">
</span><del>- generateNewChangeLogs($prefixes, $filesInChangeLog, $addedRegressionTests, $requiresTests, $functionLists, $bugURL, $bugDescription, $name, $emailAddress, $gitReviewer, $gitCommit, $writeChangeLogs, $delimiters);
</del><ins>+ generateNewChangeLogs($prefixes, $filesInChangeLog, $addedRegressionTests, $requiresTests, $functionLists, $bugURL, $bugDescription, $bugRadarURL, $name, $emailAddress, $gitReviewer, $gitCommit, $writeChangeLogs, $delimiters);
</ins><span class="cx">
</span><span class="cx"> if ($writeChangeLogs) {
</span><span class="cx"> print STDERR "-- Please remember to include a detailed description in your ChangeLog entry. --\n-- See <http://webkit.org/coding/contributing.html> for more info --\n";
</span><span class="lines">@@ -418,7 +423,7 @@
</span><span class="cx"> return $emailAddressFromArgs || changeLogEmailAddress();
</span><span class="cx"> }
</span><span class="cx">
</span><del>-sub fetchBugDescriptionFromURL($$)
</del><ins>+sub fetchBugXMLData($$)
</ins><span class="cx"> {
</span><span class="cx"> my ($bugURL, $bugNumber) = @_;
</span><span class="cx">
</span><span class="lines">@@ -426,25 +431,46 @@
</span><span class="cx"> # Perl has no built in XML processing, so we'll fetch and parse with curl and grep
</span><span class="cx"> # Pass --insecure because some cygwin installs have no certs we don't
</span><span class="cx"> # care about validating that bugs.webkit.org is who it says it is here.
</span><del>- my $descriptionLine = `curl --insecure --silent "$bugXMLURL" | grep short_desc`;
- if ($descriptionLine !~ /<short_desc>(.*)<\/short_desc>/) {
</del><ins>+ my $xmlData = `curl --insecure --silent "$bugXMLURL"`;
+ if ($xmlData !~ /<\?xml/) {
</ins><span class="cx"> # Maybe the reason the above did not work is because the curl that is installed doesn't
</span><span class="cx"> # support ssl at all.
</span><span class="cx"> if (`curl --version | grep ^Protocols` !~ /\bhttps\b/) {
</span><span class="cx"> print STDERR " Could not get description for bug $bugNumber.\n";
</span><span class="cx"> print STDERR " It looks like your version of curl does not support ssl.\n";
</span><span class="cx"> print STDERR " If you are using macports, this can be fixed with sudo port install curl +ssl.\n";
</span><del>- } else {
- print STDERR " Bug $bugNumber has no bug description. Maybe you set wrong bug ID?\n";
- print STDERR " The bug URL: $bugXMLURL\n";
</del><span class="cx"> }
</span><span class="cx"> exit 1;
</span><span class="cx"> }
</span><ins>+ return $xmlData;
+}
+
+sub fetchBugDescriptionFromBugXMLData($$$)
+{
+ my ($bugURL, $bugNumber, $bugXMLData) = @_;
+
+ if ($bugXMLData !~ /<short_desc>(.*)<\/short_desc>/) {
+ print STDERR " Bug $bugNumber has no bug description. Maybe you set wrong bug ID?\n";
+ print STDERR " The bug URL: $bugURL\n";
+ exit 1;
+ }
+
</ins><span class="cx"> my $bugDescription = decodeEntities($1);
</span><span class="cx"> print STDERR " Description from bug $bugNumber:\n \"$bugDescription\".\n";
</span><span class="cx"> return $bugDescription;
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+sub fetchRadarURLFromBugXMLData($$)
+{
+ my ($bugNumber, $bugXMLData) = @_;
+
+ return "" if $bugXMLData !~ m|<thetext>\s*(&lt;rdar://problem/\d+&gt;)|;
+
+ my $bugRadarURL = decodeEntities($1);
+ print STDERR " Radar URL from bug $bugNumber:\n \"$bugRadarURL\".\n";
+ return $bugRadarURL;
+}
+
</ins><span class="cx"> sub findChangeLogs($$)
</span><span class="cx"> {
</span><span class="cx"> my ($functionLists, $requireChangeLogToExist) = @_;
</span><span class="lines">@@ -556,9 +582,9 @@
</span><span class="cx"> close RESOLVE;
</span><span class="cx"> }
</span><span class="cx">
</span><del>-sub generateNewChangeLogs($$$$$$$$$$$$$)
</del><ins>+sub generateNewChangeLogs($$$$$$$$$$$$$$)
</ins><span class="cx"> {
</span><del>- my ($prefixes, $filesInChangeLog, $addedRegressionTests, $requiresTests, $functionLists, $bugURL, $bugDescription, $name, $emailAddress, $gitReviewer, $gitCommit, $writeChangeLogs, $delimiters) = @_;
</del><ins>+ my ($prefixes, $filesInChangeLog, $addedRegressionTests, $requiresTests, $functionLists, $bugURL, $bugDescription, $bugRadarURL, $name, $emailAddress, $gitReviewer, $gitCommit, $writeChangeLogs, $delimiters) = @_;
</ins><span class="cx">
</span><span class="cx"> # Generate new ChangeLog entries and (optionally) write out new ChangeLog files.
</span><span class="cx"> foreach my $prefix (@$prefixes) {
</span><span class="lines">@@ -595,6 +621,7 @@
</span><span class="cx"> $bugDescription = "Need a short description (OOPS!).\n Need the bug URL (OOPS!)." unless $bugDescription;
</span><span class="cx"> print CHANGE_LOG normalizeLineEndings(" $bugDescription\n", $endl) if $bugDescription;
</span><span class="cx"> print CHANGE_LOG normalizeLineEndings(" $bugURL\n", $endl) if $bugURL;
</span><ins>+ print CHANGE_LOG normalizeLineEndings(" $bugRadarURL\n", $endl) if $bugRadarURL;
</ins><span class="cx"> print CHANGE_LOG normalizeLineEndings("\n", $endl);
</span><span class="cx">
</span><span class="cx"> print CHANGE_LOG normalizeLineEndings(" Reviewed by $reviewer.\n\n", $endl);
</span></span></pre></div>
<a id="trunkToolsScriptswebkitperlprepareChangeLog_unittestfetchRadarURLFromBugXMLDatapl"></a>
<div class="addfile"><h4>Added: trunk/Tools/Scripts/webkitperl/prepare-ChangeLog_unittest/fetchRadarURLFromBugXMLData.pl (0 => 194749)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Tools/Scripts/webkitperl/prepare-ChangeLog_unittest/fetchRadarURLFromBugXMLData.pl (rev 0)
+++ trunk/Tools/Scripts/webkitperl/prepare-ChangeLog_unittest/fetchRadarURLFromBugXMLData.pl 2016-01-08 02:18:01 UTC (rev 194749)
</span><span class="lines">@@ -0,0 +1,101 @@
</span><ins>+#!/usr/bin/perl -w
+#
+# Copyright (C) 2016 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);
+
+# NOTE: A Bugzilla Comment XML looks like:
+#
+# <long_desc isprivate="0">
+# <commentid>1153467</commentid>
+# <who name="Radar WebKit Bug Importer">webkit-bug-importer</who>
+# <bug_when>2016-01-07 11:06:14 -0800</bug_when>
+# <thetext>&lt;rdar://problem/24093563&gt;</thetext>
+# </long_desc>
+#
+# But for these tests we simplify the XML to just the <thetext> blocks.
+
+my @testCaseHashRefs = (
+
+###
+# Comments where a Radar URL will be detected.
+##
+{
+ testName => "Radar URL comment",
+ inputText => "<thetext>&lt;rdar://problem/24093563&gt;</thetext>",
+ expected => "<rdar://problem/24093563>"
+},
+{
+ testName => "Radar URL comment with leading whitespace",
+ inputText => "<thetext> &lt;rdar://problem/24093563&gt;</thetext>",
+ expected => "<rdar://problem/24093563>"
+},
+{
+ testName => "Radar URL comment with trailing title",
+ inputText => "<thetext>&lt;rdar://problem/24093563&gt; Radar Title Here</thetext>",
+ expected => "<rdar://problem/24093563>"
+},
+{
+ testName => "Multiple comments, detect first Radar URL comment",
+ inputText => "<thetext>Comment 1</thetext>\n<thetext>&lt;rdar://problem/24093563&gt;</thetext>\n<thetext>&lt;rdar://problem/99999999&gt;</thetext>",
+ expected => "<rdar://problem/24093563>"
+},
+
+###
+# Comments where a Radar URL will not be detected.
+##
+{
+ testName => "Empty comment",
+ inputText => "",
+ expected => ""
+},
+{
+ testName => "Comment without radar URL link",
+ inputText => "<thetext>Comment text</thetext>",
+ expected => ""
+},
+{
+ testName => "Radar URL comment with leading text",
+ inputText => "<thetext>Check out: &lt;rdar://problem/24093563&gt;</thetext>",
+ expected => ""
+},
+
+);
+
+# Ignore STDERR output from fetchRadarURLFromBugXMLData for the test cases.
+close STDERR;
+
+my $testCasesCount = @testCaseHashRefs;
+plan(tests => $testCasesCount);
+
+foreach my $testCase (@testCaseHashRefs) {
+ my $expected = $testCase->{expected};
+ my $got = PrepareChangeLog::fetchRadarURLFromBugXMLData(152839, $testCase->{inputText});
+ is($got, $expected, $testCase->{testName});
+}
</ins><span class="cx">Property changes on: trunk/Tools/Scripts/webkitperl/prepare-ChangeLog_unittest/fetchRadarURLFromBugXMLData.pl
</span><span class="cx">___________________________________________________________________
</span></span></pre></div>
<a id="svnexecutable"></a>
<div class="addfile"><h4>Added: svn:executable</h4></div>
</div>
</body>
</html>