db/pgbackrest
1
0
Fork 0
mirror of https://github.com/pgbackrest/pgbackrest.git synced 2025-07-05 00:28:52 +02:00
Code Issues Releases Activity
Files
20bb544e7a321562bf0c9061a91369bb6a12d7c1
pgbackrest/test/src/module/command/helpTest.c

466 lines
26 KiB
C
Raw Normal View History

Implement help command in C.
2018-01-23 13:34:24 -05:00
/***********************************************************************************************************************************
Test Help Command
***********************************************************************************************************************************/
#include "config/parse.h"
Simplify storage object names. Remove "File" and "Driver" from object names so they are shorter and easier to keep consistent. Also remove the "driver" directory so storage implementations are visible directly under "storage".
2019-05-03 15:46:15 -04:00
#include "storage/posix/storage.h"
Implement help command in C.
2018-01-23 13:34:24 -05:00
#include "storage/storage.h"
#include "version.h"
Use harnessCfgLoadRaw() in command/help unit test. This correctly set defaults from cfgLoadUpdateOption(), e.g. repo-host-cmd.
2020-10-19 16:27:52 -04:00
#include "common/harnessConfig.h"
Implement help command in C.
2018-01-23 13:34:24 -05:00
/***********************************************************************************************************************************
Test Run
***********************************************************************************************************************************/
Fix non-compliant formatting for function declarations. Per review by Cynthia Shang.
2018-01-31 18:22:25 -05:00
void
Enable -Wstrict-prototypes and update all void functions to conform.
2018-08-03 19:19:14 -04:00
testRun(void)
Implement help command in C.
2018-01-23 13:34:24 -05:00
{
Add stack trace macros to all functions. Low-level functions only include stack trace in test builds while higher-level functions ship with stack trace built-in. Stack traces include all parameters passed to the function but production builds only create the parameter list when the log level is set high enough, i.e. debug or trace depending on the function.
2018-05-18 11:57:32 -04:00
FUNCTION_HARNESS_VOID();
Implement help command in C.
2018-01-23 13:34:24 -05:00
// Program name a version are used multiple times
Rename PGBACKREST/BACKREST constants to PROJECT. This brings consistency between the C and Perl constants and allows for easier code reuse.
2018-11-24 19:05:03 -05:00
const char *helpVersion = PROJECT_NAME " " PROJECT_VERSION;
Implement help command in C.
2018-01-23 13:34:24 -05:00
// General help text is used in more than one test
Rename strPtr()/strPtrNull() to strZ()/strZNull(). We use the Z suffix in many functions to indicate that we are expecting a zero-terminated string so make this function conform to the pattern. As a bonus the new name is a bit shorter, which is a good quality in a commonly-used function.
2020-07-30 07:49:06 -04:00
const char *generalHelp = strZ(strNewFmt(
Implement help command in C.
2018-01-23 13:34:24 -05:00
"%s - General help\n"
"\n"
"Usage:\n"
" pgbackrest [options] [command]\n"
"\n"
"Commands:\n"
" archive-get Get a WAL segment from the archive.\n"
" archive-push Push a WAL segment to the archive.\n"
" backup Backup a database cluster.\n"
" check Check the configuration.\n"
" expire Expire backups that exceed retention.\n"
" help Get help.\n"
" info Retrieve information about backups.\n"
Add repo-get command.
2021-02-05 10:39:03 -05:00
" repo-get Get files from a repository.\n"
Add repo-ls command.
2021-02-05 10:07:43 -05:00
" repo-ls List files in a repository.\n"
Implement help command in C.
2018-01-23 13:34:24 -05:00
" restore Restore a database cluster.\n"
" stanza-create Create the required stanza data.\n"
" stanza-delete Delete a stanza.\n"
" stanza-upgrade Upgrade a stanza.\n"
" start Allow pgBackRest processes to run.\n"
" stop Stop pgBackRest processes from running.\n"
" version Get version.\n"
"\n"
"Use 'pgbackrest help [command]' for more information.\n",
helpVersion));
// *****************************************************************************************************************************
if (testBegin("helpRenderText()"))
{
Change meaning of TEST_RESULT_STR() macro. This macro was created before the String object existed so subsequent usage with String always included a lot of strPtr() wrapping. TEST_RESULT_STR_Z() had already been introduced but a wholesale replacement of TEST_RESULT_STR() was not done since the priority was on the C migration. Update all calls to (old) TEST_RESULT_STR() with one of the following variants: (new) TEST_RESULT_STR(), TEST_RESULT_STR_Z(), TEST_RESULT_Z(), TEST_RESULT_Z_STR().
2019-12-26 18:08:27 -07:00
TEST_RESULT_STR_Z(helpRenderText(strNew("this is a short sentence"), 0, false, 80), "this is a short sentence", "one line");
Implement help command in C.
2018-01-23 13:34:24 -05:00
Change meaning of TEST_RESULT_STR() macro. This macro was created before the String object existed so subsequent usage with String always included a lot of strPtr() wrapping. TEST_RESULT_STR_Z() had already been introduced but a wholesale replacement of TEST_RESULT_STR() was not done since the priority was on the C migration. Update all calls to (old) TEST_RESULT_STR() with one of the following variants: (new) TEST_RESULT_STR(), TEST_RESULT_STR_Z(), TEST_RESULT_Z(), TEST_RESULT_Z_STR().
2019-12-26 18:08:27 -07:00
TEST_RESULT_STR_Z(
helpRenderText(strNew("this is a short sentence"), 4, false, 14),
Implement help command in C.
2018-01-23 13:34:24 -05:00
"this is a\n"
" short\n"
" sentence",
"three lines, no indent first");
Change meaning of TEST_RESULT_STR() macro. This macro was created before the String object existed so subsequent usage with String always included a lot of strPtr() wrapping. TEST_RESULT_STR_Z() had already been introduced but a wholesale replacement of TEST_RESULT_STR() was not done since the priority was on the C migration. Update all calls to (old) TEST_RESULT_STR() with one of the following variants: (new) TEST_RESULT_STR(), TEST_RESULT_STR_Z(), TEST_RESULT_Z(), TEST_RESULT_Z_STR().
2019-12-26 18:08:27 -07:00
TEST_RESULT_STR_Z(
helpRenderText(strNew("This is a short paragraph.\n\nHere is another one."), 2, true, 16),
Implement help command in C.
2018-01-23 13:34:24 -05:00
" This is a\n"
" short\n"
" paragraph.\n"
"\n"
" Here is\n"
" another one.",
"two paragraphs, indent first");
}
// *****************************************************************************************************************************
if (testBegin("helpRenderValue()"))
{
Move all parse-related rules to parse module. Data required for parsing was spread between the config and defined modules, mostly for historical reasons because the same data was used by Perl. Requiring all the parse rules to be accessed with function interfaces makes the code more complicated and new rules harder to implement. Instead, move the data to the parse module so in the most complex cases no interface functions are needed. This reduces the total amount of code and paves the way for more complex parse rules.
2020-12-17 09:32:31 -05:00
TEST_RESULT_STR_Z(helpRenderValue(varNewBool(true), cfgOptTypeBoolean), "y", "boolean y");
TEST_RESULT_STR_Z(helpRenderValue(varNewBool(false), cfgOptTypeBoolean), "n", "boolean n");
TEST_RESULT_STR_Z(helpRenderValue(varNewStrZ("test-string"), cfgOptTypeString), "test-string", "string");
TEST_RESULT_STR_Z(helpRenderValue(varNewInt64(1234), cfgOptTypeInteger), "1234", "int");
TEST_RESULT_STR_Z(helpRenderValue(varNewInt64(1234000), cfgOptTypeTime), "1234", "time");
Implement help command in C.
2018-01-23 13:34:24 -05:00
}
// *****************************************************************************************************************************
if (testBegin("helpRender()"))
{
StringList *argList = NULL;
// -------------------------------------------------------------------------------------------------------------------------
argList = strLstNew();
strLstAddZ(argList, "/path/to/pgbackrest");
Use harnessCfgLoadRaw() in command/help unit test. This correctly set defaults from cfgLoadUpdateOption(), e.g. repo-host-cmd.
2020-10-19 16:27:52 -04:00
TEST_RESULT_VOID(harnessCfgLoadRaw(strLstSize(argList), strLstPtr(argList)), "help from empty command line");
Change meaning of TEST_RESULT_STR() macro. This macro was created before the String object existed so subsequent usage with String always included a lot of strPtr() wrapping. TEST_RESULT_STR_Z() had already been introduced but a wholesale replacement of TEST_RESULT_STR() was not done since the priority was on the C migration. Update all calls to (old) TEST_RESULT_STR() with one of the following variants: (new) TEST_RESULT_STR(), TEST_RESULT_STR_Z(), TEST_RESULT_Z(), TEST_RESULT_Z_STR().
2019-12-26 18:08:27 -07:00
TEST_RESULT_STR_Z(helpRender(), generalHelp, " check text");
Implement help command in C.
2018-01-23 13:34:24 -05:00
argList = strLstNew();
strLstAddZ(argList, "/path/to/pgbackrest");
strLstAddZ(argList, "help");
Use harnessCfgLoadRaw() in command/help unit test. This correctly set defaults from cfgLoadUpdateOption(), e.g. repo-host-cmd.
2020-10-19 16:27:52 -04:00
TEST_RESULT_VOID(harnessCfgLoadRaw(strLstSize(argList), strLstPtr(argList)), "help from help command");
Change meaning of TEST_RESULT_STR() macro. This macro was created before the String object existed so subsequent usage with String always included a lot of strPtr() wrapping. TEST_RESULT_STR_Z() had already been introduced but a wholesale replacement of TEST_RESULT_STR() was not done since the priority was on the C migration. Update all calls to (old) TEST_RESULT_STR() with one of the following variants: (new) TEST_RESULT_STR(), TEST_RESULT_STR_Z(), TEST_RESULT_Z(), TEST_RESULT_Z_STR().
2019-12-26 18:08:27 -07:00
TEST_RESULT_STR_Z(helpRender(), generalHelp, " check text");
Implement help command in C.
2018-01-23 13:34:24 -05:00
// -------------------------------------------------------------------------------------------------------------------------
Rename strPtr()/strPtrNull() to strZ()/strZNull(). We use the Z suffix in many functions to indicate that we are expecting a zero-terminated string so make this function conform to the pattern. As a bonus the new name is a bit shorter, which is a good quality in a commonly-used function.
2020-07-30 07:49:06 -04:00
const char *commandHelp = strZ(strNewFmt(
Full branch coverage for command/help/help, common/error, common/ini, and common/log modules.
2018-05-05 09:38:09 -04:00
"%s%s",
helpVersion,
" - 'version' command help\n"
"\n"
"Get version.\n"
"\n"
"Displays installed pgBackRest version.\n"));
argList = strLstNew();
strLstAddZ(argList, "/path/to/pgbackrest");
strLstAddZ(argList, "help");
strLstAddZ(argList, "version");
Use harnessCfgLoadRaw() in command/help unit test. This correctly set defaults from cfgLoadUpdateOption(), e.g. repo-host-cmd.
2020-10-19 16:27:52 -04:00
TEST_RESULT_VOID(harnessCfgLoadRaw(strLstSize(argList), strLstPtr(argList)), "help for version command");
Change meaning of TEST_RESULT_STR() macro. This macro was created before the String object existed so subsequent usage with String always included a lot of strPtr() wrapping. TEST_RESULT_STR_Z() had already been introduced but a wholesale replacement of TEST_RESULT_STR() was not done since the priority was on the C migration. Update all calls to (old) TEST_RESULT_STR() with one of the following variants: (new) TEST_RESULT_STR(), TEST_RESULT_STR_Z(), TEST_RESULT_Z(), TEST_RESULT_Z_STR().
2019-12-26 18:08:27 -07:00
TEST_RESULT_STR_Z(helpRender(), commandHelp, " check text");
Full branch coverage for command/help/help, common/error, common/ini, and common/log modules.
2018-05-05 09:38:09 -04:00
// This test is broken up into multiple strings because C99 does not require compilers to support const strings > 4095 bytes
// -------------------------------------------------------------------------------------------------------------------------
Rename strPtr()/strPtrNull() to strZ()/strZNull(). We use the Z suffix in many functions to indicate that we are expecting a zero-terminated string so make this function conform to the pattern. As a bonus the new name is a bit shorter, which is a good quality in a commonly-used function.
2020-07-30 07:49:06 -04:00
commandHelp = strZ(strNewFmt(
Add support for additional pgBackRest configuration files. Configuration files are loaded from the directory specified by the --config-include-path option. Add --config-path option for overriding the default base path of the --config and --config-include-path option. Contributed by Cynthia Shang.
2018-04-19 11:09:39 -04:00
"%s%s%s",
helpVersion,
Update help test to use restore command to provide better coverage.
2018-05-01 13:20:48 -04:00
" - 'restore' command help\n"
Implement help command in C.
2018-01-23 13:34:24 -05:00
"\n"
Update help test to use restore command to provide better coverage.
2018-05-01 13:20:48 -04:00
"Restore a database cluster.\n"
Implement help command in C.
2018-01-23 13:34:24 -05:00
"\n"
Update help test to use restore command to provide better coverage.
2018-05-01 13:20:48 -04:00
"This command is generally run manually, but there are instances where it might\n"
"be automated.\n"
Implement help command in C.
2018-01-23 13:34:24 -05:00
"\n"
"Command Options:\n"
"\n"
Add archive-mode option to disable archiving on restore. When restoring a cluster that will be promoted but is not intended to be the new primary, it is important to disable archiving to avoid polluting the repository with useless WAL. This option makes disabling archiving a bit easier.
2020-08-25 15:05:41 -04:00
" --archive-mode preserve or disable archiving on restored\n"
" cluster [default=preserve]\n"
Update help test to use restore command to provide better coverage.
2018-05-01 13:20:48 -04:00
" --db-include restore only specified databases\n"
Fix rendering of key/value and list options in help. Reported by Clinton Adams.
2018-05-01 14:07:08 -04:00
" [current=db1, db2]\n"
Update help test to use restore command to provide better coverage.
2018-05-01 13:20:48 -04:00
" --force force a restore [default=n]\n"
" --link-all restore all symlinks [default=n]\n"
" --link-map modify the destination of a symlink\n"
Fix rendering of key/value and list options in help. Reported by Clinton Adams.
2018-05-01 14:07:08 -04:00
" [current=/link1=/dest1, /link2=/dest2]\n"
Update help test to use restore command to provide better coverage.
2018-05-01 13:20:48 -04:00
" --recovery-option set an option in recovery.conf\n"
" --set backup set to restore [default=latest]\n"
" --tablespace-map restore a tablespace into the specified\n"
" directory\n"
" --tablespace-map-all restore all tablespaces into the specified\n"
" directory\n"
" --target recovery target\n"
" --target-action action to take when recovery target is\n"
" reached [default=pause]\n"
" --target-exclusive stop just before the recovery target is\n"
" reached [default=n]\n"
" --target-timeline recover along a timeline\n"
" --type recovery type [default=default]\n"
Implement help command in C.
2018-01-23 13:34:24 -05:00
"\n"
"General Options:\n"
"\n"
Add support for additional pgBackRest configuration files. Configuration files are loaded from the directory specified by the --config-include-path option. Add --config-path option for overriding the default base path of the --config and --config-include-path option. Contributed by Cynthia Shang.
2018-04-19 11:09:39 -04:00
" --buffer-size buffer size for file operations\n"
Reduce buffer-size default to 1MiB. The prior default was determined by benchmarking the Perl code prior to the 1.0 release. In general buffer allocation was more expensive in Perl so large buffers gave the best performance. This was due to multiple buffer allocations for each filter in an IO operation. The C code allocates fixed buffers for each IO operation so the cost for buffer allocation is lower than Perl. That being the case it made sense to benchmark the C code to determine the optimal buffer default. The performance/storage tests were used to measure the performance of a variety of filters. 1GiB of data was processed by each filter 10 times and the results of the tests were averaged. While most buffer sizes gave similar performance, 1MiB appeared to perform the best overall. Of course, different architectures are likely to yield different results but this seems like a sensible default. The buffer-size option may still need to be manually configured to give optimal results. Raw test data for reference: 4MB buffer (prior default) copy time 1807ms, avg time 180ms, avg throughput: 5942MB/s md5 time 14200ms, avg time 1420ms, avg throughput: 756MB/s sha1 time 11431ms, avg time 1143ms, avg throughput: 939MB/s sha256 time 23463ms, avg time 2346ms, avg throughput: 457MB/s gzip -6 time 381199ms, avg time 38119ms, avg throughput: 28MB/s lz4 -1 time 15484ms, avg time 1548ms, avg throughput: 693MB/s 1MB buffer (new default) copy time 1760ms, avg time 176ms, avg throughput: 6100MB/s md5 time 13739ms, avg time 1373ms, avg throughput: 781MB/s sha1 time 11025ms, avg time 1102ms, avg throughput: 973MB/s sha256 time 22539ms, avg time 2253ms, avg throughput: 476MB/s gzip -6 time 372995ms, avg time 37299ms, avg throughput: 28MB/s lz4 -1 time 15118ms, avg time 1511ms, avg throughput: 710MB/s 512K buffer copy time 1782ms, avg time 178ms, avg throughput: 6025MB/s md5 time 13724ms, avg time 1372ms, avg throughput: 782MB/s sha1 time 10959ms, avg time 1095ms, avg throughput: 979MB/s sha256 time 22982ms, avg time 2298ms, avg throughput: 467MB/s gzip -6 time 378120ms, avg time 37812ms, avg throughput: 28MB/s lz4 -1 time 15484ms, avg time 1548ms, avg throughput: 693MB/s 256K buffer copy time 1805ms, avg time 180ms, avg throughput: 5948MB/s md5 time 13706ms, avg time 1370ms, avg throughput: 783MB/s sha1 time 11074ms, avg time 1107ms, avg throughput: 969MB/s sha256 time 22588ms, avg time 2258ms, avg throughput: 475MB/s gzip -6 time 372645ms, avg time 37264ms, avg throughput: 28MB/s lz4 -1 time 16346ms, avg time 1634ms, avg throughput: 656MB/s
2020-05-19 16:58:49 -04:00
" [current=32768, default=1048576]\n"
Add support for additional pgBackRest configuration files. Configuration files are loaded from the directory specified by the --config-include-path option. Add --config-path option for overriding the default base path of the --config and --config-include-path option. Contributed by Cynthia Shang.
2018-04-19 11:09:39 -04:00
" --cmd-ssh path to ssh client executable [default=ssh]\n"
Add infrastructure for multiple compression type support. Add compress-type option and deprecate compress option. Since the compress option is boolean it won't work with multiple compression types. Add logic to cfgLoadUpdateOption() to update compress-type if it is not set directly. The compress option should no longer be referenced outside the cfgLoadUpdateOption() function. Add common/compress/helper module to contain interface functions that work with multiple compression types. Code outside this module should no longer call specific compression drivers, though it may be OK to reference a specific compression type using the new interface (e.g., saving backup history files in gz format). Unit tests only test compression using the gz format because other formats may not be available in all builds. It is the job of integration tests to exercise all compression types. Additional compression types will be added in future commits.
2020-03-06 14:41:03 -05:00
" --compress-level-network network compression level [default=3]\n"
Add support for additional pgBackRest configuration files. Configuration files are loaded from the directory specified by the --config-include-path option. Add --config-path option for overriding the default base path of the --config and --config-include-path option. Contributed by Cynthia Shang.
2018-04-19 11:09:39 -04:00
" --config pgBackRest configuration file\n"
" [default=/etc/pgbackrest/pgbackrest.conf]\n"
" --config-include-path path to additional pgBackRest configuration\n"
" files [default=/etc/pgbackrest/conf.d]\n"
" --config-path base path of pgBackRest configuration files\n"
" [default=/etc/pgbackrest]\n"
Add checksum delta for incremental backups. Use checksums rather than timestamps to determine if files have changed. This is useful in cases where the timestamps may not be trustworthy, e.g. when performing an incremental after failing over to a standby. If checksum delta is enabled then checksums will be used for verification of resumed backups, even if they are full. Resumes have always used checksums to verify the files in the repository, enabling delta performs checksums on the database files as well. Note that the user must manually enable this feature in cases were it would be useful or just keep in enabled all the time. A future commit will address automatically enabling the feature in cases where it seems likely to be useful. Contributed by Cynthia Shang.
2018-09-19 11:12:45 -04:00
" --delta restore or backup using checksums [default=n]\n"
Add io-timeout option. Timeout used for connections and read/write operations. Note that the entire read/write operation does not need to complete within this timeout but some progress must be made, even if it is only a single byte.
2020-04-17 09:18:52 -04:00
" --io-timeout i/O timeout [default=60]\n"
Add support for additional pgBackRest configuration files. Configuration files are loaded from the directory specified by the --config-include-path option. Add --config-path option for overriding the default base path of the --config and --config-include-path option. Contributed by Cynthia Shang.
2018-04-19 11:09:39 -04:00
" --lock-path path where lock files are stored\n"
" [default=/tmp/pgbackrest]\n"
" --neutral-umask use a neutral umask [default=y]\n"
" --process-max max processes to use for compress/transfer\n"
" [default=1]\n"
" --protocol-timeout protocol timeout [default=1830]\n"
Rename tcp-keep-alive option to sck-keep-alive. This is really a socket option so the new name is clearer. Since common/io/socket/tcp will contains a mix of options it makes sense to rename it to socket and cascade name changes as needed.
2020-04-01 15:44:51 -04:00
" --sck-keep-alive keep-alive enable [default=y]\n"
Add support for additional pgBackRest configuration files. Configuration files are loaded from the directory specified by the --config-include-path option. Add --config-path option for overriding the default base path of the --config and --config-include-path option. Contributed by Cynthia Shang.
2018-04-19 11:09:39 -04:00
" --stanza defines the stanza\n"
TCP keep-alive options are configurable. Prior to 2.25 the individual TCP keep-alive options were not being configured due to a missing header. In 2.25 they were being configured incorrectly due to a disconnect between the timeout specified in ms and what was expected by the TCP options, i.e. seconds. Instead make the TCP keep-alive options directly configurable, with correct units and better testing. Keep-alive is enabled by default (though it can be defaulted to the system setting instead) and the rest of the options are not set by default. This is in line with what PostgreSQL does, though PostgreSQL does not allow keep-alive to be defaulted. Also move configuration of TCP options before connect() as PostgreSQL does.
2020-03-31 18:13:11 -04:00
" --tcp-keep-alive-count keep-alive count\n"
" --tcp-keep-alive-idle keep-alive idle time\n"
" --tcp-keep-alive-interval keep-alive interval time\n"
Implement help command in C.
2018-01-23 13:34:24 -05:00
"\n"
"Log Options:\n"
"\n"
Add support for additional pgBackRest configuration files. Configuration files are loaded from the directory specified by the --config-include-path option. Add --config-path option for overriding the default base path of the --config and --config-include-path option. Contributed by Cynthia Shang.
2018-04-19 11:09:39 -04:00
" --log-level-console level for console logging [default=warn]\n"
" --log-level-file level for file logging [default=info]\n"
" --log-level-stderr level for stderr logging [default=warn]\n"
" --log-path path where log files are stored\n"
" [default=/var/log/pgbackrest]\n"
Add log-subprocess option to allow file logging for local and remote subprocesses.
2018-08-22 20:05:49 -04:00
" --log-subprocess enable logging in subprocesses [default=n]\n"
Add support for additional pgBackRest configuration files. Configuration files are loaded from the directory specified by the --config-include-path option. Add --config-path option for overriding the default base path of the --config and --config-include-path option. Contributed by Cynthia Shang.
2018-04-19 11:09:39 -04:00
" --log-timestamp enable timestamp in logging [default=y]\n"
Update help test to use restore command to provide better coverage.
2018-05-01 13:20:48 -04:00
"\n",
"Repository Options:\n"
Implement help command in C.
2018-01-23 13:34:24 -05:00
"\n"
Azure support for repository storage. Azure and Azure-compatible object stores can now be used for repository storage. Currently only shared key authentication is supported but SAS will be added soon.
2020-07-02 16:24:34 -04:00
" --repo-azure-account azure repository account\n"
" --repo-azure-container azure repository container\n"
Add repo-azure-endpoint option. This option allows alternate endpoints (e.g. Azure Government) to be configured.
2020-10-06 17:15:48 -04:00
" --repo-azure-endpoint azure repository endpoint\n"
" [default=blob.core.windows.net]\n"
Add shared access signature (SAS) authorization for Azure. A shared access signature (SAS) provides granular, delegated access to resources in a storage account. This is often preferable to using a shared key which provides more access and is a greater security risk if compromised.
2020-07-09 14:46:48 -04:00
" --repo-azure-key azure repository key\n"
" --repo-azure-key-type azure repository key type [default=shared]\n"
Add support for additional pgBackRest configuration files. Configuration files are loaded from the directory specified by the --config-include-path option. Add --config-path option for overriding the default base path of the --config and --config-include-path option. Contributed by Cynthia Shang.
2018-04-19 11:09:39 -04:00
" --repo-cipher-pass repository cipher passphrase\n"
Redact secure options in the help command. Secure options could show up in the help as "current". While the user must have permissions to see the source of the options (e.g. environment, config file) it's still not a good idea to display them in an unexpected context. Instead show secure options as <redacted> in the help command.
2019-06-24 19:27:13 -04:00
" [current=<redacted>]\n"
Add support for additional pgBackRest configuration files. Configuration files are loaded from the directory specified by the --config-include-path option. Add --config-path option for overriding the default base path of the --config and --config-include-path option. Contributed by Cynthia Shang.
2018-04-19 11:09:39 -04:00
" --repo-cipher-type cipher used to encrypt the repository\n"
Redact secure options in the help command. Secure options could show up in the help as "current". While the user must have permissions to see the source of the options (e.g. environment, config file) it's still not a good idea to display them in an unexpected context. Instead show secure options as <redacted> in the help command.
2019-06-24 19:27:13 -04:00
" [current=aes-256-cbc, default=none]\n"
Add support for additional pgBackRest configuration files. Configuration files are loaded from the directory specified by the --config-include-path option. Add --config-path option for overriding the default base path of the --config and --config-include-path option. Contributed by Cynthia Shang.
2018-04-19 11:09:39 -04:00
" --repo-host repository host when operating remotely via\n"
" SSH [current=backup.example.net]\n"
" --repo-host-cmd pgBackRest exe path on the repository host\n"
Use harnessCfgLoadRaw() in command/help unit test. This correctly set defaults from cfgLoadUpdateOption(), e.g. repo-host-cmd.
2020-10-19 16:27:52 -04:00
" [default=/path/to/pgbackrest]\n"
Add support for additional pgBackRest configuration files. Configuration files are loaded from the directory specified by the --config-include-path option. Add --config-path option for overriding the default base path of the --config and --config-include-path option. Contributed by Cynthia Shang.
2018-04-19 11:09:39 -04:00
" --repo-host-config pgBackRest repository host configuration\n"
" file\n"
" [default=/etc/pgbackrest/pgbackrest.conf]\n"
" --repo-host-config-include-path pgBackRest repository host configuration\n"
" include path [default=/etc/pgbackrest/conf.d]\n"
" --repo-host-config-path pgBackRest repository host configuration\n"
" path [default=/etc/pgbackrest]\n"
" --repo-host-port repository host port when repo-host is set\n"
" --repo-host-user repository host user when repo-host is set\n"
" [default=pgbackrest]\n"
" --repo-path path where backups and archive are stored\n"
" [default=/var/lib/pgbackrest]\n"
Do not lower-case help summaries when first word is an acronym. If the second letter is capital or a digit then the word is likely an acronym so don't lower-case the first letter. For now only the digit case is checked since there are no summaries with a capital as the second letter.
2021-02-19 10:29:29 -05:00
" --repo-s3-bucket S3 repository bucket\n"
" --repo-s3-endpoint S3 repository endpoint\n"
" --repo-s3-key S3 repository access key\n"
" --repo-s3-key-secret S3 repository secret access key\n"
" --repo-s3-key-type S3 repository key type [default=shared]\n"
" --repo-s3-region S3 repository region\n"
" --repo-s3-role S3 repository role\n"
" --repo-s3-token S3 repository security token\n"
" --repo-s3-uri-style S3 URI Style [default=host]\n"
Consolidate less commonly used repository storage options. The following options are renamed as specified: repo1-azure-ca-file -> repo1-storage-ca-file repo1-azure-ca-path -> repo1-storage-ca-path repo1-azure-host -> repo1-storage-host repo1-azure-port -> repo1-storage-port repo1-azure-verify-tls -> repo1-storage-verify-tls repo1-s3-ca-file -> repo1-storage-ca-file repo1-s3-ca-path -> repo1-storage-ca-path repo1-s3-host -> repo1-storage-host repo1-s3-port -> repo1-storage-port repo1-s3-verify-tls -> repo1-storage-verify-tls The old option names (e.g. repo1-s3-port) will continue to work for repo1, but repo2, etc. will require the new names.
2021-03-02 13:51:40 -05:00
" --repo-storage-ca-file repository storage CA file\n"
" --repo-storage-ca-path repository storage CA path\n"
" --repo-storage-host repository storage host\n"
" --repo-storage-port repository storage port [default=443]\n"
" --repo-storage-verify-tls repository storage certificate verify\n"
" [default=y]\n"
Add support for additional pgBackRest configuration files. Configuration files are loaded from the directory specified by the --config-include-path option. Add --config-path option for overriding the default base path of the --config and --config-include-path option. Contributed by Cynthia Shang.
2018-04-19 11:09:39 -04:00
" --repo-type type of storage used for the repository\n"
" [default=posix]\n"
Implement help command in C.
2018-01-23 13:34:24 -05:00
"\n"
"Stanza Options:\n"
"\n"
Add support for additional pgBackRest configuration files. Configuration files are loaded from the directory specified by the --config-include-path option. Add --config-path option for overriding the default base path of the --config and --config-include-path option. Contributed by Cynthia Shang.
2018-04-19 11:09:39 -04:00
" --pg-path postgreSQL data directory\n"
Implement help command in C.
2018-01-23 13:34:24 -05:00
"\n"
Update help test to use restore command to provide better coverage.
2018-05-01 13:20:48 -04:00
"Use 'pgbackrest help restore [option]' for more information.\n"));
Implement help command in C.
2018-01-23 13:34:24 -05:00
argList = strLstNew();
strLstAddZ(argList, "/path/to/pgbackrest");
strLstAddZ(argList, "help");
Update help test to use restore command to provide better coverage.
2018-05-01 13:20:48 -04:00
strLstAddZ(argList, "restore");
Implement help command in C.
2018-01-23 13:34:24 -05:00
strLstAddZ(argList, "--buffer-size=32768");
Redact secure options in the help command. Secure options could show up in the help as "current". While the user must have permissions to see the source of the options (e.g. environment, config file) it's still not a good idea to display them in an unexpected context. Instead show secure options as <redacted> in the help command.
2019-06-24 19:27:13 -04:00
strLstAddZ(argList, "--repo1-cipher-type=aes-256-cbc");
setenv("PGBACKREST_REPO1_CIPHER_PASS", "supersecret", true);
Rename db-* options to pg-* and backup-* options to repo-* to improve consistency. * repo-* options are now indexed although only one is allowed. * List deprecated option names in documentation and command-line help.
2018-02-03 18:27:38 -05:00
strLstAddZ(argList, "--repo1-host=backup.example.net");
Fix rendering of key/value and list options in help. Reported by Clinton Adams.
2018-05-01 14:07:08 -04:00
strLstAddZ(argList, "--link-map=/link1=/dest1");
strLstAddZ(argList, "--link-map=/link2=/dest2");
strLstAddZ(argList, "--db-include=db1");
strLstAddZ(argList, "--db-include=db2");
Use harnessCfgLoadRaw() in command/help unit test. This correctly set defaults from cfgLoadUpdateOption(), e.g. repo-host-cmd.
2020-10-19 16:27:52 -04:00
TEST_RESULT_VOID(harnessCfgLoadRaw(strLstSize(argList), strLstPtr(argList)), "help for restore command");
Redact secure options in the help command. Secure options could show up in the help as "current". While the user must have permissions to see the source of the options (e.g. environment, config file) it's still not a good idea to display them in an unexpected context. Instead show secure options as <redacted> in the help command.
2019-06-24 19:27:13 -04:00
unsetenv("PGBACKREST_REPO1_CIPHER_PASS");
Change meaning of TEST_RESULT_STR() macro. This macro was created before the String object existed so subsequent usage with String always included a lot of strPtr() wrapping. TEST_RESULT_STR_Z() had already been introduced but a wholesale replacement of TEST_RESULT_STR() was not done since the priority was on the C migration. Update all calls to (old) TEST_RESULT_STR() with one of the following variants: (new) TEST_RESULT_STR(), TEST_RESULT_STR_Z(), TEST_RESULT_Z(), TEST_RESULT_Z_STR().
2019-12-26 18:08:27 -07:00
TEST_RESULT_STR_Z(helpRender(), commandHelp, " check text");
Implement help command in C.
2018-01-23 13:34:24 -05:00
// -------------------------------------------------------------------------------------------------------------------------
argList = strLstNew();
strLstAddZ(argList, "/path/to/pgbackrest");
strLstAddZ(argList, "help");
strLstAddZ(argList, "archive-push");
strLstAddZ(argList, "buffer-size");
strLstAddZ(argList, "buffer-size");
Use harnessCfgLoadRaw() in command/help unit test. This correctly set defaults from cfgLoadUpdateOption(), e.g. repo-host-cmd.
2020-10-19 16:27:52 -04:00
TEST_RESULT_VOID(harnessCfgLoadRaw(strLstSize(argList), strLstPtr(argList)), "parse too many options");
Implement help command in C.
2018-01-23 13:34:24 -05:00
TEST_ERROR(helpRender(), ParamInvalidError, "only one option allowed for option help");
argList = strLstNew();
strLstAddZ(argList, "/path/to/pgbackrest");
strLstAddZ(argList, "help");
strLstAddZ(argList, "archive-push");
strLstAddZ(argList, BOGUS_STR);
Use harnessCfgLoadRaw() in command/help unit test. This correctly set defaults from cfgLoadUpdateOption(), e.g. repo-host-cmd.
2020-10-19 16:27:52 -04:00
TEST_RESULT_VOID(harnessCfgLoadRaw(strLstSize(argList), strLstPtr(argList)), "parse bogus option");
Implement help command in C.
2018-01-23 13:34:24 -05:00
TEST_ERROR(helpRender(), OptionInvalidError, "option 'BOGUS' is not valid for command 'archive-push'");
// -------------------------------------------------------------------------------------------------------------------------
Rename strPtr()/strPtrNull() to strZ()/strZNull(). We use the Z suffix in many functions to indicate that we are expecting a zero-terminated string so make this function conform to the pattern. As a bonus the new name is a bit shorter, which is a good quality in a commonly-used function.
2020-07-30 07:49:06 -04:00
const char *optionHelp = strZ(strNewFmt(
Implement help command in C.
2018-01-23 13:34:24 -05:00
"%s - 'archive-push' command - 'buffer-size' option help\n"
"\n"
"Buffer size for file operations.\n"
"\n"
"Set the buffer size used for copy, compress, and uncompress functions. A\n"
"maximum of 3 buffers will be in use at a time per process. An additional\n"
Update the archive-push-queue-max, manifest-save-threshold, and buffer-size options to accept values in KB, MB, GB, TB, or PB where the multiplier is a power of 1024. Contributed by Cynthia Shang.
2018-04-25 15:46:05 -04:00
"maximum of 256K per process may be used for zlib buffers.\n"
"\n"
"Size can be entered in bytes (default) or KB, MB, GB, TB, or PB where the\n"
Command-line help update missed in cabb3f857.
2018-09-11 10:55:55 -04:00
"multiplier is a power of 1024. For example, the case-insensitive value 32k (or\n"
"32KB) can be used instead of 32768.\n"
"\n"
"Allowed values, in bytes, are 16384, 32768, 65536, 131072, 262144, 524288,\n"
"1048576, 2097152, 4194304, 8388608, and 16777216.\n",
Implement help command in C.
2018-01-23 13:34:24 -05:00
helpVersion));
argList = strLstNew();
strLstAddZ(argList, "/path/to/pgbackrest");
strLstAddZ(argList, "help");
strLstAddZ(argList, "archive-push");
strLstAddZ(argList, "buffer-size");
Refactor the common/log tests to not depend on common/harnessLog. common/harnessLog was not ideally suited for general testing and made all the tests quite awkward. Instead, move all code used to test the common/log module into the logTest module and repurpose common/harnessLog to do log expect testing for all other tests in a cleaner way. Add a few exceptions for config testing since the log levels are reset by default in config/parse.
2018-07-20 18:51:42 -04:00
TEST_RESULT_VOID(
Use harnessCfgLoadRaw() in command/help unit test. This correctly set defaults from cfgLoadUpdateOption(), e.g. repo-host-cmd.
2020-10-19 16:27:52 -04:00
harnessCfgLoadRaw(strLstSize(argList), strLstPtr(argList)), "help for archive-push command, buffer-size option");
Reduce buffer-size default to 1MiB. The prior default was determined by benchmarking the Perl code prior to the 1.0 release. In general buffer allocation was more expensive in Perl so large buffers gave the best performance. This was due to multiple buffer allocations for each filter in an IO operation. The C code allocates fixed buffers for each IO operation so the cost for buffer allocation is lower than Perl. That being the case it made sense to benchmark the C code to determine the optimal buffer default. The performance/storage tests were used to measure the performance of a variety of filters. 1GiB of data was processed by each filter 10 times and the results of the tests were averaged. While most buffer sizes gave similar performance, 1MiB appeared to perform the best overall. Of course, different architectures are likely to yield different results but this seems like a sensible default. The buffer-size option may still need to be manually configured to give optimal results. Raw test data for reference: 4MB buffer (prior default) copy time 1807ms, avg time 180ms, avg throughput: 5942MB/s md5 time 14200ms, avg time 1420ms, avg throughput: 756MB/s sha1 time 11431ms, avg time 1143ms, avg throughput: 939MB/s sha256 time 23463ms, avg time 2346ms, avg throughput: 457MB/s gzip -6 time 381199ms, avg time 38119ms, avg throughput: 28MB/s lz4 -1 time 15484ms, avg time 1548ms, avg throughput: 693MB/s 1MB buffer (new default) copy time 1760ms, avg time 176ms, avg throughput: 6100MB/s md5 time 13739ms, avg time 1373ms, avg throughput: 781MB/s sha1 time 11025ms, avg time 1102ms, avg throughput: 973MB/s sha256 time 22539ms, avg time 2253ms, avg throughput: 476MB/s gzip -6 time 372995ms, avg time 37299ms, avg throughput: 28MB/s lz4 -1 time 15118ms, avg time 1511ms, avg throughput: 710MB/s 512K buffer copy time 1782ms, avg time 178ms, avg throughput: 6025MB/s md5 time 13724ms, avg time 1372ms, avg throughput: 782MB/s sha1 time 10959ms, avg time 1095ms, avg throughput: 979MB/s sha256 time 22982ms, avg time 2298ms, avg throughput: 467MB/s gzip -6 time 378120ms, avg time 37812ms, avg throughput: 28MB/s lz4 -1 time 15484ms, avg time 1548ms, avg throughput: 693MB/s 256K buffer copy time 1805ms, avg time 180ms, avg throughput: 5948MB/s md5 time 13706ms, avg time 1370ms, avg throughput: 783MB/s sha1 time 11074ms, avg time 1107ms, avg throughput: 969MB/s sha256 time 22588ms, avg time 2258ms, avg throughput: 475MB/s gzip -6 time 372645ms, avg time 37264ms, avg throughput: 28MB/s lz4 -1 time 16346ms, avg time 1634ms, avg throughput: 656MB/s
2020-05-19 16:58:49 -04:00
TEST_RESULT_STR(helpRender(), strNewFmt("%s\ndefault: 1048576\n", optionHelp), " check text");
Implement help command in C.
2018-01-23 13:34:24 -05:00
strLstAddZ(argList, "--buffer-size=32768");
Refactor the common/log tests to not depend on common/harnessLog. common/harnessLog was not ideally suited for general testing and made all the tests quite awkward. Instead, move all code used to test the common/log module into the logTest module and repurpose common/harnessLog to do log expect testing for all other tests in a cleaner way. Add a few exceptions for config testing since the log levels are reset by default in config/parse.
2018-07-20 18:51:42 -04:00
TEST_RESULT_VOID(
Use harnessCfgLoadRaw() in command/help unit test. This correctly set defaults from cfgLoadUpdateOption(), e.g. repo-host-cmd.
2020-10-19 16:27:52 -04:00
harnessCfgLoadRaw(strLstSize(argList), strLstPtr(argList)), "help for archive-push command, buffer-size option");
Reduce buffer-size default to 1MiB. The prior default was determined by benchmarking the Perl code prior to the 1.0 release. In general buffer allocation was more expensive in Perl so large buffers gave the best performance. This was due to multiple buffer allocations for each filter in an IO operation. The C code allocates fixed buffers for each IO operation so the cost for buffer allocation is lower than Perl. That being the case it made sense to benchmark the C code to determine the optimal buffer default. The performance/storage tests were used to measure the performance of a variety of filters. 1GiB of data was processed by each filter 10 times and the results of the tests were averaged. While most buffer sizes gave similar performance, 1MiB appeared to perform the best overall. Of course, different architectures are likely to yield different results but this seems like a sensible default. The buffer-size option may still need to be manually configured to give optimal results. Raw test data for reference: 4MB buffer (prior default) copy time 1807ms, avg time 180ms, avg throughput: 5942MB/s md5 time 14200ms, avg time 1420ms, avg throughput: 756MB/s sha1 time 11431ms, avg time 1143ms, avg throughput: 939MB/s sha256 time 23463ms, avg time 2346ms, avg throughput: 457MB/s gzip -6 time 381199ms, avg time 38119ms, avg throughput: 28MB/s lz4 -1 time 15484ms, avg time 1548ms, avg throughput: 693MB/s 1MB buffer (new default) copy time 1760ms, avg time 176ms, avg throughput: 6100MB/s md5 time 13739ms, avg time 1373ms, avg throughput: 781MB/s sha1 time 11025ms, avg time 1102ms, avg throughput: 973MB/s sha256 time 22539ms, avg time 2253ms, avg throughput: 476MB/s gzip -6 time 372995ms, avg time 37299ms, avg throughput: 28MB/s lz4 -1 time 15118ms, avg time 1511ms, avg throughput: 710MB/s 512K buffer copy time 1782ms, avg time 178ms, avg throughput: 6025MB/s md5 time 13724ms, avg time 1372ms, avg throughput: 782MB/s sha1 time 10959ms, avg time 1095ms, avg throughput: 979MB/s sha256 time 22982ms, avg time 2298ms, avg throughput: 467MB/s gzip -6 time 378120ms, avg time 37812ms, avg throughput: 28MB/s lz4 -1 time 15484ms, avg time 1548ms, avg throughput: 693MB/s 256K buffer copy time 1805ms, avg time 180ms, avg throughput: 5948MB/s md5 time 13706ms, avg time 1370ms, avg throughput: 783MB/s sha1 time 11074ms, avg time 1107ms, avg throughput: 969MB/s sha256 time 22588ms, avg time 2258ms, avg throughput: 475MB/s gzip -6 time 372645ms, avg time 37264ms, avg throughput: 28MB/s lz4 -1 time 16346ms, avg time 1634ms, avg throughput: 656MB/s
2020-05-19 16:58:49 -04:00
TEST_RESULT_STR(helpRender(), strNewFmt("%s\ncurrent: 32768\ndefault: 1048576\n", optionHelp), " check text");
Implement help command in C.
2018-01-23 13:34:24 -05:00
// -------------------------------------------------------------------------------------------------------------------------
Consolidate less commonly used repository storage options. The following options are renamed as specified: repo1-azure-ca-file -> repo1-storage-ca-file repo1-azure-ca-path -> repo1-storage-ca-path repo1-azure-host -> repo1-storage-host repo1-azure-port -> repo1-storage-port repo1-azure-verify-tls -> repo1-storage-verify-tls repo1-s3-ca-file -> repo1-storage-ca-file repo1-s3-ca-path -> repo1-storage-ca-path repo1-s3-host -> repo1-storage-host repo1-s3-port -> repo1-storage-port repo1-s3-verify-tls -> repo1-storage-verify-tls The old option names (e.g. repo1-s3-port) will continue to work for repo1, but repo2, etc. will require the new names.
2021-03-02 13:51:40 -05:00
#define HELP_OPTION \
"%s - 'archive-push' command - 'repo-storage-host' option help\n" \
"\n" \
"Repository storage host.\n" \
"\n" \
"Connect to a host other than the storage (e.g. S3, Azure) endpoint. This is\n" \
"typically used for testing.\n" \
Implement help command in C.
2018-01-23 13:34:24 -05:00
"\n"
Consolidate less commonly used repository storage options. The following options are renamed as specified: repo1-azure-ca-file -> repo1-storage-ca-file repo1-azure-ca-path -> repo1-storage-ca-path repo1-azure-host -> repo1-storage-host repo1-azure-port -> repo1-storage-port repo1-azure-verify-tls -> repo1-storage-verify-tls repo1-s3-ca-file -> repo1-storage-ca-file repo1-s3-ca-path -> repo1-storage-ca-path repo1-s3-host -> repo1-storage-host repo1-s3-port -> repo1-storage-port repo1-s3-verify-tls -> repo1-storage-verify-tls The old option names (e.g. repo1-s3-port) will continue to work for repo1, but repo2, etc. will require the new names.
2021-03-02 13:51:40 -05:00
#define HELP_OPTION_DEPRECATED_NAMES \
"deprecated names: repo-azure-host, repo-s3-host\n"
optionHelp = strZ(strNewFmt(
HELP_OPTION
HELP_OPTION_DEPRECATED_NAMES,
Implement help command in C.
2018-01-23 13:34:24 -05:00
helpVersion));
argList = strLstNew();
strLstAddZ(argList, "/path/to/pgbackrest");
strLstAddZ(argList, "help");
strLstAddZ(argList, "archive-push");
Call Perl with built-in interpreter instead of execvp(). Exec'ing Perl worked fine but generated a very large command line in the process list and potentially exposed secrets.
2018-02-14 17:19:54 -05:00
strLstAddZ(argList, "repo1-s3-host");
TEST_RESULT_VOID(
Use harnessCfgLoadRaw() in command/help unit test. This correctly set defaults from cfgLoadUpdateOption(), e.g. repo-host-cmd.
2020-10-19 16:27:52 -04:00
harnessCfgLoadRaw(strLstSize(argList), strLstPtr(argList)), "help for archive-push command, repo1-s3-host option");
Change meaning of TEST_RESULT_STR() macro. This macro was created before the String object existed so subsequent usage with String always included a lot of strPtr() wrapping. TEST_RESULT_STR_Z() had already been introduced but a wholesale replacement of TEST_RESULT_STR() was not done since the priority was on the C migration. Update all calls to (old) TEST_RESULT_STR() with one of the following variants: (new) TEST_RESULT_STR(), TEST_RESULT_STR_Z(), TEST_RESULT_Z(), TEST_RESULT_Z_STR().
2019-12-26 18:08:27 -07:00
TEST_RESULT_STR_Z(helpRender(), optionHelp, " check text");
Rename db-* options to pg-* and backup-* options to repo-* to improve consistency. * repo-* options are now indexed although only one is allowed. * List deprecated option names in documentation and command-line help.
2018-02-03 18:27:38 -05:00
Consolidate less commonly used repository storage options. The following options are renamed as specified: repo1-azure-ca-file -> repo1-storage-ca-file repo1-azure-ca-path -> repo1-storage-ca-path repo1-azure-host -> repo1-storage-host repo1-azure-port -> repo1-storage-port repo1-azure-verify-tls -> repo1-storage-verify-tls repo1-s3-ca-file -> repo1-storage-ca-file repo1-s3-ca-path -> repo1-storage-ca-path repo1-s3-host -> repo1-storage-host repo1-s3-port -> repo1-storage-port repo1-s3-verify-tls -> repo1-storage-verify-tls The old option names (e.g. repo1-s3-port) will continue to work for repo1, but repo2, etc. will require the new names.
2021-03-02 13:51:40 -05:00
optionHelp = strZ(strNewFmt(
HELP_OPTION
"current: s3-host\n"
"\n"
HELP_OPTION_DEPRECATED_NAMES,
helpVersion));
Full branch coverage for command/help/help, common/error, common/ini, and common/log modules.
2018-05-05 09:38:09 -04:00
strLstAddZ(argList, "--repo1-type=s3");
strLstAddZ(argList, "--repo1-s3-host=s3-host");
TEST_RESULT_VOID(
Use harnessCfgLoadRaw() in command/help unit test. This correctly set defaults from cfgLoadUpdateOption(), e.g. repo-host-cmd.
2020-10-19 16:27:52 -04:00
harnessCfgLoadRaw(strLstSize(argList), strLstPtr(argList)), "help for archive-push command, repo1-s3-host option");
Consolidate less commonly used repository storage options. The following options are renamed as specified: repo1-azure-ca-file -> repo1-storage-ca-file repo1-azure-ca-path -> repo1-storage-ca-path repo1-azure-host -> repo1-storage-host repo1-azure-port -> repo1-storage-port repo1-azure-verify-tls -> repo1-storage-verify-tls repo1-s3-ca-file -> repo1-storage-ca-file repo1-s3-ca-path -> repo1-storage-ca-path repo1-s3-host -> repo1-storage-host repo1-s3-port -> repo1-storage-port repo1-s3-verify-tls -> repo1-storage-verify-tls The old option names (e.g. repo1-s3-port) will continue to work for repo1, but repo2, etc. will require the new names.
2021-03-02 13:51:40 -05:00
TEST_RESULT_STR_Z(helpRender(), optionHelp, " check text");
Full branch coverage for command/help/help, common/error, common/ini, and common/log modules.
2018-05-05 09:38:09 -04:00
Redact secure options in the help command. Secure options could show up in the help as "current". While the user must have permissions to see the source of the options (e.g. environment, config file) it's still not a good idea to display them in an unexpected context. Instead show secure options as <redacted> in the help command.
2019-06-24 19:27:13 -04:00
// -------------------------------------------------------------------------------------------------------------------------
Rename strPtr()/strPtrNull() to strZ()/strZNull(). We use the Z suffix in many functions to indicate that we are expecting a zero-terminated string so make this function conform to the pattern. As a bonus the new name is a bit shorter, which is a good quality in a commonly-used function.
2020-07-30 07:49:06 -04:00
optionHelp = strZ(strNewFmt(
Redact secure options in the help command. Secure options could show up in the help as "current". While the user must have permissions to see the source of the options (e.g. environment, config file) it's still not a good idea to display them in an unexpected context. Instead show secure options as <redacted> in the help command.
2019-06-24 19:27:13 -04:00
"%s - 'archive-push' command - 'repo-cipher-pass' option help\n"
"\n"
"Repository cipher passphrase.\n"
"\n"
"Passphrase used to encrypt/decrypt files of the repository.\n"
"\n"
"current: <redacted>\n",
helpVersion));
argList = strLstNew();
strLstAddZ(argList, "/path/to/pgbackrest");
strLstAddZ(argList, "help");
strLstAddZ(argList, "--repo1-cipher-type=aes-256-cbc");
setenv("PGBACKREST_REPO1_CIPHER_PASS", "supersecret", true);
strLstAddZ(argList, "archive-push");
strLstAddZ(argList, "repo-cipher-pass");
TEST_RESULT_VOID(
Use harnessCfgLoadRaw() in command/help unit test. This correctly set defaults from cfgLoadUpdateOption(), e.g. repo-host-cmd.
2020-10-19 16:27:52 -04:00
harnessCfgLoadRaw(strLstSize(argList), strLstPtr(argList)), "help for archive-push command, repo1-s3-host option");
Redact secure options in the help command. Secure options could show up in the help as "current". While the user must have permissions to see the source of the options (e.g. environment, config file) it's still not a good idea to display them in an unexpected context. Instead show secure options as <redacted> in the help command.
2019-06-24 19:27:13 -04:00
unsetenv("PGBACKREST_REPO1_CIPHER_PASS");
Change meaning of TEST_RESULT_STR() macro. This macro was created before the String object existed so subsequent usage with String always included a lot of strPtr() wrapping. TEST_RESULT_STR_Z() had already been introduced but a wholesale replacement of TEST_RESULT_STR() was not done since the priority was on the C migration. Update all calls to (old) TEST_RESULT_STR() with one of the following variants: (new) TEST_RESULT_STR(), TEST_RESULT_STR_Z(), TEST_RESULT_Z(), TEST_RESULT_Z_STR().
2019-12-26 18:08:27 -07:00
TEST_RESULT_STR_Z(helpRender(), optionHelp, " check text");
Redact secure options in the help command. Secure options could show up in the help as "current". While the user must have permissions to see the source of the options (e.g. environment, config file) it's still not a good idea to display them in an unexpected context. Instead show secure options as <redacted> in the help command.
2019-06-24 19:27:13 -04:00
Rename db-* options to pg-* and backup-* options to repo-* to improve consistency. * repo-* options are now indexed although only one is allowed. * List deprecated option names in documentation and command-line help.
2018-02-03 18:27:38 -05:00
// -------------------------------------------------------------------------------------------------------------------------
Rename strPtr()/strPtrNull() to strZ()/strZNull(). We use the Z suffix in many functions to indicate that we are expecting a zero-terminated string so make this function conform to the pattern. As a bonus the new name is a bit shorter, which is a good quality in a commonly-used function.
2020-07-30 07:49:06 -04:00
optionHelp = strZ(strNewFmt(
Rename db-* options to pg-* and backup-* options to repo-* to improve consistency. * repo-* options are now indexed although only one is allowed. * List deprecated option names in documentation and command-line help.
2018-02-03 18:27:38 -05:00
"%s - 'backup' command - 'repo-hardlink' option help\n"
"\n"
"Hardlink files between backups in the repository.\n"
"\n"
"Enable hard-linking of files in differential and incremental backups to their\n"
"full backups. This gives the appearance that each backup is a full backup at\n"
"the file-system level. Be careful, though, because modifying files that are\n"
"hard-linked can affect all the backups in the set.\n"
"\n"
"default: n\n"
"\n"
"deprecated name: hardlink\n",
helpVersion));
argList = strLstNew();
strLstAddZ(argList, "/path/to/pgbackrest");
strLstAddZ(argList, "help");
strLstAddZ(argList, "backup");
strLstAddZ(argList, "repo-hardlink");
Refactor the common/log tests to not depend on common/harnessLog. common/harnessLog was not ideally suited for general testing and made all the tests quite awkward. Instead, move all code used to test the common/log module into the logTest module and repurpose common/harnessLog to do log expect testing for all other tests in a cleaner way. Add a few exceptions for config testing since the log levels are reset by default in config/parse.
2018-07-20 18:51:42 -04:00
TEST_RESULT_VOID(
Use harnessCfgLoadRaw() in command/help unit test. This correctly set defaults from cfgLoadUpdateOption(), e.g. repo-host-cmd.
2020-10-19 16:27:52 -04:00
harnessCfgLoadRaw(strLstSize(argList), strLstPtr(argList)), "help for backup command, repo-hardlink option");
Change meaning of TEST_RESULT_STR() macro. This macro was created before the String object existed so subsequent usage with String always included a lot of strPtr() wrapping. TEST_RESULT_STR_Z() had already been introduced but a wholesale replacement of TEST_RESULT_STR() was not done since the priority was on the C migration. Update all calls to (old) TEST_RESULT_STR() with one of the following variants: (new) TEST_RESULT_STR(), TEST_RESULT_STR_Z(), TEST_RESULT_Z(), TEST_RESULT_Z_STR().
2019-12-26 18:08:27 -07:00
TEST_RESULT_STR_Z(helpRender(), optionHelp, " check text");
Add admonitions to documentation renderers. Admonitions call out places where the user should take special care. Support added for HTML, PDF, Markdown and help text renderers. XML files have been updated accordingly. Contributed by Cynthia Shang.
2018-12-30 16:40:20 +02:00
Remove cfgOptionId() and replace it with cfgParseOption(). cfgOptionId() did not recognize deprecated options which made the help command throw errors when they were specified on the command line. cfgParseOption() will correctly identify deprecated options. cfgParseOption() can also be used in cfgParse() to reduce code duplication when parsing info out of the option value returned by optionFind(). Finally, code the option key index separately in parse.auto.c. For now they are simply added back together but future code will need them separated.
2020-10-20 11:24:26 -04:00
argList = strLstNew();
strLstAddZ(argList, "/path/to/pgbackrest");
strLstAddZ(argList, "help");
strLstAddZ(argList, "backup");
strLstAddZ(argList, "hardlink");
TEST_RESULT_VOID(
harnessCfgLoadRaw(strLstSize(argList), strLstPtr(argList)), "help for backup command, deprecated hardlink option");
TEST_RESULT_STR_Z(helpRender(), optionHelp, " check text");
Add admonitions to documentation renderers. Admonitions call out places where the user should take special care. Support added for HTML, PDF, Markdown and help text renderers. XML files have been updated accordingly. Contributed by Cynthia Shang.
2018-12-30 16:40:20 +02:00
// Check admonition
// -------------------------------------------------------------------------------------------------------------------------
Rename strPtr()/strPtrNull() to strZ()/strZNull(). We use the Z suffix in many functions to indicate that we are expecting a zero-terminated string so make this function conform to the pattern. As a bonus the new name is a bit shorter, which is a good quality in a commonly-used function.
2020-07-30 07:49:06 -04:00
optionHelp = strZ(strNewFmt(
Add admonitions to documentation renderers. Admonitions call out places where the user should take special care. Support added for HTML, PDF, Markdown and help text renderers. XML files have been updated accordingly. Contributed by Cynthia Shang.
2018-12-30 16:40:20 +02:00
"%s - 'backup' command - 'repo-retention-archive' option help\n"
"\n"
"Number of backups worth of continuous WAL to retain.\n"
"\n"
"NOTE: WAL segments required to make a backup consistent are always retained\n"
"until the backup is expired regardless of how this option is configured.\n"
"\n"
Add time-based retention for full backups. The --repo-retention-full-type option allows retention of full backups based on a time period, specified in days. The new option will default to 'count' and therefore will not affect current installations. Setting repo-retention-full-type to 'time' will allow the user to use a time period, in days, to indicate full backup retention. Using this method, a full backup can be expired only if the time the backup completed is older than the number of days set with repo-retention-full (calculated from the moment the 'expire' command is run) and at least one full backup meets the retention period. If archive retention has not been configured, then the default settings will expire archives that are prior to the oldest retained full backup. For example, if there are three full backups ending in times that are 25 days old (F1), 20 days old (F2) and 10 days old (F3), then if the full retention period is 15 days, then only F1 will be expired; F2 will be retained because F1 is not at least 15 days old.
2020-05-08 15:25:03 -04:00
"If this value is not set and repo-retention-full-type is count (default), then\n"
"the archive to expire will default to the repo-retention-full (or\n"
"repo-retention-diff) value corresponding to the repo-retention-archive-type if\n"
"set to full (or diff). This will ensure that WAL is only expired for backups\n"
"that are already expired. If repo-retention-full-type is time, then this value\n"
"will default to removing archives that are earlier than the oldest full backup\n"
"retained after satisfying the repo-retention-full setting.\n"
Add admonitions to documentation renderers. Admonitions call out places where the user should take special care. Support added for HTML, PDF, Markdown and help text renderers. XML files have been updated accordingly. Contributed by Cynthia Shang.
2018-12-30 16:40:20 +02:00
"\n"
"This option must be set if repo-retention-archive-type is set to incr. If disk\n"
"space is at a premium, then this setting, in conjunction with\n"
"repo-retention-archive-type, can be used to aggressively expire WAL segments.\n"
"However, doing so negates the ability to perform PITR from the backups with\n"
"expired WAL and is therefore not recommended.\n"
"\n"
"deprecated name: retention-archive\n",
helpVersion));
argList = strLstNew();
strLstAddZ(argList, "/path/to/pgbackrest");
strLstAddZ(argList, "help");
strLstAddZ(argList, "backup");
strLstAddZ(argList, "repo-retention-archive");
TEST_RESULT_VOID(
Use harnessCfgLoadRaw() in command/help unit test. This correctly set defaults from cfgLoadUpdateOption(), e.g. repo-host-cmd.
2020-10-19 16:27:52 -04:00
harnessCfgLoadRaw(strLstSize(argList), strLstPtr(argList)), "help for backup command, repo-retention-archive option");
Change meaning of TEST_RESULT_STR() macro. This macro was created before the String object existed so subsequent usage with String always included a lot of strPtr() wrapping. TEST_RESULT_STR_Z() had already been introduced but a wholesale replacement of TEST_RESULT_STR() was not done since the priority was on the C migration. Update all calls to (old) TEST_RESULT_STR() with one of the following variants: (new) TEST_RESULT_STR(), TEST_RESULT_STR_Z(), TEST_RESULT_Z(), TEST_RESULT_Z_STR().
2019-12-26 18:08:27 -07:00
TEST_RESULT_STR_Z(helpRender(), optionHelp, " check admonition text");
Implement help command in C.
2018-01-23 13:34:24 -05:00
}
// *****************************************************************************************************************************
if (testBegin("cmdHelp()"))
{
StringList *argList = strLstNew();
strLstAddZ(argList, "/path/to/pgbackrest");
Use harnessCfgLoadRaw() in command/help unit test. This correctly set defaults from cfgLoadUpdateOption(), e.g. repo-host-cmd.
2020-10-19 16:27:52 -04:00
TEST_RESULT_VOID(harnessCfgLoadRaw(strLstSize(argList), strLstPtr(argList)), "parse help from empty command line");
Implement help command in C.
2018-01-23 13:34:24 -05:00
// Redirect stdout to a file
int stdoutSave = dup(STDOUT_FILENO);
String *stdoutFile = strNewFmt("%s/stdout.help", testPath());
Replace THROW_ON_SYS_ERROR() with THROW_SYS_ERROR(). The former macro was hiding missing branch coverage for critical error handling.
2018-03-24 14:11:29 -04:00
Rename strPtr()/strPtrNull() to strZ()/strZNull(). We use the Z suffix in many functions to indicate that we are expecting a zero-terminated string so make this function conform to the pattern. As a bonus the new name is a bit shorter, which is a good quality in a commonly-used function.
2020-07-30 07:49:06 -04:00
THROW_ON_SYS_ERROR(freopen(strZ(stdoutFile), "w", stdout) == NULL, FileWriteError, "unable to reopen stdout");
Implement help command in C.
2018-01-23 13:34:24 -05:00
// Not in a test wrapper to avoid writing to stdout
cmdHelp();
// Restore normal stdout
dup2(stdoutSave, STDOUT_FILENO);
Convert storagePosixNew() to storagePosixNewP(). An upcoming feature requires new parameters for storagePosixNew() and this causes a lot of churn because almost every test creates a Posix storage object. Some refactoring in the tests might reduce this duplication but storagePosixNew() is collecting a lot of parameters so converting to storagePosixNewP() makes sense in any case. There are relatively few call sites in the core code but they still benefit from better readability after this change.
2020-04-30 11:01:38 -04:00
Storage *storage = storagePosixNewP(strNew(testPath()));
Change meaning of TEST_RESULT_STR() macro. This macro was created before the String object existed so subsequent usage with String always included a lot of strPtr() wrapping. TEST_RESULT_STR_Z() had already been introduced but a wholesale replacement of TEST_RESULT_STR() was not done since the priority was on the C migration. Update all calls to (old) TEST_RESULT_STR() with one of the following variants: (new) TEST_RESULT_STR(), TEST_RESULT_STR_Z(), TEST_RESULT_Z(), TEST_RESULT_Z_STR().
2019-12-26 18:08:27 -07:00
TEST_RESULT_STR_Z(strNewBuf(storageGetP(storageNewReadP(storage, stdoutFile))), generalHelp, " check text");
Implement help command in C.
2018-01-23 13:34:24 -05:00
}
Add stack trace macros to all functions. Low-level functions only include stack trace in test builds while higher-level functions ship with stack trace built-in. Stack traces include all parameters passed to the function but production builds only create the parameter list when the log level is set high enough, i.e. debug or trace depending on the function.
2018-05-18 11:57:32 -04:00
FUNCTION_HARNESS_RESULT_VOID();
Implement help command in C.
2018-01-23 13:34:24 -05:00
}
Reference in New Issue Copy Permalink