{[project]}

{[project]} testing configuration requirements, setup, and options.

# Introduction

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 tests and build documentation. If Vagrant is not suitable then the `Vagrantfile` still contains the configuration steps required to build a test system.

this is not required for normal operation of .

# Testing

The easiest way to start testing 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
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
pg-version is only applicable to the full test in the backup module.

Iterate All Possible Test Combinations

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