Skip to content

Commit 03cfb3a

Browse files
author
jcoleman
committed
General test README cleanup.
1 parent 1795eb2 commit 03cfb3a

File tree

2 files changed

+9
-2
lines changed

2 files changed

+9
-2
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,7 @@ See the [pg_partman.md file](doc/pg_partman.md) in the doc folder for full detai
8888

8989
TESTING
9090
-------
91+
9192
This extension can use the pgTAP unit testing suite to evalutate if it is working properly (http://www.pgtap.org).
92-
WARNING: You MUST increase max_locks_per_transaction above the default value of 64. For me, 128 has worked well so far. This is due to the sub-partitioning tests that create/destroy several hundred tables in a single transaction. If you don't do this, you risk a cluster crash when running subpartitioning tests.
9393

94+
See the [testing README](test/README_test.md) for more information.

test/README_test.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ http://pgTAP.org/
77

88
A minimum version of pgtap 0.99.1 is required for pg_partman's test suite.
99

10+
## General Setup
11+
12+
WARNING: You MUST increase `max_locks_per_transaction` above the default value of 64. For me, 128 has worked well so far. This is due to the sub-partitioning tests that create/destroy several hundred tables in a single transaction. If you don't do this, you risk a cluster crash when running subpartitioning tests.
13+
1014
Tests assume that the required extensions have been installed in the following schemas:
1115

1216
pg_partman: partman
@@ -20,7 +24,9 @@ Once that's done, it's best to use the **pg_prove** script that pgTAP comes with
2024

2125
pg_prove -ovf /path/to/partman/test/*.sql
2226

23-
For most tests, they must be run by a superuser since roles & schemas are created & dropped as part of the test. There is a separate test script for each of the partitioning types. The tests are not required to run pg_partman, so if you don't feel safe doing this you don't need to run the tests. But if you are running into problems and report any issues without a clear explanation of what is wrong, I will ask that you run the test suite so you can try and narrow down where the problem may be. You are free to look through to tests to see exactly what they're doing. All tests in the top level of the test folder are run inside a transaction that is rolled back, so they should not change anything (except jobmon logging as mentioned).
27+
Most tests must be run by a superuser since roles & schemas are created & dropped as part of the test. There is a separate test script for each of the partitioning types. The tests are not required to run pg_partman, so if you don't feel safe doing this you don't need to run the tests. But if you are running into problems and report any issues without a clear explanation of what is wrong, I will ask that you run the test suite so you can try and narrow down where the problem may be. You are free to look through to tests to see exactly what they're doing. All tests in the top level of the test folder are run inside a transaction that is rolled back, so they should not change anything (except jobmon logging as mentioned).
28+
29+
## Specific Test Types
2430

2531
Tests for the time-custom partition type are in their own folder. The 30second test frequently errors out if run in certain 30 second blocks. Waiting for the next 30 second block and running it again should allow it to pass. Same goes for the 30 second test in the native folder.
2632

0 commit comments

Comments
 (0)