1
0
mirror of https://github.com/pgbackrest/pgbackrest.git synced 2024-12-12 10:04:14 +02:00
pgbackrest/test/README.md
David Steele c9b49b0d7e Doc engine improvements.
Bug Fixes:

* Fixed and issue that suppressed exceptions in PDF builds.

Features:

* Allow a source to be included as a section so large documents can be broken up.
* Added section link support to Markdown output.
* Added list support to PDF output.
* Added include option to explicitly build sources (complements the exclude option though both cannot be used in the same invocation).
* Added keyword-add option to add keywords without overriding the default keyword.
* Added debug option to doc.pl to easily add the debug keyword to documentation builds.
* Added pre option to doc.pl to easily add the pre keyword to documentation builds.

Refactoring:

* Improvements to markdown rendering.
* Remove code dependency on project variable, instead use title param.
2016-11-17 16:35:11 -05:00

1.9 KiB

pgBackRest
Regression, Unit, & Integration Testing

Introduction

pgBackRest uses Docker to run tests and generate documentation. Docker's light-weight virualization 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 that 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 that 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 --db-version=9.4

Note that db-version is only applicable to the full test in the backup module.

Iterate All Possible Test Combinations:

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