1
0
mirror of https://github.com/pgbackrest/pgbackrest.git synced 2024-12-12 10:04:14 +02:00
pgbackrest/test
David Steele 9a47b88da3 Add links to custom coverage report.
When multiple files were missing coverage it could be hard to locate the coverage report for a specific file.

Add links for uncovered files to make this easier.

Also move table titles out of the table so they are valid html.
2020-03-16 20:02:36 -04:00
..
certificate
code-count Update code classification and remove XS definition. 2020-03-14 18:30:24 -04:00
data
expect Add lz4 compression support. 2020-03-10 14:45:27 -04:00
lib/pgBackRestTest Add links to custom coverage report. 2020-03-16 20:02:36 -04:00
patch Configure and make improvements. 2020-03-13 09:07:57 -04:00
src Reduce variables extern'd by the common/log module in debug builds. 2020-03-16 18:16:27 -04:00
.gitignore Move coverage results to test/result. 2020-03-14 15:29:42 -04:00
container.yaml Add lz4 compression support. 2020-03-10 14:45:27 -04:00
define.yaml Reduce variables extern'd by the common/log module in debug builds. 2020-03-16 18:16:27 -04:00
README.md Fix typos in the documentation. 2019-08-26 12:26:00 -04:00
test.pl Move raw coverage results to test/result/raw path. 2020-03-16 08:41:32 -04:00
travis.pl Rename BackRestDoc Perl module to pgBackRestDoc. 2020-03-10 15:41:56 -04:00
Vagrantfile Forbid access to /tmp/pgbackrest in the Vagrantfile. 2020-03-16 17:27:01 -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