Refactor routine to find single log content pattern in TAP tests

The same routine to check if a specific pattern can be found in the
server logs was copied over four different test scripts.  This refactors
the whole to use a single routine located in PostgreSQL::Test::Cluster,
named log_contains, to grab the contents of the server logs and check
for a specific pattern.

On HEAD, the code previously used assumed that slurp_file() could not
handle an undefined offset, setting it to zero, but slurp_file() does
do an extra fseek() before retrieving the log contents only if an offset
is defined.  In two places, the test was retrieving the full log
contents with slurp_file() after calling substr() to apply an offset,
ignoring that slurp_file() would be able to handle that.

Backpatch all the way down to ease the introduction of new tests that
could rely on the new routine.

Author: Vignesh C
Reviewed-by: Andrew Dunstan, Dagfinn Ilmari Mannsåker, Michael Paquier
Discussion: https://postgr.es/m/CALDaNm0YSiLpjCmajwLfidQrFOrLNKPQir7s__PeVvh9U3uoTQ@mail.gmail.com
Backpatch-through: 11

diff --git a/src/test/perl/PostgresNode.pm b/src/test/perl/PostgresNode.pm
index b7e4dbd0e8e4426d483c1b4fd517c82ee99e4040..ce924de0b24586cc478e7a294910f27f54575cfb 100644 (file)
--- a/src/test/perl/PostgresNode.pm
+++ b/src/test/perl/PostgresNode.pm
@@ -2081,6 +2081,21 @@ sub issues_sql_like
 
 =pod
 
+=item $node->log_contains(pattern, offset)
+
+Find pattern in logfile of node after offset byte.
+
+=cut
+
+sub log_contains
+{
+   my ($self, $pattern, $offset) = @_;
+
+   return TestLib::slurp_file($self->logfile, $offset) =~ m/$pattern/;
+}
+
+=pod
+
 =item $node->run_log(...)
 
 Runs a shell command like TestLib::run_log, but with connection parameters set

diff --git a/src/test/recovery/t/019_replslot_limit.pl b/src/test/recovery/t/019_replslot_limit.pl
index 7a8954dad20348df46d0406195e69c885b492d4a..d36c9545888cc24ea0b67d3bbc48ab37902eb5df 100644 (file)
--- a/src/test/recovery/t/019_replslot_limit.pl
+++ b/src/test/recovery/t/019_replslot_limit.pl
@@ -165,8 +165,7 @@ $node_master->wait_for_catchup($node_standby, 'replay', $start_lsn);
 
 $node_standby->stop;
 
-ok( !find_in_log(
-       $node_standby,
+ok( !$node_standby->log_contains(
        "requested WAL segment [0-9A-F]+ has already been removed"),
    'check that required WAL segments are still available');
 
@@ -188,8 +187,7 @@ $node_master->safe_psql('postgres', "CHECKPOINT;");
 my $invalidated = 0;
 for (my $i = 0; $i < 10000; $i++)
 {
-   if (find_in_log(
-           $node_master,
+   if ($node_master->log_contains(
            "invalidating slot \"rep1\" because its restart_lsn [0-9A-F/]+ exceeds max_slot_wal_keep_size",
            $logstart))
    {
@@ -212,7 +210,7 @@ is($result, "rep1|f|t|lost|",
 my $checkpoint_ended = 0;
 for (my $i = 0; $i < 10000; $i++)
 {
-   if (find_in_log($node_master, "checkpoint complete: ", $logstart))
+   if ($node_master->log_contains("checkpoint complete: ", $logstart))
    {
        $checkpoint_ended = 1;
        last;
@@ -242,8 +240,7 @@ $node_standby->start;
 my $failed = 0;
 for (my $i = 0; $i < 10000; $i++)
 {
-   if (find_in_log(
-           $node_standby,
+   if ($node_standby->log_contains(
            "requested WAL segment [0-9A-F]+ has already been removed",
            $logstart))
    {
@@ -318,17 +315,3 @@ sub get_log_size
 
    return (stat $node->logfile)[7];
 }
-
-# find $pat in logfile of $node after $off-th byte
-sub find_in_log
-{
-   my ($node, $pat, $off) = @_;
-
-   $off = 0 unless defined $off;
-   my $log = TestLib::slurp_file($node->logfile);
-   return 0 if (length($log) <= $off);
-
-   $log = substr($log, $off);
-
-   return $log =~ m/$pat/;
-}

diff --git a/src/test/recovery/t/033_replay_tsp_drops.pl b/src/test/recovery/t/033_replay_tsp_drops.pl
index 140d94db312f35dc735e75f3a29f1f8e15153416..4c8f4e7970453ff0ad48de41164f6aa93f49bf78 100644 (file)
--- a/src/test/recovery/t/033_replay_tsp_drops.pl
+++ b/src/test/recovery/t/033_replay_tsp_drops.pl
@@ -132,21 +132,11 @@ while ($max_attempts-- >= 0)
 {
    last
      if (
-       find_in_log(
-           $node_standby, qr!WARNING: ( [A-Z0-9]+:)? creating missing directory: pg_tblspc/!,
+       $node_standby->log_contains(
+           qr!WARNING: ( [A-Z0-9]+:)? creating missing directory: pg_tblspc/!,
            $logstart));
    usleep(100_000);
 }
 ok($max_attempts > 0, "invalid directory creation is detected");
 
 done_testing();
-
-# find $pat in logfile of $node after $off-th byte
-sub find_in_log
-{
-   my ($node, $pat, $off) = @_;
-
-   my $log = PostgreSQL::Test::Utils::slurp_file($node->logfile, $off);
-
-   return $log =~ m/$pat/;
-}