Enable back trace.

Back tracing helps with debugging by showing more detail about were an error happened.

false
Buffer size for I/O operations.

Buffer size used for copy, compress, encrypt, and other operations. The number of buffers used depends on options and each operation may use additional memory, e.g. gz compression may use an additional 256KiB of memory.

Allowed values are 16KiB, 32KiB, 64KiB, 128KiB, 256KiB, 512KiB, and 1MiB.

1MiB
Generate code coverage.

Coverage helps determine that tests adequately test the code.

n
Level for harness logging.

Log level for the test harness (as opposed to the test being run).

The following log levels are supported:

off
- No logging at all (not recommended)
error
- Log only errors
warn
- Log warnings and errors
info
- Log info, warnings, and errors
detail
- Log detail, info, warnings, and errors
debug
- Log debug, detail, info, warnings, and errors
trace
- Log trace (very verbose debugging), debug, info, warnings, and errors
error
Level for test logging.

Log level for the test being run (as opposed to the test harness).

Supported log levels are the same as log-level

error
Enable timestamp in logging.

Enables the timestamp in console and file logging. This option is disabled in special situations such as generating documentation.

n
Use a neutral umask.

Sets the umask to 0000 so modes are created in a sensible way. The default directory mode is 0750 and default file mode is 0640. The lock and log directories set the directory and file mode to 0770 and 0660 respectively.

To use the executing user's umask instead specify neutral-umask=n in the config file or --no-neutral-umask on the command line.

n
Optimize test.

Compile test with optimizations.

n
version for integration test.

Version of to use for the integration test.

16
Generate profile report.

Profiling helps identify bottlenecks in the code.

n
Path to code repository.

Path to the original code repository or a copy.

/path/to/pgbackrest
Scale performance test.

Allows performance tests to be scaled from the default.

10
Module test to run.

Run an individual test in a module.

2
Path where test will run.

This path will be managed entirely by the test harness.

n
Timezone for testing.

Used to ensure that different timezones do not change test results.

America/New_York
VM to run test on.

Name of VM to run the test on.

rh7
VM id to run test on.

Allows more than one test to run simultaneously.

3
Get help.

Three levels of help are provided. If no command is specified then general help will be displayed. If a command is specified (e.g. pgbackrest help backup) then a full description of the command will be displayed along with a list of valid options. If an option is specified in addition to a command (e.g. pgbackrest help backup type) then a full description of the option as it applies to the command will be displayed.

Run a test.

By default tests expect to run with the code repository in a subpath named pgbackrest. Tests will be run in a subpath named test.

A test can be run by using the module option, e.g. --module=common/error.

Get version.

Displays installed version.