1
0
mirror of https://github.com/pgbackrest/pgbackrest.git synced 2024-12-12 10:04:14 +02:00
pgbackrest/test
Cynthia Shang 38b72eded4 Document how to contribute to pgBackRest.
There's a lot more to be done here, but this is a good start.
2019-10-08 15:27:17 -04:00
..
certificate New test containers with static test certificates. 2018-11-21 18:13:37 -05:00
code-count Rename infoManifest module to manifest. 2019-09-05 19:53:00 -04:00
data Automate generation of WAL and pg_control test files. 2017-11-18 20:02:54 -05:00
docker Use a prebuilt s3 server container for documentation and tests. 2018-06-12 13:43:15 -04:00
expect PostgreSQL 12 support. 2019-10-01 13:20:43 -04:00
lib/pgBackRestTest Allow most unit tests to run outside of a container. 2019-10-08 12:06:30 -04:00
src Allow most unit tests to run outside of a container. 2019-10-08 12:06:30 -04:00
.gitignore Add configure script for improved multi-platform support. 2019-04-26 08:08:23 -04:00
container.yaml Add PostgreSQL 12 to u18 container. 2019-09-27 09:35:59 -04:00
define.yaml Allow most unit tests to run outside of a container. 2019-10-08 12:06:30 -04:00
README.md Fix typos in the documentation. 2019-08-26 12:26:00 -04:00
test.pl Allow most unit tests to run outside of a container. 2019-10-08 12:06:30 -04:00
travis.pl Allow most unit tests to run outside of a container. 2019-10-08 12:06:30 -04:00
Vagrantfile Document how to contribute to pgBackRest. 2019-10-08 15:27:17 -04:00

pgBackRest
Regression, Unit, & Integration Testing

Introduction

pgBackRest uses Docker to run tests and generate documentation. Docker's light-weight virtualization provides the a good balance between proper OS emulation and performance (especially startup)

A Vagrantfile is provided that contains the complete configuration required to run pgBackRest tests and build documentation. If Vagrant is not suitable then the Vagrantfile still contains the configuration steps required to build a test system.

NOTE: this is not required for normal operation of pgBackRest.

Testing

The easiest way to start testing pgBackRest is with the included Vagrantfile.

Build Vagrant and Logon:

cd test
vagrant up
vagrant ssh

The vagrant up command may take some time as a number of Docker containers must also be built. The vagrant ssh command automatically logs onto the VM.

Run All Tests:

/backrest/test/test.pl

Run Tests for a Specific OS:

/backrest/test/test.pl --vm=co6

Run Tests for a Specific OS and Module:

/backrest/test/test.pl --vm=co6 --module=backup

Run Tests for a Specific OS, Module, and Test:

/backrest/test/test.pl --vm=co6 --module=backup --test=full

Run Tests for a Specific OS, Module, Test, and Run:

/backrest/test/test.pl --vm=co6 --module=backup --test=full --run=1

Run Tests for a Specific OS, Module, Test, and Process Max:

/backrest/test/test.pl --vm=co6 --module=backup --test=full --process-max=4

NOTE: process-max is only applicable to the synthetic and full tests in the backup module.

Run Tests for a Specific OS, Module, Test, Process Max, and Database Version:

/backrest/test/test.pl --vm=co6 --module=backup --test=full --process-max=4 --pg-version=9.4

NOTE: pg-version is only applicable to the full test in the backup module.

Iterate All Possible Test Combinations:

/backrest/test/test.pl --dry-run