Skip to content

Commit e082ef9

Browse files
author
Amit Kapila
committed
Back-Patch "Add wait_for_subscription_sync for TAP tests."
This was originally done in commit 0c20dd3 for 16 only, to eliminate duplicate code and as an infrastructure that makes it easier to write future tests. However, it has been suggested that it would be good to back-patch this testing infrastructure to aid future tests in back-branches. Backpatch to all supported versions. Author: Masahiko Sawada Reviewed by: Amit Kapila, Shi yu Discussion: https://postgr.es/m/CAD21AoC-fvAkaKHa4t1urupwL8xbAcWRePeETvshvy80f6WV1A@mail.gmail.com Discussion: https://postgr.es/m/E1oJBIf-0006sw-SA@gemulon.postgresql.org
1 parent 68dcce2 commit e082ef9

18 files changed

+88
-146
lines changed

‎src/test/perl/PostgresNode.pm

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2572,6 +2572,50 @@ sub wait_for_slot_catchup
25722572

25732573
=pod
25742574
2575+
=item $node->wait_for_subscription_sync(publisher, subname, dbname)
2576+
2577+
Wait for all tables in pg_subscription_rel to complete the initial
2578+
synchronization (i.e to be either in 'syncdone' or 'ready' state).
2579+
2580+
If the publisher node is given, additionally, check if the subscriber has
2581+
caught up to what has been committed on the primary. This is useful to
2582+
ensure that the initial data synchronization has been completed after
2583+
creating a new subscription.
2584+
2585+
If there is no active replication connection from this peer, wait until
2586+
poll_query_until timeout.
2587+
2588+
This is not a test. It die()s on failure.
2589+
2590+
=cut
2591+
2592+
sub wait_for_subscription_sync
2593+
{
2594+
my ($self, $publisher, $subname, $dbname) = @_;
2595+
my $name = $self->name;
2596+
2597+
$dbname = defined($dbname) ? $dbname : 'postgres';
2598+
2599+
# Wait for all tables to finish initial sync.
2600+
print "Waiting for all subscriptions in \"$name\" to synchronize data\n";
2601+
my $query =
2602+
qq[SELECT count(1) = 0 FROM pg_subscription_rel WHERE srsubstate NOT IN ('r', 's');];
2603+
$self->poll_query_until($dbname, $query)
2604+
or croak "timed out waiting for subscriber to synchronize data";
2605+
2606+
# Then, wait for the replication to catchup if required.
2607+
if (defined($publisher))
2608+
{
2609+
croak 'subscription name must be specified' unless defined($subname);
2610+
$publisher->wait_for_catchup($subname);
2611+
}
2612+
2613+
print "done\n";
2614+
return;
2615+
}
2616+
2617+
=pod
2618+
25752619
=item $node->wait_for_log(regexp, offset)
25762620
25772621
Waits for the contents of the server log file, starting at the given offset, to

‎src/test/subscription/t/001_rep_changes.pl

Lines changed: 4 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -102,13 +102,8 @@
102102
"CREATE SUBSCRIPTION tap_sub CONNECTION '$publisher_connstr' PUBLICATION tap_pub, tap_pub_ins_only"
103103
);
104104

105-
$node_publisher->wait_for_catchup('tap_sub');
106-
107-
# Also wait for initial table sync to finish
108-
my $synced_query =
109-
"SELECT count(1) = 0 FROM pg_subscription_rel WHERE srsubstate NOT IN ('r', 's');";
110-
$node_subscriber->poll_query_until('postgres', $synced_query)
111-
or die "Timed out while waiting for subscriber to synchronize data";
105+
# Wait for initial table sync to finish
106+
$node_subscriber->wait_for_subscription_sync($node_publisher, 'tap_sub');
112107

113108
my $result =
114109
$node_subscriber->safe_psql('postgres', "SELECT count(*) FROM tab_notrep");
@@ -237,13 +232,8 @@
237232
"CREATE SUBSCRIPTION tap_sub_temp1 CONNECTION '$publisher_connstr' PUBLICATION tap_pub_temp1, tap_pub_temp2"
238233
);
239234

240-
$node_publisher->wait_for_catchup('tap_sub_temp1');
241-
242-
# Also wait for initial table sync to finish
243-
$synced_query =
244-
"SELECT count(1) = 0 FROM pg_subscription_rel WHERE srsubstate NOT IN ('r', 's');";
245-
$node_subscriber->poll_query_until('postgres', $synced_query)
246-
or die "Timed out while waiting for subscriber to synchronize data";
235+
# Wait for initial table sync to finish
236+
$node_subscriber->wait_for_subscription_sync($node_publisher, 'tap_sub_temp1');
247237

248238
# Subscriber table will have no rows initially
249239
$result =

‎src/test/subscription/t/002_types.pl

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -114,13 +114,8 @@
114114
"CREATE SUBSCRIPTION tap_sub CONNECTION '$publisher_connstr' PUBLICATION tap_pub WITH (slot_name = tap_sub_slot)"
115115
);
116116

117-
$node_publisher->wait_for_catchup('tap_sub');
118-
119-
# Wait for initial sync to finish as well
120-
my $synced_query =
121-
"SELECT count(1) = 0 FROM pg_subscription_rel WHERE srsubstate NOT IN ('s', 'r');";
122-
$node_subscriber->poll_query_until('postgres', $synced_query)
123-
or die "Timed out while waiting for subscriber to synchronize data";
117+
# Wait for initial sync to finish
118+
$node_subscriber->wait_for_subscription_sync($node_publisher, 'tap_sub');
124119

125120
# Insert initial test data
126121
$node_publisher->safe_psql(

‎src/test/subscription/t/004_sync.pl

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -39,13 +39,8 @@
3939
"CREATE SUBSCRIPTION tap_sub CONNECTION '$publisher_connstr' PUBLICATION tap_pub"
4040
);
4141

42-
$node_publisher->wait_for_catchup('tap_sub');
43-
44-
# Also wait for initial table sync to finish
45-
my $synced_query =
46-
"SELECT count(1) = 0 FROM pg_subscription_rel WHERE srsubstate NOT IN ('r', 's');";
47-
$node_subscriber->poll_query_until('postgres', $synced_query)
48-
or die "Timed out while waiting for subscriber to synchronize data";
42+
# Wait for initial table sync to finish
43+
$node_subscriber->wait_for_subscription_sync($node_publisher, 'tap_sub');
4944

5045
my $result =
5146
$node_subscriber->safe_psql('postgres', "SELECT count(*) FROM tab_rep");
@@ -71,8 +66,7 @@
7166
$node_subscriber->safe_psql('postgres', "DELETE FROM tab_rep;");
7267

7368
# wait for sync to finish this time
74-
$node_subscriber->poll_query_until('postgres', $synced_query)
75-
or die "Timed out while waiting for subscriber to synchronize data";
69+
$node_subscriber->wait_for_subscription_sync;
7670

7771
# check that all data is synced
7872
$result =
@@ -107,8 +101,7 @@
107101
);
108102

109103
# and wait for data sync to finish again
110-
$node_subscriber->poll_query_until('postgres', $synced_query)
111-
or die "Timed out while waiting for subscriber to synchronize data";
104+
$node_subscriber->wait_for_subscription_sync;
112105

113106
# check that all data is synced
114107
$result =
@@ -133,8 +126,7 @@
133126
"ALTER SUBSCRIPTION tap_sub REFRESH PUBLICATION");
134127

135128
# wait for sync to finish
136-
$node_subscriber->poll_query_until('postgres', $synced_query)
137-
or die "Timed out while waiting for subscriber to synchronize data";
129+
$node_subscriber->wait_for_subscription_sync;
138130

139131
$result = $node_subscriber->safe_psql('postgres',
140132
"SELECT count(*) FROM tab_rep_next");

‎src/test/subscription/t/005_encoding.pl

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,8 @@
3232
"CREATE SUBSCRIPTION mysub CONNECTION '$publisher_connstr' PUBLICATION mypub;"
3333
);
3434

35-
$node_publisher->wait_for_catchup('mysub');
36-
37-
# Wait for initial sync to finish as well
38-
my $synced_query =
39-
"SELECT count(1) = 0 FROM pg_subscription_rel WHERE srsubstate NOT IN ('s', 'r');";
40-
$node_subscriber->poll_query_until('postgres', $synced_query)
41-
or die "Timed out while waiting for subscriber to synchronize data";
35+
# Wait for initial sync to finish
36+
$node_subscriber->wait_for_subscription_sync($node_publisher, 'mysub');
4237

4338
$node_publisher->safe_psql('postgres',
4439
q{INSERT INTO test1 VALUES (1, E'Mot\xc3\xb6rhead')}); # hand-rolled UTF-8

‎src/test/subscription/t/006_rewrite.pl

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,8 @@
2828
"CREATE SUBSCRIPTION mysub CONNECTION '$publisher_connstr' PUBLICATION mypub;"
2929
);
3030

31-
$node_publisher->wait_for_catchup('mysub');
32-
33-
# Wait for initial sync to finish as well
34-
my $synced_query =
35-
"SELECT count(1) = 0 FROM pg_subscription_rel WHERE srsubstate NOT IN ('s', 'r');";
36-
$node_subscriber->poll_query_until('postgres', $synced_query)
37-
or die "Timed out while waiting for subscriber to synchronize data";
31+
# Wait for initial sync to finish
32+
$node_subscriber->wait_for_subscription_sync($node_publisher, 'mysub');
3833

3934
$node_publisher->safe_psql('postgres',
4035
q{INSERT INTO test1 (a, b) VALUES (1, 'one'), (2, 'two');});

‎src/test/subscription/t/008_diff_schema.pl

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -38,13 +38,8 @@
3838
"CREATE SUBSCRIPTION tap_sub CONNECTION '$publisher_connstr' PUBLICATION tap_pub"
3939
);
4040

41-
$node_publisher->wait_for_catchup('tap_sub');
42-
43-
# Also wait for initial table sync to finish
44-
my $synced_query =
45-
"SELECT count(1) = 0 FROM pg_subscription_rel WHERE srsubstate NOT IN ('r', 's');";
46-
$node_subscriber->poll_query_until('postgres', $synced_query)
47-
or die "Timed out while waiting for subscriber to synchronize data";
41+
# Wait for initial table sync to finish
42+
$node_subscriber->wait_for_subscription_sync($node_publisher, 'tap_sub');
4843

4944
my $result =
5045
$node_subscriber->safe_psql('postgres',
@@ -105,8 +100,7 @@
105100
$node_subscriber->safe_psql('postgres',
106101
"ALTER SUBSCRIPTION tap_sub REFRESH PUBLICATION");
107102

108-
$node_subscriber->poll_query_until('postgres', $synced_query)
109-
or die "Timed out while waiting for subscriber to synchronize data";
103+
$node_subscriber->wait_for_subscription_sync;
110104

111105
# Add replica identity column. (The serial is not necessary, but it's
112106
# a convenient way to get a default on the new column so that rows

‎src/test/subscription/t/010_truncate.pl

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -67,10 +67,7 @@
6767
);
6868

6969
# Wait for initial sync of all subscriptions
70-
my $synced_query =
71-
"SELECT count(1) = 0 FROM pg_subscription_rel WHERE srsubstate NOT IN ('r', 's');";
72-
$node_subscriber->poll_query_until('postgres', $synced_query)
73-
or die "Timed out while waiting for subscriber to synchronize data";
70+
$node_subscriber->wait_for_subscription_sync;
7471

7572
# insert data to truncate
7673

@@ -211,8 +208,7 @@
211208
);
212209

213210
# wait for initial data sync
214-
$node_subscriber->poll_query_until('postgres', $synced_query)
215-
or die "Timed out while waiting for subscriber to synchronize data";
211+
$node_subscriber->wait_for_subscription_sync;
216212

217213
# insert data to truncate
218214

‎src/test/subscription/t/011_generated.pl

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,7 @@
4040
);
4141

4242
# Wait for initial sync of all subscriptions
43-
my $synced_query =
44-
"SELECT count(1) = 0 FROM pg_subscription_rel WHERE srsubstate NOT IN ('r', 's');";
45-
$node_subscriber->poll_query_until('postgres', $synced_query)
46-
or die "Timed out while waiting for subscriber to synchronize data";
43+
$node_subscriber->wait_for_subscription_sync;
4744

4845
my $result = $node_subscriber->safe_psql('postgres', "SELECT a, b FROM tab1");
4946
is( $result, qq(1|22

‎src/test/subscription/t/013_partition.pl

Lines changed: 6 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -153,12 +153,8 @@ BEGIN
153153
});
154154

155155
# Wait for initial sync of all subscriptions
156-
my $synced_query =
157-
"SELECT count(1) = 0 FROM pg_subscription_rel WHERE srsubstate NOT IN ('r', 's');";
158-
$node_subscriber1->poll_query_until('postgres', $synced_query)
159-
or die "Timed out while waiting for subscriber to synchronize data";
160-
$node_subscriber2->poll_query_until('postgres', $synced_query)
161-
or die "Timed out while waiting for subscriber to synchronize data";
156+
$node_subscriber1->wait_for_subscription_sync;
157+
$node_subscriber2->wait_for_subscription_sync;
162158

163159
# Tests for replication using leaf partition identity and schema
164160

@@ -483,10 +479,8 @@ BEGIN
483479
"ALTER SUBSCRIPTION sub2 SET PUBLICATION pub_lower_level, pub_all");
484480

485481
# Wait for initial sync of all subscriptions
486-
$node_subscriber1->poll_query_until('postgres', $synced_query)
487-
or die "Timed out while waiting for subscriber to synchronize data";
488-
$node_subscriber2->poll_query_until('postgres', $synced_query)
489-
or die "Timed out while waiting for subscriber to synchronize data";
482+
$node_subscriber1->wait_for_subscription_sync;
483+
$node_subscriber2->wait_for_subscription_sync;
490484

491485
# check that data is synced correctly
492486
$result = $node_subscriber1->safe_psql('postgres',
@@ -557,8 +551,7 @@ BEGIN
557551

558552
# make sure the subscription on the second subscriber is synced, before
559553
# continuing
560-
$node_subscriber2->poll_query_until('postgres', $synced_query)
561-
or die "Timed out while waiting for subscriber to synchronize data";
554+
$node_subscriber2->wait_for_subscription_sync;
562555

563556
# Insert a change into the leaf partition, should be replicated through
564557
# the partition root (thanks to the FOR ALL TABLES partition).
@@ -813,8 +806,7 @@ BEGIN
813806
$node_subscriber2->safe_psql('postgres',
814807
"ALTER SUBSCRIPTION sub2 REFRESH PUBLICATION");
815808

816-
$node_subscriber2->poll_query_until('postgres', $synced_query)
817-
or die "Timed out while waiting for subscriber to synchronize data";
809+
$node_subscriber2->wait_for_subscription_sync;
818810

819811
# Make partition map cache
820812
$node_publisher->safe_psql('postgres', "INSERT INTO tab5 VALUES (1, 1)");

‎src/test/subscription/t/014_binary.pl

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,7 @@
4646
. "PUBLICATION tpub WITH (slot_name = tpub_slot, binary = true)");
4747

4848
# Ensure nodes are in sync with each other
49-
$node_publisher->wait_for_catchup('tsub');
50-
$node_subscriber->poll_query_until('postgres',
51-
"SELECT count(1) = 0 FROM pg_subscription_rel WHERE srsubstate NOT IN ('s', 'r');"
52-
) or die "Timed out while waiting for subscriber to synchronize data";
49+
$node_subscriber->wait_for_subscription_sync($node_publisher, 'tsub');
5350

5451
# Insert some content and make sure it's replicated across
5552
$node_publisher->safe_psql(

‎src/test/subscription/t/015_stream.pl

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -41,13 +41,8 @@
4141
"CREATE SUBSCRIPTION tap_sub CONNECTION '$publisher_connstr application_name=$appname' PUBLICATION tap_pub WITH (streaming = on)"
4242
);
4343

44-
$node_publisher->wait_for_catchup($appname);
45-
46-
# Also wait for initial table sync to finish
47-
my $synced_query =
48-
"SELECT count(1) = 0 FROM pg_subscription_rel WHERE srsubstate NOT IN ('r', 's');";
49-
$node_subscriber->poll_query_until('postgres', $synced_query)
50-
or die "Timed out while waiting for subscriber to synchronize data";
44+
# Wait for initial table sync to finish
45+
$node_subscriber->wait_for_subscription_sync($node_publisher, $appname);
5146

5247
my $result =
5348
$node_subscriber->safe_psql('postgres',

‎src/test/subscription/t/016_stream_subxact.pl

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -41,13 +41,8 @@
4141
"CREATE SUBSCRIPTION tap_sub CONNECTION '$publisher_connstr application_name=$appname' PUBLICATION tap_pub WITH (streaming = on)"
4242
);
4343

44-
$node_publisher->wait_for_catchup($appname);
45-
46-
# Also wait for initial table sync to finish
47-
my $synced_query =
48-
"SELECT count(1) = 0 FROM pg_subscription_rel WHERE srsubstate NOT IN ('r', 's');";
49-
$node_subscriber->poll_query_until('postgres', $synced_query)
50-
or die "Timed out while waiting for subscriber to synchronize data";
44+
# Wait for initial table sync to finish
45+
$node_subscriber->wait_for_subscription_sync($node_publisher, $appname);
5146

5247
my $result =
5348
$node_subscriber->safe_psql('postgres',

‎src/test/subscription/t/017_stream_ddl.pl

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -41,13 +41,8 @@
4141
"CREATE SUBSCRIPTION tap_sub CONNECTION '$publisher_connstr application_name=$appname' PUBLICATION tap_pub WITH (streaming = on)"
4242
);
4343

44-
$node_publisher->wait_for_catchup($appname);
45-
46-
# Also wait for initial table sync to finish
47-
my $synced_query =
48-
"SELECT count(1) = 0 FROM pg_subscription_rel WHERE srsubstate NOT IN ('r', 's');";
49-
$node_subscriber->poll_query_until('postgres', $synced_query)
50-
or die "Timed out while waiting for subscriber to synchronize data";
44+
# Wait for initial table sync to finish
45+
$node_subscriber->wait_for_subscription_sync($node_publisher, $appname);
5146

5247
my $result =
5348
$node_subscriber->safe_psql('postgres',

‎src/test/subscription/t/018_stream_subxact_abort.pl

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -40,13 +40,8 @@
4040
"CREATE SUBSCRIPTION tap_sub CONNECTION '$publisher_connstr application_name=$appname' PUBLICATION tap_pub WITH (streaming = on)"
4141
);
4242

43-
$node_publisher->wait_for_catchup($appname);
44-
45-
# Also wait for initial table sync to finish
46-
my $synced_query =
47-
"SELECT count(1) = 0 FROM pg_subscription_rel WHERE srsubstate NOT IN ('r', 's');";
48-
$node_subscriber->poll_query_until('postgres', $synced_query)
49-
or die "Timed out while waiting for subscriber to synchronize data";
43+
# Wait for initial table sync to finish
44+
$node_subscriber->wait_for_subscription_sync($node_publisher, $appname);
5045

5146
my $result =
5247
$node_subscriber->safe_psql('postgres',

‎src/test/subscription/t/019_stream_subxact_ddl_abort.pl

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -41,13 +41,8 @@
4141
"CREATE SUBSCRIPTION tap_sub CONNECTION '$publisher_connstr application_name=$appname' PUBLICATION tap_pub WITH (streaming = on)"
4242
);
4343

44-
$node_publisher->wait_for_catchup($appname);
45-
46-
# Also wait for initial table sync to finish
47-
my $synced_query =
48-
"SELECT count(1) = 0 FROM pg_subscription_rel WHERE srsubstate NOT IN ('r', 's');";
49-
$node_subscriber->poll_query_until('postgres', $synced_query)
50-
or die "Timed out while waiting for subscriber to synchronize data";
44+
# Wait for initial table sync to finish
45+
$node_subscriber->wait_for_subscription_sync($node_publisher, $appname);
5146

5247
my $result =
5348
$node_subscriber->safe_psql('postgres',

0 commit comments

Comments
 (0)