1
1

Add a helper script for the gatekeepers -- automatically create a

suggested SVN commit message for when closing a CMR (containing CMR
#s, CMR subject lines, and SVN commit log messages).

This commit was SVN r22882.
Этот коммит содержится в:
Jeff Squyres 2010-03-25 14:38:21 +00:00
родитель a6175bbefc
Коммит 370c987486

298
contrib/dist/gkcommit.pl поставляемый Исполняемый файл
Просмотреть файл

@ -0,0 +1,298 @@
#!/usr/bin/env perl
#
# Helper script for gatekeepers: it marshals together a GK-worthy SVN
# commit message containing the CMR number(s) being closed and SVN
# commit log messages for the SVN r numbers referenced.
#
use strict;
use Getopt::Long;
use XML::Parser;
use Data::Dumper;
use Cwd;
use LWP;
use File::Temp qw/ :POSIX /;
my $base_trac_url = "https://svn.open-mpi.org/trac/ompi/ticket/%d?format=csv";
###########################################################################
# Command line parsing
my @cmr_arg;
my @r_arg;
&Getopt::Long::Configure("bundling");
my $ok = Getopt::Long::GetOptions("cmr|c=s" => \@cmr_arg,
"r|r=s" => \@r_arg);
# Parse the -cmr argument
my @cmrs;
if (@cmr_arg) {
foreach my $cmr (@cmr_arg) {
foreach my $c (split(/,/, $cmr)) {
push(@cmrs, $c);
}
}
}
# Parse the -r argument
my @rs;
if (@r_arg) {
foreach my $r (@r_arg) {
foreach my $rr (split(/,/, $r)) {
push(@rs, $rr);
}
}
}
###########################################################################
# Make sure we're in an SVN tree
die "Not in a SVN tree"
if (! -d ".svn");
###########################################################################
# If we didn't get cmrs on the command line, prompt for them
if (!@cmrs) {
print "Enter a list of CMRs closed by this commit.\n";
while (1) {
print "\nList so far: ";
if ($#cmrs >= 0) {
print "#" . join(', #', @cmrs) . "\n";
} else {
print "<none>\n";
}
print "CMR number (-1 to exit)? ";
my $cmr = <STDIN>;
chomp($cmr);
last
if (-1 == $cmr);
if ($cmr > 0) {
push(@cmrs, $cmr);
} else {
print "Invalid CMR number; must be greater than 0 (ignored).\n";
}
}
print("\n");
}
if ($#cmrs < 0) {
print "Must supply at least one CMR that is closed by this commit\n";
exit(1);
}
# If we didn't get r numbers on the command line, prompt for them
if (!@rs) {
print "Enter a list of SVN r numbers included in this commit.\n";
while (1) {
print "\nList so far: ";
if ($#rs >= 0) {
print "r" . join(', r', @rs) . "\n";
} else {
print "<none>\n";
}
print "SVN r number (-1 to exit)? ";
my $r = <STDIN>;
chomp($r);
last
if (-1 == $r);
if ($r > 0) {
push(@rs, $r);
} else {
print "Invalid SVN r number; must be greater than 0 (ignored).\n";
}
}
print("\n");
}
###########################################################################
# Prettyprint
print "\nFinal list of CMRs closed by this commit: #" .
join(', #', @cmrs) . "\n";
print "\nFinal list of SVN r number closed by this commit: ";
if ($#rs >= 0) {
print "r" . join(', r', @rs) . "\n";
} else {
print "<none>\n";
}
###########################################################################
# Retrieve subject lines for Trac CMRs
print "Retrieving Trac CMR summaries...\n";
my $cmr_summaries;
foreach my $cmr (@cmrs) {
my $url = sprintf($base_trac_url, $cmr);
my %params = { env_proxy => 0 };
my $ua = LWP::UserAgent->new(%params);
# @#$@!$# LWP proxying for https *does not work*. So don't set
# $ua->proxy() for it. Instead, rely on $ENV{https_proxy} being
# set whenever we process requests that require SSL proxying,
# because that is obeyed deep down in the innards underneath LWP.
$ua->agent("gkcommit");
my $res = $ua->get($url);
if (!$res->is_success()) {
print("Failed to download Trac ticket #" . $cmr . "\n");
print $res->reason;
exit(1);
}
my @lines = split('\n', $res->content);
my @fields = split(',', $lines[0]);
# The summary field may have a "," in it, so do the parsing with
# care. If it does, the value will be enclosed in quotes ("foo").
# If not, there will be no quotes.
my $summary = $lines[1];
$summary =~ s/^.*?,//;
if (substr($summary, 0, 1) eq '"') {
# Quotes are escaped in the string with double quotes
my $marker="===GK-COMMIT-DOUBLE-QUOTE===";
$summary =~ s/\"\"/$marker/g;
$summary =~ m/^\"(.+?)\",/;
$summary = $1;
$summary =~ s/$marker/\"/g;
} else {
$summary =~ s/(.+?),.+/\1/;
}
$cmr_summaries->{$cmr} = $summary;
}
# If we have r numbers to parse, get the SVN logs and parse them into
# a data structure
my $logentries;
my $logentry;
my $chars;
if ($#rs >= 0) {
print "Retrieving SVN log messages...\n";
my $cmd = "svn log --xml ";
foreach my $r (@rs) {
$cmd .= "-r $r ";
}
print "Running: $cmd\n";
my $xml;
open(CMD, "$cmd|");
$xml .= $_
while (<CMD>);
close(CMD);
my $x = new XML::Parser(Style => 'Subs',
Handlers => { Char => \&my_char });
$x->parse($xml);
}
###########################################################################
# Create a SVN commit message for the gatekeeper
my $commit_file = File::Temp::tempnam(Cwd::cwd(), "gkcommit");
open(FILE, ">$commit_file") ||
die "Can't open temp file";
foreach my $cmr (@cmrs) {
print FILE "Fixes #$cmr: $cmr_summaries->{$cmr}\n";
}
print FILE "\n";
# If we have r numbers, print them
foreach my $r (@rs) {
print FILE "r$r
$logentries->{$r}->{msg}\n\n";
}
close(FILE);
# Now allow the gk to edit the file
if ($ENV{SVN_EDITOR}) {
system("$ENV{SVN_EDITOR} $commit_file");
} elsif ($ENV{EDITOR}) {
system("$ENV{EDITOR} $commit_file");
} else {
system("vi $commit_file");
}
if (! -f $commit_file) {
print "Commit file no longer exists! Aborting.\n";
exit(1);
}
# Finally, run the commit
my $cmd = "bogus svn commit --file $commit_file " . join(' ', @ARGV);
print "Running: $cmd\n";
if (0 == system($cmd)) {
unlink($commit_file);
exit(0);
} else {
print "Error during SVN commit!\n";
print "GK commit message left in: $commit_file\n";
exit(1);
}
###########################################################################
###########################################################################
###########################################################################
# Helper functions
###########################################################################
###########################################################################
###########################################################################
# Called for the first logentry tag in the XML parsing
sub logentry {
# The beginning logentry tag has arugments of the form:
# ($expat, 'logentry', attr1, val1, attr2, val2, ...);
shift(@_);
shift(@_);
while (@_) {
my $attr = shift(@_);
my $val = shift(@_);
$logentry->{$attr} = $val;
}
}
# Called for the last logentry tag in the XML parsing
sub logentry_ {
$logentries->{$logentry->{revision}} = $logentry;
$logentry = undef;
}
# Called for the last anchor tag in the XML parsing
sub author_ {
chomp($chars);
$chars =~ s/^\n*//;
$logentry->{author} = $chars;
$chars = '';
}
# Called for the last date tag in the XML parsing
sub date_ {
chomp($chars);
$chars =~ s/^\n*//;
$logentry->{date} = $chars;
$chars = '';
}
# Called for the last revision tag in the XML parsing
sub revision_ {
chomp($chars);
$chars =~ s/^\n*//;
$logentry->{revision} = $chars;
$chars = '';
}
# Called for the last msg tag in the XML parsing
sub msg_ {
chomp($chars);
$chars =~ s/^\n*//;
$logentry->{msg} = $chars;
$chars = '';
}
# Called for general character data in XML parsing
sub my_char {
my ($expat, $tmp) = @_;
$chars .= $tmp;
}