\n" unless $in_failure;
$in_failure = 1;
}
if ($css) {
$line = "
$line";
$bats_count{$css}++;
}
print { $out_fh } "
$timestamp"
if $timestamp;
print { $out_fh } $line, "\n";
next LINE;
}
# Timing section at the bottom of the page
if ($line =~ / timing results\s*$/) {
$in_timing = 1;
}
elsif ($in_timing) {
if ($line =~ /^(\S.*\S)\s+(\d+\.\d+)\s*$/) {
my ($name, $time) = ($1, $2);
my $id = make_id($1, 'timing');
# Try to column-align the timing numbers. Some test names
# will be longer than our max - oh well.
my $spaces = 80 - length(unescapeHTML($name));
$spaces = 1 if $spaces < 1;
$spaces++ if $time < 10;
my $spacing = ' ' x $spaces;
$line = qq{
$name$spacing$time};
}
else {
$in_timing = 0;
}
}
#
# Ginkgo error reformatting
#
if ($line =~ /^.{1,4} (Failure|Panic)( in .*)? \[/) {
# Begins a block of multiple lines including a stack trace
print { $out_fh } "
\n";
$in_failure = 1;
}
elsif ($line =~ /^-----------/) {
if ($in_failure) {
# Ends a stack trace block
$in_failure = 0;
print { $out_fh } "
\n";
}
$after_divider = 1;
print { $out_fh } "\n
\n
\n";
# Always show timestamp at start of each new test
$previous_timestamp = '';
next LINE;
}
# (bindings test sometimes emits 'Running' with leading bullet char)
elsif ($line =~ s!^•?Running:!$Prompt!) {
# Highlight the important (non-boilerplate) podman command.
$line =~ s/\s+--remote\s+/ /g; # --remote takes no args
# Strip out the global podman options, but show them on hover
$line =~ s{(\S+\/podman(-remote)?)((\s+--(root|runroot|runtime|tmpdir|storage-opt|conmon|cgroup-manager|network-backend|network-config-dir|storage-driver|events-backend|url) \S+)*)(.*)}{
my ($full_path, $remote, $options, $args) = ($1, $2||'', $3, $6);
$options =~ s/^\s+//;
# Separate each '--foo bar' with newlines for readability
$options =~ s/ --/\n--/g;
qq{podman$remote [options]$args};
}e;
$current_output = '';
}
# Grrr. 'output:' usually just tells us what we already know.
elsif ($line =~ /^output:/) {
$current_output =~ s!^\s+|\s+$!!g; # Trim leading/trailing blanks
$current_output =~ s/\s+/ /g; # Collapse multiple spaces
if ($line eq "output: $current_output" || $line eq 'output: ') {
next LINE;
}
}
elsif ($line =~ /^Error:/ || $line =~ / level=(warning|error) /) {
$line = "" . $line . "";
}
elsif ($line =~ /^panic:/) {
$line = "" . $line . "";
}
else {
$current_output .= ' ' . $line;
}
# Two lines after each divider, there's a test name. Make it
# an anchor so we can link to it later.
if ($after_divider++ == 2) {
# Sigh. There is no actual marker. Assume that anything with
## two leading spaces then alpha or hyphen (not slashes) is
## a test name.
if ($line =~ /^ [a-zA-Z-]/) {
my $id = make_id($line, 'anchor');
$line = "$line
";
}
}
# Make SKIPPING and SLOW TEST visible
$line =~ s!(\[SKIPPING\].*)!$1!;
$line =~ s!(\[SLOW TEST.*\])!$1!;
# Highlight test name when it appears in the middle of commands.
# But make it boring, because we already have the test name in large
# bold just above. (Except in skipped tests).
$line =~ s!^(\s*)(\[It\]\s+.*)!$1$2!;
# Failure name corresponds to a previously-seen block.
# 1 2 2 3 3 14 4
if ($line =~ /^(\[(Fail|Panic!)\] .* \[(It|BeforeEach)\] )([A-Za-z-].*)/) {
my ($lhs, $type, $ginkgo_fluff, $testname) = ($1, $2, $3, $4);
my $id = make_id($testname, 'link');
$line = "$lhs$testname";
}
print { $out_fh } "$timestamp"
if $timestamp;
print { $out_fh } $line, "\n";
}
my $have_formatted_log; # Set on success
if ($out_fh) {
# Summary line for BATS tests
if (keys %bats_count) {
print { $out_fh } "
Summary:";
my $total = 0;
my $comma = '';
for my $class (qw(passed failed skipped)) {
if (my $n = $bats_count{$class}) {
printf { $out_fh } "%s %d %s",
$comma, $class, $n, ucfirst($class);
$total += $n;
$comma = ',';
}
}
printf { $out_fh } ". Total tests: $total";
if (my $expected_total = $bats_count{expected_total}) {
if ($total != $expected_total) {
print { $out_fh } " (WARNING: expected $expected_total)";
}
}
print { $out_fh } "\n";
}
print { $out_fh } " \n";
# Did we find a cirrus task? Link back.
if ($cirrus_task) {
print { $out_fh } <<"END_HTML";
END_HTML
}
# FIXME: need a safe way to get TZ
printf { $out_fh } <<"END_HTML", scalar(CORE::localtime);
Processed %s by $ME v$VERSION
END_HTML
if (close $out_fh) {
if (rename $out_tmp => $outfile) {
$have_formatted_log = 1;
}
else {
warn "$ME: Could not rename $out_tmp: $!\n";
}
}
else {
warn "$ME: Error writing $out_tmp: $!\n";
}
}
# Grumble. Github only shows the last N lines of the log... which is
# anti-helpful when you want a quick synopsis of what failed. Write a
# summary at the tail, to make it easier for humans to see what went wrong.
if (my $fails = $bats_count{__fail_list}) {
print "\n";
printf "Failed tests (%d):\n", scalar(@$fails);
printf " - %d %s\n", @$_ for @$fails;
}
# If Cirrus magic envariables are available, write a link to results.
# FIXME: it'd be so nice to make this a clickable live link.
#
# As of June 2022 we use the Cirrus API[1] as the source of our logs,
# instead of linking directly to googleapis.com. This will allow us
# to abstract cloud-specific details, so we can one day use Amazon cloud.
# See #14569 for more info.
#
# [1] https://cirrus-ci.org/guide/writing-tasks/#latest-build-artifacts
if ($have_formatted_log && $ENV{CIRRUS_TASK_ID}) {
my $URL_BASE = "https://api.cirrus-ci.com";
my $task_id = $ENV{CIRRUS_TASK_ID};
# Link by *taskID*, not buildID + taskname. First, this is shorter
# and less duplicaty. Second, and more important, buildID + taskname
# is non-unique, and a link to a flake log will be clobbered.
my $URL = "${URL_BASE}/v1/artifact/task/$task_id/html/${outfile}";
print "\n\nAnnotated results:\n $URL\n";
}
}
#############
# make_id # Given a test name, generate an anchor link name
#############
sub make_id {
my $name = shift; # in: test title
my $type = shift; # in: differentiator (anchor, link)
state %counter;
$name =~ s/^\s+|\s+$//g; # strip leading/trailing whitespace
$name =~ s/\&#\d+;//g; # 'doesn't' -> 'doesnt'
$name =~ s/\"/-/g; # '"path"' -> '-path-'
$name =~ s/[^a-zA-Z0-9_-]/-/g; # Convert non-alphanumeric to dash
$name =~ s/-{3,}/-/g; # '------' to just '-'
# Keep a running tally of how many times we've seen this identifier
# for this given type! This lets us cross-match, in the bottom of
# the page, the first/second/third failure of a given test.
$name .= "--" . ++$counter{$type}{$name};
$name;
}
###############################################################################
# BEGIN job_synopsis and related helpers
##################
# job_synopsis # Job details, links to github/cirrus
##################
sub job_synopsis {
my $subtest_name = shift; # e.g. integration_test
my $s = <<"END_SYNOPSIS";
END_SYNOPSIS
# PR 1234 - title of the pr
my $pr_title = escapeHTML(_env_replace("{CIRRUS_CHANGE_TITLE}"));
$s .= _tr("GitHub PR", sprintf("%s - %s",
_a("{CIRRUS_PR}", "https://{CIRRUS_REPO_CLONE_HOST}/{CIRRUS_REPO_FULL_NAME}/pull/{CIRRUS_PR}"),
$pr_title));
# PR author, if signed-off-by
if (my $msg = _env_replace("{CIRRUS_COMMIT_MESSAGE}")) {
while ($msg =~ /^Signed-off-by:\s+(\S.*\S)$/gmi) {
$s .= _tr("Author", escapeHTML($1));
}
}
# eg "test fedora", "special_testing_rootless"
# WARNING: As of 2020-10-05, $CIRRUS_TASK_NAME reflects the same
# descriptive content as our $subtest_name argument (confirm via
# cross-checking runner.sh:logformatter() vs cirrus.yml:&std_name_fmt).
# If this ever becomes untrue, just add _tr("Subtest", $subtest_name).
my $test_name = _env_replace("{CIRRUS_TASK_NAME}");
# (Special-case cleanup: Cirrus\ quotes\ spaces; remove for readability).
$test_name =~ s/\\\s+/ /g;
$s .= _tr("Test name", $test_name);
# Link to further Cirrus results, e.g. other runs.
# Build is mostly boring, it's usually TASK that we want to see.
$s .= _tr("Cirrus", sprintf("Build %s / Task %s",
_a("{CIRRUS_BUILD_ID}", "https://cirrus-ci.com/build/{CIRRUS_BUILD_ID}"),
_a("{CIRRUS_TASK_ID}", "https://cirrus-ci.com/task/{CIRRUS_TASK_ID}")));
$s .= "
\n";
return $s;
}
sub _tr {
my ($th, $td) = @_;
return "
| $th: | $td |
|---|
\n";
}
sub _a {
my ($name, $href) = map { _env_replace($_) } @_;
if ($href =~ /UNDEFINED/) {
return "$name ($href)";
}
return "
$name";
}
sub _env_replace {
my $s_in = shift;
$s_in =~ s[\{(.*?)\}][$ENV{$1} || "[$1 UNDEFINED]"]ge;
return $s_in;
}
# END job_synopsis and related helpers
###############################################################################
# BEGIN html-formatting helpers
sub escapeHTML {
my $s = shift;
state %chars;
%chars = ('&' => '&', '<' => '<', '>' => '>', '"' => '"', "'" => ''')
if keys(%chars) == 0;
my $class = join('', sort keys %chars);
$s =~ s/([$class])/$chars{$1}/ge;
return $s;
}
sub unescapeHTML {
my $s = shift;
# We don't actually care about the character, only its length
$s =~ s/\&\#?[a-z0-9]+;/./g;
return $s;
}
# END html-formatting helpers
###############################################################################
1;