pg_probackup/tests

****see wiki

Note: For now these tests work on Linux and "kinda" work on Windows

Note: tests require python3 to work properly.

Windows Note: For tablespaces tests to work on Windows, you should explicitly(!) grant current user full access to tmp_dirs

Check physical correctness of restored instances:
 Apply this patch to disable HINT BITS: https://gist.github.com/gsmol/2bb34fd3ba31984369a72cc1c27a36b6
 export PG_PROBACKUP_PARANOIA=ON

Check archive compression:
 export ARCHIVE_COMPRESSION=ON

Enable compatibility tests:
 export PGPROBACKUPBIN_OLD=/path/to/previous_version_pg_probackup_binary

Specify path to pg_probackup binary file. By default tests use <Path to Git repository>/pg_probackup/
 export PGPROBACKUPBIN=<path to pg_probackup>

Remote backup depends on key authentication to local machine via ssh as current user.
 export PGPROBACKUP_SSH_REMOTE=ON

Run tests that are relied on advanced debugging features. For this mode, pg_probackup should be compiled without optimizations. For example:
CFLAGS="-O0" ./configure --prefix=/path/to/prefix --enable-debug --enable-cassert --enable-depend --enable-tap-tests --enable-nls

 export PGPROBACKUP_GDB=ON

Run suit of basic simple tests:
 export PG_PROBACKUP_TEST_BASIC=ON

Run ptrack tests:
 export PG_PROBACKUP_PTRACK=ON

Run long (time consuming) tests:
 export PG_PROBACKUP_LONG=ON

Usage:

 sudo sysctl kernel.yama.ptrace_scope=0                                           # only active until the next reboot
or
 sudo sed -i 's/ptrace_scope = 1/ptrace_scope = 0/' /etc/sysctl.d/10-ptrace.conf  # set permanently, needs a reboot to take effect
                                                                                  # see https://www.kernel.org/doc/Documentation/security/Yama.txt for possible implications of setting this parameter permanently
 pip install testgres
 export PG_CONFIG=/path/to/pg_config
 python -m unittest [-v] tests[.specific_module][.class.test]

Environment variables

Variable	Possible values	Required	Default value	Description
KEEP_LOGS	Any	No	Not set	If this variable is set to '1', 'y' or 'Y' then test logs are kept after the successful execution of a test, otherwise test logs are deleted upon the successful execution of a test
PG_PROBACKUP_S3_TEST	Not set, minio, VK	No	Not set	If set, specifies the type of the S3 storage for the tests, otherwise signifies to the tests that the storage is not an S3 one
PG_PROBACKUP_S3_CONFIG_FILE	Not set, path to config file, True	No	Not set	Specifies the path to an S3 configuration file. If set, all commands will include --s3-config-file='path'. If 'True', the default configuration file at ./s3/tests/s3.conf will be used
PGPROBACKUP_TMP_DIR	File path	No	tmp_dirs	The root of the temporary directory hierarchy where tests store data and logs. Relative paths start from the tests directory.

Troubleshooting FAQ

Python tests failure

1. Could not open extension "..."

testgres.exceptions.QueryException ERROR:  could not open extension control file "<postgres_build_dir>/share/extension/amcheck.control": No such file or directory

Solution:

You have no <postgres_src_root>/contrib/... extension installed, please do

cd <postgres_src_root>
make install-world